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.
716 Set number of packets per burst::
718 testpmd> set burst (num)
720 This is equivalent to the ``--burst command-line`` option.
722 When retry is enabled, the transmit delay time and number of retries can also be set::
724 testpmd> set burst tx delay (microseconds) retry (num)
729 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
731 testpmd> set txpkts (x[,y]*)
733 Where x[,y]* represents a CSV list of values, without white space.
738 Configure the timing burst pattern for Tx only mode. This command enables
739 the packet send scheduling on dynamic timestamp mbuf field and configures
740 timing pattern in Tx only mode. In this mode, if scheduling is enabled
741 application provides timestamps in the packets being sent. It is possible
742 to configure delay (in unspecified device clock units) between bursts
743 and between the packets within the burst::
745 testpmd> set txtimes (inter),(intra)
749 * ``inter`` is the delay between the bursts in the device clock units.
750 If ``intra`` is zero, this is the time between the beginnings of the
751 first packets in the neighbour bursts, if ``intra`` is not zero,
752 ``inter`` specifies the time between the beginning of the first packet
753 of the current burst and the beginning of the last packet of the
754 previous burst. If ``inter`` parameter is zero the send scheduling
755 on timestamps is disabled (default).
757 * ``intra`` is the delay between the packets within the burst specified
758 in the device clock units. The number of packets in the burst is defined
759 by regular burst setting. If ``intra`` parameter is zero no timestamps
760 provided in the packets excepting the first one in the burst.
762 As the result the bursts of packet will be transmitted with specific
763 delays between the packets within the burst and specific delay between
764 the bursts. The rte_eth_read_clock() must be supported by the device(s)
765 and is supposed to be engaged to get the current device clock value
766 and provide the reference for the timestamps. If there is no supported
767 rte_eth_read_clock() there will be no send scheduling provided on the port.
772 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
774 testpmd> set txsplit (off|on|rand)
778 * ``off`` disable packet copy & split for CSUM mode.
780 * ``on`` split outgoing packet into multiple segments. Size of each segment
781 and number of segments per packet is determined by ``set txpkts`` command
784 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
789 Set the list of forwarding cores::
791 testpmd> set corelist (x[,y]*)
793 For example, to change the forwarding cores:
795 .. code-block:: console
797 testpmd> set corelist 3,1
798 testpmd> show config fwd
800 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
801 Logical Core 3 (socket 0) forwards packets on 1 streams:
802 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
803 Logical Core 1 (socket 0) forwards packets on 1 streams:
804 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
808 The cores are used in the same order as specified on the command line.
813 Set the list of forwarding ports::
815 testpmd> set portlist (x[,y]*)
817 For example, to change the port forwarding:
819 .. code-block:: console
821 testpmd> set portlist 0,2,1,3
822 testpmd> show config fwd
824 io packet forwarding - ports=4 - cores=1 - streams=4
825 Logical Core 3 (socket 0) forwards packets on 4 streams:
826 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
827 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
828 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
829 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
834 Select how to retrieve new ports created after "port attach" command::
836 testpmd> set port setup on (iterator|event)
838 For each new port, a setup is done.
839 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
840 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
845 Enable/disable tx loopback::
847 testpmd> set tx loopback (port_id) (on|off)
852 set drop enable bit for all queues::
854 testpmd> set all queues drop (port_id) (on|off)
856 set split drop enable (for VF)
857 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
859 set split drop enable bit for VF from PF::
861 testpmd> set vf split drop (port_id) (vf_id) (on|off)
863 set mac antispoof (for VF)
864 ~~~~~~~~~~~~~~~~~~~~~~~~~~
866 Set mac antispoof for a VF from the PF::
868 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
873 Enable/disable MACsec offload::
875 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
876 testpmd> set macsec offload (port_id) off
881 Configure MACsec secure connection (SC)::
883 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
887 The pi argument is ignored for tx.
888 Check the NIC Datasheet for hardware limits.
893 Configure MACsec secure association (SA)::
895 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
899 The IDX value must be 0 or 1.
900 Check the NIC Datasheet for hardware limits.
902 set broadcast mode (for VF)
903 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
905 Set broadcast mode for a VF from the PF::
907 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
912 Set the VLAN strip for a queue on a port::
914 testpmd> vlan set stripq (on|off) (port_id,queue_id)
916 vlan set stripq (for VF)
917 ~~~~~~~~~~~~~~~~~~~~~~~~
919 Set VLAN strip for all queues in a pool for a VF from the PF::
921 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
923 vlan set insert (for VF)
924 ~~~~~~~~~~~~~~~~~~~~~~~~
926 Set VLAN insert for a VF from the PF::
928 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
930 vlan set tag (for VF)
931 ~~~~~~~~~~~~~~~~~~~~~
933 Set VLAN tag for a VF from the PF::
935 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
937 vlan set antispoof (for VF)
938 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
940 Set VLAN antispoof for a VF from the PF::
942 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
944 vlan set (strip|filter|qinq_strip|extend)
945 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
946 Set the VLAN strip/filter/QinQ strip/extend on for a port::
948 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
953 Set the inner or outer VLAN TPID for packet filtering on a port::
955 testpmd> vlan set (inner|outer) tpid (value) (port_id)
959 TPID value must be a 16-bit number (value <= 65536).
964 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
966 testpmd> rx_vlan add (vlan_id|all) (port_id)
970 VLAN filter must be set on that port. VLAN ID < 4096.
971 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
972 in VFTA table. This is important if enabling all vlan_ids.
977 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
979 testpmd> rx_vlan rm (vlan_id|all) (port_id)
984 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
986 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
991 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
993 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
998 Add a tunnel filter on a port::
1000 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
1001 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
1002 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1004 The available information categories are:
1006 * ``vxlan``: Set tunnel type as VXLAN.
1008 * ``nvgre``: Set tunnel type as NVGRE.
1010 * ``ipingre``: Set tunnel type as IP-in-GRE.
1012 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
1014 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
1016 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
1018 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
1020 * ``imac``: Set filter type as Inner MAC.
1022 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
1024 * ``oip``: Set filter type as Outer IP.
1026 * ``iip``: Set filter type as Inner IP.
1030 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
1031 192.168.2.2 0 ipingre oip 1 1
1033 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
1035 tunnel_filter remove
1036 ~~~~~~~~~~~~~~~~~~~~
1038 Remove a tunnel filter on a port::
1040 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
1041 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
1042 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1047 Add an UDP port for VXLAN packet filter on a port::
1049 testpmd> rx_vxlan_port add (udp_port) (port_id)
1051 rx_vxlan_port remove
1052 ~~~~~~~~~~~~~~~~~~~~
1054 Remove an UDP port for VXLAN packet filter on a port::
1056 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1061 Set hardware insertion of VLAN IDs in packets sent on a port::
1063 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1065 For example, set a single VLAN ID (5) insertion on port 0::
1069 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1077 Set port based hardware insertion of VLAN ID in packets sent on a port::
1079 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1084 Disable hardware insertion of a VLAN header in packets sent on a port::
1086 testpmd> tx_vlan reset (port_id)
1091 Select hardware or software calculation of the checksum when
1092 transmitting a packet using the ``csum`` forwarding engine::
1094 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1098 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1100 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1101 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
1102 supported). See also the ``csum parse-tunnel`` command.
1104 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1105 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
1106 supported). See also the ``csum parse-tunnel`` command.
1110 Check the NIC Datasheet for hardware limits.
1115 Set RSS queue region span on a port::
1117 testpmd> set port (port_id) queue-region region_id (value) \
1118 queue_start_index (value) queue_num (value)
1120 Set flowtype mapping on a RSS queue region on a port::
1122 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1126 * For the flowtype(pctype) of packet,the specific index for each type has
1127 been defined in file i40e_type.h as enum i40e_filter_pctype.
1129 Set user priority mapping on a RSS queue region on a port::
1131 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1133 Flush all queue region related configuration on a port::
1135 testpmd> set port (port_id) queue-region flush (on|off)
1139 * ``on``: is just an enable function which server for other configuration,
1140 it is for all configuration about queue region from up layer,
1141 at first will only keep in DPDK software stored in driver,
1142 only after "flush on", it commit all configuration to HW.
1144 * ``"off``: is just clean all configuration about queue region just now,
1145 and restore all to DPDK i40e driver default config when start up.
1147 Show all queue region related configuration info on a port::
1149 testpmd> show port (port_id) queue-region
1153 Queue region only support on PF by now, so these command is
1154 only for configuration of queue region on PF port.
1159 Define how tunneled packets should be handled by the csum forward
1162 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1164 If enabled, the csum forward engine will try to recognize supported
1165 tunnel headers (vxlan, gre, ipip).
1167 If disabled, treat tunnel packets as non-tunneled packets (a inner
1168 header is handled as a packet payload).
1172 The port argument is the TX port like in the ``csum set`` command.
1176 Consider a packet in packet like the following::
1178 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1180 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1181 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1182 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1184 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1185 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1190 Display tx checksum offload configuration::
1192 testpmd> csum show (port_id)
1197 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1199 testpmd> tso set (segsize) (port_id)
1203 Check the NIC datasheet for hardware limits.
1208 Display the status of TCP Segmentation Offload::
1210 testpmd> tso show (port_id)
1215 Set tso segment size of tunneled packets for a port in csum engine::
1217 testpmd> tunnel_tso set (tso_segsz) (port_id)
1222 Display the status of tunneled TCP Segmentation Offload for a port::
1224 testpmd> tunnel_tso show (port_id)
1229 Enable or disable GRO in ``csum`` forwarding engine::
1231 testpmd> set port <port_id> gro on|off
1233 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1234 packets received from the given port.
1236 If disabled, packets received from the given port won't be performed
1237 GRO. By default, GRO is disabled for all ports.
1241 When enable GRO for a port, TCP/IPv4 packets received from the port
1242 will be performed GRO. After GRO, all merged packets have bad
1243 checksums, since the GRO library doesn't re-calculate checksums for
1244 the merged packets. Therefore, if users want the merged packets to
1245 have correct checksums, please select HW IP checksum calculation and
1246 HW TCP checksum calculation for the port which the merged packets are
1252 Display GRO configuration for a given port::
1254 testpmd> show port <port_id> gro
1259 Set the cycle to flush the GROed packets from reassembly tables::
1261 testpmd> set gro flush <cycles>
1263 When enable GRO, the csum forwarding engine performs GRO on received
1264 packets, and the GROed packets are stored in reassembly tables. Users
1265 can use this command to determine when the GROed packets are flushed
1266 from the reassembly tables.
1268 The ``cycles`` is measured in GRO operation times. The csum forwarding
1269 engine flushes the GROed packets from the tables every ``cycles`` GRO
1272 By default, the value of ``cycles`` is 1, which means flush GROed packets
1273 from the reassembly tables as soon as one GRO operation finishes. The value
1274 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1276 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1277 stack performance. Because the GROed packets are delayed to arrive the
1278 stack, thus causing more duplicated ACKs and TCP retransmissions.
1283 Toggle per-port GSO support in ``csum`` forwarding engine::
1285 testpmd> set port <port_id> gso on|off
1287 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1288 packets, transmitted on the given port.
1290 If disabled, packets transmitted on the given port will not undergo GSO.
1291 By default, GSO is disabled for all ports.
1295 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1296 port undergo GSO. Afterwards, the segmented packets are represented by
1297 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1298 of checksums for GSO'd segments in SW. As a result, if users want correct
1299 checksums in GSO segments, they should enable HW checksum calculation for
1302 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1303 by setting the following options in the csum forwarding engine:
1305 testpmd> csum set outer_ip hw <port_id>
1307 testpmd> csum set ip hw <port_id>
1309 testpmd> csum set tcp hw <port_id>
1311 UDP GSO is the same as IP fragmentation, which treats the UDP header
1312 as the payload and does not modify it during segmentation. That is,
1313 after UDP GSO, only the first output fragment has the original UDP
1314 header. Therefore, users need to enable HW IP checksum calculation
1315 and SW UDP checksum calculation for GSO-enabled ports, if they want
1316 correct checksums for UDP/IPv4 packets.
1321 Set the maximum GSO segment size (measured in bytes), which includes the
1322 packet header and the packet payload for GSO-enabled ports (global)::
1324 testpmd> set gso segsz <length>
1329 Display the status of Generic Segmentation Offload for a given port::
1331 testpmd> show port <port_id> gso
1336 Add an alternative MAC address to a port::
1338 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1343 Remove a MAC address from a port::
1345 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1350 To add the multicast MAC address to/from the set of multicast addresses
1353 testpmd> mcast_addr add (port_id) (mcast_addr)
1358 To remove the multicast MAC address to/from the set of multicast addresses
1361 testpmd> mcast_addr remove (port_id) (mcast_addr)
1363 mac_addr add (for VF)
1364 ~~~~~~~~~~~~~~~~~~~~~
1366 Add an alternative MAC address for a VF to a port::
1368 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1373 Set the default MAC address for a port::
1375 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1377 mac_addr set (for VF)
1378 ~~~~~~~~~~~~~~~~~~~~~
1380 Set the MAC address for a VF from the PF::
1382 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1387 Set the forwarding peer address for certain port::
1389 testpmd> set eth-peer (port_id) (peer_addr)
1391 This is equivalent to the ``--eth-peer`` command-line option.
1396 Set the unicast hash filter(s) on/off for a port::
1398 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1403 Set the promiscuous mode on for a port or for all ports.
1404 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1406 testpmd> set promisc (port_id|all) (on|off)
1411 Set the allmulti mode for a port or for all ports::
1413 testpmd> set allmulti (port_id|all) (on|off)
1415 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1417 set promisc (for VF)
1418 ~~~~~~~~~~~~~~~~~~~~
1420 Set the unicast promiscuous mode for a VF from PF.
1421 It's supported by Intel i40e NICs now.
1422 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1424 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1426 set allmulticast (for VF)
1427 ~~~~~~~~~~~~~~~~~~~~~~~~~
1429 Set the multicast promiscuous mode for a VF from PF.
1430 It's supported by Intel i40e NICs now.
1431 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1433 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1435 set tx max bandwidth (for VF)
1436 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1438 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1440 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1442 set tc tx min bandwidth (for VF)
1443 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1445 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1447 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1449 set tc tx max bandwidth (for VF)
1450 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1452 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1454 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1456 set tc strict link priority mode
1457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1459 Set some TCs' strict link priority mode on a physical port::
1461 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1463 set tc tx min bandwidth
1464 ~~~~~~~~~~~~~~~~~~~~~~~
1466 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1468 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1473 Set the link flow control parameter on a port::
1475 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1476 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1477 autoneg (on|off) (port_id)
1481 * ``high_water`` (integer): High threshold value to trigger XOFF.
1483 * ``low_water`` (integer): Low threshold value to trigger XON.
1485 * ``pause_time`` (integer): Pause quota in the Pause frame.
1487 * ``send_xon`` (0/1): Send XON frame.
1489 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1491 * ``autoneg``: Change the auto-negotiation parameter.
1496 Set the priority flow control parameter on a port::
1498 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1499 (pause_time) (priority) (port_id)
1503 * ``high_water`` (integer): High threshold value.
1505 * ``low_water`` (integer): Low threshold value.
1507 * ``pause_time`` (integer): Pause quota in the Pause frame.
1509 * ``priority`` (0-7): VLAN User Priority.
1514 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1516 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1518 For example, to set rx queue 2 on port 0 to mapping 5::
1520 testpmd>set stat_qmap rx 0 2 5
1522 set xstats-hide-zero
1523 ~~~~~~~~~~~~~~~~~~~~
1525 Set the option to hide zero values for xstats display::
1527 testpmd> set xstats-hide-zero on|off
1531 By default, the zero values are displayed for xstats.
1533 set port - rx/tx (for VF)
1534 ~~~~~~~~~~~~~~~~~~~~~~~~~
1536 Set VF receive/transmit from a port::
1538 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1540 set port - mac address filter (for VF)
1541 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1543 Add/Remove unicast or multicast MAC addr filter for a VF::
1545 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1546 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1548 set port - rx mode(for VF)
1549 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1551 Set the VF receive mode of a port::
1553 testpmd> set port (port_id) vf (vf_id) \
1554 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1556 The available receive modes are:
1558 * ``AUPE``: Accepts untagged VLAN.
1560 * ``ROPE``: Accepts unicast hash.
1562 * ``BAM``: Accepts broadcast packets.
1564 * ``MPE``: Accepts all multicast packets.
1566 set port - tx_rate (for Queue)
1567 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1569 Set TX rate limitation for a queue on a port::
1571 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1573 set port - tx_rate (for VF)
1574 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1576 Set TX rate limitation for queues in VF on a port::
1578 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1580 set port - mirror rule
1581 ~~~~~~~~~~~~~~~~~~~~~~
1583 Set pool or vlan type mirror rule for a port::
1585 testpmd> set port (port_id) mirror-rule (rule_id) \
1586 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1587 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1589 Set link mirror rule for a port::
1591 testpmd> set port (port_id) mirror-rule (rule_id) \
1592 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1594 For example to enable mirror traffic with vlan 0,1 to pool 0::
1596 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1598 reset port - mirror rule
1599 ~~~~~~~~~~~~~~~~~~~~~~~~
1601 Reset a mirror rule for a port::
1603 testpmd> reset port (port_id) mirror-rule (rule_id)
1608 Set the flush on RX streams before forwarding.
1609 The default is flush ``on``.
1610 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1612 testpmd> set flush_rx off
1617 Set the bypass mode for the lowest port on bypass enabled NIC::
1619 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1624 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1626 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1627 mode (normal|bypass|isolate) (port_id)
1631 * ``timeout``: Enable bypass after watchdog timeout.
1633 * ``os_on``: Enable bypass when OS/board is powered on.
1635 * ``os_off``: Enable bypass when OS/board is powered off.
1637 * ``power_on``: Enable bypass when power supply is turned on.
1639 * ``power_off``: Enable bypass when power supply is turned off.
1645 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1647 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1652 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1654 testpmd> show bypass config (port_id)
1659 Set link up for a port::
1661 testpmd> set link-up port (port id)
1666 Set link down for a port::
1668 testpmd> set link-down port (port id)
1673 Enable E-tag insertion for a VF on a port::
1675 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1677 Disable E-tag insertion for a VF on a port::
1679 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1681 Enable/disable E-tag stripping on a port::
1683 testpmd> E-tag set stripping (on|off) port (port_id)
1685 Enable/disable E-tag based forwarding on a port::
1687 testpmd> E-tag set forwarding (on|off) port (port_id)
1689 Add an E-tag forwarding filter on a port::
1691 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1693 Delete an E-tag forwarding filter on a port::
1694 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1699 Load a dynamic device personalization (DDP) profile and store backup profile::
1701 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1706 Delete a dynamic device personalization profile and restore backup profile::
1708 testpmd> ddp del (port_id) (backup_profile_path)
1713 List all items from the ptype mapping table::
1715 testpmd> ptype mapping get (port_id) (valid_only)
1719 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1721 Replace a specific or a group of software defined ptype with a new one::
1723 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1727 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1729 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1731 * ``pkt_type``: The new software ptype to replace the old ones.
1733 Update hardware defined ptype to software defined packet type mapping table::
1735 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1739 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1741 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1743 Reset ptype mapping table::
1745 testpmd> ptype mapping reset (port_id)
1747 config per port Rx offloading
1748 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1750 Enable or disable a per port Rx offloading on all Rx queues of a port::
1752 testpmd> port config (port_id) rx_offload (offloading) on|off
1754 * ``offloading``: can be any of these offloading capability:
1755 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1756 qinq_strip, outer_ipv4_cksum, macsec_strip,
1757 header_split, vlan_filter, vlan_extend, jumbo_frame,
1758 scatter, timestamp, security, keep_crc, rss_hash
1760 This command should be run when the port is stopped, or else it will fail.
1762 config per queue Rx offloading
1763 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1765 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1767 testpmd> port (port_id) rxq (queue_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
1775 This command should be run when the port is stopped, or else it will fail.
1777 config per port Tx offloading
1778 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1780 Enable or disable a per port Tx offloading on all Tx queues of a port::
1782 testpmd> port config (port_id) tx_offload (offloading) on|off
1784 * ``offloading``: can be any of these offloading capability:
1785 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1786 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1787 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1788 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1789 mt_lockfree, multi_segs, mbuf_fast_free, security
1791 This command should be run when the port is stopped, or else it will fail.
1793 config per queue Tx offloading
1794 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1796 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1798 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1800 * ``offloading``: can be any of these offloading capability:
1801 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1802 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1803 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1804 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1805 mt_lockfree, multi_segs, mbuf_fast_free, security
1807 This command should be run when the port is stopped, or else it will fail.
1809 Config VXLAN Encap outer layers
1810 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1812 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1814 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1815 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1818 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1819 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1820 eth-src (eth-src) eth-dst (eth-dst)
1822 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1823 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1824 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1826 These commands will set an internal configuration inside testpmd, any following
1827 flow rule using the action vxlan_encap will use the last configuration set.
1828 To have a different encapsulation header, one of those commands must be called
1829 before the flow rule creation.
1831 Config NVGRE Encap outer layers
1832 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1834 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1836 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1837 eth-src (eth-src) eth-dst (eth-dst)
1838 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1839 ip-dst (ip-dst) vlan-tci (vlan-tci) 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 nvgre_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.
1849 Configure the l2 to be used when encapsulating a packet with L2::
1851 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1852 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1853 eth-src (eth-src) eth-dst (eth-dst)
1855 Those commands will set an internal configuration inside testpmd, any following
1856 flow rule using the action l2_encap will use the last configuration set.
1857 To have a different encapsulation header, one of those commands must be called
1858 before the flow rule creation.
1863 Configure the l2 to be removed when decapsulating a packet with L2::
1865 set l2_decap ip-version (ipv4|ipv6)
1866 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1868 Those commands will set an internal configuration inside testpmd, any following
1869 flow rule using the action l2_decap will use the last configuration set.
1870 To have a different encapsulation header, one of those commands must be called
1871 before the flow rule creation.
1873 Config MPLSoGRE Encap outer layers
1874 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1876 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1878 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1879 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1880 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1881 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1882 eth-src (eth-src) eth-dst (eth-dst)
1884 These commands will set an internal configuration inside testpmd, any following
1885 flow rule using the action mplsogre_encap will use the last configuration set.
1886 To have a different encapsulation header, one of those commands must be called
1887 before the flow rule creation.
1889 Config MPLSoGRE Decap outer layers
1890 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1892 Configure the outer layer to decapsulate MPLSoGRE packet::
1894 set mplsogre_decap ip-version (ipv4|ipv6)
1895 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1897 These commands will set an internal configuration inside testpmd, any following
1898 flow rule using the action mplsogre_decap will use the last configuration set.
1899 To have a different decapsulation header, one of those commands must be called
1900 before the flow rule creation.
1902 Config MPLSoUDP Encap outer layers
1903 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1905 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1907 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1908 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1909 eth-src (eth-src) eth-dst (eth-dst)
1910 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1911 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1912 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1914 These commands will set an internal configuration inside testpmd, any following
1915 flow rule using the action mplsoudp_encap will use the last configuration set.
1916 To have a different encapsulation header, one of those commands must be called
1917 before the flow rule creation.
1919 Config MPLSoUDP Decap outer layers
1920 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1922 Configure the outer layer to decapsulate MPLSoUDP packet::
1924 set mplsoudp_decap ip-version (ipv4|ipv6)
1925 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1927 These commands will set an internal configuration inside testpmd, any following
1928 flow rule using the action mplsoudp_decap will use the last configuration set.
1929 To have a different decapsulation header, one of those commands must be called
1930 before the flow rule creation.
1932 Config Raw Encapsulation
1933 ~~~~~~~~~~~~~~~~~~~~~~~~~
1935 Configure the raw data to be used when encapsulating a packet by
1936 rte_flow_action_raw_encap::
1938 set raw_encap {index} {item} [/ {item} [...]] / end_set
1940 There are multiple global buffers for ``raw_encap``, this command will set one
1941 internal buffer index by ``{index}``.
1942 If there is no ``{index}`` specified::
1944 set raw_encap {item} [/ {item} [...]] / end_set
1946 the default index ``0`` is used.
1947 In order to use different encapsulating header, ``index`` must be specified
1948 during the flow rule creation::
1950 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1951 raw_encap index 2 / end
1953 Otherwise the default index ``0`` is used.
1955 Config Raw Decapsulation
1956 ~~~~~~~~~~~~~~~~~~~~~~~~
1958 Configure the raw data to be used when decapsulating a packet by
1959 rte_flow_action_raw_decap::
1961 set raw_decap {index} {item} [/ {item} [...]] / end_set
1963 There are multiple global buffers for ``raw_decap``, this command will set
1964 one internal buffer index by ``{index}``.
1965 If there is no ``{index}`` specified::
1967 set raw_decap {item} [/ {item} [...]] / end_set
1969 the default index ``0`` is used.
1970 In order to use different decapsulating header, ``index`` must be specified
1971 during the flow rule creation::
1973 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1974 raw_encap index 3 / end
1976 Otherwise the default index ``0`` is used.
1981 The following sections show functions for configuring ports.
1985 Port configuration changes only become active when forwarding is started/restarted.
1990 Attach a port specified by pci address or virtual device args::
1992 testpmd> port attach (identifier)
1994 To attach a new pci device, the device should be recognized by kernel first.
1995 Then it should be moved under DPDK management.
1996 Finally the port can be attached to testpmd.
1998 For example, to move a pci device using ixgbe under DPDK management:
2000 .. code-block:: console
2002 # Check the status of the available devices.
2003 ./usertools/dpdk-devbind.py --status
2005 Network devices using DPDK-compatible driver
2006 ============================================
2009 Network devices using kernel driver
2010 ===================================
2011 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
2014 # Bind the device to igb_uio.
2015 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
2018 # Recheck the status of the devices.
2019 ./usertools/dpdk-devbind.py --status
2020 Network devices using DPDK-compatible driver
2021 ============================================
2022 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
2024 To attach a port created by virtual device, above steps are not needed.
2026 For example, to attach a port whose pci address is 0000:0a:00.0.
2028 .. code-block:: console
2030 testpmd> port attach 0000:0a:00.0
2031 Attaching a new port...
2032 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2033 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
2034 EAL: PCI memory mapped at 0x7f83bfa00000
2035 EAL: PCI memory mapped at 0x7f83bfa80000
2036 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
2037 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
2038 Port 0 is attached. Now total ports is 1
2041 For example, to attach a port created by pcap PMD.
2043 .. code-block:: console
2045 testpmd> port attach net_pcap0
2046 Attaching a new port...
2047 PMD: Initializing pmd_pcap for net_pcap0
2048 PMD: Creating pcap-backed ethdev on numa socket 0
2049 Port 0 is attached. Now total ports is 1
2052 In this case, identifier is ``net_pcap0``.
2053 This identifier format is the same as ``--vdev`` format of DPDK applications.
2055 For example, to re-attach a bonded port which has been previously detached,
2056 the mode and slave parameters must be given.
2058 .. code-block:: console
2060 testpmd> port attach net_bond_0,mode=0,slave=1
2061 Attaching a new port...
2062 EAL: Initializing pmd_bond for net_bond_0
2063 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2064 Port 0 is attached. Now total ports is 1
2071 Detach a specific port::
2073 testpmd> port detach (port_id)
2075 Before detaching a port, the port should be stopped and closed.
2077 For example, to detach a pci device port 0.
2079 .. code-block:: console
2081 testpmd> port stop 0
2084 testpmd> port close 0
2088 testpmd> port detach 0
2090 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2091 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2092 EAL: PCI memory unmapped at 0x7f83bfa00000
2093 EAL: PCI memory unmapped at 0x7f83bfa80000
2097 For example, to detach a virtual device port 0.
2099 .. code-block:: console
2101 testpmd> port stop 0
2104 testpmd> port close 0
2108 testpmd> port detach 0
2110 PMD: Closing pcap ethdev on numa socket 0
2111 Port 'net_pcap0' is detached. Now total ports is 0
2114 To remove a pci device completely from the system, first detach the port from testpmd.
2115 Then the device should be moved under kernel management.
2116 Finally the device can be removed using kernel pci hotplug functionality.
2118 For example, to move a pci device under kernel management:
2120 .. code-block:: console
2122 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2124 ./usertools/dpdk-devbind.py --status
2126 Network devices using DPDK-compatible driver
2127 ============================================
2130 Network devices using kernel driver
2131 ===================================
2132 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2134 To remove a port created by a virtual device, above steps are not needed.
2139 Start all ports or a specific port::
2141 testpmd> port start (port_id|all)
2146 Stop all ports or a specific port::
2148 testpmd> port stop (port_id|all)
2153 Close all ports or a specific port::
2155 testpmd> port close (port_id|all)
2160 Reset all ports or a specific port::
2162 testpmd> port reset (port_id|all)
2164 User should stop port(s) before resetting and (re-)start after reset.
2166 port config - queue ring size
2167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2169 Configure a rx/tx queue ring size::
2171 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2173 Only take effect after command that (re-)start the port or command that setup specific queue.
2175 port start/stop queue
2176 ~~~~~~~~~~~~~~~~~~~~~
2178 Start/stop a rx/tx queue on a specific port::
2180 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2182 port config - queue deferred start
2183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2185 Switch on/off deferred start of a specific port queue::
2187 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2190 ~~~~~~~~~~~~~~~~~~~~~
2192 Setup a rx/tx queue on a specific port::
2194 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2196 Only take effect when port is started.
2201 Set the speed and duplex mode for all ports or a specific port::
2203 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \
2204 duplex (half|full|auto)
2206 port config - queues/descriptors
2207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2209 Set number of queues/descriptors for rxq, txq, rxd and txd::
2211 testpmd> port config all (rxq|txq|rxd|txd) (value)
2213 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2215 port config - max-pkt-len
2216 ~~~~~~~~~~~~~~~~~~~~~~~~~
2218 Set the maximum packet length::
2220 testpmd> port config all max-pkt-len (value)
2222 This is equivalent to the ``--max-pkt-len`` command-line option.
2224 port config - max-lro-pkt-size
2225 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2227 Set the maximum LRO aggregated packet size::
2229 testpmd> port config all max-lro-pkt-size (value)
2231 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2233 port config - Drop Packets
2234 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2236 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2238 testpmd> port config all drop-en (on|off)
2240 Packet dropping when no receive buffers available is off by default.
2242 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2247 Set the RSS (Receive Side Scaling) mode on or off::
2249 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)
2251 RSS is on by default.
2253 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp.
2255 The ``default`` option enables all supported RSS types reported by device info.
2257 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2259 port config - RSS Reta
2260 ~~~~~~~~~~~~~~~~~~~~~~
2262 Set the RSS (Receive Side Scaling) redirection table::
2264 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2269 Set the DCB mode for an individual port::
2271 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2273 The traffic class should be 4 or 8.
2278 Set the number of packets per burst::
2280 testpmd> port config all burst (value)
2282 This is equivalent to the ``--burst`` command-line option.
2284 port config - Threshold
2285 ~~~~~~~~~~~~~~~~~~~~~~~
2287 Set thresholds for TX/RX queues::
2289 testpmd> port config all (threshold) (value)
2291 Where the threshold type can be:
2293 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2295 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2297 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2299 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2301 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2303 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2305 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2307 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2309 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2311 These threshold options are also available from the command-line.
2316 Set the value of ether-type for E-tag::
2318 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2320 Enable/disable the E-tag support::
2322 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2324 port config pctype mapping
2325 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2327 Reset pctype mapping table::
2329 testpmd> port config (port_id) pctype mapping reset
2331 Update hardware defined pctype to software defined flow type mapping table::
2333 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2337 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2339 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2341 port config input set
2342 ~~~~~~~~~~~~~~~~~~~~~
2344 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2346 testpmd> port config (port_id) pctype (pctype_id) \
2347 (hash_inset|fdir_inset|fdir_flx_inset) \
2348 (get|set|clear) field (field_idx)
2350 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2352 testpmd> port config (port_id) pctype (pctype_id) \
2353 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2357 * ``pctype_id``: hardware packet classification types.
2358 * ``field_idx``: hardware field index.
2360 port config udp_tunnel_port
2361 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2363 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2365 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2367 port config tx_metadata
2368 ~~~~~~~~~~~~~~~~~~~~~~~
2370 Set Tx metadata value per port.
2371 testpmd will add this value to any Tx packet sent from this port::
2373 testpmd> port config (port_id) tx_metadata (value)
2378 Set/clear dynamic flag per port.
2379 testpmd will register this flag in the mbuf (same registration
2380 for both Tx and Rx). Then set/clear this flag for each Tx
2381 packet sent from this port. The set bit only works for Tx packet::
2383 testpmd> port config (port_id) dynf (name) (set|clear)
2388 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2390 testpmd> port config mtu (port_id) (value)
2392 port config rss hash key
2393 ~~~~~~~~~~~~~~~~~~~~~~~~
2395 To configure the RSS hash key used to compute the RSS
2396 hash of input [IP] packets received on port::
2398 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2399 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2400 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2401 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2402 ipv6-udp-ex <string of hex digits \
2403 (variable length, NIC dependent)>)
2408 The following sections show functions for device operations.
2413 Detach a device specified by pci address or virtual device args::
2415 testpmd> device detach (identifier)
2417 Before detaching a device associated with ports, the ports should be stopped and closed.
2419 For example, to detach a pci device whose address is 0002:03:00.0.
2421 .. code-block:: console
2423 testpmd> device detach 0002:03:00.0
2424 Removing a device...
2425 Port 1 is now closed
2426 EAL: Releasing pci mapped resource for 0002:03:00.0
2427 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2428 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2429 Device 0002:03:00.0 is detached
2430 Now total ports is 1
2432 For example, to detach a port created by pcap PMD.
2434 .. code-block:: console
2436 testpmd> device detach net_pcap0
2437 Removing a device...
2438 Port 0 is now closed
2439 Device net_pcap0 is detached
2440 Now total ports is 0
2443 In this case, identifier is ``net_pcap0``.
2444 This identifier format is the same as ``--vdev`` format of DPDK applications.
2446 Link Bonding Functions
2447 ----------------------
2449 The Link Bonding functions make it possible to dynamically create and
2450 manage link bonding devices from within testpmd interactive prompt.
2452 create bonded device
2453 ~~~~~~~~~~~~~~~~~~~~
2455 Create a new bonding device::
2457 testpmd> create bonded device (mode) (socket)
2459 For example, to create a bonded device in mode 1 on socket 0::
2461 testpmd> create bonded device 1 0
2462 created new bonded device (port X)
2467 Adds Ethernet device to a Link Bonding device::
2469 testpmd> add bonding slave (slave id) (port id)
2471 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2473 testpmd> add bonding slave 6 10
2476 remove bonding slave
2477 ~~~~~~~~~~~~~~~~~~~~
2479 Removes an Ethernet slave device from a Link Bonding device::
2481 testpmd> remove bonding slave (slave id) (port id)
2483 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2485 testpmd> remove bonding slave 6 10
2490 Set the Link Bonding mode of a Link Bonding device::
2492 testpmd> set bonding mode (value) (port id)
2494 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2496 testpmd> set bonding mode 3 10
2501 Set an Ethernet slave device as the primary device on a Link Bonding device::
2503 testpmd> set bonding primary (slave id) (port id)
2505 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2507 testpmd> set bonding primary 6 10
2512 Set the MAC address of a Link Bonding device::
2514 testpmd> set bonding mac (port id) (mac)
2516 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2518 testpmd> set bonding mac 10 00:00:00:00:00:01
2520 set bonding xmit_balance_policy
2521 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2523 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2525 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2527 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2529 testpmd> set bonding xmit_balance_policy 10 l34
2532 set bonding mon_period
2533 ~~~~~~~~~~~~~~~~~~~~~~
2535 Set the link status monitoring polling period in milliseconds for a bonding device.
2537 This adds support for PMD slave devices which do not support link status interrupts.
2538 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2539 link status ISR will be queried every polling interval to check if their link status has changed::
2541 testpmd> set bonding mon_period (port_id) (value)
2543 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2545 testpmd> set bonding mon_period 5 150
2548 set bonding lacp dedicated_queue
2549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2551 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2552 when in mode 4 (link-aggregation-802.3ad)::
2554 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2557 set bonding agg_mode
2558 ~~~~~~~~~~~~~~~~~~~~
2560 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2562 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2568 Show the current configuration of a Link Bonding device::
2570 testpmd> show bonding config (port id)
2573 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2574 in balance mode with a transmission policy of layer 2+3::
2576 testpmd> show bonding config 9
2578 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2580 Active Slaves (3): [1 3 4]
2587 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2588 This is mainly useful for debugging purposes.
2589 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2590 and fields that can be accessed.
2595 Display the value of a port register::
2597 testpmd> read reg (port_id) (address)
2599 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2601 testpmd> read reg 0 0xEE00
2602 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2607 Display a port register bit field::
2609 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2611 For example, reading the lowest two bits from the register in the example above::
2613 testpmd> read regfield 0 0xEE00 0 1
2614 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2619 Display a single port register bit::
2621 testpmd> read regbit (port_id) (address) (bit_x)
2623 For example, reading the lowest bit from the register in the example above::
2625 testpmd> read regbit 0 0xEE00 0
2626 port 0 PCI register at offset 0xEE00: bit 0=1
2631 Set the value of a port register::
2633 testpmd> write reg (port_id) (address) (value)
2635 For example, to clear a register::
2637 testpmd> write reg 0 0xEE00 0x0
2638 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2643 Set bit field of a port register::
2645 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2647 For example, writing to the register cleared in the example above::
2649 testpmd> write regfield 0 0xEE00 0 1 2
2650 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2655 Set single bit value of a port register::
2657 testpmd> write regbit (port_id) (address) (bit_x) (value)
2659 For example, to set the high bit in the register from the example above::
2661 testpmd> write regbit 0 0xEE00 31 1
2662 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2664 Traffic Metering and Policing
2665 -----------------------------
2667 The following section shows functions for configuring traffic metering and
2668 policing on the ethernet device through the use of generic ethdev API.
2670 show port traffic management capability
2671 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2673 Show traffic metering and policing capability of the port::
2675 testpmd> show port meter cap (port_id)
2677 add port meter profile (srTCM rfc2967)
2678 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2680 Add meter profile (srTCM rfc2697) to the ethernet device::
2682 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2687 * ``profile_id``: ID for the meter profile.
2688 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2689 * ``cbs``: Committed Burst Size (CBS) (bytes).
2690 * ``ebs``: Excess Burst Size (EBS) (bytes).
2692 add port meter profile (trTCM rfc2968)
2693 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2695 Add meter profile (srTCM rfc2698) to the ethernet device::
2697 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2698 (cir) (pir) (cbs) (pbs)
2702 * ``profile_id``: ID for the meter profile.
2703 * ``cir``: Committed information rate (bytes/second).
2704 * ``pir``: Peak information rate (bytes/second).
2705 * ``cbs``: Committed burst size (bytes).
2706 * ``pbs``: Peak burst size (bytes).
2708 add port meter profile (trTCM rfc4115)
2709 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2711 Add meter profile (trTCM rfc4115) to the ethernet device::
2713 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2714 (cir) (eir) (cbs) (ebs)
2718 * ``profile_id``: ID for the meter profile.
2719 * ``cir``: Committed information rate (bytes/second).
2720 * ``eir``: Excess information rate (bytes/second).
2721 * ``cbs``: Committed burst size (bytes).
2722 * ``ebs``: Excess burst size (bytes).
2724 delete port meter profile
2725 ~~~~~~~~~~~~~~~~~~~~~~~~~
2727 Delete meter profile from the ethernet device::
2729 testpmd> del port meter profile (port_id) (profile_id)
2734 Create new meter object for the ethernet device::
2736 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2737 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2738 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2743 * ``mtr_id``: meter object ID.
2744 * ``profile_id``: ID for the meter profile.
2745 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2746 gets enabled at the time of creation, otherwise remains disabled.
2747 * ``g_action``: Policer action for the packet with green color.
2748 * ``y_action``: Policer action for the packet with yellow color.
2749 * ``r_action``: Policer action for the packet with red color.
2750 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2752 * ``shared``: When this parameter has a non-zero value, the meter object is
2753 shared by multiple flows. Otherwise, meter object is used by single flow.
2754 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2755 input color for the current meter object is determined by the latest meter
2756 object in the same flow. Otherwise, the current meter object uses the
2757 *dscp_table* to determine the input color.
2758 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2759 color, 0 <= x <= 63.
2764 Enable meter for the ethernet device::
2766 testpmd> enable port meter (port_id) (mtr_id)
2771 Disable meter for the ethernet device::
2773 testpmd> disable port meter (port_id) (mtr_id)
2778 Delete meter for the ethernet device::
2780 testpmd> del port meter (port_id) (mtr_id)
2782 Set port meter profile
2783 ~~~~~~~~~~~~~~~~~~~~~~
2785 Set meter profile for the ethernet device::
2787 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2789 set port meter dscp table
2790 ~~~~~~~~~~~~~~~~~~~~~~~~~
2792 Set meter dscp table for the ethernet device::
2794 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2795 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2797 set port meter policer action
2798 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2800 Set meter policer action for the ethernet device::
2802 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2803 (action0) [(action1) (action1)]
2807 * ``action_mask``: Bit mask indicating which policer actions need to be
2808 updated. One or more policer actions can be updated in a single function
2809 invocation. To update the policer action associated with color C, bit
2810 (1 << C) needs to be set in *action_mask* and element at position C
2811 in the *actions* array needs to be valid.
2812 * ``actionx``: Policer action for the color x,
2813 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2815 set port meter stats mask
2816 ~~~~~~~~~~~~~~~~~~~~~~~~~
2818 Set meter stats mask for the ethernet device::
2820 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2824 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2826 show port meter stats
2827 ~~~~~~~~~~~~~~~~~~~~~
2829 Show meter stats of the ethernet device::
2831 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2835 * ``clear``: Flag that indicates whether the statistics counters should
2836 be cleared (i.e. set to zero) immediately after they have been read or not.
2841 The following section shows functions for configuring traffic management on
2842 the ethernet device through the use of generic TM API.
2844 show port traffic management capability
2845 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2847 Show traffic management capability of the port::
2849 testpmd> show port tm cap (port_id)
2851 show port traffic management capability (hierarchy level)
2852 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2854 Show traffic management hierarchy level capability of the port::
2856 testpmd> show port tm level cap (port_id) (level_id)
2858 show port traffic management capability (hierarchy node level)
2859 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2861 Show the traffic management hierarchy node capability of the port::
2863 testpmd> show port tm node cap (port_id) (node_id)
2865 show port traffic management hierarchy node type
2866 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2868 Show the port traffic management hierarchy node type::
2870 testpmd> show port tm node type (port_id) (node_id)
2872 show port traffic management hierarchy node stats
2873 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2875 Show the port traffic management hierarchy node statistics::
2877 testpmd> show port tm node stats (port_id) (node_id) (clear)
2881 * ``clear``: When this parameter has a non-zero value, the statistics counters
2882 are cleared (i.e. set to zero) immediately after they have been read,
2883 otherwise the statistics counters are left untouched.
2885 Add port traffic management private shaper profile
2886 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2888 Add the port traffic management private shaper profile::
2890 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2891 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2892 (packet_length_adjust)
2896 * ``shaper_profile id``: Shaper profile ID for the new profile.
2897 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2898 * ``cmit_tb_size``: Committed token bucket size (bytes).
2899 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2900 * ``peak_tb_size``: Peak token bucket size (bytes).
2901 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2902 each packet for the purpose of shaping. This parameter value can be used to
2903 correct the packet length with the framing overhead bytes that are consumed
2906 Delete port traffic management private shaper profile
2907 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2909 Delete the port traffic management private shaper::
2911 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2915 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2917 Add port traffic management shared shaper
2918 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2920 Create the port traffic management shared shaper::
2922 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2927 * ``shared_shaper_id``: Shared shaper ID to be created.
2928 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2930 Set port traffic management shared shaper
2931 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2933 Update the port traffic management shared shaper::
2935 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2940 * ``shared_shaper_id``: Shared shaper ID to be update.
2941 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2943 Delete port traffic management shared shaper
2944 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2946 Delete the port traffic management shared shaper::
2948 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2952 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2954 Set port traffic management hierarchy node private shaper
2955 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2957 set the port traffic management hierarchy node private shaper::
2959 testpmd> set port tm node shaper profile (port_id) (node_id) \
2964 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2967 Add port traffic management WRED profile
2968 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2970 Create a new WRED profile::
2972 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2973 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2974 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2975 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2979 * ``wred_profile id``: Identifier for the newly create WRED profile
2980 * ``color_g``: Packet color (green)
2981 * ``min_th_g``: Minimum queue threshold for packet with green color
2982 * ``max_th_g``: Minimum queue threshold for packet with green color
2983 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2984 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2985 * ``color_y``: Packet color (yellow)
2986 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2987 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2988 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2989 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2990 * ``color_r``: Packet color (red)
2991 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2992 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2993 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2994 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2996 Delete port traffic management WRED profile
2997 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2999 Delete the WRED profile::
3001 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
3003 Add port traffic management hierarchy nonleaf node
3004 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3006 Add nonleaf node to port traffic management hierarchy::
3008 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
3009 (priority) (weight) (level_id) (shaper_profile_id) \
3010 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3011 [(shared_shaper_0) (shared_shaper_1) ...] \
3015 * ``parent_node_id``: Node ID of the parent.
3016 * ``priority``: Node priority (highest node priority is zero). This is used by
3017 the SP algorithm running on the parent node for scheduling this node.
3018 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3019 to the weight sum of all siblings that have the same priority. It is used by
3020 the WFQ algorithm running on the parent node for scheduling this node.
3021 * ``level_id``: Hierarchy level of the node.
3022 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3024 * ``n_sp_priorities``: Number of strict priorities.
3025 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3026 * ``n_shared_shapers``: Number of shared shapers.
3027 * ``shared_shaper_id``: Shared shaper id.
3029 Add port traffic management hierarchy leaf node
3030 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3032 Add leaf node to port traffic management hierarchy::
3034 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
3035 (priority) (weight) (level_id) (shaper_profile_id) \
3036 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
3037 [(shared_shaper_id) (shared_shaper_id) ...] \
3041 * ``parent_node_id``: Node ID of the parent.
3042 * ``priority``: Node priority (highest node priority is zero). This is used by
3043 the SP algorithm running on the parent node for scheduling this node.
3044 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3045 to the weight sum of all siblings that have the same priority. It is used by
3046 the WFQ algorithm running on the parent node for scheduling this node.
3047 * ``level_id``: Hierarchy level of the node.
3048 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3050 * ``cman_mode``: Congestion management mode to be enabled for this node.
3051 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3052 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3053 * ``n_shared_shapers``: Number of shared shapers.
3054 * ``shared_shaper_id``: Shared shaper id.
3056 Delete port traffic management hierarchy node
3057 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3059 Delete node from port traffic management hierarchy::
3061 testpmd> del port tm node (port_id) (node_id)
3063 Update port traffic management hierarchy parent node
3064 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3066 Update port traffic management hierarchy parent node::
3068 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3071 This function can only be called after the hierarchy commit invocation. Its
3072 success depends on the port support for this operation, as advertised through
3073 the port capability set. This function is valid for all nodes of the traffic
3074 management hierarchy except root node.
3076 Suspend port traffic management hierarchy node
3077 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3079 testpmd> suspend port tm node (port_id) (node_id)
3081 Resume port traffic management hierarchy node
3082 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3084 testpmd> resume port tm node (port_id) (node_id)
3086 Commit port traffic management hierarchy
3087 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3089 Commit the traffic management hierarchy on the port::
3091 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3095 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3096 call failure. On the other hand, hierarchy is preserved when this parameter
3099 Set port traffic management mark VLAN dei
3100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3102 Enables/Disables the traffic management marking on the port for VLAN packets::
3104 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3108 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3109 ``yellow`` or ``red`` will have dei bit enabled
3111 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3113 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3115 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3117 Set port traffic management mark IP dscp
3118 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3120 Enables/Disables the traffic management marking on the port for IP dscp packets::
3122 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3126 * ``port_id``: The port which on which IP packets marked as ``green`` or
3127 ``yellow`` or ``red`` will have IP dscp bits updated
3129 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3131 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3133 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3135 Set port traffic management mark IP ecn
3136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3138 Enables/Disables the traffic management marking on the port for IP ecn packets::
3140 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3144 * ``port_id``: The port which on which IP packets marked as ``green`` or
3145 ``yellow`` or ``red`` will have IP ecn bits updated
3147 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3148 to ecn of 2'b11 when IP is caring TCP or SCTP
3150 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3151 to ecn of 2'b11 when IP is caring TCP or SCTP
3153 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3154 to ecn of 2'b11 when IP is caring TCP or SCTP
3159 This section details the available filter functions that are available.
3161 Note these functions interface the deprecated legacy filtering framework,
3162 superseded by *rte_flow*. See `Flow rules management`_.
3165 ~~~~~~~~~~~~~~~~~~~~
3167 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3169 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3170 ethertype (ether_type) (drop|fwd) queue (queue_id)
3172 The available information parameters are:
3174 * ``port_id``: The port which the Ethertype filter assigned on.
3176 * ``mac_addr``: Compare destination mac address.
3178 * ``mac_ignr``: Ignore destination mac address match.
3180 * ``mac_address``: Destination mac address to match.
3182 * ``ether_type``: The EtherType value want to match,
3183 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3185 * ``queue_id``: The receive queue associated with this EtherType filter.
3186 It is meaningless when deleting or dropping.
3188 Example, to add/remove an ethertype filter rule::
3190 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3191 ethertype 0x0806 fwd queue 3
3193 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3194 ethertype 0x0806 fwd queue 3
3199 Add or delete a 2-tuple filter,
3200 which identifies packets by specific protocol and destination TCP/UDP port
3201 and forwards packets into one of the receive queues::
3203 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3204 protocol (protocol_value) mask (mask_value) \
3205 tcp_flags (tcp_flags_value) priority (prio_value) \
3208 The available information parameters are:
3210 * ``port_id``: The port which the 2-tuple filter assigned on.
3212 * ``dst_port_value``: Destination port in L4.
3214 * ``protocol_value``: IP L4 protocol.
3216 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3218 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3220 * ``prio_value``: Priority of this filter.
3222 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3224 Example, to add/remove an 2tuple filter rule::
3226 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3227 tcp_flags 0x02 priority 3 queue 3
3229 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3230 tcp_flags 0x02 priority 3 queue 3
3235 Add or delete a 5-tuple filter,
3236 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3237 and routes packets into one of the receive queues::
3239 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3240 (src_address) dst_port (dst_port_value) \
3241 src_port (src_port_value) protocol (protocol_value) \
3242 mask (mask_value) tcp_flags (tcp_flags_value) \
3243 priority (prio_value) queue (queue_id)
3245 The available information parameters are:
3247 * ``port_id``: The port which the 5-tuple filter assigned on.
3249 * ``dst_address``: Destination IP address.
3251 * ``src_address``: Source IP address.
3253 * ``dst_port_value``: TCP/UDP destination port.
3255 * ``src_port_value``: TCP/UDP source port.
3257 * ``protocol_value``: L4 protocol.
3259 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3261 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3263 * ``prio_value``: The priority of this filter.
3265 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3267 Example, to add/remove an 5tuple filter rule::
3269 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3270 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3271 flags 0x0 priority 3 queue 3
3273 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3274 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3275 flags 0x0 priority 3 queue 3
3280 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3282 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3284 The available information parameters are:
3286 * ``port_id``: The port which the SYN filter assigned on.
3288 * ``high``: This SYN filter has higher priority than other filters.
3290 * ``low``: This SYN filter has lower priority than other filters.
3292 * ``queue_id``: The receive queue associated with this SYN filter
3296 testpmd> syn_filter 0 add priority high queue 3
3301 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3302 and routed into one of the receive queues::
3304 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3305 mask (mask_value) priority (prio_value) queue (queue_id)
3307 The available information parameters are:
3309 * ``port_id``: The port which the Flex filter is assigned on.
3311 * ``len_value``: Filter length in bytes, no greater than 128.
3313 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3315 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3317 * ``prio_value``: The priority of this filter.
3319 * ``queue_id``: The receive queue associated with this Flex filter.
3323 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3324 mask 000C priority 3 queue 3
3326 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3327 mask 000C priority 3 queue 3
3330 .. _testpmd_flow_director:
3332 flow_director_filter
3333 ~~~~~~~~~~~~~~~~~~~~
3335 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3337 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3338 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3340 * Perfect match filters.
3341 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3342 The masked fields are for IP flow.
3344 * Signature filters.
3345 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3347 * Perfect-mac-vlan match filters.
3348 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3349 The masked fields are for MAC VLAN flow.
3351 * Perfect-tunnel match filters.
3352 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3353 The masked fields are for tunnel flow.
3355 * Perfect-raw-flow-type match filters.
3356 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3357 The masked fields are specified by input sets.
3359 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3360 per flow type and the flexible payload.
3362 The Flow Director can also mask out parts of all of these fields so that filters
3363 are only applied to certain fields or parts of the fields.
3365 Note that for raw flow type mode the source and destination fields in the
3366 raw packet buffer need to be presented in a reversed order with respect
3367 to the expected received packets.
3368 For example: IP source and destination addresses or TCP/UDP/SCTP
3369 source and destination ports
3371 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3373 # Commands to add flow director filters of different flow types::
3375 flow_director_filter (port_id) mode IP (add|del|update) \
3376 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3377 src (src_ip_address) dst (dst_ip_address) \
3378 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3379 vlan (vlan_value) flexbytes (flexbytes_value) \
3380 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3383 flow_director_filter (port_id) mode IP (add|del|update) \
3384 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3385 src (src_ip_address) (src_port) \
3386 dst (dst_ip_address) (dst_port) \
3387 tos (tos_value) ttl (ttl_value) \
3388 vlan (vlan_value) flexbytes (flexbytes_value) \
3389 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3392 flow_director_filter (port_id) mode IP (add|del|update) \
3393 flow (ipv4-sctp|ipv6-sctp) \
3394 src (src_ip_address) (src_port) \
3395 dst (dst_ip_address) (dst_port) \
3396 tos (tos_value) ttl (ttl_value) \
3397 tag (verification_tag) vlan (vlan_value) \
3398 flexbytes (flexbytes_value) (drop|fwd) \
3399 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3401 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3402 ether (ethertype) flexbytes (flexbytes_value) \
3403 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3406 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3407 mac (mac_address) vlan (vlan_value) \
3408 flexbytes (flexbytes_value) (drop|fwd) \
3409 queue (queue_id) fd_id (fd_id_value)
3411 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3412 mac (mac_address) vlan (vlan_value) \
3413 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3414 flexbytes (flexbytes_value) (drop|fwd) \
3415 queue (queue_id) fd_id (fd_id_value)
3417 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3418 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3419 packet (packet file name)
3421 For example, to add an ipv4-udp flow type filter::
3423 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3424 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3425 fwd pf queue 1 fd_id 1
3427 For example, add an ipv4-other flow type filter::
3429 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3430 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3431 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3436 Flush all flow director filters on a device::
3438 testpmd> flush_flow_director (port_id)
3440 Example, to flush all flow director filter on port 0::
3442 testpmd> flush_flow_director 0
3447 Set flow director's input masks::
3449 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3450 src_mask (ipv4_src) (ipv6_src) (src_port) \
3451 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3453 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3455 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3456 mac (mac_value) tunnel-type (tunnel_type_value) \
3457 tunnel-id (tunnel_id_value)
3459 Example, to set flow director mask on port 0::
3461 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3462 src_mask 255.255.255.255 \
3463 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3464 dst_mask 255.255.255.255 \
3465 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3467 flow_director_flex_mask
3468 ~~~~~~~~~~~~~~~~~~~~~~~
3470 set masks of flow director's flexible payload based on certain flow type::
3472 testpmd> flow_director_flex_mask (port_id) \
3473 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3474 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3475 l2_payload|all) (mask)
3477 Example, to set flow director's flex mask for all flow type on port 0::
3479 testpmd> flow_director_flex_mask 0 flow all \
3480 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3483 flow_director_flex_payload
3484 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3486 Configure flexible payload selection::
3488 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3490 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3492 testpmd> flow_director_flex_payload 0 l4 \
3493 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3495 get_sym_hash_ena_per_port
3496 ~~~~~~~~~~~~~~~~~~~~~~~~~
3498 Get symmetric hash enable configuration per port::
3500 get_sym_hash_ena_per_port (port_id)
3502 For example, to get symmetric hash enable configuration of port 1::
3504 testpmd> get_sym_hash_ena_per_port 1
3506 set_sym_hash_ena_per_port
3507 ~~~~~~~~~~~~~~~~~~~~~~~~~
3509 Set symmetric hash enable configuration per port to enable or disable::
3511 set_sym_hash_ena_per_port (port_id) (enable|disable)
3513 For example, to set symmetric hash enable configuration of port 1 to enable::
3515 testpmd> set_sym_hash_ena_per_port 1 enable
3517 get_hash_global_config
3518 ~~~~~~~~~~~~~~~~~~~~~~
3520 Get the global configurations of hash filters::
3522 get_hash_global_config (port_id)
3524 For example, to get the global configurations of hash filters of port 1::
3526 testpmd> get_hash_global_config 1
3528 set_hash_global_config
3529 ~~~~~~~~~~~~~~~~~~~~~~
3531 Set the global configurations of hash filters::
3533 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3534 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3535 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3538 For example, to enable simple_xor for flow type of ipv6 on port 2::
3540 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3545 Set the input set for hash::
3547 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3548 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3549 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3550 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3551 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3552 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3553 fld-8th|none) (select|add)
3555 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3557 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3562 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3563 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3565 Set the input set for flow director::
3567 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3568 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3569 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3570 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3571 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3572 sctp-dst-port|sctp-veri-tag|none) (select|add)
3574 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3576 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3581 Set different GRE key length for input set::
3583 global_config (port_id) gre-key-len (number in bytes)
3585 For example to set GRE key length for input set to 4 bytes on port 0::
3587 testpmd> global_config 0 gre-key-len 4
3590 .. _testpmd_rte_flow:
3592 Flow rules management
3593 ---------------------
3595 Control of the generic flow API (*rte_flow*) is fully exposed through the
3596 ``flow`` command (validation, creation, destruction, queries and operation
3599 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3600 features simultaneously may cause undefined side-effects and is therefore
3606 Because the ``flow`` command uses dynamic tokens to handle the large number
3607 of possible flow rules combinations, its behavior differs slightly from
3608 other commands, in particular:
3610 - Pressing *?* or the *<tab>* key displays contextual help for the current
3611 token, not that of the entire command.
3613 - Optional and repeated parameters are supported (provided they are listed
3614 in the contextual help).
3616 The first parameter stands for the operation mode. Possible operations and
3617 their general syntax are described below. They are covered in detail in the
3620 - Check whether a flow rule can be created::
3622 flow validate {port_id}
3623 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3624 pattern {item} [/ {item} [...]] / end
3625 actions {action} [/ {action} [...]] / end
3627 - Create a flow rule::
3629 flow create {port_id}
3630 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3631 pattern {item} [/ {item} [...]] / end
3632 actions {action} [/ {action} [...]] / end
3634 - Destroy specific flow rules::
3636 flow destroy {port_id} rule {rule_id} [...]
3638 - Destroy all flow rules::
3640 flow flush {port_id}
3642 - Query an existing flow rule::
3644 flow query {port_id} {rule_id} {action}
3646 - List existing flow rules sorted by priority, filtered by group
3649 flow list {port_id} [group {group_id}] [...]
3651 - Restrict ingress traffic to the defined flow rules::
3653 flow isolate {port_id} {boolean}
3655 - Dump internal representation information of all flows in hardware::
3657 flow dump {port_id} {output_file}
3659 - List and destroy aged flow rules::
3661 flow aged {port_id} [destroy]
3663 Validating flow rules
3664 ~~~~~~~~~~~~~~~~~~~~~
3666 ``flow validate`` reports whether a flow rule would be accepted by the
3667 underlying device in its current state but stops short of creating it. It is
3668 bound to ``rte_flow_validate()``::
3670 flow validate {port_id}
3671 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3672 pattern {item} [/ {item} [...]] / end
3673 actions {action} [/ {action} [...]] / end
3675 If successful, it will show::
3679 Otherwise it will show an error message of the form::
3681 Caught error type [...] ([...]): [...]
3683 This command uses the same parameters as ``flow create``, their format is
3684 described in `Creating flow rules`_.
3686 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3687 index 6 is supported::
3689 testpmd> flow validate 0 ingress pattern eth / end
3690 actions queue index 6 / end
3694 Port 0 does not support TCPv6 rules::
3696 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3698 Caught error type 9 (specific pattern item): Invalid argument
3704 ``flow create`` validates and creates the specified flow rule. It is bound
3705 to ``rte_flow_create()``::
3707 flow create {port_id}
3708 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3709 pattern {item} [/ {item} [...]] / end
3710 actions {action} [/ {action} [...]] / end
3712 If successful, it will return a flow rule ID usable with other commands::
3714 Flow rule #[...] created
3716 Otherwise it will show an error message of the form::
3718 Caught error type [...] ([...]): [...]
3720 Parameters describe in the following order:
3722 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3723 - A matching pattern, starting with the *pattern* token and terminated by an
3725 - Actions, starting with the *actions* token and terminated by an *end*
3728 These translate directly to *rte_flow* objects provided as-is to the
3729 underlying functions.
3731 The shortest valid definition only comprises mandatory tokens::
3733 testpmd> flow create 0 pattern end actions end
3735 Note that PMDs may refuse rules that essentially do nothing such as this
3738 **All unspecified object values are automatically initialized to 0.**
3743 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3744 specified before the ``pattern`` token.
3746 - ``group {group id}``: priority group.
3747 - ``priority {level}``: priority level within group.
3748 - ``ingress``: rule applies to ingress traffic.
3749 - ``egress``: rule applies to egress traffic.
3750 - ``transfer``: apply rule directly to endpoints found in pattern.
3752 Each instance of an attribute specified several times overrides the previous
3753 value as shown below (group 4 is used)::
3755 testpmd> flow create 0 group 42 group 24 group 4 [...]
3757 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3759 While not specifying a direction is an error, some rules may allow both
3762 Most rules affect RX therefore contain the ``ingress`` token::
3764 testpmd> flow create 0 ingress pattern [...]
3769 A matching pattern starts after the ``pattern`` token. It is made of pattern
3770 items and is terminated by a mandatory ``end`` item.
3772 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3773 rte_flow_item_type``).
3775 The ``/`` token is used as a separator between pattern items as shown
3778 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3780 Note that protocol items like these must be stacked from lowest to highest
3781 layer to make sense. For instance, the following rule is either invalid or
3782 unlikely to match any packet::
3784 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3786 More information on these restrictions can be found in the *rte_flow*
3789 Several items support additional specification structures, for example
3790 ``ipv4`` allows specifying source and destination addresses as follows::
3792 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3793 dst is 10.2.0.0 / end [...]
3795 This rule matches all IPv4 traffic with the specified properties.
3797 In this example, ``src`` and ``dst`` are field names of the underlying
3798 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3799 in a similar fashion.
3801 The ``is`` token means that the subsequent value must be matched exactly,
3802 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3803 accordingly. Possible assignment tokens are:
3805 - ``is``: match value perfectly (with full bit-mask).
3806 - ``spec``: match value according to configured bit-mask.
3807 - ``last``: specify upper bound to establish a range.
3808 - ``mask``: specify bit-mask with relevant bits set to one.
3809 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3811 These yield identical results::
3813 ipv4 src is 10.1.1.1
3817 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3821 ipv4 src spec 10.1.1.1 src prefix 32
3825 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3829 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3831 Inclusive ranges can be defined with ``last``::
3833 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3835 Note that ``mask`` affects both ``spec`` and ``last``::
3837 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3838 # matches 10.1.0.0 to 10.2.255.255
3840 Properties can be modified multiple times::
3842 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3846 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3851 This section lists supported pattern items and their attributes, if any.
3853 - ``end``: end list of pattern items.
3855 - ``void``: no-op pattern item.
3857 - ``invert``: perform actions when pattern does not match.
3859 - ``any``: match any protocol for the current layer.
3861 - ``num {unsigned}``: number of layers covered.
3863 - ``pf``: match traffic from/to the physical function.
3865 - ``vf``: match traffic from/to a virtual function ID.
3867 - ``id {unsigned}``: VF ID.
3869 - ``phy_port``: match traffic from/to a specific physical port.
3871 - ``index {unsigned}``: physical port index.
3873 - ``port_id``: match traffic from/to a given DPDK port ID.
3875 - ``id {unsigned}``: DPDK port ID.
3877 - ``mark``: match value set in previously matched flow rule using the mark action.
3879 - ``id {unsigned}``: arbitrary integer value.
3881 - ``raw``: match an arbitrary byte string.
3883 - ``relative {boolean}``: look for pattern after the previous item.
3884 - ``search {boolean}``: search pattern from offset (see also limit).
3885 - ``offset {integer}``: absolute or relative offset for pattern.
3886 - ``limit {unsigned}``: search area limit for start of pattern.
3887 - ``pattern {string}``: byte string to look for.
3889 - ``eth``: match Ethernet header.
3891 - ``dst {MAC-48}``: destination MAC.
3892 - ``src {MAC-48}``: source MAC.
3893 - ``type {unsigned}``: EtherType or TPID.
3895 - ``vlan``: match 802.1Q/ad VLAN tag.
3897 - ``tci {unsigned}``: tag control information.
3898 - ``pcp {unsigned}``: priority code point.
3899 - ``dei {unsigned}``: drop eligible indicator.
3900 - ``vid {unsigned}``: VLAN identifier.
3901 - ``inner_type {unsigned}``: inner EtherType or TPID.
3903 - ``ipv4``: match IPv4 header.
3905 - ``tos {unsigned}``: type of service.
3906 - ``ttl {unsigned}``: time to live.
3907 - ``proto {unsigned}``: next protocol ID.
3908 - ``src {ipv4 address}``: source address.
3909 - ``dst {ipv4 address}``: destination address.
3911 - ``ipv6``: match IPv6 header.
3913 - ``tc {unsigned}``: traffic class.
3914 - ``flow {unsigned}``: flow label.
3915 - ``proto {unsigned}``: protocol (next header).
3916 - ``hop {unsigned}``: hop limit.
3917 - ``src {ipv6 address}``: source address.
3918 - ``dst {ipv6 address}``: destination address.
3920 - ``icmp``: match ICMP header.
3922 - ``type {unsigned}``: ICMP packet type.
3923 - ``code {unsigned}``: ICMP packet code.
3925 - ``udp``: match UDP header.
3927 - ``src {unsigned}``: UDP source port.
3928 - ``dst {unsigned}``: UDP destination port.
3930 - ``tcp``: match TCP header.
3932 - ``src {unsigned}``: TCP source port.
3933 - ``dst {unsigned}``: TCP destination port.
3935 - ``sctp``: match SCTP header.
3937 - ``src {unsigned}``: SCTP source port.
3938 - ``dst {unsigned}``: SCTP destination port.
3939 - ``tag {unsigned}``: validation tag.
3940 - ``cksum {unsigned}``: checksum.
3942 - ``vxlan``: match VXLAN header.
3944 - ``vni {unsigned}``: VXLAN identifier.
3946 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3948 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3950 - ``nvgre``: match NVGRE header.
3952 - ``tni {unsigned}``: virtual subnet ID.
3954 - ``mpls``: match MPLS header.
3956 - ``label {unsigned}``: MPLS label.
3958 - ``gre``: match GRE header.
3960 - ``protocol {unsigned}``: protocol type.
3962 - ``gre_key``: match GRE optional key field.
3964 - ``value {unsigned}``: key value.
3966 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3968 - ``thresh {unsigned}``: accuracy threshold.
3970 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3972 - ``teid {unsigned}``: tunnel endpoint identifier.
3974 - ``geneve``: match GENEVE header.
3976 - ``vni {unsigned}``: virtual network identifier.
3977 - ``protocol {unsigned}``: protocol type.
3979 - ``vxlan-gpe``: match VXLAN-GPE header.
3981 - ``vni {unsigned}``: VXLAN-GPE identifier.
3983 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3985 - ``sha {MAC-48}``: sender hardware address.
3986 - ``spa {ipv4 address}``: sender IPv4 address.
3987 - ``tha {MAC-48}``: target hardware address.
3988 - ``tpa {ipv4 address}``: target IPv4 address.
3990 - ``ipv6_ext``: match presence of any IPv6 extension header.
3992 - ``next_hdr {unsigned}``: next header.
3994 - ``icmp6``: match any ICMPv6 header.
3996 - ``type {unsigned}``: ICMPv6 type.
3997 - ``code {unsigned}``: ICMPv6 code.
3999 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
4001 - ``target_addr {ipv6 address}``: target address.
4003 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
4005 - ``target_addr {ipv6 address}``: target address.
4007 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
4009 - ``type {unsigned}``: ND option type.
4011 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
4012 link-layer address option.
4014 - ``sla {MAC-48}``: source Ethernet LLA.
4016 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
4017 link-layer address option.
4019 - ``tla {MAC-48}``: target Ethernet LLA.
4021 - ``meta``: match application specific metadata.
4023 - ``data {unsigned}``: metadata value.
4025 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
4027 - ``pdu_type {unsigned}``: PDU type.
4028 - ``qfi {unsigned}``: QoS flow identifier.
4030 - ``pppoes``, ``pppoed``: match PPPoE header.
4032 - ``session_id {unsigned}``: session identifier.
4034 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
4036 - ``proto_id {unsigned}``: PPP protocol identifier.
4038 - ``l2tpv3oip``: match L2TPv3 over IP header.
4040 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
4042 - ``ah``: match AH header.
4044 - ``spi {unsigned}``: security parameters index.
4046 - ``pfcp``: match PFCP header.
4048 - ``s_field {unsigned}``: S field.
4049 - ``seid {unsigned}``: session endpoint identifier.
4054 A list of actions starts after the ``actions`` token in the same fashion as
4055 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
4056 terminated by a mandatory ``end`` action.
4058 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
4059 rte_flow_action_type``).
4061 Dropping all incoming UDPv4 packets can be expressed as follows::
4063 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4066 Several actions have configurable properties which must be specified when
4067 there is no valid default value. For example, ``queue`` requires a target
4070 This rule redirects incoming UDPv4 traffic to queue index 6::
4072 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4073 actions queue index 6 / end
4075 While this one could be rejected by PMDs (unspecified queue index)::
4077 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4080 As defined by *rte_flow*, the list is not ordered, all actions of a given
4081 rule are performed simultaneously. These are equivalent::
4083 queue index 6 / void / mark id 42 / end
4087 void / mark id 42 / queue index 6 / end
4089 All actions in a list should have different types, otherwise only the last
4090 action of a given type is taken into account::
4092 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4096 drop / drop / drop / end # drop is performed only once
4100 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4102 Considering they are performed simultaneously, opposite and overlapping
4103 actions can sometimes be combined when the end result is unambiguous::
4105 drop / queue index 6 / end # drop has no effect
4109 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4113 drop / passthru / end # drop has no effect
4115 Note that PMDs may still refuse such combinations.
4120 This section lists supported actions and their attributes, if any.
4122 - ``end``: end list of actions.
4124 - ``void``: no-op action.
4126 - ``passthru``: let subsequent rule process matched packets.
4128 - ``jump``: redirect traffic to group on device.
4130 - ``group {unsigned}``: group to redirect to.
4132 - ``mark``: attach 32 bit value to packets.
4134 - ``id {unsigned}``: 32 bit value to return with packets.
4136 - ``flag``: flag packets.
4138 - ``queue``: assign packets to a given queue index.
4140 - ``index {unsigned}``: queue index to use.
4142 - ``drop``: drop packets (note: passthru has priority).
4144 - ``count``: enable counters for this rule.
4146 - ``rss``: spread packets among several queues.
4148 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4149 the same as `set_hash_global_config`_.
4151 - ``level {unsigned}``: encapsulation level for ``types``.
4153 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4154 tokens are the same as `set_hash_input_set`_, except that an empty list
4155 does not disable RSS but instead requests unspecified "best-effort"
4158 - ``key {string}``: RSS hash key, overrides ``key_len``.
4160 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4161 conjunction with ``key`` to pad or truncate it.
4163 - ``queues [{unsigned} [...]] end``: queue indices to use.
4165 - ``pf``: direct traffic to physical function.
4167 - ``vf``: direct traffic to a virtual function ID.
4169 - ``original {boolean}``: use original VF ID if possible.
4170 - ``id {unsigned}``: VF ID.
4172 - ``phy_port``: direct packets to physical port index.
4174 - ``original {boolean}``: use original port index if possible.
4175 - ``index {unsigned}``: physical port index.
4177 - ``port_id``: direct matching traffic to a given DPDK port ID.
4179 - ``original {boolean}``: use original DPDK port ID if possible.
4180 - ``id {unsigned}``: DPDK port ID.
4182 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4184 - ``mpls_ttl``: MPLS TTL.
4186 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4188 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4190 - ``nw_ttl``: IP TTL.
4192 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4194 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4196 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4198 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4200 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4202 - ``ethertype``: Ethertype.
4204 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4206 - ``vlan_vid``: VLAN id.
4208 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4210 - ``vlan_pcp``: VLAN priority.
4212 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4214 - ``ethertype``: Ethertype.
4216 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4218 - ``ethertype``: Ethertype.
4220 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4221 is done through `Config VXLAN Encap outer layers`_.
4223 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4224 the VXLAN tunnel network overlay from the matched flow.
4226 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4227 is done through `Config NVGRE Encap outer layers`_.
4229 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4230 the NVGRE tunnel network overlay from the matched flow.
4232 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4233 is done through `Config L2 Encap`_.
4235 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4236 is done through `Config L2 Decap`_.
4238 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4239 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4241 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4242 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4244 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4245 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4247 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4248 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4250 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4252 - ``ipv4_addr``: New IPv4 source address.
4254 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4257 - ``ipv4_addr``: New IPv4 destination address.
4259 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4261 - ``ipv6_addr``: New IPv6 source address.
4263 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4266 - ``ipv6_addr``: New IPv6 destination address.
4268 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4271 - ``port``: New TCP/UDP source port number.
4273 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4276 - ``port``: New TCP/UDP destination port number.
4278 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4281 - ``dec_ttl``: Performs a decrease TTL value action
4283 - ``set_ttl``: Set TTL value with specified value
4284 - ``ttl_value {unsigned}``: The new TTL value to be set
4286 - ``set_mac_src``: set source MAC address
4288 - ``mac_addr {MAC-48}``: new source MAC address
4290 - ``set_mac_dst``: set destination MAC address
4292 - ``mac_addr {MAC-48}``: new destination MAC address
4294 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4296 - ``value {unsigned}``: Value to increase TCP sequence number by.
4298 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4300 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4302 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4304 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4306 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4308 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4310 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4312 - ``dscp_value {unsigned}``: The new DSCP value to be set
4314 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4316 - ``dscp_value {unsigned}``: The new DSCP value to be set
4318 Destroying flow rules
4319 ~~~~~~~~~~~~~~~~~~~~~
4321 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4322 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4323 times as necessary::
4325 flow destroy {port_id} rule {rule_id} [...]
4327 If successful, it will show::
4329 Flow rule #[...] destroyed
4331 It does not report anything for rule IDs that do not exist. The usual error
4332 message is shown when a rule cannot be destroyed::
4334 Caught error type [...] ([...]): [...]
4336 ``flow flush`` destroys all rules on a device and does not take extra
4337 arguments. It is bound to ``rte_flow_flush()``::
4339 flow flush {port_id}
4341 Any errors are reported as above.
4343 Creating several rules and destroying them::
4345 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4346 actions queue index 2 / end
4347 Flow rule #0 created
4348 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4349 actions queue index 3 / end
4350 Flow rule #1 created
4351 testpmd> flow destroy 0 rule 0 rule 1
4352 Flow rule #1 destroyed
4353 Flow rule #0 destroyed
4356 The same result can be achieved using ``flow flush``::
4358 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4359 actions queue index 2 / end
4360 Flow rule #0 created
4361 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4362 actions queue index 3 / end
4363 Flow rule #1 created
4364 testpmd> flow flush 0
4367 Non-existent rule IDs are ignored::
4369 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4370 actions queue index 2 / end
4371 Flow rule #0 created
4372 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4373 actions queue index 3 / end
4374 Flow rule #1 created
4375 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4377 testpmd> flow destroy 0 rule 0
4378 Flow rule #0 destroyed
4384 ``flow query`` queries a specific action of a flow rule having that
4385 ability. Such actions collect information that can be reported using this
4386 command. It is bound to ``rte_flow_query()``::
4388 flow query {port_id} {rule_id} {action}
4390 If successful, it will display either the retrieved data for known actions
4391 or the following message::
4393 Cannot display result for action type [...] ([...])
4395 Otherwise, it will complain either that the rule does not exist or that some
4398 Flow rule #[...] not found
4402 Caught error type [...] ([...]): [...]
4404 Currently only the ``count`` action is supported. This action reports the
4405 number of packets that hit the flow rule and the total number of bytes. Its
4406 output has the following format::
4409 hits_set: [...] # whether "hits" contains a valid value
4410 bytes_set: [...] # whether "bytes" contains a valid value
4411 hits: [...] # number of packets
4412 bytes: [...] # number of bytes
4414 Querying counters for TCPv6 packets redirected to queue 6::
4416 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4417 actions queue index 6 / count / end
4418 Flow rule #4 created
4419 testpmd> flow query 0 4 count
4430 ``flow list`` lists existing flow rules sorted by priority and optionally
4431 filtered by group identifiers::
4433 flow list {port_id} [group {group_id}] [...]
4435 This command only fails with the following message if the device does not
4440 Output consists of a header line followed by a short description of each
4441 flow rule, one per line. There is no output at all when no flow rules are
4442 configured on the device::
4444 ID Group Prio Attr Rule
4445 [...] [...] [...] [...] [...]
4447 ``Attr`` column flags:
4449 - ``i`` for ``ingress``.
4450 - ``e`` for ``egress``.
4452 Creating several flow rules and listing them::
4454 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4455 actions queue index 6 / end
4456 Flow rule #0 created
4457 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4458 actions queue index 2 / end
4459 Flow rule #1 created
4460 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4461 actions rss queues 6 7 8 end / end
4462 Flow rule #2 created
4463 testpmd> flow list 0
4464 ID Group Prio Attr Rule
4465 0 0 0 i- ETH IPV4 => QUEUE
4466 1 0 0 i- ETH IPV6 => QUEUE
4467 2 0 5 i- ETH IPV4 UDP => RSS
4470 Rules are sorted by priority (i.e. group ID first, then priority level)::
4472 testpmd> flow list 1
4473 ID Group Prio Attr Rule
4474 0 0 0 i- ETH => COUNT
4475 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4476 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4477 1 24 0 i- ETH IPV4 UDP => QUEUE
4478 4 24 10 i- ETH IPV4 TCP => DROP
4479 3 24 20 i- ETH IPV4 => DROP
4480 2 24 42 i- ETH IPV4 UDP => QUEUE
4481 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4484 Output can be limited to specific groups::
4486 testpmd> flow list 1 group 0 group 63
4487 ID Group Prio Attr Rule
4488 0 0 0 i- ETH => COUNT
4489 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4490 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4491 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4494 Toggling isolated mode
4495 ~~~~~~~~~~~~~~~~~~~~~~
4497 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4498 must only be injected from the defined flow rules; that no default traffic
4499 is expected outside those rules and the driver is free to assign more
4500 resources to handle them. It is bound to ``rte_flow_isolate()``::
4502 flow isolate {port_id} {boolean}
4504 If successful, enabling or disabling isolated mode shows either::
4506 Ingress traffic on port [...]
4507 is now restricted to the defined flow rules
4511 Ingress traffic on port [...]
4512 is not restricted anymore to the defined flow rules
4514 Otherwise, in case of error::
4516 Caught error type [...] ([...]): [...]
4518 Mainly due to its side effects, PMDs supporting this mode may not have the
4519 ability to toggle it more than once without reinitializing affected ports
4520 first (e.g. by exiting testpmd).
4522 Enabling isolated mode::
4524 testpmd> flow isolate 0 true
4525 Ingress traffic on port 0 is now restricted to the defined flow rules
4528 Disabling isolated mode::
4530 testpmd> flow isolate 0 false
4531 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4534 Dumping HW internal information
4535 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4537 ``flow dump`` dumps the hardware's internal representation information of
4538 all flows. It is bound to ``rte_flow_dev_dump()``::
4540 flow dump {port_id} {output_file}
4542 If successful, it will show::
4546 Otherwise, it will complain error occurred::
4548 Caught error type [...] ([...]): [...]
4550 Listing and destroying aged flow rules
4551 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4553 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4554 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4556 flow aged {port_id} [destroy]
4558 Listing current aged flow rules::
4560 testpmd> flow aged 0
4561 Port 0 total aged flows: 0
4562 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4563 actions age timeout 5 / queue index 0 / end
4564 Flow rule #0 created
4565 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4566 actions age timeout 4 / queue index 0 / end
4567 Flow rule #1 created
4568 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4569 actions age timeout 2 / queue index 0 / end
4570 Flow rule #2 created
4571 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4572 actions age timeout 3 / queue index 0 / end
4573 Flow rule #3 created
4576 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4577 information, all the aged flows are sorted by the longest timeout time. For example, if
4578 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4579 will be ID 3, ID 1, ID 0::
4581 testpmd> flow aged 0
4582 Port 0 total aged flows: 4
4589 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4591 testpmd> flow aged 0 destroy
4592 Port 0 total aged flows: 4
4599 Flow rule #2 destroyed
4600 Flow rule #3 destroyed
4601 Flow rule #1 destroyed
4602 Flow rule #0 destroyed
4603 4 flows be destroyed
4604 testpmd> flow aged 0
4605 Port 0 total aged flows: 0
4608 Sample QinQ flow rules
4609 ~~~~~~~~~~~~~~~~~~~~~~
4611 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4613 testpmd> port stop 0
4614 testpmd> vlan set qinq_strip on 0
4616 The above command sets the inner and outer TPID's to 0x8100.
4618 To change the TPID's the following commands should be used::
4620 testpmd> vlan set outer tpid 0xa100 0
4621 testpmd> vlan set inner tpid 0x9100 0
4622 testpmd> port start 0
4624 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4628 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4629 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4630 Flow rule #0 validated
4632 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4633 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4634 Flow rule #0 created
4636 testpmd> flow list 0
4637 ID Group Prio Attr Rule
4638 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4640 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4644 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4645 vlan tci is 654 / end actions pf / queue index 0 / end
4646 Flow rule #1 validated
4648 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4649 vlan tci is 654 / end actions pf / queue index 1 / end
4650 Flow rule #1 created
4652 testpmd> flow list 0
4653 ID Group Prio Attr Rule
4654 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4655 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4657 Sample VXLAN encapsulation rule
4658 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4660 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4661 source code, those can be changed by using the following commands
4663 IPv4 VXLAN outer header::
4665 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4666 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4667 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4670 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4671 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4672 eth-dst 22:22:22:22:22:22
4673 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4676 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4677 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4678 eth-dst 22:22:22:22:22:22
4679 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4682 IPv6 VXLAN outer header::
4684 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4685 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4686 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4689 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4690 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4691 eth-dst 22:22:22:22:22:22
4692 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4695 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4696 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4697 eth-dst 22:22:22:22:22:22
4698 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4701 Sample NVGRE encapsulation rule
4702 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4704 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4705 source code, those can be changed by using the following commands
4707 IPv4 NVGRE outer header::
4709 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4710 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4711 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4714 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4715 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4716 eth-dst 22:22:22:22:22:22
4717 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4720 IPv6 NVGRE outer header::
4722 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4723 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4724 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4727 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4728 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4729 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4732 Sample L2 encapsulation rule
4733 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4735 L2 encapsulation has default value pre-configured in testpmd
4736 source code, those can be changed by using the following commands
4740 testpmd> set l2_encap ip-version ipv4
4741 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4742 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4743 mplsoudp_decap / l2_encap / end
4745 L2 with VXLAN header::
4747 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4748 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4749 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4750 mplsoudp_decap / l2_encap / end
4752 Sample L2 decapsulation rule
4753 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4755 L2 decapsulation has default value pre-configured in testpmd
4756 source code, those can be changed by using the following commands
4760 testpmd> set l2_decap
4761 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4764 L2 with VXLAN header::
4766 testpmd> set l2_encap-with-vlan
4767 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4770 Sample MPLSoGRE encapsulation rule
4771 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4773 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4774 source code, those can be changed by using the following commands
4776 IPv4 MPLSoGRE outer header::
4778 testpmd> set mplsogre_encap ip-version ipv4 label 4
4779 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4780 eth-dst 22:22:22:22:22:22
4781 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4782 mplsogre_encap / end
4784 IPv4 MPLSoGRE with VLAN outer header::
4786 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4787 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4788 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4789 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4790 mplsogre_encap / end
4792 IPv6 MPLSoGRE outer header::
4794 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4795 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4796 eth-dst 22:22:22:22:22:22
4797 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4798 mplsogre_encap / end
4800 IPv6 MPLSoGRE with VLAN outer header::
4802 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4803 ip-src ::1 ip-dst ::2222 vlan-tci 34
4804 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4805 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4806 mplsogre_encap / end
4808 Sample MPLSoGRE decapsulation rule
4809 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4811 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4812 source code, those can be changed by using the following commands
4814 IPv4 MPLSoGRE outer header::
4816 testpmd> set mplsogre_decap ip-version ipv4
4817 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4818 mplsogre_decap / l2_encap / end
4820 IPv4 MPLSoGRE with VLAN outer header::
4822 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4823 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4824 actions mplsogre_decap / l2_encap / end
4826 IPv6 MPLSoGRE outer header::
4828 testpmd> set mplsogre_decap ip-version ipv6
4829 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4830 actions mplsogre_decap / l2_encap / end
4832 IPv6 MPLSoGRE with VLAN outer header::
4834 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4835 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4836 actions mplsogre_decap / l2_encap / end
4838 Sample MPLSoUDP encapsulation rule
4839 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4841 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4842 source code, those can be changed by using the following commands
4844 IPv4 MPLSoUDP outer header::
4846 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4847 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4848 eth-dst 22:22:22:22:22:22
4849 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4850 mplsoudp_encap / end
4852 IPv4 MPLSoUDP with VLAN outer header::
4854 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4855 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4856 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4857 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4858 mplsoudp_encap / end
4860 IPv6 MPLSoUDP outer header::
4862 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4863 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4864 eth-dst 22:22:22:22:22:22
4865 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4866 mplsoudp_encap / end
4868 IPv6 MPLSoUDP with VLAN outer header::
4870 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4871 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4872 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4873 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4874 mplsoudp_encap / end
4876 Sample MPLSoUDP decapsulation rule
4877 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4879 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4880 source code, those can be changed by using the following commands
4882 IPv4 MPLSoUDP outer header::
4884 testpmd> set mplsoudp_decap ip-version ipv4
4885 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4886 mplsoudp_decap / l2_encap / end
4888 IPv4 MPLSoUDP with VLAN outer header::
4890 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4891 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4892 actions mplsoudp_decap / l2_encap / end
4894 IPv6 MPLSoUDP outer header::
4896 testpmd> set mplsoudp_decap ip-version ipv6
4897 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4898 actions mplsoudp_decap / l2_encap / end
4900 IPv6 MPLSoUDP with VLAN outer header::
4902 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4903 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4904 actions mplsoudp_decap / l2_encap / end
4906 Sample Raw encapsulation rule
4907 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4909 Raw encapsulation configuration can be set by the following commands
4911 Eecapsulating VxLAN::
4913 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4914 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4916 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4917 raw_encap index 4 / end
4919 Sample Raw decapsulation rule
4920 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4922 Raw decapsulation configuration can be set by the following commands
4924 Decapsulating VxLAN::
4926 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4927 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4928 end actions raw_decap / queue index 0 / end
4933 ESP rules can be created by the following commands::
4935 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
4937 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
4938 actions queue index 3 / end
4939 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
4941 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
4942 actions queue index 3 / end
4947 AH rules can be created by the following commands::
4949 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
4951 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
4952 actions queue index 3 / end
4953 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
4955 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
4956 actions queue index 3 / end
4961 PFCP rules can be created by the following commands(s_field need to be 1
4964 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
4965 actions queue index 3 / end
4966 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
4967 seid is 1 / end actions queue index 3 / end
4968 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
4969 actions queue index 3 / end
4970 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
4971 seid is 1 / end actions queue index 3 / end
4976 The following sections show functions to load/unload eBPF based filters.
4981 Load an eBPF program as a callback for particular RX/TX queue::
4983 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4985 The available load-flags are:
4987 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4989 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4995 You'll need clang v3.7 or above to build bpf program you'd like to load
4999 .. code-block:: console
5002 clang -O2 -target bpf -c t1.c
5004 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
5006 .. code-block:: console
5008 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
5010 To load (not JITed) t1.o at TX queue 0, port 0:
5012 .. code-block:: console
5014 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
5019 Unload previously loaded eBPF program for particular RX/TX queue::
5021 testpmd> bpf-unload rx|tx (portid) (queueid)
5023 For example to unload BPF filter from TX queue 0, port 0:
5025 .. code-block:: console
5027 testpmd> bpf-unload tx 0 0