1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2010-2016 Intel Corporation.
6 Testpmd Runtime Functions
7 =========================
9 Where the testpmd application is started in interactive mode, (``-i|--interactive``),
10 it displays a prompt that can be used to start and stop forwarding,
11 configure the application, display statistics (including the extended NIC
12 statistics aka xstats) , set the Flow Director and other tasks::
16 The testpmd prompt has some, limited, readline support.
17 Common bash command-line functions such as ``Ctrl+a`` and ``Ctrl+e`` to go to the start and end of the prompt line are supported
18 as well as access to the command history via the up-arrow.
20 There is also support for tab completion.
21 If you type a partial command and hit ``<TAB>`` you get a list of the available completions:
23 .. code-block:: console
25 testpmd> show port <TAB>
27 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X
28 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all
29 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X
30 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all
36 Some examples in this document are too long to fit on one line are shown wrapped at `"\\"` for display purposes::
38 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
39 (pause_time) (send_xon) (port_id)
41 In the real ``testpmd>`` prompt these commands should be on a single line.
46 The testpmd has on-line help for the functions that are available at runtime.
47 These are divided into sections and can be accessed using help, help section or help all:
49 .. code-block:: console
53 help control : Start and stop forwarding.
54 help display : Displaying port, stats and config information.
55 help config : Configuration information.
56 help ports : Configuring ports.
57 help registers : Reading and setting port registers.
58 help filters : Filters configuration help.
59 help all : All of the above sections.
62 Command File Functions
63 ----------------------
65 To facilitate loading large number of commands or to avoid cutting and pasting where not
66 practical or possible testpmd supports alternative methods for executing commands.
68 * If started with the ``--cmdline-file=FILENAME`` command line argument testpmd
69 will execute all CLI commands contained within the file immediately before
70 starting packet forwarding or entering interactive mode.
72 .. code-block:: console
74 ./testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
75 Interactive-mode selected
76 CLI commands to be read from /home/ubuntu/flow-create-commands.txt
77 Configuring Port 0 (socket 0)
78 Port 0: 7C:FE:90:CB:74:CE
79 Configuring Port 1 (socket 0)
80 Port 1: 7C:FE:90:CB:74:CA
81 Checking link statuses...
82 Port 0 Link Up - speed 10000 Mbps - full-duplex
83 Port 1 Link Up - speed 10000 Mbps - full-duplex
89 Flow rule #498 created
90 Flow rule #499 created
91 Read all CLI commands from /home/ubuntu/flow-create-commands.txt
95 * At run-time additional commands can be loaded in bulk by invoking the ``load FILENAME``
98 .. code-block:: console
100 testpmd> load /home/ubuntu/flow-create-commands.txt
105 Flow rule #498 created
106 Flow rule #499 created
107 Read all CLI commands from /home/ubuntu/flow-create-commands.txt
111 In all cases output from any included command will be displayed as standard output.
112 Execution will continue until the end of the file is reached regardless of
113 whether any errors occur. The end user must examine the output to determine if
114 any failures occurred.
123 Start packet forwarding with current configuration::
130 Start packet forwarding with current configuration after sending specified number of bursts of packets::
132 testpmd> start tx_first (""|burst_num)
134 The default burst number is 1 when ``burst_num`` not presented.
139 Stop packet forwarding, and display accumulated statistics::
154 The functions in the following sections are used to display information about the
155 testpmd configuration or the NIC status.
160 Display information for a given port or all ports::
162 testpmd> show port (info|summary|stats|xstats|fdir|stat_qmap|dcb_tc|cap) (port_id|all)
164 The available information categories are:
166 * ``info``: General port information such as MAC address.
168 * ``summary``: Brief port summary such as Device Name, Driver Name etc.
170 * ``stats``: RX/TX statistics.
172 * ``xstats``: RX/TX extended NIC statistics.
174 * ``fdir``: Flow Director information and statistics.
176 * ``stat_qmap``: Queue statistics mapping.
178 * ``dcb_tc``: DCB information such as TC mapping.
180 * ``cap``: Supported offload capabilities.
184 .. code-block:: console
186 testpmd> show port info 0
188 ********************* Infos for port 0 *********************
190 MAC address: XX:XX:XX:XX:XX:XX
192 memory allocation on the socket: 0
194 Link speed: 40000 Mbps
195 Link duplex: full-duplex
196 Promiscuous mode: enabled
197 Allmulticast mode: disabled
198 Maximum number of MAC addresses: 64
199 Maximum number of MAC addresses of hash filtering: 0
201 strip on, filter on, extend off, qinq strip off
202 Redirection table size: 512
203 Supported flow types:
224 Display the rss redirection table entry indicated by masks on port X::
226 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
228 size is used to indicate the hardware supported reta size
233 Display the RSS hash functions and RSS hash key of a port::
235 testpmd> show port (port_id) rss-hash [key]
240 Clear the port statistics and forward engine statistics for a given port or for all ports::
242 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
246 testpmd> clear port stats all
251 Display information for a given port's RX/TX queue::
253 testpmd> show (rxq|txq) info (port_id) (queue_id)
255 show desc status(rxq|txq)
256 ~~~~~~~~~~~~~~~~~~~~~~~~~
258 Display information for a given port's RX/TX descriptor status::
260 testpmd> show port (port_id) (rxq|txq) (queue_id) desc (desc_id) status
266 Displays the configuration of the application.
267 The configuration comes from the command-line, the runtime or the application defaults::
269 testpmd> show config (rxtx|cores|fwd|txpkts)
271 The available information categories are:
273 * ``rxtx``: RX/TX configuration items.
275 * ``cores``: List of forwarding cores.
277 * ``fwd``: Packet forwarding configuration.
279 * ``txpkts``: Packets to TX configuration.
283 .. code-block:: console
285 testpmd> show config rxtx
287 io packet forwarding - CRC stripping disabled - packets/burst=16
288 nb forwarding cores=2 - nb forwarding ports=1
289 RX queues=1 - RX desc=128 - RX free threshold=0
290 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
291 TX queues=1 - TX desc=512 - TX free threshold=0
292 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
293 TX RS bit threshold=0 - TXQ flags=0x0
298 Set the packet forwarding mode::
300 testpmd> set fwd (io|mac|macswap|flowgen| \
301 rxonly|txonly|csum|icmpecho|noisy) (""|retry)
303 ``retry`` can be specified for forwarding engines except ``rx_only``.
305 The available information categories are:
307 * ``io``: Forwards packets "as-is" in I/O mode.
308 This is the fastest possible forwarding operation as it does not access packets data.
309 This is the default mode.
311 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
312 Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination
313 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
314 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
316 * ``macswap``: MAC swap forwarding mode.
317 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
319 * ``flowgen``: Multi-flow generation mode.
320 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
322 * ``rxonly``: Receives packets but doesn't transmit them.
324 * ``txonly``: Generates and transmits packets without receiving any.
326 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
328 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
330 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
332 * ``softnic``: Demonstrates the softnic forwarding operation. In this mode, packet forwarding is
333 similar to I/O mode except for the fact that packets are loopback to the softnic ports only. Therefore, portmask parameter should be set to softnic port only. The various software based custom NIC pipelines specified through the softnic firmware (DPDK packet framework script) can be tested in this mode. Furthermore, it allows to build 5-level hierarchical QoS scheduler as a default option that can be enabled through CLI once testpmd application is initialised. The user can modify the default scheduler hierarchy or can specify the new QoS Scheduler hierarchy through CLI. Requires ``CONFIG_RTE_LIBRTE_PMD_SOFTNIC=y``.
335 * ``noisy``: Noisy neighbor simulation.
336 Simulate more realistic behavior of a guest machine engaged in receiving
337 and sending packets performing Virtual Network Function (VNF).
341 testpmd> set fwd rxonly
343 Set rxonly packet forwarding mode
349 When running, forwarding engines maintain statistics from the time they have been started.
350 Example for the io forwarding engine, with some packet drops on the tx side::
352 testpmd> show fwd stats all
354 ------- Forward Stats for RX Port= 0/Queue= 0 -> TX Port= 1/Queue= 0 -------
355 RX-packets: 274293770 TX-packets: 274293642 TX-dropped: 128
357 ------- Forward Stats for RX Port= 1/Queue= 0 -> TX Port= 0/Queue= 0 -------
358 RX-packets: 274301850 TX-packets: 274301850 TX-dropped: 0
360 ---------------------- Forward statistics for port 0 ----------------------
361 RX-packets: 274293802 RX-dropped: 0 RX-total: 274293802
362 TX-packets: 274301862 TX-dropped: 0 TX-total: 274301862
363 ----------------------------------------------------------------------------
365 ---------------------- Forward statistics for port 1 ----------------------
366 RX-packets: 274301894 RX-dropped: 0 RX-total: 274301894
367 TX-packets: 274293706 TX-dropped: 128 TX-total: 274293834
368 ----------------------------------------------------------------------------
370 +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
371 RX-packets: 548595696 RX-dropped: 0 RX-total: 548595696
372 TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
373 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
378 Clear the forwarding engines statistics::
380 testpmd> clear fwd stats all
385 Display an RX descriptor for a port RX queue::
387 testpmd> read rxd (port_id) (queue_id) (rxd_id)
391 testpmd> read rxd 0 0 4
392 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
397 Display a TX descriptor for a port TX queue::
399 testpmd> read txd (port_id) (queue_id) (txd_id)
403 testpmd> read txd 0 0 4
404 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
409 Get loaded dynamic device personalization (DDP) package info list::
411 testpmd> ddp get list (port_id)
416 Display information about dynamic device personalization (DDP) profile::
418 testpmd> ddp get info (profile_path)
423 Display VF statistics::
425 testpmd> show vf stats (port_id) (vf_id)
430 Reset VF statistics::
432 testpmd> clear vf stats (port_id) (vf_id)
434 show port pctype mapping
435 ~~~~~~~~~~~~~~~~~~~~~~~~
437 List all items from the pctype mapping table::
439 testpmd> show port (port_id) pctype mapping
441 show rx offloading capabilities
442 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
444 List all per queue and per port Rx offloading capabilities of a port::
446 testpmd> show port (port_id) rx_offload capabilities
448 show rx offloading configuration
449 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
451 List port level and all queue level Rx offloading configuration::
453 testpmd> show port (port_id) rx_offload configuration
455 show tx offloading capabilities
456 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
458 List all per queue and per port Tx offloading capabilities of a port::
460 testpmd> show port (port_id) tx_offload capabilities
462 show tx offloading configuration
463 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
465 List port level and all queue level Tx offloading configuration::
467 testpmd> show port (port_id) tx_offload configuration
469 show tx metadata setting
470 ~~~~~~~~~~~~~~~~~~~~~~~~
472 Show Tx metadata value set for a specific port::
474 testpmd> show port (port_id) tx_metadata
476 show port supported ptypes
477 ~~~~~~~~~~~~~~~~~~~~~~~~~~
479 Show ptypes supported for a specific port::
481 testpmd> show port (port_id) ptypes
483 set port supported ptypes
484 ~~~~~~~~~~~~~~~~~~~~~~~~~
486 set packet types classification for a specific port::
488 testpmd> set port (port_id) ptypes_mask (mask)
490 show port mac addresses info
491 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
493 Show mac addresses added for a specific port::
495 testpmd> show port (port_id) macs
498 show port multicast mac addresses info
499 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
501 Show multicast mac addresses added for a specific port::
503 testpmd> show port (port_id) mcast_macs
508 Show general information about devices probed::
510 testpmd> show device info (<identifier>|all)
514 .. code-block:: console
516 testpmd> show device info net_pcap0
518 ********************* Infos for device net_pcap0 *********************
520 Driver name: net_pcap
521 Devargs: iface=enP2p6s0,phy_mac=1
522 Connect to socket: -1
525 MAC address: 1E:37:93:28:04:B8
526 Device name: net_pcap0
531 Dumps all physical memory segment layouts::
533 testpmd> dump_physmem
538 Dumps the layout of all memory zones::
540 testpmd> dump_memzone
545 Dumps the memory usage of all sockets::
547 testpmd> dump_socket_mem
552 Dumps the size of all memory structures::
554 testpmd> dump_struct_sizes
559 Dumps the status of all or specific element in DPDK rings::
561 testpmd> dump_ring [ring_name]
566 Dumps the statistics of all or specific memory pool::
568 testpmd> dump_mempool [mempool_name]
573 Dumps the user device list::
575 testpmd> dump_devargs
580 Dumps the log level for all the dpdk modules::
582 testpmd> dump_log_types
584 show (raw_encap|raw_decap)
585 ~~~~~~~~~~~~~~~~~~~~~~~~~~
587 Display content of raw_encap/raw_decap buffers in hex::
589 testpmd> show <raw_encap|raw_decap> <index>
590 testpmd> show <raw_encap|raw_decap> all
594 testpmd> show raw_encap 6
596 index: 6 at [0x1c565b0], len=50
597 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
598 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
599 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
603 Configuration Functions
604 -----------------------
606 The testpmd application can be configured from the runtime as well as from the command-line.
608 This section details the available configuration functions that are available.
612 Configuration changes only become active when forwarding is started/restarted.
617 Reset forwarding to the default configuration::
624 Set the debug verbosity level::
626 testpmd> set verbose (level)
628 Available levels are as following:
630 * ``0`` silent except for error.
631 * ``1`` fully verbose except for Tx packets.
632 * ``2`` fully verbose except for Rx packets.
633 * ``> 2`` fully verbose.
638 Set the log level for a log type::
640 testpmd> set log global|(type) (level)
644 * ``type`` is the log name.
646 * ``level`` is the log level.
648 For example, to change the global log level::
650 testpmd> set log global (level)
652 Regexes can also be used for type. To change log level of user1, user2 and user3::
654 testpmd> set log user[1-3] (level)
659 Set the number of ports used by the application:
663 This is equivalent to the ``--nb-ports`` command-line option.
668 Set the number of cores used by the application::
670 testpmd> set nbcore (num)
672 This is equivalent to the ``--nb-cores`` command-line option.
676 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
681 Set the forwarding cores hexadecimal mask::
683 testpmd> set coremask (mask)
685 This is equivalent to the ``--coremask`` command-line option.
689 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
694 Set the forwarding ports hexadecimal mask::
696 testpmd> set portmask (mask)
698 This is equivalent to the ``--portmask`` command-line option.
703 Set number of packets per burst::
705 testpmd> set burst (num)
707 This is equivalent to the ``--burst command-line`` option.
709 When retry is enabled, the transmit delay time and number of retries can also be set::
711 testpmd> set burst tx delay (microseconds) retry (num)
716 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
718 testpmd> set txpkts (x[,y]*)
720 Where x[,y]* represents a CSV list of values, without white space.
725 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
727 testpmd> set txsplit (off|on|rand)
731 * ``off`` disable packet copy & split for CSUM mode.
733 * ``on`` split outgoing packet into multiple segments. Size of each segment
734 and number of segments per packet is determined by ``set txpkts`` command
737 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
742 Set the list of forwarding cores::
744 testpmd> set corelist (x[,y]*)
746 For example, to change the forwarding cores:
748 .. code-block:: console
750 testpmd> set corelist 3,1
751 testpmd> show config fwd
753 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
754 Logical Core 3 (socket 0) forwards packets on 1 streams:
755 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
756 Logical Core 1 (socket 0) forwards packets on 1 streams:
757 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
761 The cores are used in the same order as specified on the command line.
766 Set the list of forwarding ports::
768 testpmd> set portlist (x[,y]*)
770 For example, to change the port forwarding:
772 .. code-block:: console
774 testpmd> set portlist 0,2,1,3
775 testpmd> show config fwd
777 io packet forwarding - ports=4 - cores=1 - streams=4
778 Logical Core 3 (socket 0) forwards packets on 4 streams:
779 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
780 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
781 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
782 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
787 Select how to retrieve new ports created after "port attach" command::
789 testpmd> set port setup on (iterator|event)
791 For each new port, a setup is done.
792 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
793 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
798 Enable/disable tx loopback::
800 testpmd> set tx loopback (port_id) (on|off)
805 set drop enable bit for all queues::
807 testpmd> set all queues drop (port_id) (on|off)
809 set split drop enable (for VF)
810 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
812 set split drop enable bit for VF from PF::
814 testpmd> set vf split drop (port_id) (vf_id) (on|off)
816 set mac antispoof (for VF)
817 ~~~~~~~~~~~~~~~~~~~~~~~~~~
819 Set mac antispoof for a VF from the PF::
821 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
826 Enable/disable MACsec offload::
828 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
829 testpmd> set macsec offload (port_id) off
834 Configure MACsec secure connection (SC)::
836 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
840 The pi argument is ignored for tx.
841 Check the NIC Datasheet for hardware limits.
846 Configure MACsec secure association (SA)::
848 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
852 The IDX value must be 0 or 1.
853 Check the NIC Datasheet for hardware limits.
855 set broadcast mode (for VF)
856 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
858 Set broadcast mode for a VF from the PF::
860 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
865 Set the VLAN strip for a queue on a port::
867 testpmd> vlan set stripq (on|off) (port_id,queue_id)
869 vlan set stripq (for VF)
870 ~~~~~~~~~~~~~~~~~~~~~~~~
872 Set VLAN strip for all queues in a pool for a VF from the PF::
874 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
876 vlan set insert (for VF)
877 ~~~~~~~~~~~~~~~~~~~~~~~~
879 Set VLAN insert for a VF from the PF::
881 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
883 vlan set tag (for VF)
884 ~~~~~~~~~~~~~~~~~~~~~
886 Set VLAN tag for a VF from the PF::
888 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
890 vlan set antispoof (for VF)
891 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
893 Set VLAN antispoof for a VF from the PF::
895 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
897 vlan set (strip|filter|qinq_strip|extend)
898 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
899 Set the VLAN strip/filter/QinQ strip/extend on for a port::
901 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
906 Set the inner or outer VLAN TPID for packet filtering on a port::
908 testpmd> vlan set (inner|outer) tpid (value) (port_id)
912 TPID value must be a 16-bit number (value <= 65536).
917 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
919 testpmd> rx_vlan add (vlan_id|all) (port_id)
923 VLAN filter must be set on that port. VLAN ID < 4096.
924 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
925 in VFTA table. This is important if enabling all vlan_ids.
930 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
932 testpmd> rx_vlan rm (vlan_id|all) (port_id)
937 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
939 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
944 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
946 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
951 Add a tunnel filter on a port::
953 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
954 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
955 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
957 The available information categories are:
959 * ``vxlan``: Set tunnel type as VXLAN.
961 * ``nvgre``: Set tunnel type as NVGRE.
963 * ``ipingre``: Set tunnel type as IP-in-GRE.
965 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
967 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
969 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
971 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
973 * ``imac``: Set filter type as Inner MAC.
975 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
977 * ``oip``: Set filter type as Outer IP.
979 * ``iip``: Set filter type as Inner IP.
983 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
984 192.168.2.2 0 ipingre oip 1 1
986 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
991 Remove a tunnel filter on a port::
993 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
994 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
995 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1000 Add an UDP port for VXLAN packet filter on a port::
1002 testpmd> rx_vxlan_port add (udp_port) (port_id)
1004 rx_vxlan_port remove
1005 ~~~~~~~~~~~~~~~~~~~~
1007 Remove an UDP port for VXLAN packet filter on a port::
1009 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1014 Set hardware insertion of VLAN IDs in packets sent on a port::
1016 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1018 For example, set a single VLAN ID (5) insertion on port 0::
1022 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1030 Set port based hardware insertion of VLAN ID in packets sent on a port::
1032 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1037 Disable hardware insertion of a VLAN header in packets sent on a port::
1039 testpmd> tx_vlan reset (port_id)
1044 Select hardware or software calculation of the checksum when
1045 transmitting a packet using the ``csum`` forwarding engine::
1047 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1051 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1053 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1054 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
1055 supported). See also the ``csum parse-tunnel`` command.
1057 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1058 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
1059 supported). See also the ``csum parse-tunnel`` command.
1063 Check the NIC Datasheet for hardware limits.
1068 Set RSS queue region span on a port::
1070 testpmd> set port (port_id) queue-region region_id (value) \
1071 queue_start_index (value) queue_num (value)
1073 Set flowtype mapping on a RSS queue region on a port::
1075 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1079 * For the flowtype(pctype) of packet,the specific index for each type has
1080 been defined in file i40e_type.h as enum i40e_filter_pctype.
1082 Set user priority mapping on a RSS queue region on a port::
1084 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1086 Flush all queue region related configuration on a port::
1088 testpmd> set port (port_id) queue-region flush (on|off)
1092 * ``on``: is just an enable function which server for other configuration,
1093 it is for all configuration about queue region from up layer,
1094 at first will only keep in DPDK software stored in driver,
1095 only after "flush on", it commit all configuration to HW.
1097 * ``"off``: is just clean all configuration about queue region just now,
1098 and restore all to DPDK i40e driver default config when start up.
1100 Show all queue region related configuration info on a port::
1102 testpmd> show port (port_id) queue-region
1106 Queue region only support on PF by now, so these command is
1107 only for configuration of queue region on PF port.
1112 Define how tunneled packets should be handled by the csum forward
1115 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1117 If enabled, the csum forward engine will try to recognize supported
1118 tunnel headers (vxlan, gre, ipip).
1120 If disabled, treat tunnel packets as non-tunneled packets (a inner
1121 header is handled as a packet payload).
1125 The port argument is the TX port like in the ``csum set`` command.
1129 Consider a packet in packet like the following::
1131 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1133 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1134 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1135 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1137 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1138 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1143 Display tx checksum offload configuration::
1145 testpmd> csum show (port_id)
1150 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1152 testpmd> tso set (segsize) (port_id)
1156 Check the NIC datasheet for hardware limits.
1161 Display the status of TCP Segmentation Offload::
1163 testpmd> tso show (port_id)
1168 Set tso segment size of tunneled packets for a port in csum engine::
1170 testpmd> tunnel_tso set (tso_segsz) (port_id)
1175 Display the status of tunneled TCP Segmentation Offload for a port::
1177 testpmd> tunnel_tso show (port_id)
1182 Enable or disable GRO in ``csum`` forwarding engine::
1184 testpmd> set port <port_id> gro on|off
1186 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1187 packets received from the given port.
1189 If disabled, packets received from the given port won't be performed
1190 GRO. By default, GRO is disabled for all ports.
1194 When enable GRO for a port, TCP/IPv4 packets received from the port
1195 will be performed GRO. After GRO, all merged packets have bad
1196 checksums, since the GRO library doesn't re-calculate checksums for
1197 the merged packets. Therefore, if users want the merged packets to
1198 have correct checksums, please select HW IP checksum calculation and
1199 HW TCP checksum calculation for the port which the merged packets are
1205 Display GRO configuration for a given port::
1207 testpmd> show port <port_id> gro
1212 Set the cycle to flush the GROed packets from reassembly tables::
1214 testpmd> set gro flush <cycles>
1216 When enable GRO, the csum forwarding engine performs GRO on received
1217 packets, and the GROed packets are stored in reassembly tables. Users
1218 can use this command to determine when the GROed packets are flushed
1219 from the reassembly tables.
1221 The ``cycles`` is measured in GRO operation times. The csum forwarding
1222 engine flushes the GROed packets from the tables every ``cycles`` GRO
1225 By default, the value of ``cycles`` is 1, which means flush GROed packets
1226 from the reassembly tables as soon as one GRO operation finishes. The value
1227 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1229 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1230 stack performance. Because the GROed packets are delayed to arrive the
1231 stack, thus causing more duplicated ACKs and TCP retransmissions.
1236 Toggle per-port GSO support in ``csum`` forwarding engine::
1238 testpmd> set port <port_id> gso on|off
1240 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1241 packets, transmitted on the given port.
1243 If disabled, packets transmitted on the given port will not undergo GSO.
1244 By default, GSO is disabled for all ports.
1248 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1249 port undergo GSO. Afterwards, the segmented packets are represented by
1250 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1251 of checksums for GSO'd segments in SW. As a result, if users want correct
1252 checksums in GSO segments, they should enable HW checksum calculation for
1255 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1256 by setting the following options in the csum forwarding engine:
1258 testpmd> csum set outer_ip hw <port_id>
1260 testpmd> csum set ip hw <port_id>
1262 testpmd> csum set tcp hw <port_id>
1264 UDP GSO is the same as IP fragmentation, which treats the UDP header
1265 as the payload and does not modify it during segmentation. That is,
1266 after UDP GSO, only the first output fragment has the original UDP
1267 header. Therefore, users need to enable HW IP checksum calculation
1268 and SW UDP checksum calculation for GSO-enabled ports, if they want
1269 correct checksums for UDP/IPv4 packets.
1274 Set the maximum GSO segment size (measured in bytes), which includes the
1275 packet header and the packet payload for GSO-enabled ports (global)::
1277 testpmd> set gso segsz <length>
1282 Display the status of Generic Segmentation Offload for a given port::
1284 testpmd> show port <port_id> gso
1289 Add an alternative MAC address to a port::
1291 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1296 Remove a MAC address from a port::
1298 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1303 To add the multicast MAC address to/from the set of multicast addresses
1306 testpmd> mcast_addr add (port_id) (mcast_addr)
1311 To remove the multicast MAC address to/from the set of multicast addresses
1314 testpmd> mcast_addr remove (port_id) (mcast_addr)
1316 mac_addr add (for VF)
1317 ~~~~~~~~~~~~~~~~~~~~~
1319 Add an alternative MAC address for a VF to a port::
1321 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1326 Set the default MAC address for a port::
1328 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1330 mac_addr set (for VF)
1331 ~~~~~~~~~~~~~~~~~~~~~
1333 Set the MAC address for a VF from the PF::
1335 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1340 Set the forwarding peer address for certain port::
1342 testpmd> set eth-peer (port_id) (peer_addr)
1344 This is equivalent to the ``--eth-peer`` command-line option.
1349 Set the unicast hash filter(s) on/off for a port::
1351 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1356 Set the promiscuous mode on for a port or for all ports.
1357 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1359 testpmd> set promisc (port_id|all) (on|off)
1364 Set the allmulti mode for a port or for all ports::
1366 testpmd> set allmulti (port_id|all) (on|off)
1368 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1370 set promisc (for VF)
1371 ~~~~~~~~~~~~~~~~~~~~
1373 Set the unicast promiscuous mode for a VF from PF.
1374 It's supported by Intel i40e NICs now.
1375 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1377 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1379 set allmulticast (for VF)
1380 ~~~~~~~~~~~~~~~~~~~~~~~~~
1382 Set the multicast promiscuous mode for a VF from PF.
1383 It's supported by Intel i40e NICs now.
1384 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1386 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1388 set tx max bandwidth (for VF)
1389 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1391 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1393 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1395 set tc tx min bandwidth (for VF)
1396 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1398 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1400 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1402 set tc tx max bandwidth (for VF)
1403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1405 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1407 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1409 set tc strict link priority mode
1410 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1412 Set some TCs' strict link priority mode on a physical port::
1414 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1416 set tc tx min bandwidth
1417 ~~~~~~~~~~~~~~~~~~~~~~~
1419 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1421 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1426 Set the link flow control parameter on a port::
1428 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1429 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1430 autoneg (on|off) (port_id)
1434 * ``high_water`` (integer): High threshold value to trigger XOFF.
1436 * ``low_water`` (integer): Low threshold value to trigger XON.
1438 * ``pause_time`` (integer): Pause quota in the Pause frame.
1440 * ``send_xon`` (0/1): Send XON frame.
1442 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1444 * ``autoneg``: Change the auto-negotiation parameter.
1449 Set the priority flow control parameter on a port::
1451 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1452 (pause_time) (priority) (port_id)
1456 * ``high_water`` (integer): High threshold value.
1458 * ``low_water`` (integer): Low threshold value.
1460 * ``pause_time`` (integer): Pause quota in the Pause frame.
1462 * ``priority`` (0-7): VLAN User Priority.
1467 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1469 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1471 For example, to set rx queue 2 on port 0 to mapping 5::
1473 testpmd>set stat_qmap rx 0 2 5
1475 set xstats-hide-zero
1476 ~~~~~~~~~~~~~~~~~~~~
1478 Set the option to hide zero values for xstats display::
1480 testpmd> set xstats-hide-zero on|off
1484 By default, the zero values are displayed for xstats.
1486 set port - rx/tx (for VF)
1487 ~~~~~~~~~~~~~~~~~~~~~~~~~
1489 Set VF receive/transmit from a port::
1491 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1493 set port - mac address filter (for VF)
1494 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1496 Add/Remove unicast or multicast MAC addr filter for a VF::
1498 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1499 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1501 set port - rx mode(for VF)
1502 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1504 Set the VF receive mode of a port::
1506 testpmd> set port (port_id) vf (vf_id) \
1507 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1509 The available receive modes are:
1511 * ``AUPE``: Accepts untagged VLAN.
1513 * ``ROPE``: Accepts unicast hash.
1515 * ``BAM``: Accepts broadcast packets.
1517 * ``MPE``: Accepts all multicast packets.
1519 set port - tx_rate (for Queue)
1520 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1522 Set TX rate limitation for a queue on a port::
1524 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1526 set port - tx_rate (for VF)
1527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1529 Set TX rate limitation for queues in VF on a port::
1531 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1533 set port - mirror rule
1534 ~~~~~~~~~~~~~~~~~~~~~~
1536 Set pool or vlan type mirror rule for a port::
1538 testpmd> set port (port_id) mirror-rule (rule_id) \
1539 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1540 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1542 Set link mirror rule for a port::
1544 testpmd> set port (port_id) mirror-rule (rule_id) \
1545 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1547 For example to enable mirror traffic with vlan 0,1 to pool 0::
1549 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1551 reset port - mirror rule
1552 ~~~~~~~~~~~~~~~~~~~~~~~~
1554 Reset a mirror rule for a port::
1556 testpmd> reset port (port_id) mirror-rule (rule_id)
1561 Set the flush on RX streams before forwarding.
1562 The default is flush ``on``.
1563 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1565 testpmd> set flush_rx off
1570 Set the bypass mode for the lowest port on bypass enabled NIC::
1572 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1577 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1579 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1580 mode (normal|bypass|isolate) (port_id)
1584 * ``timeout``: Enable bypass after watchdog timeout.
1586 * ``os_on``: Enable bypass when OS/board is powered on.
1588 * ``os_off``: Enable bypass when OS/board is powered off.
1590 * ``power_on``: Enable bypass when power supply is turned on.
1592 * ``power_off``: Enable bypass when power supply is turned off.
1598 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1600 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1605 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1607 testpmd> show bypass config (port_id)
1612 Set link up for a port::
1614 testpmd> set link-up port (port id)
1619 Set link down for a port::
1621 testpmd> set link-down port (port id)
1626 Enable E-tag insertion for a VF on a port::
1628 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1630 Disable E-tag insertion for a VF on a port::
1632 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1634 Enable/disable E-tag stripping on a port::
1636 testpmd> E-tag set stripping (on|off) port (port_id)
1638 Enable/disable E-tag based forwarding on a port::
1640 testpmd> E-tag set forwarding (on|off) port (port_id)
1642 Add an E-tag forwarding filter on a port::
1644 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1646 Delete an E-tag forwarding filter on a port::
1647 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1652 Load a dynamic device personalization (DDP) profile and store backup profile::
1654 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1659 Delete a dynamic device personalization profile and restore backup profile::
1661 testpmd> ddp del (port_id) (backup_profile_path)
1666 List all items from the ptype mapping table::
1668 testpmd> ptype mapping get (port_id) (valid_only)
1672 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1674 Replace a specific or a group of software defined ptype with a new one::
1676 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1680 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1682 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1684 * ``pkt_type``: The new software ptype to replace the old ones.
1686 Update hardware defined ptype to software defined packet type mapping table::
1688 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1692 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1694 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1696 Reset ptype mapping table::
1698 testpmd> ptype mapping reset (port_id)
1700 config per port Rx offloading
1701 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1703 Enable or disable a per port Rx offloading on all Rx queues of a port::
1705 testpmd> port config (port_id) rx_offload (offloading) on|off
1707 * ``offloading``: can be any of these offloading capability:
1708 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1709 qinq_strip, outer_ipv4_cksum, macsec_strip,
1710 header_split, vlan_filter, vlan_extend, jumbo_frame,
1711 scatter, timestamp, security, keep_crc, rss_hash
1713 This command should be run when the port is stopped, or else it will fail.
1715 config per queue Rx offloading
1716 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1718 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1720 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1722 * ``offloading``: can be any of these offloading capability:
1723 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1724 qinq_strip, outer_ipv4_cksum, macsec_strip,
1725 header_split, vlan_filter, vlan_extend, jumbo_frame,
1726 scatter, timestamp, security, keep_crc
1728 This command should be run when the port is stopped, or else it will fail.
1730 config per port Tx offloading
1731 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1733 Enable or disable a per port Tx offloading on all Tx queues of a port::
1735 testpmd> port config (port_id) tx_offload (offloading) on|off
1737 * ``offloading``: can be any of these offloading capability:
1738 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1739 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1740 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1741 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1742 mt_lockfree, multi_segs, mbuf_fast_free, security
1744 This command should be run when the port is stopped, or else it will fail.
1746 config per queue Tx offloading
1747 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1749 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1751 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1753 * ``offloading``: can be any of these offloading capability:
1754 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1755 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1756 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1757 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1758 mt_lockfree, multi_segs, mbuf_fast_free, security
1760 This command should be run when the port is stopped, or else it will fail.
1762 Config VXLAN Encap outer layers
1763 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1765 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1767 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1768 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1771 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1772 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1773 eth-src (eth-src) eth-dst (eth-dst)
1775 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1776 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1777 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1779 These commands will set an internal configuration inside testpmd, any following
1780 flow rule using the action vxlan_encap will use the last configuration set.
1781 To have a different encapsulation header, one of those commands must be called
1782 before the flow rule creation.
1784 Config NVGRE Encap outer layers
1785 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1787 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1789 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1790 eth-src (eth-src) eth-dst (eth-dst)
1791 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1792 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1794 These commands will set an internal configuration inside testpmd, any following
1795 flow rule using the action nvgre_encap will use the last configuration set.
1796 To have a different encapsulation header, one of those commands must be called
1797 before the flow rule creation.
1802 Configure the l2 to be used when encapsulating a packet with L2::
1804 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1805 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1806 eth-src (eth-src) eth-dst (eth-dst)
1808 Those commands will set an internal configuration inside testpmd, any following
1809 flow rule using the action l2_encap will use the last configuration set.
1810 To have a different encapsulation header, one of those commands must be called
1811 before the flow rule creation.
1816 Configure the l2 to be removed when decapsulating a packet with L2::
1818 set l2_decap ip-version (ipv4|ipv6)
1819 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1821 Those commands will set an internal configuration inside testpmd, any following
1822 flow rule using the action l2_decap will use the last configuration set.
1823 To have a different encapsulation header, one of those commands must be called
1824 before the flow rule creation.
1826 Config MPLSoGRE Encap outer layers
1827 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1829 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1831 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1832 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1833 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1834 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1835 eth-src (eth-src) eth-dst (eth-dst)
1837 These commands will set an internal configuration inside testpmd, any following
1838 flow rule using the action mplsogre_encap will use the last configuration set.
1839 To have a different encapsulation header, one of those commands must be called
1840 before the flow rule creation.
1842 Config MPLSoGRE Decap outer layers
1843 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1845 Configure the outer layer to decapsulate MPLSoGRE packet::
1847 set mplsogre_decap ip-version (ipv4|ipv6)
1848 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1850 These commands will set an internal configuration inside testpmd, any following
1851 flow rule using the action mplsogre_decap will use the last configuration set.
1852 To have a different decapsulation header, one of those commands must be called
1853 before the flow rule creation.
1855 Config MPLSoUDP Encap outer layers
1856 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1858 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1860 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1861 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1862 eth-src (eth-src) eth-dst (eth-dst)
1863 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1864 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1865 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1867 These commands will set an internal configuration inside testpmd, any following
1868 flow rule using the action mplsoudp_encap will use the last configuration set.
1869 To have a different encapsulation header, one of those commands must be called
1870 before the flow rule creation.
1872 Config MPLSoUDP Decap outer layers
1873 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1875 Configure the outer layer to decapsulate MPLSoUDP packet::
1877 set mplsoudp_decap ip-version (ipv4|ipv6)
1878 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1880 These commands will set an internal configuration inside testpmd, any following
1881 flow rule using the action mplsoudp_decap will use the last configuration set.
1882 To have a different decapsulation header, one of those commands must be called
1883 before the flow rule creation.
1885 Config Raw Encapsulation
1886 ~~~~~~~~~~~~~~~~~~~~~~~~~
1888 Configure the raw data to be used when encapsulating a packet by
1889 rte_flow_action_raw_encap::
1891 set raw_encap {index} {item} [/ {item} [...]] / end_set
1893 There are multiple global buffers for ``raw_encap``, this command will set one
1894 internal buffer index by ``{index}``.
1895 If there is no ``{index}`` specified::
1897 set raw_encap {item} [/ {item} [...]] / end_set
1899 the default index ``0`` is used.
1900 In order to use different encapsulating header, ``index`` must be specified
1901 during the flow rule creation::
1903 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1904 raw_encap index 2 / end
1906 Otherwise the default index ``0`` is used.
1908 Config Raw Decapsulation
1909 ~~~~~~~~~~~~~~~~~~~~~~~~
1911 Configure the raw data to be used when decapsulating a packet by
1912 rte_flow_action_raw_decap::
1914 set raw_decap {index} {item} [/ {item} [...]] / end_set
1916 There are multiple global buffers for ``raw_decap``, this command will set
1917 one internal buffer index by ``{index}``.
1918 If there is no ``{index}`` specified::
1920 set raw_decap {item} [/ {item} [...]] / end_set
1922 the default index ``0`` is used.
1923 In order to use different decapsulating header, ``index`` must be specified
1924 during the flow rule creation::
1926 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1927 raw_encap index 3 / end
1929 Otherwise the default index ``0`` is used.
1934 The following sections show functions for configuring ports.
1938 Port configuration changes only become active when forwarding is started/restarted.
1943 Attach a port specified by pci address or virtual device args::
1945 testpmd> port attach (identifier)
1947 To attach a new pci device, the device should be recognized by kernel first.
1948 Then it should be moved under DPDK management.
1949 Finally the port can be attached to testpmd.
1951 For example, to move a pci device using ixgbe under DPDK management:
1953 .. code-block:: console
1955 # Check the status of the available devices.
1956 ./usertools/dpdk-devbind.py --status
1958 Network devices using DPDK-compatible driver
1959 ============================================
1962 Network devices using kernel driver
1963 ===================================
1964 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1967 # Bind the device to igb_uio.
1968 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1971 # Recheck the status of the devices.
1972 ./usertools/dpdk-devbind.py --status
1973 Network devices using DPDK-compatible driver
1974 ============================================
1975 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1977 To attach a port created by virtual device, above steps are not needed.
1979 For example, to attach a port whose pci address is 0000:0a:00.0.
1981 .. code-block:: console
1983 testpmd> port attach 0000:0a:00.0
1984 Attaching a new port...
1985 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1986 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1987 EAL: PCI memory mapped at 0x7f83bfa00000
1988 EAL: PCI memory mapped at 0x7f83bfa80000
1989 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1990 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1991 Port 0 is attached. Now total ports is 1
1994 For example, to attach a port created by pcap PMD.
1996 .. code-block:: console
1998 testpmd> port attach net_pcap0
1999 Attaching a new port...
2000 PMD: Initializing pmd_pcap for net_pcap0
2001 PMD: Creating pcap-backed ethdev on numa socket 0
2002 Port 0 is attached. Now total ports is 1
2005 In this case, identifier is ``net_pcap0``.
2006 This identifier format is the same as ``--vdev`` format of DPDK applications.
2008 For example, to re-attach a bonded port which has been previously detached,
2009 the mode and slave parameters must be given.
2011 .. code-block:: console
2013 testpmd> port attach net_bond_0,mode=0,slave=1
2014 Attaching a new port...
2015 EAL: Initializing pmd_bond for net_bond_0
2016 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2017 Port 0 is attached. Now total ports is 1
2024 Detach a specific port::
2026 testpmd> port detach (port_id)
2028 Before detaching a port, the port should be stopped and closed.
2030 For example, to detach a pci device port 0.
2032 .. code-block:: console
2034 testpmd> port stop 0
2037 testpmd> port close 0
2041 testpmd> port detach 0
2043 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2044 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2045 EAL: PCI memory unmapped at 0x7f83bfa00000
2046 EAL: PCI memory unmapped at 0x7f83bfa80000
2050 For example, to detach a virtual device port 0.
2052 .. code-block:: console
2054 testpmd> port stop 0
2057 testpmd> port close 0
2061 testpmd> port detach 0
2063 PMD: Closing pcap ethdev on numa socket 0
2064 Port 'net_pcap0' is detached. Now total ports is 0
2067 To remove a pci device completely from the system, first detach the port from testpmd.
2068 Then the device should be moved under kernel management.
2069 Finally the device can be removed using kernel pci hotplug functionality.
2071 For example, to move a pci device under kernel management:
2073 .. code-block:: console
2075 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2077 ./usertools/dpdk-devbind.py --status
2079 Network devices using DPDK-compatible driver
2080 ============================================
2083 Network devices using kernel driver
2084 ===================================
2085 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2087 To remove a port created by a virtual device, above steps are not needed.
2092 Start all ports or a specific port::
2094 testpmd> port start (port_id|all)
2099 Stop all ports or a specific port::
2101 testpmd> port stop (port_id|all)
2106 Close all ports or a specific port::
2108 testpmd> port close (port_id|all)
2113 Reset all ports or a specific port::
2115 testpmd> port reset (port_id|all)
2117 User should stop port(s) before resetting and (re-)start after reset.
2119 port config - queue ring size
2120 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2122 Configure a rx/tx queue ring size::
2124 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2126 Only take effect after command that (re-)start the port or command that setup specific queue.
2128 port start/stop queue
2129 ~~~~~~~~~~~~~~~~~~~~~
2131 Start/stop a rx/tx queue on a specific port::
2133 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2135 port config - queue deferred start
2136 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2138 Switch on/off deferred start of a specific port queue::
2140 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2143 ~~~~~~~~~~~~~~~~~~~~~
2145 Setup a rx/tx queue on a specific port::
2147 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2149 Only take effect when port is started.
2154 Set the speed and duplex mode for all ports or a specific port::
2156 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
2157 duplex (half|full|auto)
2159 port config - queues/descriptors
2160 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2162 Set number of queues/descriptors for rxq, txq, rxd and txd::
2164 testpmd> port config all (rxq|txq|rxd|txd) (value)
2166 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2168 port config - max-pkt-len
2169 ~~~~~~~~~~~~~~~~~~~~~~~~~
2171 Set the maximum packet length::
2173 testpmd> port config all max-pkt-len (value)
2175 This is equivalent to the ``--max-pkt-len`` command-line option.
2177 port config - max-lro-pkt-size
2178 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2180 Set the maximum LRO aggregated packet size::
2182 testpmd> port config all max-lro-pkt-size (value)
2184 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2186 port config - Drop Packets
2187 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2189 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2191 testpmd> port config all drop-en (on|off)
2193 Packet dropping when no receive buffers available is off by default.
2195 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2200 Set the RSS (Receive Side Scaling) mode on or off::
2202 testpmd> port config all rss (all|default|eth|vlan|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|l2tpv3|esp|ah|pfcp|none)
2204 RSS is on by default.
2206 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp.
2208 The ``default`` option enables all supported RSS types reported by device info.
2210 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2212 port config - RSS Reta
2213 ~~~~~~~~~~~~~~~~~~~~~~
2215 Set the RSS (Receive Side Scaling) redirection table::
2217 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2222 Set the DCB mode for an individual port::
2224 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2226 The traffic class should be 4 or 8.
2231 Set the number of packets per burst::
2233 testpmd> port config all burst (value)
2235 This is equivalent to the ``--burst`` command-line option.
2237 port config - Threshold
2238 ~~~~~~~~~~~~~~~~~~~~~~~
2240 Set thresholds for TX/RX queues::
2242 testpmd> port config all (threshold) (value)
2244 Where the threshold type can be:
2246 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2248 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2250 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2252 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2254 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2256 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2258 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2260 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2262 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2264 These threshold options are also available from the command-line.
2269 Set the value of ether-type for E-tag::
2271 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2273 Enable/disable the E-tag support::
2275 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2277 port config pctype mapping
2278 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2280 Reset pctype mapping table::
2282 testpmd> port config (port_id) pctype mapping reset
2284 Update hardware defined pctype to software defined flow type mapping table::
2286 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2290 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2292 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2294 port config input set
2295 ~~~~~~~~~~~~~~~~~~~~~
2297 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2299 testpmd> port config (port_id) pctype (pctype_id) \
2300 (hash_inset|fdir_inset|fdir_flx_inset) \
2301 (get|set|clear) field (field_idx)
2303 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2305 testpmd> port config (port_id) pctype (pctype_id) \
2306 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2310 * ``pctype_id``: hardware packet classification types.
2311 * ``field_idx``: hardware field index.
2313 port config udp_tunnel_port
2314 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2316 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2318 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2320 port config tx_metadata
2321 ~~~~~~~~~~~~~~~~~~~~~~~
2323 Set Tx metadata value per port.
2324 testpmd will add this value to any Tx packet sent from this port::
2326 testpmd> port config (port_id) tx_metadata (value)
2331 Set/clear dynamic flag per port.
2332 testpmd will register this flag in the mbuf (same registration
2333 for both Tx and Rx). Then set/clear this flag for each Tx
2334 packet sent from this port. The set bit only works for Tx packet::
2336 testpmd> port config (port_id) dynf (name) (set|clear)
2341 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2343 testpmd> port config mtu (port_id) (value)
2345 port config rss hash key
2346 ~~~~~~~~~~~~~~~~~~~~~~~~
2348 To configure the RSS hash key used to compute the RSS
2349 hash of input [IP] packets received on port::
2351 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2352 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2353 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2354 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2355 ipv6-udp-ex <string of hex digits \
2356 (variable length, NIC dependent)>)
2361 The following sections show functions for device operations.
2366 Detach a device specified by pci address or virtual device args::
2368 testpmd> device detach (identifier)
2370 Before detaching a device associated with ports, the ports should be stopped and closed.
2372 For example, to detach a pci device whose address is 0002:03:00.0.
2374 .. code-block:: console
2376 testpmd> device detach 0002:03:00.0
2377 Removing a device...
2378 Port 1 is now closed
2379 EAL: Releasing pci mapped resource for 0002:03:00.0
2380 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2381 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2382 Device 0002:03:00.0 is detached
2383 Now total ports is 1
2385 For example, to detach a port created by pcap PMD.
2387 .. code-block:: console
2389 testpmd> device detach net_pcap0
2390 Removing a device...
2391 Port 0 is now closed
2392 Device net_pcap0 is detached
2393 Now total ports is 0
2396 In this case, identifier is ``net_pcap0``.
2397 This identifier format is the same as ``--vdev`` format of DPDK applications.
2399 Link Bonding Functions
2400 ----------------------
2402 The Link Bonding functions make it possible to dynamically create and
2403 manage link bonding devices from within testpmd interactive prompt.
2405 create bonded device
2406 ~~~~~~~~~~~~~~~~~~~~
2408 Create a new bonding device::
2410 testpmd> create bonded device (mode) (socket)
2412 For example, to create a bonded device in mode 1 on socket 0::
2414 testpmd> create bonded device 1 0
2415 created new bonded device (port X)
2420 Adds Ethernet device to a Link Bonding device::
2422 testpmd> add bonding slave (slave id) (port id)
2424 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2426 testpmd> add bonding slave 6 10
2429 remove bonding slave
2430 ~~~~~~~~~~~~~~~~~~~~
2432 Removes an Ethernet slave device from a Link Bonding device::
2434 testpmd> remove bonding slave (slave id) (port id)
2436 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2438 testpmd> remove bonding slave 6 10
2443 Set the Link Bonding mode of a Link Bonding device::
2445 testpmd> set bonding mode (value) (port id)
2447 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2449 testpmd> set bonding mode 3 10
2454 Set an Ethernet slave device as the primary device on a Link Bonding device::
2456 testpmd> set bonding primary (slave id) (port id)
2458 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2460 testpmd> set bonding primary 6 10
2465 Set the MAC address of a Link Bonding device::
2467 testpmd> set bonding mac (port id) (mac)
2469 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2471 testpmd> set bonding mac 10 00:00:00:00:00:01
2473 set bonding xmit_balance_policy
2474 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2476 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2478 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2480 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2482 testpmd> set bonding xmit_balance_policy 10 l34
2485 set bonding mon_period
2486 ~~~~~~~~~~~~~~~~~~~~~~
2488 Set the link status monitoring polling period in milliseconds for a bonding device.
2490 This adds support for PMD slave devices which do not support link status interrupts.
2491 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2492 link status ISR will be queried every polling interval to check if their link status has changed::
2494 testpmd> set bonding mon_period (port_id) (value)
2496 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2498 testpmd> set bonding mon_period 5 150
2501 set bonding lacp dedicated_queue
2502 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2504 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2505 when in mode 4 (link-aggregation-802.3ad)::
2507 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2510 set bonding agg_mode
2511 ~~~~~~~~~~~~~~~~~~~~
2513 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2515 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2521 Show the current configuration of a Link Bonding device::
2523 testpmd> show bonding config (port id)
2526 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2527 in balance mode with a transmission policy of layer 2+3::
2529 testpmd> show bonding config 9
2531 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2533 Active Slaves (3): [1 3 4]
2540 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2541 This is mainly useful for debugging purposes.
2542 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2543 and fields that can be accessed.
2548 Display the value of a port register::
2550 testpmd> read reg (port_id) (address)
2552 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2554 testpmd> read reg 0 0xEE00
2555 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2560 Display a port register bit field::
2562 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2564 For example, reading the lowest two bits from the register in the example above::
2566 testpmd> read regfield 0 0xEE00 0 1
2567 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2572 Display a single port register bit::
2574 testpmd> read regbit (port_id) (address) (bit_x)
2576 For example, reading the lowest bit from the register in the example above::
2578 testpmd> read regbit 0 0xEE00 0
2579 port 0 PCI register at offset 0xEE00: bit 0=1
2584 Set the value of a port register::
2586 testpmd> write reg (port_id) (address) (value)
2588 For example, to clear a register::
2590 testpmd> write reg 0 0xEE00 0x0
2591 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2596 Set bit field of a port register::
2598 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2600 For example, writing to the register cleared in the example above::
2602 testpmd> write regfield 0 0xEE00 0 1 2
2603 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2608 Set single bit value of a port register::
2610 testpmd> write regbit (port_id) (address) (bit_x) (value)
2612 For example, to set the high bit in the register from the example above::
2614 testpmd> write regbit 0 0xEE00 31 1
2615 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2617 Traffic Metering and Policing
2618 -----------------------------
2620 The following section shows functions for configuring traffic metering and
2621 policing on the ethernet device through the use of generic ethdev API.
2623 show port traffic management capability
2624 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2626 Show traffic metering and policing capability of the port::
2628 testpmd> show port meter cap (port_id)
2630 add port meter profile (srTCM rfc2967)
2631 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2633 Add meter profile (srTCM rfc2697) to the ethernet device::
2635 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2640 * ``profile_id``: ID for the meter profile.
2641 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2642 * ``cbs``: Committed Burst Size (CBS) (bytes).
2643 * ``ebs``: Excess Burst Size (EBS) (bytes).
2645 add port meter profile (trTCM rfc2968)
2646 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2648 Add meter profile (srTCM rfc2698) to the ethernet device::
2650 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2651 (cir) (pir) (cbs) (pbs)
2655 * ``profile_id``: ID for the meter profile.
2656 * ``cir``: Committed information rate (bytes/second).
2657 * ``pir``: Peak information rate (bytes/second).
2658 * ``cbs``: Committed burst size (bytes).
2659 * ``pbs``: Peak burst size (bytes).
2661 add port meter profile (trTCM rfc4115)
2662 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2664 Add meter profile (trTCM rfc4115) to the ethernet device::
2666 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2667 (cir) (eir) (cbs) (ebs)
2671 * ``profile_id``: ID for the meter profile.
2672 * ``cir``: Committed information rate (bytes/second).
2673 * ``eir``: Excess information rate (bytes/second).
2674 * ``cbs``: Committed burst size (bytes).
2675 * ``ebs``: Excess burst size (bytes).
2677 delete port meter profile
2678 ~~~~~~~~~~~~~~~~~~~~~~~~~
2680 Delete meter profile from the ethernet device::
2682 testpmd> del port meter profile (port_id) (profile_id)
2687 Create new meter object for the ethernet device::
2689 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2690 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2691 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2696 * ``mtr_id``: meter object ID.
2697 * ``profile_id``: ID for the meter profile.
2698 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2699 gets enabled at the time of creation, otherwise remains disabled.
2700 * ``g_action``: Policer action for the packet with green color.
2701 * ``y_action``: Policer action for the packet with yellow color.
2702 * ``r_action``: Policer action for the packet with red color.
2703 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2705 * ``shared``: When this parameter has a non-zero value, the meter object is
2706 shared by multiple flows. Otherwise, meter object is used by single flow.
2707 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2708 input color for the current meter object is determined by the latest meter
2709 object in the same flow. Otherwise, the current meter object uses the
2710 *dscp_table* to determine the input color.
2711 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2712 color, 0 <= x <= 63.
2717 Enable meter for the ethernet device::
2719 testpmd> enable port meter (port_id) (mtr_id)
2724 Disable meter for the ethernet device::
2726 testpmd> disable port meter (port_id) (mtr_id)
2731 Delete meter for the ethernet device::
2733 testpmd> del port meter (port_id) (mtr_id)
2735 Set port meter profile
2736 ~~~~~~~~~~~~~~~~~~~~~~
2738 Set meter profile for the ethernet device::
2740 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2742 set port meter dscp table
2743 ~~~~~~~~~~~~~~~~~~~~~~~~~
2745 Set meter dscp table for the ethernet device::
2747 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2748 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2750 set port meter policer action
2751 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2753 Set meter policer action for the ethernet device::
2755 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2756 (action0) [(action1) (action1)]
2760 * ``action_mask``: Bit mask indicating which policer actions need to be
2761 updated. One or more policer actions can be updated in a single function
2762 invocation. To update the policer action associated with color C, bit
2763 (1 << C) needs to be set in *action_mask* and element at position C
2764 in the *actions* array needs to be valid.
2765 * ``actionx``: Policer action for the color x,
2766 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2768 set port meter stats mask
2769 ~~~~~~~~~~~~~~~~~~~~~~~~~
2771 Set meter stats mask for the ethernet device::
2773 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2777 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2779 show port meter stats
2780 ~~~~~~~~~~~~~~~~~~~~~
2782 Show meter stats of the ethernet device::
2784 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2788 * ``clear``: Flag that indicates whether the statistics counters should
2789 be cleared (i.e. set to zero) immediately after they have been read or not.
2794 The following section shows functions for configuring traffic management on
2795 the ethernet device through the use of generic TM API.
2797 show port traffic management capability
2798 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2800 Show traffic management capability of the port::
2802 testpmd> show port tm cap (port_id)
2804 show port traffic management capability (hierarchy level)
2805 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2807 Show traffic management hierarchy level capability of the port::
2809 testpmd> show port tm level cap (port_id) (level_id)
2811 show port traffic management capability (hierarchy node level)
2812 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2814 Show the traffic management hierarchy node capability of the port::
2816 testpmd> show port tm node cap (port_id) (node_id)
2818 show port traffic management hierarchy node type
2819 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2821 Show the port traffic management hierarchy node type::
2823 testpmd> show port tm node type (port_id) (node_id)
2825 show port traffic management hierarchy node stats
2826 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2828 Show the port traffic management hierarchy node statistics::
2830 testpmd> show port tm node stats (port_id) (node_id) (clear)
2834 * ``clear``: When this parameter has a non-zero value, the statistics counters
2835 are cleared (i.e. set to zero) immediately after they have been read,
2836 otherwise the statistics counters are left untouched.
2838 Add port traffic management private shaper profile
2839 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2841 Add the port traffic management private shaper profile::
2843 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2844 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2845 (packet_length_adjust)
2849 * ``shaper_profile id``: Shaper profile ID for the new profile.
2850 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2851 * ``cmit_tb_size``: Committed token bucket size (bytes).
2852 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2853 * ``peak_tb_size``: Peak token bucket size (bytes).
2854 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2855 each packet for the purpose of shaping. This parameter value can be used to
2856 correct the packet length with the framing overhead bytes that are consumed
2859 Delete port traffic management private shaper profile
2860 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2862 Delete the port traffic management private shaper::
2864 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2868 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2870 Add port traffic management shared shaper
2871 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2873 Create the port traffic management shared shaper::
2875 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2880 * ``shared_shaper_id``: Shared shaper ID to be created.
2881 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2883 Set port traffic management shared shaper
2884 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2886 Update the port traffic management shared shaper::
2888 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2893 * ``shared_shaper_id``: Shared shaper ID to be update.
2894 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2896 Delete port traffic management shared shaper
2897 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2899 Delete the port traffic management shared shaper::
2901 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2905 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2907 Set port traffic management hierarchy node private shaper
2908 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2910 set the port traffic management hierarchy node private shaper::
2912 testpmd> set port tm node shaper profile (port_id) (node_id) \
2917 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2920 Add port traffic management WRED profile
2921 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2923 Create a new WRED profile::
2925 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2926 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2927 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2928 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2932 * ``wred_profile id``: Identifier for the newly create WRED profile
2933 * ``color_g``: Packet color (green)
2934 * ``min_th_g``: Minimum queue threshold for packet with green color
2935 * ``max_th_g``: Minimum queue threshold for packet with green color
2936 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2937 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2938 * ``color_y``: Packet color (yellow)
2939 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2940 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2941 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2942 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2943 * ``color_r``: Packet color (red)
2944 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2945 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2946 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2947 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2949 Delete port traffic management WRED profile
2950 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2952 Delete the WRED profile::
2954 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2956 Add port traffic management hierarchy nonleaf node
2957 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2959 Add nonleaf node to port traffic management hierarchy::
2961 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2962 (priority) (weight) (level_id) (shaper_profile_id) \
2963 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2964 [(shared_shaper_0) (shared_shaper_1) ...] \
2968 * ``parent_node_id``: Node ID of the parent.
2969 * ``priority``: Node priority (highest node priority is zero). This is used by
2970 the SP algorithm running on the parent node for scheduling this node.
2971 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2972 to the weight sum of all siblings that have the same priority. It is used by
2973 the WFQ algorithm running on the parent node for scheduling this node.
2974 * ``level_id``: Hierarchy level of the node.
2975 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2977 * ``n_sp_priorities``: Number of strict priorities.
2978 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2979 * ``n_shared_shapers``: Number of shared shapers.
2980 * ``shared_shaper_id``: Shared shaper id.
2982 Add port traffic management hierarchy leaf node
2983 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2985 Add leaf node to port traffic management hierarchy::
2987 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2988 (priority) (weight) (level_id) (shaper_profile_id) \
2989 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2990 [(shared_shaper_id) (shared_shaper_id) ...] \
2994 * ``parent_node_id``: Node ID of the parent.
2995 * ``priority``: Node priority (highest node priority is zero). This is used by
2996 the SP algorithm running on the parent node for scheduling this node.
2997 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2998 to the weight sum of all siblings that have the same priority. It is used by
2999 the WFQ algorithm running on the parent node for scheduling this node.
3000 * ``level_id``: Hierarchy level of the node.
3001 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3003 * ``cman_mode``: Congestion management mode to be enabled for this node.
3004 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3005 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3006 * ``n_shared_shapers``: Number of shared shapers.
3007 * ``shared_shaper_id``: Shared shaper id.
3009 Delete port traffic management hierarchy node
3010 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3012 Delete node from port traffic management hierarchy::
3014 testpmd> del port tm node (port_id) (node_id)
3016 Update port traffic management hierarchy parent node
3017 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3019 Update port traffic management hierarchy parent node::
3021 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3024 This function can only be called after the hierarchy commit invocation. Its
3025 success depends on the port support for this operation, as advertised through
3026 the port capability set. This function is valid for all nodes of the traffic
3027 management hierarchy except root node.
3029 Suspend port traffic management hierarchy node
3030 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3032 testpmd> suspend port tm node (port_id) (node_id)
3034 Resume port traffic management hierarchy node
3035 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3037 testpmd> resume port tm node (port_id) (node_id)
3039 Commit port traffic management hierarchy
3040 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3042 Commit the traffic management hierarchy on the port::
3044 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3048 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3049 call failure. On the other hand, hierarchy is preserved when this parameter
3052 Set port traffic management mark VLAN dei
3053 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3055 Enables/Disables the traffic management marking on the port for VLAN packets::
3057 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3061 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3062 ``yellow`` or ``red`` will have dei bit enabled
3064 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3066 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3068 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3070 Set port traffic management mark IP dscp
3071 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3073 Enables/Disables the traffic management marking on the port for IP dscp packets::
3075 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3079 * ``port_id``: The port which on which IP packets marked as ``green`` or
3080 ``yellow`` or ``red`` will have IP dscp bits updated
3082 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3084 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3086 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3088 Set port traffic management mark IP ecn
3089 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3091 Enables/Disables the traffic management marking on the port for IP ecn packets::
3093 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3097 * ``port_id``: The port which on which IP packets marked as ``green`` or
3098 ``yellow`` or ``red`` will have IP ecn bits updated
3100 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3101 to ecn of 2'b11 when IP is caring TCP or SCTP
3103 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3104 to ecn of 2'b11 when IP is caring TCP or SCTP
3106 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3107 to ecn of 2'b11 when IP is caring TCP or SCTP
3109 Set port traffic management default hierarchy (softnic forwarding mode)
3110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3112 set the traffic management default hierarchy on the port::
3114 testpmd> set port tm hierarchy default (port_id)
3119 This section details the available filter functions that are available.
3121 Note these functions interface the deprecated legacy filtering framework,
3122 superseded by *rte_flow*. See `Flow rules management`_.
3125 ~~~~~~~~~~~~~~~~~~~~
3127 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3129 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3130 ethertype (ether_type) (drop|fwd) queue (queue_id)
3132 The available information parameters are:
3134 * ``port_id``: The port which the Ethertype filter assigned on.
3136 * ``mac_addr``: Compare destination mac address.
3138 * ``mac_ignr``: Ignore destination mac address match.
3140 * ``mac_address``: Destination mac address to match.
3142 * ``ether_type``: The EtherType value want to match,
3143 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3145 * ``queue_id``: The receive queue associated with this EtherType filter.
3146 It is meaningless when deleting or dropping.
3148 Example, to add/remove an ethertype filter rule::
3150 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3151 ethertype 0x0806 fwd queue 3
3153 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3154 ethertype 0x0806 fwd queue 3
3159 Add or delete a 2-tuple filter,
3160 which identifies packets by specific protocol and destination TCP/UDP port
3161 and forwards packets into one of the receive queues::
3163 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3164 protocol (protocol_value) mask (mask_value) \
3165 tcp_flags (tcp_flags_value) priority (prio_value) \
3168 The available information parameters are:
3170 * ``port_id``: The port which the 2-tuple filter assigned on.
3172 * ``dst_port_value``: Destination port in L4.
3174 * ``protocol_value``: IP L4 protocol.
3176 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3178 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3180 * ``prio_value``: Priority of this filter.
3182 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3184 Example, to add/remove an 2tuple filter rule::
3186 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3187 tcp_flags 0x02 priority 3 queue 3
3189 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3190 tcp_flags 0x02 priority 3 queue 3
3195 Add or delete a 5-tuple filter,
3196 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3197 and routes packets into one of the receive queues::
3199 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3200 (src_address) dst_port (dst_port_value) \
3201 src_port (src_port_value) protocol (protocol_value) \
3202 mask (mask_value) tcp_flags (tcp_flags_value) \
3203 priority (prio_value) queue (queue_id)
3205 The available information parameters are:
3207 * ``port_id``: The port which the 5-tuple filter assigned on.
3209 * ``dst_address``: Destination IP address.
3211 * ``src_address``: Source IP address.
3213 * ``dst_port_value``: TCP/UDP destination port.
3215 * ``src_port_value``: TCP/UDP source port.
3217 * ``protocol_value``: L4 protocol.
3219 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3221 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3223 * ``prio_value``: The priority of this filter.
3225 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3227 Example, to add/remove an 5tuple filter rule::
3229 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3230 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3231 flags 0x0 priority 3 queue 3
3233 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3234 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3235 flags 0x0 priority 3 queue 3
3240 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3242 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3244 The available information parameters are:
3246 * ``port_id``: The port which the SYN filter assigned on.
3248 * ``high``: This SYN filter has higher priority than other filters.
3250 * ``low``: This SYN filter has lower priority than other filters.
3252 * ``queue_id``: The receive queue associated with this SYN filter
3256 testpmd> syn_filter 0 add priority high queue 3
3261 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3262 and routed into one of the receive queues::
3264 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3265 mask (mask_value) priority (prio_value) queue (queue_id)
3267 The available information parameters are:
3269 * ``port_id``: The port which the Flex filter is assigned on.
3271 * ``len_value``: Filter length in bytes, no greater than 128.
3273 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3275 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3277 * ``prio_value``: The priority of this filter.
3279 * ``queue_id``: The receive queue associated with this Flex filter.
3283 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3284 mask 000C priority 3 queue 3
3286 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3287 mask 000C priority 3 queue 3
3290 .. _testpmd_flow_director:
3292 flow_director_filter
3293 ~~~~~~~~~~~~~~~~~~~~
3295 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3297 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3298 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3300 * Perfect match filters.
3301 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3302 The masked fields are for IP flow.
3304 * Signature filters.
3305 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3307 * Perfect-mac-vlan match filters.
3308 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3309 The masked fields are for MAC VLAN flow.
3311 * Perfect-tunnel match filters.
3312 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3313 The masked fields are for tunnel flow.
3315 * Perfect-raw-flow-type match filters.
3316 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3317 The masked fields are specified by input sets.
3319 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3320 per flow type and the flexible payload.
3322 The Flow Director can also mask out parts of all of these fields so that filters
3323 are only applied to certain fields or parts of the fields.
3325 Note that for raw flow type mode the source and destination fields in the
3326 raw packet buffer need to be presented in a reversed order with respect
3327 to the expected received packets.
3328 For example: IP source and destination addresses or TCP/UDP/SCTP
3329 source and destination ports
3331 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3333 # Commands to add flow director filters of different flow types::
3335 flow_director_filter (port_id) mode IP (add|del|update) \
3336 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3337 src (src_ip_address) dst (dst_ip_address) \
3338 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3339 vlan (vlan_value) flexbytes (flexbytes_value) \
3340 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3343 flow_director_filter (port_id) mode IP (add|del|update) \
3344 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3345 src (src_ip_address) (src_port) \
3346 dst (dst_ip_address) (dst_port) \
3347 tos (tos_value) ttl (ttl_value) \
3348 vlan (vlan_value) flexbytes (flexbytes_value) \
3349 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3352 flow_director_filter (port_id) mode IP (add|del|update) \
3353 flow (ipv4-sctp|ipv6-sctp) \
3354 src (src_ip_address) (src_port) \
3355 dst (dst_ip_address) (dst_port) \
3356 tos (tos_value) ttl (ttl_value) \
3357 tag (verification_tag) vlan (vlan_value) \
3358 flexbytes (flexbytes_value) (drop|fwd) \
3359 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3361 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3362 ether (ethertype) flexbytes (flexbytes_value) \
3363 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3366 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3367 mac (mac_address) vlan (vlan_value) \
3368 flexbytes (flexbytes_value) (drop|fwd) \
3369 queue (queue_id) fd_id (fd_id_value)
3371 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3372 mac (mac_address) vlan (vlan_value) \
3373 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3374 flexbytes (flexbytes_value) (drop|fwd) \
3375 queue (queue_id) fd_id (fd_id_value)
3377 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3378 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3379 packet (packet file name)
3381 For example, to add an ipv4-udp flow type filter::
3383 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3384 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3385 fwd pf queue 1 fd_id 1
3387 For example, add an ipv4-other flow type filter::
3389 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3390 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3391 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3396 Flush all flow director filters on a device::
3398 testpmd> flush_flow_director (port_id)
3400 Example, to flush all flow director filter on port 0::
3402 testpmd> flush_flow_director 0
3407 Set flow director's input masks::
3409 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3410 src_mask (ipv4_src) (ipv6_src) (src_port) \
3411 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3413 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3415 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3416 mac (mac_value) tunnel-type (tunnel_type_value) \
3417 tunnel-id (tunnel_id_value)
3419 Example, to set flow director mask on port 0::
3421 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3422 src_mask 255.255.255.255 \
3423 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3424 dst_mask 255.255.255.255 \
3425 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3427 flow_director_flex_mask
3428 ~~~~~~~~~~~~~~~~~~~~~~~
3430 set masks of flow director's flexible payload based on certain flow type::
3432 testpmd> flow_director_flex_mask (port_id) \
3433 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3434 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3435 l2_payload|all) (mask)
3437 Example, to set flow director's flex mask for all flow type on port 0::
3439 testpmd> flow_director_flex_mask 0 flow all \
3440 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3443 flow_director_flex_payload
3444 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3446 Configure flexible payload selection::
3448 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3450 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3452 testpmd> flow_director_flex_payload 0 l4 \
3453 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3455 get_sym_hash_ena_per_port
3456 ~~~~~~~~~~~~~~~~~~~~~~~~~
3458 Get symmetric hash enable configuration per port::
3460 get_sym_hash_ena_per_port (port_id)
3462 For example, to get symmetric hash enable configuration of port 1::
3464 testpmd> get_sym_hash_ena_per_port 1
3466 set_sym_hash_ena_per_port
3467 ~~~~~~~~~~~~~~~~~~~~~~~~~
3469 Set symmetric hash enable configuration per port to enable or disable::
3471 set_sym_hash_ena_per_port (port_id) (enable|disable)
3473 For example, to set symmetric hash enable configuration of port 1 to enable::
3475 testpmd> set_sym_hash_ena_per_port 1 enable
3477 get_hash_global_config
3478 ~~~~~~~~~~~~~~~~~~~~~~
3480 Get the global configurations of hash filters::
3482 get_hash_global_config (port_id)
3484 For example, to get the global configurations of hash filters of port 1::
3486 testpmd> get_hash_global_config 1
3488 set_hash_global_config
3489 ~~~~~~~~~~~~~~~~~~~~~~
3491 Set the global configurations of hash filters::
3493 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3494 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3495 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3498 For example, to enable simple_xor for flow type of ipv6 on port 2::
3500 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3505 Set the input set for hash::
3507 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3508 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3509 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3510 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3511 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3512 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3513 fld-8th|none) (select|add)
3515 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3517 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3522 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3523 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3525 Set the input set for flow director::
3527 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3528 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3529 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3530 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3531 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3532 sctp-dst-port|sctp-veri-tag|none) (select|add)
3534 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3536 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3541 Set different GRE key length for input set::
3543 global_config (port_id) gre-key-len (number in bytes)
3545 For example to set GRE key length for input set to 4 bytes on port 0::
3547 testpmd> global_config 0 gre-key-len 4
3550 .. _testpmd_rte_flow:
3552 Flow rules management
3553 ---------------------
3555 Control of the generic flow API (*rte_flow*) is fully exposed through the
3556 ``flow`` command (validation, creation, destruction, queries and operation
3559 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3560 features simultaneously may cause undefined side-effects and is therefore
3566 Because the ``flow`` command uses dynamic tokens to handle the large number
3567 of possible flow rules combinations, its behavior differs slightly from
3568 other commands, in particular:
3570 - Pressing *?* or the *<tab>* key displays contextual help for the current
3571 token, not that of the entire command.
3573 - Optional and repeated parameters are supported (provided they are listed
3574 in the contextual help).
3576 The first parameter stands for the operation mode. Possible operations and
3577 their general syntax are described below. They are covered in detail in the
3580 - Check whether a flow rule can be created::
3582 flow validate {port_id}
3583 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3584 pattern {item} [/ {item} [...]] / end
3585 actions {action} [/ {action} [...]] / end
3587 - Create a flow rule::
3589 flow create {port_id}
3590 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3591 pattern {item} [/ {item} [...]] / end
3592 actions {action} [/ {action} [...]] / end
3594 - Destroy specific flow rules::
3596 flow destroy {port_id} rule {rule_id} [...]
3598 - Destroy all flow rules::
3600 flow flush {port_id}
3602 - Query an existing flow rule::
3604 flow query {port_id} {rule_id} {action}
3606 - List existing flow rules sorted by priority, filtered by group
3609 flow list {port_id} [group {group_id}] [...]
3611 - Restrict ingress traffic to the defined flow rules::
3613 flow isolate {port_id} {boolean}
3615 - Dump internal representation information of all flows in hardware::
3617 flow dump {port_id} {output_file}
3619 - List and destroy aged flow rules::
3621 flow aged {port_id} [destroy]
3623 Validating flow rules
3624 ~~~~~~~~~~~~~~~~~~~~~
3626 ``flow validate`` reports whether a flow rule would be accepted by the
3627 underlying device in its current state but stops short of creating it. It is
3628 bound to ``rte_flow_validate()``::
3630 flow validate {port_id}
3631 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3632 pattern {item} [/ {item} [...]] / end
3633 actions {action} [/ {action} [...]] / end
3635 If successful, it will show::
3639 Otherwise it will show an error message of the form::
3641 Caught error type [...] ([...]): [...]
3643 This command uses the same parameters as ``flow create``, their format is
3644 described in `Creating flow rules`_.
3646 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3647 index 6 is supported::
3649 testpmd> flow validate 0 ingress pattern eth / end
3650 actions queue index 6 / end
3654 Port 0 does not support TCPv6 rules::
3656 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3658 Caught error type 9 (specific pattern item): Invalid argument
3664 ``flow create`` validates and creates the specified flow rule. It is bound
3665 to ``rte_flow_create()``::
3667 flow create {port_id}
3668 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3669 pattern {item} [/ {item} [...]] / end
3670 actions {action} [/ {action} [...]] / end
3672 If successful, it will return a flow rule ID usable with other commands::
3674 Flow rule #[...] created
3676 Otherwise it will show an error message of the form::
3678 Caught error type [...] ([...]): [...]
3680 Parameters describe in the following order:
3682 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3683 - A matching pattern, starting with the *pattern* token and terminated by an
3685 - Actions, starting with the *actions* token and terminated by an *end*
3688 These translate directly to *rte_flow* objects provided as-is to the
3689 underlying functions.
3691 The shortest valid definition only comprises mandatory tokens::
3693 testpmd> flow create 0 pattern end actions end
3695 Note that PMDs may refuse rules that essentially do nothing such as this
3698 **All unspecified object values are automatically initialized to 0.**
3703 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3704 specified before the ``pattern`` token.
3706 - ``group {group id}``: priority group.
3707 - ``priority {level}``: priority level within group.
3708 - ``ingress``: rule applies to ingress traffic.
3709 - ``egress``: rule applies to egress traffic.
3710 - ``transfer``: apply rule directly to endpoints found in pattern.
3712 Each instance of an attribute specified several times overrides the previous
3713 value as shown below (group 4 is used)::
3715 testpmd> flow create 0 group 42 group 24 group 4 [...]
3717 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3719 While not specifying a direction is an error, some rules may allow both
3722 Most rules affect RX therefore contain the ``ingress`` token::
3724 testpmd> flow create 0 ingress pattern [...]
3729 A matching pattern starts after the ``pattern`` token. It is made of pattern
3730 items and is terminated by a mandatory ``end`` item.
3732 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3733 rte_flow_item_type``).
3735 The ``/`` token is used as a separator between pattern items as shown
3738 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3740 Note that protocol items like these must be stacked from lowest to highest
3741 layer to make sense. For instance, the following rule is either invalid or
3742 unlikely to match any packet::
3744 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3746 More information on these restrictions can be found in the *rte_flow*
3749 Several items support additional specification structures, for example
3750 ``ipv4`` allows specifying source and destination addresses as follows::
3752 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3753 dst is 10.2.0.0 / end [...]
3755 This rule matches all IPv4 traffic with the specified properties.
3757 In this example, ``src`` and ``dst`` are field names of the underlying
3758 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3759 in a similar fashion.
3761 The ``is`` token means that the subsequent value must be matched exactly,
3762 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3763 accordingly. Possible assignment tokens are:
3765 - ``is``: match value perfectly (with full bit-mask).
3766 - ``spec``: match value according to configured bit-mask.
3767 - ``last``: specify upper bound to establish a range.
3768 - ``mask``: specify bit-mask with relevant bits set to one.
3769 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3771 These yield identical results::
3773 ipv4 src is 10.1.1.1
3777 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3781 ipv4 src spec 10.1.1.1 src prefix 32
3785 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3789 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3791 Inclusive ranges can be defined with ``last``::
3793 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3795 Note that ``mask`` affects both ``spec`` and ``last``::
3797 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3798 # matches 10.1.0.0 to 10.2.255.255
3800 Properties can be modified multiple times::
3802 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3806 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3811 This section lists supported pattern items and their attributes, if any.
3813 - ``end``: end list of pattern items.
3815 - ``void``: no-op pattern item.
3817 - ``invert``: perform actions when pattern does not match.
3819 - ``any``: match any protocol for the current layer.
3821 - ``num {unsigned}``: number of layers covered.
3823 - ``pf``: match traffic from/to the physical function.
3825 - ``vf``: match traffic from/to a virtual function ID.
3827 - ``id {unsigned}``: VF ID.
3829 - ``phy_port``: match traffic from/to a specific physical port.
3831 - ``index {unsigned}``: physical port index.
3833 - ``port_id``: match traffic from/to a given DPDK port ID.
3835 - ``id {unsigned}``: DPDK port ID.
3837 - ``mark``: match value set in previously matched flow rule using the mark action.
3839 - ``id {unsigned}``: arbitrary integer value.
3841 - ``raw``: match an arbitrary byte string.
3843 - ``relative {boolean}``: look for pattern after the previous item.
3844 - ``search {boolean}``: search pattern from offset (see also limit).
3845 - ``offset {integer}``: absolute or relative offset for pattern.
3846 - ``limit {unsigned}``: search area limit for start of pattern.
3847 - ``pattern {string}``: byte string to look for.
3849 - ``eth``: match Ethernet header.
3851 - ``dst {MAC-48}``: destination MAC.
3852 - ``src {MAC-48}``: source MAC.
3853 - ``type {unsigned}``: EtherType or TPID.
3855 - ``vlan``: match 802.1Q/ad VLAN tag.
3857 - ``tci {unsigned}``: tag control information.
3858 - ``pcp {unsigned}``: priority code point.
3859 - ``dei {unsigned}``: drop eligible indicator.
3860 - ``vid {unsigned}``: VLAN identifier.
3861 - ``inner_type {unsigned}``: inner EtherType or TPID.
3863 - ``ipv4``: match IPv4 header.
3865 - ``tos {unsigned}``: type of service.
3866 - ``ttl {unsigned}``: time to live.
3867 - ``proto {unsigned}``: next protocol ID.
3868 - ``src {ipv4 address}``: source address.
3869 - ``dst {ipv4 address}``: destination address.
3871 - ``ipv6``: match IPv6 header.
3873 - ``tc {unsigned}``: traffic class.
3874 - ``flow {unsigned}``: flow label.
3875 - ``proto {unsigned}``: protocol (next header).
3876 - ``hop {unsigned}``: hop limit.
3877 - ``src {ipv6 address}``: source address.
3878 - ``dst {ipv6 address}``: destination address.
3880 - ``icmp``: match ICMP header.
3882 - ``type {unsigned}``: ICMP packet type.
3883 - ``code {unsigned}``: ICMP packet code.
3885 - ``udp``: match UDP header.
3887 - ``src {unsigned}``: UDP source port.
3888 - ``dst {unsigned}``: UDP destination port.
3890 - ``tcp``: match TCP header.
3892 - ``src {unsigned}``: TCP source port.
3893 - ``dst {unsigned}``: TCP destination port.
3895 - ``sctp``: match SCTP header.
3897 - ``src {unsigned}``: SCTP source port.
3898 - ``dst {unsigned}``: SCTP destination port.
3899 - ``tag {unsigned}``: validation tag.
3900 - ``cksum {unsigned}``: checksum.
3902 - ``vxlan``: match VXLAN header.
3904 - ``vni {unsigned}``: VXLAN identifier.
3906 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3908 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3910 - ``nvgre``: match NVGRE header.
3912 - ``tni {unsigned}``: virtual subnet ID.
3914 - ``mpls``: match MPLS header.
3916 - ``label {unsigned}``: MPLS label.
3918 - ``gre``: match GRE header.
3920 - ``protocol {unsigned}``: protocol type.
3922 - ``gre_key``: match GRE optional key field.
3924 - ``value {unsigned}``: key value.
3926 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3928 - ``thresh {unsigned}``: accuracy threshold.
3930 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3932 - ``teid {unsigned}``: tunnel endpoint identifier.
3934 - ``geneve``: match GENEVE header.
3936 - ``vni {unsigned}``: virtual network identifier.
3937 - ``protocol {unsigned}``: protocol type.
3939 - ``vxlan-gpe``: match VXLAN-GPE header.
3941 - ``vni {unsigned}``: VXLAN-GPE identifier.
3943 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3945 - ``sha {MAC-48}``: sender hardware address.
3946 - ``spa {ipv4 address}``: sender IPv4 address.
3947 - ``tha {MAC-48}``: target hardware address.
3948 - ``tpa {ipv4 address}``: target IPv4 address.
3950 - ``ipv6_ext``: match presence of any IPv6 extension header.
3952 - ``next_hdr {unsigned}``: next header.
3954 - ``icmp6``: match any ICMPv6 header.
3956 - ``type {unsigned}``: ICMPv6 type.
3957 - ``code {unsigned}``: ICMPv6 code.
3959 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3961 - ``target_addr {ipv6 address}``: target address.
3963 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3965 - ``target_addr {ipv6 address}``: target address.
3967 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3969 - ``type {unsigned}``: ND option type.
3971 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3972 link-layer address option.
3974 - ``sla {MAC-48}``: source Ethernet LLA.
3976 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3977 link-layer address option.
3979 - ``tla {MAC-48}``: target Ethernet LLA.
3981 - ``meta``: match application specific metadata.
3983 - ``data {unsigned}``: metadata value.
3985 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3987 - ``pdu_type {unsigned}``: PDU type.
3988 - ``qfi {unsigned}``: QoS flow identifier.
3990 - ``pppoes``, ``pppoed``: match PPPoE header.
3992 - ``session_id {unsigned}``: session identifier.
3994 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3996 - ``proto_id {unsigned}``: PPP protocol identifier.
3998 - ``l2tpv3oip``: match L2TPv3 over IP header.
4000 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
4002 - ``ah``: match AH header.
4004 - ``spi {unsigned}``: security parameters index.
4006 - ``pfcp``: match PFCP header.
4008 - ``s_field {unsigned}``: S field.
4009 - ``seid {unsigned}``: session endpoint identifier.
4014 A list of actions starts after the ``actions`` token in the same fashion as
4015 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
4016 terminated by a mandatory ``end`` action.
4018 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
4019 rte_flow_action_type``).
4021 Dropping all incoming UDPv4 packets can be expressed as follows::
4023 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4026 Several actions have configurable properties which must be specified when
4027 there is no valid default value. For example, ``queue`` requires a target
4030 This rule redirects incoming UDPv4 traffic to queue index 6::
4032 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4033 actions queue index 6 / end
4035 While this one could be rejected by PMDs (unspecified queue index)::
4037 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4040 As defined by *rte_flow*, the list is not ordered, all actions of a given
4041 rule are performed simultaneously. These are equivalent::
4043 queue index 6 / void / mark id 42 / end
4047 void / mark id 42 / queue index 6 / end
4049 All actions in a list should have different types, otherwise only the last
4050 action of a given type is taken into account::
4052 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4056 drop / drop / drop / end # drop is performed only once
4060 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4062 Considering they are performed simultaneously, opposite and overlapping
4063 actions can sometimes be combined when the end result is unambiguous::
4065 drop / queue index 6 / end # drop has no effect
4069 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4073 drop / passthru / end # drop has no effect
4075 Note that PMDs may still refuse such combinations.
4080 This section lists supported actions and their attributes, if any.
4082 - ``end``: end list of actions.
4084 - ``void``: no-op action.
4086 - ``passthru``: let subsequent rule process matched packets.
4088 - ``jump``: redirect traffic to group on device.
4090 - ``group {unsigned}``: group to redirect to.
4092 - ``mark``: attach 32 bit value to packets.
4094 - ``id {unsigned}``: 32 bit value to return with packets.
4096 - ``flag``: flag packets.
4098 - ``queue``: assign packets to a given queue index.
4100 - ``index {unsigned}``: queue index to use.
4102 - ``drop``: drop packets (note: passthru has priority).
4104 - ``count``: enable counters for this rule.
4106 - ``rss``: spread packets among several queues.
4108 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4109 the same as `set_hash_global_config`_.
4111 - ``level {unsigned}``: encapsulation level for ``types``.
4113 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4114 tokens are the same as `set_hash_input_set`_, except that an empty list
4115 does not disable RSS but instead requests unspecified "best-effort"
4118 - ``key {string}``: RSS hash key, overrides ``key_len``.
4120 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4121 conjunction with ``key`` to pad or truncate it.
4123 - ``queues [{unsigned} [...]] end``: queue indices to use.
4125 - ``pf``: direct traffic to physical function.
4127 - ``vf``: direct traffic to a virtual function ID.
4129 - ``original {boolean}``: use original VF ID if possible.
4130 - ``id {unsigned}``: VF ID.
4132 - ``phy_port``: direct packets to physical port index.
4134 - ``original {boolean}``: use original port index if possible.
4135 - ``index {unsigned}``: physical port index.
4137 - ``port_id``: direct matching traffic to a given DPDK port ID.
4139 - ``original {boolean}``: use original DPDK port ID if possible.
4140 - ``id {unsigned}``: DPDK port ID.
4142 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4144 - ``mpls_ttl``: MPLS TTL.
4146 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4148 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4150 - ``nw_ttl``: IP TTL.
4152 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4154 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4156 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4158 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4160 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4162 - ``ethertype``: Ethertype.
4164 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4166 - ``vlan_vid``: VLAN id.
4168 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4170 - ``vlan_pcp``: VLAN priority.
4172 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4174 - ``ethertype``: Ethertype.
4176 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4178 - ``ethertype``: Ethertype.
4180 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4181 is done through `Config VXLAN Encap outer layers`_.
4183 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4184 the VXLAN tunnel network overlay from the matched flow.
4186 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4187 is done through `Config NVGRE Encap outer layers`_.
4189 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4190 the NVGRE tunnel network overlay from the matched flow.
4192 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4193 is done through `Config L2 Encap`_.
4195 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4196 is done through `Config L2 Decap`_.
4198 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4199 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4201 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4202 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4204 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4205 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4207 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4208 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4210 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4212 - ``ipv4_addr``: New IPv4 source address.
4214 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4217 - ``ipv4_addr``: New IPv4 destination address.
4219 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4221 - ``ipv6_addr``: New IPv6 source address.
4223 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4226 - ``ipv6_addr``: New IPv6 destination address.
4228 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4231 - ``port``: New TCP/UDP source port number.
4233 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4236 - ``port``: New TCP/UDP destination port number.
4238 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4241 - ``dec_ttl``: Performs a decrease TTL value action
4243 - ``set_ttl``: Set TTL value with specified value
4244 - ``ttl_value {unsigned}``: The new TTL value to be set
4246 - ``set_mac_src``: set source MAC address
4248 - ``mac_addr {MAC-48}``: new source MAC address
4250 - ``set_mac_dst``: set destination MAC address
4252 - ``mac_addr {MAC-48}``: new destination MAC address
4254 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4256 - ``value {unsigned}``: Value to increase TCP sequence number by.
4258 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4260 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4262 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4264 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4266 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4268 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4270 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4272 - ``dscp_value {unsigned}``: The new DSCP value to be set
4274 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4276 - ``dscp_value {unsigned}``: The new DSCP value to be set
4278 Destroying flow rules
4279 ~~~~~~~~~~~~~~~~~~~~~
4281 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4282 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4283 times as necessary::
4285 flow destroy {port_id} rule {rule_id} [...]
4287 If successful, it will show::
4289 Flow rule #[...] destroyed
4291 It does not report anything for rule IDs that do not exist. The usual error
4292 message is shown when a rule cannot be destroyed::
4294 Caught error type [...] ([...]): [...]
4296 ``flow flush`` destroys all rules on a device and does not take extra
4297 arguments. It is bound to ``rte_flow_flush()``::
4299 flow flush {port_id}
4301 Any errors are reported as above.
4303 Creating several rules and destroying them::
4305 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4306 actions queue index 2 / end
4307 Flow rule #0 created
4308 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4309 actions queue index 3 / end
4310 Flow rule #1 created
4311 testpmd> flow destroy 0 rule 0 rule 1
4312 Flow rule #1 destroyed
4313 Flow rule #0 destroyed
4316 The same result can be achieved using ``flow flush``::
4318 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4319 actions queue index 2 / end
4320 Flow rule #0 created
4321 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4322 actions queue index 3 / end
4323 Flow rule #1 created
4324 testpmd> flow flush 0
4327 Non-existent rule IDs are ignored::
4329 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4330 actions queue index 2 / end
4331 Flow rule #0 created
4332 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4333 actions queue index 3 / end
4334 Flow rule #1 created
4335 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4337 testpmd> flow destroy 0 rule 0
4338 Flow rule #0 destroyed
4344 ``flow query`` queries a specific action of a flow rule having that
4345 ability. Such actions collect information that can be reported using this
4346 command. It is bound to ``rte_flow_query()``::
4348 flow query {port_id} {rule_id} {action}
4350 If successful, it will display either the retrieved data for known actions
4351 or the following message::
4353 Cannot display result for action type [...] ([...])
4355 Otherwise, it will complain either that the rule does not exist or that some
4358 Flow rule #[...] not found
4362 Caught error type [...] ([...]): [...]
4364 Currently only the ``count`` action is supported. This action reports the
4365 number of packets that hit the flow rule and the total number of bytes. Its
4366 output has the following format::
4369 hits_set: [...] # whether "hits" contains a valid value
4370 bytes_set: [...] # whether "bytes" contains a valid value
4371 hits: [...] # number of packets
4372 bytes: [...] # number of bytes
4374 Querying counters for TCPv6 packets redirected to queue 6::
4376 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4377 actions queue index 6 / count / end
4378 Flow rule #4 created
4379 testpmd> flow query 0 4 count
4390 ``flow list`` lists existing flow rules sorted by priority and optionally
4391 filtered by group identifiers::
4393 flow list {port_id} [group {group_id}] [...]
4395 This command only fails with the following message if the device does not
4400 Output consists of a header line followed by a short description of each
4401 flow rule, one per line. There is no output at all when no flow rules are
4402 configured on the device::
4404 ID Group Prio Attr Rule
4405 [...] [...] [...] [...] [...]
4407 ``Attr`` column flags:
4409 - ``i`` for ``ingress``.
4410 - ``e`` for ``egress``.
4412 Creating several flow rules and listing them::
4414 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4415 actions queue index 6 / end
4416 Flow rule #0 created
4417 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4418 actions queue index 2 / end
4419 Flow rule #1 created
4420 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4421 actions rss queues 6 7 8 end / end
4422 Flow rule #2 created
4423 testpmd> flow list 0
4424 ID Group Prio Attr Rule
4425 0 0 0 i- ETH IPV4 => QUEUE
4426 1 0 0 i- ETH IPV6 => QUEUE
4427 2 0 5 i- ETH IPV4 UDP => RSS
4430 Rules are sorted by priority (i.e. group ID first, then priority level)::
4432 testpmd> flow list 1
4433 ID Group Prio Attr Rule
4434 0 0 0 i- ETH => COUNT
4435 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4436 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4437 1 24 0 i- ETH IPV4 UDP => QUEUE
4438 4 24 10 i- ETH IPV4 TCP => DROP
4439 3 24 20 i- ETH IPV4 => DROP
4440 2 24 42 i- ETH IPV4 UDP => QUEUE
4441 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4444 Output can be limited to specific groups::
4446 testpmd> flow list 1 group 0 group 63
4447 ID Group Prio Attr Rule
4448 0 0 0 i- ETH => COUNT
4449 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4450 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4451 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4454 Toggling isolated mode
4455 ~~~~~~~~~~~~~~~~~~~~~~
4457 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4458 must only be injected from the defined flow rules; that no default traffic
4459 is expected outside those rules and the driver is free to assign more
4460 resources to handle them. It is bound to ``rte_flow_isolate()``::
4462 flow isolate {port_id} {boolean}
4464 If successful, enabling or disabling isolated mode shows either::
4466 Ingress traffic on port [...]
4467 is now restricted to the defined flow rules
4471 Ingress traffic on port [...]
4472 is not restricted anymore to the defined flow rules
4474 Otherwise, in case of error::
4476 Caught error type [...] ([...]): [...]
4478 Mainly due to its side effects, PMDs supporting this mode may not have the
4479 ability to toggle it more than once without reinitializing affected ports
4480 first (e.g. by exiting testpmd).
4482 Enabling isolated mode::
4484 testpmd> flow isolate 0 true
4485 Ingress traffic on port 0 is now restricted to the defined flow rules
4488 Disabling isolated mode::
4490 testpmd> flow isolate 0 false
4491 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4494 Dumping HW internal information
4495 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4497 ``flow dump`` dumps the hardware's internal representation information of
4498 all flows. It is bound to ``rte_flow_dev_dump()``::
4500 flow dump {port_id} {output_file}
4502 If successful, it will show::
4506 Otherwise, it will complain error occurred::
4508 Caught error type [...] ([...]): [...]
4510 Listing and destroying aged flow rules
4511 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4513 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4514 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4516 flow aged {port_id} [destroy]
4518 Listing current aged flow rules::
4520 testpmd> flow aged 0
4521 Port 0 total aged flows: 0
4522 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4523 actions age timeout 5 / queue index 0 / end
4524 Flow rule #0 created
4525 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4526 actions age timeout 4 / queue index 0 / end
4527 Flow rule #1 created
4528 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4529 actions age timeout 2 / queue index 0 / end
4530 Flow rule #2 created
4531 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4532 actions age timeout 3 / queue index 0 / end
4533 Flow rule #3 created
4536 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4537 information, all the aged flows are sorted by the longest timeout time. For example, if
4538 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4539 will be ID 3, ID 1, ID 0::
4541 testpmd> flow aged 0
4542 Port 0 total aged flows: 4
4549 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4551 testpmd> flow aged 0 destroy
4552 Port 0 total aged flows: 4
4559 Flow rule #2 destroyed
4560 Flow rule #3 destroyed
4561 Flow rule #1 destroyed
4562 Flow rule #0 destroyed
4563 4 flows be destroyed
4564 testpmd> flow aged 0
4565 Port 0 total aged flows: 0
4568 Sample QinQ flow rules
4569 ~~~~~~~~~~~~~~~~~~~~~~
4571 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4573 testpmd> port stop 0
4574 testpmd> vlan set qinq_strip on 0
4576 The above command sets the inner and outer TPID's to 0x8100.
4578 To change the TPID's the following commands should be used::
4580 testpmd> vlan set outer tpid 0xa100 0
4581 testpmd> vlan set inner tpid 0x9100 0
4582 testpmd> port start 0
4584 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4588 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4589 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4590 Flow rule #0 validated
4592 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4593 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4594 Flow rule #0 created
4596 testpmd> flow list 0
4597 ID Group Prio Attr Rule
4598 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4600 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4604 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4605 vlan tci is 654 / end actions pf / queue index 0 / end
4606 Flow rule #1 validated
4608 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4609 vlan tci is 654 / end actions pf / queue index 1 / end
4610 Flow rule #1 created
4612 testpmd> flow list 0
4613 ID Group Prio Attr Rule
4614 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4615 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4617 Sample VXLAN encapsulation rule
4618 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4620 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4621 source code, those can be changed by using the following commands
4623 IPv4 VXLAN outer header::
4625 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4626 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4627 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4630 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4631 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4632 eth-dst 22:22:22:22:22:22
4633 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4636 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4637 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4638 eth-dst 22:22:22:22:22:22
4639 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4642 IPv6 VXLAN outer header::
4644 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4645 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4646 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4649 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4650 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4651 eth-dst 22:22:22:22:22:22
4652 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4655 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4656 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4657 eth-dst 22:22:22:22:22:22
4658 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4661 Sample NVGRE encapsulation rule
4662 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4664 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4665 source code, those can be changed by using the following commands
4667 IPv4 NVGRE outer header::
4669 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4670 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4671 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4674 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4675 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4676 eth-dst 22:22:22:22:22:22
4677 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4680 IPv6 NVGRE outer header::
4682 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4683 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4684 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4687 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4688 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4689 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4692 Sample L2 encapsulation rule
4693 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4695 L2 encapsulation has default value pre-configured in testpmd
4696 source code, those can be changed by using the following commands
4700 testpmd> set l2_encap ip-version ipv4
4701 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4702 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4703 mplsoudp_decap / l2_encap / end
4705 L2 with VXLAN header::
4707 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4708 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4709 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4710 mplsoudp_decap / l2_encap / end
4712 Sample L2 decapsulation rule
4713 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4715 L2 decapsulation has default value pre-configured in testpmd
4716 source code, those can be changed by using the following commands
4720 testpmd> set l2_decap
4721 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4724 L2 with VXLAN header::
4726 testpmd> set l2_encap-with-vlan
4727 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4730 Sample MPLSoGRE encapsulation rule
4731 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4733 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4734 source code, those can be changed by using the following commands
4736 IPv4 MPLSoGRE outer header::
4738 testpmd> set mplsogre_encap ip-version ipv4 label 4
4739 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4740 eth-dst 22:22:22:22:22:22
4741 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4742 mplsogre_encap / end
4744 IPv4 MPLSoGRE with VLAN outer header::
4746 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4747 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4748 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4749 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4750 mplsogre_encap / end
4752 IPv6 MPLSoGRE outer header::
4754 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4755 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4756 eth-dst 22:22:22:22:22:22
4757 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4758 mplsogre_encap / end
4760 IPv6 MPLSoGRE with VLAN outer header::
4762 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4763 ip-src ::1 ip-dst ::2222 vlan-tci 34
4764 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4765 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4766 mplsogre_encap / end
4768 Sample MPLSoGRE decapsulation rule
4769 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4771 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4772 source code, those can be changed by using the following commands
4774 IPv4 MPLSoGRE outer header::
4776 testpmd> set mplsogre_decap ip-version ipv4
4777 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4778 mplsogre_decap / l2_encap / end
4780 IPv4 MPLSoGRE with VLAN outer header::
4782 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4783 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4784 actions mplsogre_decap / l2_encap / end
4786 IPv6 MPLSoGRE outer header::
4788 testpmd> set mplsogre_decap ip-version ipv6
4789 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4790 actions mplsogre_decap / l2_encap / end
4792 IPv6 MPLSoGRE with VLAN outer header::
4794 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4795 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4796 actions mplsogre_decap / l2_encap / end
4798 Sample MPLSoUDP encapsulation rule
4799 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4801 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4802 source code, those can be changed by using the following commands
4804 IPv4 MPLSoUDP outer header::
4806 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4807 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4808 eth-dst 22:22:22:22:22:22
4809 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4810 mplsoudp_encap / end
4812 IPv4 MPLSoUDP with VLAN outer header::
4814 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4815 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4816 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4817 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4818 mplsoudp_encap / end
4820 IPv6 MPLSoUDP outer header::
4822 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4823 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4824 eth-dst 22:22:22:22:22:22
4825 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4826 mplsoudp_encap / end
4828 IPv6 MPLSoUDP with VLAN outer header::
4830 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4831 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4832 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4833 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4834 mplsoudp_encap / end
4836 Sample MPLSoUDP decapsulation rule
4837 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4839 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4840 source code, those can be changed by using the following commands
4842 IPv4 MPLSoUDP outer header::
4844 testpmd> set mplsoudp_decap ip-version ipv4
4845 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4846 mplsoudp_decap / l2_encap / end
4848 IPv4 MPLSoUDP with VLAN outer header::
4850 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4851 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4852 actions mplsoudp_decap / l2_encap / end
4854 IPv6 MPLSoUDP outer header::
4856 testpmd> set mplsoudp_decap ip-version ipv6
4857 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4858 actions mplsoudp_decap / l2_encap / end
4860 IPv6 MPLSoUDP with VLAN outer header::
4862 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4863 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4864 actions mplsoudp_decap / l2_encap / end
4866 Sample Raw encapsulation rule
4867 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4869 Raw encapsulation configuration can be set by the following commands
4871 Eecapsulating VxLAN::
4873 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4874 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4876 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4877 raw_encap index 4 / end
4879 Sample Raw decapsulation rule
4880 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4882 Raw decapsulation configuration can be set by the following commands
4884 Decapsulating VxLAN::
4886 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4887 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4888 end actions raw_decap / queue index 0 / end
4893 ESP rules can be created by the following commands::
4895 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
4897 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
4898 actions queue index 3 / end
4899 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
4901 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
4902 actions queue index 3 / end
4907 AH rules can be created by the following commands::
4909 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
4911 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
4912 actions queue index 3 / end
4913 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
4915 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
4916 actions queue index 3 / end
4921 PFCP rules can be created by the following commands(s_field need to be 1
4924 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
4925 actions queue index 3 / end
4926 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
4927 seid is 1 / end actions queue index 3 / end
4928 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
4929 actions queue index 3 / end
4930 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
4931 seid is 1 / end actions queue index 3 / end
4936 The following sections show functions to load/unload eBPF based filters.
4941 Load an eBPF program as a callback for particular RX/TX queue::
4943 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4945 The available load-flags are:
4947 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4949 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4955 You'll need clang v3.7 or above to build bpf program you'd like to load
4959 .. code-block:: console
4962 clang -O2 -target bpf -c t1.c
4964 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4966 .. code-block:: console
4968 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4970 To load (not JITed) t1.o at TX queue 0, port 0:
4972 .. code-block:: console
4974 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4979 Unload previously loaded eBPF program for particular RX/TX queue::
4981 testpmd> bpf-unload rx|tx (portid) (queueid)
4983 For example to unload BPF filter from TX queue 0, port 0:
4985 .. code-block:: console
4987 testpmd> bpf-unload tx 0 0