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 an UDP port for VXLAN packet filter on a port::
1080 testpmd> rx_vxlan_port add (udp_port) (port_id)
1082 rx_vxlan_port remove
1083 ~~~~~~~~~~~~~~~~~~~~
1085 Remove an UDP port for VXLAN packet filter on a port::
1087 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1092 Set hardware insertion of VLAN IDs in packets sent on a port::
1094 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1096 For example, set a single VLAN ID (5) insertion on port 0::
1100 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1108 Set port based hardware insertion of VLAN ID in packets sent on a port::
1110 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1115 Disable hardware insertion of a VLAN header in packets sent on a port::
1117 testpmd> tx_vlan reset (port_id)
1122 Select hardware or software calculation of the checksum when
1123 transmitting a packet using the ``csum`` forwarding engine::
1125 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1129 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1131 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1132 as a tunnel packet by the forwarding engine (geneve, gre, gtp, ipip, vxlan and vxlan-gpe are
1133 supported). See also the ``csum parse-tunnel`` command.
1135 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1136 as a tunnel packet by the forwarding engine (geneve, gtp, vxlan and vxlan-gpe are
1137 supported). See also the ``csum parse-tunnel`` command.
1141 Check the NIC Datasheet for hardware limits.
1146 Set RSS queue region span on a port::
1148 testpmd> set port (port_id) queue-region region_id (value) \
1149 queue_start_index (value) queue_num (value)
1151 Set flowtype mapping on a RSS queue region on a port::
1153 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1157 * For the flowtype(pctype) of packet,the specific index for each type has
1158 been defined in file i40e_type.h as enum i40e_filter_pctype.
1160 Set user priority mapping on a RSS queue region on a port::
1162 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1164 Flush all queue region related configuration on a port::
1166 testpmd> set port (port_id) queue-region flush (on|off)
1170 * ``on``: is just an enable function which server for other configuration,
1171 it is for all configuration about queue region from up layer,
1172 at first will only keep in DPDK software stored in driver,
1173 only after "flush on", it commit all configuration to HW.
1175 * ``"off``: is just clean all configuration about queue region just now,
1176 and restore all to DPDK i40e driver default config when start up.
1178 Show all queue region related configuration info on a port::
1180 testpmd> show port (port_id) queue-region
1184 Queue region only support on PF by now, so these command is
1185 only for configuration of queue region on PF port.
1190 Define how tunneled packets should be handled by the csum forward
1193 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1195 If enabled, the csum forward engine will try to recognize supported
1196 tunnel headers (geneve, gtp, gre, ipip, vxlan, vxlan-gpe).
1198 If disabled, treat tunnel packets as non-tunneled packets (a inner
1199 header is handled as a packet payload).
1203 The port argument is the TX port like in the ``csum set`` command.
1207 Consider a packet in packet like the following::
1209 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1211 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1212 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1213 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1215 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1216 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1221 Display tx checksum offload configuration::
1223 testpmd> csum show (port_id)
1228 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1230 testpmd> tso set (segsize) (port_id)
1234 Check the NIC datasheet for hardware limits.
1239 Display the status of TCP Segmentation Offload::
1241 testpmd> tso show (port_id)
1246 Set tso segment size of tunneled packets for a port in csum engine::
1248 testpmd> tunnel_tso set (tso_segsz) (port_id)
1253 Display the status of tunneled TCP Segmentation Offload for a port::
1255 testpmd> tunnel_tso show (port_id)
1260 Enable or disable GRO in ``csum`` forwarding engine::
1262 testpmd> set port <port_id> gro on|off
1264 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1265 packets received from the given port.
1267 If disabled, packets received from the given port won't be performed
1268 GRO. By default, GRO is disabled for all ports.
1272 When enable GRO for a port, TCP/IPv4 packets received from the port
1273 will be performed GRO. After GRO, all merged packets have bad
1274 checksums, since the GRO library doesn't re-calculate checksums for
1275 the merged packets. Therefore, if users want the merged packets to
1276 have correct checksums, please select HW IP checksum calculation and
1277 HW TCP checksum calculation for the port which the merged packets are
1283 Display GRO configuration for a given port::
1285 testpmd> show port <port_id> gro
1290 Set the cycle to flush the GROed packets from reassembly tables::
1292 testpmd> set gro flush <cycles>
1294 When enable GRO, the csum forwarding engine performs GRO on received
1295 packets, and the GROed packets are stored in reassembly tables. Users
1296 can use this command to determine when the GROed packets are flushed
1297 from the reassembly tables.
1299 The ``cycles`` is measured in GRO operation times. The csum forwarding
1300 engine flushes the GROed packets from the tables every ``cycles`` GRO
1303 By default, the value of ``cycles`` is 1, which means flush GROed packets
1304 from the reassembly tables as soon as one GRO operation finishes. The value
1305 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1307 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1308 stack performance. Because the GROed packets are delayed to arrive the
1309 stack, thus causing more duplicated ACKs and TCP retransmissions.
1314 Toggle per-port GSO support in ``csum`` forwarding engine::
1316 testpmd> set port <port_id> gso on|off
1318 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1319 packets, transmitted on the given port.
1321 If disabled, packets transmitted on the given port will not undergo GSO.
1322 By default, GSO is disabled for all ports.
1326 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1327 port undergo GSO. Afterwards, the segmented packets are represented by
1328 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1329 of checksums for GSO'd segments in SW. As a result, if users want correct
1330 checksums in GSO segments, they should enable HW checksum calculation for
1333 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1334 by setting the following options in the csum forwarding engine:
1336 testpmd> csum set outer_ip hw <port_id>
1338 testpmd> csum set ip hw <port_id>
1340 testpmd> csum set tcp hw <port_id>
1342 UDP GSO is the same as IP fragmentation, which treats the UDP header
1343 as the payload and does not modify it during segmentation. That is,
1344 after UDP GSO, only the first output fragment has the original UDP
1345 header. Therefore, users need to enable HW IP checksum calculation
1346 and SW UDP checksum calculation for GSO-enabled ports, if they want
1347 correct checksums for UDP/IPv4 packets.
1352 Set the maximum GSO segment size (measured in bytes), which includes the
1353 packet header and the packet payload for GSO-enabled ports (global)::
1355 testpmd> set gso segsz <length>
1360 Display the status of Generic Segmentation Offload for a given port::
1362 testpmd> show port <port_id> gso
1367 Add an alternative MAC address to a port::
1369 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1374 Remove a MAC address from a port::
1376 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1381 To add the multicast MAC address to/from the set of multicast addresses
1384 testpmd> mcast_addr add (port_id) (mcast_addr)
1389 To remove the multicast MAC address to/from the set of multicast addresses
1392 testpmd> mcast_addr remove (port_id) (mcast_addr)
1394 mac_addr add (for VF)
1395 ~~~~~~~~~~~~~~~~~~~~~
1397 Add an alternative MAC address for a VF to a port::
1399 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1404 Set the default MAC address for a port::
1406 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1408 mac_addr set (for VF)
1409 ~~~~~~~~~~~~~~~~~~~~~
1411 Set the MAC address for a VF from the PF::
1413 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1418 Set the forwarding peer address for certain port::
1420 testpmd> set eth-peer (port_id) (peer_addr)
1422 This is equivalent to the ``--eth-peer`` command-line option.
1427 Set the unicast hash filter(s) on/off for a port::
1429 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1434 Set the promiscuous mode on for a port or for all ports.
1435 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1437 testpmd> set promisc (port_id|all) (on|off)
1442 Set the allmulti mode for a port or for all ports::
1444 testpmd> set allmulti (port_id|all) (on|off)
1446 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1448 set promisc (for VF)
1449 ~~~~~~~~~~~~~~~~~~~~
1451 Set the unicast promiscuous mode for a VF from PF.
1452 It's supported by Intel i40e NICs now.
1453 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1455 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1457 set allmulticast (for VF)
1458 ~~~~~~~~~~~~~~~~~~~~~~~~~
1460 Set the multicast promiscuous mode for a VF from PF.
1461 It's supported by Intel i40e NICs now.
1462 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1464 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1466 set tx max bandwidth (for VF)
1467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1469 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1471 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1473 set tc tx min bandwidth (for VF)
1474 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1476 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1478 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1480 set tc tx max bandwidth (for VF)
1481 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1483 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1485 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1487 set tc strict link priority mode
1488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1490 Set some TCs' strict link priority mode on a physical port::
1492 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1494 set tc tx min bandwidth
1495 ~~~~~~~~~~~~~~~~~~~~~~~
1497 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1499 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1504 Set the link flow control parameter on a port::
1506 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1507 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1508 autoneg (on|off) (port_id)
1512 * ``high_water`` (integer): High threshold value to trigger XOFF.
1514 * ``low_water`` (integer): Low threshold value to trigger XON.
1516 * ``pause_time`` (integer): Pause quota in the Pause frame.
1518 * ``send_xon`` (0/1): Send XON frame.
1520 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1522 * ``autoneg``: Change the auto-negotiation parameter.
1527 Set the priority flow control parameter on a port::
1529 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1530 (pause_time) (priority) (port_id)
1534 * ``high_water`` (integer): High threshold value.
1536 * ``low_water`` (integer): Low threshold value.
1538 * ``pause_time`` (integer): Pause quota in the Pause frame.
1540 * ``priority`` (0-7): VLAN User Priority.
1545 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1547 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1549 For example, to set rx queue 2 on port 0 to mapping 5::
1551 testpmd>set stat_qmap rx 0 2 5
1553 set xstats-hide-zero
1554 ~~~~~~~~~~~~~~~~~~~~
1556 Set the option to hide zero values for xstats display::
1558 testpmd> set xstats-hide-zero on|off
1562 By default, the zero values are displayed for xstats.
1564 set port - rx/tx (for VF)
1565 ~~~~~~~~~~~~~~~~~~~~~~~~~
1567 Set VF receive/transmit from a port::
1569 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1571 set port - rx mode(for VF)
1572 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1574 Set the VF receive mode of a port::
1576 testpmd> set port (port_id) vf (vf_id) \
1577 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1579 The available receive modes are:
1581 * ``AUPE``: Accepts untagged VLAN.
1583 * ``ROPE``: Accepts unicast hash.
1585 * ``BAM``: Accepts broadcast packets.
1587 * ``MPE``: Accepts all multicast packets.
1589 set port - tx_rate (for Queue)
1590 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1592 Set TX rate limitation for a queue on a port::
1594 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1596 set port - tx_rate (for VF)
1597 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1599 Set TX rate limitation for queues in VF on a port::
1601 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1603 set port - mirror rule
1604 ~~~~~~~~~~~~~~~~~~~~~~
1606 Set pool or vlan type mirror rule for a port::
1608 testpmd> set port (port_id) mirror-rule (rule_id) \
1609 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1610 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1612 Set link mirror rule for a port::
1614 testpmd> set port (port_id) mirror-rule (rule_id) \
1615 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1617 For example to enable mirror traffic with vlan 0,1 to pool 0::
1619 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1621 reset port - mirror rule
1622 ~~~~~~~~~~~~~~~~~~~~~~~~
1624 Reset a mirror rule for a port::
1626 testpmd> reset port (port_id) mirror-rule (rule_id)
1631 Set the flush on RX streams before forwarding.
1632 The default is flush ``on``.
1633 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1635 testpmd> set flush_rx off
1640 Set the bypass mode for the lowest port on bypass enabled NIC::
1642 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1647 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1649 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1650 mode (normal|bypass|isolate) (port_id)
1654 * ``timeout``: Enable bypass after watchdog timeout.
1656 * ``os_on``: Enable bypass when OS/board is powered on.
1658 * ``os_off``: Enable bypass when OS/board is powered off.
1660 * ``power_on``: Enable bypass when power supply is turned on.
1662 * ``power_off``: Enable bypass when power supply is turned off.
1668 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1670 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1675 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1677 testpmd> show bypass config (port_id)
1682 Set link up for a port::
1684 testpmd> set link-up port (port id)
1689 Set link down for a port::
1691 testpmd> set link-down port (port id)
1696 Enable E-tag insertion for a VF on a port::
1698 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1700 Disable E-tag insertion for a VF on a port::
1702 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1704 Enable/disable E-tag stripping on a port::
1706 testpmd> E-tag set stripping (on|off) port (port_id)
1708 Enable/disable E-tag based forwarding on a port::
1710 testpmd> E-tag set forwarding (on|off) port (port_id)
1715 Load a dynamic device personalization (DDP) profile and store backup profile::
1717 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1722 Delete a dynamic device personalization profile and restore backup profile::
1724 testpmd> ddp del (port_id) (backup_profile_path)
1729 List all items from the ptype mapping table::
1731 testpmd> ptype mapping get (port_id) (valid_only)
1735 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1737 Replace a specific or a group of software defined ptype with a new one::
1739 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1743 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1745 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1747 * ``pkt_type``: The new software ptype to replace the old ones.
1749 Update hardware defined ptype to software defined packet type mapping table::
1751 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1755 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1757 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1759 Reset ptype mapping table::
1761 testpmd> ptype mapping reset (port_id)
1763 config per port Rx offloading
1764 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1766 Enable or disable a per port Rx offloading on all Rx queues of a port::
1768 testpmd> port config (port_id) rx_offload (offloading) on|off
1770 * ``offloading``: can be any of these offloading capability:
1771 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1772 qinq_strip, outer_ipv4_cksum, macsec_strip,
1773 header_split, vlan_filter, vlan_extend, jumbo_frame,
1774 scatter, timestamp, security, keep_crc, rss_hash
1776 This command should be run when the port is stopped, or else it will fail.
1778 config per queue Rx offloading
1779 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1781 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1783 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1785 * ``offloading``: can be any of these offloading capability:
1786 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1787 qinq_strip, outer_ipv4_cksum, macsec_strip,
1788 header_split, vlan_filter, vlan_extend, jumbo_frame,
1789 scatter, timestamp, security, keep_crc
1791 This command should be run when the port is stopped, or else it will fail.
1793 config per port Tx offloading
1794 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1796 Enable or disable a per port Tx offloading on all Tx queues of a port::
1798 testpmd> port config (port_id) tx_offload (offloading) on|off
1800 * ``offloading``: can be any of these offloading capability:
1801 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1802 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1803 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1804 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1805 mt_lockfree, multi_segs, mbuf_fast_free, security
1807 This command should be run when the port is stopped, or else it will fail.
1809 config per queue Tx offloading
1810 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1812 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1814 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1816 * ``offloading``: can be any of these offloading capability:
1817 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1818 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1819 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1820 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1821 mt_lockfree, multi_segs, mbuf_fast_free, security
1823 This command should be run when the port is stopped, or else it will fail.
1825 Config VXLAN Encap outer layers
1826 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1828 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1830 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1831 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1834 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1835 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1836 eth-src (eth-src) eth-dst (eth-dst)
1838 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1839 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1840 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1842 These commands will set an internal configuration inside testpmd, any following
1843 flow rule using the action vxlan_encap will use the last configuration set.
1844 To have a different encapsulation header, one of those commands must be called
1845 before the flow rule creation.
1847 Config NVGRE Encap outer layers
1848 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1850 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1852 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1853 eth-src (eth-src) eth-dst (eth-dst)
1854 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1855 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1857 These commands will set an internal configuration inside testpmd, any following
1858 flow rule using the action nvgre_encap will use the last configuration set.
1859 To have a different encapsulation header, one of those commands must be called
1860 before the flow rule creation.
1865 Configure the l2 to be used when encapsulating a packet with L2::
1867 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1868 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1869 eth-src (eth-src) eth-dst (eth-dst)
1871 Those commands will set an internal configuration inside testpmd, any following
1872 flow rule using the action l2_encap will use the last configuration set.
1873 To have a different encapsulation header, one of those commands must be called
1874 before the flow rule creation.
1879 Configure the l2 to be removed when decapsulating a packet with L2::
1881 set l2_decap ip-version (ipv4|ipv6)
1882 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1884 Those commands will set an internal configuration inside testpmd, any following
1885 flow rule using the action l2_decap will use the last configuration set.
1886 To have a different encapsulation header, one of those commands must be called
1887 before the flow rule creation.
1889 Config MPLSoGRE Encap outer layers
1890 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1892 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1894 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1895 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1896 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1897 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1898 eth-src (eth-src) eth-dst (eth-dst)
1900 These commands will set an internal configuration inside testpmd, any following
1901 flow rule using the action mplsogre_encap will use the last configuration set.
1902 To have a different encapsulation header, one of those commands must be called
1903 before the flow rule creation.
1905 Config MPLSoGRE Decap outer layers
1906 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1908 Configure the outer layer to decapsulate MPLSoGRE packet::
1910 set mplsogre_decap ip-version (ipv4|ipv6)
1911 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1913 These commands will set an internal configuration inside testpmd, any following
1914 flow rule using the action mplsogre_decap will use the last configuration set.
1915 To have a different decapsulation header, one of those commands must be called
1916 before the flow rule creation.
1918 Config MPLSoUDP Encap outer layers
1919 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1921 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1923 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1924 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1925 eth-src (eth-src) eth-dst (eth-dst)
1926 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1927 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1928 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1930 These commands will set an internal configuration inside testpmd, any following
1931 flow rule using the action mplsoudp_encap will use the last configuration set.
1932 To have a different encapsulation header, one of those commands must be called
1933 before the flow rule creation.
1935 Config MPLSoUDP Decap outer layers
1936 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1938 Configure the outer layer to decapsulate MPLSoUDP packet::
1940 set mplsoudp_decap ip-version (ipv4|ipv6)
1941 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1943 These commands will set an internal configuration inside testpmd, any following
1944 flow rule using the action mplsoudp_decap will use the last configuration set.
1945 To have a different decapsulation header, one of those commands must be called
1946 before the flow rule creation.
1948 Config Raw Encapsulation
1949 ~~~~~~~~~~~~~~~~~~~~~~~~~
1951 Configure the raw data to be used when encapsulating a packet by
1952 rte_flow_action_raw_encap::
1954 set raw_encap {index} {item} [/ {item} [...]] / end_set
1956 There are multiple global buffers for ``raw_encap``, this command will set one
1957 internal buffer index by ``{index}``.
1958 If there is no ``{index}`` specified::
1960 set raw_encap {item} [/ {item} [...]] / end_set
1962 the default index ``0`` is used.
1963 In order to use different encapsulating header, ``index`` must be specified
1964 during the flow rule creation::
1966 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1967 raw_encap index 2 / end
1969 Otherwise the default index ``0`` is used.
1971 Config Raw Decapsulation
1972 ~~~~~~~~~~~~~~~~~~~~~~~~
1974 Configure the raw data to be used when decapsulating a packet by
1975 rte_flow_action_raw_decap::
1977 set raw_decap {index} {item} [/ {item} [...]] / end_set
1979 There are multiple global buffers for ``raw_decap``, this command will set
1980 one internal buffer index by ``{index}``.
1981 If there is no ``{index}`` specified::
1983 set raw_decap {item} [/ {item} [...]] / end_set
1985 the default index ``0`` is used.
1986 In order to use different decapsulating header, ``index`` must be specified
1987 during the flow rule creation::
1989 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1990 raw_encap index 3 / end
1992 Otherwise the default index ``0`` is used.
1997 Set fec mode for a specific port::
1999 testpmd> set port (port_id) fec_mode auto|off|rs|baser
2005 The following sections show functions for configuring ports.
2009 Port configuration changes only become active when forwarding is started/restarted.
2014 Attach a port specified by pci address or virtual device args::
2016 testpmd> port attach (identifier)
2018 To attach a new pci device, the device should be recognized by kernel first.
2019 Then it should be moved under DPDK management.
2020 Finally the port can be attached to testpmd.
2022 For example, to move a pci device using ixgbe under DPDK management:
2024 .. code-block:: console
2026 # Check the status of the available devices.
2027 ./usertools/dpdk-devbind.py --status
2029 Network devices using DPDK-compatible driver
2030 ============================================
2033 Network devices using kernel driver
2034 ===================================
2035 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
2038 # Bind the device to igb_uio.
2039 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
2042 # Recheck the status of the devices.
2043 ./usertools/dpdk-devbind.py --status
2044 Network devices using DPDK-compatible driver
2045 ============================================
2046 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
2048 To attach a port created by virtual device, above steps are not needed.
2050 For example, to attach a port whose pci address is 0000:0a:00.0.
2052 .. code-block:: console
2054 testpmd> port attach 0000:0a:00.0
2055 Attaching a new port...
2056 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2057 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
2058 EAL: PCI memory mapped at 0x7f83bfa00000
2059 EAL: PCI memory mapped at 0x7f83bfa80000
2060 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
2061 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
2062 Port 0 is attached. Now total ports is 1
2065 For example, to attach a port created by pcap PMD.
2067 .. code-block:: console
2069 testpmd> port attach net_pcap0
2070 Attaching a new port...
2071 PMD: Initializing pmd_pcap for net_pcap0
2072 PMD: Creating pcap-backed ethdev on numa socket 0
2073 Port 0 is attached. Now total ports is 1
2076 In this case, identifier is ``net_pcap0``.
2077 This identifier format is the same as ``--vdev`` format of DPDK applications.
2079 For example, to re-attach a bonded port which has been previously detached,
2080 the mode and slave parameters must be given.
2082 .. code-block:: console
2084 testpmd> port attach net_bond_0,mode=0,slave=1
2085 Attaching a new port...
2086 EAL: Initializing pmd_bond for net_bond_0
2087 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2088 Port 0 is attached. Now total ports is 1
2095 Detach a specific port::
2097 testpmd> port detach (port_id)
2099 Before detaching a port, the port should be stopped and closed.
2101 For example, to detach a pci device port 0.
2103 .. code-block:: console
2105 testpmd> port stop 0
2108 testpmd> port close 0
2112 testpmd> port detach 0
2114 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2115 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2116 EAL: PCI memory unmapped at 0x7f83bfa00000
2117 EAL: PCI memory unmapped at 0x7f83bfa80000
2121 For example, to detach a virtual device port 0.
2123 .. code-block:: console
2125 testpmd> port stop 0
2128 testpmd> port close 0
2132 testpmd> port detach 0
2134 PMD: Closing pcap ethdev on numa socket 0
2135 Port 'net_pcap0' is detached. Now total ports is 0
2138 To remove a pci device completely from the system, first detach the port from testpmd.
2139 Then the device should be moved under kernel management.
2140 Finally the device can be removed using kernel pci hotplug functionality.
2142 For example, to move a pci device under kernel management:
2144 .. code-block:: console
2146 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2148 ./usertools/dpdk-devbind.py --status
2150 Network devices using DPDK-compatible driver
2151 ============================================
2154 Network devices using kernel driver
2155 ===================================
2156 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2158 To remove a port created by a virtual device, above steps are not needed.
2163 Start all ports or a specific port::
2165 testpmd> port start (port_id|all)
2170 Stop all ports or a specific port::
2172 testpmd> port stop (port_id|all)
2177 Close all ports or a specific port::
2179 testpmd> port close (port_id|all)
2184 Reset all ports or a specific port::
2186 testpmd> port reset (port_id|all)
2188 User should stop port(s) before resetting and (re-)start after reset.
2190 port config - queue ring size
2191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2193 Configure a rx/tx queue ring size::
2195 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2197 Only take effect after command that (re-)start the port or command that setup specific queue.
2199 port start/stop queue
2200 ~~~~~~~~~~~~~~~~~~~~~
2202 Start/stop a rx/tx queue on a specific port::
2204 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2206 port config - queue deferred start
2207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2209 Switch on/off deferred start of a specific port queue::
2211 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2214 ~~~~~~~~~~~~~~~~~~~~~
2216 Setup a rx/tx queue on a specific port::
2218 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2220 Only take effect when port is started.
2225 Set the speed and duplex mode for all ports or a specific port::
2227 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \
2228 duplex (half|full|auto)
2230 port config - queues/descriptors
2231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2233 Set number of queues/descriptors for rxq, txq, rxd and txd::
2235 testpmd> port config all (rxq|txq|rxd|txd) (value)
2237 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2239 port config - max-pkt-len
2240 ~~~~~~~~~~~~~~~~~~~~~~~~~
2242 Set the maximum packet length::
2244 testpmd> port config all max-pkt-len (value)
2246 This is equivalent to the ``--max-pkt-len`` command-line option.
2248 port config - max-lro-pkt-size
2249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2251 Set the maximum LRO aggregated packet size::
2253 testpmd> port config all max-lro-pkt-size (value)
2255 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2257 port config - Drop Packets
2258 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2260 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2262 testpmd> port config all drop-en (on|off)
2264 Packet dropping when no receive buffers available is off by default.
2266 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2271 Set the RSS (Receive Side Scaling) mode on or off::
2273 testpmd> port config all rss (all|default|eth|vlan|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|l2tpv3|esp|ah|pfcp|ecpri|mpls|none)
2275 RSS is on by default.
2277 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp.
2279 The ``default`` option enables all supported RSS types reported by device info.
2281 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2283 port config - RSS Reta
2284 ~~~~~~~~~~~~~~~~~~~~~~
2286 Set the RSS (Receive Side Scaling) redirection table::
2288 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2293 Set the DCB mode for an individual port::
2295 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2297 The traffic class should be 4 or 8.
2302 Set the number of packets per burst::
2304 testpmd> port config all burst (value)
2306 This is equivalent to the ``--burst`` command-line option.
2308 port config - Threshold
2309 ~~~~~~~~~~~~~~~~~~~~~~~
2311 Set thresholds for TX/RX queues::
2313 testpmd> port config all (threshold) (value)
2315 Where the threshold type can be:
2317 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2319 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2321 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2323 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2325 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2327 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2329 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2331 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2333 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2335 These threshold options are also available from the command-line.
2337 port config pctype mapping
2338 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2340 Reset pctype mapping table::
2342 testpmd> port config (port_id) pctype mapping reset
2344 Update hardware defined pctype to software defined flow type mapping table::
2346 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2350 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2352 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2354 port config input set
2355 ~~~~~~~~~~~~~~~~~~~~~
2357 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2359 testpmd> port config (port_id) pctype (pctype_id) \
2360 (hash_inset|fdir_inset|fdir_flx_inset) \
2361 (get|set|clear) field (field_idx)
2363 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2365 testpmd> port config (port_id) pctype (pctype_id) \
2366 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2370 * ``pctype_id``: hardware packet classification types.
2371 * ``field_idx``: hardware field index.
2373 port config udp_tunnel_port
2374 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2376 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2378 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe|ecpri (udp_port)
2380 port config tx_metadata
2381 ~~~~~~~~~~~~~~~~~~~~~~~
2383 Set Tx metadata value per port.
2384 testpmd will add this value to any Tx packet sent from this port::
2386 testpmd> port config (port_id) tx_metadata (value)
2391 Set/clear dynamic flag per port.
2392 testpmd will register this flag in the mbuf (same registration
2393 for both Tx and Rx). Then set/clear this flag for each Tx
2394 packet sent from this port. The set bit only works for Tx packet::
2396 testpmd> port config (port_id) dynf (name) (set|clear)
2401 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2403 testpmd> port config mtu (port_id) (value)
2405 port config rss hash key
2406 ~~~~~~~~~~~~~~~~~~~~~~~~
2408 To configure the RSS hash key used to compute the RSS
2409 hash of input [IP] packets received on port::
2411 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2412 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2413 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2414 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2415 ipv6-udp-ex <string of hex digits \
2416 (variable length, NIC dependent)>)
2421 The following sections show functions for device operations.
2426 Detach a device specified by pci address or virtual device args::
2428 testpmd> device detach (identifier)
2430 Before detaching a device associated with ports, the ports should be stopped and closed.
2432 For example, to detach a pci device whose address is 0002:03:00.0.
2434 .. code-block:: console
2436 testpmd> device detach 0002:03:00.0
2437 Removing a device...
2438 Port 1 is now closed
2439 EAL: Releasing pci mapped resource for 0002:03:00.0
2440 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2441 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2442 Device 0002:03:00.0 is detached
2443 Now total ports is 1
2445 For example, to detach a port created by pcap PMD.
2447 .. code-block:: console
2449 testpmd> device detach net_pcap0
2450 Removing a device...
2451 Port 0 is now closed
2452 Device net_pcap0 is detached
2453 Now total ports is 0
2456 In this case, identifier is ``net_pcap0``.
2457 This identifier format is the same as ``--vdev`` format of DPDK applications.
2459 Link Bonding Functions
2460 ----------------------
2462 The Link Bonding functions make it possible to dynamically create and
2463 manage link bonding devices from within testpmd interactive prompt.
2465 create bonded device
2466 ~~~~~~~~~~~~~~~~~~~~
2468 Create a new bonding device::
2470 testpmd> create bonded device (mode) (socket)
2472 For example, to create a bonded device in mode 1 on socket 0::
2474 testpmd> create bonded device 1 0
2475 created new bonded device (port X)
2480 Adds Ethernet device to a Link Bonding device::
2482 testpmd> add bonding slave (slave id) (port id)
2484 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2486 testpmd> add bonding slave 6 10
2489 remove bonding slave
2490 ~~~~~~~~~~~~~~~~~~~~
2492 Removes an Ethernet slave device from a Link Bonding device::
2494 testpmd> remove bonding slave (slave id) (port id)
2496 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2498 testpmd> remove bonding slave 6 10
2503 Set the Link Bonding mode of a Link Bonding device::
2505 testpmd> set bonding mode (value) (port id)
2507 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2509 testpmd> set bonding mode 3 10
2514 Set an Ethernet slave device as the primary device on a Link Bonding device::
2516 testpmd> set bonding primary (slave id) (port id)
2518 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2520 testpmd> set bonding primary 6 10
2525 Set the MAC address of a Link Bonding device::
2527 testpmd> set bonding mac (port id) (mac)
2529 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2531 testpmd> set bonding mac 10 00:00:00:00:00:01
2533 set bonding balance_xmit_policy
2534 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2536 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2538 testpmd> set bonding balance_xmit_policy (port_id) (l2|l23|l34)
2540 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2542 testpmd> set bonding balance_xmit_policy 10 l34
2545 set bonding mon_period
2546 ~~~~~~~~~~~~~~~~~~~~~~
2548 Set the link status monitoring polling period in milliseconds for a bonding device.
2550 This adds support for PMD slave devices which do not support link status interrupts.
2551 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2552 link status ISR will be queried every polling interval to check if their link status has changed::
2554 testpmd> set bonding mon_period (port_id) (value)
2556 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2558 testpmd> set bonding mon_period 5 150
2561 set bonding lacp dedicated_queue
2562 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2564 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2565 when in mode 4 (link-aggregation-802.3ad)::
2567 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2570 set bonding agg_mode
2571 ~~~~~~~~~~~~~~~~~~~~
2573 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2575 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2581 Show the current configuration of a Link Bonding device::
2583 testpmd> show bonding config (port id)
2586 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2587 in balance mode with a transmission policy of layer 2+3::
2589 testpmd> show bonding config 9
2591 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2593 Active Slaves (3): [1 3 4]
2600 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2601 This is mainly useful for debugging purposes.
2602 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2603 and fields that can be accessed.
2608 Display the value of a port register::
2610 testpmd> read reg (port_id) (address)
2612 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2614 testpmd> read reg 0 0xEE00
2615 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2620 Display a port register bit field::
2622 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2624 For example, reading the lowest two bits from the register in the example above::
2626 testpmd> read regfield 0 0xEE00 0 1
2627 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2632 Display a single port register bit::
2634 testpmd> read regbit (port_id) (address) (bit_x)
2636 For example, reading the lowest bit from the register in the example above::
2638 testpmd> read regbit 0 0xEE00 0
2639 port 0 PCI register at offset 0xEE00: bit 0=1
2644 Set the value of a port register::
2646 testpmd> write reg (port_id) (address) (value)
2648 For example, to clear a register::
2650 testpmd> write reg 0 0xEE00 0x0
2651 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2656 Set bit field of a port register::
2658 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2660 For example, writing to the register cleared in the example above::
2662 testpmd> write regfield 0 0xEE00 0 1 2
2663 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2668 Set single bit value of a port register::
2670 testpmd> write regbit (port_id) (address) (bit_x) (value)
2672 For example, to set the high bit in the register from the example above::
2674 testpmd> write regbit 0 0xEE00 31 1
2675 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2677 Traffic Metering and Policing
2678 -----------------------------
2680 The following section shows functions for configuring traffic metering and
2681 policing on the ethernet device through the use of generic ethdev API.
2683 show port traffic management capability
2684 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2686 Show traffic metering and policing capability of the port::
2688 testpmd> show port meter cap (port_id)
2690 add port meter profile (srTCM rfc2967)
2691 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2693 Add meter profile (srTCM rfc2697) to the ethernet device::
2695 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2700 * ``profile_id``: ID for the meter profile.
2701 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2702 * ``cbs``: Committed Burst Size (CBS) (bytes).
2703 * ``ebs``: Excess Burst Size (EBS) (bytes).
2705 add port meter profile (trTCM rfc2968)
2706 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2708 Add meter profile (srTCM rfc2698) to the ethernet device::
2710 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2711 (cir) (pir) (cbs) (pbs)
2715 * ``profile_id``: ID for the meter profile.
2716 * ``cir``: Committed information rate (bytes/second).
2717 * ``pir``: Peak information rate (bytes/second).
2718 * ``cbs``: Committed burst size (bytes).
2719 * ``pbs``: Peak burst size (bytes).
2721 add port meter profile (trTCM rfc4115)
2722 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2724 Add meter profile (trTCM rfc4115) to the ethernet device::
2726 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2727 (cir) (eir) (cbs) (ebs)
2731 * ``profile_id``: ID for the meter profile.
2732 * ``cir``: Committed information rate (bytes/second).
2733 * ``eir``: Excess information rate (bytes/second).
2734 * ``cbs``: Committed burst size (bytes).
2735 * ``ebs``: Excess burst size (bytes).
2737 delete port meter profile
2738 ~~~~~~~~~~~~~~~~~~~~~~~~~
2740 Delete meter profile from the ethernet device::
2742 testpmd> del port meter profile (port_id) (profile_id)
2747 Create new meter object for the ethernet device::
2749 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2750 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2751 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2756 * ``mtr_id``: meter object ID.
2757 * ``profile_id``: ID for the meter profile.
2758 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2759 gets enabled at the time of creation, otherwise remains disabled.
2760 * ``g_action``: Policer action for the packet with green color.
2761 * ``y_action``: Policer action for the packet with yellow color.
2762 * ``r_action``: Policer action for the packet with red color.
2763 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2765 * ``shared``: When this parameter has a non-zero value, the meter object is
2766 shared by multiple flows. Otherwise, meter object is used by single flow.
2767 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2768 input color for the current meter object is determined by the latest meter
2769 object in the same flow. Otherwise, the current meter object uses the
2770 *dscp_table* to determine the input color.
2771 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2772 color, 0 <= x <= 63.
2777 Enable meter for the ethernet device::
2779 testpmd> enable port meter (port_id) (mtr_id)
2784 Disable meter for the ethernet device::
2786 testpmd> disable port meter (port_id) (mtr_id)
2791 Delete meter for the ethernet device::
2793 testpmd> del port meter (port_id) (mtr_id)
2795 Set port meter profile
2796 ~~~~~~~~~~~~~~~~~~~~~~
2798 Set meter profile for the ethernet device::
2800 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2802 set port meter dscp table
2803 ~~~~~~~~~~~~~~~~~~~~~~~~~
2805 Set meter dscp table for the ethernet device::
2807 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2808 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2810 set port meter policer action
2811 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2813 Set meter policer action for the ethernet device::
2815 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2816 (action0) [(action1) (action1)]
2820 * ``action_mask``: Bit mask indicating which policer actions need to be
2821 updated. One or more policer actions can be updated in a single function
2822 invocation. To update the policer action associated with color C, bit
2823 (1 << C) needs to be set in *action_mask* and element at position C
2824 in the *actions* array needs to be valid.
2825 * ``actionx``: Policer action for the color x,
2826 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2828 set port meter stats mask
2829 ~~~~~~~~~~~~~~~~~~~~~~~~~
2831 Set meter stats mask for the ethernet device::
2833 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2837 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2839 show port meter stats
2840 ~~~~~~~~~~~~~~~~~~~~~
2842 Show meter stats of the ethernet device::
2844 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2848 * ``clear``: Flag that indicates whether the statistics counters should
2849 be cleared (i.e. set to zero) immediately after they have been read or not.
2854 The following section shows functions for configuring traffic management on
2855 the ethernet device through the use of generic TM API.
2857 show port traffic management capability
2858 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2860 Show traffic management capability of the port::
2862 testpmd> show port tm cap (port_id)
2864 show port traffic management capability (hierarchy level)
2865 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2867 Show traffic management hierarchy level capability of the port::
2869 testpmd> show port tm level cap (port_id) (level_id)
2871 show port traffic management capability (hierarchy node level)
2872 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2874 Show the traffic management hierarchy node capability of the port::
2876 testpmd> show port tm node cap (port_id) (node_id)
2878 show port traffic management hierarchy node type
2879 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2881 Show the port traffic management hierarchy node type::
2883 testpmd> show port tm node type (port_id) (node_id)
2885 show port traffic management hierarchy node stats
2886 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2888 Show the port traffic management hierarchy node statistics::
2890 testpmd> show port tm node stats (port_id) (node_id) (clear)
2894 * ``clear``: When this parameter has a non-zero value, the statistics counters
2895 are cleared (i.e. set to zero) immediately after they have been read,
2896 otherwise the statistics counters are left untouched.
2898 Add port traffic management private shaper profile
2899 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2901 Add the port traffic management private shaper profile::
2903 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2904 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2905 (packet_length_adjust) (packet_mode)
2909 * ``shaper_profile id``: Shaper profile ID for the new profile.
2910 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second or packets per second).
2911 * ``cmit_tb_size``: Committed token bucket size (bytes or packets).
2912 * ``peak_tb_rate``: Peak token bucket rate (bytes per second or packets per second).
2913 * ``peak_tb_size``: Peak token bucket size (bytes or packets).
2914 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2915 each packet for the purpose of shaping. This parameter value can be used to
2916 correct the packet length with the framing overhead bytes that are consumed
2918 * ``packet_mode``: Shaper configured in packet mode. This parameter value if
2919 zero, configures shaper in byte mode and if non-zero configures it in packet
2922 Delete port traffic management private shaper profile
2923 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2925 Delete the port traffic management private shaper::
2927 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2931 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2933 Add port traffic management shared shaper
2934 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2936 Create the port traffic management shared shaper::
2938 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2943 * ``shared_shaper_id``: Shared shaper ID to be created.
2944 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2946 Set port traffic management shared shaper
2947 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2949 Update the port traffic management shared shaper::
2951 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2956 * ``shared_shaper_id``: Shared shaper ID to be update.
2957 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2959 Delete port traffic management shared shaper
2960 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2962 Delete the port traffic management shared shaper::
2964 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2968 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2970 Set port traffic management hierarchy node private shaper
2971 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2973 set the port traffic management hierarchy node private shaper::
2975 testpmd> set port tm node shaper profile (port_id) (node_id) \
2980 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2983 Add port traffic management WRED profile
2984 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2986 Create a new WRED profile::
2988 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2989 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2990 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2991 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2995 * ``wred_profile id``: Identifier for the newly create WRED profile
2996 * ``color_g``: Packet color (green)
2997 * ``min_th_g``: Minimum queue threshold for packet with green color
2998 * ``max_th_g``: Minimum queue threshold for packet with green color
2999 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
3000 * ``wq_log2_g``: Negated log2 of queue weight (wq)
3001 * ``color_y``: Packet color (yellow)
3002 * ``min_th_y``: Minimum queue threshold for packet with yellow color
3003 * ``max_th_y``: Minimum queue threshold for packet with yellow color
3004 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
3005 * ``wq_log2_y``: Negated log2 of queue weight (wq)
3006 * ``color_r``: Packet color (red)
3007 * ``min_th_r``: Minimum queue threshold for packet with yellow color
3008 * ``max_th_r``: Minimum queue threshold for packet with yellow color
3009 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
3010 * ``wq_log2_r``: Negated log2 of queue weight (wq)
3012 Delete port traffic management WRED profile
3013 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3015 Delete the WRED profile::
3017 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
3019 Add port traffic management hierarchy nonleaf node
3020 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3022 Add nonleaf node to port traffic management hierarchy::
3024 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
3025 (priority) (weight) (level_id) (shaper_profile_id) \
3026 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3027 [(shared_shaper_0) (shared_shaper_1) ...] \
3031 * ``parent_node_id``: Node ID of the parent.
3032 * ``priority``: Node priority (highest node priority is zero). This is used by
3033 the SP algorithm running on the parent node for scheduling this node.
3034 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3035 to the weight sum of all siblings that have the same priority. It is used by
3036 the WFQ algorithm running on the parent node for scheduling this node.
3037 * ``level_id``: Hierarchy level of the node.
3038 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3040 * ``n_sp_priorities``: Number of strict priorities.
3041 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3042 * ``n_shared_shapers``: Number of shared shapers.
3043 * ``shared_shaper_id``: Shared shaper id.
3045 Add port traffic management hierarchy nonleaf node with packet mode
3046 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3048 Add nonleaf node with packet mode to port traffic management hierarchy::
3050 testpmd> add port tm nonleaf node pktmode (port_id) (node_id) (parent_node_id) \
3051 (priority) (weight) (level_id) (shaper_profile_id) \
3052 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3053 [(shared_shaper_0) (shared_shaper_1) ...] \
3057 * ``parent_node_id``: Node ID of the parent.
3058 * ``priority``: Node priority (highest node priority is zero). This is used by
3059 the SP algorithm running on the parent node for scheduling this node.
3060 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3061 to the weight sum of all siblings that have the same priority. It is used by
3062 the WFQ algorithm running on the parent node for scheduling this node.
3063 * ``level_id``: Hierarchy level of the node.
3064 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3066 * ``n_sp_priorities``: Number of strict priorities. Packet mode is enabled on
3068 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3069 * ``n_shared_shapers``: Number of shared shapers.
3070 * ``shared_shaper_id``: Shared shaper id.
3072 Add port traffic management hierarchy leaf node
3073 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3075 Add leaf node to port traffic management hierarchy::
3077 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
3078 (priority) (weight) (level_id) (shaper_profile_id) \
3079 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
3080 [(shared_shaper_id) (shared_shaper_id) ...] \
3084 * ``parent_node_id``: Node ID of the parent.
3085 * ``priority``: Node priority (highest node priority is zero). This is used by
3086 the SP algorithm running on the parent node for scheduling this node.
3087 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3088 to the weight sum of all siblings that have the same priority. It is used by
3089 the WFQ algorithm running on the parent node for scheduling this node.
3090 * ``level_id``: Hierarchy level of the node.
3091 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3093 * ``cman_mode``: Congestion management mode to be enabled for this node.
3094 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3095 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3096 * ``n_shared_shapers``: Number of shared shapers.
3097 * ``shared_shaper_id``: Shared shaper id.
3099 Delete port traffic management hierarchy node
3100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3102 Delete node from port traffic management hierarchy::
3104 testpmd> del port tm node (port_id) (node_id)
3106 Update port traffic management hierarchy parent node
3107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3109 Update port traffic management hierarchy parent node::
3111 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3114 This function can only be called after the hierarchy commit invocation. Its
3115 success depends on the port support for this operation, as advertised through
3116 the port capability set. This function is valid for all nodes of the traffic
3117 management hierarchy except root node.
3119 Suspend port traffic management hierarchy node
3120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3122 testpmd> suspend port tm node (port_id) (node_id)
3124 Resume port traffic management hierarchy node
3125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3127 testpmd> resume port tm node (port_id) (node_id)
3129 Commit port traffic management hierarchy
3130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3132 Commit the traffic management hierarchy on the port::
3134 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3138 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3139 call failure. On the other hand, hierarchy is preserved when this parameter
3142 Set port traffic management mark VLAN dei
3143 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3145 Enables/Disables the traffic management marking on the port for VLAN packets::
3147 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3151 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3152 ``yellow`` or ``red`` will have dei bit enabled
3154 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3156 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3158 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3160 Set port traffic management mark IP dscp
3161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3163 Enables/Disables the traffic management marking on the port for IP dscp packets::
3165 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3169 * ``port_id``: The port which on which IP packets marked as ``green`` or
3170 ``yellow`` or ``red`` will have IP dscp bits updated
3172 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3174 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3176 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3178 Set port traffic management mark IP ecn
3179 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3181 Enables/Disables the traffic management marking on the port for IP ecn packets::
3183 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3187 * ``port_id``: The port which on which IP packets marked as ``green`` or
3188 ``yellow`` or ``red`` will have IP ecn bits updated
3190 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3191 to ecn of 2'b11 when IP is caring TCP or SCTP
3193 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3194 to ecn of 2'b11 when IP is caring TCP or SCTP
3196 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3197 to ecn of 2'b11 when IP is caring TCP or SCTP
3202 This section details the available filter functions that are available.
3204 Note these functions interface the deprecated legacy filtering framework,
3205 superseded by *rte_flow*. See `Flow rules management`_.
3207 .. _testpmd_flow_director:
3212 Set flow director's input masks::
3214 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3215 src_mask (ipv4_src) (ipv6_src) (src_port) \
3216 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3218 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3220 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3221 mac (mac_value) tunnel-type (tunnel_type_value) \
3222 tunnel-id (tunnel_id_value)
3224 Example, to set flow director mask on port 0::
3226 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3227 src_mask 255.255.255.255 \
3228 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3229 dst_mask 255.255.255.255 \
3230 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3232 flow_director_flex_payload
3233 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3235 Configure flexible payload selection::
3237 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3239 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3241 testpmd> flow_director_flex_payload 0 l4 \
3242 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3245 .. _testpmd_rte_flow:
3247 Flow rules management
3248 ---------------------
3250 Control of the generic flow API (*rte_flow*) is fully exposed through the
3251 ``flow`` command (validation, creation, destruction, queries and operation
3254 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3255 features simultaneously may cause undefined side-effects and is therefore
3261 Because the ``flow`` command uses dynamic tokens to handle the large number
3262 of possible flow rules combinations, its behavior differs slightly from
3263 other commands, in particular:
3265 - Pressing *?* or the *<tab>* key displays contextual help for the current
3266 token, not that of the entire command.
3268 - Optional and repeated parameters are supported (provided they are listed
3269 in the contextual help).
3271 The first parameter stands for the operation mode. Possible operations and
3272 their general syntax are described below. They are covered in detail in the
3275 - Check whether a flow rule can be created::
3277 flow validate {port_id}
3278 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3279 pattern {item} [/ {item} [...]] / end
3280 actions {action} [/ {action} [...]] / end
3282 - Create a flow rule::
3284 flow create {port_id}
3285 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3286 pattern {item} [/ {item} [...]] / end
3287 actions {action} [/ {action} [...]] / end
3289 - Destroy specific flow rules::
3291 flow destroy {port_id} rule {rule_id} [...]
3293 - Destroy all flow rules::
3295 flow flush {port_id}
3297 - Query an existing flow rule::
3299 flow query {port_id} {rule_id} {action}
3301 - List existing flow rules sorted by priority, filtered by group
3304 flow list {port_id} [group {group_id}] [...]
3306 - Restrict ingress traffic to the defined flow rules::
3308 flow isolate {port_id} {boolean}
3310 - Dump internal representation information of all flows in hardware::
3312 flow dump {port_id} {output_file}
3314 - List and destroy aged flow rules::
3316 flow aged {port_id} [destroy]
3318 - Tunnel offload - create a tunnel stub::
3320 flow tunnel create {port_id} type {tunnel_type}
3322 - Tunnel offload - destroy a tunnel stub::
3324 flow tunnel destroy {port_id} id {tunnel_id}
3326 - Tunnel offload - list port tunnel stubs::
3328 flow tunnel list {port_id}
3330 Creating a tunnel stub for offload
3331 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3333 ``flow tunnel create`` setup a tunnel stub for tunnel offload flow rules::
3335 flow tunnel create {port_id} type {tunnel_type}
3337 If successful, it will return a tunnel stub ID usable with other commands::
3339 port [...]: flow tunnel #[...] type [...]
3341 Tunnel stub ID is relative to a port.
3343 Destroying tunnel offload stub
3344 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3346 ``flow tunnel destroy`` destroy port tunnel stub::
3348 flow tunnel destroy {port_id} id {tunnel_id}
3350 Listing tunnel offload stubs
3351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3353 ``flow tunnel list`` list port tunnel offload stubs::
3355 flow tunnel list {port_id}
3357 Validating flow rules
3358 ~~~~~~~~~~~~~~~~~~~~~
3360 ``flow validate`` reports whether a flow rule would be accepted by the
3361 underlying device in its current state but stops short of creating it. It is
3362 bound to ``rte_flow_validate()``::
3364 flow validate {port_id}
3365 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3366 pattern {item} [/ {item} [...]] / end
3367 actions {action} [/ {action} [...]] / end
3369 If successful, it will show::
3373 Otherwise it will show an error message of the form::
3375 Caught error type [...] ([...]): [...]
3377 This command uses the same parameters as ``flow create``, their format is
3378 described in `Creating flow rules`_.
3380 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3381 index 6 is supported::
3383 testpmd> flow validate 0 ingress pattern eth / end
3384 actions queue index 6 / end
3388 Port 0 does not support TCPv6 rules::
3390 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3392 Caught error type 9 (specific pattern item): Invalid argument
3398 ``flow create`` validates and creates the specified flow rule. It is bound
3399 to ``rte_flow_create()``::
3401 flow create {port_id}
3402 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3403 [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}]
3404 pattern {item} [/ {item} [...]] / end
3405 actions {action} [/ {action} [...]] / end
3407 If successful, it will return a flow rule ID usable with other commands::
3409 Flow rule #[...] created
3411 Otherwise it will show an error message of the form::
3413 Caught error type [...] ([...]): [...]
3415 Parameters describe in the following order:
3417 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3418 - Tunnel offload specification (tunnel_set, tunnel_match)
3419 - A matching pattern, starting with the *pattern* token and terminated by an
3421 - Actions, starting with the *actions* token and terminated by an *end*
3424 These translate directly to *rte_flow* objects provided as-is to the
3425 underlying functions.
3427 The shortest valid definition only comprises mandatory tokens::
3429 testpmd> flow create 0 pattern end actions end
3431 Note that PMDs may refuse rules that essentially do nothing such as this
3434 **All unspecified object values are automatically initialized to 0.**
3439 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3440 specified before the ``pattern`` token.
3442 - ``group {group id}``: priority group.
3443 - ``priority {level}``: priority level within group.
3444 - ``ingress``: rule applies to ingress traffic.
3445 - ``egress``: rule applies to egress traffic.
3446 - ``transfer``: apply rule directly to endpoints found in pattern.
3448 Each instance of an attribute specified several times overrides the previous
3449 value as shown below (group 4 is used)::
3451 testpmd> flow create 0 group 42 group 24 group 4 [...]
3453 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3455 While not specifying a direction is an error, some rules may allow both
3458 Most rules affect RX therefore contain the ``ingress`` token::
3460 testpmd> flow create 0 ingress pattern [...]
3465 Indicate tunnel offload rule type
3467 - ``tunnel_set {tunnel_id}``: mark rule as tunnel offload decap_set type.
3468 - ``tunnel_match {tunnel_id}``: mark rule as tunel offload match type.
3473 A matching pattern starts after the ``pattern`` token. It is made of pattern
3474 items and is terminated by a mandatory ``end`` item.
3476 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3477 rte_flow_item_type``).
3479 The ``/`` token is used as a separator between pattern items as shown
3482 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3484 Note that protocol items like these must be stacked from lowest to highest
3485 layer to make sense. For instance, the following rule is either invalid or
3486 unlikely to match any packet::
3488 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3490 More information on these restrictions can be found in the *rte_flow*
3493 Several items support additional specification structures, for example
3494 ``ipv4`` allows specifying source and destination addresses as follows::
3496 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3497 dst is 10.2.0.0 / end [...]
3499 This rule matches all IPv4 traffic with the specified properties.
3501 In this example, ``src`` and ``dst`` are field names of the underlying
3502 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3503 in a similar fashion.
3505 The ``is`` token means that the subsequent value must be matched exactly,
3506 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3507 accordingly. Possible assignment tokens are:
3509 - ``is``: match value perfectly (with full bit-mask).
3510 - ``spec``: match value according to configured bit-mask.
3511 - ``last``: specify upper bound to establish a range.
3512 - ``mask``: specify bit-mask with relevant bits set to one.
3513 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3515 These yield identical results::
3517 ipv4 src is 10.1.1.1
3521 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3525 ipv4 src spec 10.1.1.1 src prefix 32
3529 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3533 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3535 Inclusive ranges can be defined with ``last``::
3537 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3539 Note that ``mask`` affects both ``spec`` and ``last``::
3541 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3542 # matches 10.1.0.0 to 10.2.255.255
3544 Properties can be modified multiple times::
3546 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3550 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3555 This section lists supported pattern items and their attributes, if any.
3557 - ``end``: end list of pattern items.
3559 - ``void``: no-op pattern item.
3561 - ``invert``: perform actions when pattern does not match.
3563 - ``any``: match any protocol for the current layer.
3565 - ``num {unsigned}``: number of layers covered.
3567 - ``pf``: match traffic from/to the physical function.
3569 - ``vf``: match traffic from/to a virtual function ID.
3571 - ``id {unsigned}``: VF ID.
3573 - ``phy_port``: match traffic from/to a specific physical port.
3575 - ``index {unsigned}``: physical port index.
3577 - ``port_id``: match traffic from/to a given DPDK port ID.
3579 - ``id {unsigned}``: DPDK port ID.
3581 - ``mark``: match value set in previously matched flow rule using the mark action.
3583 - ``id {unsigned}``: arbitrary integer value.
3585 - ``raw``: match an arbitrary byte string.
3587 - ``relative {boolean}``: look for pattern after the previous item.
3588 - ``search {boolean}``: search pattern from offset (see also limit).
3589 - ``offset {integer}``: absolute or relative offset for pattern.
3590 - ``limit {unsigned}``: search area limit for start of pattern.
3591 - ``pattern {string}``: byte string to look for.
3593 - ``eth``: match Ethernet header.
3595 - ``dst {MAC-48}``: destination MAC.
3596 - ``src {MAC-48}``: source MAC.
3597 - ``type {unsigned}``: EtherType or TPID.
3599 - ``vlan``: match 802.1Q/ad VLAN tag.
3601 - ``tci {unsigned}``: tag control information.
3602 - ``pcp {unsigned}``: priority code point.
3603 - ``dei {unsigned}``: drop eligible indicator.
3604 - ``vid {unsigned}``: VLAN identifier.
3605 - ``inner_type {unsigned}``: inner EtherType or TPID.
3607 - ``ipv4``: match IPv4 header.
3609 - ``tos {unsigned}``: type of service.
3610 - ``ttl {unsigned}``: time to live.
3611 - ``proto {unsigned}``: next protocol ID.
3612 - ``src {ipv4 address}``: source address.
3613 - ``dst {ipv4 address}``: destination address.
3615 - ``ipv6``: match IPv6 header.
3617 - ``tc {unsigned}``: traffic class.
3618 - ``flow {unsigned}``: flow label.
3619 - ``proto {unsigned}``: protocol (next header).
3620 - ``hop {unsigned}``: hop limit.
3621 - ``src {ipv6 address}``: source address.
3622 - ``dst {ipv6 address}``: destination address.
3624 - ``icmp``: match ICMP header.
3626 - ``type {unsigned}``: ICMP packet type.
3627 - ``code {unsigned}``: ICMP packet code.
3629 - ``udp``: match UDP header.
3631 - ``src {unsigned}``: UDP source port.
3632 - ``dst {unsigned}``: UDP destination port.
3634 - ``tcp``: match TCP header.
3636 - ``src {unsigned}``: TCP source port.
3637 - ``dst {unsigned}``: TCP destination port.
3639 - ``sctp``: match SCTP header.
3641 - ``src {unsigned}``: SCTP source port.
3642 - ``dst {unsigned}``: SCTP destination port.
3643 - ``tag {unsigned}``: validation tag.
3644 - ``cksum {unsigned}``: checksum.
3646 - ``vxlan``: match VXLAN header.
3648 - ``vni {unsigned}``: VXLAN identifier.
3650 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3652 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3654 - ``nvgre``: match NVGRE header.
3656 - ``tni {unsigned}``: virtual subnet ID.
3658 - ``mpls``: match MPLS header.
3660 - ``label {unsigned}``: MPLS label.
3662 - ``gre``: match GRE header.
3664 - ``protocol {unsigned}``: protocol type.
3666 - ``gre_key``: match GRE optional key field.
3668 - ``value {unsigned}``: key value.
3670 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3672 - ``thresh {unsigned}``: accuracy threshold.
3674 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3676 - ``teid {unsigned}``: tunnel endpoint identifier.
3678 - ``geneve``: match GENEVE header.
3680 - ``vni {unsigned}``: virtual network identifier.
3681 - ``protocol {unsigned}``: protocol type.
3683 - ``geneve-opt``: match GENEVE header option.
3685 - ``class {unsigned}``: GENEVE option class.
3686 - ``type {unsigned}``: GENEVE option type.
3687 - ``length {unsigned}``: GENEVE option length in 32-bit words.
3688 - ``data {hex string}``: GENEVE option data, the length is defined by
3691 - ``vxlan-gpe``: match VXLAN-GPE header.
3693 - ``vni {unsigned}``: VXLAN-GPE identifier.
3695 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3697 - ``sha {MAC-48}``: sender hardware address.
3698 - ``spa {ipv4 address}``: sender IPv4 address.
3699 - ``tha {MAC-48}``: target hardware address.
3700 - ``tpa {ipv4 address}``: target IPv4 address.
3702 - ``ipv6_ext``: match presence of any IPv6 extension header.
3704 - ``next_hdr {unsigned}``: next header.
3706 - ``icmp6``: match any ICMPv6 header.
3708 - ``type {unsigned}``: ICMPv6 type.
3709 - ``code {unsigned}``: ICMPv6 code.
3711 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3713 - ``target_addr {ipv6 address}``: target address.
3715 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3717 - ``target_addr {ipv6 address}``: target address.
3719 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3721 - ``type {unsigned}``: ND option type.
3723 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3724 link-layer address option.
3726 - ``sla {MAC-48}``: source Ethernet LLA.
3728 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3729 link-layer address option.
3731 - ``tla {MAC-48}``: target Ethernet LLA.
3733 - ``meta``: match application specific metadata.
3735 - ``data {unsigned}``: metadata value.
3737 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3739 - ``pdu_type {unsigned}``: PDU type.
3740 - ``qfi {unsigned}``: QoS flow identifier.
3742 - ``pppoes``, ``pppoed``: match PPPoE header.
3744 - ``session_id {unsigned}``: session identifier.
3746 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3748 - ``proto_id {unsigned}``: PPP protocol identifier.
3750 - ``l2tpv3oip``: match L2TPv3 over IP header.
3752 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
3754 - ``ah``: match AH header.
3756 - ``spi {unsigned}``: security parameters index.
3758 - ``pfcp``: match PFCP header.
3760 - ``s_field {unsigned}``: S field.
3761 - ``seid {unsigned}``: session endpoint identifier.
3766 A list of actions starts after the ``actions`` token in the same fashion as
3767 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3768 terminated by a mandatory ``end`` action.
3770 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3771 rte_flow_action_type``).
3773 Dropping all incoming UDPv4 packets can be expressed as follows::
3775 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3778 Several actions have configurable properties which must be specified when
3779 there is no valid default value. For example, ``queue`` requires a target
3782 This rule redirects incoming UDPv4 traffic to queue index 6::
3784 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3785 actions queue index 6 / end
3787 While this one could be rejected by PMDs (unspecified queue index)::
3789 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3792 As defined by *rte_flow*, the list is not ordered, all actions of a given
3793 rule are performed simultaneously. These are equivalent::
3795 queue index 6 / void / mark id 42 / end
3799 void / mark id 42 / queue index 6 / end
3801 All actions in a list should have different types, otherwise only the last
3802 action of a given type is taken into account::
3804 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
3808 drop / drop / drop / end # drop is performed only once
3812 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
3814 Considering they are performed simultaneously, opposite and overlapping
3815 actions can sometimes be combined when the end result is unambiguous::
3817 drop / queue index 6 / end # drop has no effect
3821 queue index 6 / rss queues 6 7 8 / end # queue has no effect
3825 drop / passthru / end # drop has no effect
3827 Note that PMDs may still refuse such combinations.
3832 This section lists supported actions and their attributes, if any.
3834 - ``end``: end list of actions.
3836 - ``void``: no-op action.
3838 - ``passthru``: let subsequent rule process matched packets.
3840 - ``jump``: redirect traffic to group on device.
3842 - ``group {unsigned}``: group to redirect to.
3844 - ``mark``: attach 32 bit value to packets.
3846 - ``id {unsigned}``: 32 bit value to return with packets.
3848 - ``flag``: flag packets.
3850 - ``queue``: assign packets to a given queue index.
3852 - ``index {unsigned}``: queue index to use.
3854 - ``drop``: drop packets (note: passthru has priority).
3856 - ``count``: enable counters for this rule.
3858 - ``rss``: spread packets among several queues.
3860 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
3861 ``toeplitz``, ``simple_xor``, ``symmetric_toeplitz`` and ``default``.
3863 - ``level {unsigned}``: encapsulation level for ``types``.
3865 - ``types [{RSS hash type} [...]] end``: specific RSS hash types.
3866 Note that an empty list does not disable RSS but instead requests
3867 unspecified "best-effort" settings.
3869 - ``key {string}``: RSS hash key, overrides ``key_len``.
3871 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
3872 conjunction with ``key`` to pad or truncate it.
3874 - ``queues [{unsigned} [...]] end``: queue indices to use.
3876 - ``pf``: direct traffic to physical function.
3878 - ``vf``: direct traffic to a virtual function ID.
3880 - ``original {boolean}``: use original VF ID if possible.
3881 - ``id {unsigned}``: VF ID.
3883 - ``phy_port``: direct packets to physical port index.
3885 - ``original {boolean}``: use original port index if possible.
3886 - ``index {unsigned}``: physical port index.
3888 - ``port_id``: direct matching traffic to a given DPDK port ID.
3890 - ``original {boolean}``: use original DPDK port ID if possible.
3891 - ``id {unsigned}``: DPDK port ID.
3893 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
3895 - ``mpls_ttl``: MPLS TTL.
3897 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
3899 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
3901 - ``nw_ttl``: IP TTL.
3903 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
3905 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
3907 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
3909 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
3911 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
3913 - ``ethertype``: Ethertype.
3915 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
3917 - ``vlan_vid``: VLAN id.
3919 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
3921 - ``vlan_pcp``: VLAN priority.
3923 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
3925 - ``ethertype``: Ethertype.
3927 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
3929 - ``ethertype``: Ethertype.
3931 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
3932 is done through `Config VXLAN Encap outer layers`_.
3934 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
3935 the VXLAN tunnel network overlay from the matched flow.
3937 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
3938 is done through `Config NVGRE Encap outer layers`_.
3940 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
3941 the NVGRE tunnel network overlay from the matched flow.
3943 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
3944 is done through `Config L2 Encap`_.
3946 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
3947 is done through `Config L2 Decap`_.
3949 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
3950 configuration is done through `Config MPLSoGRE Encap outer layers`_.
3952 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
3953 configuration is done through `Config MPLSoGRE Decap outer layers`_.
3955 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
3956 configuration is done through `Config MPLSoUDP Encap outer layers`_.
3958 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
3959 configuration is done through `Config MPLSoUDP Decap outer layers`_.
3961 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
3963 - ``ipv4_addr``: New IPv4 source address.
3965 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
3968 - ``ipv4_addr``: New IPv4 destination address.
3970 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
3972 - ``ipv6_addr``: New IPv6 source address.
3974 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
3977 - ``ipv6_addr``: New IPv6 destination address.
3979 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
3982 - ``port``: New TCP/UDP source port number.
3984 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
3987 - ``port``: New TCP/UDP destination port number.
3989 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
3992 - ``dec_ttl``: Performs a decrease TTL value action
3994 - ``set_ttl``: Set TTL value with specified value
3995 - ``ttl_value {unsigned}``: The new TTL value to be set
3997 - ``set_mac_src``: set source MAC address
3999 - ``mac_addr {MAC-48}``: new source MAC address
4001 - ``set_mac_dst``: set destination MAC address
4003 - ``mac_addr {MAC-48}``: new destination MAC address
4005 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4007 - ``value {unsigned}``: Value to increase TCP sequence number by.
4009 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4011 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4013 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4015 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4017 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4019 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4021 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4023 - ``dscp_value {unsigned}``: The new DSCP value to be set
4025 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4027 - ``dscp_value {unsigned}``: The new DSCP value to be set
4029 - ``shared``: Use shared action created via
4030 ``flow shared_action {port_id} create``
4032 - ``shared_action_id {unsigned}``: Shared action ID to use
4034 Destroying flow rules
4035 ~~~~~~~~~~~~~~~~~~~~~
4037 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4038 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4039 times as necessary::
4041 flow destroy {port_id} rule {rule_id} [...]
4043 If successful, it will show::
4045 Flow rule #[...] destroyed
4047 It does not report anything for rule IDs that do not exist. The usual error
4048 message is shown when a rule cannot be destroyed::
4050 Caught error type [...] ([...]): [...]
4052 ``flow flush`` destroys all rules on a device and does not take extra
4053 arguments. It is bound to ``rte_flow_flush()``::
4055 flow flush {port_id}
4057 Any errors are reported as above.
4059 Creating several rules and destroying them::
4061 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4062 actions queue index 2 / end
4063 Flow rule #0 created
4064 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4065 actions queue index 3 / end
4066 Flow rule #1 created
4067 testpmd> flow destroy 0 rule 0 rule 1
4068 Flow rule #1 destroyed
4069 Flow rule #0 destroyed
4072 The same result can be achieved using ``flow flush``::
4074 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4075 actions queue index 2 / end
4076 Flow rule #0 created
4077 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4078 actions queue index 3 / end
4079 Flow rule #1 created
4080 testpmd> flow flush 0
4083 Non-existent rule IDs are ignored::
4085 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4086 actions queue index 2 / end
4087 Flow rule #0 created
4088 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4089 actions queue index 3 / end
4090 Flow rule #1 created
4091 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4093 testpmd> flow destroy 0 rule 0
4094 Flow rule #0 destroyed
4100 ``flow query`` queries a specific action of a flow rule having that
4101 ability. Such actions collect information that can be reported using this
4102 command. It is bound to ``rte_flow_query()``::
4104 flow query {port_id} {rule_id} {action}
4106 If successful, it will display either the retrieved data for known actions
4107 or the following message::
4109 Cannot display result for action type [...] ([...])
4111 Otherwise, it will complain either that the rule does not exist or that some
4114 Flow rule #[...] not found
4118 Caught error type [...] ([...]): [...]
4120 Currently only the ``count`` action is supported. This action reports the
4121 number of packets that hit the flow rule and the total number of bytes. Its
4122 output has the following format::
4125 hits_set: [...] # whether "hits" contains a valid value
4126 bytes_set: [...] # whether "bytes" contains a valid value
4127 hits: [...] # number of packets
4128 bytes: [...] # number of bytes
4130 Querying counters for TCPv6 packets redirected to queue 6::
4132 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4133 actions queue index 6 / count / end
4134 Flow rule #4 created
4135 testpmd> flow query 0 4 count
4146 ``flow list`` lists existing flow rules sorted by priority and optionally
4147 filtered by group identifiers::
4149 flow list {port_id} [group {group_id}] [...]
4151 This command only fails with the following message if the device does not
4156 Output consists of a header line followed by a short description of each
4157 flow rule, one per line. There is no output at all when no flow rules are
4158 configured on the device::
4160 ID Group Prio Attr Rule
4161 [...] [...] [...] [...] [...]
4163 ``Attr`` column flags:
4165 - ``i`` for ``ingress``.
4166 - ``e`` for ``egress``.
4168 Creating several flow rules and listing them::
4170 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4171 actions queue index 6 / end
4172 Flow rule #0 created
4173 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4174 actions queue index 2 / end
4175 Flow rule #1 created
4176 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4177 actions rss queues 6 7 8 end / end
4178 Flow rule #2 created
4179 testpmd> flow list 0
4180 ID Group Prio Attr Rule
4181 0 0 0 i- ETH IPV4 => QUEUE
4182 1 0 0 i- ETH IPV6 => QUEUE
4183 2 0 5 i- ETH IPV4 UDP => RSS
4186 Rules are sorted by priority (i.e. group ID first, then priority level)::
4188 testpmd> flow list 1
4189 ID Group Prio Attr Rule
4190 0 0 0 i- ETH => COUNT
4191 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4192 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4193 1 24 0 i- ETH IPV4 UDP => QUEUE
4194 4 24 10 i- ETH IPV4 TCP => DROP
4195 3 24 20 i- ETH IPV4 => DROP
4196 2 24 42 i- ETH IPV4 UDP => QUEUE
4197 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4200 Output can be limited to specific groups::
4202 testpmd> flow list 1 group 0 group 63
4203 ID Group Prio Attr Rule
4204 0 0 0 i- ETH => COUNT
4205 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4206 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4207 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4210 Toggling isolated mode
4211 ~~~~~~~~~~~~~~~~~~~~~~
4213 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4214 must only be injected from the defined flow rules; that no default traffic
4215 is expected outside those rules and the driver is free to assign more
4216 resources to handle them. It is bound to ``rte_flow_isolate()``::
4218 flow isolate {port_id} {boolean}
4220 If successful, enabling or disabling isolated mode shows either::
4222 Ingress traffic on port [...]
4223 is now restricted to the defined flow rules
4227 Ingress traffic on port [...]
4228 is not restricted anymore to the defined flow rules
4230 Otherwise, in case of error::
4232 Caught error type [...] ([...]): [...]
4234 Mainly due to its side effects, PMDs supporting this mode may not have the
4235 ability to toggle it more than once without reinitializing affected ports
4236 first (e.g. by exiting testpmd).
4238 Enabling isolated mode::
4240 testpmd> flow isolate 0 true
4241 Ingress traffic on port 0 is now restricted to the defined flow rules
4244 Disabling isolated mode::
4246 testpmd> flow isolate 0 false
4247 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4250 Dumping HW internal information
4251 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4253 ``flow dump`` dumps the hardware's internal representation information of
4254 all flows. It is bound to ``rte_flow_dev_dump()``::
4256 flow dump {port_id} {output_file}
4258 If successful, it will show::
4262 Otherwise, it will complain error occurred::
4264 Caught error type [...] ([...]): [...]
4266 Listing and destroying aged flow rules
4267 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4269 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4270 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4272 flow aged {port_id} [destroy]
4274 Listing current aged flow rules::
4276 testpmd> flow aged 0
4277 Port 0 total aged flows: 0
4278 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4279 actions age timeout 5 / queue index 0 / end
4280 Flow rule #0 created
4281 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4282 actions age timeout 4 / queue index 0 / end
4283 Flow rule #1 created
4284 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4285 actions age timeout 2 / queue index 0 / end
4286 Flow rule #2 created
4287 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4288 actions age timeout 3 / queue index 0 / end
4289 Flow rule #3 created
4292 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4293 information, all the aged flows are sorted by the longest timeout time. For example, if
4294 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4295 will be ID 3, ID 1, ID 0::
4297 testpmd> flow aged 0
4298 Port 0 total aged flows: 4
4305 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4307 testpmd> flow aged 0 destroy
4308 Port 0 total aged flows: 4
4315 Flow rule #2 destroyed
4316 Flow rule #3 destroyed
4317 Flow rule #1 destroyed
4318 Flow rule #0 destroyed
4319 4 flows be destroyed
4320 testpmd> flow aged 0
4321 Port 0 total aged flows: 0
4323 Creating shared actions
4324 ~~~~~~~~~~~~~~~~~~~~~~~
4325 ``flow shared_action {port_id} create`` creates shared action with optional
4326 shared action ID. It is bound to ``rte_flow_shared_action_create()``::
4328 flow shared_action {port_id} create [action_id {shared_action_id}]
4329 [ingress] [egress] [transfer] action {action} / end
4331 If successful, it will show::
4333 Shared action #[...] created
4335 Otherwise, it will complain either that shared action already exists or that
4336 some error occurred::
4338 Shared action #[...] is already assigned, delete it first
4342 Caught error type [...] ([...]): [...]
4344 Create shared rss action with id 100 to queues 1 and 2 on port 0::
4346 testpmd> flow shared_action 0 create action_id 100 \
4347 ingress action rss queues 1 2 end / end
4349 Create shared rss action with id assigned by testpmd to queues 1 and 2 on
4352 testpmd> flow shared_action 0 create action_id \
4353 ingress action rss queues 0 1 end / end
4355 Updating shared actions
4356 ~~~~~~~~~~~~~~~~~~~~~~~
4357 ``flow shared_action {port_id} update`` updates configuration of the shared
4358 action from its shared action ID (as returned by
4359 ``flow shared_action {port_id} create``). It is bound to
4360 ``rte_flow_shared_action_update()``::
4362 flow shared_action {port_id} update {shared_action_id}
4363 action {action} / end
4365 If successful, it will show::
4367 Shared action #[...] updated
4369 Otherwise, it will complain either that shared action not found or that some
4372 Failed to find shared action #[...] on port [...]
4376 Caught error type [...] ([...]): [...]
4378 Update shared rss action having id 100 on port 0 with rss to queues 0 and 3
4379 (in create example above rss queues were 1 and 2)::
4381 testpmd> flow shared_action 0 update 100 action rss queues 0 3 end / end
4383 Destroying shared actions
4384 ~~~~~~~~~~~~~~~~~~~~~~~~~
4385 ``flow shared_action {port_id} update`` destroys one or more shared actions
4386 from their shared action IDs (as returned by
4387 ``flow shared_action {port_id} create``). It is bound to
4388 ``rte_flow_shared_action_destroy()``::
4390 flow shared_action {port_id} destroy action_id {shared_action_id} [...]
4392 If successful, it will show::
4394 Shared action #[...] destroyed
4396 It does not report anything for shared action IDs that do not exist.
4397 The usual error message is shown when a shared action cannot be destroyed::
4399 Caught error type [...] ([...]): [...]
4401 Destroy shared actions having id 100 & 101::
4403 testpmd> flow shared_action 0 destroy action_id 100 action_id 101
4405 Query shared actions
4406 ~~~~~~~~~~~~~~~~~~~~
4407 ``flow shared_action {port_id} query`` queries the shared action from its
4408 shared action ID (as returned by ``flow shared_action {port_id} create``).
4409 It is bound to ``rte_flow_shared_action_query()``::
4411 flow shared_action {port_id} query {shared_action_id}
4413 Currently only rss shared action supported. If successful, it will show::
4418 Otherwise, it will complain either that shared action not found or that some
4421 Failed to find shared action #[...] on port [...]
4425 Caught error type [...] ([...]): [...]
4427 Query shared action having id 100::
4429 testpmd> flow shared_action 0 query 100
4431 Sample QinQ flow rules
4432 ~~~~~~~~~~~~~~~~~~~~~~
4434 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4436 testpmd> port stop 0
4437 testpmd> vlan set qinq_strip on 0
4439 The above command sets the inner and outer TPID's to 0x8100.
4441 To change the TPID's the following commands should be used::
4443 testpmd> vlan set outer tpid 0xa100 0
4444 testpmd> vlan set inner tpid 0x9100 0
4445 testpmd> port start 0
4447 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4451 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4452 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4453 Flow rule #0 validated
4455 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4456 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4457 Flow rule #0 created
4459 testpmd> flow list 0
4460 ID Group Prio Attr Rule
4461 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4463 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4467 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4468 vlan tci is 654 / end actions pf / queue index 0 / end
4469 Flow rule #1 validated
4471 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4472 vlan tci is 654 / end actions pf / queue index 1 / end
4473 Flow rule #1 created
4475 testpmd> flow list 0
4476 ID Group Prio Attr Rule
4477 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4478 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4480 Sample VXLAN flow rules
4481 ~~~~~~~~~~~~~~~~~~~~~~~
4483 Before creating VXLAN rule(s), the UDP port should be added for VXLAN packet
4486 testpmd> rx_vxlan_port add 4789 0
4488 Create VXLAN rules on port 0 to steer traffic to PF queues.
4492 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
4493 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 1 / end
4494 Flow rule #0 created
4496 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 3 /
4497 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 2 / end
4498 Flow rule #1 created
4500 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
4501 eth dst is 00:11:22:33:44:55 / vlan tci is 10 / end actions pf /
4503 Flow rule #2 created
4505 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 5 /
4506 eth dst is 00:11:22:33:44:55 / vlan tci is 20 / end actions pf /
4508 Flow rule #3 created
4510 testpmd> flow create 0 ingress pattern eth dst is 00:00:00:00:01:00 / ipv4 /
4511 udp / vxlan vni is 6 / eth dst is 00:11:22:33:44:55 / end actions pf /
4513 Flow rule #4 created
4515 testpmd> flow list 0
4516 ID Group Prio Attr Rule
4517 0 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4518 1 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4519 2 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
4520 3 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
4521 4 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4523 Sample VXLAN encapsulation rule
4524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4526 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4527 source code, those can be changed by using the following commands
4529 IPv4 VXLAN outer header::
4531 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4532 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4533 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4536 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4537 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4538 eth-dst 22:22:22:22:22:22
4539 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4542 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4543 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4544 eth-dst 22:22:22:22:22:22
4545 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4548 IPv6 VXLAN outer header::
4550 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4551 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4552 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4555 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4556 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4557 eth-dst 22:22:22:22:22:22
4558 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4561 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4562 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4563 eth-dst 22:22:22:22:22:22
4564 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4567 Sample NVGRE encapsulation rule
4568 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4570 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4571 source code, those can be changed by using the following commands
4573 IPv4 NVGRE outer header::
4575 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4576 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4577 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4580 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4581 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4582 eth-dst 22:22:22:22:22:22
4583 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4586 IPv6 NVGRE outer header::
4588 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4589 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4590 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4593 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4594 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4595 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4598 Sample L2 encapsulation rule
4599 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4601 L2 encapsulation has default value pre-configured in testpmd
4602 source code, those can be changed by using the following commands
4606 testpmd> set l2_encap ip-version ipv4
4607 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4608 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4609 mplsoudp_decap / l2_encap / end
4611 L2 with VXLAN header::
4613 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4614 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4615 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4616 mplsoudp_decap / l2_encap / end
4618 Sample L2 decapsulation rule
4619 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4621 L2 decapsulation has default value pre-configured in testpmd
4622 source code, those can be changed by using the following commands
4626 testpmd> set l2_decap
4627 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4630 L2 with VXLAN header::
4632 testpmd> set l2_encap-with-vlan
4633 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4636 Sample MPLSoGRE encapsulation rule
4637 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4639 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4640 source code, those can be changed by using the following commands
4642 IPv4 MPLSoGRE outer header::
4644 testpmd> set mplsogre_encap ip-version ipv4 label 4
4645 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4646 eth-dst 22:22:22:22:22:22
4647 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4648 mplsogre_encap / end
4650 IPv4 MPLSoGRE with VLAN outer header::
4652 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4653 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4654 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4655 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4656 mplsogre_encap / end
4658 IPv6 MPLSoGRE outer header::
4660 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4661 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4662 eth-dst 22:22:22:22:22:22
4663 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4664 mplsogre_encap / end
4666 IPv6 MPLSoGRE with VLAN outer header::
4668 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4669 ip-src ::1 ip-dst ::2222 vlan-tci 34
4670 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4671 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4672 mplsogre_encap / end
4674 Sample MPLSoGRE decapsulation rule
4675 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4677 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4678 source code, those can be changed by using the following commands
4680 IPv4 MPLSoGRE outer header::
4682 testpmd> set mplsogre_decap ip-version ipv4
4683 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4684 mplsogre_decap / l2_encap / end
4686 IPv4 MPLSoGRE with VLAN outer header::
4688 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4689 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4690 actions mplsogre_decap / l2_encap / end
4692 IPv6 MPLSoGRE outer header::
4694 testpmd> set mplsogre_decap ip-version ipv6
4695 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4696 actions mplsogre_decap / l2_encap / end
4698 IPv6 MPLSoGRE with VLAN outer header::
4700 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4701 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4702 actions mplsogre_decap / l2_encap / end
4704 Sample MPLSoUDP encapsulation rule
4705 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4707 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4708 source code, those can be changed by using the following commands
4710 IPv4 MPLSoUDP outer header::
4712 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4713 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4714 eth-dst 22:22:22:22:22:22
4715 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4716 mplsoudp_encap / end
4718 IPv4 MPLSoUDP with VLAN outer header::
4720 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4721 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4722 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4723 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4724 mplsoudp_encap / end
4726 IPv6 MPLSoUDP outer header::
4728 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4729 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4730 eth-dst 22:22:22:22:22:22
4731 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4732 mplsoudp_encap / end
4734 IPv6 MPLSoUDP with VLAN outer header::
4736 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4737 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4738 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4739 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4740 mplsoudp_encap / end
4742 Sample MPLSoUDP decapsulation rule
4743 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4745 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4746 source code, those can be changed by using the following commands
4748 IPv4 MPLSoUDP outer header::
4750 testpmd> set mplsoudp_decap ip-version ipv4
4751 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4752 mplsoudp_decap / l2_encap / end
4754 IPv4 MPLSoUDP with VLAN outer header::
4756 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4757 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4758 actions mplsoudp_decap / l2_encap / end
4760 IPv6 MPLSoUDP outer header::
4762 testpmd> set mplsoudp_decap ip-version ipv6
4763 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4764 actions mplsoudp_decap / l2_encap / end
4766 IPv6 MPLSoUDP with VLAN outer header::
4768 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4769 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4770 actions mplsoudp_decap / l2_encap / end
4772 Sample Raw encapsulation rule
4773 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4775 Raw encapsulation configuration can be set by the following commands
4777 Eecapsulating VxLAN::
4779 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4780 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4782 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4783 raw_encap index 4 / end
4785 Sample Raw decapsulation rule
4786 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4788 Raw decapsulation configuration can be set by the following commands
4790 Decapsulating VxLAN::
4792 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4793 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4794 end actions raw_decap / queue index 0 / end
4799 ESP rules can be created by the following commands::
4801 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
4803 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
4804 actions queue index 3 / end
4805 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
4807 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
4808 actions queue index 3 / end
4813 AH rules can be created by the following commands::
4815 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
4817 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
4818 actions queue index 3 / end
4819 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
4821 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
4822 actions queue index 3 / end
4827 PFCP rules can be created by the following commands(s_field need to be 1
4830 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
4831 actions queue index 3 / end
4832 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
4833 seid is 1 / end actions queue index 3 / end
4834 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
4835 actions queue index 3 / end
4836 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
4837 seid is 1 / end actions queue index 3 / end
4842 The following sections show functions to load/unload eBPF based filters.
4847 Load an eBPF program as a callback for particular RX/TX queue::
4849 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4851 The available load-flags are:
4853 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4855 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4861 You'll need clang v3.7 or above to build bpf program you'd like to load
4865 .. code-block:: console
4868 clang -O2 -target bpf -c t1.c
4870 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4872 .. code-block:: console
4874 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4876 To load (not JITed) t1.o at TX queue 0, port 0:
4878 .. code-block:: console
4880 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4885 Unload previously loaded eBPF program for particular RX/TX queue::
4887 testpmd> bpf-unload rx|tx (portid) (queueid)
4889 For example to unload BPF filter from TX queue 0, port 0:
4891 .. code-block:: console
4893 testpmd> bpf-unload tx 0 0