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 ./dpdk-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:
221 show port (module_eeprom|eeprom)
222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
224 Display the EEPROM information of a port::
226 testpmd> show port (port_id) (module_eeprom|eeprom)
231 Display the rss redirection table entry indicated by masks on port X::
233 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
235 size is used to indicate the hardware supported reta size
240 Display the RSS hash functions and RSS hash key of a port::
242 testpmd> show port (port_id) rss-hash [key]
247 Clear the port statistics and forward engine statistics for a given port or for all ports::
249 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
253 testpmd> clear port stats all
258 Display information for a given port's RX/TX queue::
260 testpmd> show (rxq|txq) info (port_id) (queue_id)
262 show desc status(rxq|txq)
263 ~~~~~~~~~~~~~~~~~~~~~~~~~
265 Display information for a given port's RX/TX descriptor status::
267 testpmd> show port (port_id) (rxq|txq) (queue_id) desc (desc_id) status
273 Displays the configuration of the application.
274 The configuration comes from the command-line, the runtime or the application defaults::
276 testpmd> show config (rxtx|cores|fwd|rxoffs|rxpkts|txpkts|txtimes)
278 The available information categories are:
280 * ``rxtx``: RX/TX configuration items.
282 * ``cores``: List of forwarding cores.
284 * ``fwd``: Packet forwarding configuration.
286 * ``rxoffs``: Packet offsets for RX split.
288 * ``rxpkts``: Packets to RX split configuration.
290 * ``txpkts``: Packets to TX configuration.
292 * ``txtimes``: Burst time pattern for Tx only mode.
296 .. code-block:: console
298 testpmd> show config rxtx
300 io packet forwarding - CRC stripping disabled - packets/burst=16
301 nb forwarding cores=2 - nb forwarding ports=1
302 RX queues=1 - RX desc=128 - RX free threshold=0
303 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
304 TX queues=1 - TX desc=512 - TX free threshold=0
305 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
306 TX RS bit threshold=0 - TXQ flags=0x0
311 Set the packet forwarding mode::
313 testpmd> set fwd (io|mac|macswap|flowgen| \
314 rxonly|txonly|csum|icmpecho|noisy|5tswap) (""|retry)
316 ``retry`` can be specified for forwarding engines except ``rx_only``.
318 The available information categories are:
320 * ``io``: Forwards packets "as-is" in I/O mode.
321 This is the fastest possible forwarding operation as it does not access packets data.
322 This is the default mode.
324 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
325 Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination
326 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
327 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
329 * ``macswap``: MAC swap forwarding mode.
330 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
332 * ``flowgen``: Multi-flow generation mode.
333 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
335 * ``rxonly``: Receives packets but doesn't transmit them.
337 * ``txonly``: Generates and transmits packets without receiving any.
339 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
341 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
343 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX.
345 * ``noisy``: Noisy neighbor simulation.
346 Simulate more realistic behavior of a guest machine engaged in receiving
347 and sending packets performing Virtual Network Function (VNF).
349 * ``5tswap``: Swap the source and destination of L2,L3,L4 if they exist.
351 L2 swaps the source address and destination address of Ethernet, as same as ``macswap``.
353 L3 swaps the source address and destination address of IP (v4 and v6).
355 L4 swaps the source port and destination port of transport layer (TCP and UDP).
359 testpmd> set fwd rxonly
361 Set rxonly packet forwarding mode
367 When running, forwarding engines maintain statistics from the time they have been started.
368 Example for the io forwarding engine, with some packet drops on the tx side::
370 testpmd> show fwd stats all
372 ------- Forward Stats for RX Port= 0/Queue= 0 -> TX Port= 1/Queue= 0 -------
373 RX-packets: 274293770 TX-packets: 274293642 TX-dropped: 128
375 ------- Forward Stats for RX Port= 1/Queue= 0 -> TX Port= 0/Queue= 0 -------
376 RX-packets: 274301850 TX-packets: 274301850 TX-dropped: 0
378 ---------------------- Forward statistics for port 0 ----------------------
379 RX-packets: 274293802 RX-dropped: 0 RX-total: 274293802
380 TX-packets: 274301862 TX-dropped: 0 TX-total: 274301862
381 ----------------------------------------------------------------------------
383 ---------------------- Forward statistics for port 1 ----------------------
384 RX-packets: 274301894 RX-dropped: 0 RX-total: 274301894
385 TX-packets: 274293706 TX-dropped: 128 TX-total: 274293834
386 ----------------------------------------------------------------------------
388 +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
389 RX-packets: 548595696 RX-dropped: 0 RX-total: 548595696
390 TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
391 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
397 Clear the forwarding engines statistics::
399 testpmd> clear fwd stats all
404 Display an RX descriptor for a port RX queue::
406 testpmd> read rxd (port_id) (queue_id) (rxd_id)
410 testpmd> read rxd 0 0 4
411 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
416 Display a TX descriptor for a port TX queue::
418 testpmd> read txd (port_id) (queue_id) (txd_id)
422 testpmd> read txd 0 0 4
423 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
428 Get loaded dynamic device personalization (DDP) package info list::
430 testpmd> ddp get list (port_id)
435 Display information about dynamic device personalization (DDP) profile::
437 testpmd> ddp get info (profile_path)
442 Display VF statistics::
444 testpmd> show vf stats (port_id) (vf_id)
449 Reset VF statistics::
451 testpmd> clear vf stats (port_id) (vf_id)
453 show port pctype mapping
454 ~~~~~~~~~~~~~~~~~~~~~~~~
456 List all items from the pctype mapping table::
458 testpmd> show port (port_id) pctype mapping
460 show rx offloading capabilities
461 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
463 List all per queue and per port Rx offloading capabilities of a port::
465 testpmd> show port (port_id) rx_offload capabilities
467 show rx offloading configuration
468 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
470 List port level and all queue level Rx offloading configuration::
472 testpmd> show port (port_id) rx_offload configuration
474 show tx offloading capabilities
475 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
477 List all per queue and per port Tx offloading capabilities of a port::
479 testpmd> show port (port_id) tx_offload capabilities
481 show tx offloading configuration
482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
484 List port level and all queue level Tx offloading configuration::
486 testpmd> show port (port_id) tx_offload configuration
488 show tx metadata setting
489 ~~~~~~~~~~~~~~~~~~~~~~~~
491 Show Tx metadata value set for a specific port::
493 testpmd> show port (port_id) tx_metadata
495 show port supported ptypes
496 ~~~~~~~~~~~~~~~~~~~~~~~~~~
498 Show ptypes supported for a specific port::
500 testpmd> show port (port_id) ptypes
502 set port supported ptypes
503 ~~~~~~~~~~~~~~~~~~~~~~~~~
505 set packet types classification for a specific port::
507 testpmd> set port (port_id) ptypes_mask (mask)
509 show port mac addresses info
510 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
512 Show mac addresses added for a specific port::
514 testpmd> show port (port_id) macs
517 show port multicast mac addresses info
518 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
520 Show multicast mac addresses added for a specific port::
522 testpmd> show port (port_id) mcast_macs
527 Show general information about devices probed::
529 testpmd> show device info (<identifier>|all)
533 .. code-block:: console
535 testpmd> show device info net_pcap0
537 ********************* Infos for device net_pcap0 *********************
539 Driver name: net_pcap
540 Devargs: iface=enP2p6s0,phy_mac=1
541 Connect to socket: -1
544 MAC address: 1E:37:93:28:04:B8
545 Device name: net_pcap0
550 Dumps all physical memory segment layouts::
552 testpmd> dump_physmem
557 Dumps the layout of all memory zones::
559 testpmd> dump_memzone
564 Dumps the memory usage of all sockets::
566 testpmd> dump_socket_mem
571 Dumps the size of all memory structures::
573 testpmd> dump_struct_sizes
578 Dumps the status of all or specific element in DPDK rings::
580 testpmd> dump_ring [ring_name]
585 Dumps the statistics of all or specific memory pool::
587 testpmd> dump_mempool [mempool_name]
592 Dumps the user device list::
594 testpmd> dump_devargs
599 Dumps the log level for all the dpdk modules::
601 testpmd> dump_log_types
603 show (raw_encap|raw_decap)
604 ~~~~~~~~~~~~~~~~~~~~~~~~~~
606 Display content of raw_encap/raw_decap buffers in hex::
608 testpmd> show <raw_encap|raw_decap> <index>
609 testpmd> show <raw_encap|raw_decap> all
613 testpmd> show raw_encap 6
615 index: 6 at [0x1c565b0], len=50
616 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
617 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
618 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
621 show fec capabilities
622 ~~~~~~~~~~~~~~~~~~~~~
624 Show fec capabilities of a port::
626 testpmd> show port (port_id) fec capabilities
631 Show fec mode of a port::
633 testpmd> show port (port_id) fec_mode
636 Configuration Functions
637 -----------------------
639 The testpmd application can be configured from the runtime as well as from the command-line.
641 This section details the available configuration functions that are available.
645 Configuration changes only become active when forwarding is started/restarted.
650 Reset forwarding to the default configuration::
657 Set the debug verbosity level::
659 testpmd> set verbose (level)
661 Available levels are as following:
663 * ``0`` silent except for error.
664 * ``1`` fully verbose except for Tx packets.
665 * ``2`` fully verbose except for Rx packets.
666 * ``> 2`` fully verbose.
671 Set the log level for a log type::
673 testpmd> set log global|(type) (level)
677 * ``type`` is the log name.
679 * ``level`` is the log level.
681 For example, to change the global log level::
683 testpmd> set log global (level)
685 Regexes can also be used for type. To change log level of user1, user2 and user3::
687 testpmd> set log user[1-3] (level)
692 Set the number of ports used by the application:
696 This is equivalent to the ``--nb-ports`` command-line option.
701 Set the number of cores used by the application::
703 testpmd> set nbcore (num)
705 This is equivalent to the ``--nb-cores`` command-line option.
709 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
714 Set the forwarding cores hexadecimal mask::
716 testpmd> set coremask (mask)
718 This is equivalent to the ``--coremask`` command-line option.
722 The main lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
727 Set the forwarding ports hexadecimal mask::
729 testpmd> set portmask (mask)
731 This is equivalent to the ``--portmask`` command-line option.
733 set record-core-cycles
734 ~~~~~~~~~~~~~~~~~~~~~~
736 Set the recording of CPU cycles::
738 testpmd> set record-core-cycles (on|off)
742 * ``on`` enables measurement of CPU cycles per packet.
744 * ``off`` disables measurement of CPU cycles per packet.
746 This is equivalent to the ``--record-core-cycles command-line`` option.
748 set record-burst-stats
749 ~~~~~~~~~~~~~~~~~~~~~~
751 Set the displaying of RX and TX bursts::
753 testpmd> set record-burst-stats (on|off)
757 * ``on`` enables display of RX and TX bursts.
759 * ``off`` disables display of RX and TX bursts.
761 This is equivalent to the ``--record-burst-stats command-line`` option.
766 Set number of packets per burst::
768 testpmd> set burst (num)
770 This is equivalent to the ``--burst command-line`` option.
772 When retry is enabled, the transmit delay time and number of retries can also be set::
774 testpmd> set burst tx delay (microseconds) retry (num)
779 Set the offsets of segments relating to the data buffer beginning on receiving
780 if split feature is engaged. Affects only the queues configured with split
781 offloads (currently BUFFER_SPLIT is supported only).
783 testpmd> set rxoffs (x[,y]*)
785 Where x[,y]* represents a CSV list of values, without white space. If the list
786 of offsets is shorter than the list of segments the zero offsets will be used
787 for the remaining segments.
792 Set the length of segments to scatter packets on receiving if split
793 feature is engaged. Affects only the queues configured with split offloads
794 (currently BUFFER_SPLIT is supported only). Optionally the multiple memory
795 pools can be specified with --mbuf-size command line parameter and the mbufs
796 to receive will be allocated sequentially from these extra memory pools (the
797 mbuf for the first segment is allocated from the first pool, the second one
798 from the second pool, and so on, if segment number is greater then pool's the
799 mbuf for remaining segments will be allocated from the last valid pool).
801 testpmd> set rxpkts (x[,y]*)
803 Where x[,y]* represents a CSV list of values, without white space. Zero value
804 means to use the corresponding memory pool data buffer size.
809 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
811 testpmd> set txpkts (x[,y]*)
813 Where x[,y]* represents a CSV list of values, without white space.
818 Configure the timing burst pattern for Tx only mode. This command enables
819 the packet send scheduling on dynamic timestamp mbuf field and configures
820 timing pattern in Tx only mode. In this mode, if scheduling is enabled
821 application provides timestamps in the packets being sent. It is possible
822 to configure delay (in unspecified device clock units) between bursts
823 and between the packets within the burst::
825 testpmd> set txtimes (inter),(intra)
829 * ``inter`` is the delay between the bursts in the device clock units.
830 If ``intra`` is zero, this is the time between the beginnings of the
831 first packets in the neighbour bursts, if ``intra`` is not zero,
832 ``inter`` specifies the time between the beginning of the first packet
833 of the current burst and the beginning of the last packet of the
834 previous burst. If ``inter`` parameter is zero the send scheduling
835 on timestamps is disabled (default).
837 * ``intra`` is the delay between the packets within the burst specified
838 in the device clock units. The number of packets in the burst is defined
839 by regular burst setting. If ``intra`` parameter is zero no timestamps
840 provided in the packets excepting the first one in the burst.
842 As the result the bursts of packet will be transmitted with specific
843 delays between the packets within the burst and specific delay between
844 the bursts. The rte_eth_read_clock() must be supported by the device(s)
845 and is supposed to be engaged to get the current device clock value
846 and provide the reference for the timestamps. If there is no supported
847 rte_eth_read_clock() there will be no send scheduling provided on the port.
852 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
854 testpmd> set txsplit (off|on|rand)
858 * ``off`` disable packet copy & split for CSUM mode.
860 * ``on`` split outgoing packet into multiple segments. Size of each segment
861 and number of segments per packet is determined by ``set txpkts`` command
864 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
869 Set the list of forwarding cores::
871 testpmd> set corelist (x[,y]*)
873 For example, to change the forwarding cores:
875 .. code-block:: console
877 testpmd> set corelist 3,1
878 testpmd> show config fwd
880 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
881 Logical Core 3 (socket 0) forwards packets on 1 streams:
882 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
883 Logical Core 1 (socket 0) forwards packets on 1 streams:
884 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
888 The cores are used in the same order as specified on the command line.
893 Set the list of forwarding ports::
895 testpmd> set portlist (x[,y]*)
897 For example, to change the port forwarding:
899 .. code-block:: console
901 testpmd> set portlist 0,2,1,3
902 testpmd> show config fwd
904 io packet forwarding - ports=4 - cores=1 - streams=4
905 Logical Core 3 (socket 0) forwards packets on 4 streams:
906 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
907 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
908 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
909 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
914 Select how to retrieve new ports created after "port attach" command::
916 testpmd> set port setup on (iterator|event)
918 For each new port, a setup is done.
919 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
920 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
925 Enable/disable tx loopback::
927 testpmd> set tx loopback (port_id) (on|off)
932 set drop enable bit for all queues::
934 testpmd> set all queues drop (port_id) (on|off)
936 set split drop enable (for VF)
937 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
939 set split drop enable bit for VF from PF::
941 testpmd> set vf split drop (port_id) (vf_id) (on|off)
943 set mac antispoof (for VF)
944 ~~~~~~~~~~~~~~~~~~~~~~~~~~
946 Set mac antispoof for a VF from the PF::
948 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
953 Enable/disable MACsec offload::
955 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
956 testpmd> set macsec offload (port_id) off
961 Configure MACsec secure connection (SC)::
963 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
967 The pi argument is ignored for tx.
968 Check the NIC Datasheet for hardware limits.
973 Configure MACsec secure association (SA)::
975 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
979 The IDX value must be 0 or 1.
980 Check the NIC Datasheet for hardware limits.
982 set broadcast mode (for VF)
983 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
985 Set broadcast mode for a VF from the PF::
987 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
992 Set the VLAN strip for a queue on a port::
994 testpmd> vlan set stripq (on|off) (port_id,queue_id)
996 vlan set stripq (for VF)
997 ~~~~~~~~~~~~~~~~~~~~~~~~
999 Set VLAN strip for all queues in a pool for a VF from the PF::
1001 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
1003 vlan set insert (for VF)
1004 ~~~~~~~~~~~~~~~~~~~~~~~~
1006 Set VLAN insert for a VF from the PF::
1008 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
1010 vlan set tag (for VF)
1011 ~~~~~~~~~~~~~~~~~~~~~
1013 Set VLAN tag for a VF from the PF::
1015 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
1017 vlan set antispoof (for VF)
1018 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1020 Set VLAN antispoof for a VF from the PF::
1022 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
1024 vlan set (strip|filter|qinq_strip|extend)
1025 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1026 Set the VLAN strip/filter/QinQ strip/extend on for a port::
1028 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
1033 Set the inner or outer VLAN TPID for packet filtering on a port::
1035 testpmd> vlan set (inner|outer) tpid (value) (port_id)
1039 TPID value must be a 16-bit number (value <= 65536).
1044 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
1046 testpmd> rx_vlan add (vlan_id|all) (port_id)
1050 VLAN filter must be set on that port. VLAN ID < 4096.
1051 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
1052 in VFTA table. This is important if enabling all vlan_ids.
1057 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
1059 testpmd> rx_vlan rm (vlan_id|all) (port_id)
1061 rx_vlan add (for VF)
1062 ~~~~~~~~~~~~~~~~~~~~
1064 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
1066 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
1071 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
1073 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
1078 Add a tunnel filter on a port::
1080 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
1081 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
1082 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1084 The available information categories are:
1086 * ``vxlan``: Set tunnel type as VXLAN.
1088 * ``nvgre``: Set tunnel type as NVGRE.
1090 * ``ipingre``: Set tunnel type as IP-in-GRE.
1092 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
1094 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
1096 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
1098 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
1100 * ``imac``: Set filter type as Inner MAC.
1102 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
1104 * ``oip``: Set filter type as Outer IP.
1106 * ``iip``: Set filter type as Inner IP.
1110 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
1111 192.168.2.2 0 ipingre oip 1 1
1113 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
1115 tunnel_filter remove
1116 ~~~~~~~~~~~~~~~~~~~~
1118 Remove a tunnel filter on a port::
1120 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
1121 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
1122 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1127 Add an UDP port for VXLAN packet filter on a port::
1129 testpmd> rx_vxlan_port add (udp_port) (port_id)
1131 rx_vxlan_port remove
1132 ~~~~~~~~~~~~~~~~~~~~
1134 Remove an UDP port for VXLAN packet filter on a port::
1136 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1141 Set hardware insertion of VLAN IDs in packets sent on a port::
1143 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1145 For example, set a single VLAN ID (5) insertion on port 0::
1149 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1157 Set port based hardware insertion of VLAN ID in packets sent on a port::
1159 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1164 Disable hardware insertion of a VLAN header in packets sent on a port::
1166 testpmd> tx_vlan reset (port_id)
1171 Select hardware or software calculation of the checksum when
1172 transmitting a packet using the ``csum`` forwarding engine::
1174 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1178 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1180 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1181 as a tunnel packet by the forwarding engine (geneve, gre, gtp, ipip, vxlan and vxlan-gpe are
1182 supported). See also the ``csum parse-tunnel`` command.
1184 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1185 as a tunnel packet by the forwarding engine (geneve, gtp, vxlan and vxlan-gpe are
1186 supported). See also the ``csum parse-tunnel`` command.
1190 Check the NIC Datasheet for hardware limits.
1195 Set RSS queue region span on a port::
1197 testpmd> set port (port_id) queue-region region_id (value) \
1198 queue_start_index (value) queue_num (value)
1200 Set flowtype mapping on a RSS queue region on a port::
1202 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1206 * For the flowtype(pctype) of packet,the specific index for each type has
1207 been defined in file i40e_type.h as enum i40e_filter_pctype.
1209 Set user priority mapping on a RSS queue region on a port::
1211 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1213 Flush all queue region related configuration on a port::
1215 testpmd> set port (port_id) queue-region flush (on|off)
1219 * ``on``: is just an enable function which server for other configuration,
1220 it is for all configuration about queue region from up layer,
1221 at first will only keep in DPDK software stored in driver,
1222 only after "flush on", it commit all configuration to HW.
1224 * ``"off``: is just clean all configuration about queue region just now,
1225 and restore all to DPDK i40e driver default config when start up.
1227 Show all queue region related configuration info on a port::
1229 testpmd> show port (port_id) queue-region
1233 Queue region only support on PF by now, so these command is
1234 only for configuration of queue region on PF port.
1239 Define how tunneled packets should be handled by the csum forward
1242 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1244 If enabled, the csum forward engine will try to recognize supported
1245 tunnel headers (geneve, gtp, gre, ipip, vxlan, vxlan-gpe).
1247 If disabled, treat tunnel packets as non-tunneled packets (a inner
1248 header is handled as a packet payload).
1252 The port argument is the TX port like in the ``csum set`` command.
1256 Consider a packet in packet like the following::
1258 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1260 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1261 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1262 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1264 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1265 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1270 Display tx checksum offload configuration::
1272 testpmd> csum show (port_id)
1277 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1279 testpmd> tso set (segsize) (port_id)
1283 Check the NIC datasheet for hardware limits.
1288 Display the status of TCP Segmentation Offload::
1290 testpmd> tso show (port_id)
1295 Set tso segment size of tunneled packets for a port in csum engine::
1297 testpmd> tunnel_tso set (tso_segsz) (port_id)
1302 Display the status of tunneled TCP Segmentation Offload for a port::
1304 testpmd> tunnel_tso show (port_id)
1309 Enable or disable GRO in ``csum`` forwarding engine::
1311 testpmd> set port <port_id> gro on|off
1313 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1314 packets received from the given port.
1316 If disabled, packets received from the given port won't be performed
1317 GRO. By default, GRO is disabled for all ports.
1321 When enable GRO for a port, TCP/IPv4 packets received from the port
1322 will be performed GRO. After GRO, all merged packets have bad
1323 checksums, since the GRO library doesn't re-calculate checksums for
1324 the merged packets. Therefore, if users want the merged packets to
1325 have correct checksums, please select HW IP checksum calculation and
1326 HW TCP checksum calculation for the port which the merged packets are
1332 Display GRO configuration for a given port::
1334 testpmd> show port <port_id> gro
1339 Set the cycle to flush the GROed packets from reassembly tables::
1341 testpmd> set gro flush <cycles>
1343 When enable GRO, the csum forwarding engine performs GRO on received
1344 packets, and the GROed packets are stored in reassembly tables. Users
1345 can use this command to determine when the GROed packets are flushed
1346 from the reassembly tables.
1348 The ``cycles`` is measured in GRO operation times. The csum forwarding
1349 engine flushes the GROed packets from the tables every ``cycles`` GRO
1352 By default, the value of ``cycles`` is 1, which means flush GROed packets
1353 from the reassembly tables as soon as one GRO operation finishes. The value
1354 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1356 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1357 stack performance. Because the GROed packets are delayed to arrive the
1358 stack, thus causing more duplicated ACKs and TCP retransmissions.
1363 Toggle per-port GSO support in ``csum`` forwarding engine::
1365 testpmd> set port <port_id> gso on|off
1367 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1368 packets, transmitted on the given port.
1370 If disabled, packets transmitted on the given port will not undergo GSO.
1371 By default, GSO is disabled for all ports.
1375 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1376 port undergo GSO. Afterwards, the segmented packets are represented by
1377 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1378 of checksums for GSO'd segments in SW. As a result, if users want correct
1379 checksums in GSO segments, they should enable HW checksum calculation for
1382 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1383 by setting the following options in the csum forwarding engine:
1385 testpmd> csum set outer_ip hw <port_id>
1387 testpmd> csum set ip hw <port_id>
1389 testpmd> csum set tcp hw <port_id>
1391 UDP GSO is the same as IP fragmentation, which treats the UDP header
1392 as the payload and does not modify it during segmentation. That is,
1393 after UDP GSO, only the first output fragment has the original UDP
1394 header. Therefore, users need to enable HW IP checksum calculation
1395 and SW UDP checksum calculation for GSO-enabled ports, if they want
1396 correct checksums for UDP/IPv4 packets.
1401 Set the maximum GSO segment size (measured in bytes), which includes the
1402 packet header and the packet payload for GSO-enabled ports (global)::
1404 testpmd> set gso segsz <length>
1409 Display the status of Generic Segmentation Offload for a given port::
1411 testpmd> show port <port_id> gso
1416 Add an alternative MAC address to a port::
1418 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1423 Remove a MAC address from a port::
1425 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1430 To add the multicast MAC address to/from the set of multicast addresses
1433 testpmd> mcast_addr add (port_id) (mcast_addr)
1438 To remove the multicast MAC address to/from the set of multicast addresses
1441 testpmd> mcast_addr remove (port_id) (mcast_addr)
1443 mac_addr add (for VF)
1444 ~~~~~~~~~~~~~~~~~~~~~
1446 Add an alternative MAC address for a VF to a port::
1448 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1453 Set the default MAC address for a port::
1455 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1457 mac_addr set (for VF)
1458 ~~~~~~~~~~~~~~~~~~~~~
1460 Set the MAC address for a VF from the PF::
1462 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1467 Set the forwarding peer address for certain port::
1469 testpmd> set eth-peer (port_id) (peer_addr)
1471 This is equivalent to the ``--eth-peer`` command-line option.
1476 Set the unicast hash filter(s) on/off for a port::
1478 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1483 Set the promiscuous mode on for a port or for all ports.
1484 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1486 testpmd> set promisc (port_id|all) (on|off)
1491 Set the allmulti mode for a port or for all ports::
1493 testpmd> set allmulti (port_id|all) (on|off)
1495 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1497 set promisc (for VF)
1498 ~~~~~~~~~~~~~~~~~~~~
1500 Set the unicast promiscuous mode for a VF from PF.
1501 It's supported by Intel i40e NICs now.
1502 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1504 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1506 set allmulticast (for VF)
1507 ~~~~~~~~~~~~~~~~~~~~~~~~~
1509 Set the multicast promiscuous mode for a VF from PF.
1510 It's supported by Intel i40e NICs now.
1511 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1513 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1515 set tx max bandwidth (for VF)
1516 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1518 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1520 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1522 set tc tx min bandwidth (for VF)
1523 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1525 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1527 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1529 set tc tx max bandwidth (for VF)
1530 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1532 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1534 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1536 set tc strict link priority mode
1537 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1539 Set some TCs' strict link priority mode on a physical port::
1541 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1543 set tc tx min bandwidth
1544 ~~~~~~~~~~~~~~~~~~~~~~~
1546 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1548 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1553 Set the link flow control parameter on a port::
1555 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1556 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1557 autoneg (on|off) (port_id)
1561 * ``high_water`` (integer): High threshold value to trigger XOFF.
1563 * ``low_water`` (integer): Low threshold value to trigger XON.
1565 * ``pause_time`` (integer): Pause quota in the Pause frame.
1567 * ``send_xon`` (0/1): Send XON frame.
1569 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1571 * ``autoneg``: Change the auto-negotiation parameter.
1576 Set the priority flow control parameter on a port::
1578 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1579 (pause_time) (priority) (port_id)
1583 * ``high_water`` (integer): High threshold value.
1585 * ``low_water`` (integer): Low threshold value.
1587 * ``pause_time`` (integer): Pause quota in the Pause frame.
1589 * ``priority`` (0-7): VLAN User Priority.
1594 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1596 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1598 For example, to set rx queue 2 on port 0 to mapping 5::
1600 testpmd>set stat_qmap rx 0 2 5
1602 set xstats-hide-zero
1603 ~~~~~~~~~~~~~~~~~~~~
1605 Set the option to hide zero values for xstats display::
1607 testpmd> set xstats-hide-zero on|off
1611 By default, the zero values are displayed for xstats.
1613 set port - rx/tx (for VF)
1614 ~~~~~~~~~~~~~~~~~~~~~~~~~
1616 Set VF receive/transmit from a port::
1618 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1620 set port - rx mode(for VF)
1621 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1623 Set the VF receive mode of a port::
1625 testpmd> set port (port_id) vf (vf_id) \
1626 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1628 The available receive modes are:
1630 * ``AUPE``: Accepts untagged VLAN.
1632 * ``ROPE``: Accepts unicast hash.
1634 * ``BAM``: Accepts broadcast packets.
1636 * ``MPE``: Accepts all multicast packets.
1638 set port - tx_rate (for Queue)
1639 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1641 Set TX rate limitation for a queue on a port::
1643 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1645 set port - tx_rate (for VF)
1646 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1648 Set TX rate limitation for queues in VF on a port::
1650 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1652 set port - mirror rule
1653 ~~~~~~~~~~~~~~~~~~~~~~
1655 Set pool or vlan type mirror rule for a port::
1657 testpmd> set port (port_id) mirror-rule (rule_id) \
1658 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1659 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1661 Set link mirror rule for a port::
1663 testpmd> set port (port_id) mirror-rule (rule_id) \
1664 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1666 For example to enable mirror traffic with vlan 0,1 to pool 0::
1668 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1670 reset port - mirror rule
1671 ~~~~~~~~~~~~~~~~~~~~~~~~
1673 Reset a mirror rule for a port::
1675 testpmd> reset port (port_id) mirror-rule (rule_id)
1680 Set the flush on RX streams before forwarding.
1681 The default is flush ``on``.
1682 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1684 testpmd> set flush_rx off
1689 Set the bypass mode for the lowest port on bypass enabled NIC::
1691 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1696 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1698 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1699 mode (normal|bypass|isolate) (port_id)
1703 * ``timeout``: Enable bypass after watchdog timeout.
1705 * ``os_on``: Enable bypass when OS/board is powered on.
1707 * ``os_off``: Enable bypass when OS/board is powered off.
1709 * ``power_on``: Enable bypass when power supply is turned on.
1711 * ``power_off``: Enable bypass when power supply is turned off.
1717 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1719 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1724 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1726 testpmd> show bypass config (port_id)
1731 Set link up for a port::
1733 testpmd> set link-up port (port id)
1738 Set link down for a port::
1740 testpmd> set link-down port (port id)
1745 Enable E-tag insertion for a VF on a port::
1747 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1749 Disable E-tag insertion for a VF on a port::
1751 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1753 Enable/disable E-tag stripping on a port::
1755 testpmd> E-tag set stripping (on|off) port (port_id)
1757 Enable/disable E-tag based forwarding on a port::
1759 testpmd> E-tag set forwarding (on|off) port (port_id)
1761 Add an E-tag forwarding filter on a port::
1763 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1765 Delete an E-tag forwarding filter on a port::
1766 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1771 Load a dynamic device personalization (DDP) profile and store backup profile::
1773 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1778 Delete a dynamic device personalization profile and restore backup profile::
1780 testpmd> ddp del (port_id) (backup_profile_path)
1785 List all items from the ptype mapping table::
1787 testpmd> ptype mapping get (port_id) (valid_only)
1791 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1793 Replace a specific or a group of software defined ptype with a new one::
1795 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1799 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1801 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1803 * ``pkt_type``: The new software ptype to replace the old ones.
1805 Update hardware defined ptype to software defined packet type mapping table::
1807 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1811 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1813 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1815 Reset ptype mapping table::
1817 testpmd> ptype mapping reset (port_id)
1819 config per port Rx offloading
1820 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1822 Enable or disable a per port Rx offloading on all Rx queues of a port::
1824 testpmd> port config (port_id) rx_offload (offloading) on|off
1826 * ``offloading``: can be any of these offloading capability:
1827 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1828 qinq_strip, outer_ipv4_cksum, macsec_strip,
1829 header_split, vlan_filter, vlan_extend, jumbo_frame,
1830 scatter, timestamp, security, keep_crc, rss_hash
1832 This command should be run when the port is stopped, or else it will fail.
1834 config per queue Rx offloading
1835 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1837 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1839 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1841 * ``offloading``: can be any of these offloading capability:
1842 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1843 qinq_strip, outer_ipv4_cksum, macsec_strip,
1844 header_split, vlan_filter, vlan_extend, jumbo_frame,
1845 scatter, timestamp, security, keep_crc
1847 This command should be run when the port is stopped, or else it will fail.
1849 config per port Tx offloading
1850 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1852 Enable or disable a per port Tx offloading on all Tx queues of a port::
1854 testpmd> port config (port_id) tx_offload (offloading) on|off
1856 * ``offloading``: can be any of these offloading capability:
1857 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1858 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1859 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1860 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1861 mt_lockfree, multi_segs, mbuf_fast_free, security
1863 This command should be run when the port is stopped, or else it will fail.
1865 config per queue Tx offloading
1866 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1868 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1870 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1872 * ``offloading``: can be any of these offloading capability:
1873 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1874 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1875 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1876 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1877 mt_lockfree, multi_segs, mbuf_fast_free, security
1879 This command should be run when the port is stopped, or else it will fail.
1881 Config VXLAN Encap outer layers
1882 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1884 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1886 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1887 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1890 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1891 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1892 eth-src (eth-src) eth-dst (eth-dst)
1894 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1895 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1896 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1898 These commands will set an internal configuration inside testpmd, any following
1899 flow rule using the action vxlan_encap will use the last configuration set.
1900 To have a different encapsulation header, one of those commands must be called
1901 before the flow rule creation.
1903 Config NVGRE Encap outer layers
1904 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1906 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1908 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1909 eth-src (eth-src) eth-dst (eth-dst)
1910 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1911 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1913 These commands will set an internal configuration inside testpmd, any following
1914 flow rule using the action nvgre_encap will use the last configuration set.
1915 To have a different encapsulation header, one of those commands must be called
1916 before the flow rule creation.
1921 Configure the l2 to be used when encapsulating a packet with L2::
1923 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1924 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1925 eth-src (eth-src) eth-dst (eth-dst)
1927 Those commands will set an internal configuration inside testpmd, any following
1928 flow rule using the action l2_encap will use the last configuration set.
1929 To have a different encapsulation header, one of those commands must be called
1930 before the flow rule creation.
1935 Configure the l2 to be removed when decapsulating a packet with L2::
1937 set l2_decap ip-version (ipv4|ipv6)
1938 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1940 Those commands will set an internal configuration inside testpmd, any following
1941 flow rule using the action l2_decap will use the last configuration set.
1942 To have a different encapsulation header, one of those commands must be called
1943 before the flow rule creation.
1945 Config MPLSoGRE Encap outer layers
1946 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1948 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1950 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1951 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1952 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1953 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1954 eth-src (eth-src) eth-dst (eth-dst)
1956 These commands will set an internal configuration inside testpmd, any following
1957 flow rule using the action mplsogre_encap will use the last configuration set.
1958 To have a different encapsulation header, one of those commands must be called
1959 before the flow rule creation.
1961 Config MPLSoGRE Decap outer layers
1962 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1964 Configure the outer layer to decapsulate MPLSoGRE packet::
1966 set mplsogre_decap ip-version (ipv4|ipv6)
1967 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1969 These commands will set an internal configuration inside testpmd, any following
1970 flow rule using the action mplsogre_decap will use the last configuration set.
1971 To have a different decapsulation header, one of those commands must be called
1972 before the flow rule creation.
1974 Config MPLSoUDP Encap outer layers
1975 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1977 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1979 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1980 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1981 eth-src (eth-src) eth-dst (eth-dst)
1982 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1983 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1984 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1986 These commands will set an internal configuration inside testpmd, any following
1987 flow rule using the action mplsoudp_encap will use the last configuration set.
1988 To have a different encapsulation header, one of those commands must be called
1989 before the flow rule creation.
1991 Config MPLSoUDP Decap outer layers
1992 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1994 Configure the outer layer to decapsulate MPLSoUDP packet::
1996 set mplsoudp_decap ip-version (ipv4|ipv6)
1997 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1999 These commands will set an internal configuration inside testpmd, any following
2000 flow rule using the action mplsoudp_decap will use the last configuration set.
2001 To have a different decapsulation header, one of those commands must be called
2002 before the flow rule creation.
2004 Config Raw Encapsulation
2005 ~~~~~~~~~~~~~~~~~~~~~~~~~
2007 Configure the raw data to be used when encapsulating a packet by
2008 rte_flow_action_raw_encap::
2010 set raw_encap {index} {item} [/ {item} [...]] / end_set
2012 There are multiple global buffers for ``raw_encap``, this command will set one
2013 internal buffer index by ``{index}``.
2014 If there is no ``{index}`` specified::
2016 set raw_encap {item} [/ {item} [...]] / end_set
2018 the default index ``0`` is used.
2019 In order to use different encapsulating header, ``index`` must be specified
2020 during the flow rule creation::
2022 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
2023 raw_encap index 2 / end
2025 Otherwise the default index ``0`` is used.
2027 Config Raw Decapsulation
2028 ~~~~~~~~~~~~~~~~~~~~~~~~
2030 Configure the raw data to be used when decapsulating a packet by
2031 rte_flow_action_raw_decap::
2033 set raw_decap {index} {item} [/ {item} [...]] / end_set
2035 There are multiple global buffers for ``raw_decap``, this command will set
2036 one internal buffer index by ``{index}``.
2037 If there is no ``{index}`` specified::
2039 set raw_decap {item} [/ {item} [...]] / end_set
2041 the default index ``0`` is used.
2042 In order to use different decapsulating header, ``index`` must be specified
2043 during the flow rule creation::
2045 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
2046 raw_encap index 3 / end
2048 Otherwise the default index ``0`` is used.
2053 Set fec mode for a specific port::
2055 testpmd> set port (port_id) fec_mode auto|off|rs|baser
2061 The following sections show functions for configuring ports.
2065 Port configuration changes only become active when forwarding is started/restarted.
2070 Attach a port specified by pci address or virtual device args::
2072 testpmd> port attach (identifier)
2074 To attach a new pci device, the device should be recognized by kernel first.
2075 Then it should be moved under DPDK management.
2076 Finally the port can be attached to testpmd.
2078 For example, to move a pci device using ixgbe under DPDK management:
2080 .. code-block:: console
2082 # Check the status of the available devices.
2083 ./usertools/dpdk-devbind.py --status
2085 Network devices using DPDK-compatible driver
2086 ============================================
2089 Network devices using kernel driver
2090 ===================================
2091 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
2094 # Bind the device to igb_uio.
2095 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
2098 # Recheck the status of the devices.
2099 ./usertools/dpdk-devbind.py --status
2100 Network devices using DPDK-compatible driver
2101 ============================================
2102 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
2104 To attach a port created by virtual device, above steps are not needed.
2106 For example, to attach a port whose pci address is 0000:0a:00.0.
2108 .. code-block:: console
2110 testpmd> port attach 0000:0a:00.0
2111 Attaching a new port...
2112 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2113 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
2114 EAL: PCI memory mapped at 0x7f83bfa00000
2115 EAL: PCI memory mapped at 0x7f83bfa80000
2116 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
2117 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
2118 Port 0 is attached. Now total ports is 1
2121 For example, to attach a port created by pcap PMD.
2123 .. code-block:: console
2125 testpmd> port attach net_pcap0
2126 Attaching a new port...
2127 PMD: Initializing pmd_pcap for net_pcap0
2128 PMD: Creating pcap-backed ethdev on numa socket 0
2129 Port 0 is attached. Now total ports is 1
2132 In this case, identifier is ``net_pcap0``.
2133 This identifier format is the same as ``--vdev`` format of DPDK applications.
2135 For example, to re-attach a bonded port which has been previously detached,
2136 the mode and slave parameters must be given.
2138 .. code-block:: console
2140 testpmd> port attach net_bond_0,mode=0,slave=1
2141 Attaching a new port...
2142 EAL: Initializing pmd_bond for net_bond_0
2143 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2144 Port 0 is attached. Now total ports is 1
2151 Detach a specific port::
2153 testpmd> port detach (port_id)
2155 Before detaching a port, the port should be stopped and closed.
2157 For example, to detach a pci device port 0.
2159 .. code-block:: console
2161 testpmd> port stop 0
2164 testpmd> port close 0
2168 testpmd> port detach 0
2170 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2171 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2172 EAL: PCI memory unmapped at 0x7f83bfa00000
2173 EAL: PCI memory unmapped at 0x7f83bfa80000
2177 For example, to detach a virtual device port 0.
2179 .. code-block:: console
2181 testpmd> port stop 0
2184 testpmd> port close 0
2188 testpmd> port detach 0
2190 PMD: Closing pcap ethdev on numa socket 0
2191 Port 'net_pcap0' is detached. Now total ports is 0
2194 To remove a pci device completely from the system, first detach the port from testpmd.
2195 Then the device should be moved under kernel management.
2196 Finally the device can be removed using kernel pci hotplug functionality.
2198 For example, to move a pci device under kernel management:
2200 .. code-block:: console
2202 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2204 ./usertools/dpdk-devbind.py --status
2206 Network devices using DPDK-compatible driver
2207 ============================================
2210 Network devices using kernel driver
2211 ===================================
2212 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2214 To remove a port created by a virtual device, above steps are not needed.
2219 Start all ports or a specific port::
2221 testpmd> port start (port_id|all)
2226 Stop all ports or a specific port::
2228 testpmd> port stop (port_id|all)
2233 Close all ports or a specific port::
2235 testpmd> port close (port_id|all)
2240 Reset all ports or a specific port::
2242 testpmd> port reset (port_id|all)
2244 User should stop port(s) before resetting and (re-)start after reset.
2246 port config - queue ring size
2247 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2249 Configure a rx/tx queue ring size::
2251 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2253 Only take effect after command that (re-)start the port or command that setup specific queue.
2255 port start/stop queue
2256 ~~~~~~~~~~~~~~~~~~~~~
2258 Start/stop a rx/tx queue on a specific port::
2260 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2262 port config - queue deferred start
2263 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2265 Switch on/off deferred start of a specific port queue::
2267 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2270 ~~~~~~~~~~~~~~~~~~~~~
2272 Setup a rx/tx queue on a specific port::
2274 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2276 Only take effect when port is started.
2281 Set the speed and duplex mode for all ports or a specific port::
2283 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \
2284 duplex (half|full|auto)
2286 port config - queues/descriptors
2287 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2289 Set number of queues/descriptors for rxq, txq, rxd and txd::
2291 testpmd> port config all (rxq|txq|rxd|txd) (value)
2293 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2295 port config - max-pkt-len
2296 ~~~~~~~~~~~~~~~~~~~~~~~~~
2298 Set the maximum packet length::
2300 testpmd> port config all max-pkt-len (value)
2302 This is equivalent to the ``--max-pkt-len`` command-line option.
2304 port config - max-lro-pkt-size
2305 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2307 Set the maximum LRO aggregated packet size::
2309 testpmd> port config all max-lro-pkt-size (value)
2311 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2313 port config - Drop Packets
2314 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2316 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2318 testpmd> port config all drop-en (on|off)
2320 Packet dropping when no receive buffers available is off by default.
2322 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2327 Set the RSS (Receive Side Scaling) mode on or off::
2329 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)
2331 RSS is on by default.
2333 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp.
2335 The ``default`` option enables all supported RSS types reported by device info.
2337 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2339 port config - RSS Reta
2340 ~~~~~~~~~~~~~~~~~~~~~~
2342 Set the RSS (Receive Side Scaling) redirection table::
2344 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2349 Set the DCB mode for an individual port::
2351 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2353 The traffic class should be 4 or 8.
2358 Set the number of packets per burst::
2360 testpmd> port config all burst (value)
2362 This is equivalent to the ``--burst`` command-line option.
2364 port config - Threshold
2365 ~~~~~~~~~~~~~~~~~~~~~~~
2367 Set thresholds for TX/RX queues::
2369 testpmd> port config all (threshold) (value)
2371 Where the threshold type can be:
2373 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2375 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2377 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2379 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2381 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2383 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2385 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2387 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2389 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2391 These threshold options are also available from the command-line.
2396 Set the value of ether-type for E-tag::
2398 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2400 Enable/disable the E-tag support::
2402 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2404 port config pctype mapping
2405 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2407 Reset pctype mapping table::
2409 testpmd> port config (port_id) pctype mapping reset
2411 Update hardware defined pctype to software defined flow type mapping table::
2413 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2417 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2419 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2421 port config input set
2422 ~~~~~~~~~~~~~~~~~~~~~
2424 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2426 testpmd> port config (port_id) pctype (pctype_id) \
2427 (hash_inset|fdir_inset|fdir_flx_inset) \
2428 (get|set|clear) field (field_idx)
2430 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2432 testpmd> port config (port_id) pctype (pctype_id) \
2433 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2437 * ``pctype_id``: hardware packet classification types.
2438 * ``field_idx``: hardware field index.
2440 port config udp_tunnel_port
2441 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2443 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2445 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2447 port config tx_metadata
2448 ~~~~~~~~~~~~~~~~~~~~~~~
2450 Set Tx metadata value per port.
2451 testpmd will add this value to any Tx packet sent from this port::
2453 testpmd> port config (port_id) tx_metadata (value)
2458 Set/clear dynamic flag per port.
2459 testpmd will register this flag in the mbuf (same registration
2460 for both Tx and Rx). Then set/clear this flag for each Tx
2461 packet sent from this port. The set bit only works for Tx packet::
2463 testpmd> port config (port_id) dynf (name) (set|clear)
2468 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2470 testpmd> port config mtu (port_id) (value)
2472 port config rss hash key
2473 ~~~~~~~~~~~~~~~~~~~~~~~~
2475 To configure the RSS hash key used to compute the RSS
2476 hash of input [IP] packets received on port::
2478 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2479 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2480 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2481 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2482 ipv6-udp-ex <string of hex digits \
2483 (variable length, NIC dependent)>)
2488 The following sections show functions for device operations.
2493 Detach a device specified by pci address or virtual device args::
2495 testpmd> device detach (identifier)
2497 Before detaching a device associated with ports, the ports should be stopped and closed.
2499 For example, to detach a pci device whose address is 0002:03:00.0.
2501 .. code-block:: console
2503 testpmd> device detach 0002:03:00.0
2504 Removing a device...
2505 Port 1 is now closed
2506 EAL: Releasing pci mapped resource for 0002:03:00.0
2507 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2508 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2509 Device 0002:03:00.0 is detached
2510 Now total ports is 1
2512 For example, to detach a port created by pcap PMD.
2514 .. code-block:: console
2516 testpmd> device detach net_pcap0
2517 Removing a device...
2518 Port 0 is now closed
2519 Device net_pcap0 is detached
2520 Now total ports is 0
2523 In this case, identifier is ``net_pcap0``.
2524 This identifier format is the same as ``--vdev`` format of DPDK applications.
2526 Link Bonding Functions
2527 ----------------------
2529 The Link Bonding functions make it possible to dynamically create and
2530 manage link bonding devices from within testpmd interactive prompt.
2532 create bonded device
2533 ~~~~~~~~~~~~~~~~~~~~
2535 Create a new bonding device::
2537 testpmd> create bonded device (mode) (socket)
2539 For example, to create a bonded device in mode 1 on socket 0::
2541 testpmd> create bonded device 1 0
2542 created new bonded device (port X)
2547 Adds Ethernet device to a Link Bonding device::
2549 testpmd> add bonding slave (slave id) (port id)
2551 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2553 testpmd> add bonding slave 6 10
2556 remove bonding slave
2557 ~~~~~~~~~~~~~~~~~~~~
2559 Removes an Ethernet slave device from a Link Bonding device::
2561 testpmd> remove bonding slave (slave id) (port id)
2563 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2565 testpmd> remove bonding slave 6 10
2570 Set the Link Bonding mode of a Link Bonding device::
2572 testpmd> set bonding mode (value) (port id)
2574 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2576 testpmd> set bonding mode 3 10
2581 Set an Ethernet slave device as the primary device on a Link Bonding device::
2583 testpmd> set bonding primary (slave id) (port id)
2585 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2587 testpmd> set bonding primary 6 10
2592 Set the MAC address of a Link Bonding device::
2594 testpmd> set bonding mac (port id) (mac)
2596 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2598 testpmd> set bonding mac 10 00:00:00:00:00:01
2600 set bonding balance_xmit_policy
2601 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2603 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2605 testpmd> set bonding balance_xmit_policy (port_id) (l2|l23|l34)
2607 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2609 testpmd> set bonding balance_xmit_policy 10 l34
2612 set bonding mon_period
2613 ~~~~~~~~~~~~~~~~~~~~~~
2615 Set the link status monitoring polling period in milliseconds for a bonding device.
2617 This adds support for PMD slave devices which do not support link status interrupts.
2618 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2619 link status ISR will be queried every polling interval to check if their link status has changed::
2621 testpmd> set bonding mon_period (port_id) (value)
2623 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2625 testpmd> set bonding mon_period 5 150
2628 set bonding lacp dedicated_queue
2629 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2631 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2632 when in mode 4 (link-aggregation-802.3ad)::
2634 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2637 set bonding agg_mode
2638 ~~~~~~~~~~~~~~~~~~~~
2640 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2642 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2648 Show the current configuration of a Link Bonding device::
2650 testpmd> show bonding config (port id)
2653 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2654 in balance mode with a transmission policy of layer 2+3::
2656 testpmd> show bonding config 9
2658 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2660 Active Slaves (3): [1 3 4]
2667 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2668 This is mainly useful for debugging purposes.
2669 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2670 and fields that can be accessed.
2675 Display the value of a port register::
2677 testpmd> read reg (port_id) (address)
2679 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2681 testpmd> read reg 0 0xEE00
2682 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2687 Display a port register bit field::
2689 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2691 For example, reading the lowest two bits from the register in the example above::
2693 testpmd> read regfield 0 0xEE00 0 1
2694 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2699 Display a single port register bit::
2701 testpmd> read regbit (port_id) (address) (bit_x)
2703 For example, reading the lowest bit from the register in the example above::
2705 testpmd> read regbit 0 0xEE00 0
2706 port 0 PCI register at offset 0xEE00: bit 0=1
2711 Set the value of a port register::
2713 testpmd> write reg (port_id) (address) (value)
2715 For example, to clear a register::
2717 testpmd> write reg 0 0xEE00 0x0
2718 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2723 Set bit field of a port register::
2725 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2727 For example, writing to the register cleared in the example above::
2729 testpmd> write regfield 0 0xEE00 0 1 2
2730 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2735 Set single bit value of a port register::
2737 testpmd> write regbit (port_id) (address) (bit_x) (value)
2739 For example, to set the high bit in the register from the example above::
2741 testpmd> write regbit 0 0xEE00 31 1
2742 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2744 Traffic Metering and Policing
2745 -----------------------------
2747 The following section shows functions for configuring traffic metering and
2748 policing on the ethernet device through the use of generic ethdev API.
2750 show port traffic management capability
2751 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2753 Show traffic metering and policing capability of the port::
2755 testpmd> show port meter cap (port_id)
2757 add port meter profile (srTCM rfc2967)
2758 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2760 Add meter profile (srTCM rfc2697) to the ethernet device::
2762 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2767 * ``profile_id``: ID for the meter profile.
2768 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2769 * ``cbs``: Committed Burst Size (CBS) (bytes).
2770 * ``ebs``: Excess Burst Size (EBS) (bytes).
2772 add port meter profile (trTCM rfc2968)
2773 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2775 Add meter profile (srTCM rfc2698) to the ethernet device::
2777 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2778 (cir) (pir) (cbs) (pbs)
2782 * ``profile_id``: ID for the meter profile.
2783 * ``cir``: Committed information rate (bytes/second).
2784 * ``pir``: Peak information rate (bytes/second).
2785 * ``cbs``: Committed burst size (bytes).
2786 * ``pbs``: Peak burst size (bytes).
2788 add port meter profile (trTCM rfc4115)
2789 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2791 Add meter profile (trTCM rfc4115) to the ethernet device::
2793 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2794 (cir) (eir) (cbs) (ebs)
2798 * ``profile_id``: ID for the meter profile.
2799 * ``cir``: Committed information rate (bytes/second).
2800 * ``eir``: Excess information rate (bytes/second).
2801 * ``cbs``: Committed burst size (bytes).
2802 * ``ebs``: Excess burst size (bytes).
2804 delete port meter profile
2805 ~~~~~~~~~~~~~~~~~~~~~~~~~
2807 Delete meter profile from the ethernet device::
2809 testpmd> del port meter profile (port_id) (profile_id)
2814 Create new meter object for the ethernet device::
2816 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2817 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2818 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2823 * ``mtr_id``: meter object ID.
2824 * ``profile_id``: ID for the meter profile.
2825 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2826 gets enabled at the time of creation, otherwise remains disabled.
2827 * ``g_action``: Policer action for the packet with green color.
2828 * ``y_action``: Policer action for the packet with yellow color.
2829 * ``r_action``: Policer action for the packet with red color.
2830 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2832 * ``shared``: When this parameter has a non-zero value, the meter object is
2833 shared by multiple flows. Otherwise, meter object is used by single flow.
2834 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2835 input color for the current meter object is determined by the latest meter
2836 object in the same flow. Otherwise, the current meter object uses the
2837 *dscp_table* to determine the input color.
2838 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2839 color, 0 <= x <= 63.
2844 Enable meter for the ethernet device::
2846 testpmd> enable port meter (port_id) (mtr_id)
2851 Disable meter for the ethernet device::
2853 testpmd> disable port meter (port_id) (mtr_id)
2858 Delete meter for the ethernet device::
2860 testpmd> del port meter (port_id) (mtr_id)
2862 Set port meter profile
2863 ~~~~~~~~~~~~~~~~~~~~~~
2865 Set meter profile for the ethernet device::
2867 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2869 set port meter dscp table
2870 ~~~~~~~~~~~~~~~~~~~~~~~~~
2872 Set meter dscp table for the ethernet device::
2874 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2875 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2877 set port meter policer action
2878 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2880 Set meter policer action for the ethernet device::
2882 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2883 (action0) [(action1) (action1)]
2887 * ``action_mask``: Bit mask indicating which policer actions need to be
2888 updated. One or more policer actions can be updated in a single function
2889 invocation. To update the policer action associated with color C, bit
2890 (1 << C) needs to be set in *action_mask* and element at position C
2891 in the *actions* array needs to be valid.
2892 * ``actionx``: Policer action for the color x,
2893 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2895 set port meter stats mask
2896 ~~~~~~~~~~~~~~~~~~~~~~~~~
2898 Set meter stats mask for the ethernet device::
2900 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2904 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2906 show port meter stats
2907 ~~~~~~~~~~~~~~~~~~~~~
2909 Show meter stats of the ethernet device::
2911 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2915 * ``clear``: Flag that indicates whether the statistics counters should
2916 be cleared (i.e. set to zero) immediately after they have been read or not.
2921 The following section shows functions for configuring traffic management on
2922 the ethernet device through the use of generic TM API.
2924 show port traffic management capability
2925 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2927 Show traffic management capability of the port::
2929 testpmd> show port tm cap (port_id)
2931 show port traffic management capability (hierarchy level)
2932 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2934 Show traffic management hierarchy level capability of the port::
2936 testpmd> show port tm level cap (port_id) (level_id)
2938 show port traffic management capability (hierarchy node level)
2939 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2941 Show the traffic management hierarchy node capability of the port::
2943 testpmd> show port tm node cap (port_id) (node_id)
2945 show port traffic management hierarchy node type
2946 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2948 Show the port traffic management hierarchy node type::
2950 testpmd> show port tm node type (port_id) (node_id)
2952 show port traffic management hierarchy node stats
2953 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2955 Show the port traffic management hierarchy node statistics::
2957 testpmd> show port tm node stats (port_id) (node_id) (clear)
2961 * ``clear``: When this parameter has a non-zero value, the statistics counters
2962 are cleared (i.e. set to zero) immediately after they have been read,
2963 otherwise the statistics counters are left untouched.
2965 Add port traffic management private shaper profile
2966 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2968 Add the port traffic management private shaper profile::
2970 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2971 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2972 (packet_length_adjust) (packet_mode)
2976 * ``shaper_profile id``: Shaper profile ID for the new profile.
2977 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second or packets per second).
2978 * ``cmit_tb_size``: Committed token bucket size (bytes or packets).
2979 * ``peak_tb_rate``: Peak token bucket rate (bytes per second or packets per second).
2980 * ``peak_tb_size``: Peak token bucket size (bytes or packets).
2981 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2982 each packet for the purpose of shaping. This parameter value can be used to
2983 correct the packet length with the framing overhead bytes that are consumed
2985 * ``packet_mode``: Shaper configured in packet mode. This parameter value if
2986 zero, configures shaper in byte mode and if non-zero configures it in packet
2989 Delete port traffic management private shaper profile
2990 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2992 Delete the port traffic management private shaper::
2994 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2998 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
3000 Add port traffic management shared shaper
3001 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3003 Create the port traffic management shared shaper::
3005 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
3010 * ``shared_shaper_id``: Shared shaper ID to be created.
3011 * ``shaper_profile id``: Shaper profile ID for shared shaper.
3013 Set port traffic management shared shaper
3014 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3016 Update the port traffic management shared shaper::
3018 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
3023 * ``shared_shaper_id``: Shared shaper ID to be update.
3024 * ``shaper_profile id``: Shaper profile ID for shared shaper.
3026 Delete port traffic management shared shaper
3027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3029 Delete the port traffic management shared shaper::
3031 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
3035 * ``shared_shaper_id``: Shared shaper ID to be deleted.
3037 Set port traffic management hierarchy node private shaper
3038 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3040 set the port traffic management hierarchy node private shaper::
3042 testpmd> set port tm node shaper profile (port_id) (node_id) \
3047 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
3050 Add port traffic management WRED profile
3051 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3053 Create a new WRED profile::
3055 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
3056 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
3057 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
3058 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
3062 * ``wred_profile id``: Identifier for the newly create WRED profile
3063 * ``color_g``: Packet color (green)
3064 * ``min_th_g``: Minimum queue threshold for packet with green color
3065 * ``max_th_g``: Minimum queue threshold for packet with green color
3066 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
3067 * ``wq_log2_g``: Negated log2 of queue weight (wq)
3068 * ``color_y``: Packet color (yellow)
3069 * ``min_th_y``: Minimum queue threshold for packet with yellow color
3070 * ``max_th_y``: Minimum queue threshold for packet with yellow color
3071 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
3072 * ``wq_log2_y``: Negated log2 of queue weight (wq)
3073 * ``color_r``: Packet color (red)
3074 * ``min_th_r``: Minimum queue threshold for packet with yellow color
3075 * ``max_th_r``: Minimum queue threshold for packet with yellow color
3076 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
3077 * ``wq_log2_r``: Negated log2 of queue weight (wq)
3079 Delete port traffic management WRED profile
3080 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3082 Delete the WRED profile::
3084 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
3086 Add port traffic management hierarchy nonleaf node
3087 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3089 Add nonleaf node to port traffic management hierarchy::
3091 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
3092 (priority) (weight) (level_id) (shaper_profile_id) \
3093 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3094 [(shared_shaper_0) (shared_shaper_1) ...] \
3098 * ``parent_node_id``: Node ID of the parent.
3099 * ``priority``: Node priority (highest node priority is zero). This is used by
3100 the SP algorithm running on the parent node for scheduling this node.
3101 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3102 to the weight sum of all siblings that have the same priority. It is used by
3103 the WFQ algorithm running on the parent node for scheduling this node.
3104 * ``level_id``: Hierarchy level of the node.
3105 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3107 * ``n_sp_priorities``: Number of strict priorities.
3108 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3109 * ``n_shared_shapers``: Number of shared shapers.
3110 * ``shared_shaper_id``: Shared shaper id.
3112 Add port traffic management hierarchy nonleaf node with packet mode
3113 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3115 Add nonleaf node with packet mode to port traffic management hierarchy::
3117 testpmd> add port tm nonleaf node pktmode (port_id) (node_id) (parent_node_id) \
3118 (priority) (weight) (level_id) (shaper_profile_id) \
3119 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3120 [(shared_shaper_0) (shared_shaper_1) ...] \
3124 * ``parent_node_id``: Node ID of the parent.
3125 * ``priority``: Node priority (highest node priority is zero). This is used by
3126 the SP algorithm running on the parent node for scheduling this node.
3127 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3128 to the weight sum of all siblings that have the same priority. It is used by
3129 the WFQ algorithm running on the parent node for scheduling this node.
3130 * ``level_id``: Hierarchy level of the node.
3131 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3133 * ``n_sp_priorities``: Number of strict priorities. Packet mode is enabled on
3135 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3136 * ``n_shared_shapers``: Number of shared shapers.
3137 * ``shared_shaper_id``: Shared shaper id.
3139 Add port traffic management hierarchy leaf node
3140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3142 Add leaf node to port traffic management hierarchy::
3144 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
3145 (priority) (weight) (level_id) (shaper_profile_id) \
3146 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
3147 [(shared_shaper_id) (shared_shaper_id) ...] \
3151 * ``parent_node_id``: Node ID of the parent.
3152 * ``priority``: Node priority (highest node priority is zero). This is used by
3153 the SP algorithm running on the parent node for scheduling this node.
3154 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3155 to the weight sum of all siblings that have the same priority. It is used by
3156 the WFQ algorithm running on the parent node for scheduling this node.
3157 * ``level_id``: Hierarchy level of the node.
3158 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3160 * ``cman_mode``: Congestion management mode to be enabled for this node.
3161 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3162 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3163 * ``n_shared_shapers``: Number of shared shapers.
3164 * ``shared_shaper_id``: Shared shaper id.
3166 Delete port traffic management hierarchy node
3167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3169 Delete node from port traffic management hierarchy::
3171 testpmd> del port tm node (port_id) (node_id)
3173 Update port traffic management hierarchy parent node
3174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3176 Update port traffic management hierarchy parent node::
3178 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3181 This function can only be called after the hierarchy commit invocation. Its
3182 success depends on the port support for this operation, as advertised through
3183 the port capability set. This function is valid for all nodes of the traffic
3184 management hierarchy except root node.
3186 Suspend port traffic management hierarchy node
3187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3189 testpmd> suspend port tm node (port_id) (node_id)
3191 Resume port traffic management hierarchy node
3192 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3194 testpmd> resume port tm node (port_id) (node_id)
3196 Commit port traffic management hierarchy
3197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3199 Commit the traffic management hierarchy on the port::
3201 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3205 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3206 call failure. On the other hand, hierarchy is preserved when this parameter
3209 Set port traffic management mark VLAN dei
3210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3212 Enables/Disables the traffic management marking on the port for VLAN packets::
3214 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3218 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3219 ``yellow`` or ``red`` will have dei bit enabled
3221 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3223 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3225 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3227 Set port traffic management mark IP dscp
3228 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3230 Enables/Disables the traffic management marking on the port for IP dscp packets::
3232 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3236 * ``port_id``: The port which on which IP packets marked as ``green`` or
3237 ``yellow`` or ``red`` will have IP dscp bits updated
3239 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3241 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3243 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3245 Set port traffic management mark IP ecn
3246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3248 Enables/Disables the traffic management marking on the port for IP ecn packets::
3250 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3254 * ``port_id``: The port which on which IP packets marked as ``green`` or
3255 ``yellow`` or ``red`` will have IP ecn bits updated
3257 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3258 to ecn of 2'b11 when IP is caring TCP or SCTP
3260 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3261 to ecn of 2'b11 when IP is caring TCP or SCTP
3263 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3264 to ecn of 2'b11 when IP is caring TCP or SCTP
3269 This section details the available filter functions that are available.
3271 Note these functions interface the deprecated legacy filtering framework,
3272 superseded by *rte_flow*. See `Flow rules management`_.
3275 ~~~~~~~~~~~~~~~~~~~~
3277 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3279 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3280 ethertype (ether_type) (drop|fwd) queue (queue_id)
3282 The available information parameters are:
3284 * ``port_id``: The port which the Ethertype filter assigned on.
3286 * ``mac_addr``: Compare destination mac address.
3288 * ``mac_ignr``: Ignore destination mac address match.
3290 * ``mac_address``: Destination mac address to match.
3292 * ``ether_type``: The EtherType value want to match,
3293 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3295 * ``queue_id``: The receive queue associated with this EtherType filter.
3296 It is meaningless when deleting or dropping.
3298 Example, to add/remove an ethertype filter rule::
3300 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3301 ethertype 0x0806 fwd queue 3
3303 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3304 ethertype 0x0806 fwd queue 3
3309 Add or delete a 2-tuple filter,
3310 which identifies packets by specific protocol and destination TCP/UDP port
3311 and forwards packets into one of the receive queues::
3313 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3314 protocol (protocol_value) mask (mask_value) \
3315 tcp_flags (tcp_flags_value) priority (prio_value) \
3318 The available information parameters are:
3320 * ``port_id``: The port which the 2-tuple filter assigned on.
3322 * ``dst_port_value``: Destination port in L4.
3324 * ``protocol_value``: IP L4 protocol.
3326 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3328 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3330 * ``prio_value``: Priority of this filter.
3332 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3334 Example, to add/remove an 2tuple filter rule::
3336 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3337 tcp_flags 0x02 priority 3 queue 3
3339 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3340 tcp_flags 0x02 priority 3 queue 3
3345 Add or delete a 5-tuple filter,
3346 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3347 and routes packets into one of the receive queues::
3349 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3350 (src_address) dst_port (dst_port_value) \
3351 src_port (src_port_value) protocol (protocol_value) \
3352 mask (mask_value) tcp_flags (tcp_flags_value) \
3353 priority (prio_value) queue (queue_id)
3355 The available information parameters are:
3357 * ``port_id``: The port which the 5-tuple filter assigned on.
3359 * ``dst_address``: Destination IP address.
3361 * ``src_address``: Source IP address.
3363 * ``dst_port_value``: TCP/UDP destination port.
3365 * ``src_port_value``: TCP/UDP source port.
3367 * ``protocol_value``: L4 protocol.
3369 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3371 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3373 * ``prio_value``: The priority of this filter.
3375 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3377 Example, to add/remove an 5tuple filter rule::
3379 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3380 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3381 flags 0x0 priority 3 queue 3
3383 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3384 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3385 flags 0x0 priority 3 queue 3
3390 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3392 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3394 The available information parameters are:
3396 * ``port_id``: The port which the SYN filter assigned on.
3398 * ``high``: This SYN filter has higher priority than other filters.
3400 * ``low``: This SYN filter has lower priority than other filters.
3402 * ``queue_id``: The receive queue associated with this SYN filter
3406 testpmd> syn_filter 0 add priority high queue 3
3411 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3412 and routed into one of the receive queues::
3414 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3415 mask (mask_value) priority (prio_value) queue (queue_id)
3417 The available information parameters are:
3419 * ``port_id``: The port which the Flex filter is assigned on.
3421 * ``len_value``: Filter length in bytes, no greater than 128.
3423 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3425 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3427 * ``prio_value``: The priority of this filter.
3429 * ``queue_id``: The receive queue associated with this Flex filter.
3433 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3434 mask 000C priority 3 queue 3
3436 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3437 mask 000C priority 3 queue 3
3440 .. _testpmd_flow_director:
3442 flow_director_filter
3443 ~~~~~~~~~~~~~~~~~~~~
3445 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3447 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3448 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3450 * Perfect match filters.
3451 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3452 The masked fields are for IP flow.
3454 * Signature filters.
3455 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3457 * Perfect-mac-vlan match filters.
3458 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3459 The masked fields are for MAC VLAN flow.
3461 * Perfect-tunnel match filters.
3462 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3463 The masked fields are for tunnel flow.
3465 * Perfect-raw-flow-type match filters.
3466 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3467 The masked fields are specified by input sets.
3469 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3470 per flow type and the flexible payload.
3472 The Flow Director can also mask out parts of all of these fields so that filters
3473 are only applied to certain fields or parts of the fields.
3475 Note that for raw flow type mode the source and destination fields in the
3476 raw packet buffer need to be presented in a reversed order with respect
3477 to the expected received packets.
3478 For example: IP source and destination addresses or TCP/UDP/SCTP
3479 source and destination ports
3481 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3483 # Commands to add flow director filters of different flow types::
3485 flow_director_filter (port_id) mode IP (add|del|update) \
3486 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3487 src (src_ip_address) dst (dst_ip_address) \
3488 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3489 vlan (vlan_value) flexbytes (flexbytes_value) \
3490 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3493 flow_director_filter (port_id) mode IP (add|del|update) \
3494 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3495 src (src_ip_address) (src_port) \
3496 dst (dst_ip_address) (dst_port) \
3497 tos (tos_value) ttl (ttl_value) \
3498 vlan (vlan_value) flexbytes (flexbytes_value) \
3499 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3502 flow_director_filter (port_id) mode IP (add|del|update) \
3503 flow (ipv4-sctp|ipv6-sctp) \
3504 src (src_ip_address) (src_port) \
3505 dst (dst_ip_address) (dst_port) \
3506 tos (tos_value) ttl (ttl_value) \
3507 tag (verification_tag) vlan (vlan_value) \
3508 flexbytes (flexbytes_value) (drop|fwd) \
3509 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3511 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3512 ether (ethertype) flexbytes (flexbytes_value) \
3513 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3516 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3517 mac (mac_address) vlan (vlan_value) \
3518 flexbytes (flexbytes_value) (drop|fwd) \
3519 queue (queue_id) fd_id (fd_id_value)
3521 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3522 mac (mac_address) vlan (vlan_value) \
3523 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3524 flexbytes (flexbytes_value) (drop|fwd) \
3525 queue (queue_id) fd_id (fd_id_value)
3527 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3528 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3529 packet (packet file name)
3531 For example, to add an ipv4-udp flow type filter::
3533 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3534 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3535 fwd pf queue 1 fd_id 1
3537 For example, add an ipv4-other flow type filter::
3539 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3540 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3541 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3546 Flush all flow director filters on a device::
3548 testpmd> flush_flow_director (port_id)
3550 Example, to flush all flow director filter on port 0::
3552 testpmd> flush_flow_director 0
3557 Set flow director's input masks::
3559 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3560 src_mask (ipv4_src) (ipv6_src) (src_port) \
3561 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3563 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3565 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3566 mac (mac_value) tunnel-type (tunnel_type_value) \
3567 tunnel-id (tunnel_id_value)
3569 Example, to set flow director mask on port 0::
3571 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3572 src_mask 255.255.255.255 \
3573 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3574 dst_mask 255.255.255.255 \
3575 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3577 flow_director_flex_mask
3578 ~~~~~~~~~~~~~~~~~~~~~~~
3580 set masks of flow director's flexible payload based on certain flow type::
3582 testpmd> flow_director_flex_mask (port_id) \
3583 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3584 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3585 l2_payload|all) (mask)
3587 Example, to set flow director's flex mask for all flow type on port 0::
3589 testpmd> flow_director_flex_mask 0 flow all \
3590 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3593 flow_director_flex_payload
3594 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3596 Configure flexible payload selection::
3598 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3600 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3602 testpmd> flow_director_flex_payload 0 l4 \
3603 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3605 get_sym_hash_ena_per_port
3606 ~~~~~~~~~~~~~~~~~~~~~~~~~
3608 Get symmetric hash enable configuration per port::
3610 get_sym_hash_ena_per_port (port_id)
3612 For example, to get symmetric hash enable configuration of port 1::
3614 testpmd> get_sym_hash_ena_per_port 1
3616 set_sym_hash_ena_per_port
3617 ~~~~~~~~~~~~~~~~~~~~~~~~~
3619 Set symmetric hash enable configuration per port to enable or disable::
3621 set_sym_hash_ena_per_port (port_id) (enable|disable)
3623 For example, to set symmetric hash enable configuration of port 1 to enable::
3625 testpmd> set_sym_hash_ena_per_port 1 enable
3627 get_hash_global_config
3628 ~~~~~~~~~~~~~~~~~~~~~~
3630 Get the global configurations of hash filters::
3632 get_hash_global_config (port_id)
3634 For example, to get the global configurations of hash filters of port 1::
3636 testpmd> get_hash_global_config 1
3638 set_hash_global_config
3639 ~~~~~~~~~~~~~~~~~~~~~~
3641 Set the global configurations of hash filters::
3643 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3644 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3645 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3648 For example, to enable simple_xor for flow type of ipv6 on port 2::
3650 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3655 Set the input set for hash::
3657 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3658 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3659 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3660 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3661 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3662 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3663 fld-8th|none) (select|add)
3665 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3667 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3672 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3673 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3675 Set the input set for flow director::
3677 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3678 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3679 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3680 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3681 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3682 sctp-dst-port|sctp-veri-tag|none) (select|add)
3684 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3686 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3691 Set different GRE key length for input set::
3693 global_config (port_id) gre-key-len (number in bytes)
3695 For example to set GRE key length for input set to 4 bytes on port 0::
3697 testpmd> global_config 0 gre-key-len 4
3700 .. _testpmd_rte_flow:
3702 Flow rules management
3703 ---------------------
3705 Control of the generic flow API (*rte_flow*) is fully exposed through the
3706 ``flow`` command (validation, creation, destruction, queries and operation
3709 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3710 features simultaneously may cause undefined side-effects and is therefore
3716 Because the ``flow`` command uses dynamic tokens to handle the large number
3717 of possible flow rules combinations, its behavior differs slightly from
3718 other commands, in particular:
3720 - Pressing *?* or the *<tab>* key displays contextual help for the current
3721 token, not that of the entire command.
3723 - Optional and repeated parameters are supported (provided they are listed
3724 in the contextual help).
3726 The first parameter stands for the operation mode. Possible operations and
3727 their general syntax are described below. They are covered in detail in the
3730 - Check whether a flow rule can be created::
3732 flow validate {port_id}
3733 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3734 pattern {item} [/ {item} [...]] / end
3735 actions {action} [/ {action} [...]] / end
3737 - Create a flow rule::
3739 flow create {port_id}
3740 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3741 pattern {item} [/ {item} [...]] / end
3742 actions {action} [/ {action} [...]] / end
3744 - Destroy specific flow rules::
3746 flow destroy {port_id} rule {rule_id} [...]
3748 - Destroy all flow rules::
3750 flow flush {port_id}
3752 - Query an existing flow rule::
3754 flow query {port_id} {rule_id} {action}
3756 - List existing flow rules sorted by priority, filtered by group
3759 flow list {port_id} [group {group_id}] [...]
3761 - Restrict ingress traffic to the defined flow rules::
3763 flow isolate {port_id} {boolean}
3765 - Dump internal representation information of all flows in hardware::
3767 flow dump {port_id} {output_file}
3769 - List and destroy aged flow rules::
3771 flow aged {port_id} [destroy]
3773 - Tunnel offload - create a tunnel stub::
3775 flow tunnel create {port_id} type {tunnel_type}
3777 - Tunnel offload - destroy a tunnel stub::
3779 flow tunnel destroy {port_id} id {tunnel_id}
3781 - Tunnel offload - list port tunnel stubs::
3783 flow tunnel list {port_id}
3785 Creating a tunnel stub for offload
3786 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3788 ``flow tunnel create`` setup a tunnel stub for tunnel offload flow rules::
3790 flow tunnel create {port_id} type {tunnel_type}
3792 If successful, it will return a tunnel stub ID usable with other commands::
3794 port [...]: flow tunnel #[...] type [...]
3796 Tunnel stub ID is relative to a port.
3798 Destroying tunnel offload stub
3799 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3801 ``flow tunnel destroy`` destroy port tunnel stub::
3803 flow tunnel destroy {port_id} id {tunnel_id}
3805 Listing tunnel offload stubs
3806 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3808 ``flow tunnel list`` list port tunnel offload stubs::
3810 flow tunnel list {port_id}
3812 Validating flow rules
3813 ~~~~~~~~~~~~~~~~~~~~~
3815 ``flow validate`` reports whether a flow rule would be accepted by the
3816 underlying device in its current state but stops short of creating it. It is
3817 bound to ``rte_flow_validate()``::
3819 flow validate {port_id}
3820 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3821 pattern {item} [/ {item} [...]] / end
3822 actions {action} [/ {action} [...]] / end
3824 If successful, it will show::
3828 Otherwise it will show an error message of the form::
3830 Caught error type [...] ([...]): [...]
3832 This command uses the same parameters as ``flow create``, their format is
3833 described in `Creating flow rules`_.
3835 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3836 index 6 is supported::
3838 testpmd> flow validate 0 ingress pattern eth / end
3839 actions queue index 6 / end
3843 Port 0 does not support TCPv6 rules::
3845 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3847 Caught error type 9 (specific pattern item): Invalid argument
3853 ``flow create`` validates and creates the specified flow rule. It is bound
3854 to ``rte_flow_create()``::
3856 flow create {port_id}
3857 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3858 [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}]
3859 pattern {item} [/ {item} [...]] / end
3860 actions {action} [/ {action} [...]] / end
3862 If successful, it will return a flow rule ID usable with other commands::
3864 Flow rule #[...] created
3866 Otherwise it will show an error message of the form::
3868 Caught error type [...] ([...]): [...]
3870 Parameters describe in the following order:
3872 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3873 - Tunnel offload specification (tunnel_set, tunnel_match)
3874 - A matching pattern, starting with the *pattern* token and terminated by an
3876 - Actions, starting with the *actions* token and terminated by an *end*
3879 These translate directly to *rte_flow* objects provided as-is to the
3880 underlying functions.
3882 The shortest valid definition only comprises mandatory tokens::
3884 testpmd> flow create 0 pattern end actions end
3886 Note that PMDs may refuse rules that essentially do nothing such as this
3889 **All unspecified object values are automatically initialized to 0.**
3894 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3895 specified before the ``pattern`` token.
3897 - ``group {group id}``: priority group.
3898 - ``priority {level}``: priority level within group.
3899 - ``ingress``: rule applies to ingress traffic.
3900 - ``egress``: rule applies to egress traffic.
3901 - ``transfer``: apply rule directly to endpoints found in pattern.
3903 Each instance of an attribute specified several times overrides the previous
3904 value as shown below (group 4 is used)::
3906 testpmd> flow create 0 group 42 group 24 group 4 [...]
3908 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3910 While not specifying a direction is an error, some rules may allow both
3913 Most rules affect RX therefore contain the ``ingress`` token::
3915 testpmd> flow create 0 ingress pattern [...]
3920 Indicate tunnel offload rule type
3922 - ``tunnel_set {tunnel_id}``: mark rule as tunnel offload decap_set type.
3923 - ``tunnel_match {tunnel_id}``: mark rule as tunel offload match type.
3928 A matching pattern starts after the ``pattern`` token. It is made of pattern
3929 items and is terminated by a mandatory ``end`` item.
3931 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3932 rte_flow_item_type``).
3934 The ``/`` token is used as a separator between pattern items as shown
3937 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3939 Note that protocol items like these must be stacked from lowest to highest
3940 layer to make sense. For instance, the following rule is either invalid or
3941 unlikely to match any packet::
3943 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3945 More information on these restrictions can be found in the *rte_flow*
3948 Several items support additional specification structures, for example
3949 ``ipv4`` allows specifying source and destination addresses as follows::
3951 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3952 dst is 10.2.0.0 / end [...]
3954 This rule matches all IPv4 traffic with the specified properties.
3956 In this example, ``src`` and ``dst`` are field names of the underlying
3957 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3958 in a similar fashion.
3960 The ``is`` token means that the subsequent value must be matched exactly,
3961 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3962 accordingly. Possible assignment tokens are:
3964 - ``is``: match value perfectly (with full bit-mask).
3965 - ``spec``: match value according to configured bit-mask.
3966 - ``last``: specify upper bound to establish a range.
3967 - ``mask``: specify bit-mask with relevant bits set to one.
3968 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3970 These yield identical results::
3972 ipv4 src is 10.1.1.1
3976 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3980 ipv4 src spec 10.1.1.1 src prefix 32
3984 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3988 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3990 Inclusive ranges can be defined with ``last``::
3992 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3994 Note that ``mask`` affects both ``spec`` and ``last``::
3996 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3997 # matches 10.1.0.0 to 10.2.255.255
3999 Properties can be modified multiple times::
4001 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
4005 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
4010 This section lists supported pattern items and their attributes, if any.
4012 - ``end``: end list of pattern items.
4014 - ``void``: no-op pattern item.
4016 - ``invert``: perform actions when pattern does not match.
4018 - ``any``: match any protocol for the current layer.
4020 - ``num {unsigned}``: number of layers covered.
4022 - ``pf``: match traffic from/to the physical function.
4024 - ``vf``: match traffic from/to a virtual function ID.
4026 - ``id {unsigned}``: VF ID.
4028 - ``phy_port``: match traffic from/to a specific physical port.
4030 - ``index {unsigned}``: physical port index.
4032 - ``port_id``: match traffic from/to a given DPDK port ID.
4034 - ``id {unsigned}``: DPDK port ID.
4036 - ``mark``: match value set in previously matched flow rule using the mark action.
4038 - ``id {unsigned}``: arbitrary integer value.
4040 - ``raw``: match an arbitrary byte string.
4042 - ``relative {boolean}``: look for pattern after the previous item.
4043 - ``search {boolean}``: search pattern from offset (see also limit).
4044 - ``offset {integer}``: absolute or relative offset for pattern.
4045 - ``limit {unsigned}``: search area limit for start of pattern.
4046 - ``pattern {string}``: byte string to look for.
4048 - ``eth``: match Ethernet header.
4050 - ``dst {MAC-48}``: destination MAC.
4051 - ``src {MAC-48}``: source MAC.
4052 - ``type {unsigned}``: EtherType or TPID.
4054 - ``vlan``: match 802.1Q/ad VLAN tag.
4056 - ``tci {unsigned}``: tag control information.
4057 - ``pcp {unsigned}``: priority code point.
4058 - ``dei {unsigned}``: drop eligible indicator.
4059 - ``vid {unsigned}``: VLAN identifier.
4060 - ``inner_type {unsigned}``: inner EtherType or TPID.
4062 - ``ipv4``: match IPv4 header.
4064 - ``tos {unsigned}``: type of service.
4065 - ``ttl {unsigned}``: time to live.
4066 - ``proto {unsigned}``: next protocol ID.
4067 - ``src {ipv4 address}``: source address.
4068 - ``dst {ipv4 address}``: destination address.
4070 - ``ipv6``: match IPv6 header.
4072 - ``tc {unsigned}``: traffic class.
4073 - ``flow {unsigned}``: flow label.
4074 - ``proto {unsigned}``: protocol (next header).
4075 - ``hop {unsigned}``: hop limit.
4076 - ``src {ipv6 address}``: source address.
4077 - ``dst {ipv6 address}``: destination address.
4079 - ``icmp``: match ICMP header.
4081 - ``type {unsigned}``: ICMP packet type.
4082 - ``code {unsigned}``: ICMP packet code.
4084 - ``udp``: match UDP header.
4086 - ``src {unsigned}``: UDP source port.
4087 - ``dst {unsigned}``: UDP destination port.
4089 - ``tcp``: match TCP header.
4091 - ``src {unsigned}``: TCP source port.
4092 - ``dst {unsigned}``: TCP destination port.
4094 - ``sctp``: match SCTP header.
4096 - ``src {unsigned}``: SCTP source port.
4097 - ``dst {unsigned}``: SCTP destination port.
4098 - ``tag {unsigned}``: validation tag.
4099 - ``cksum {unsigned}``: checksum.
4101 - ``vxlan``: match VXLAN header.
4103 - ``vni {unsigned}``: VXLAN identifier.
4105 - ``e_tag``: match IEEE 802.1BR E-Tag header.
4107 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
4109 - ``nvgre``: match NVGRE header.
4111 - ``tni {unsigned}``: virtual subnet ID.
4113 - ``mpls``: match MPLS header.
4115 - ``label {unsigned}``: MPLS label.
4117 - ``gre``: match GRE header.
4119 - ``protocol {unsigned}``: protocol type.
4121 - ``gre_key``: match GRE optional key field.
4123 - ``value {unsigned}``: key value.
4125 - ``fuzzy``: fuzzy pattern match, expect faster than default.
4127 - ``thresh {unsigned}``: accuracy threshold.
4129 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
4131 - ``teid {unsigned}``: tunnel endpoint identifier.
4133 - ``geneve``: match GENEVE header.
4135 - ``vni {unsigned}``: virtual network identifier.
4136 - ``protocol {unsigned}``: protocol type.
4138 - ``vxlan-gpe``: match VXLAN-GPE header.
4140 - ``vni {unsigned}``: VXLAN-GPE identifier.
4142 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
4144 - ``sha {MAC-48}``: sender hardware address.
4145 - ``spa {ipv4 address}``: sender IPv4 address.
4146 - ``tha {MAC-48}``: target hardware address.
4147 - ``tpa {ipv4 address}``: target IPv4 address.
4149 - ``ipv6_ext``: match presence of any IPv6 extension header.
4151 - ``next_hdr {unsigned}``: next header.
4153 - ``icmp6``: match any ICMPv6 header.
4155 - ``type {unsigned}``: ICMPv6 type.
4156 - ``code {unsigned}``: ICMPv6 code.
4158 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
4160 - ``target_addr {ipv6 address}``: target address.
4162 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
4164 - ``target_addr {ipv6 address}``: target address.
4166 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
4168 - ``type {unsigned}``: ND option type.
4170 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
4171 link-layer address option.
4173 - ``sla {MAC-48}``: source Ethernet LLA.
4175 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
4176 link-layer address option.
4178 - ``tla {MAC-48}``: target Ethernet LLA.
4180 - ``meta``: match application specific metadata.
4182 - ``data {unsigned}``: metadata value.
4184 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
4186 - ``pdu_type {unsigned}``: PDU type.
4187 - ``qfi {unsigned}``: QoS flow identifier.
4189 - ``pppoes``, ``pppoed``: match PPPoE header.
4191 - ``session_id {unsigned}``: session identifier.
4193 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
4195 - ``proto_id {unsigned}``: PPP protocol identifier.
4197 - ``l2tpv3oip``: match L2TPv3 over IP header.
4199 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
4201 - ``ah``: match AH header.
4203 - ``spi {unsigned}``: security parameters index.
4205 - ``pfcp``: match PFCP header.
4207 - ``s_field {unsigned}``: S field.
4208 - ``seid {unsigned}``: session endpoint identifier.
4213 A list of actions starts after the ``actions`` token in the same fashion as
4214 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
4215 terminated by a mandatory ``end`` action.
4217 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
4218 rte_flow_action_type``).
4220 Dropping all incoming UDPv4 packets can be expressed as follows::
4222 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4225 Several actions have configurable properties which must be specified when
4226 there is no valid default value. For example, ``queue`` requires a target
4229 This rule redirects incoming UDPv4 traffic to queue index 6::
4231 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4232 actions queue index 6 / end
4234 While this one could be rejected by PMDs (unspecified queue index)::
4236 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4239 As defined by *rte_flow*, the list is not ordered, all actions of a given
4240 rule are performed simultaneously. These are equivalent::
4242 queue index 6 / void / mark id 42 / end
4246 void / mark id 42 / queue index 6 / end
4248 All actions in a list should have different types, otherwise only the last
4249 action of a given type is taken into account::
4251 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4255 drop / drop / drop / end # drop is performed only once
4259 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4261 Considering they are performed simultaneously, opposite and overlapping
4262 actions can sometimes be combined when the end result is unambiguous::
4264 drop / queue index 6 / end # drop has no effect
4268 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4272 drop / passthru / end # drop has no effect
4274 Note that PMDs may still refuse such combinations.
4279 This section lists supported actions and their attributes, if any.
4281 - ``end``: end list of actions.
4283 - ``void``: no-op action.
4285 - ``passthru``: let subsequent rule process matched packets.
4287 - ``jump``: redirect traffic to group on device.
4289 - ``group {unsigned}``: group to redirect to.
4291 - ``mark``: attach 32 bit value to packets.
4293 - ``id {unsigned}``: 32 bit value to return with packets.
4295 - ``flag``: flag packets.
4297 - ``queue``: assign packets to a given queue index.
4299 - ``index {unsigned}``: queue index to use.
4301 - ``drop``: drop packets (note: passthru has priority).
4303 - ``count``: enable counters for this rule.
4305 - ``rss``: spread packets among several queues.
4307 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4308 the same as `set_hash_global_config`_.
4310 - ``level {unsigned}``: encapsulation level for ``types``.
4312 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4313 tokens are the same as `set_hash_input_set`_, except that an empty list
4314 does not disable RSS but instead requests unspecified "best-effort"
4317 - ``key {string}``: RSS hash key, overrides ``key_len``.
4319 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4320 conjunction with ``key`` to pad or truncate it.
4322 - ``queues [{unsigned} [...]] end``: queue indices to use.
4324 - ``pf``: direct traffic to physical function.
4326 - ``vf``: direct traffic to a virtual function ID.
4328 - ``original {boolean}``: use original VF ID if possible.
4329 - ``id {unsigned}``: VF ID.
4331 - ``phy_port``: direct packets to physical port index.
4333 - ``original {boolean}``: use original port index if possible.
4334 - ``index {unsigned}``: physical port index.
4336 - ``port_id``: direct matching traffic to a given DPDK port ID.
4338 - ``original {boolean}``: use original DPDK port ID if possible.
4339 - ``id {unsigned}``: DPDK port ID.
4341 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4343 - ``mpls_ttl``: MPLS TTL.
4345 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4347 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4349 - ``nw_ttl``: IP TTL.
4351 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4353 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4355 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4357 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4359 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4361 - ``ethertype``: Ethertype.
4363 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4365 - ``vlan_vid``: VLAN id.
4367 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4369 - ``vlan_pcp``: VLAN priority.
4371 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4373 - ``ethertype``: Ethertype.
4375 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4377 - ``ethertype``: Ethertype.
4379 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4380 is done through `Config VXLAN Encap outer layers`_.
4382 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4383 the VXLAN tunnel network overlay from the matched flow.
4385 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4386 is done through `Config NVGRE Encap outer layers`_.
4388 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4389 the NVGRE tunnel network overlay from the matched flow.
4391 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4392 is done through `Config L2 Encap`_.
4394 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4395 is done through `Config L2 Decap`_.
4397 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4398 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4400 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4401 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4403 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4404 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4406 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4407 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4409 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4411 - ``ipv4_addr``: New IPv4 source address.
4413 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4416 - ``ipv4_addr``: New IPv4 destination address.
4418 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4420 - ``ipv6_addr``: New IPv6 source address.
4422 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4425 - ``ipv6_addr``: New IPv6 destination address.
4427 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4430 - ``port``: New TCP/UDP source port number.
4432 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4435 - ``port``: New TCP/UDP destination port number.
4437 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4440 - ``dec_ttl``: Performs a decrease TTL value action
4442 - ``set_ttl``: Set TTL value with specified value
4443 - ``ttl_value {unsigned}``: The new TTL value to be set
4445 - ``set_mac_src``: set source MAC address
4447 - ``mac_addr {MAC-48}``: new source MAC address
4449 - ``set_mac_dst``: set destination MAC address
4451 - ``mac_addr {MAC-48}``: new destination MAC address
4453 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4455 - ``value {unsigned}``: Value to increase TCP sequence number by.
4457 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4459 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4461 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4463 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4465 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4467 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4469 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4471 - ``dscp_value {unsigned}``: The new DSCP value to be set
4473 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4475 - ``dscp_value {unsigned}``: The new DSCP value to be set
4477 - ``shared``: Use shared action created via
4478 ``flow shared_action {port_id} create``
4480 - ``shared_action_id {unsigned}``: Shared action ID to use
4482 Destroying flow rules
4483 ~~~~~~~~~~~~~~~~~~~~~
4485 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4486 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4487 times as necessary::
4489 flow destroy {port_id} rule {rule_id} [...]
4491 If successful, it will show::
4493 Flow rule #[...] destroyed
4495 It does not report anything for rule IDs that do not exist. The usual error
4496 message is shown when a rule cannot be destroyed::
4498 Caught error type [...] ([...]): [...]
4500 ``flow flush`` destroys all rules on a device and does not take extra
4501 arguments. It is bound to ``rte_flow_flush()``::
4503 flow flush {port_id}
4505 Any errors are reported as above.
4507 Creating several rules and destroying them::
4509 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4510 actions queue index 2 / end
4511 Flow rule #0 created
4512 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4513 actions queue index 3 / end
4514 Flow rule #1 created
4515 testpmd> flow destroy 0 rule 0 rule 1
4516 Flow rule #1 destroyed
4517 Flow rule #0 destroyed
4520 The same result can be achieved using ``flow flush``::
4522 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4523 actions queue index 2 / end
4524 Flow rule #0 created
4525 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4526 actions queue index 3 / end
4527 Flow rule #1 created
4528 testpmd> flow flush 0
4531 Non-existent rule IDs are ignored::
4533 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4534 actions queue index 2 / end
4535 Flow rule #0 created
4536 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4537 actions queue index 3 / end
4538 Flow rule #1 created
4539 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4541 testpmd> flow destroy 0 rule 0
4542 Flow rule #0 destroyed
4548 ``flow query`` queries a specific action of a flow rule having that
4549 ability. Such actions collect information that can be reported using this
4550 command. It is bound to ``rte_flow_query()``::
4552 flow query {port_id} {rule_id} {action}
4554 If successful, it will display either the retrieved data for known actions
4555 or the following message::
4557 Cannot display result for action type [...] ([...])
4559 Otherwise, it will complain either that the rule does not exist or that some
4562 Flow rule #[...] not found
4566 Caught error type [...] ([...]): [...]
4568 Currently only the ``count`` action is supported. This action reports the
4569 number of packets that hit the flow rule and the total number of bytes. Its
4570 output has the following format::
4573 hits_set: [...] # whether "hits" contains a valid value
4574 bytes_set: [...] # whether "bytes" contains a valid value
4575 hits: [...] # number of packets
4576 bytes: [...] # number of bytes
4578 Querying counters for TCPv6 packets redirected to queue 6::
4580 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4581 actions queue index 6 / count / end
4582 Flow rule #4 created
4583 testpmd> flow query 0 4 count
4594 ``flow list`` lists existing flow rules sorted by priority and optionally
4595 filtered by group identifiers::
4597 flow list {port_id} [group {group_id}] [...]
4599 This command only fails with the following message if the device does not
4604 Output consists of a header line followed by a short description of each
4605 flow rule, one per line. There is no output at all when no flow rules are
4606 configured on the device::
4608 ID Group Prio Attr Rule
4609 [...] [...] [...] [...] [...]
4611 ``Attr`` column flags:
4613 - ``i`` for ``ingress``.
4614 - ``e`` for ``egress``.
4616 Creating several flow rules and listing them::
4618 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4619 actions queue index 6 / end
4620 Flow rule #0 created
4621 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4622 actions queue index 2 / end
4623 Flow rule #1 created
4624 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4625 actions rss queues 6 7 8 end / end
4626 Flow rule #2 created
4627 testpmd> flow list 0
4628 ID Group Prio Attr Rule
4629 0 0 0 i- ETH IPV4 => QUEUE
4630 1 0 0 i- ETH IPV6 => QUEUE
4631 2 0 5 i- ETH IPV4 UDP => RSS
4634 Rules are sorted by priority (i.e. group ID first, then priority level)::
4636 testpmd> flow list 1
4637 ID Group Prio Attr Rule
4638 0 0 0 i- ETH => COUNT
4639 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4640 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4641 1 24 0 i- ETH IPV4 UDP => QUEUE
4642 4 24 10 i- ETH IPV4 TCP => DROP
4643 3 24 20 i- ETH IPV4 => DROP
4644 2 24 42 i- ETH IPV4 UDP => QUEUE
4645 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4648 Output can be limited to specific groups::
4650 testpmd> flow list 1 group 0 group 63
4651 ID Group Prio Attr Rule
4652 0 0 0 i- ETH => COUNT
4653 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4654 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4655 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4658 Toggling isolated mode
4659 ~~~~~~~~~~~~~~~~~~~~~~
4661 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4662 must only be injected from the defined flow rules; that no default traffic
4663 is expected outside those rules and the driver is free to assign more
4664 resources to handle them. It is bound to ``rte_flow_isolate()``::
4666 flow isolate {port_id} {boolean}
4668 If successful, enabling or disabling isolated mode shows either::
4670 Ingress traffic on port [...]
4671 is now restricted to the defined flow rules
4675 Ingress traffic on port [...]
4676 is not restricted anymore to the defined flow rules
4678 Otherwise, in case of error::
4680 Caught error type [...] ([...]): [...]
4682 Mainly due to its side effects, PMDs supporting this mode may not have the
4683 ability to toggle it more than once without reinitializing affected ports
4684 first (e.g. by exiting testpmd).
4686 Enabling isolated mode::
4688 testpmd> flow isolate 0 true
4689 Ingress traffic on port 0 is now restricted to the defined flow rules
4692 Disabling isolated mode::
4694 testpmd> flow isolate 0 false
4695 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4698 Dumping HW internal information
4699 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4701 ``flow dump`` dumps the hardware's internal representation information of
4702 all flows. It is bound to ``rte_flow_dev_dump()``::
4704 flow dump {port_id} {output_file}
4706 If successful, it will show::
4710 Otherwise, it will complain error occurred::
4712 Caught error type [...] ([...]): [...]
4714 Listing and destroying aged flow rules
4715 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4717 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4718 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4720 flow aged {port_id} [destroy]
4722 Listing current aged flow rules::
4724 testpmd> flow aged 0
4725 Port 0 total aged flows: 0
4726 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4727 actions age timeout 5 / queue index 0 / end
4728 Flow rule #0 created
4729 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4730 actions age timeout 4 / queue index 0 / end
4731 Flow rule #1 created
4732 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4733 actions age timeout 2 / queue index 0 / end
4734 Flow rule #2 created
4735 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4736 actions age timeout 3 / queue index 0 / end
4737 Flow rule #3 created
4740 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4741 information, all the aged flows are sorted by the longest timeout time. For example, if
4742 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4743 will be ID 3, ID 1, ID 0::
4745 testpmd> flow aged 0
4746 Port 0 total aged flows: 4
4753 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4755 testpmd> flow aged 0 destroy
4756 Port 0 total aged flows: 4
4763 Flow rule #2 destroyed
4764 Flow rule #3 destroyed
4765 Flow rule #1 destroyed
4766 Flow rule #0 destroyed
4767 4 flows be destroyed
4768 testpmd> flow aged 0
4769 Port 0 total aged flows: 0
4771 Creating shared actions
4772 ~~~~~~~~~~~~~~~~~~~~~~~
4773 ``flow shared_action {port_id} create`` creates shared action with optional
4774 shared action ID. It is bound to ``rte_flow_shared_action_create()``::
4776 flow shared_action {port_id} create [action_id {shared_action_id}]
4777 [ingress] [egress] action {action} / end
4779 If successful, it will show::
4781 Shared action #[...] created
4783 Otherwise, it will complain either that shared action already exists or that
4784 some error occurred::
4786 Shared action #[...] is already assigned, delete it first
4790 Caught error type [...] ([...]): [...]
4792 Create shared rss action with id 100 to queues 1 and 2 on port 0::
4794 testpmd> flow shared_action 0 create action_id 100 \
4795 ingress action rss queues 1 2 end / end
4797 Create shared rss action with id assigned by testpmd to queues 1 and 2 on
4800 testpmd> flow shared_action 0 create action_id \
4801 ingress action rss queues 0 1 end / end
4803 Updating shared actions
4804 ~~~~~~~~~~~~~~~~~~~~~~~
4805 ``flow shared_action {port_id} update`` updates configuration of the shared
4806 action from its shared action ID (as returned by
4807 ``flow shared_action {port_id} create``). It is bound to
4808 ``rte_flow_shared_action_update()``::
4810 flow shared_action {port_id} update {shared_action_id}
4811 action {action} / end
4813 If successful, it will show::
4815 Shared action #[...] updated
4817 Otherwise, it will complain either that shared action not found or that some
4820 Failed to find shared action #[...] on port [...]
4824 Caught error type [...] ([...]): [...]
4826 Update shared rss action having id 100 on port 0 with rss to queues 0 and 3
4827 (in create example above rss queues were 1 and 2)::
4829 testpmd> flow shared_action 0 update 100 action rss queues 0 3 end / end
4831 Destroying shared actions
4832 ~~~~~~~~~~~~~~~~~~~~~~~~~
4833 ``flow shared_action {port_id} update`` destroys one or more shared actions
4834 from their shared action IDs (as returned by
4835 ``flow shared_action {port_id} create``). It is bound to
4836 ``rte_flow_shared_action_destroy()``::
4838 flow shared_action {port_id} destroy action_id {shared_action_id} [...]
4840 If successful, it will show::
4842 Shared action #[...] destroyed
4844 It does not report anything for shared action IDs that do not exist.
4845 The usual error message is shown when a shared action cannot be destroyed::
4847 Caught error type [...] ([...]): [...]
4849 Destroy shared actions having id 100 & 101::
4851 testpmd> flow shared_action 0 destroy action_id 100 action_id 101
4853 Query shared actions
4854 ~~~~~~~~~~~~~~~~~~~~
4855 ``flow shared_action {port_id} query`` queries the shared action from its
4856 shared action ID (as returned by ``flow shared_action {port_id} create``).
4857 It is bound to ``rte_flow_shared_action_query()``::
4859 flow shared_action {port_id} query {shared_action_id}
4861 Currently only rss shared action supported. If successful, it will show::
4866 Otherwise, it will complain either that shared action not found or that some
4869 Failed to find shared action #[...] on port [...]
4873 Caught error type [...] ([...]): [...]
4875 Query shared action having id 100::
4877 testpmd> flow shared_action 0 query 100
4879 Sample QinQ flow rules
4880 ~~~~~~~~~~~~~~~~~~~~~~
4882 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4884 testpmd> port stop 0
4885 testpmd> vlan set qinq_strip on 0
4887 The above command sets the inner and outer TPID's to 0x8100.
4889 To change the TPID's the following commands should be used::
4891 testpmd> vlan set outer tpid 0xa100 0
4892 testpmd> vlan set inner tpid 0x9100 0
4893 testpmd> port start 0
4895 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4899 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4900 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4901 Flow rule #0 validated
4903 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4904 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4905 Flow rule #0 created
4907 testpmd> flow list 0
4908 ID Group Prio Attr Rule
4909 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4911 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4915 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4916 vlan tci is 654 / end actions pf / queue index 0 / end
4917 Flow rule #1 validated
4919 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4920 vlan tci is 654 / end actions pf / queue index 1 / end
4921 Flow rule #1 created
4923 testpmd> flow list 0
4924 ID Group Prio Attr Rule
4925 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4926 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4928 Sample VXLAN flow rules
4929 ~~~~~~~~~~~~~~~~~~~~~~~
4931 Before creating VXLAN rule(s), the UDP port should be added for VXLAN packet
4934 testpmd> rx_vxlan_port add 4789 0
4936 Create VXLAN rules on port 0 to steer traffic to PF queues.
4940 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
4941 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 1 / end
4942 Flow rule #0 created
4944 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 3 /
4945 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 2 / end
4946 Flow rule #1 created
4948 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
4949 eth dst is 00:11:22:33:44:55 / vlan tci is 10 / end actions pf /
4951 Flow rule #2 created
4953 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 5 /
4954 eth dst is 00:11:22:33:44:55 / vlan tci is 20 / end actions pf /
4956 Flow rule #3 created
4958 testpmd> flow create 0 ingress pattern eth dst is 00:00:00:00:01:00 / ipv4 /
4959 udp / vxlan vni is 6 / eth dst is 00:11:22:33:44:55 / end actions pf /
4961 Flow rule #4 created
4963 testpmd> flow list 0
4964 ID Group Prio Attr Rule
4965 0 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4966 1 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4967 2 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
4968 3 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
4969 4 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4971 Sample VXLAN encapsulation rule
4972 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4974 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4975 source code, those can be changed by using the following commands
4977 IPv4 VXLAN outer header::
4979 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4980 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4981 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4984 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4985 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4986 eth-dst 22:22:22:22:22:22
4987 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4990 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4991 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4992 eth-dst 22:22:22:22:22:22
4993 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4996 IPv6 VXLAN outer header::
4998 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4999 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5000 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5003 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
5004 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
5005 eth-dst 22:22:22:22:22:22
5006 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5009 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
5010 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
5011 eth-dst 22:22:22:22:22:22
5012 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5015 Sample NVGRE encapsulation rule
5016 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5018 NVGRE encapsulation outer layer has default value pre-configured in testpmd
5019 source code, those can be changed by using the following commands
5021 IPv4 NVGRE outer header::
5023 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
5024 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5025 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5028 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
5029 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
5030 eth-dst 22:22:22:22:22:22
5031 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5034 IPv6 NVGRE outer header::
5036 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
5037 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5038 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5041 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
5042 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5043 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5046 Sample L2 encapsulation rule
5047 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5049 L2 encapsulation has default value pre-configured in testpmd
5050 source code, those can be changed by using the following commands
5054 testpmd> set l2_encap ip-version ipv4
5055 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5056 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5057 mplsoudp_decap / l2_encap / end
5059 L2 with VXLAN header::
5061 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
5062 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5063 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5064 mplsoudp_decap / l2_encap / end
5066 Sample L2 decapsulation rule
5067 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5069 L2 decapsulation has default value pre-configured in testpmd
5070 source code, those can be changed by using the following commands
5074 testpmd> set l2_decap
5075 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
5078 L2 with VXLAN header::
5080 testpmd> set l2_encap-with-vlan
5081 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
5084 Sample MPLSoGRE encapsulation rule
5085 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5087 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
5088 source code, those can be changed by using the following commands
5090 IPv4 MPLSoGRE outer header::
5092 testpmd> set mplsogre_encap ip-version ipv4 label 4
5093 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
5094 eth-dst 22:22:22:22:22:22
5095 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5096 mplsogre_encap / end
5098 IPv4 MPLSoGRE with VLAN outer header::
5100 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
5101 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
5102 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5103 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5104 mplsogre_encap / end
5106 IPv6 MPLSoGRE outer header::
5108 testpmd> set mplsogre_encap ip-version ipv6 mask 4
5109 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
5110 eth-dst 22:22:22:22:22:22
5111 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5112 mplsogre_encap / end
5114 IPv6 MPLSoGRE with VLAN outer header::
5116 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
5117 ip-src ::1 ip-dst ::2222 vlan-tci 34
5118 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5119 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5120 mplsogre_encap / end
5122 Sample MPLSoGRE decapsulation rule
5123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5125 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
5126 source code, those can be changed by using the following commands
5128 IPv4 MPLSoGRE outer header::
5130 testpmd> set mplsogre_decap ip-version ipv4
5131 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
5132 mplsogre_decap / l2_encap / end
5134 IPv4 MPLSoGRE with VLAN outer header::
5136 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
5137 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
5138 actions mplsogre_decap / l2_encap / end
5140 IPv6 MPLSoGRE outer header::
5142 testpmd> set mplsogre_decap ip-version ipv6
5143 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
5144 actions mplsogre_decap / l2_encap / end
5146 IPv6 MPLSoGRE with VLAN outer header::
5148 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
5149 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
5150 actions mplsogre_decap / l2_encap / end
5152 Sample MPLSoUDP encapsulation rule
5153 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5155 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
5156 source code, those can be changed by using the following commands
5158 IPv4 MPLSoUDP outer header::
5160 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
5161 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
5162 eth-dst 22:22:22:22:22:22
5163 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5164 mplsoudp_encap / end
5166 IPv4 MPLSoUDP with VLAN outer header::
5168 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
5169 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
5170 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5171 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5172 mplsoudp_encap / end
5174 IPv6 MPLSoUDP outer header::
5176 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
5177 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
5178 eth-dst 22:22:22:22:22:22
5179 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5180 mplsoudp_encap / end
5182 IPv6 MPLSoUDP with VLAN outer header::
5184 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
5185 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
5186 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5187 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5188 mplsoudp_encap / end
5190 Sample MPLSoUDP decapsulation rule
5191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5193 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
5194 source code, those can be changed by using the following commands
5196 IPv4 MPLSoUDP outer header::
5198 testpmd> set mplsoudp_decap ip-version ipv4
5199 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5200 mplsoudp_decap / l2_encap / end
5202 IPv4 MPLSoUDP with VLAN outer header::
5204 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
5205 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
5206 actions mplsoudp_decap / l2_encap / end
5208 IPv6 MPLSoUDP outer header::
5210 testpmd> set mplsoudp_decap ip-version ipv6
5211 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
5212 actions mplsoudp_decap / l2_encap / end
5214 IPv6 MPLSoUDP with VLAN outer header::
5216 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
5217 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
5218 actions mplsoudp_decap / l2_encap / end
5220 Sample Raw encapsulation rule
5221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5223 Raw encapsulation configuration can be set by the following commands
5225 Eecapsulating VxLAN::
5227 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
5228 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
5230 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
5231 raw_encap index 4 / end
5233 Sample Raw decapsulation rule
5234 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5236 Raw decapsulation configuration can be set by the following commands
5238 Decapsulating VxLAN::
5240 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
5241 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
5242 end actions raw_decap / queue index 0 / end
5247 ESP rules can be created by the following commands::
5249 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
5251 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
5252 actions queue index 3 / end
5253 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
5255 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
5256 actions queue index 3 / end
5261 AH rules can be created by the following commands::
5263 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
5265 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
5266 actions queue index 3 / end
5267 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
5269 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
5270 actions queue index 3 / end
5275 PFCP rules can be created by the following commands(s_field need to be 1
5278 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
5279 actions queue index 3 / end
5280 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
5281 seid is 1 / end actions queue index 3 / end
5282 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
5283 actions queue index 3 / end
5284 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
5285 seid is 1 / end actions queue index 3 / end
5290 The following sections show functions to load/unload eBPF based filters.
5295 Load an eBPF program as a callback for particular RX/TX queue::
5297 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
5299 The available load-flags are:
5301 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
5303 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
5309 You'll need clang v3.7 or above to build bpf program you'd like to load
5313 .. code-block:: console
5316 clang -O2 -target bpf -c t1.c
5318 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
5320 .. code-block:: console
5322 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
5324 To load (not JITed) t1.o at TX queue 0, port 0:
5326 .. code-block:: console
5328 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
5333 Unload previously loaded eBPF program for particular RX/TX queue::
5335 testpmd> bpf-unload rx|tx (portid) (queueid)
5337 For example to unload BPF filter from TX queue 0, port 0:
5339 .. code-block:: console
5341 testpmd> bpf-unload tx 0 0