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 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
546 Dumps the size of all memory structures::
548 testpmd> dump_struct_sizes
553 Dumps the status of all or specific element in DPDK rings::
555 testpmd> dump_ring [ring_name]
560 Dumps the statistics of all or specific memory pool::
562 testpmd> dump_mempool [mempool_name]
567 Dumps the user device list::
569 testpmd> dump_devargs
574 Dumps the log level for all the dpdk modules::
576 testpmd> dump_log_types
578 show (raw_encap|raw_decap)
579 ~~~~~~~~~~~~~~~~~~~~~~~~~~
581 Display content of raw_encap/raw_decap buffers in hex::
583 testpmd> show <raw_encap|raw_decap> <index>
584 testpmd> show <raw_encap|raw_decap> all
588 testpmd> show raw_encap 6
590 index: 6 at [0x1c565b0], len=50
591 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
592 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
593 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
597 Configuration Functions
598 -----------------------
600 The testpmd application can be configured from the runtime as well as from the command-line.
602 This section details the available configuration functions that are available.
606 Configuration changes only become active when forwarding is started/restarted.
611 Reset forwarding to the default configuration::
618 Set the debug verbosity level::
620 testpmd> set verbose (level)
622 Available levels are as following:
624 * ``0`` silent except for error.
625 * ``1`` fully verbose except for Tx packets.
626 * ``2`` fully verbose except for Rx packets.
627 * ``> 2`` fully verbose.
632 Set the log level for a log type::
634 testpmd> set log global|(type) (level)
638 * ``type`` is the log name.
640 * ``level`` is the log level.
642 For example, to change the global log level::
644 testpmd> set log global (level)
646 Regexes can also be used for type. To change log level of user1, user2 and user3::
648 testpmd> set log user[1-3] (level)
653 Set the number of ports used by the application:
657 This is equivalent to the ``--nb-ports`` command-line option.
662 Set the number of cores used by the application::
664 testpmd> set nbcore (num)
666 This is equivalent to the ``--nb-cores`` command-line option.
670 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
675 Set the forwarding cores hexadecimal mask::
677 testpmd> set coremask (mask)
679 This is equivalent to the ``--coremask`` command-line option.
683 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
688 Set the forwarding ports hexadecimal mask::
690 testpmd> set portmask (mask)
692 This is equivalent to the ``--portmask`` command-line option.
697 Set number of packets per burst::
699 testpmd> set burst (num)
701 This is equivalent to the ``--burst command-line`` option.
703 When retry is enabled, the transmit delay time and number of retries can also be set::
705 testpmd> set burst tx delay (microseconds) retry (num)
710 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
712 testpmd> set txpkts (x[,y]*)
714 Where x[,y]* represents a CSV list of values, without white space.
719 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
721 testpmd> set txsplit (off|on|rand)
725 * ``off`` disable packet copy & split for CSUM mode.
727 * ``on`` split outgoing packet into multiple segments. Size of each segment
728 and number of segments per packet is determined by ``set txpkts`` command
731 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
736 Set the list of forwarding cores::
738 testpmd> set corelist (x[,y]*)
740 For example, to change the forwarding cores:
742 .. code-block:: console
744 testpmd> set corelist 3,1
745 testpmd> show config fwd
747 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
748 Logical Core 3 (socket 0) forwards packets on 1 streams:
749 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
750 Logical Core 1 (socket 0) forwards packets on 1 streams:
751 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
755 The cores are used in the same order as specified on the command line.
760 Set the list of forwarding ports::
762 testpmd> set portlist (x[,y]*)
764 For example, to change the port forwarding:
766 .. code-block:: console
768 testpmd> set portlist 0,2,1,3
769 testpmd> show config fwd
771 io packet forwarding - ports=4 - cores=1 - streams=4
772 Logical Core 3 (socket 0) forwards packets on 4 streams:
773 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
774 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
775 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
776 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
781 Select how to retrieve new ports created after "port attach" command::
783 testpmd> set port setup on (iterator|event)
785 For each new port, a setup is done.
786 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
787 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
792 Enable/disable tx loopback::
794 testpmd> set tx loopback (port_id) (on|off)
799 set drop enable bit for all queues::
801 testpmd> set all queues drop (port_id) (on|off)
803 set split drop enable (for VF)
804 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
806 set split drop enable bit for VF from PF::
808 testpmd> set vf split drop (port_id) (vf_id) (on|off)
810 set mac antispoof (for VF)
811 ~~~~~~~~~~~~~~~~~~~~~~~~~~
813 Set mac antispoof for a VF from the PF::
815 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
820 Enable/disable MACsec offload::
822 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
823 testpmd> set macsec offload (port_id) off
828 Configure MACsec secure connection (SC)::
830 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
834 The pi argument is ignored for tx.
835 Check the NIC Datasheet for hardware limits.
840 Configure MACsec secure association (SA)::
842 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
846 The IDX value must be 0 or 1.
847 Check the NIC Datasheet for hardware limits.
849 set broadcast mode (for VF)
850 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
852 Set broadcast mode for a VF from the PF::
854 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
859 Set the VLAN strip for a queue on a port::
861 testpmd> vlan set stripq (on|off) (port_id,queue_id)
863 vlan set stripq (for VF)
864 ~~~~~~~~~~~~~~~~~~~~~~~~
866 Set VLAN strip for all queues in a pool for a VF from the PF::
868 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
870 vlan set insert (for VF)
871 ~~~~~~~~~~~~~~~~~~~~~~~~
873 Set VLAN insert for a VF from the PF::
875 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
877 vlan set tag (for VF)
878 ~~~~~~~~~~~~~~~~~~~~~
880 Set VLAN tag for a VF from the PF::
882 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
884 vlan set antispoof (for VF)
885 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
887 Set VLAN antispoof for a VF from the PF::
889 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
891 vlan set (strip|filter|qinq_strip|extend)
892 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
893 Set the VLAN strip/filter/QinQ strip/extend on for a port::
895 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
900 Set the inner or outer VLAN TPID for packet filtering on a port::
902 testpmd> vlan set (inner|outer) tpid (value) (port_id)
906 TPID value must be a 16-bit number (value <= 65536).
911 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
913 testpmd> rx_vlan add (vlan_id|all) (port_id)
917 VLAN filter must be set on that port. VLAN ID < 4096.
918 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
919 in VFTA table. This is important if enabling all vlan_ids.
924 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
926 testpmd> rx_vlan rm (vlan_id|all) (port_id)
931 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
933 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
938 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
940 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
945 Add a tunnel filter on a port::
947 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
948 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
949 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
951 The available information categories are:
953 * ``vxlan``: Set tunnel type as VXLAN.
955 * ``nvgre``: Set tunnel type as NVGRE.
957 * ``ipingre``: Set tunnel type as IP-in-GRE.
959 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
961 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
963 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
965 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
967 * ``imac``: Set filter type as Inner MAC.
969 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
971 * ``oip``: Set filter type as Outer IP.
973 * ``iip``: Set filter type as Inner IP.
977 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
978 192.168.2.2 0 ipingre oip 1 1
980 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
985 Remove a tunnel filter on a port::
987 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
988 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
989 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
994 Add an UDP port for VXLAN packet filter on a port::
996 testpmd> rx_vxlan_port add (udp_port) (port_id)
1001 Remove an UDP port for VXLAN packet filter on a port::
1003 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1008 Set hardware insertion of VLAN IDs in packets sent on a port::
1010 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1012 For example, set a single VLAN ID (5) insertion on port 0::
1016 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1024 Set port based hardware insertion of VLAN ID in packets sent on a port::
1026 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1031 Disable hardware insertion of a VLAN header in packets sent on a port::
1033 testpmd> tx_vlan reset (port_id)
1038 Select hardware or software calculation of the checksum when
1039 transmitting a packet using the ``csum`` forwarding engine::
1041 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1045 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1047 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1048 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
1049 supported). See also the ``csum parse-tunnel`` command.
1051 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1052 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
1053 supported). See also the ``csum parse-tunnel`` command.
1057 Check the NIC Datasheet for hardware limits.
1062 Set RSS queue region span on a port::
1064 testpmd> set port (port_id) queue-region region_id (value) \
1065 queue_start_index (value) queue_num (value)
1067 Set flowtype mapping on a RSS queue region on a port::
1069 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1073 * For the flowtype(pctype) of packet,the specific index for each type has
1074 been defined in file i40e_type.h as enum i40e_filter_pctype.
1076 Set user priority mapping on a RSS queue region on a port::
1078 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1080 Flush all queue region related configuration on a port::
1082 testpmd> set port (port_id) queue-region flush (on|off)
1086 * ``on``: is just an enable function which server for other configuration,
1087 it is for all configuration about queue region from up layer,
1088 at first will only keep in DPDK software stored in driver,
1089 only after "flush on", it commit all configuration to HW.
1091 * ``"off``: is just clean all configuration about queue region just now,
1092 and restore all to DPDK i40e driver default config when start up.
1094 Show all queue region related configuration info on a port::
1096 testpmd> show port (port_id) queue-region
1100 Queue region only support on PF by now, so these command is
1101 only for configuration of queue region on PF port.
1106 Define how tunneled packets should be handled by the csum forward
1109 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1111 If enabled, the csum forward engine will try to recognize supported
1112 tunnel headers (vxlan, gre, ipip).
1114 If disabled, treat tunnel packets as non-tunneled packets (a inner
1115 header is handled as a packet payload).
1119 The port argument is the TX port like in the ``csum set`` command.
1123 Consider a packet in packet like the following::
1125 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1127 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1128 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1129 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1131 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1132 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1137 Display tx checksum offload configuration::
1139 testpmd> csum show (port_id)
1144 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1146 testpmd> tso set (segsize) (port_id)
1150 Check the NIC datasheet for hardware limits.
1155 Display the status of TCP Segmentation Offload::
1157 testpmd> tso show (port_id)
1162 Set tso segment size of tunneled packets for a port in csum engine::
1164 testpmd> tunnel_tso set (tso_segsz) (port_id)
1169 Display the status of tunneled TCP Segmentation Offload for a port::
1171 testpmd> tunnel_tso show (port_id)
1176 Enable or disable GRO in ``csum`` forwarding engine::
1178 testpmd> set port <port_id> gro on|off
1180 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1181 packets received from the given port.
1183 If disabled, packets received from the given port won't be performed
1184 GRO. By default, GRO is disabled for all ports.
1188 When enable GRO for a port, TCP/IPv4 packets received from the port
1189 will be performed GRO. After GRO, all merged packets have bad
1190 checksums, since the GRO library doesn't re-calculate checksums for
1191 the merged packets. Therefore, if users want the merged packets to
1192 have correct checksums, please select HW IP checksum calculation and
1193 HW TCP checksum calculation for the port which the merged packets are
1199 Display GRO configuration for a given port::
1201 testpmd> show port <port_id> gro
1206 Set the cycle to flush the GROed packets from reassembly tables::
1208 testpmd> set gro flush <cycles>
1210 When enable GRO, the csum forwarding engine performs GRO on received
1211 packets, and the GROed packets are stored in reassembly tables. Users
1212 can use this command to determine when the GROed packets are flushed
1213 from the reassembly tables.
1215 The ``cycles`` is measured in GRO operation times. The csum forwarding
1216 engine flushes the GROed packets from the tables every ``cycles`` GRO
1219 By default, the value of ``cycles`` is 1, which means flush GROed packets
1220 from the reassembly tables as soon as one GRO operation finishes. The value
1221 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1223 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1224 stack performance. Because the GROed packets are delayed to arrive the
1225 stack, thus causing more duplicated ACKs and TCP retransmissions.
1230 Toggle per-port GSO support in ``csum`` forwarding engine::
1232 testpmd> set port <port_id> gso on|off
1234 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1235 packets, transmitted on the given port.
1237 If disabled, packets transmitted on the given port will not undergo GSO.
1238 By default, GSO is disabled for all ports.
1242 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1243 port undergo GSO. Afterwards, the segmented packets are represented by
1244 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1245 of checksums for GSO'd segments in SW. As a result, if users want correct
1246 checksums in GSO segments, they should enable HW checksum calculation for
1249 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1250 by setting the following options in the csum forwarding engine:
1252 testpmd> csum set outer_ip hw <port_id>
1254 testpmd> csum set ip hw <port_id>
1256 testpmd> csum set tcp hw <port_id>
1258 UDP GSO is the same as IP fragmentation, which treats the UDP header
1259 as the payload and does not modify it during segmentation. That is,
1260 after UDP GSO, only the first output fragment has the original UDP
1261 header. Therefore, users need to enable HW IP checksum calculation
1262 and SW UDP checksum calculation for GSO-enabled ports, if they want
1263 correct checksums for UDP/IPv4 packets.
1268 Set the maximum GSO segment size (measured in bytes), which includes the
1269 packet header and the packet payload for GSO-enabled ports (global)::
1271 testpmd> set gso segsz <length>
1276 Display the status of Generic Segmentation Offload for a given port::
1278 testpmd> show port <port_id> gso
1283 Add an alternative MAC address to a port::
1285 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1290 Remove a MAC address from a port::
1292 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1297 To add the multicast MAC address to/from the set of multicast addresses
1300 testpmd> mcast_addr add (port_id) (mcast_addr)
1305 To remove the multicast MAC address to/from the set of multicast addresses
1308 testpmd> mcast_addr remove (port_id) (mcast_addr)
1310 mac_addr add (for VF)
1311 ~~~~~~~~~~~~~~~~~~~~~
1313 Add an alternative MAC address for a VF to a port::
1315 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1320 Set the default MAC address for a port::
1322 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1324 mac_addr set (for VF)
1325 ~~~~~~~~~~~~~~~~~~~~~
1327 Set the MAC address for a VF from the PF::
1329 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1334 Set the forwarding peer address for certain port::
1336 testpmd> set eth-peer (port_id) (peer_addr)
1338 This is equivalent to the ``--eth-peer`` command-line option.
1343 Set the unicast hash filter(s) on/off for a port::
1345 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1350 Set the promiscuous mode on for a port or for all ports.
1351 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1353 testpmd> set promisc (port_id|all) (on|off)
1358 Set the allmulti mode for a port or for all ports::
1360 testpmd> set allmulti (port_id|all) (on|off)
1362 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1364 set promisc (for VF)
1365 ~~~~~~~~~~~~~~~~~~~~
1367 Set the unicast promiscuous mode for a VF from PF.
1368 It's supported by Intel i40e NICs now.
1369 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1371 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1373 set allmulticast (for VF)
1374 ~~~~~~~~~~~~~~~~~~~~~~~~~
1376 Set the multicast promiscuous mode for a VF from PF.
1377 It's supported by Intel i40e NICs now.
1378 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1380 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1382 set tx max bandwidth (for VF)
1383 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1385 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1387 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1389 set tc tx min bandwidth (for VF)
1390 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1392 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1394 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1396 set tc tx max bandwidth (for VF)
1397 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1399 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1401 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1403 set tc strict link priority mode
1404 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1406 Set some TCs' strict link priority mode on a physical port::
1408 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1410 set tc tx min bandwidth
1411 ~~~~~~~~~~~~~~~~~~~~~~~
1413 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1415 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1420 Set the link flow control parameter on a port::
1422 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1423 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1424 autoneg (on|off) (port_id)
1428 * ``high_water`` (integer): High threshold value to trigger XOFF.
1430 * ``low_water`` (integer): Low threshold value to trigger XON.
1432 * ``pause_time`` (integer): Pause quota in the Pause frame.
1434 * ``send_xon`` (0/1): Send XON frame.
1436 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1438 * ``autoneg``: Change the auto-negotiation parameter.
1443 Set the priority flow control parameter on a port::
1445 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1446 (pause_time) (priority) (port_id)
1450 * ``high_water`` (integer): High threshold value.
1452 * ``low_water`` (integer): Low threshold value.
1454 * ``pause_time`` (integer): Pause quota in the Pause frame.
1456 * ``priority`` (0-7): VLAN User Priority.
1461 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1463 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1465 For example, to set rx queue 2 on port 0 to mapping 5::
1467 testpmd>set stat_qmap rx 0 2 5
1469 set xstats-hide-zero
1470 ~~~~~~~~~~~~~~~~~~~~
1472 Set the option to hide zero values for xstats display::
1474 testpmd> set xstats-hide-zero on|off
1478 By default, the zero values are displayed for xstats.
1480 set port - rx/tx (for VF)
1481 ~~~~~~~~~~~~~~~~~~~~~~~~~
1483 Set VF receive/transmit from a port::
1485 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1487 set port - mac address filter (for VF)
1488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1490 Add/Remove unicast or multicast MAC addr filter for a VF::
1492 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1493 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1495 set port - rx mode(for VF)
1496 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1498 Set the VF receive mode of a port::
1500 testpmd> set port (port_id) vf (vf_id) \
1501 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1503 The available receive modes are:
1505 * ``AUPE``: Accepts untagged VLAN.
1507 * ``ROPE``: Accepts unicast hash.
1509 * ``BAM``: Accepts broadcast packets.
1511 * ``MPE``: Accepts all multicast packets.
1513 set port - tx_rate (for Queue)
1514 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1516 Set TX rate limitation for a queue on a port::
1518 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1520 set port - tx_rate (for VF)
1521 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1523 Set TX rate limitation for queues in VF on a port::
1525 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1527 set port - mirror rule
1528 ~~~~~~~~~~~~~~~~~~~~~~
1530 Set pool or vlan type mirror rule for a port::
1532 testpmd> set port (port_id) mirror-rule (rule_id) \
1533 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1534 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1536 Set link mirror rule for a port::
1538 testpmd> set port (port_id) mirror-rule (rule_id) \
1539 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1541 For example to enable mirror traffic with vlan 0,1 to pool 0::
1543 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1545 reset port - mirror rule
1546 ~~~~~~~~~~~~~~~~~~~~~~~~
1548 Reset a mirror rule for a port::
1550 testpmd> reset port (port_id) mirror-rule (rule_id)
1555 Set the flush on RX streams before forwarding.
1556 The default is flush ``on``.
1557 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1559 testpmd> set flush_rx off
1564 Set the bypass mode for the lowest port on bypass enabled NIC::
1566 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1571 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1573 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1574 mode (normal|bypass|isolate) (port_id)
1578 * ``timeout``: Enable bypass after watchdog timeout.
1580 * ``os_on``: Enable bypass when OS/board is powered on.
1582 * ``os_off``: Enable bypass when OS/board is powered off.
1584 * ``power_on``: Enable bypass when power supply is turned on.
1586 * ``power_off``: Enable bypass when power supply is turned off.
1592 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1594 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1599 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1601 testpmd> show bypass config (port_id)
1606 Set link up for a port::
1608 testpmd> set link-up port (port id)
1613 Set link down for a port::
1615 testpmd> set link-down port (port id)
1620 Enable E-tag insertion for a VF on a port::
1622 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1624 Disable E-tag insertion for a VF on a port::
1626 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1628 Enable/disable E-tag stripping on a port::
1630 testpmd> E-tag set stripping (on|off) port (port_id)
1632 Enable/disable E-tag based forwarding on a port::
1634 testpmd> E-tag set forwarding (on|off) port (port_id)
1636 Add an E-tag forwarding filter on a port::
1638 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1640 Delete an E-tag forwarding filter on a port::
1641 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1646 Load a dynamic device personalization (DDP) profile and store backup profile::
1648 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1653 Delete a dynamic device personalization profile and restore backup profile::
1655 testpmd> ddp del (port_id) (backup_profile_path)
1660 List all items from the ptype mapping table::
1662 testpmd> ptype mapping get (port_id) (valid_only)
1666 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1668 Replace a specific or a group of software defined ptype with a new one::
1670 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1674 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1676 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1678 * ``pkt_type``: The new software ptype to replace the old ones.
1680 Update hardware defined ptype to software defined packet type mapping table::
1682 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1686 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1688 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1690 Reset ptype mapping table::
1692 testpmd> ptype mapping reset (port_id)
1694 config per port Rx offloading
1695 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1697 Enable or disable a per port Rx offloading on all Rx queues of a port::
1699 testpmd> port config (port_id) rx_offload (offloading) on|off
1701 * ``offloading``: can be any of these offloading capability:
1702 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1703 qinq_strip, outer_ipv4_cksum, macsec_strip,
1704 header_split, vlan_filter, vlan_extend, jumbo_frame,
1705 scatter, timestamp, security, keep_crc, rss_hash
1707 This command should be run when the port is stopped, or else it will fail.
1709 config per queue Rx offloading
1710 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1712 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1714 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1716 * ``offloading``: can be any of these offloading capability:
1717 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1718 qinq_strip, outer_ipv4_cksum, macsec_strip,
1719 header_split, vlan_filter, vlan_extend, jumbo_frame,
1720 scatter, timestamp, security, keep_crc
1722 This command should be run when the port is stopped, or else it will fail.
1724 config per port Tx offloading
1725 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1727 Enable or disable a per port Tx offloading on all Tx queues of a port::
1729 testpmd> port config (port_id) tx_offload (offloading) on|off
1731 * ``offloading``: can be any of these offloading capability:
1732 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1733 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1734 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1735 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1736 mt_lockfree, multi_segs, mbuf_fast_free, security
1738 This command should be run when the port is stopped, or else it will fail.
1740 config per queue Tx offloading
1741 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1743 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1745 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1747 * ``offloading``: can be any of these offloading capability:
1748 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1749 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1750 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1751 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1752 mt_lockfree, multi_segs, mbuf_fast_free, security
1754 This command should be run when the port is stopped, or else it will fail.
1756 Config VXLAN Encap outer layers
1757 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1759 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1761 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1762 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1765 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1766 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1767 eth-src (eth-src) eth-dst (eth-dst)
1769 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1770 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1771 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1773 These commands will set an internal configuration inside testpmd, any following
1774 flow rule using the action vxlan_encap will use the last configuration set.
1775 To have a different encapsulation header, one of those commands must be called
1776 before the flow rule creation.
1778 Config NVGRE Encap outer layers
1779 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1781 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1783 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1784 eth-src (eth-src) eth-dst (eth-dst)
1785 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1786 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1788 These commands will set an internal configuration inside testpmd, any following
1789 flow rule using the action nvgre_encap will use the last configuration set.
1790 To have a different encapsulation header, one of those commands must be called
1791 before the flow rule creation.
1796 Configure the l2 to be used when encapsulating a packet with L2::
1798 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1799 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1800 eth-src (eth-src) eth-dst (eth-dst)
1802 Those commands will set an internal configuration inside testpmd, any following
1803 flow rule using the action l2_encap will use the last configuration set.
1804 To have a different encapsulation header, one of those commands must be called
1805 before the flow rule creation.
1810 Configure the l2 to be removed when decapsulating a packet with L2::
1812 set l2_decap ip-version (ipv4|ipv6)
1813 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1815 Those commands will set an internal configuration inside testpmd, any following
1816 flow rule using the action l2_decap will use the last configuration set.
1817 To have a different encapsulation header, one of those commands must be called
1818 before the flow rule creation.
1820 Config MPLSoGRE Encap outer layers
1821 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1823 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1825 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1826 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1827 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1828 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1829 eth-src (eth-src) eth-dst (eth-dst)
1831 These commands will set an internal configuration inside testpmd, any following
1832 flow rule using the action mplsogre_encap will use the last configuration set.
1833 To have a different encapsulation header, one of those commands must be called
1834 before the flow rule creation.
1836 Config MPLSoGRE Decap outer layers
1837 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1839 Configure the outer layer to decapsulate MPLSoGRE packet::
1841 set mplsogre_decap ip-version (ipv4|ipv6)
1842 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1844 These commands will set an internal configuration inside testpmd, any following
1845 flow rule using the action mplsogre_decap will use the last configuration set.
1846 To have a different decapsulation header, one of those commands must be called
1847 before the flow rule creation.
1849 Config MPLSoUDP Encap outer layers
1850 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1852 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1854 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1855 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1856 eth-src (eth-src) eth-dst (eth-dst)
1857 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1858 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1859 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1861 These commands will set an internal configuration inside testpmd, any following
1862 flow rule using the action mplsoudp_encap will use the last configuration set.
1863 To have a different encapsulation header, one of those commands must be called
1864 before the flow rule creation.
1866 Config MPLSoUDP Decap outer layers
1867 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1869 Configure the outer layer to decapsulate MPLSoUDP packet::
1871 set mplsoudp_decap ip-version (ipv4|ipv6)
1872 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1874 These commands will set an internal configuration inside testpmd, any following
1875 flow rule using the action mplsoudp_decap will use the last configuration set.
1876 To have a different decapsulation header, one of those commands must be called
1877 before the flow rule creation.
1879 Config Raw Encapsulation
1880 ~~~~~~~~~~~~~~~~~~~~~~~~~
1882 Configure the raw data to be used when encapsulating a packet by
1883 rte_flow_action_raw_encap::
1885 set raw_encap {index} {item} [/ {item} [...]] / end_set
1887 There are multiple global buffers for ``raw_encap``, this command will set one
1888 internal buffer index by ``{index}``.
1889 If there is no ``{index}`` specified::
1891 set raw_encap {item} [/ {item} [...]] / end_set
1893 the default index ``0`` is used.
1894 In order to use different encapsulating header, ``index`` must be specified
1895 during the flow rule creation::
1897 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1898 raw_encap index 2 / end
1900 Otherwise the default index ``0`` is used.
1902 Config Raw Decapsulation
1903 ~~~~~~~~~~~~~~~~~~~~~~~~
1905 Configure the raw data to be used when decapsulating a packet by
1906 rte_flow_action_raw_decap::
1908 set raw_decap {index} {item} [/ {item} [...]] / end_set
1910 There are multiple global buffers for ``raw_decap``, this command will set
1911 one internal buffer index by ``{index}``.
1912 If there is no ``{index}`` specified::
1914 set raw_decap {item} [/ {item} [...]] / end_set
1916 the default index ``0`` is used.
1917 In order to use different decapsulating header, ``index`` must be specified
1918 during the flow rule creation::
1920 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1921 raw_encap index 3 / end
1923 Otherwise the default index ``0`` is used.
1928 The following sections show functions for configuring ports.
1932 Port configuration changes only become active when forwarding is started/restarted.
1937 Attach a port specified by pci address or virtual device args::
1939 testpmd> port attach (identifier)
1941 To attach a new pci device, the device should be recognized by kernel first.
1942 Then it should be moved under DPDK management.
1943 Finally the port can be attached to testpmd.
1945 For example, to move a pci device using ixgbe under DPDK management:
1947 .. code-block:: console
1949 # Check the status of the available devices.
1950 ./usertools/dpdk-devbind.py --status
1952 Network devices using DPDK-compatible driver
1953 ============================================
1956 Network devices using kernel driver
1957 ===================================
1958 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1961 # Bind the device to igb_uio.
1962 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1965 # Recheck the status of the devices.
1966 ./usertools/dpdk-devbind.py --status
1967 Network devices using DPDK-compatible driver
1968 ============================================
1969 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1971 To attach a port created by virtual device, above steps are not needed.
1973 For example, to attach a port whose pci address is 0000:0a:00.0.
1975 .. code-block:: console
1977 testpmd> port attach 0000:0a:00.0
1978 Attaching a new port...
1979 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1980 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1981 EAL: PCI memory mapped at 0x7f83bfa00000
1982 EAL: PCI memory mapped at 0x7f83bfa80000
1983 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1984 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1985 Port 0 is attached. Now total ports is 1
1988 For example, to attach a port created by pcap PMD.
1990 .. code-block:: console
1992 testpmd> port attach net_pcap0
1993 Attaching a new port...
1994 PMD: Initializing pmd_pcap for net_pcap0
1995 PMD: Creating pcap-backed ethdev on numa socket 0
1996 Port 0 is attached. Now total ports is 1
1999 In this case, identifier is ``net_pcap0``.
2000 This identifier format is the same as ``--vdev`` format of DPDK applications.
2002 For example, to re-attach a bonded port which has been previously detached,
2003 the mode and slave parameters must be given.
2005 .. code-block:: console
2007 testpmd> port attach net_bond_0,mode=0,slave=1
2008 Attaching a new port...
2009 EAL: Initializing pmd_bond for net_bond_0
2010 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2011 Port 0 is attached. Now total ports is 1
2018 Detach a specific port::
2020 testpmd> port detach (port_id)
2022 Before detaching a port, the port should be stopped and closed.
2024 For example, to detach a pci device port 0.
2026 .. code-block:: console
2028 testpmd> port stop 0
2031 testpmd> port close 0
2035 testpmd> port detach 0
2037 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2038 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2039 EAL: PCI memory unmapped at 0x7f83bfa00000
2040 EAL: PCI memory unmapped at 0x7f83bfa80000
2044 For example, to detach a virtual device port 0.
2046 .. code-block:: console
2048 testpmd> port stop 0
2051 testpmd> port close 0
2055 testpmd> port detach 0
2057 PMD: Closing pcap ethdev on numa socket 0
2058 Port 'net_pcap0' is detached. Now total ports is 0
2061 To remove a pci device completely from the system, first detach the port from testpmd.
2062 Then the device should be moved under kernel management.
2063 Finally the device can be removed using kernel pci hotplug functionality.
2065 For example, to move a pci device under kernel management:
2067 .. code-block:: console
2069 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2071 ./usertools/dpdk-devbind.py --status
2073 Network devices using DPDK-compatible driver
2074 ============================================
2077 Network devices using kernel driver
2078 ===================================
2079 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2081 To remove a port created by a virtual device, above steps are not needed.
2086 Start all ports or a specific port::
2088 testpmd> port start (port_id|all)
2093 Stop all ports or a specific port::
2095 testpmd> port stop (port_id|all)
2100 Close all ports or a specific port::
2102 testpmd> port close (port_id|all)
2107 Reset all ports or a specific port::
2109 testpmd> port reset (port_id|all)
2111 User should stop port(s) before resetting and (re-)start after reset.
2113 port config - queue ring size
2114 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2116 Configure a rx/tx queue ring size::
2118 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2120 Only take effect after command that (re-)start the port or command that setup specific queue.
2122 port start/stop queue
2123 ~~~~~~~~~~~~~~~~~~~~~
2125 Start/stop a rx/tx queue on a specific port::
2127 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2129 port config - queue deferred start
2130 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2132 Switch on/off deferred start of a specific port queue::
2134 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2137 ~~~~~~~~~~~~~~~~~~~~~
2139 Setup a rx/tx queue on a specific port::
2141 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2143 Only take effect when port is started.
2148 Set the speed and duplex mode for all ports or a specific port::
2150 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
2151 duplex (half|full|auto)
2153 port config - queues/descriptors
2154 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2156 Set number of queues/descriptors for rxq, txq, rxd and txd::
2158 testpmd> port config all (rxq|txq|rxd|txd) (value)
2160 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2162 port config - max-pkt-len
2163 ~~~~~~~~~~~~~~~~~~~~~~~~~
2165 Set the maximum packet length::
2167 testpmd> port config all max-pkt-len (value)
2169 This is equivalent to the ``--max-pkt-len`` command-line option.
2171 port config - max-lro-pkt-size
2172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2174 Set the maximum LRO aggregated packet size::
2176 testpmd> port config all max-lro-pkt-size (value)
2178 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2180 port config - Drop Packets
2181 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2183 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2185 testpmd> port config all drop-en (on|off)
2187 Packet dropping when no receive buffers available is off by default.
2189 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2194 Set the RSS (Receive Side Scaling) mode on or off::
2196 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|none)
2198 RSS is on by default.
2200 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
2201 The ``default`` option enables all supported RSS types reported by device info.
2202 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2204 port config - RSS Reta
2205 ~~~~~~~~~~~~~~~~~~~~~~
2207 Set the RSS (Receive Side Scaling) redirection table::
2209 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2214 Set the DCB mode for an individual port::
2216 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2218 The traffic class should be 4 or 8.
2223 Set the number of packets per burst::
2225 testpmd> port config all burst (value)
2227 This is equivalent to the ``--burst`` command-line option.
2229 port config - Threshold
2230 ~~~~~~~~~~~~~~~~~~~~~~~
2232 Set thresholds for TX/RX queues::
2234 testpmd> port config all (threshold) (value)
2236 Where the threshold type can be:
2238 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2240 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2242 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2244 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2246 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2248 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2250 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2252 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2254 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2256 These threshold options are also available from the command-line.
2261 Set the value of ether-type for E-tag::
2263 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2265 Enable/disable the E-tag support::
2267 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2269 port config pctype mapping
2270 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2272 Reset pctype mapping table::
2274 testpmd> port config (port_id) pctype mapping reset
2276 Update hardware defined pctype to software defined flow type mapping table::
2278 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2282 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2284 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2286 port config input set
2287 ~~~~~~~~~~~~~~~~~~~~~
2289 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2291 testpmd> port config (port_id) pctype (pctype_id) \
2292 (hash_inset|fdir_inset|fdir_flx_inset) \
2293 (get|set|clear) field (field_idx)
2295 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2297 testpmd> port config (port_id) pctype (pctype_id) \
2298 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2302 * ``pctype_id``: hardware packet classification types.
2303 * ``field_idx``: hardware field index.
2305 port config udp_tunnel_port
2306 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2308 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2310 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2312 port config tx_metadata
2313 ~~~~~~~~~~~~~~~~~~~~~~~
2315 Set Tx metadata value per port.
2316 testpmd will add this value to any Tx packet sent from this port::
2318 testpmd> port config (port_id) tx_metadata (value)
2323 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2325 testpmd> port config mtu (port_id) (value)
2327 port config rss hash key
2328 ~~~~~~~~~~~~~~~~~~~~~~~~
2330 To configure the RSS hash key used to compute the RSS
2331 hash of input [IP] packets received on port::
2333 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2334 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2335 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2336 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2337 ipv6-udp-ex <string of hex digits \
2338 (variable length, NIC dependent)>)
2343 The following sections show functions for device operations.
2348 Detach a device specified by pci address or virtual device args::
2350 testpmd> device detach (identifier)
2352 Before detaching a device associated with ports, the ports should be stopped and closed.
2354 For example, to detach a pci device whose address is 0002:03:00.0.
2356 .. code-block:: console
2358 testpmd> device detach 0002:03:00.0
2359 Removing a device...
2360 Port 1 is now closed
2361 EAL: Releasing pci mapped resource for 0002:03:00.0
2362 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2363 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2364 Device 0002:03:00.0 is detached
2365 Now total ports is 1
2367 For example, to detach a port created by pcap PMD.
2369 .. code-block:: console
2371 testpmd> device detach net_pcap0
2372 Removing a device...
2373 Port 0 is now closed
2374 Device net_pcap0 is detached
2375 Now total ports is 0
2378 In this case, identifier is ``net_pcap0``.
2379 This identifier format is the same as ``--vdev`` format of DPDK applications.
2381 Link Bonding Functions
2382 ----------------------
2384 The Link Bonding functions make it possible to dynamically create and
2385 manage link bonding devices from within testpmd interactive prompt.
2387 create bonded device
2388 ~~~~~~~~~~~~~~~~~~~~
2390 Create a new bonding device::
2392 testpmd> create bonded device (mode) (socket)
2394 For example, to create a bonded device in mode 1 on socket 0::
2396 testpmd> create bonded device 1 0
2397 created new bonded device (port X)
2402 Adds Ethernet device to a Link Bonding device::
2404 testpmd> add bonding slave (slave id) (port id)
2406 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2408 testpmd> add bonding slave 6 10
2411 remove bonding slave
2412 ~~~~~~~~~~~~~~~~~~~~
2414 Removes an Ethernet slave device from a Link Bonding device::
2416 testpmd> remove bonding slave (slave id) (port id)
2418 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2420 testpmd> remove bonding slave 6 10
2425 Set the Link Bonding mode of a Link Bonding device::
2427 testpmd> set bonding mode (value) (port id)
2429 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2431 testpmd> set bonding mode 3 10
2436 Set an Ethernet slave device as the primary device on a Link Bonding device::
2438 testpmd> set bonding primary (slave id) (port id)
2440 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2442 testpmd> set bonding primary 6 10
2447 Set the MAC address of a Link Bonding device::
2449 testpmd> set bonding mac (port id) (mac)
2451 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2453 testpmd> set bonding mac 10 00:00:00:00:00:01
2455 set bonding xmit_balance_policy
2456 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2458 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2460 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2462 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2464 testpmd> set bonding xmit_balance_policy 10 l34
2467 set bonding mon_period
2468 ~~~~~~~~~~~~~~~~~~~~~~
2470 Set the link status monitoring polling period in milliseconds for a bonding device.
2472 This adds support for PMD slave devices which do not support link status interrupts.
2473 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2474 link status ISR will be queried every polling interval to check if their link status has changed::
2476 testpmd> set bonding mon_period (port_id) (value)
2478 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2480 testpmd> set bonding mon_period 5 150
2483 set bonding lacp dedicated_queue
2484 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2486 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2487 when in mode 4 (link-aggregation-802.3ad)::
2489 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2492 set bonding agg_mode
2493 ~~~~~~~~~~~~~~~~~~~~
2495 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2497 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2503 Show the current configuration of a Link Bonding device::
2505 testpmd> show bonding config (port id)
2508 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2509 in balance mode with a transmission policy of layer 2+3::
2511 testpmd> show bonding config 9
2513 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2515 Active Slaves (3): [1 3 4]
2522 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2523 This is mainly useful for debugging purposes.
2524 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2525 and fields that can be accessed.
2530 Display the value of a port register::
2532 testpmd> read reg (port_id) (address)
2534 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2536 testpmd> read reg 0 0xEE00
2537 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2542 Display a port register bit field::
2544 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2546 For example, reading the lowest two bits from the register in the example above::
2548 testpmd> read regfield 0 0xEE00 0 1
2549 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2554 Display a single port register bit::
2556 testpmd> read regbit (port_id) (address) (bit_x)
2558 For example, reading the lowest bit from the register in the example above::
2560 testpmd> read regbit 0 0xEE00 0
2561 port 0 PCI register at offset 0xEE00: bit 0=1
2566 Set the value of a port register::
2568 testpmd> write reg (port_id) (address) (value)
2570 For example, to clear a register::
2572 testpmd> write reg 0 0xEE00 0x0
2573 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2578 Set bit field of a port register::
2580 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2582 For example, writing to the register cleared in the example above::
2584 testpmd> write regfield 0 0xEE00 0 1 2
2585 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2590 Set single bit value of a port register::
2592 testpmd> write regbit (port_id) (address) (bit_x) (value)
2594 For example, to set the high bit in the register from the example above::
2596 testpmd> write regbit 0 0xEE00 31 1
2597 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2599 Traffic Metering and Policing
2600 -----------------------------
2602 The following section shows functions for configuring traffic metering and
2603 policing on the ethernet device through the use of generic ethdev API.
2605 show port traffic management capability
2606 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2608 Show traffic metering and policing capability of the port::
2610 testpmd> show port meter cap (port_id)
2612 add port meter profile (srTCM rfc2967)
2613 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2615 Add meter profile (srTCM rfc2697) to the ethernet device::
2617 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2622 * ``profile_id``: ID for the meter profile.
2623 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2624 * ``cbs``: Committed Burst Size (CBS) (bytes).
2625 * ``ebs``: Excess Burst Size (EBS) (bytes).
2627 add port meter profile (trTCM rfc2968)
2628 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2630 Add meter profile (srTCM rfc2698) to the ethernet device::
2632 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2633 (cir) (pir) (cbs) (pbs)
2637 * ``profile_id``: ID for the meter profile.
2638 * ``cir``: Committed information rate (bytes/second).
2639 * ``pir``: Peak information rate (bytes/second).
2640 * ``cbs``: Committed burst size (bytes).
2641 * ``pbs``: Peak burst size (bytes).
2643 add port meter profile (trTCM rfc4115)
2644 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2646 Add meter profile (trTCM rfc4115) to the ethernet device::
2648 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2649 (cir) (eir) (cbs) (ebs)
2653 * ``profile_id``: ID for the meter profile.
2654 * ``cir``: Committed information rate (bytes/second).
2655 * ``eir``: Excess information rate (bytes/second).
2656 * ``cbs``: Committed burst size (bytes).
2657 * ``ebs``: Excess burst size (bytes).
2659 delete port meter profile
2660 ~~~~~~~~~~~~~~~~~~~~~~~~~
2662 Delete meter profile from the ethernet device::
2664 testpmd> del port meter profile (port_id) (profile_id)
2669 Create new meter object for the ethernet device::
2671 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2672 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2673 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2678 * ``mtr_id``: meter object ID.
2679 * ``profile_id``: ID for the meter profile.
2680 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2681 gets enabled at the time of creation, otherwise remains disabled.
2682 * ``g_action``: Policer action for the packet with green color.
2683 * ``y_action``: Policer action for the packet with yellow color.
2684 * ``r_action``: Policer action for the packet with red color.
2685 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2687 * ``shared``: When this parameter has a non-zero value, the meter object is
2688 shared by multiple flows. Otherwise, meter object is used by single flow.
2689 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2690 input color for the current meter object is determined by the latest meter
2691 object in the same flow. Otherwise, the current meter object uses the
2692 *dscp_table* to determine the input color.
2693 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2694 color, 0 <= x <= 63.
2699 Enable meter for the ethernet device::
2701 testpmd> enable port meter (port_id) (mtr_id)
2706 Disable meter for the ethernet device::
2708 testpmd> disable port meter (port_id) (mtr_id)
2713 Delete meter for the ethernet device::
2715 testpmd> del port meter (port_id) (mtr_id)
2717 Set port meter profile
2718 ~~~~~~~~~~~~~~~~~~~~~~
2720 Set meter profile for the ethernet device::
2722 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2724 set port meter dscp table
2725 ~~~~~~~~~~~~~~~~~~~~~~~~~
2727 Set meter dscp table for the ethernet device::
2729 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2730 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2732 set port meter policer action
2733 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2735 Set meter policer action for the ethernet device::
2737 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2738 (action0) [(action1) (action1)]
2742 * ``action_mask``: Bit mask indicating which policer actions need to be
2743 updated. One or more policer actions can be updated in a single function
2744 invocation. To update the policer action associated with color C, bit
2745 (1 << C) needs to be set in *action_mask* and element at position C
2746 in the *actions* array needs to be valid.
2747 * ``actionx``: Policer action for the color x,
2748 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2750 set port meter stats mask
2751 ~~~~~~~~~~~~~~~~~~~~~~~~~
2753 Set meter stats mask for the ethernet device::
2755 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2759 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2761 show port meter stats
2762 ~~~~~~~~~~~~~~~~~~~~~
2764 Show meter stats of the ethernet device::
2766 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2770 * ``clear``: Flag that indicates whether the statistics counters should
2771 be cleared (i.e. set to zero) immediately after they have been read or not.
2776 The following section shows functions for configuring traffic management on
2777 the ethernet device through the use of generic TM API.
2779 show port traffic management capability
2780 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2782 Show traffic management capability of the port::
2784 testpmd> show port tm cap (port_id)
2786 show port traffic management capability (hierarchy level)
2787 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2789 Show traffic management hierarchy level capability of the port::
2791 testpmd> show port tm level cap (port_id) (level_id)
2793 show port traffic management capability (hierarchy node level)
2794 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2796 Show the traffic management hierarchy node capability of the port::
2798 testpmd> show port tm node cap (port_id) (node_id)
2800 show port traffic management hierarchy node type
2801 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2803 Show the port traffic management hierarchy node type::
2805 testpmd> show port tm node type (port_id) (node_id)
2807 show port traffic management hierarchy node stats
2808 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2810 Show the port traffic management hierarchy node statistics::
2812 testpmd> show port tm node stats (port_id) (node_id) (clear)
2816 * ``clear``: When this parameter has a non-zero value, the statistics counters
2817 are cleared (i.e. set to zero) immediately after they have been read,
2818 otherwise the statistics counters are left untouched.
2820 Add port traffic management private shaper profile
2821 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2823 Add the port traffic management private shaper profile::
2825 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2826 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2827 (packet_length_adjust)
2831 * ``shaper_profile id``: Shaper profile ID for the new profile.
2832 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2833 * ``cmit_tb_size``: Committed token bucket size (bytes).
2834 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2835 * ``peak_tb_size``: Peak token bucket size (bytes).
2836 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2837 each packet for the purpose of shaping. This parameter value can be used to
2838 correct the packet length with the framing overhead bytes that are consumed
2841 Delete port traffic management private shaper profile
2842 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2844 Delete the port traffic management private shaper::
2846 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2850 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2852 Add port traffic management shared shaper
2853 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2855 Create the port traffic management shared shaper::
2857 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2862 * ``shared_shaper_id``: Shared shaper ID to be created.
2863 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2865 Set port traffic management shared shaper
2866 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2868 Update the port traffic management shared shaper::
2870 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2875 * ``shared_shaper_id``: Shared shaper ID to be update.
2876 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2878 Delete port traffic management shared shaper
2879 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2881 Delete the port traffic management shared shaper::
2883 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2887 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2889 Set port traffic management hierarchy node private shaper
2890 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2892 set the port traffic management hierarchy node private shaper::
2894 testpmd> set port tm node shaper profile (port_id) (node_id) \
2899 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2902 Add port traffic management WRED profile
2903 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2905 Create a new WRED profile::
2907 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2908 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2909 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2910 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2914 * ``wred_profile id``: Identifier for the newly create WRED profile
2915 * ``color_g``: Packet color (green)
2916 * ``min_th_g``: Minimum queue threshold for packet with green color
2917 * ``max_th_g``: Minimum queue threshold for packet with green color
2918 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2919 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2920 * ``color_y``: Packet color (yellow)
2921 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2922 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2923 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2924 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2925 * ``color_r``: Packet color (red)
2926 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2927 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2928 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2929 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2931 Delete port traffic management WRED profile
2932 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2934 Delete the WRED profile::
2936 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2938 Add port traffic management hierarchy nonleaf node
2939 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2941 Add nonleaf node to port traffic management hierarchy::
2943 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2944 (priority) (weight) (level_id) (shaper_profile_id) \
2945 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2946 [(shared_shaper_0) (shared_shaper_1) ...] \
2950 * ``parent_node_id``: Node ID of the parent.
2951 * ``priority``: Node priority (highest node priority is zero). This is used by
2952 the SP algorithm running on the parent node for scheduling this node.
2953 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2954 to the weight sum of all siblings that have the same priority. It is used by
2955 the WFQ algorithm running on the parent node for scheduling this node.
2956 * ``level_id``: Hierarchy level of the node.
2957 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2959 * ``n_sp_priorities``: Number of strict priorities.
2960 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2961 * ``n_shared_shapers``: Number of shared shapers.
2962 * ``shared_shaper_id``: Shared shaper id.
2964 Add port traffic management hierarchy leaf node
2965 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2967 Add leaf node to port traffic management hierarchy::
2969 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2970 (priority) (weight) (level_id) (shaper_profile_id) \
2971 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2972 [(shared_shaper_id) (shared_shaper_id) ...] \
2976 * ``parent_node_id``: Node ID of the parent.
2977 * ``priority``: Node priority (highest node priority is zero). This is used by
2978 the SP algorithm running on the parent node for scheduling this node.
2979 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2980 to the weight sum of all siblings that have the same priority. It is used by
2981 the WFQ algorithm running on the parent node for scheduling this node.
2982 * ``level_id``: Hierarchy level of the node.
2983 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2985 * ``cman_mode``: Congestion management mode to be enabled for this node.
2986 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2987 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2988 * ``n_shared_shapers``: Number of shared shapers.
2989 * ``shared_shaper_id``: Shared shaper id.
2991 Delete port traffic management hierarchy node
2992 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2994 Delete node from port traffic management hierarchy::
2996 testpmd> del port tm node (port_id) (node_id)
2998 Update port traffic management hierarchy parent node
2999 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3001 Update port traffic management hierarchy parent node::
3003 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3006 This function can only be called after the hierarchy commit invocation. Its
3007 success depends on the port support for this operation, as advertised through
3008 the port capability set. This function is valid for all nodes of the traffic
3009 management hierarchy except root node.
3011 Suspend port traffic management hierarchy node
3012 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3014 testpmd> suspend port tm node (port_id) (node_id)
3016 Resume port traffic management hierarchy node
3017 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3019 testpmd> resume port tm node (port_id) (node_id)
3021 Commit port traffic management hierarchy
3022 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3024 Commit the traffic management hierarchy on the port::
3026 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3030 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3031 call failure. On the other hand, hierarchy is preserved when this parameter
3034 Set port traffic management mark VLAN dei
3035 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3037 Enables/Disables the traffic management marking on the port for VLAN packets::
3039 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3043 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3044 ``yellow`` or ``red`` will have dei bit enabled
3046 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3048 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3050 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3052 Set port traffic management mark IP dscp
3053 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3055 Enables/Disables the traffic management marking on the port for IP dscp packets::
3057 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3061 * ``port_id``: The port which on which IP packets marked as ``green`` or
3062 ``yellow`` or ``red`` will have IP dscp bits updated
3064 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3066 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3068 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3070 Set port traffic management mark IP ecn
3071 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3073 Enables/Disables the traffic management marking on the port for IP ecn packets::
3075 testpmd> set port tm mark ip_ecn <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 ecn bits updated
3082 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3083 to ecn of 2'b11 when IP is caring TCP or SCTP
3085 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3086 to ecn of 2'b11 when IP is caring TCP or SCTP
3088 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3089 to ecn of 2'b11 when IP is caring TCP or SCTP
3091 Set port traffic management default hierarchy (softnic forwarding mode)
3092 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3094 set the traffic management default hierarchy on the port::
3096 testpmd> set port tm hierarchy default (port_id)
3101 This section details the available filter functions that are available.
3103 Note these functions interface the deprecated legacy filtering framework,
3104 superseded by *rte_flow*. See `Flow rules management`_.
3107 ~~~~~~~~~~~~~~~~~~~~
3109 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3111 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3112 ethertype (ether_type) (drop|fwd) queue (queue_id)
3114 The available information parameters are:
3116 * ``port_id``: The port which the Ethertype filter assigned on.
3118 * ``mac_addr``: Compare destination mac address.
3120 * ``mac_ignr``: Ignore destination mac address match.
3122 * ``mac_address``: Destination mac address to match.
3124 * ``ether_type``: The EtherType value want to match,
3125 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3127 * ``queue_id``: The receive queue associated with this EtherType filter.
3128 It is meaningless when deleting or dropping.
3130 Example, to add/remove an ethertype filter rule::
3132 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3133 ethertype 0x0806 fwd queue 3
3135 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3136 ethertype 0x0806 fwd queue 3
3141 Add or delete a 2-tuple filter,
3142 which identifies packets by specific protocol and destination TCP/UDP port
3143 and forwards packets into one of the receive queues::
3145 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3146 protocol (protocol_value) mask (mask_value) \
3147 tcp_flags (tcp_flags_value) priority (prio_value) \
3150 The available information parameters are:
3152 * ``port_id``: The port which the 2-tuple filter assigned on.
3154 * ``dst_port_value``: Destination port in L4.
3156 * ``protocol_value``: IP L4 protocol.
3158 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3160 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3162 * ``prio_value``: Priority of this filter.
3164 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3166 Example, to add/remove an 2tuple filter rule::
3168 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3169 tcp_flags 0x02 priority 3 queue 3
3171 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3172 tcp_flags 0x02 priority 3 queue 3
3177 Add or delete a 5-tuple filter,
3178 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3179 and routes packets into one of the receive queues::
3181 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3182 (src_address) dst_port (dst_port_value) \
3183 src_port (src_port_value) protocol (protocol_value) \
3184 mask (mask_value) tcp_flags (tcp_flags_value) \
3185 priority (prio_value) queue (queue_id)
3187 The available information parameters are:
3189 * ``port_id``: The port which the 5-tuple filter assigned on.
3191 * ``dst_address``: Destination IP address.
3193 * ``src_address``: Source IP address.
3195 * ``dst_port_value``: TCP/UDP destination port.
3197 * ``src_port_value``: TCP/UDP source port.
3199 * ``protocol_value``: L4 protocol.
3201 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3203 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3205 * ``prio_value``: The priority of this filter.
3207 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3209 Example, to add/remove an 5tuple filter rule::
3211 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3212 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3213 flags 0x0 priority 3 queue 3
3215 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3216 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3217 flags 0x0 priority 3 queue 3
3222 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3224 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3226 The available information parameters are:
3228 * ``port_id``: The port which the SYN filter assigned on.
3230 * ``high``: This SYN filter has higher priority than other filters.
3232 * ``low``: This SYN filter has lower priority than other filters.
3234 * ``queue_id``: The receive queue associated with this SYN filter
3238 testpmd> syn_filter 0 add priority high queue 3
3243 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3244 and routed into one of the receive queues::
3246 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3247 mask (mask_value) priority (prio_value) queue (queue_id)
3249 The available information parameters are:
3251 * ``port_id``: The port which the Flex filter is assigned on.
3253 * ``len_value``: Filter length in bytes, no greater than 128.
3255 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3257 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3259 * ``prio_value``: The priority of this filter.
3261 * ``queue_id``: The receive queue associated with this Flex filter.
3265 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3266 mask 000C priority 3 queue 3
3268 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3269 mask 000C priority 3 queue 3
3272 .. _testpmd_flow_director:
3274 flow_director_filter
3275 ~~~~~~~~~~~~~~~~~~~~
3277 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3279 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3280 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3282 * Perfect match filters.
3283 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3284 The masked fields are for IP flow.
3286 * Signature filters.
3287 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3289 * Perfect-mac-vlan match filters.
3290 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3291 The masked fields are for MAC VLAN flow.
3293 * Perfect-tunnel match filters.
3294 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3295 The masked fields are for tunnel flow.
3297 * Perfect-raw-flow-type match filters.
3298 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3299 The masked fields are specified by input sets.
3301 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3302 per flow type and the flexible payload.
3304 The Flow Director can also mask out parts of all of these fields so that filters
3305 are only applied to certain fields or parts of the fields.
3307 Note that for raw flow type mode the source and destination fields in the
3308 raw packet buffer need to be presented in a reversed order with respect
3309 to the expected received packets.
3310 For example: IP source and destination addresses or TCP/UDP/SCTP
3311 source and destination ports
3313 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3315 # Commands to add flow director filters of different flow types::
3317 flow_director_filter (port_id) mode IP (add|del|update) \
3318 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3319 src (src_ip_address) dst (dst_ip_address) \
3320 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3321 vlan (vlan_value) flexbytes (flexbytes_value) \
3322 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3325 flow_director_filter (port_id) mode IP (add|del|update) \
3326 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3327 src (src_ip_address) (src_port) \
3328 dst (dst_ip_address) (dst_port) \
3329 tos (tos_value) ttl (ttl_value) \
3330 vlan (vlan_value) flexbytes (flexbytes_value) \
3331 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3334 flow_director_filter (port_id) mode IP (add|del|update) \
3335 flow (ipv4-sctp|ipv6-sctp) \
3336 src (src_ip_address) (src_port) \
3337 dst (dst_ip_address) (dst_port) \
3338 tos (tos_value) ttl (ttl_value) \
3339 tag (verification_tag) vlan (vlan_value) \
3340 flexbytes (flexbytes_value) (drop|fwd) \
3341 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3343 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3344 ether (ethertype) flexbytes (flexbytes_value) \
3345 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3348 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3349 mac (mac_address) vlan (vlan_value) \
3350 flexbytes (flexbytes_value) (drop|fwd) \
3351 queue (queue_id) fd_id (fd_id_value)
3353 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3354 mac (mac_address) vlan (vlan_value) \
3355 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3356 flexbytes (flexbytes_value) (drop|fwd) \
3357 queue (queue_id) fd_id (fd_id_value)
3359 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3360 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3361 packet (packet file name)
3363 For example, to add an ipv4-udp flow type filter::
3365 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3366 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3367 fwd pf queue 1 fd_id 1
3369 For example, add an ipv4-other flow type filter::
3371 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3372 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3373 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3378 Flush all flow director filters on a device::
3380 testpmd> flush_flow_director (port_id)
3382 Example, to flush all flow director filter on port 0::
3384 testpmd> flush_flow_director 0
3389 Set flow director's input masks::
3391 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3392 src_mask (ipv4_src) (ipv6_src) (src_port) \
3393 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3395 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3397 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3398 mac (mac_value) tunnel-type (tunnel_type_value) \
3399 tunnel-id (tunnel_id_value)
3401 Example, to set flow director mask on port 0::
3403 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3404 src_mask 255.255.255.255 \
3405 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3406 dst_mask 255.255.255.255 \
3407 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3409 flow_director_flex_mask
3410 ~~~~~~~~~~~~~~~~~~~~~~~
3412 set masks of flow director's flexible payload based on certain flow type::
3414 testpmd> flow_director_flex_mask (port_id) \
3415 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3416 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3417 l2_payload|all) (mask)
3419 Example, to set flow director's flex mask for all flow type on port 0::
3421 testpmd> flow_director_flex_mask 0 flow all \
3422 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3425 flow_director_flex_payload
3426 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3428 Configure flexible payload selection::
3430 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3432 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3434 testpmd> flow_director_flex_payload 0 l4 \
3435 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3437 get_sym_hash_ena_per_port
3438 ~~~~~~~~~~~~~~~~~~~~~~~~~
3440 Get symmetric hash enable configuration per port::
3442 get_sym_hash_ena_per_port (port_id)
3444 For example, to get symmetric hash enable configuration of port 1::
3446 testpmd> get_sym_hash_ena_per_port 1
3448 set_sym_hash_ena_per_port
3449 ~~~~~~~~~~~~~~~~~~~~~~~~~
3451 Set symmetric hash enable configuration per port to enable or disable::
3453 set_sym_hash_ena_per_port (port_id) (enable|disable)
3455 For example, to set symmetric hash enable configuration of port 1 to enable::
3457 testpmd> set_sym_hash_ena_per_port 1 enable
3459 get_hash_global_config
3460 ~~~~~~~~~~~~~~~~~~~~~~
3462 Get the global configurations of hash filters::
3464 get_hash_global_config (port_id)
3466 For example, to get the global configurations of hash filters of port 1::
3468 testpmd> get_hash_global_config 1
3470 set_hash_global_config
3471 ~~~~~~~~~~~~~~~~~~~~~~
3473 Set the global configurations of hash filters::
3475 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3476 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3477 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3480 For example, to enable simple_xor for flow type of ipv6 on port 2::
3482 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3487 Set the input set for hash::
3489 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3490 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3491 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3492 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3493 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3494 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3495 fld-8th|none) (select|add)
3497 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3499 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3504 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3505 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3507 Set the input set for flow director::
3509 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3510 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3511 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3512 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3513 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3514 sctp-dst-port|sctp-veri-tag|none) (select|add)
3516 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3518 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3523 Set different GRE key length for input set::
3525 global_config (port_id) gre-key-len (number in bytes)
3527 For example to set GRE key length for input set to 4 bytes on port 0::
3529 testpmd> global_config 0 gre-key-len 4
3532 .. _testpmd_rte_flow:
3534 Flow rules management
3535 ---------------------
3537 Control of the generic flow API (*rte_flow*) is fully exposed through the
3538 ``flow`` command (validation, creation, destruction, queries and operation
3541 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3542 features simultaneously may cause undefined side-effects and is therefore
3548 Because the ``flow`` command uses dynamic tokens to handle the large number
3549 of possible flow rules combinations, its behavior differs slightly from
3550 other commands, in particular:
3552 - Pressing *?* or the *<tab>* key displays contextual help for the current
3553 token, not that of the entire command.
3555 - Optional and repeated parameters are supported (provided they are listed
3556 in the contextual help).
3558 The first parameter stands for the operation mode. Possible operations and
3559 their general syntax are described below. They are covered in detail in the
3562 - Check whether a flow rule can be created::
3564 flow validate {port_id}
3565 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3566 pattern {item} [/ {item} [...]] / end
3567 actions {action} [/ {action} [...]] / end
3569 - Create a flow rule::
3571 flow create {port_id}
3572 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3573 pattern {item} [/ {item} [...]] / end
3574 actions {action} [/ {action} [...]] / end
3576 - Destroy specific flow rules::
3578 flow destroy {port_id} rule {rule_id} [...]
3580 - Destroy all flow rules::
3582 flow flush {port_id}
3584 - Query an existing flow rule::
3586 flow query {port_id} {rule_id} {action}
3588 - List existing flow rules sorted by priority, filtered by group
3591 flow list {port_id} [group {group_id}] [...]
3593 - Restrict ingress traffic to the defined flow rules::
3595 flow isolate {port_id} {boolean}
3597 Validating flow rules
3598 ~~~~~~~~~~~~~~~~~~~~~
3600 ``flow validate`` reports whether a flow rule would be accepted by the
3601 underlying device in its current state but stops short of creating it. It is
3602 bound to ``rte_flow_validate()``::
3604 flow validate {port_id}
3605 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3606 pattern {item} [/ {item} [...]] / end
3607 actions {action} [/ {action} [...]] / end
3609 If successful, it will show::
3613 Otherwise it will show an error message of the form::
3615 Caught error type [...] ([...]): [...]
3617 This command uses the same parameters as ``flow create``, their format is
3618 described in `Creating flow rules`_.
3620 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3621 index 6 is supported::
3623 testpmd> flow validate 0 ingress pattern eth / end
3624 actions queue index 6 / end
3628 Port 0 does not support TCPv6 rules::
3630 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3632 Caught error type 9 (specific pattern item): Invalid argument
3638 ``flow create`` validates and creates the specified flow rule. It is bound
3639 to ``rte_flow_create()``::
3641 flow create {port_id}
3642 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3643 pattern {item} [/ {item} [...]] / end
3644 actions {action} [/ {action} [...]] / end
3646 If successful, it will return a flow rule ID usable with other commands::
3648 Flow rule #[...] created
3650 Otherwise it will show an error message of the form::
3652 Caught error type [...] ([...]): [...]
3654 Parameters describe in the following order:
3656 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3657 - A matching pattern, starting with the *pattern* token and terminated by an
3659 - Actions, starting with the *actions* token and terminated by an *end*
3662 These translate directly to *rte_flow* objects provided as-is to the
3663 underlying functions.
3665 The shortest valid definition only comprises mandatory tokens::
3667 testpmd> flow create 0 pattern end actions end
3669 Note that PMDs may refuse rules that essentially do nothing such as this
3672 **All unspecified object values are automatically initialized to 0.**
3677 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3678 specified before the ``pattern`` token.
3680 - ``group {group id}``: priority group.
3681 - ``priority {level}``: priority level within group.
3682 - ``ingress``: rule applies to ingress traffic.
3683 - ``egress``: rule applies to egress traffic.
3684 - ``transfer``: apply rule directly to endpoints found in pattern.
3686 Each instance of an attribute specified several times overrides the previous
3687 value as shown below (group 4 is used)::
3689 testpmd> flow create 0 group 42 group 24 group 4 [...]
3691 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3693 While not specifying a direction is an error, some rules may allow both
3696 Most rules affect RX therefore contain the ``ingress`` token::
3698 testpmd> flow create 0 ingress pattern [...]
3703 A matching pattern starts after the ``pattern`` token. It is made of pattern
3704 items and is terminated by a mandatory ``end`` item.
3706 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3707 rte_flow_item_type``).
3709 The ``/`` token is used as a separator between pattern items as shown
3712 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3714 Note that protocol items like these must be stacked from lowest to highest
3715 layer to make sense. For instance, the following rule is either invalid or
3716 unlikely to match any packet::
3718 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3720 More information on these restrictions can be found in the *rte_flow*
3723 Several items support additional specification structures, for example
3724 ``ipv4`` allows specifying source and destination addresses as follows::
3726 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3727 dst is 10.2.0.0 / end [...]
3729 This rule matches all IPv4 traffic with the specified properties.
3731 In this example, ``src`` and ``dst`` are field names of the underlying
3732 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3733 in a similar fashion.
3735 The ``is`` token means that the subsequent value must be matched exactly,
3736 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3737 accordingly. Possible assignment tokens are:
3739 - ``is``: match value perfectly (with full bit-mask).
3740 - ``spec``: match value according to configured bit-mask.
3741 - ``last``: specify upper bound to establish a range.
3742 - ``mask``: specify bit-mask with relevant bits set to one.
3743 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3745 These yield identical results::
3747 ipv4 src is 10.1.1.1
3751 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3755 ipv4 src spec 10.1.1.1 src prefix 32
3759 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3763 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3765 Inclusive ranges can be defined with ``last``::
3767 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3769 Note that ``mask`` affects both ``spec`` and ``last``::
3771 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3772 # matches 10.1.0.0 to 10.2.255.255
3774 Properties can be modified multiple times::
3776 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3780 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3785 This section lists supported pattern items and their attributes, if any.
3787 - ``end``: end list of pattern items.
3789 - ``void``: no-op pattern item.
3791 - ``invert``: perform actions when pattern does not match.
3793 - ``any``: match any protocol for the current layer.
3795 - ``num {unsigned}``: number of layers covered.
3797 - ``pf``: match traffic from/to the physical function.
3799 - ``vf``: match traffic from/to a virtual function ID.
3801 - ``id {unsigned}``: VF ID.
3803 - ``phy_port``: match traffic from/to a specific physical port.
3805 - ``index {unsigned}``: physical port index.
3807 - ``port_id``: match traffic from/to a given DPDK port ID.
3809 - ``id {unsigned}``: DPDK port ID.
3811 - ``mark``: match value set in previously matched flow rule using the mark action.
3813 - ``id {unsigned}``: arbitrary integer value.
3815 - ``raw``: match an arbitrary byte string.
3817 - ``relative {boolean}``: look for pattern after the previous item.
3818 - ``search {boolean}``: search pattern from offset (see also limit).
3819 - ``offset {integer}``: absolute or relative offset for pattern.
3820 - ``limit {unsigned}``: search area limit for start of pattern.
3821 - ``pattern {string}``: byte string to look for.
3823 - ``eth``: match Ethernet header.
3825 - ``dst {MAC-48}``: destination MAC.
3826 - ``src {MAC-48}``: source MAC.
3827 - ``type {unsigned}``: EtherType or TPID.
3829 - ``vlan``: match 802.1Q/ad VLAN tag.
3831 - ``tci {unsigned}``: tag control information.
3832 - ``pcp {unsigned}``: priority code point.
3833 - ``dei {unsigned}``: drop eligible indicator.
3834 - ``vid {unsigned}``: VLAN identifier.
3835 - ``inner_type {unsigned}``: inner EtherType or TPID.
3837 - ``ipv4``: match IPv4 header.
3839 - ``tos {unsigned}``: type of service.
3840 - ``ttl {unsigned}``: time to live.
3841 - ``proto {unsigned}``: next protocol ID.
3842 - ``src {ipv4 address}``: source address.
3843 - ``dst {ipv4 address}``: destination address.
3845 - ``ipv6``: match IPv6 header.
3847 - ``tc {unsigned}``: traffic class.
3848 - ``flow {unsigned}``: flow label.
3849 - ``proto {unsigned}``: protocol (next header).
3850 - ``hop {unsigned}``: hop limit.
3851 - ``src {ipv6 address}``: source address.
3852 - ``dst {ipv6 address}``: destination address.
3854 - ``icmp``: match ICMP header.
3856 - ``type {unsigned}``: ICMP packet type.
3857 - ``code {unsigned}``: ICMP packet code.
3859 - ``udp``: match UDP header.
3861 - ``src {unsigned}``: UDP source port.
3862 - ``dst {unsigned}``: UDP destination port.
3864 - ``tcp``: match TCP header.
3866 - ``src {unsigned}``: TCP source port.
3867 - ``dst {unsigned}``: TCP destination port.
3869 - ``sctp``: match SCTP header.
3871 - ``src {unsigned}``: SCTP source port.
3872 - ``dst {unsigned}``: SCTP destination port.
3873 - ``tag {unsigned}``: validation tag.
3874 - ``cksum {unsigned}``: checksum.
3876 - ``vxlan``: match VXLAN header.
3878 - ``vni {unsigned}``: VXLAN identifier.
3880 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3882 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3884 - ``nvgre``: match NVGRE header.
3886 - ``tni {unsigned}``: virtual subnet ID.
3888 - ``mpls``: match MPLS header.
3890 - ``label {unsigned}``: MPLS label.
3892 - ``gre``: match GRE header.
3894 - ``protocol {unsigned}``: protocol type.
3896 - ``gre_key``: match GRE optional key field.
3898 - ``value {unsigned}``: key value.
3900 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3902 - ``thresh {unsigned}``: accuracy threshold.
3904 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3906 - ``teid {unsigned}``: tunnel endpoint identifier.
3908 - ``geneve``: match GENEVE header.
3910 - ``vni {unsigned}``: virtual network identifier.
3911 - ``protocol {unsigned}``: protocol type.
3913 - ``vxlan-gpe``: match VXLAN-GPE header.
3915 - ``vni {unsigned}``: VXLAN-GPE identifier.
3917 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3919 - ``sha {MAC-48}``: sender hardware address.
3920 - ``spa {ipv4 address}``: sender IPv4 address.
3921 - ``tha {MAC-48}``: target hardware address.
3922 - ``tpa {ipv4 address}``: target IPv4 address.
3924 - ``ipv6_ext``: match presence of any IPv6 extension header.
3926 - ``next_hdr {unsigned}``: next header.
3928 - ``icmp6``: match any ICMPv6 header.
3930 - ``type {unsigned}``: ICMPv6 type.
3931 - ``code {unsigned}``: ICMPv6 code.
3933 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3935 - ``target_addr {ipv6 address}``: target address.
3937 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3939 - ``target_addr {ipv6 address}``: target address.
3941 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3943 - ``type {unsigned}``: ND option type.
3945 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3946 link-layer address option.
3948 - ``sla {MAC-48}``: source Ethernet LLA.
3950 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3951 link-layer address option.
3953 - ``tla {MAC-48}``: target Ethernet LLA.
3955 - ``meta``: match application specific metadata.
3957 - ``data {unsigned}``: metadata value.
3959 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3961 - ``pdu_type {unsigned}``: PDU type.
3962 - ``qfi {unsigned}``: QoS flow identifier.
3964 - ``pppoes``, ``pppoed``: match PPPoE header.
3966 - ``session_id {unsigned}``: session identifier.
3968 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3970 - ``proto_id {unsigned}``: PPP protocol identifier.
3972 - ``l2tpv3oip``: match L2TPv3 over IP header.
3974 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
3979 A list of actions starts after the ``actions`` token in the same fashion as
3980 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3981 terminated by a mandatory ``end`` action.
3983 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3984 rte_flow_action_type``).
3986 Dropping all incoming UDPv4 packets can be expressed as follows::
3988 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3991 Several actions have configurable properties which must be specified when
3992 there is no valid default value. For example, ``queue`` requires a target
3995 This rule redirects incoming UDPv4 traffic to queue index 6::
3997 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3998 actions queue index 6 / end
4000 While this one could be rejected by PMDs (unspecified queue index)::
4002 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4005 As defined by *rte_flow*, the list is not ordered, all actions of a given
4006 rule are performed simultaneously. These are equivalent::
4008 queue index 6 / void / mark id 42 / end
4012 void / mark id 42 / queue index 6 / end
4014 All actions in a list should have different types, otherwise only the last
4015 action of a given type is taken into account::
4017 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4021 drop / drop / drop / end # drop is performed only once
4025 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4027 Considering they are performed simultaneously, opposite and overlapping
4028 actions can sometimes be combined when the end result is unambiguous::
4030 drop / queue index 6 / end # drop has no effect
4034 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4038 drop / passthru / end # drop has no effect
4040 Note that PMDs may still refuse such combinations.
4045 This section lists supported actions and their attributes, if any.
4047 - ``end``: end list of actions.
4049 - ``void``: no-op action.
4051 - ``passthru``: let subsequent rule process matched packets.
4053 - ``jump``: redirect traffic to group on device.
4055 - ``group {unsigned}``: group to redirect to.
4057 - ``mark``: attach 32 bit value to packets.
4059 - ``id {unsigned}``: 32 bit value to return with packets.
4061 - ``flag``: flag packets.
4063 - ``queue``: assign packets to a given queue index.
4065 - ``index {unsigned}``: queue index to use.
4067 - ``drop``: drop packets (note: passthru has priority).
4069 - ``count``: enable counters for this rule.
4071 - ``rss``: spread packets among several queues.
4073 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4074 the same as `set_hash_global_config`_.
4076 - ``level {unsigned}``: encapsulation level for ``types``.
4078 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4079 tokens are the same as `set_hash_input_set`_, except that an empty list
4080 does not disable RSS but instead requests unspecified "best-effort"
4083 - ``key {string}``: RSS hash key, overrides ``key_len``.
4085 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4086 conjunction with ``key`` to pad or truncate it.
4088 - ``queues [{unsigned} [...]] end``: queue indices to use.
4090 - ``pf``: direct traffic to physical function.
4092 - ``vf``: direct traffic to a virtual function ID.
4094 - ``original {boolean}``: use original VF ID if possible.
4095 - ``id {unsigned}``: VF ID.
4097 - ``phy_port``: direct packets to physical port index.
4099 - ``original {boolean}``: use original port index if possible.
4100 - ``index {unsigned}``: physical port index.
4102 - ``port_id``: direct matching traffic to a given DPDK port ID.
4104 - ``original {boolean}``: use original DPDK port ID if possible.
4105 - ``id {unsigned}``: DPDK port ID.
4107 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4109 - ``mpls_ttl``: MPLS TTL.
4111 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4113 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4115 - ``nw_ttl``: IP TTL.
4117 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4119 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4121 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4123 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4125 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4127 - ``ethertype``: Ethertype.
4129 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4131 - ``vlan_vid``: VLAN id.
4133 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4135 - ``vlan_pcp``: VLAN priority.
4137 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4139 - ``ethertype``: Ethertype.
4141 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4143 - ``ethertype``: Ethertype.
4145 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4146 is done through `Config VXLAN Encap outer layers`_.
4148 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4149 the VXLAN tunnel network overlay from the matched flow.
4151 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4152 is done through `Config NVGRE Encap outer layers`_.
4154 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4155 the NVGRE tunnel network overlay from the matched flow.
4157 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4158 is done through `Config L2 Encap`_.
4160 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4161 is done through `Config L2 Decap`_.
4163 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4164 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4166 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4167 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4169 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4170 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4172 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4173 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4175 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4177 - ``ipv4_addr``: New IPv4 source address.
4179 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4182 - ``ipv4_addr``: New IPv4 destination address.
4184 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4186 - ``ipv6_addr``: New IPv6 source address.
4188 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4191 - ``ipv6_addr``: New IPv6 destination address.
4193 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4196 - ``port``: New TCP/UDP source port number.
4198 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4201 - ``port``: New TCP/UDP destination port number.
4203 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4206 - ``dec_ttl``: Performs a decrease TTL value action
4208 - ``set_ttl``: Set TTL value with specified value
4209 - ``ttl_value {unsigned}``: The new TTL value to be set
4211 - ``set_mac_src``: set source MAC address
4213 - ``mac_addr {MAC-48}``: new source MAC address
4215 - ``set_mac_dst``: set destination MAC address
4217 - ``mac_addr {MAC-48}``: new destination MAC address
4219 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4221 - ``value {unsigned}``: Value to increase TCP sequence number by.
4223 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4225 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4227 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4229 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4231 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4233 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4235 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4237 - ``dscp_value {unsigned}``: The new DSCP value to be set
4239 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4241 - ``dscp_value {unsigned}``: The new DSCP value to be set
4243 Destroying flow rules
4244 ~~~~~~~~~~~~~~~~~~~~~
4246 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4247 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4248 times as necessary::
4250 flow destroy {port_id} rule {rule_id} [...]
4252 If successful, it will show::
4254 Flow rule #[...] destroyed
4256 It does not report anything for rule IDs that do not exist. The usual error
4257 message is shown when a rule cannot be destroyed::
4259 Caught error type [...] ([...]): [...]
4261 ``flow flush`` destroys all rules on a device and does not take extra
4262 arguments. It is bound to ``rte_flow_flush()``::
4264 flow flush {port_id}
4266 Any errors are reported as above.
4268 Creating several rules and destroying them::
4270 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4271 actions queue index 2 / end
4272 Flow rule #0 created
4273 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4274 actions queue index 3 / end
4275 Flow rule #1 created
4276 testpmd> flow destroy 0 rule 0 rule 1
4277 Flow rule #1 destroyed
4278 Flow rule #0 destroyed
4281 The same result can be achieved using ``flow flush``::
4283 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4284 actions queue index 2 / end
4285 Flow rule #0 created
4286 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4287 actions queue index 3 / end
4288 Flow rule #1 created
4289 testpmd> flow flush 0
4292 Non-existent rule IDs are ignored::
4294 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4295 actions queue index 2 / end
4296 Flow rule #0 created
4297 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4298 actions queue index 3 / end
4299 Flow rule #1 created
4300 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4302 testpmd> flow destroy 0 rule 0
4303 Flow rule #0 destroyed
4309 ``flow query`` queries a specific action of a flow rule having that
4310 ability. Such actions collect information that can be reported using this
4311 command. It is bound to ``rte_flow_query()``::
4313 flow query {port_id} {rule_id} {action}
4315 If successful, it will display either the retrieved data for known actions
4316 or the following message::
4318 Cannot display result for action type [...] ([...])
4320 Otherwise, it will complain either that the rule does not exist or that some
4323 Flow rule #[...] not found
4327 Caught error type [...] ([...]): [...]
4329 Currently only the ``count`` action is supported. This action reports the
4330 number of packets that hit the flow rule and the total number of bytes. Its
4331 output has the following format::
4334 hits_set: [...] # whether "hits" contains a valid value
4335 bytes_set: [...] # whether "bytes" contains a valid value
4336 hits: [...] # number of packets
4337 bytes: [...] # number of bytes
4339 Querying counters for TCPv6 packets redirected to queue 6::
4341 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4342 actions queue index 6 / count / end
4343 Flow rule #4 created
4344 testpmd> flow query 0 4 count
4355 ``flow list`` lists existing flow rules sorted by priority and optionally
4356 filtered by group identifiers::
4358 flow list {port_id} [group {group_id}] [...]
4360 This command only fails with the following message if the device does not
4365 Output consists of a header line followed by a short description of each
4366 flow rule, one per line. There is no output at all when no flow rules are
4367 configured on the device::
4369 ID Group Prio Attr Rule
4370 [...] [...] [...] [...] [...]
4372 ``Attr`` column flags:
4374 - ``i`` for ``ingress``.
4375 - ``e`` for ``egress``.
4377 Creating several flow rules and listing them::
4379 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4380 actions queue index 6 / end
4381 Flow rule #0 created
4382 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4383 actions queue index 2 / end
4384 Flow rule #1 created
4385 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4386 actions rss queues 6 7 8 end / end
4387 Flow rule #2 created
4388 testpmd> flow list 0
4389 ID Group Prio Attr Rule
4390 0 0 0 i- ETH IPV4 => QUEUE
4391 1 0 0 i- ETH IPV6 => QUEUE
4392 2 0 5 i- ETH IPV4 UDP => RSS
4395 Rules are sorted by priority (i.e. group ID first, then priority level)::
4397 testpmd> flow list 1
4398 ID Group Prio Attr Rule
4399 0 0 0 i- ETH => COUNT
4400 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4401 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4402 1 24 0 i- ETH IPV4 UDP => QUEUE
4403 4 24 10 i- ETH IPV4 TCP => DROP
4404 3 24 20 i- ETH IPV4 => DROP
4405 2 24 42 i- ETH IPV4 UDP => QUEUE
4406 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4409 Output can be limited to specific groups::
4411 testpmd> flow list 1 group 0 group 63
4412 ID Group Prio Attr Rule
4413 0 0 0 i- ETH => COUNT
4414 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4415 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4416 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4419 Toggling isolated mode
4420 ~~~~~~~~~~~~~~~~~~~~~~
4422 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4423 must only be injected from the defined flow rules; that no default traffic
4424 is expected outside those rules and the driver is free to assign more
4425 resources to handle them. It is bound to ``rte_flow_isolate()``::
4427 flow isolate {port_id} {boolean}
4429 If successful, enabling or disabling isolated mode shows either::
4431 Ingress traffic on port [...]
4432 is now restricted to the defined flow rules
4436 Ingress traffic on port [...]
4437 is not restricted anymore to the defined flow rules
4439 Otherwise, in case of error::
4441 Caught error type [...] ([...]): [...]
4443 Mainly due to its side effects, PMDs supporting this mode may not have the
4444 ability to toggle it more than once without reinitializing affected ports
4445 first (e.g. by exiting testpmd).
4447 Enabling isolated mode::
4449 testpmd> flow isolate 0 true
4450 Ingress traffic on port 0 is now restricted to the defined flow rules
4453 Disabling isolated mode::
4455 testpmd> flow isolate 0 false
4456 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4459 Sample QinQ flow rules
4460 ~~~~~~~~~~~~~~~~~~~~~~
4462 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4464 testpmd> port stop 0
4465 testpmd> vlan set qinq_strip on 0
4467 The above command sets the inner and outer TPID's to 0x8100.
4469 To change the TPID's the following commands should be used::
4471 testpmd> vlan set outer tpid 0xa100 0
4472 testpmd> vlan set inner tpid 0x9100 0
4473 testpmd> port start 0
4475 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4479 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4480 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4481 Flow rule #0 validated
4483 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4484 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4485 Flow rule #0 created
4487 testpmd> flow list 0
4488 ID Group Prio Attr Rule
4489 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4491 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4495 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4496 vlan tci is 654 / end actions pf / queue index 0 / end
4497 Flow rule #1 validated
4499 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4500 vlan tci is 654 / end actions pf / queue index 1 / end
4501 Flow rule #1 created
4503 testpmd> flow list 0
4504 ID Group Prio Attr Rule
4505 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4506 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4508 Sample VXLAN encapsulation rule
4509 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4511 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4512 source code, those can be changed by using the following commands
4514 IPv4 VXLAN outer header::
4516 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4517 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4518 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4521 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4522 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4523 eth-dst 22:22:22:22:22:22
4524 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4527 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4528 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4529 eth-dst 22:22:22:22:22:22
4530 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4533 IPv6 VXLAN outer header::
4535 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4536 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4537 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4540 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4541 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4542 eth-dst 22:22:22:22:22:22
4543 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4546 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4547 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4548 eth-dst 22:22:22:22:22:22
4549 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4552 Sample NVGRE encapsulation rule
4553 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4555 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4556 source code, those can be changed by using the following commands
4558 IPv4 NVGRE outer header::
4560 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4561 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4562 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4565 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4566 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4567 eth-dst 22:22:22:22:22:22
4568 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4571 IPv6 NVGRE outer header::
4573 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4574 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4575 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4578 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4579 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4580 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4583 Sample L2 encapsulation rule
4584 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4586 L2 encapsulation has default value pre-configured in testpmd
4587 source code, those can be changed by using the following commands
4591 testpmd> set l2_encap ip-version ipv4
4592 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4593 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4594 mplsoudp_decap / l2_encap / end
4596 L2 with VXLAN header::
4598 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4599 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4600 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4601 mplsoudp_decap / l2_encap / end
4603 Sample L2 decapsulation rule
4604 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4606 L2 decapsulation has default value pre-configured in testpmd
4607 source code, those can be changed by using the following commands
4611 testpmd> set l2_decap
4612 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4615 L2 with VXLAN header::
4617 testpmd> set l2_encap-with-vlan
4618 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4621 Sample MPLSoGRE encapsulation rule
4622 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4624 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4625 source code, those can be changed by using the following commands
4627 IPv4 MPLSoGRE outer header::
4629 testpmd> set mplsogre_encap ip-version ipv4 label 4
4630 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4631 eth-dst 22:22:22:22:22:22
4632 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4633 mplsogre_encap / end
4635 IPv4 MPLSoGRE with VLAN outer header::
4637 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4638 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4639 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4640 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4641 mplsogre_encap / end
4643 IPv6 MPLSoGRE outer header::
4645 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4646 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4647 eth-dst 22:22:22:22:22:22
4648 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4649 mplsogre_encap / end
4651 IPv6 MPLSoGRE with VLAN outer header::
4653 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4654 ip-src ::1 ip-dst ::2222 vlan-tci 34
4655 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4656 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4657 mplsogre_encap / end
4659 Sample MPLSoGRE decapsulation rule
4660 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4662 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4663 source code, those can be changed by using the following commands
4665 IPv4 MPLSoGRE outer header::
4667 testpmd> set mplsogre_decap ip-version ipv4
4668 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4669 mplsogre_decap / l2_encap / end
4671 IPv4 MPLSoGRE with VLAN outer header::
4673 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4674 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4675 actions mplsogre_decap / l2_encap / end
4677 IPv6 MPLSoGRE outer header::
4679 testpmd> set mplsogre_decap ip-version ipv6
4680 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4681 actions mplsogre_decap / l2_encap / end
4683 IPv6 MPLSoGRE with VLAN outer header::
4685 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4686 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4687 actions mplsogre_decap / l2_encap / end
4689 Sample MPLSoUDP encapsulation rule
4690 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4692 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4693 source code, those can be changed by using the following commands
4695 IPv4 MPLSoUDP outer header::
4697 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4698 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4699 eth-dst 22:22:22:22:22:22
4700 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4701 mplsoudp_encap / end
4703 IPv4 MPLSoUDP with VLAN outer header::
4705 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4706 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4707 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4708 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4709 mplsoudp_encap / end
4711 IPv6 MPLSoUDP outer header::
4713 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4714 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4715 eth-dst 22:22:22:22:22:22
4716 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4717 mplsoudp_encap / end
4719 IPv6 MPLSoUDP with VLAN outer header::
4721 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4722 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4723 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4724 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4725 mplsoudp_encap / end
4727 Sample MPLSoUDP decapsulation rule
4728 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4730 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4731 source code, those can be changed by using the following commands
4733 IPv4 MPLSoUDP outer header::
4735 testpmd> set mplsoudp_decap ip-version ipv4
4736 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4737 mplsoudp_decap / l2_encap / end
4739 IPv4 MPLSoUDP with VLAN outer header::
4741 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4742 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4743 actions mplsoudp_decap / l2_encap / end
4745 IPv6 MPLSoUDP outer header::
4747 testpmd> set mplsoudp_decap ip-version ipv6
4748 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4749 actions mplsoudp_decap / l2_encap / end
4751 IPv6 MPLSoUDP with VLAN outer header::
4753 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4754 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4755 actions mplsoudp_decap / l2_encap / end
4757 Sample Raw encapsulation rule
4758 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4760 Raw encapsulation configuration can be set by the following commands
4762 Eecapsulating VxLAN::
4764 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4765 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4767 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4768 raw_encap index 4 / end
4770 Sample Raw decapsulation rule
4771 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4773 Raw decapsulation configuration can be set by the following commands
4775 Decapsulating VxLAN::
4777 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4778 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4779 end actions raw_decap / queue index 0 / end
4784 ESP rules can be created by the following commands::
4786 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
4788 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
4789 actions queue index 3 / end
4790 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
4792 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
4793 actions queue index 3 / end
4798 The following sections show functions to load/unload eBPF based filters.
4803 Load an eBPF program as a callback for particular RX/TX queue::
4805 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4807 The available load-flags are:
4809 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4811 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4817 You'll need clang v3.7 or above to build bpf program you'd like to load
4821 .. code-block:: console
4824 clang -O2 -target bpf -c t1.c
4826 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4828 .. code-block:: console
4830 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4832 To load (not JITed) t1.o at TX queue 0, port 0:
4834 .. code-block:: console
4836 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4841 Unload previously loaded eBPF program for particular RX/TX queue::
4843 testpmd> bpf-unload rx|tx (portid) (queueid)
4845 For example to unload BPF filter from TX queue 0, port 0:
4847 .. code-block:: console
4849 testpmd> bpf-unload tx 0 0