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)
493 Show general information about devices probed::
495 testpmd> show device info (<identifier>|all)
499 .. code-block:: console
501 testpmd> show device info net_pcap0
503 ********************* Infos for device net_pcap0 *********************
505 Driver name: net_pcap
506 Devargs: iface=enP2p6s0,phy_mac=1
507 Connect to socket: -1
510 MAC address: 1E:37:93:28:04:B8
511 Device name: net_pcap0
516 Dumps all physical memory segment layouts::
518 testpmd> dump_physmem
523 Dumps the layout of all memory zones::
525 testpmd> dump_memzone
531 Dumps the size of all memory structures::
533 testpmd> dump_struct_sizes
538 Dumps the status of all or specific element in DPDK rings::
540 testpmd> dump_ring [ring_name]
545 Dumps the statistics of all or specific memory pool::
547 testpmd> dump_mempool [mempool_name]
552 Dumps the user device list::
554 testpmd> dump_devargs
559 Dumps the log level for all the dpdk modules::
561 testpmd> dump_log_types
563 show (raw_encap|raw_decap)
564 ~~~~~~~~~~~~~~~~~~~~~~~~~~
566 Display content of raw_encap/raw_decap buffers in hex::
568 testpmd> show <raw_encap|raw_decap> <index>
569 testpmd> show <raw_encap|raw_decap> all
573 testpmd> show raw_encap 6
575 index: 6 at [0x1c565b0], len=50
576 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
577 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
578 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
582 Configuration Functions
583 -----------------------
585 The testpmd application can be configured from the runtime as well as from the command-line.
587 This section details the available configuration functions that are available.
591 Configuration changes only become active when forwarding is started/restarted.
596 Reset forwarding to the default configuration::
603 Set the debug verbosity level::
605 testpmd> set verbose (level)
607 Available levels are as following:
609 * ``0`` silent except for error.
610 * ``1`` fully verbose except for Tx packets.
611 * ``2`` fully verbose except for Rx packets.
612 * ``> 2`` fully verbose.
617 Set the log level for a log type::
619 testpmd> set log global|(type) (level)
623 * ``type`` is the log name.
625 * ``level`` is the log level.
627 For example, to change the global log level::
629 testpmd> set log global (level)
631 Regexes can also be used for type. To change log level of user1, user2 and user3::
633 testpmd> set log user[1-3] (level)
638 Set the number of ports used by the application:
642 This is equivalent to the ``--nb-ports`` command-line option.
647 Set the number of cores used by the application::
649 testpmd> set nbcore (num)
651 This is equivalent to the ``--nb-cores`` command-line option.
655 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
660 Set the forwarding cores hexadecimal mask::
662 testpmd> set coremask (mask)
664 This is equivalent to the ``--coremask`` command-line option.
668 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
673 Set the forwarding ports hexadecimal mask::
675 testpmd> set portmask (mask)
677 This is equivalent to the ``--portmask`` command-line option.
682 Set number of packets per burst::
684 testpmd> set burst (num)
686 This is equivalent to the ``--burst command-line`` option.
688 When retry is enabled, the transmit delay time and number of retries can also be set::
690 testpmd> set burst tx delay (microseconds) retry (num)
695 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
697 testpmd> set txpkts (x[,y]*)
699 Where x[,y]* represents a CSV list of values, without white space.
704 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
706 testpmd> set txsplit (off|on|rand)
710 * ``off`` disable packet copy & split for CSUM mode.
712 * ``on`` split outgoing packet into multiple segments. Size of each segment
713 and number of segments per packet is determined by ``set txpkts`` command
716 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
721 Set the list of forwarding cores::
723 testpmd> set corelist (x[,y]*)
725 For example, to change the forwarding cores:
727 .. code-block:: console
729 testpmd> set corelist 3,1
730 testpmd> show config fwd
732 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
733 Logical Core 3 (socket 0) forwards packets on 1 streams:
734 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
735 Logical Core 1 (socket 0) forwards packets on 1 streams:
736 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
740 The cores are used in the same order as specified on the command line.
745 Set the list of forwarding ports::
747 testpmd> set portlist (x[,y]*)
749 For example, to change the port forwarding:
751 .. code-block:: console
753 testpmd> set portlist 0,2,1,3
754 testpmd> show config fwd
756 io packet forwarding - ports=4 - cores=1 - streams=4
757 Logical Core 3 (socket 0) forwards packets on 4 streams:
758 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
759 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
760 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
761 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
766 Select how to retrieve new ports created after "port attach" command::
768 testpmd> set port setup on (iterator|event)
770 For each new port, a setup is done.
771 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
772 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
777 Enable/disable tx loopback::
779 testpmd> set tx loopback (port_id) (on|off)
784 set drop enable bit for all queues::
786 testpmd> set all queues drop (port_id) (on|off)
788 set split drop enable (for VF)
789 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
791 set split drop enable bit for VF from PF::
793 testpmd> set vf split drop (port_id) (vf_id) (on|off)
795 set mac antispoof (for VF)
796 ~~~~~~~~~~~~~~~~~~~~~~~~~~
798 Set mac antispoof for a VF from the PF::
800 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
805 Enable/disable MACsec offload::
807 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
808 testpmd> set macsec offload (port_id) off
813 Configure MACsec secure connection (SC)::
815 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
819 The pi argument is ignored for tx.
820 Check the NIC Datasheet for hardware limits.
825 Configure MACsec secure association (SA)::
827 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
831 The IDX value must be 0 or 1.
832 Check the NIC Datasheet for hardware limits.
834 set broadcast mode (for VF)
835 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
837 Set broadcast mode for a VF from the PF::
839 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
844 Set the VLAN strip for a queue on a port::
846 testpmd> vlan set stripq (on|off) (port_id,queue_id)
848 vlan set stripq (for VF)
849 ~~~~~~~~~~~~~~~~~~~~~~~~
851 Set VLAN strip for all queues in a pool for a VF from the PF::
853 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
855 vlan set insert (for VF)
856 ~~~~~~~~~~~~~~~~~~~~~~~~
858 Set VLAN insert for a VF from the PF::
860 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
862 vlan set tag (for VF)
863 ~~~~~~~~~~~~~~~~~~~~~
865 Set VLAN tag for a VF from the PF::
867 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
869 vlan set antispoof (for VF)
870 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
872 Set VLAN antispoof for a VF from the PF::
874 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
876 vlan set (strip|filter|qinq_strip|extend)
877 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
878 Set the VLAN strip/filter/QinQ strip/extend on for a port::
880 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
885 Set the inner or outer VLAN TPID for packet filtering on a port::
887 testpmd> vlan set (inner|outer) tpid (value) (port_id)
891 TPID value must be a 16-bit number (value <= 65536).
896 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
898 testpmd> rx_vlan add (vlan_id|all) (port_id)
902 VLAN filter must be set on that port. VLAN ID < 4096.
903 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
904 in VFTA table. This is important if enabling all vlan_ids.
909 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
911 testpmd> rx_vlan rm (vlan_id|all) (port_id)
916 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
918 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
923 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
925 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
930 Add a tunnel filter on a port::
932 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
933 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
934 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
936 The available information categories are:
938 * ``vxlan``: Set tunnel type as VXLAN.
940 * ``nvgre``: Set tunnel type as NVGRE.
942 * ``ipingre``: Set tunnel type as IP-in-GRE.
944 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
946 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
948 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
950 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
952 * ``imac``: Set filter type as Inner MAC.
954 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
956 * ``oip``: Set filter type as Outer IP.
958 * ``iip``: Set filter type as Inner IP.
962 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
963 192.168.2.2 0 ipingre oip 1 1
965 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
970 Remove a tunnel filter on a port::
972 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
973 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
974 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
979 Add an UDP port for VXLAN packet filter on a port::
981 testpmd> rx_vxlan_port add (udp_port) (port_id)
986 Remove an UDP port for VXLAN packet filter on a port::
988 testpmd> rx_vxlan_port rm (udp_port) (port_id)
993 Set hardware insertion of VLAN IDs in packets sent on a port::
995 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
997 For example, set a single VLAN ID (5) insertion on port 0::
1001 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1009 Set port based hardware insertion of VLAN ID in packets sent on a port::
1011 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1016 Disable hardware insertion of a VLAN header in packets sent on a port::
1018 testpmd> tx_vlan reset (port_id)
1023 Select hardware or software calculation of the checksum when
1024 transmitting a packet using the ``csum`` forwarding engine::
1026 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1030 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1032 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1033 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
1034 supported). See also the ``csum parse-tunnel`` command.
1036 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1037 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
1038 supported). See also the ``csum parse-tunnel`` command.
1042 Check the NIC Datasheet for hardware limits.
1047 Set RSS queue region span on a port::
1049 testpmd> set port (port_id) queue-region region_id (value) \
1050 queue_start_index (value) queue_num (value)
1052 Set flowtype mapping on a RSS queue region on a port::
1054 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1058 * For the flowtype(pctype) of packet,the specific index for each type has
1059 been defined in file i40e_type.h as enum i40e_filter_pctype.
1061 Set user priority mapping on a RSS queue region on a port::
1063 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1065 Flush all queue region related configuration on a port::
1067 testpmd> set port (port_id) queue-region flush (on|off)
1071 * ``on``: is just an enable function which server for other configuration,
1072 it is for all configuration about queue region from up layer,
1073 at first will only keep in DPDK software stored in driver,
1074 only after "flush on", it commit all configuration to HW.
1076 * ``"off``: is just clean all configuration about queue region just now,
1077 and restore all to DPDK i40e driver default config when start up.
1079 Show all queue region related configuration info on a port::
1081 testpmd> show port (port_id) queue-region
1085 Queue region only support on PF by now, so these command is
1086 only for configuration of queue region on PF port.
1091 Define how tunneled packets should be handled by the csum forward
1094 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1096 If enabled, the csum forward engine will try to recognize supported
1097 tunnel headers (vxlan, gre, ipip).
1099 If disabled, treat tunnel packets as non-tunneled packets (a inner
1100 header is handled as a packet payload).
1104 The port argument is the TX port like in the ``csum set`` command.
1108 Consider a packet in packet like the following::
1110 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1112 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1113 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1114 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1116 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1117 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1122 Display tx checksum offload configuration::
1124 testpmd> csum show (port_id)
1129 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1131 testpmd> tso set (segsize) (port_id)
1135 Check the NIC datasheet for hardware limits.
1140 Display the status of TCP Segmentation Offload::
1142 testpmd> tso show (port_id)
1147 Set tso segment size of tunneled packets for a port in csum engine::
1149 testpmd> tunnel_tso set (tso_segsz) (port_id)
1154 Display the status of tunneled TCP Segmentation Offload for a port::
1156 testpmd> tunnel_tso show (port_id)
1161 Enable or disable GRO in ``csum`` forwarding engine::
1163 testpmd> set port <port_id> gro on|off
1165 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1166 packets received from the given port.
1168 If disabled, packets received from the given port won't be performed
1169 GRO. By default, GRO is disabled for all ports.
1173 When enable GRO for a port, TCP/IPv4 packets received from the port
1174 will be performed GRO. After GRO, all merged packets have bad
1175 checksums, since the GRO library doesn't re-calculate checksums for
1176 the merged packets. Therefore, if users want the merged packets to
1177 have correct checksums, please select HW IP checksum calculation and
1178 HW TCP checksum calculation for the port which the merged packets are
1184 Display GRO configuration for a given port::
1186 testpmd> show port <port_id> gro
1191 Set the cycle to flush the GROed packets from reassembly tables::
1193 testpmd> set gro flush <cycles>
1195 When enable GRO, the csum forwarding engine performs GRO on received
1196 packets, and the GROed packets are stored in reassembly tables. Users
1197 can use this command to determine when the GROed packets are flushed
1198 from the reassembly tables.
1200 The ``cycles`` is measured in GRO operation times. The csum forwarding
1201 engine flushes the GROed packets from the tables every ``cycles`` GRO
1204 By default, the value of ``cycles`` is 1, which means flush GROed packets
1205 from the reassembly tables as soon as one GRO operation finishes. The value
1206 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1208 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1209 stack performance. Because the GROed packets are delayed to arrive the
1210 stack, thus causing more duplicated ACKs and TCP retransmissions.
1215 Toggle per-port GSO support in ``csum`` forwarding engine::
1217 testpmd> set port <port_id> gso on|off
1219 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1220 packets, transmitted on the given port.
1222 If disabled, packets transmitted on the given port will not undergo GSO.
1223 By default, GSO is disabled for all ports.
1227 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1228 port undergo GSO. Afterwards, the segmented packets are represented by
1229 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1230 of checksums for GSO'd segments in SW. As a result, if users want correct
1231 checksums in GSO segments, they should enable HW checksum calculation for
1234 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1235 by setting the following options in the csum forwarding engine:
1237 testpmd> csum set outer_ip hw <port_id>
1239 testpmd> csum set ip hw <port_id>
1241 testpmd> csum set tcp hw <port_id>
1243 UDP GSO is the same as IP fragmentation, which treats the UDP header
1244 as the payload and does not modify it during segmentation. That is,
1245 after UDP GSO, only the first output fragment has the original UDP
1246 header. Therefore, users need to enable HW IP checksum calculation
1247 and SW UDP checksum calculation for GSO-enabled ports, if they want
1248 correct checksums for UDP/IPv4 packets.
1253 Set the maximum GSO segment size (measured in bytes), which includes the
1254 packet header and the packet payload for GSO-enabled ports (global)::
1256 testpmd> set gso segsz <length>
1261 Display the status of Generic Segmentation Offload for a given port::
1263 testpmd> show port <port_id> gso
1268 Add an alternative MAC address to a port::
1270 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1275 Remove a MAC address from a port::
1277 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1282 To add the multicast MAC address to/from the set of multicast addresses
1285 testpmd> mcast_addr add (port_id) (mcast_addr)
1290 To remove the multicast MAC address to/from the set of multicast addresses
1293 testpmd> mcast_addr remove (port_id) (mcast_addr)
1295 mac_addr add (for VF)
1296 ~~~~~~~~~~~~~~~~~~~~~
1298 Add an alternative MAC address for a VF to a port::
1300 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1305 Set the default MAC address for a port::
1307 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1309 mac_addr set (for VF)
1310 ~~~~~~~~~~~~~~~~~~~~~
1312 Set the MAC address for a VF from the PF::
1314 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1319 Set the forwarding peer address for certain port::
1321 testpmd> set eth-peer (port_id) (peer_addr)
1323 This is equivalent to the ``--eth-peer`` command-line option.
1328 Set the unicast hash filter(s) on/off for a port::
1330 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1335 Set the promiscuous mode on for a port or for all ports.
1336 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1338 testpmd> set promisc (port_id|all) (on|off)
1343 Set the allmulti mode for a port or for all ports::
1345 testpmd> set allmulti (port_id|all) (on|off)
1347 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1349 set promisc (for VF)
1350 ~~~~~~~~~~~~~~~~~~~~
1352 Set the unicast promiscuous mode for a VF from PF.
1353 It's supported by Intel i40e NICs now.
1354 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1356 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1358 set allmulticast (for VF)
1359 ~~~~~~~~~~~~~~~~~~~~~~~~~
1361 Set the multicast promiscuous mode for a VF from PF.
1362 It's supported by Intel i40e NICs now.
1363 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1365 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1367 set tx max bandwidth (for VF)
1368 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1370 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1372 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1374 set tc tx min bandwidth (for VF)
1375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1377 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1379 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1381 set tc tx max bandwidth (for VF)
1382 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1384 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1386 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1388 set tc strict link priority mode
1389 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1391 Set some TCs' strict link priority mode on a physical port::
1393 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1395 set tc tx min bandwidth
1396 ~~~~~~~~~~~~~~~~~~~~~~~
1398 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1400 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1405 Set the link flow control parameter on a port::
1407 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1408 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1409 autoneg (on|off) (port_id)
1413 * ``high_water`` (integer): High threshold value to trigger XOFF.
1415 * ``low_water`` (integer): Low threshold value to trigger XON.
1417 * ``pause_time`` (integer): Pause quota in the Pause frame.
1419 * ``send_xon`` (0/1): Send XON frame.
1421 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1423 * ``autoneg``: Change the auto-negotiation parameter.
1428 Set the priority flow control parameter on a port::
1430 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1431 (pause_time) (priority) (port_id)
1435 * ``high_water`` (integer): High threshold value.
1437 * ``low_water`` (integer): Low threshold value.
1439 * ``pause_time`` (integer): Pause quota in the Pause frame.
1441 * ``priority`` (0-7): VLAN User Priority.
1446 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1448 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1450 For example, to set rx queue 2 on port 0 to mapping 5::
1452 testpmd>set stat_qmap rx 0 2 5
1454 set xstats-hide-zero
1455 ~~~~~~~~~~~~~~~~~~~~
1457 Set the option to hide zero values for xstats display::
1459 testpmd> set xstats-hide-zero on|off
1463 By default, the zero values are displayed for xstats.
1465 set port - rx/tx (for VF)
1466 ~~~~~~~~~~~~~~~~~~~~~~~~~
1468 Set VF receive/transmit from a port::
1470 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1472 set port - mac address filter (for VF)
1473 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1475 Add/Remove unicast or multicast MAC addr filter for a VF::
1477 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1478 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1480 set port - rx mode(for VF)
1481 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1483 Set the VF receive mode of a port::
1485 testpmd> set port (port_id) vf (vf_id) \
1486 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1488 The available receive modes are:
1490 * ``AUPE``: Accepts untagged VLAN.
1492 * ``ROPE``: Accepts unicast hash.
1494 * ``BAM``: Accepts broadcast packets.
1496 * ``MPE``: Accepts all multicast packets.
1498 set port - tx_rate (for Queue)
1499 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1501 Set TX rate limitation for a queue on a port::
1503 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1505 set port - tx_rate (for VF)
1506 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1508 Set TX rate limitation for queues in VF on a port::
1510 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1512 set port - mirror rule
1513 ~~~~~~~~~~~~~~~~~~~~~~
1515 Set pool or vlan type mirror rule for a port::
1517 testpmd> set port (port_id) mirror-rule (rule_id) \
1518 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1519 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1521 Set link mirror rule for a port::
1523 testpmd> set port (port_id) mirror-rule (rule_id) \
1524 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1526 For example to enable mirror traffic with vlan 0,1 to pool 0::
1528 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1530 reset port - mirror rule
1531 ~~~~~~~~~~~~~~~~~~~~~~~~
1533 Reset a mirror rule for a port::
1535 testpmd> reset port (port_id) mirror-rule (rule_id)
1540 Set the flush on RX streams before forwarding.
1541 The default is flush ``on``.
1542 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1544 testpmd> set flush_rx off
1549 Set the bypass mode for the lowest port on bypass enabled NIC::
1551 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1556 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1558 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1559 mode (normal|bypass|isolate) (port_id)
1563 * ``timeout``: Enable bypass after watchdog timeout.
1565 * ``os_on``: Enable bypass when OS/board is powered on.
1567 * ``os_off``: Enable bypass when OS/board is powered off.
1569 * ``power_on``: Enable bypass when power supply is turned on.
1571 * ``power_off``: Enable bypass when power supply is turned off.
1577 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1579 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1584 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1586 testpmd> show bypass config (port_id)
1591 Set link up for a port::
1593 testpmd> set link-up port (port id)
1598 Set link down for a port::
1600 testpmd> set link-down port (port id)
1605 Enable E-tag insertion for a VF on a port::
1607 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1609 Disable E-tag insertion for a VF on a port::
1611 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1613 Enable/disable E-tag stripping on a port::
1615 testpmd> E-tag set stripping (on|off) port (port_id)
1617 Enable/disable E-tag based forwarding on a port::
1619 testpmd> E-tag set forwarding (on|off) port (port_id)
1621 Add an E-tag forwarding filter on a port::
1623 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1625 Delete an E-tag forwarding filter on a port::
1626 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1631 Load a dynamic device personalization (DDP) profile and store backup profile::
1633 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1638 Delete a dynamic device personalization profile and restore backup profile::
1640 testpmd> ddp del (port_id) (backup_profile_path)
1645 List all items from the ptype mapping table::
1647 testpmd> ptype mapping get (port_id) (valid_only)
1651 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1653 Replace a specific or a group of software defined ptype with a new one::
1655 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1659 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1661 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1663 * ``pkt_type``: The new software ptype to replace the old ones.
1665 Update hardware defined ptype to software defined packet type mapping table::
1667 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1671 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1673 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1675 Reset ptype mapping table::
1677 testpmd> ptype mapping reset (port_id)
1679 config per port Rx offloading
1680 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1682 Enable or disable a per port Rx offloading on all Rx queues of a port::
1684 testpmd> port config (port_id) rx_offload (offloading) on|off
1686 * ``offloading``: can be any of these offloading capability:
1687 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1688 qinq_strip, outer_ipv4_cksum, macsec_strip,
1689 header_split, vlan_filter, vlan_extend, jumbo_frame,
1690 scatter, timestamp, security, keep_crc, rss_hash
1692 This command should be run when the port is stopped, or else it will fail.
1694 config per queue Rx offloading
1695 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1697 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1699 testpmd> port (port_id) rxq (queue_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
1707 This command should be run when the port is stopped, or else it will fail.
1709 config per port Tx offloading
1710 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1712 Enable or disable a per port Tx offloading on all Tx queues of a port::
1714 testpmd> port config (port_id) tx_offload (offloading) on|off
1716 * ``offloading``: can be any of these offloading capability:
1717 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1718 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1719 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1720 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1721 mt_lockfree, multi_segs, mbuf_fast_free, security
1723 This command should be run when the port is stopped, or else it will fail.
1725 config per queue Tx offloading
1726 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1728 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1730 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1732 * ``offloading``: can be any of these offloading capability:
1733 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1734 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1735 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1736 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1737 mt_lockfree, multi_segs, mbuf_fast_free, security
1739 This command should be run when the port is stopped, or else it will fail.
1741 Config VXLAN Encap outer layers
1742 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1744 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1746 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1747 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1750 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1751 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1752 eth-src (eth-src) eth-dst (eth-dst)
1754 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1755 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1756 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1758 These commands will set an internal configuration inside testpmd, any following
1759 flow rule using the action vxlan_encap will use the last configuration set.
1760 To have a different encapsulation header, one of those commands must be called
1761 before the flow rule creation.
1763 Config NVGRE Encap outer layers
1764 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1766 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1768 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1769 eth-src (eth-src) eth-dst (eth-dst)
1770 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1771 ip-dst (ip-dst) vlan-tci (vlan-tci) 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 nvgre_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.
1781 Configure the l2 to be used when encapsulating a packet with L2::
1783 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1784 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1785 eth-src (eth-src) eth-dst (eth-dst)
1787 Those commands will set an internal configuration inside testpmd, any following
1788 flow rule using the action l2_encap will use the last configuration set.
1789 To have a different encapsulation header, one of those commands must be called
1790 before the flow rule creation.
1795 Configure the l2 to be removed when decapsulating a packet with L2::
1797 set l2_decap ip-version (ipv4|ipv6)
1798 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1800 Those commands will set an internal configuration inside testpmd, any following
1801 flow rule using the action l2_decap will use the last configuration set.
1802 To have a different encapsulation header, one of those commands must be called
1803 before the flow rule creation.
1805 Config MPLSoGRE Encap outer layers
1806 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1808 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1810 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1811 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1812 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1813 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1814 eth-src (eth-src) eth-dst (eth-dst)
1816 These commands will set an internal configuration inside testpmd, any following
1817 flow rule using the action mplsogre_encap will use the last configuration set.
1818 To have a different encapsulation header, one of those commands must be called
1819 before the flow rule creation.
1821 Config MPLSoGRE Decap outer layers
1822 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1824 Configure the outer layer to decapsulate MPLSoGRE packet::
1826 set mplsogre_decap ip-version (ipv4|ipv6)
1827 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1829 These commands will set an internal configuration inside testpmd, any following
1830 flow rule using the action mplsogre_decap will use the last configuration set.
1831 To have a different decapsulation header, one of those commands must be called
1832 before the flow rule creation.
1834 Config MPLSoUDP Encap outer layers
1835 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1837 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1839 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1840 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1841 eth-src (eth-src) eth-dst (eth-dst)
1842 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1843 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1844 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1846 These commands will set an internal configuration inside testpmd, any following
1847 flow rule using the action mplsoudp_encap will use the last configuration set.
1848 To have a different encapsulation header, one of those commands must be called
1849 before the flow rule creation.
1851 Config MPLSoUDP Decap outer layers
1852 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1854 Configure the outer layer to decapsulate MPLSoUDP packet::
1856 set mplsoudp_decap ip-version (ipv4|ipv6)
1857 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1859 These commands will set an internal configuration inside testpmd, any following
1860 flow rule using the action mplsoudp_decap will use the last configuration set.
1861 To have a different decapsulation header, one of those commands must be called
1862 before the flow rule creation.
1864 Config Raw Encapsulation
1865 ~~~~~~~~~~~~~~~~~~~~~~~~~
1867 Configure the raw data to be used when encapsulating a packet by
1868 rte_flow_action_raw_encap::
1870 set raw_encap {index} {item} [/ {item} [...]] / end_set
1872 There are multiple global buffers for ``raw_encap``, this command will set one
1873 internal buffer index by ``{index}``.
1874 If there is no ``{index}`` specified::
1876 set raw_encap {item} [/ {item} [...]] / end_set
1878 the default index ``0`` is used.
1879 In order to use different encapsulating header, ``index`` must be specified
1880 during the flow rule creation::
1882 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1883 raw_encap index 2 / end
1885 Otherwise the default index ``0`` is used.
1887 Config Raw Decapsulation
1888 ~~~~~~~~~~~~~~~~~~~~~~~~
1890 Configure the raw data to be used when decapsulating a packet by
1891 rte_flow_action_raw_decap::
1893 set raw_decap {index} {item} [/ {item} [...]] / end_set
1895 There are multiple global buffers for ``raw_decap``, this command will set
1896 one internal buffer index by ``{index}``.
1897 If there is no ``{index}`` specified::
1899 set raw_decap {item} [/ {item} [...]] / end_set
1901 the default index ``0`` is used.
1902 In order to use different decapsulating header, ``index`` must be specified
1903 during the flow rule creation::
1905 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1906 raw_encap index 3 / end
1908 Otherwise the default index ``0`` is used.
1913 The following sections show functions for configuring ports.
1917 Port configuration changes only become active when forwarding is started/restarted.
1922 Attach a port specified by pci address or virtual device args::
1924 testpmd> port attach (identifier)
1926 To attach a new pci device, the device should be recognized by kernel first.
1927 Then it should be moved under DPDK management.
1928 Finally the port can be attached to testpmd.
1930 For example, to move a pci device using ixgbe under DPDK management:
1932 .. code-block:: console
1934 # Check the status of the available devices.
1935 ./usertools/dpdk-devbind.py --status
1937 Network devices using DPDK-compatible driver
1938 ============================================
1941 Network devices using kernel driver
1942 ===================================
1943 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1946 # Bind the device to igb_uio.
1947 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1950 # Recheck the status of the devices.
1951 ./usertools/dpdk-devbind.py --status
1952 Network devices using DPDK-compatible driver
1953 ============================================
1954 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1956 To attach a port created by virtual device, above steps are not needed.
1958 For example, to attach a port whose pci address is 0000:0a:00.0.
1960 .. code-block:: console
1962 testpmd> port attach 0000:0a:00.0
1963 Attaching a new port...
1964 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1965 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1966 EAL: PCI memory mapped at 0x7f83bfa00000
1967 EAL: PCI memory mapped at 0x7f83bfa80000
1968 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1969 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1970 Port 0 is attached. Now total ports is 1
1973 For example, to attach a port created by pcap PMD.
1975 .. code-block:: console
1977 testpmd> port attach net_pcap0
1978 Attaching a new port...
1979 PMD: Initializing pmd_pcap for net_pcap0
1980 PMD: Creating pcap-backed ethdev on numa socket 0
1981 Port 0 is attached. Now total ports is 1
1984 In this case, identifier is ``net_pcap0``.
1985 This identifier format is the same as ``--vdev`` format of DPDK applications.
1987 For example, to re-attach a bonded port which has been previously detached,
1988 the mode and slave parameters must be given.
1990 .. code-block:: console
1992 testpmd> port attach net_bond_0,mode=0,slave=1
1993 Attaching a new port...
1994 EAL: Initializing pmd_bond for net_bond_0
1995 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1996 Port 0 is attached. Now total ports is 1
2003 Detach a specific port::
2005 testpmd> port detach (port_id)
2007 Before detaching a port, the port should be stopped and closed.
2009 For example, to detach a pci device port 0.
2011 .. code-block:: console
2013 testpmd> port stop 0
2016 testpmd> port close 0
2020 testpmd> port detach 0
2022 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2023 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2024 EAL: PCI memory unmapped at 0x7f83bfa00000
2025 EAL: PCI memory unmapped at 0x7f83bfa80000
2029 For example, to detach a virtual device port 0.
2031 .. code-block:: console
2033 testpmd> port stop 0
2036 testpmd> port close 0
2040 testpmd> port detach 0
2042 PMD: Closing pcap ethdev on numa socket 0
2043 Port 'net_pcap0' is detached. Now total ports is 0
2046 To remove a pci device completely from the system, first detach the port from testpmd.
2047 Then the device should be moved under kernel management.
2048 Finally the device can be removed using kernel pci hotplug functionality.
2050 For example, to move a pci device under kernel management:
2052 .. code-block:: console
2054 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2056 ./usertools/dpdk-devbind.py --status
2058 Network devices using DPDK-compatible driver
2059 ============================================
2062 Network devices using kernel driver
2063 ===================================
2064 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2066 To remove a port created by a virtual device, above steps are not needed.
2071 Start all ports or a specific port::
2073 testpmd> port start (port_id|all)
2078 Stop all ports or a specific port::
2080 testpmd> port stop (port_id|all)
2085 Close all ports or a specific port::
2087 testpmd> port close (port_id|all)
2092 Reset all ports or a specific port::
2094 testpmd> port reset (port_id|all)
2096 User should stop port(s) before resetting and (re-)start after reset.
2098 port config - queue ring size
2099 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2101 Configure a rx/tx queue ring size::
2103 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2105 Only take effect after command that (re-)start the port or command that setup specific queue.
2107 port start/stop queue
2108 ~~~~~~~~~~~~~~~~~~~~~
2110 Start/stop a rx/tx queue on a specific port::
2112 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2114 port config - queue deferred start
2115 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2117 Switch on/off deferred start of a specific port queue::
2119 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2122 ~~~~~~~~~~~~~~~~~~~~~
2124 Setup a rx/tx queue on a specific port::
2126 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2128 Only take effect when port is started.
2133 Set the speed and duplex mode for all ports or a specific port::
2135 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
2136 duplex (half|full|auto)
2138 port config - queues/descriptors
2139 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2141 Set number of queues/descriptors for rxq, txq, rxd and txd::
2143 testpmd> port config all (rxq|txq|rxd|txd) (value)
2145 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2147 port config - max-pkt-len
2148 ~~~~~~~~~~~~~~~~~~~~~~~~~
2150 Set the maximum packet length::
2152 testpmd> port config all max-pkt-len (value)
2154 This is equivalent to the ``--max-pkt-len`` command-line option.
2156 port config - max-lro-pkt-size
2157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2159 Set the maximum LRO aggregated packet size::
2161 testpmd> port config all max-lro-pkt-size (value)
2163 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2165 port config - Drop Packets
2166 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2168 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2170 testpmd> port config all drop-en (on|off)
2172 Packet dropping when no receive buffers available is off by default.
2174 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2179 Set the RSS (Receive Side Scaling) mode on or off::
2181 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|none)
2183 RSS is on by default.
2185 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
2186 The ``default`` option enables all supported RSS types reported by device info.
2187 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2189 port config - RSS Reta
2190 ~~~~~~~~~~~~~~~~~~~~~~
2192 Set the RSS (Receive Side Scaling) redirection table::
2194 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2199 Set the DCB mode for an individual port::
2201 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2203 The traffic class should be 4 or 8.
2208 Set the number of packets per burst::
2210 testpmd> port config all burst (value)
2212 This is equivalent to the ``--burst`` command-line option.
2214 port config - Threshold
2215 ~~~~~~~~~~~~~~~~~~~~~~~
2217 Set thresholds for TX/RX queues::
2219 testpmd> port config all (threshold) (value)
2221 Where the threshold type can be:
2223 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2225 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2227 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2229 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2231 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2233 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2235 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2237 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2239 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2241 These threshold options are also available from the command-line.
2246 Set the value of ether-type for E-tag::
2248 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2250 Enable/disable the E-tag support::
2252 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2254 port config pctype mapping
2255 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2257 Reset pctype mapping table::
2259 testpmd> port config (port_id) pctype mapping reset
2261 Update hardware defined pctype to software defined flow type mapping table::
2263 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2267 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2269 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2271 port config input set
2272 ~~~~~~~~~~~~~~~~~~~~~
2274 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2276 testpmd> port config (port_id) pctype (pctype_id) \
2277 (hash_inset|fdir_inset|fdir_flx_inset) \
2278 (get|set|clear) field (field_idx)
2280 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2282 testpmd> port config (port_id) pctype (pctype_id) \
2283 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2287 * ``pctype_id``: hardware packet classification types.
2288 * ``field_idx``: hardware field index.
2290 port config udp_tunnel_port
2291 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2293 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2295 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2297 port config tx_metadata
2298 ~~~~~~~~~~~~~~~~~~~~~~~
2300 Set Tx metadata value per port.
2301 testpmd will add this value to any Tx packet sent from this port::
2303 testpmd> port config (port_id) tx_metadata (value)
2308 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2310 testpmd> port config mtu (port_id) (value)
2312 port config rss hash key
2313 ~~~~~~~~~~~~~~~~~~~~~~~~
2315 To configure the RSS hash key used to compute the RSS
2316 hash of input [IP] packets received on port::
2318 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2319 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2320 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2321 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2322 ipv6-udp-ex <string of hex digits \
2323 (variable length, NIC dependent)>)
2328 The following sections show functions for device operations.
2333 Detach a device specified by pci address or virtual device args::
2335 testpmd> device detach (identifier)
2337 Before detaching a device associated with ports, the ports should be stopped and closed.
2339 For example, to detach a pci device whose address is 0002:03:00.0.
2341 .. code-block:: console
2343 testpmd> device detach 0002:03:00.0
2344 Removing a device...
2345 Port 1 is now closed
2346 EAL: Releasing pci mapped resource for 0002:03:00.0
2347 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2348 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2349 Device 0002:03:00.0 is detached
2350 Now total ports is 1
2352 For example, to detach a port created by pcap PMD.
2354 .. code-block:: console
2356 testpmd> device detach net_pcap0
2357 Removing a device...
2358 Port 0 is now closed
2359 Device net_pcap0 is detached
2360 Now total ports is 0
2363 In this case, identifier is ``net_pcap0``.
2364 This identifier format is the same as ``--vdev`` format of DPDK applications.
2366 Link Bonding Functions
2367 ----------------------
2369 The Link Bonding functions make it possible to dynamically create and
2370 manage link bonding devices from within testpmd interactive prompt.
2372 create bonded device
2373 ~~~~~~~~~~~~~~~~~~~~
2375 Create a new bonding device::
2377 testpmd> create bonded device (mode) (socket)
2379 For example, to create a bonded device in mode 1 on socket 0::
2381 testpmd> create bonded device 1 0
2382 created new bonded device (port X)
2387 Adds Ethernet device to a Link Bonding device::
2389 testpmd> add bonding slave (slave id) (port id)
2391 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2393 testpmd> add bonding slave 6 10
2396 remove bonding slave
2397 ~~~~~~~~~~~~~~~~~~~~
2399 Removes an Ethernet slave device from a Link Bonding device::
2401 testpmd> remove bonding slave (slave id) (port id)
2403 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2405 testpmd> remove bonding slave 6 10
2410 Set the Link Bonding mode of a Link Bonding device::
2412 testpmd> set bonding mode (value) (port id)
2414 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2416 testpmd> set bonding mode 3 10
2421 Set an Ethernet slave device as the primary device on a Link Bonding device::
2423 testpmd> set bonding primary (slave id) (port id)
2425 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2427 testpmd> set bonding primary 6 10
2432 Set the MAC address of a Link Bonding device::
2434 testpmd> set bonding mac (port id) (mac)
2436 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2438 testpmd> set bonding mac 10 00:00:00:00:00:01
2440 set bonding xmit_balance_policy
2441 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2443 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2445 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2447 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2449 testpmd> set bonding xmit_balance_policy 10 l34
2452 set bonding mon_period
2453 ~~~~~~~~~~~~~~~~~~~~~~
2455 Set the link status monitoring polling period in milliseconds for a bonding device.
2457 This adds support for PMD slave devices which do not support link status interrupts.
2458 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2459 link status ISR will be queried every polling interval to check if their link status has changed::
2461 testpmd> set bonding mon_period (port_id) (value)
2463 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2465 testpmd> set bonding mon_period 5 150
2468 set bonding lacp dedicated_queue
2469 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2471 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2472 when in mode 4 (link-aggregation-802.3ad)::
2474 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2477 set bonding agg_mode
2478 ~~~~~~~~~~~~~~~~~~~~
2480 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2482 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2488 Show the current configuration of a Link Bonding device::
2490 testpmd> show bonding config (port id)
2493 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2494 in balance mode with a transmission policy of layer 2+3::
2496 testpmd> show bonding config 9
2498 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2500 Active Slaves (3): [1 3 4]
2507 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2508 This is mainly useful for debugging purposes.
2509 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2510 and fields that can be accessed.
2515 Display the value of a port register::
2517 testpmd> read reg (port_id) (address)
2519 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2521 testpmd> read reg 0 0xEE00
2522 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2527 Display a port register bit field::
2529 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2531 For example, reading the lowest two bits from the register in the example above::
2533 testpmd> read regfield 0 0xEE00 0 1
2534 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2539 Display a single port register bit::
2541 testpmd> read regbit (port_id) (address) (bit_x)
2543 For example, reading the lowest bit from the register in the example above::
2545 testpmd> read regbit 0 0xEE00 0
2546 port 0 PCI register at offset 0xEE00: bit 0=1
2551 Set the value of a port register::
2553 testpmd> write reg (port_id) (address) (value)
2555 For example, to clear a register::
2557 testpmd> write reg 0 0xEE00 0x0
2558 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2563 Set bit field of a port register::
2565 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2567 For example, writing to the register cleared in the example above::
2569 testpmd> write regfield 0 0xEE00 0 1 2
2570 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2575 Set single bit value of a port register::
2577 testpmd> write regbit (port_id) (address) (bit_x) (value)
2579 For example, to set the high bit in the register from the example above::
2581 testpmd> write regbit 0 0xEE00 31 1
2582 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2584 Traffic Metering and Policing
2585 -----------------------------
2587 The following section shows functions for configuring traffic metering and
2588 policing on the ethernet device through the use of generic ethdev API.
2590 show port traffic management capability
2591 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2593 Show traffic metering and policing capability of the port::
2595 testpmd> show port meter cap (port_id)
2597 add port meter profile (srTCM rfc2967)
2598 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2600 Add meter profile (srTCM rfc2697) to the ethernet device::
2602 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2607 * ``profile_id``: ID for the meter profile.
2608 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2609 * ``cbs``: Committed Burst Size (CBS) (bytes).
2610 * ``ebs``: Excess Burst Size (EBS) (bytes).
2612 add port meter profile (trTCM rfc2968)
2613 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2615 Add meter profile (srTCM rfc2698) to the ethernet device::
2617 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2618 (cir) (pir) (cbs) (pbs)
2622 * ``profile_id``: ID for the meter profile.
2623 * ``cir``: Committed information rate (bytes/second).
2624 * ``pir``: Peak information rate (bytes/second).
2625 * ``cbs``: Committed burst size (bytes).
2626 * ``pbs``: Peak burst size (bytes).
2628 add port meter profile (trTCM rfc4115)
2629 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2631 Add meter profile (trTCM rfc4115) to the ethernet device::
2633 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2634 (cir) (eir) (cbs) (ebs)
2638 * ``profile_id``: ID for the meter profile.
2639 * ``cir``: Committed information rate (bytes/second).
2640 * ``eir``: Excess information rate (bytes/second).
2641 * ``cbs``: Committed burst size (bytes).
2642 * ``ebs``: Excess burst size (bytes).
2644 delete port meter profile
2645 ~~~~~~~~~~~~~~~~~~~~~~~~~
2647 Delete meter profile from the ethernet device::
2649 testpmd> del port meter profile (port_id) (profile_id)
2654 Create new meter object for the ethernet device::
2656 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2657 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2658 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2663 * ``mtr_id``: meter object ID.
2664 * ``profile_id``: ID for the meter profile.
2665 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2666 gets enabled at the time of creation, otherwise remains disabled.
2667 * ``g_action``: Policer action for the packet with green color.
2668 * ``y_action``: Policer action for the packet with yellow color.
2669 * ``r_action``: Policer action for the packet with red color.
2670 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2672 * ``shared``: When this parameter has a non-zero value, the meter object is
2673 shared by multiple flows. Otherwise, meter object is used by single flow.
2674 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2675 input color for the current meter object is determined by the latest meter
2676 object in the same flow. Otherwise, the current meter object uses the
2677 *dscp_table* to determine the input color.
2678 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2679 color, 0 <= x <= 63.
2684 Enable meter for the ethernet device::
2686 testpmd> enable port meter (port_id) (mtr_id)
2691 Disable meter for the ethernet device::
2693 testpmd> disable port meter (port_id) (mtr_id)
2698 Delete meter for the ethernet device::
2700 testpmd> del port meter (port_id) (mtr_id)
2702 Set port meter profile
2703 ~~~~~~~~~~~~~~~~~~~~~~
2705 Set meter profile for the ethernet device::
2707 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2709 set port meter dscp table
2710 ~~~~~~~~~~~~~~~~~~~~~~~~~
2712 Set meter dscp table for the ethernet device::
2714 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2715 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2717 set port meter policer action
2718 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2720 Set meter policer action for the ethernet device::
2722 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2723 (action0) [(action1) (action1)]
2727 * ``action_mask``: Bit mask indicating which policer actions need to be
2728 updated. One or more policer actions can be updated in a single function
2729 invocation. To update the policer action associated with color C, bit
2730 (1 << C) needs to be set in *action_mask* and element at position C
2731 in the *actions* array needs to be valid.
2732 * ``actionx``: Policer action for the color x,
2733 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2735 set port meter stats mask
2736 ~~~~~~~~~~~~~~~~~~~~~~~~~
2738 Set meter stats mask for the ethernet device::
2740 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2744 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2746 show port meter stats
2747 ~~~~~~~~~~~~~~~~~~~~~
2749 Show meter stats of the ethernet device::
2751 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2755 * ``clear``: Flag that indicates whether the statistics counters should
2756 be cleared (i.e. set to zero) immediately after they have been read or not.
2761 The following section shows functions for configuring traffic management on
2762 the ethernet device through the use of generic TM API.
2764 show port traffic management capability
2765 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2767 Show traffic management capability of the port::
2769 testpmd> show port tm cap (port_id)
2771 show port traffic management capability (hierarchy level)
2772 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2774 Show traffic management hierarchy level capability of the port::
2776 testpmd> show port tm level cap (port_id) (level_id)
2778 show port traffic management capability (hierarchy node level)
2779 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2781 Show the traffic management hierarchy node capability of the port::
2783 testpmd> show port tm node cap (port_id) (node_id)
2785 show port traffic management hierarchy node type
2786 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2788 Show the port traffic management hierarchy node type::
2790 testpmd> show port tm node type (port_id) (node_id)
2792 show port traffic management hierarchy node stats
2793 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2795 Show the port traffic management hierarchy node statistics::
2797 testpmd> show port tm node stats (port_id) (node_id) (clear)
2801 * ``clear``: When this parameter has a non-zero value, the statistics counters
2802 are cleared (i.e. set to zero) immediately after they have been read,
2803 otherwise the statistics counters are left untouched.
2805 Add port traffic management private shaper profile
2806 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2808 Add the port traffic management private shaper profile::
2810 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2811 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2812 (packet_length_adjust)
2816 * ``shaper_profile id``: Shaper profile ID for the new profile.
2817 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2818 * ``cmit_tb_size``: Committed token bucket size (bytes).
2819 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2820 * ``peak_tb_size``: Peak token bucket size (bytes).
2821 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2822 each packet for the purpose of shaping. This parameter value can be used to
2823 correct the packet length with the framing overhead bytes that are consumed
2826 Delete port traffic management private shaper profile
2827 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2829 Delete the port traffic management private shaper::
2831 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2835 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2837 Add port traffic management shared shaper
2838 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2840 Create the port traffic management shared shaper::
2842 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2847 * ``shared_shaper_id``: Shared shaper ID to be created.
2848 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2850 Set port traffic management shared shaper
2851 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2853 Update the port traffic management shared shaper::
2855 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2860 * ``shared_shaper_id``: Shared shaper ID to be update.
2861 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2863 Delete port traffic management shared shaper
2864 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2866 Delete the port traffic management shared shaper::
2868 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2872 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2874 Set port traffic management hierarchy node private shaper
2875 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2877 set the port traffic management hierarchy node private shaper::
2879 testpmd> set port tm node shaper profile (port_id) (node_id) \
2884 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2887 Add port traffic management WRED profile
2888 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2890 Create a new WRED profile::
2892 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2893 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2894 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2895 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2899 * ``wred_profile id``: Identifier for the newly create WRED profile
2900 * ``color_g``: Packet color (green)
2901 * ``min_th_g``: Minimum queue threshold for packet with green color
2902 * ``max_th_g``: Minimum queue threshold for packet with green color
2903 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2904 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2905 * ``color_y``: Packet color (yellow)
2906 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2907 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2908 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2909 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2910 * ``color_r``: Packet color (red)
2911 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2912 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2913 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2914 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2916 Delete port traffic management WRED profile
2917 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2919 Delete the WRED profile::
2921 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2923 Add port traffic management hierarchy nonleaf node
2924 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2926 Add nonleaf node to port traffic management hierarchy::
2928 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2929 (priority) (weight) (level_id) (shaper_profile_id) \
2930 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2931 [(shared_shaper_0) (shared_shaper_1) ...] \
2935 * ``parent_node_id``: Node ID of the parent.
2936 * ``priority``: Node priority (highest node priority is zero). This is used by
2937 the SP algorithm running on the parent node for scheduling this node.
2938 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2939 to the weight sum of all siblings that have the same priority. It is used by
2940 the WFQ algorithm running on the parent node for scheduling this node.
2941 * ``level_id``: Hierarchy level of the node.
2942 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2944 * ``n_sp_priorities``: Number of strict priorities.
2945 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2946 * ``n_shared_shapers``: Number of shared shapers.
2947 * ``shared_shaper_id``: Shared shaper id.
2949 Add port traffic management hierarchy leaf node
2950 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2952 Add leaf node to port traffic management hierarchy::
2954 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2955 (priority) (weight) (level_id) (shaper_profile_id) \
2956 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2957 [(shared_shaper_id) (shared_shaper_id) ...] \
2961 * ``parent_node_id``: Node ID of the parent.
2962 * ``priority``: Node priority (highest node priority is zero). This is used by
2963 the SP algorithm running on the parent node for scheduling this node.
2964 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2965 to the weight sum of all siblings that have the same priority. It is used by
2966 the WFQ algorithm running on the parent node for scheduling this node.
2967 * ``level_id``: Hierarchy level of the node.
2968 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2970 * ``cman_mode``: Congestion management mode to be enabled for this node.
2971 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2972 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2973 * ``n_shared_shapers``: Number of shared shapers.
2974 * ``shared_shaper_id``: Shared shaper id.
2976 Delete port traffic management hierarchy node
2977 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2979 Delete node from port traffic management hierarchy::
2981 testpmd> del port tm node (port_id) (node_id)
2983 Update port traffic management hierarchy parent node
2984 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2986 Update port traffic management hierarchy parent node::
2988 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
2991 This function can only be called after the hierarchy commit invocation. Its
2992 success depends on the port support for this operation, as advertised through
2993 the port capability set. This function is valid for all nodes of the traffic
2994 management hierarchy except root node.
2996 Suspend port traffic management hierarchy node
2997 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2999 testpmd> suspend port tm node (port_id) (node_id)
3001 Resume port traffic management hierarchy node
3002 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3004 testpmd> resume port tm node (port_id) (node_id)
3006 Commit port traffic management hierarchy
3007 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3009 Commit the traffic management hierarchy on the port::
3011 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3015 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3016 call failure. On the other hand, hierarchy is preserved when this parameter
3019 Set port traffic management mark VLAN dei
3020 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3022 Enables/Disables the traffic management marking on the port for VLAN packets::
3024 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3028 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3029 ``yellow`` or ``red`` will have dei bit enabled
3031 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3033 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3035 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3037 Set port traffic management mark IP dscp
3038 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3040 Enables/Disables the traffic management marking on the port for IP dscp packets::
3042 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3046 * ``port_id``: The port which on which IP packets marked as ``green`` or
3047 ``yellow`` or ``red`` will have IP dscp bits updated
3049 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3051 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3053 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3055 Set port traffic management mark IP ecn
3056 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3058 Enables/Disables the traffic management marking on the port for IP ecn packets::
3060 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3064 * ``port_id``: The port which on which IP packets marked as ``green`` or
3065 ``yellow`` or ``red`` will have IP ecn bits updated
3067 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3068 to ecn of 2'b11 when IP is caring TCP or SCTP
3070 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3071 to ecn of 2'b11 when IP is caring TCP or SCTP
3073 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3074 to ecn of 2'b11 when IP is caring TCP or SCTP
3076 Set port traffic management default hierarchy (softnic forwarding mode)
3077 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3079 set the traffic management default hierarchy on the port::
3081 testpmd> set port tm hierarchy default (port_id)
3086 This section details the available filter functions that are available.
3088 Note these functions interface the deprecated legacy filtering framework,
3089 superseded by *rte_flow*. See `Flow rules management`_.
3092 ~~~~~~~~~~~~~~~~~~~~
3094 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3096 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3097 ethertype (ether_type) (drop|fwd) queue (queue_id)
3099 The available information parameters are:
3101 * ``port_id``: The port which the Ethertype filter assigned on.
3103 * ``mac_addr``: Compare destination mac address.
3105 * ``mac_ignr``: Ignore destination mac address match.
3107 * ``mac_address``: Destination mac address to match.
3109 * ``ether_type``: The EtherType value want to match,
3110 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3112 * ``queue_id``: The receive queue associated with this EtherType filter.
3113 It is meaningless when deleting or dropping.
3115 Example, to add/remove an ethertype filter rule::
3117 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3118 ethertype 0x0806 fwd queue 3
3120 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3121 ethertype 0x0806 fwd queue 3
3126 Add or delete a 2-tuple filter,
3127 which identifies packets by specific protocol and destination TCP/UDP port
3128 and forwards packets into one of the receive queues::
3130 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3131 protocol (protocol_value) mask (mask_value) \
3132 tcp_flags (tcp_flags_value) priority (prio_value) \
3135 The available information parameters are:
3137 * ``port_id``: The port which the 2-tuple filter assigned on.
3139 * ``dst_port_value``: Destination port in L4.
3141 * ``protocol_value``: IP L4 protocol.
3143 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3145 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3147 * ``prio_value``: Priority of this filter.
3149 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3151 Example, to add/remove an 2tuple filter rule::
3153 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3154 tcp_flags 0x02 priority 3 queue 3
3156 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3157 tcp_flags 0x02 priority 3 queue 3
3162 Add or delete a 5-tuple filter,
3163 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3164 and routes packets into one of the receive queues::
3166 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3167 (src_address) dst_port (dst_port_value) \
3168 src_port (src_port_value) protocol (protocol_value) \
3169 mask (mask_value) tcp_flags (tcp_flags_value) \
3170 priority (prio_value) queue (queue_id)
3172 The available information parameters are:
3174 * ``port_id``: The port which the 5-tuple filter assigned on.
3176 * ``dst_address``: Destination IP address.
3178 * ``src_address``: Source IP address.
3180 * ``dst_port_value``: TCP/UDP destination port.
3182 * ``src_port_value``: TCP/UDP source port.
3184 * ``protocol_value``: L4 protocol.
3186 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3188 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3190 * ``prio_value``: The priority of this filter.
3192 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3194 Example, to add/remove an 5tuple filter rule::
3196 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3197 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3198 flags 0x0 priority 3 queue 3
3200 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3201 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3202 flags 0x0 priority 3 queue 3
3207 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3209 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3211 The available information parameters are:
3213 * ``port_id``: The port which the SYN filter assigned on.
3215 * ``high``: This SYN filter has higher priority than other filters.
3217 * ``low``: This SYN filter has lower priority than other filters.
3219 * ``queue_id``: The receive queue associated with this SYN filter
3223 testpmd> syn_filter 0 add priority high queue 3
3228 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3229 and routed into one of the receive queues::
3231 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3232 mask (mask_value) priority (prio_value) queue (queue_id)
3234 The available information parameters are:
3236 * ``port_id``: The port which the Flex filter is assigned on.
3238 * ``len_value``: Filter length in bytes, no greater than 128.
3240 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3242 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3244 * ``prio_value``: The priority of this filter.
3246 * ``queue_id``: The receive queue associated with this Flex filter.
3250 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3251 mask 000C priority 3 queue 3
3253 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3254 mask 000C priority 3 queue 3
3257 .. _testpmd_flow_director:
3259 flow_director_filter
3260 ~~~~~~~~~~~~~~~~~~~~
3262 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3264 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3265 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3267 * Perfect match filters.
3268 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3269 The masked fields are for IP flow.
3271 * Signature filters.
3272 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3274 * Perfect-mac-vlan match filters.
3275 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3276 The masked fields are for MAC VLAN flow.
3278 * Perfect-tunnel match filters.
3279 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3280 The masked fields are for tunnel flow.
3282 * Perfect-raw-flow-type match filters.
3283 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3284 The masked fields are specified by input sets.
3286 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3287 per flow type and the flexible payload.
3289 The Flow Director can also mask out parts of all of these fields so that filters
3290 are only applied to certain fields or parts of the fields.
3292 Note that for raw flow type mode the source and destination fields in the
3293 raw packet buffer need to be presented in a reversed order with respect
3294 to the expected received packets.
3295 For example: IP source and destination addresses or TCP/UDP/SCTP
3296 source and destination ports
3298 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3300 # Commands to add flow director filters of different flow types::
3302 flow_director_filter (port_id) mode IP (add|del|update) \
3303 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3304 src (src_ip_address) dst (dst_ip_address) \
3305 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3306 vlan (vlan_value) flexbytes (flexbytes_value) \
3307 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3310 flow_director_filter (port_id) mode IP (add|del|update) \
3311 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3312 src (src_ip_address) (src_port) \
3313 dst (dst_ip_address) (dst_port) \
3314 tos (tos_value) ttl (ttl_value) \
3315 vlan (vlan_value) flexbytes (flexbytes_value) \
3316 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3319 flow_director_filter (port_id) mode IP (add|del|update) \
3320 flow (ipv4-sctp|ipv6-sctp) \
3321 src (src_ip_address) (src_port) \
3322 dst (dst_ip_address) (dst_port) \
3323 tos (tos_value) ttl (ttl_value) \
3324 tag (verification_tag) vlan (vlan_value) \
3325 flexbytes (flexbytes_value) (drop|fwd) \
3326 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3328 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3329 ether (ethertype) flexbytes (flexbytes_value) \
3330 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3333 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3334 mac (mac_address) vlan (vlan_value) \
3335 flexbytes (flexbytes_value) (drop|fwd) \
3336 queue (queue_id) fd_id (fd_id_value)
3338 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3339 mac (mac_address) vlan (vlan_value) \
3340 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3341 flexbytes (flexbytes_value) (drop|fwd) \
3342 queue (queue_id) fd_id (fd_id_value)
3344 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3345 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3346 packet (packet file name)
3348 For example, to add an ipv4-udp flow type filter::
3350 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3351 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3352 fwd pf queue 1 fd_id 1
3354 For example, add an ipv4-other flow type filter::
3356 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3357 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3358 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3363 Flush all flow director filters on a device::
3365 testpmd> flush_flow_director (port_id)
3367 Example, to flush all flow director filter on port 0::
3369 testpmd> flush_flow_director 0
3374 Set flow director's input masks::
3376 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3377 src_mask (ipv4_src) (ipv6_src) (src_port) \
3378 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3380 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3382 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3383 mac (mac_value) tunnel-type (tunnel_type_value) \
3384 tunnel-id (tunnel_id_value)
3386 Example, to set flow director mask on port 0::
3388 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3389 src_mask 255.255.255.255 \
3390 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3391 dst_mask 255.255.255.255 \
3392 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3394 flow_director_flex_mask
3395 ~~~~~~~~~~~~~~~~~~~~~~~
3397 set masks of flow director's flexible payload based on certain flow type::
3399 testpmd> flow_director_flex_mask (port_id) \
3400 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3401 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3402 l2_payload|all) (mask)
3404 Example, to set flow director's flex mask for all flow type on port 0::
3406 testpmd> flow_director_flex_mask 0 flow all \
3407 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3410 flow_director_flex_payload
3411 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3413 Configure flexible payload selection::
3415 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3417 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3419 testpmd> flow_director_flex_payload 0 l4 \
3420 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3422 get_sym_hash_ena_per_port
3423 ~~~~~~~~~~~~~~~~~~~~~~~~~
3425 Get symmetric hash enable configuration per port::
3427 get_sym_hash_ena_per_port (port_id)
3429 For example, to get symmetric hash enable configuration of port 1::
3431 testpmd> get_sym_hash_ena_per_port 1
3433 set_sym_hash_ena_per_port
3434 ~~~~~~~~~~~~~~~~~~~~~~~~~
3436 Set symmetric hash enable configuration per port to enable or disable::
3438 set_sym_hash_ena_per_port (port_id) (enable|disable)
3440 For example, to set symmetric hash enable configuration of port 1 to enable::
3442 testpmd> set_sym_hash_ena_per_port 1 enable
3444 get_hash_global_config
3445 ~~~~~~~~~~~~~~~~~~~~~~
3447 Get the global configurations of hash filters::
3449 get_hash_global_config (port_id)
3451 For example, to get the global configurations of hash filters of port 1::
3453 testpmd> get_hash_global_config 1
3455 set_hash_global_config
3456 ~~~~~~~~~~~~~~~~~~~~~~
3458 Set the global configurations of hash filters::
3460 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3461 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3462 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3465 For example, to enable simple_xor for flow type of ipv6 on port 2::
3467 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3472 Set the input set for hash::
3474 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3475 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3476 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3477 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3478 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3479 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3480 fld-8th|none) (select|add)
3482 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3484 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3489 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3490 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3492 Set the input set for flow director::
3494 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3495 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3496 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3497 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3498 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3499 sctp-dst-port|sctp-veri-tag|none) (select|add)
3501 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3503 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3508 Set different GRE key length for input set::
3510 global_config (port_id) gre-key-len (number in bytes)
3512 For example to set GRE key length for input set to 4 bytes on port 0::
3514 testpmd> global_config 0 gre-key-len 4
3517 .. _testpmd_rte_flow:
3519 Flow rules management
3520 ---------------------
3522 Control of the generic flow API (*rte_flow*) is fully exposed through the
3523 ``flow`` command (validation, creation, destruction, queries and operation
3526 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3527 features simultaneously may cause undefined side-effects and is therefore
3533 Because the ``flow`` command uses dynamic tokens to handle the large number
3534 of possible flow rules combinations, its behavior differs slightly from
3535 other commands, in particular:
3537 - Pressing *?* or the *<tab>* key displays contextual help for the current
3538 token, not that of the entire command.
3540 - Optional and repeated parameters are supported (provided they are listed
3541 in the contextual help).
3543 The first parameter stands for the operation mode. Possible operations and
3544 their general syntax are described below. They are covered in detail in the
3547 - Check whether a flow rule can be created::
3549 flow validate {port_id}
3550 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3551 pattern {item} [/ {item} [...]] / end
3552 actions {action} [/ {action} [...]] / end
3554 - Create a flow rule::
3556 flow create {port_id}
3557 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3558 pattern {item} [/ {item} [...]] / end
3559 actions {action} [/ {action} [...]] / end
3561 - Destroy specific flow rules::
3563 flow destroy {port_id} rule {rule_id} [...]
3565 - Destroy all flow rules::
3567 flow flush {port_id}
3569 - Query an existing flow rule::
3571 flow query {port_id} {rule_id} {action}
3573 - List existing flow rules sorted by priority, filtered by group
3576 flow list {port_id} [group {group_id}] [...]
3578 - Restrict ingress traffic to the defined flow rules::
3580 flow isolate {port_id} {boolean}
3582 Validating flow rules
3583 ~~~~~~~~~~~~~~~~~~~~~
3585 ``flow validate`` reports whether a flow rule would be accepted by the
3586 underlying device in its current state but stops short of creating it. It is
3587 bound to ``rte_flow_validate()``::
3589 flow validate {port_id}
3590 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3591 pattern {item} [/ {item} [...]] / end
3592 actions {action} [/ {action} [...]] / end
3594 If successful, it will show::
3598 Otherwise it will show an error message of the form::
3600 Caught error type [...] ([...]): [...]
3602 This command uses the same parameters as ``flow create``, their format is
3603 described in `Creating flow rules`_.
3605 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3606 index 6 is supported::
3608 testpmd> flow validate 0 ingress pattern eth / end
3609 actions queue index 6 / end
3613 Port 0 does not support TCPv6 rules::
3615 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3617 Caught error type 9 (specific pattern item): Invalid argument
3623 ``flow create`` validates and creates the specified flow rule. It is bound
3624 to ``rte_flow_create()``::
3626 flow create {port_id}
3627 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3628 pattern {item} [/ {item} [...]] / end
3629 actions {action} [/ {action} [...]] / end
3631 If successful, it will return a flow rule ID usable with other commands::
3633 Flow rule #[...] created
3635 Otherwise it will show an error message of the form::
3637 Caught error type [...] ([...]): [...]
3639 Parameters describe in the following order:
3641 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3642 - A matching pattern, starting with the *pattern* token and terminated by an
3644 - Actions, starting with the *actions* token and terminated by an *end*
3647 These translate directly to *rte_flow* objects provided as-is to the
3648 underlying functions.
3650 The shortest valid definition only comprises mandatory tokens::
3652 testpmd> flow create 0 pattern end actions end
3654 Note that PMDs may refuse rules that essentially do nothing such as this
3657 **All unspecified object values are automatically initialized to 0.**
3662 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3663 specified before the ``pattern`` token.
3665 - ``group {group id}``: priority group.
3666 - ``priority {level}``: priority level within group.
3667 - ``ingress``: rule applies to ingress traffic.
3668 - ``egress``: rule applies to egress traffic.
3669 - ``transfer``: apply rule directly to endpoints found in pattern.
3671 Each instance of an attribute specified several times overrides the previous
3672 value as shown below (group 4 is used)::
3674 testpmd> flow create 0 group 42 group 24 group 4 [...]
3676 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3678 While not specifying a direction is an error, some rules may allow both
3681 Most rules affect RX therefore contain the ``ingress`` token::
3683 testpmd> flow create 0 ingress pattern [...]
3688 A matching pattern starts after the ``pattern`` token. It is made of pattern
3689 items and is terminated by a mandatory ``end`` item.
3691 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3692 rte_flow_item_type``).
3694 The ``/`` token is used as a separator between pattern items as shown
3697 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3699 Note that protocol items like these must be stacked from lowest to highest
3700 layer to make sense. For instance, the following rule is either invalid or
3701 unlikely to match any packet::
3703 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3705 More information on these restrictions can be found in the *rte_flow*
3708 Several items support additional specification structures, for example
3709 ``ipv4`` allows specifying source and destination addresses as follows::
3711 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3712 dst is 10.2.0.0 / end [...]
3714 This rule matches all IPv4 traffic with the specified properties.
3716 In this example, ``src`` and ``dst`` are field names of the underlying
3717 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3718 in a similar fashion.
3720 The ``is`` token means that the subsequent value must be matched exactly,
3721 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3722 accordingly. Possible assignment tokens are:
3724 - ``is``: match value perfectly (with full bit-mask).
3725 - ``spec``: match value according to configured bit-mask.
3726 - ``last``: specify upper bound to establish a range.
3727 - ``mask``: specify bit-mask with relevant bits set to one.
3728 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3730 These yield identical results::
3732 ipv4 src is 10.1.1.1
3736 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3740 ipv4 src spec 10.1.1.1 src prefix 32
3744 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3748 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3750 Inclusive ranges can be defined with ``last``::
3752 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3754 Note that ``mask`` affects both ``spec`` and ``last``::
3756 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3757 # matches 10.1.0.0 to 10.2.255.255
3759 Properties can be modified multiple times::
3761 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3765 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3770 This section lists supported pattern items and their attributes, if any.
3772 - ``end``: end list of pattern items.
3774 - ``void``: no-op pattern item.
3776 - ``invert``: perform actions when pattern does not match.
3778 - ``any``: match any protocol for the current layer.
3780 - ``num {unsigned}``: number of layers covered.
3782 - ``pf``: match traffic from/to the physical function.
3784 - ``vf``: match traffic from/to a virtual function ID.
3786 - ``id {unsigned}``: VF ID.
3788 - ``phy_port``: match traffic from/to a specific physical port.
3790 - ``index {unsigned}``: physical port index.
3792 - ``port_id``: match traffic from/to a given DPDK port ID.
3794 - ``id {unsigned}``: DPDK port ID.
3796 - ``mark``: match value set in previously matched flow rule using the mark action.
3798 - ``id {unsigned}``: arbitrary integer value.
3800 - ``raw``: match an arbitrary byte string.
3802 - ``relative {boolean}``: look for pattern after the previous item.
3803 - ``search {boolean}``: search pattern from offset (see also limit).
3804 - ``offset {integer}``: absolute or relative offset for pattern.
3805 - ``limit {unsigned}``: search area limit for start of pattern.
3806 - ``pattern {string}``: byte string to look for.
3808 - ``eth``: match Ethernet header.
3810 - ``dst {MAC-48}``: destination MAC.
3811 - ``src {MAC-48}``: source MAC.
3812 - ``type {unsigned}``: EtherType or TPID.
3814 - ``vlan``: match 802.1Q/ad VLAN tag.
3816 - ``tci {unsigned}``: tag control information.
3817 - ``pcp {unsigned}``: priority code point.
3818 - ``dei {unsigned}``: drop eligible indicator.
3819 - ``vid {unsigned}``: VLAN identifier.
3820 - ``inner_type {unsigned}``: inner EtherType or TPID.
3822 - ``ipv4``: match IPv4 header.
3824 - ``tos {unsigned}``: type of service.
3825 - ``ttl {unsigned}``: time to live.
3826 - ``proto {unsigned}``: next protocol ID.
3827 - ``src {ipv4 address}``: source address.
3828 - ``dst {ipv4 address}``: destination address.
3830 - ``ipv6``: match IPv6 header.
3832 - ``tc {unsigned}``: traffic class.
3833 - ``flow {unsigned}``: flow label.
3834 - ``proto {unsigned}``: protocol (next header).
3835 - ``hop {unsigned}``: hop limit.
3836 - ``src {ipv6 address}``: source address.
3837 - ``dst {ipv6 address}``: destination address.
3839 - ``icmp``: match ICMP header.
3841 - ``type {unsigned}``: ICMP packet type.
3842 - ``code {unsigned}``: ICMP packet code.
3844 - ``udp``: match UDP header.
3846 - ``src {unsigned}``: UDP source port.
3847 - ``dst {unsigned}``: UDP destination port.
3849 - ``tcp``: match TCP header.
3851 - ``src {unsigned}``: TCP source port.
3852 - ``dst {unsigned}``: TCP destination port.
3854 - ``sctp``: match SCTP header.
3856 - ``src {unsigned}``: SCTP source port.
3857 - ``dst {unsigned}``: SCTP destination port.
3858 - ``tag {unsigned}``: validation tag.
3859 - ``cksum {unsigned}``: checksum.
3861 - ``vxlan``: match VXLAN header.
3863 - ``vni {unsigned}``: VXLAN identifier.
3865 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3867 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3869 - ``nvgre``: match NVGRE header.
3871 - ``tni {unsigned}``: virtual subnet ID.
3873 - ``mpls``: match MPLS header.
3875 - ``label {unsigned}``: MPLS label.
3877 - ``gre``: match GRE header.
3879 - ``protocol {unsigned}``: protocol type.
3881 - ``gre_key``: match GRE optional key field.
3883 - ``value {unsigned}``: key value.
3885 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3887 - ``thresh {unsigned}``: accuracy threshold.
3889 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3891 - ``teid {unsigned}``: tunnel endpoint identifier.
3893 - ``geneve``: match GENEVE header.
3895 - ``vni {unsigned}``: virtual network identifier.
3896 - ``protocol {unsigned}``: protocol type.
3898 - ``vxlan-gpe``: match VXLAN-GPE header.
3900 - ``vni {unsigned}``: VXLAN-GPE identifier.
3902 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3904 - ``sha {MAC-48}``: sender hardware address.
3905 - ``spa {ipv4 address}``: sender IPv4 address.
3906 - ``tha {MAC-48}``: target hardware address.
3907 - ``tpa {ipv4 address}``: target IPv4 address.
3909 - ``ipv6_ext``: match presence of any IPv6 extension header.
3911 - ``next_hdr {unsigned}``: next header.
3913 - ``icmp6``: match any ICMPv6 header.
3915 - ``type {unsigned}``: ICMPv6 type.
3916 - ``code {unsigned}``: ICMPv6 code.
3918 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3920 - ``target_addr {ipv6 address}``: target address.
3922 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3924 - ``target_addr {ipv6 address}``: target address.
3926 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3928 - ``type {unsigned}``: ND option type.
3930 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3931 link-layer address option.
3933 - ``sla {MAC-48}``: source Ethernet LLA.
3935 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3936 link-layer address option.
3938 - ``tla {MAC-48}``: target Ethernet LLA.
3940 - ``meta``: match application specific metadata.
3942 - ``data {unsigned}``: metadata value.
3944 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3946 - ``pdu_type {unsigned}``: PDU type.
3947 - ``qfi {unsigned}``: QoS flow identifier.
3949 - ``pppoes``, ``pppoed``: match PPPoE header.
3951 - ``session_id {unsigned}``: session identifier.
3953 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3955 - ``proto_id {unsigned}``: PPP protocol identifier.
3960 A list of actions starts after the ``actions`` token in the same fashion as
3961 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3962 terminated by a mandatory ``end`` action.
3964 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3965 rte_flow_action_type``).
3967 Dropping all incoming UDPv4 packets can be expressed as follows::
3969 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3972 Several actions have configurable properties which must be specified when
3973 there is no valid default value. For example, ``queue`` requires a target
3976 This rule redirects incoming UDPv4 traffic to queue index 6::
3978 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3979 actions queue index 6 / end
3981 While this one could be rejected by PMDs (unspecified queue index)::
3983 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3986 As defined by *rte_flow*, the list is not ordered, all actions of a given
3987 rule are performed simultaneously. These are equivalent::
3989 queue index 6 / void / mark id 42 / end
3993 void / mark id 42 / queue index 6 / end
3995 All actions in a list should have different types, otherwise only the last
3996 action of a given type is taken into account::
3998 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4002 drop / drop / drop / end # drop is performed only once
4006 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4008 Considering they are performed simultaneously, opposite and overlapping
4009 actions can sometimes be combined when the end result is unambiguous::
4011 drop / queue index 6 / end # drop has no effect
4015 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4019 drop / passthru / end # drop has no effect
4021 Note that PMDs may still refuse such combinations.
4026 This section lists supported actions and their attributes, if any.
4028 - ``end``: end list of actions.
4030 - ``void``: no-op action.
4032 - ``passthru``: let subsequent rule process matched packets.
4034 - ``jump``: redirect traffic to group on device.
4036 - ``group {unsigned}``: group to redirect to.
4038 - ``mark``: attach 32 bit value to packets.
4040 - ``id {unsigned}``: 32 bit value to return with packets.
4042 - ``flag``: flag packets.
4044 - ``queue``: assign packets to a given queue index.
4046 - ``index {unsigned}``: queue index to use.
4048 - ``drop``: drop packets (note: passthru has priority).
4050 - ``count``: enable counters for this rule.
4052 - ``rss``: spread packets among several queues.
4054 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4055 the same as `set_hash_global_config`_.
4057 - ``level {unsigned}``: encapsulation level for ``types``.
4059 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4060 tokens are the same as `set_hash_input_set`_, except that an empty list
4061 does not disable RSS but instead requests unspecified "best-effort"
4064 - ``key {string}``: RSS hash key, overrides ``key_len``.
4066 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4067 conjunction with ``key`` to pad or truncate it.
4069 - ``queues [{unsigned} [...]] end``: queue indices to use.
4071 - ``pf``: direct traffic to physical function.
4073 - ``vf``: direct traffic to a virtual function ID.
4075 - ``original {boolean}``: use original VF ID if possible.
4076 - ``id {unsigned}``: VF ID.
4078 - ``phy_port``: direct packets to physical port index.
4080 - ``original {boolean}``: use original port index if possible.
4081 - ``index {unsigned}``: physical port index.
4083 - ``port_id``: direct matching traffic to a given DPDK port ID.
4085 - ``original {boolean}``: use original DPDK port ID if possible.
4086 - ``id {unsigned}``: DPDK port ID.
4088 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4090 - ``mpls_ttl``: MPLS TTL.
4092 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4094 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4096 - ``nw_ttl``: IP TTL.
4098 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4100 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4102 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4104 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4106 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4108 - ``ethertype``: Ethertype.
4110 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4112 - ``vlan_vid``: VLAN id.
4114 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4116 - ``vlan_pcp``: VLAN priority.
4118 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4120 - ``ethertype``: Ethertype.
4122 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4124 - ``ethertype``: Ethertype.
4126 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4127 is done through `Config VXLAN Encap outer layers`_.
4129 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4130 the VXLAN tunnel network overlay from the matched flow.
4132 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4133 is done through `Config NVGRE Encap outer layers`_.
4135 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4136 the NVGRE tunnel network overlay from the matched flow.
4138 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4139 is done through `Config L2 Encap`_.
4141 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4142 is done through `Config L2 Decap`_.
4144 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4145 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4147 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4148 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4150 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4151 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4153 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4154 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4156 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4158 - ``ipv4_addr``: New IPv4 source address.
4160 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4163 - ``ipv4_addr``: New IPv4 destination address.
4165 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4167 - ``ipv6_addr``: New IPv6 source address.
4169 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4172 - ``ipv6_addr``: New IPv6 destination address.
4174 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4177 - ``port``: New TCP/UDP source port number.
4179 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4182 - ``port``: New TCP/UDP destination port number.
4184 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4187 - ``dec_ttl``: Performs a decrease TTL value action
4189 - ``set_ttl``: Set TTL value with specified value
4190 - ``ttl_value {unsigned}``: The new TTL value to be set
4192 - ``set_mac_src``: set source MAC address
4194 - ``mac_addr {MAC-48}``: new source MAC address
4196 - ``set_mac_dst``: set destination MAC address
4198 - ``mac_addr {MAC-48}``: new destination MAC address
4200 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4202 - ``value {unsigned}``: Value to increase TCP sequence number by.
4204 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4206 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4208 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4210 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4212 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4214 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4216 Destroying flow rules
4217 ~~~~~~~~~~~~~~~~~~~~~
4219 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4220 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4221 times as necessary::
4223 flow destroy {port_id} rule {rule_id} [...]
4225 If successful, it will show::
4227 Flow rule #[...] destroyed
4229 It does not report anything for rule IDs that do not exist. The usual error
4230 message is shown when a rule cannot be destroyed::
4232 Caught error type [...] ([...]): [...]
4234 ``flow flush`` destroys all rules on a device and does not take extra
4235 arguments. It is bound to ``rte_flow_flush()``::
4237 flow flush {port_id}
4239 Any errors are reported as above.
4241 Creating several rules and destroying them::
4243 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4244 actions queue index 2 / end
4245 Flow rule #0 created
4246 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4247 actions queue index 3 / end
4248 Flow rule #1 created
4249 testpmd> flow destroy 0 rule 0 rule 1
4250 Flow rule #1 destroyed
4251 Flow rule #0 destroyed
4254 The same result can be achieved using ``flow flush``::
4256 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4257 actions queue index 2 / end
4258 Flow rule #0 created
4259 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4260 actions queue index 3 / end
4261 Flow rule #1 created
4262 testpmd> flow flush 0
4265 Non-existent rule IDs are ignored::
4267 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4268 actions queue index 2 / end
4269 Flow rule #0 created
4270 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4271 actions queue index 3 / end
4272 Flow rule #1 created
4273 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4275 testpmd> flow destroy 0 rule 0
4276 Flow rule #0 destroyed
4282 ``flow query`` queries a specific action of a flow rule having that
4283 ability. Such actions collect information that can be reported using this
4284 command. It is bound to ``rte_flow_query()``::
4286 flow query {port_id} {rule_id} {action}
4288 If successful, it will display either the retrieved data for known actions
4289 or the following message::
4291 Cannot display result for action type [...] ([...])
4293 Otherwise, it will complain either that the rule does not exist or that some
4296 Flow rule #[...] not found
4300 Caught error type [...] ([...]): [...]
4302 Currently only the ``count`` action is supported. This action reports the
4303 number of packets that hit the flow rule and the total number of bytes. Its
4304 output has the following format::
4307 hits_set: [...] # whether "hits" contains a valid value
4308 bytes_set: [...] # whether "bytes" contains a valid value
4309 hits: [...] # number of packets
4310 bytes: [...] # number of bytes
4312 Querying counters for TCPv6 packets redirected to queue 6::
4314 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4315 actions queue index 6 / count / end
4316 Flow rule #4 created
4317 testpmd> flow query 0 4 count
4328 ``flow list`` lists existing flow rules sorted by priority and optionally
4329 filtered by group identifiers::
4331 flow list {port_id} [group {group_id}] [...]
4333 This command only fails with the following message if the device does not
4338 Output consists of a header line followed by a short description of each
4339 flow rule, one per line. There is no output at all when no flow rules are
4340 configured on the device::
4342 ID Group Prio Attr Rule
4343 [...] [...] [...] [...] [...]
4345 ``Attr`` column flags:
4347 - ``i`` for ``ingress``.
4348 - ``e`` for ``egress``.
4350 Creating several flow rules and listing them::
4352 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4353 actions queue index 6 / end
4354 Flow rule #0 created
4355 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4356 actions queue index 2 / end
4357 Flow rule #1 created
4358 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4359 actions rss queues 6 7 8 end / end
4360 Flow rule #2 created
4361 testpmd> flow list 0
4362 ID Group Prio Attr Rule
4363 0 0 0 i- ETH IPV4 => QUEUE
4364 1 0 0 i- ETH IPV6 => QUEUE
4365 2 0 5 i- ETH IPV4 UDP => RSS
4368 Rules are sorted by priority (i.e. group ID first, then priority level)::
4370 testpmd> flow list 1
4371 ID Group Prio Attr Rule
4372 0 0 0 i- ETH => COUNT
4373 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4374 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4375 1 24 0 i- ETH IPV4 UDP => QUEUE
4376 4 24 10 i- ETH IPV4 TCP => DROP
4377 3 24 20 i- ETH IPV4 => DROP
4378 2 24 42 i- ETH IPV4 UDP => QUEUE
4379 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4382 Output can be limited to specific groups::
4384 testpmd> flow list 1 group 0 group 63
4385 ID Group Prio Attr Rule
4386 0 0 0 i- ETH => COUNT
4387 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4388 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4389 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4392 Toggling isolated mode
4393 ~~~~~~~~~~~~~~~~~~~~~~
4395 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4396 must only be injected from the defined flow rules; that no default traffic
4397 is expected outside those rules and the driver is free to assign more
4398 resources to handle them. It is bound to ``rte_flow_isolate()``::
4400 flow isolate {port_id} {boolean}
4402 If successful, enabling or disabling isolated mode shows either::
4404 Ingress traffic on port [...]
4405 is now restricted to the defined flow rules
4409 Ingress traffic on port [...]
4410 is not restricted anymore to the defined flow rules
4412 Otherwise, in case of error::
4414 Caught error type [...] ([...]): [...]
4416 Mainly due to its side effects, PMDs supporting this mode may not have the
4417 ability to toggle it more than once without reinitializing affected ports
4418 first (e.g. by exiting testpmd).
4420 Enabling isolated mode::
4422 testpmd> flow isolate 0 true
4423 Ingress traffic on port 0 is now restricted to the defined flow rules
4426 Disabling isolated mode::
4428 testpmd> flow isolate 0 false
4429 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4432 Sample QinQ flow rules
4433 ~~~~~~~~~~~~~~~~~~~~~~
4435 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4437 testpmd> port stop 0
4438 testpmd> vlan set qinq_strip on 0
4440 The above command sets the inner and outer TPID's to 0x8100.
4442 To change the TPID's the following commands should be used::
4444 testpmd> vlan set outer tpid 0xa100 0
4445 testpmd> vlan set inner tpid 0x9100 0
4446 testpmd> port start 0
4448 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4452 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4453 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4454 Flow rule #0 validated
4456 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4457 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4458 Flow rule #0 created
4460 testpmd> flow list 0
4461 ID Group Prio Attr Rule
4462 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4464 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4468 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4469 vlan tci is 654 / end actions pf / queue index 0 / end
4470 Flow rule #1 validated
4472 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4473 vlan tci is 654 / end actions pf / queue index 1 / end
4474 Flow rule #1 created
4476 testpmd> flow list 0
4477 ID Group Prio Attr Rule
4478 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4479 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4481 Sample VXLAN encapsulation rule
4482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4484 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4485 source code, those can be changed by using the following commands
4487 IPv4 VXLAN outer header::
4489 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4490 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4491 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4494 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4495 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4496 eth-dst 22:22:22:22:22:22
4497 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4500 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4501 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4502 eth-dst 22:22:22:22:22:22
4503 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4506 IPv6 VXLAN outer header::
4508 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4509 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4510 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4513 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4514 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4515 eth-dst 22:22:22:22:22:22
4516 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4519 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4520 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4521 eth-dst 22:22:22:22:22:22
4522 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4525 Sample NVGRE encapsulation rule
4526 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4528 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4529 source code, those can be changed by using the following commands
4531 IPv4 NVGRE outer header::
4533 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4534 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4535 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4538 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4539 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4540 eth-dst 22:22:22:22:22:22
4541 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4544 IPv6 NVGRE outer header::
4546 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4547 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4548 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4551 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4552 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4553 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4556 Sample L2 encapsulation rule
4557 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4559 L2 encapsulation has default value pre-configured in testpmd
4560 source code, those can be changed by using the following commands
4564 testpmd> set l2_encap ip-version ipv4
4565 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4566 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4567 mplsoudp_decap / l2_encap / end
4569 L2 with VXLAN header::
4571 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4572 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4573 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4574 mplsoudp_decap / l2_encap / end
4576 Sample L2 decapsulation rule
4577 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4579 L2 decapsulation has default value pre-configured in testpmd
4580 source code, those can be changed by using the following commands
4584 testpmd> set l2_decap
4585 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4588 L2 with VXLAN header::
4590 testpmd> set l2_encap-with-vlan
4591 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4594 Sample MPLSoGRE encapsulation rule
4595 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4597 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4598 source code, those can be changed by using the following commands
4600 IPv4 MPLSoGRE outer header::
4602 testpmd> set mplsogre_encap ip-version ipv4 label 4
4603 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4604 eth-dst 22:22:22:22:22:22
4605 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4606 mplsogre_encap / end
4608 IPv4 MPLSoGRE with VLAN outer header::
4610 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4611 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4612 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4613 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4614 mplsogre_encap / end
4616 IPv6 MPLSoGRE outer header::
4618 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4619 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4620 eth-dst 22:22:22:22:22:22
4621 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4622 mplsogre_encap / end
4624 IPv6 MPLSoGRE with VLAN outer header::
4626 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4627 ip-src ::1 ip-dst ::2222 vlan-tci 34
4628 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4629 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4630 mplsogre_encap / end
4632 Sample MPLSoGRE decapsulation rule
4633 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4635 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4636 source code, those can be changed by using the following commands
4638 IPv4 MPLSoGRE outer header::
4640 testpmd> set mplsogre_decap ip-version ipv4
4641 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4642 mplsogre_decap / l2_encap / end
4644 IPv4 MPLSoGRE with VLAN outer header::
4646 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4647 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4648 actions mplsogre_decap / l2_encap / end
4650 IPv6 MPLSoGRE outer header::
4652 testpmd> set mplsogre_decap ip-version ipv6
4653 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4654 actions mplsogre_decap / l2_encap / end
4656 IPv6 MPLSoGRE with VLAN outer header::
4658 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4659 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4660 actions mplsogre_decap / l2_encap / end
4662 Sample MPLSoUDP encapsulation rule
4663 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4665 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4666 source code, those can be changed by using the following commands
4668 IPv4 MPLSoUDP outer header::
4670 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4671 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4672 eth-dst 22:22:22:22:22:22
4673 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4674 mplsoudp_encap / end
4676 IPv4 MPLSoUDP with VLAN outer header::
4678 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4679 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4680 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4681 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4682 mplsoudp_encap / end
4684 IPv6 MPLSoUDP outer header::
4686 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4687 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4688 eth-dst 22:22:22:22:22:22
4689 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4690 mplsoudp_encap / end
4692 IPv6 MPLSoUDP with VLAN outer header::
4694 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4695 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4696 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4697 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4698 mplsoudp_encap / end
4700 Sample MPLSoUDP decapsulation rule
4701 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4703 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4704 source code, those can be changed by using the following commands
4706 IPv4 MPLSoUDP outer header::
4708 testpmd> set mplsoudp_decap ip-version ipv4
4709 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4710 mplsoudp_decap / l2_encap / end
4712 IPv4 MPLSoUDP with VLAN outer header::
4714 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4715 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4716 actions mplsoudp_decap / l2_encap / end
4718 IPv6 MPLSoUDP outer header::
4720 testpmd> set mplsoudp_decap ip-version ipv6
4721 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4722 actions mplsoudp_decap / l2_encap / end
4724 IPv6 MPLSoUDP with VLAN outer header::
4726 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4727 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4728 actions mplsoudp_decap / l2_encap / end
4730 Sample Raw encapsulation rule
4731 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4733 Raw encapsulation configuration can be set by the following commands
4735 Eecapsulating VxLAN::
4737 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4738 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4740 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4741 raw_encap index 4 / end
4743 Sample Raw decapsulation rule
4744 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4746 Raw decapsulation configuration can be set by the following commands
4748 Decapsulating VxLAN::
4750 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4751 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4752 end actions raw_decap / queue index 0 / end
4757 The following sections show functions to load/unload eBPF based filters.
4762 Load an eBPF program as a callback for particular RX/TX queue::
4764 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4766 The available load-flags are:
4768 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4770 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4776 You'll need clang v3.7 or above to build bpf program you'd like to load
4780 .. code-block:: console
4783 clang -O2 -target bpf -c t1.c
4785 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4787 .. code-block:: console
4789 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4791 To load (not JITed) t1.o at TX queue 0, port 0:
4793 .. code-block:: console
4795 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4800 Unload previously loaded eBPF program for particular RX/TX queue::
4802 testpmd> bpf-unload rx|tx (portid) (queueid)
4804 For example to unload BPF filter from TX queue 0, port 0:
4806 .. code-block:: console
4808 testpmd> bpf-unload tx 0 0