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,
1724 This command should be run when the port is stopped, or else it will fail.
1726 config per queue Tx offloading
1727 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1729 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1731 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1733 * ``offloading``: can be any of these offloading capability:
1734 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1735 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1736 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1737 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1738 mt_lockfree, multi_segs, mbuf_fast_free, security
1740 This command should be run when the port is stopped, or else it will fail.
1742 Config VXLAN Encap outer layers
1743 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1745 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1747 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1748 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1751 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1752 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1753 eth-src (eth-src) eth-dst (eth-dst)
1755 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1756 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1757 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1759 These commands will set an internal configuration inside testpmd, any following
1760 flow rule using the action vxlan_encap will use the last configuration set.
1761 To have a different encapsulation header, one of those commands must be called
1762 before the flow rule creation.
1764 Config NVGRE Encap outer layers
1765 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1767 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1769 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1770 eth-src (eth-src) eth-dst (eth-dst)
1771 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1772 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1774 These commands will set an internal configuration inside testpmd, any following
1775 flow rule using the action nvgre_encap will use the last configuration set.
1776 To have a different encapsulation header, one of those commands must be called
1777 before the flow rule creation.
1782 Configure the l2 to be used when encapsulating a packet with L2::
1784 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1785 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1786 eth-src (eth-src) eth-dst (eth-dst)
1788 Those commands will set an internal configuration inside testpmd, any following
1789 flow rule using the action l2_encap will use the last configuration set.
1790 To have a different encapsulation header, one of those commands must be called
1791 before the flow rule creation.
1796 Configure the l2 to be removed when decapsulating a packet with L2::
1798 set l2_decap ip-version (ipv4|ipv6)
1799 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1801 Those commands will set an internal configuration inside testpmd, any following
1802 flow rule using the action l2_decap will use the last configuration set.
1803 To have a different encapsulation header, one of those commands must be called
1804 before the flow rule creation.
1806 Config MPLSoGRE Encap outer layers
1807 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1809 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1811 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1812 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1813 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1814 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1815 eth-src (eth-src) eth-dst (eth-dst)
1817 These commands will set an internal configuration inside testpmd, any following
1818 flow rule using the action mplsogre_encap will use the last configuration set.
1819 To have a different encapsulation header, one of those commands must be called
1820 before the flow rule creation.
1822 Config MPLSoGRE Decap outer layers
1823 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1825 Configure the outer layer to decapsulate MPLSoGRE packet::
1827 set mplsogre_decap ip-version (ipv4|ipv6)
1828 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1830 These commands will set an internal configuration inside testpmd, any following
1831 flow rule using the action mplsogre_decap will use the last configuration set.
1832 To have a different decapsulation header, one of those commands must be called
1833 before the flow rule creation.
1835 Config MPLSoUDP Encap outer layers
1836 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1838 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1840 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1841 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1842 eth-src (eth-src) eth-dst (eth-dst)
1843 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1844 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1845 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1847 These commands will set an internal configuration inside testpmd, any following
1848 flow rule using the action mplsoudp_encap will use the last configuration set.
1849 To have a different encapsulation header, one of those commands must be called
1850 before the flow rule creation.
1852 Config MPLSoUDP Decap outer layers
1853 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1855 Configure the outer layer to decapsulate MPLSoUDP packet::
1857 set mplsoudp_decap ip-version (ipv4|ipv6)
1858 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1860 These commands will set an internal configuration inside testpmd, any following
1861 flow rule using the action mplsoudp_decap will use the last configuration set.
1862 To have a different decapsulation header, one of those commands must be called
1863 before the flow rule creation.
1865 Config Raw Encapsulation
1866 ~~~~~~~~~~~~~~~~~~~~~~~~~
1868 Configure the raw data to be used when encapsulating a packet by
1869 rte_flow_action_raw_encap::
1871 set raw_encap {index} {item} [/ {item} [...]] / end_set
1873 There are multiple global buffers for ``raw_encap``, this command will set one
1874 internal buffer index by ``{index}``.
1875 If there is no ``{index}`` specified::
1877 set raw_encap {item} [/ {item} [...]] / end_set
1879 the default index ``0`` is used.
1880 In order to use different encapsulating header, ``index`` must be specified
1881 during the flow rule creation::
1883 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1884 raw_encap index 2 / end
1886 Otherwise the default index ``0`` is used.
1888 Config Raw Decapsulation
1889 ~~~~~~~~~~~~~~~~~~~~~~~~
1891 Configure the raw data to be used when decapsulating a packet by
1892 rte_flow_action_raw_decap::
1894 set raw_decap {index} {item} [/ {item} [...]] / end_set
1896 There are multiple global buffers for ``raw_decap``, this command will set
1897 one internal buffer index by ``{index}``.
1898 If there is no ``{index}`` specified::
1900 set raw_decap {item} [/ {item} [...]] / end_set
1902 the default index ``0`` is used.
1903 In order to use different decapsulating header, ``index`` must be specified
1904 during the flow rule creation::
1906 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1907 raw_encap index 3 / end
1909 Otherwise the default index ``0`` is used.
1914 The following sections show functions for configuring ports.
1918 Port configuration changes only become active when forwarding is started/restarted.
1923 Attach a port specified by pci address or virtual device args::
1925 testpmd> port attach (identifier)
1927 To attach a new pci device, the device should be recognized by kernel first.
1928 Then it should be moved under DPDK management.
1929 Finally the port can be attached to testpmd.
1931 For example, to move a pci device using ixgbe under DPDK management:
1933 .. code-block:: console
1935 # Check the status of the available devices.
1936 ./usertools/dpdk-devbind.py --status
1938 Network devices using DPDK-compatible driver
1939 ============================================
1942 Network devices using kernel driver
1943 ===================================
1944 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1947 # Bind the device to igb_uio.
1948 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1951 # Recheck the status of the devices.
1952 ./usertools/dpdk-devbind.py --status
1953 Network devices using DPDK-compatible driver
1954 ============================================
1955 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1957 To attach a port created by virtual device, above steps are not needed.
1959 For example, to attach a port whose pci address is 0000:0a:00.0.
1961 .. code-block:: console
1963 testpmd> port attach 0000:0a:00.0
1964 Attaching a new port...
1965 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1966 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1967 EAL: PCI memory mapped at 0x7f83bfa00000
1968 EAL: PCI memory mapped at 0x7f83bfa80000
1969 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1970 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1971 Port 0 is attached. Now total ports is 1
1974 For example, to attach a port created by pcap PMD.
1976 .. code-block:: console
1978 testpmd> port attach net_pcap0
1979 Attaching a new port...
1980 PMD: Initializing pmd_pcap for net_pcap0
1981 PMD: Creating pcap-backed ethdev on numa socket 0
1982 Port 0 is attached. Now total ports is 1
1985 In this case, identifier is ``net_pcap0``.
1986 This identifier format is the same as ``--vdev`` format of DPDK applications.
1988 For example, to re-attach a bonded port which has been previously detached,
1989 the mode and slave parameters must be given.
1991 .. code-block:: console
1993 testpmd> port attach net_bond_0,mode=0,slave=1
1994 Attaching a new port...
1995 EAL: Initializing pmd_bond for net_bond_0
1996 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1997 Port 0 is attached. Now total ports is 1
2004 Detach a specific port::
2006 testpmd> port detach (port_id)
2008 Before detaching a port, the port should be stopped and closed.
2010 For example, to detach a pci device port 0.
2012 .. code-block:: console
2014 testpmd> port stop 0
2017 testpmd> port close 0
2021 testpmd> port detach 0
2023 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2024 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2025 EAL: PCI memory unmapped at 0x7f83bfa00000
2026 EAL: PCI memory unmapped at 0x7f83bfa80000
2030 For example, to detach a virtual device port 0.
2032 .. code-block:: console
2034 testpmd> port stop 0
2037 testpmd> port close 0
2041 testpmd> port detach 0
2043 PMD: Closing pcap ethdev on numa socket 0
2044 Port 'net_pcap0' is detached. Now total ports is 0
2047 To remove a pci device completely from the system, first detach the port from testpmd.
2048 Then the device should be moved under kernel management.
2049 Finally the device can be removed using kernel pci hotplug functionality.
2051 For example, to move a pci device under kernel management:
2053 .. code-block:: console
2055 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2057 ./usertools/dpdk-devbind.py --status
2059 Network devices using DPDK-compatible driver
2060 ============================================
2063 Network devices using kernel driver
2064 ===================================
2065 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2067 To remove a port created by a virtual device, above steps are not needed.
2072 Start all ports or a specific port::
2074 testpmd> port start (port_id|all)
2079 Stop all ports or a specific port::
2081 testpmd> port stop (port_id|all)
2086 Close all ports or a specific port::
2088 testpmd> port close (port_id|all)
2093 Reset all ports or a specific port::
2095 testpmd> port reset (port_id|all)
2097 User should stop port(s) before resetting and (re-)start after reset.
2099 port config - queue ring size
2100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2102 Configure a rx/tx queue ring size::
2104 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2106 Only take effect after command that (re-)start the port or command that setup specific queue.
2108 port start/stop queue
2109 ~~~~~~~~~~~~~~~~~~~~~
2111 Start/stop a rx/tx queue on a specific port::
2113 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2115 port config - queue deferred start
2116 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2118 Switch on/off deferred start of a specific port queue::
2120 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2123 ~~~~~~~~~~~~~~~~~~~~~
2125 Setup a rx/tx queue on a specific port::
2127 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2129 Only take effect when port is started.
2134 Set the speed and duplex mode for all ports or a specific port::
2136 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
2137 duplex (half|full|auto)
2139 port config - queues/descriptors
2140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2142 Set number of queues/descriptors for rxq, txq, rxd and txd::
2144 testpmd> port config all (rxq|txq|rxd|txd) (value)
2146 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2148 port config - max-pkt-len
2149 ~~~~~~~~~~~~~~~~~~~~~~~~~
2151 Set the maximum packet length::
2153 testpmd> port config all max-pkt-len (value)
2155 This is equivalent to the ``--max-pkt-len`` command-line option.
2157 port config - max-lro-pkt-size
2158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2160 Set the maximum LRO aggregated packet size::
2162 testpmd> port config all max-lro-pkt-size (value)
2164 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2166 port config - Drop Packets
2167 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2169 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2171 testpmd> port config all drop-en (on|off)
2173 Packet dropping when no receive buffers available is off by default.
2175 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2180 Set the RSS (Receive Side Scaling) mode on or off::
2182 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|none)
2184 RSS is on by default.
2186 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
2187 The ``default`` option enables all supported RSS types reported by device info.
2188 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2190 port config - RSS Reta
2191 ~~~~~~~~~~~~~~~~~~~~~~
2193 Set the RSS (Receive Side Scaling) redirection table::
2195 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2200 Set the DCB mode for an individual port::
2202 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2204 The traffic class should be 4 or 8.
2209 Set the number of packets per burst::
2211 testpmd> port config all burst (value)
2213 This is equivalent to the ``--burst`` command-line option.
2215 port config - Threshold
2216 ~~~~~~~~~~~~~~~~~~~~~~~
2218 Set thresholds for TX/RX queues::
2220 testpmd> port config all (threshold) (value)
2222 Where the threshold type can be:
2224 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2226 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2228 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2230 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2232 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2234 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2236 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2238 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2240 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2242 These threshold options are also available from the command-line.
2247 Set the value of ether-type for E-tag::
2249 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2251 Enable/disable the E-tag support::
2253 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2255 port config pctype mapping
2256 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2258 Reset pctype mapping table::
2260 testpmd> port config (port_id) pctype mapping reset
2262 Update hardware defined pctype to software defined flow type mapping table::
2264 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2268 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2270 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2272 port config input set
2273 ~~~~~~~~~~~~~~~~~~~~~
2275 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2277 testpmd> port config (port_id) pctype (pctype_id) \
2278 (hash_inset|fdir_inset|fdir_flx_inset) \
2279 (get|set|clear) field (field_idx)
2281 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2283 testpmd> port config (port_id) pctype (pctype_id) \
2284 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2288 * ``pctype_id``: hardware packet classification types.
2289 * ``field_idx``: hardware field index.
2291 port config udp_tunnel_port
2292 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2294 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2296 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2298 port config tx_metadata
2299 ~~~~~~~~~~~~~~~~~~~~~~~
2301 Set Tx metadata value per port.
2302 testpmd will add this value to any Tx packet sent from this port::
2304 testpmd> port config (port_id) tx_metadata (value)
2309 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2311 testpmd> port config mtu (port_id) (value)
2313 port config rss hash key
2314 ~~~~~~~~~~~~~~~~~~~~~~~~
2316 To configure the RSS hash key used to compute the RSS
2317 hash of input [IP] packets received on port::
2319 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2320 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2321 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2322 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2323 ipv6-udp-ex <string of hex digits \
2324 (variable length, NIC dependent)>)
2329 The following sections show functions for device operations.
2334 Detach a device specified by pci address or virtual device args::
2336 testpmd> device detach (identifier)
2338 Before detaching a device associated with ports, the ports should be stopped and closed.
2340 For example, to detach a pci device whose address is 0002:03:00.0.
2342 .. code-block:: console
2344 testpmd> device detach 0002:03:00.0
2345 Removing a device...
2346 Port 1 is now closed
2347 EAL: Releasing pci mapped resource for 0002:03:00.0
2348 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2349 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2350 Device 0002:03:00.0 is detached
2351 Now total ports is 1
2353 For example, to detach a port created by pcap PMD.
2355 .. code-block:: console
2357 testpmd> device detach net_pcap0
2358 Removing a device...
2359 Port 0 is now closed
2360 Device net_pcap0 is detached
2361 Now total ports is 0
2364 In this case, identifier is ``net_pcap0``.
2365 This identifier format is the same as ``--vdev`` format of DPDK applications.
2367 Link Bonding Functions
2368 ----------------------
2370 The Link Bonding functions make it possible to dynamically create and
2371 manage link bonding devices from within testpmd interactive prompt.
2373 create bonded device
2374 ~~~~~~~~~~~~~~~~~~~~
2376 Create a new bonding device::
2378 testpmd> create bonded device (mode) (socket)
2380 For example, to create a bonded device in mode 1 on socket 0::
2382 testpmd> create bonded device 1 0
2383 created new bonded device (port X)
2388 Adds Ethernet device to a Link Bonding device::
2390 testpmd> add bonding slave (slave id) (port id)
2392 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2394 testpmd> add bonding slave 6 10
2397 remove bonding slave
2398 ~~~~~~~~~~~~~~~~~~~~
2400 Removes an Ethernet slave device from a Link Bonding device::
2402 testpmd> remove bonding slave (slave id) (port id)
2404 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2406 testpmd> remove bonding slave 6 10
2411 Set the Link Bonding mode of a Link Bonding device::
2413 testpmd> set bonding mode (value) (port id)
2415 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2417 testpmd> set bonding mode 3 10
2422 Set an Ethernet slave device as the primary device on a Link Bonding device::
2424 testpmd> set bonding primary (slave id) (port id)
2426 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2428 testpmd> set bonding primary 6 10
2433 Set the MAC address of a Link Bonding device::
2435 testpmd> set bonding mac (port id) (mac)
2437 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2439 testpmd> set bonding mac 10 00:00:00:00:00:01
2441 set bonding xmit_balance_policy
2442 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2444 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2446 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2448 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2450 testpmd> set bonding xmit_balance_policy 10 l34
2453 set bonding mon_period
2454 ~~~~~~~~~~~~~~~~~~~~~~
2456 Set the link status monitoring polling period in milliseconds for a bonding device.
2458 This adds support for PMD slave devices which do not support link status interrupts.
2459 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2460 link status ISR will be queried every polling interval to check if their link status has changed::
2462 testpmd> set bonding mon_period (port_id) (value)
2464 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2466 testpmd> set bonding mon_period 5 150
2469 set bonding lacp dedicated_queue
2470 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2472 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2473 when in mode 4 (link-aggregation-802.3ad)::
2475 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2478 set bonding agg_mode
2479 ~~~~~~~~~~~~~~~~~~~~
2481 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2483 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2489 Show the current configuration of a Link Bonding device::
2491 testpmd> show bonding config (port id)
2494 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2495 in balance mode with a transmission policy of layer 2+3::
2497 testpmd> show bonding config 9
2499 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2501 Active Slaves (3): [1 3 4]
2508 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2509 This is mainly useful for debugging purposes.
2510 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2511 and fields that can be accessed.
2516 Display the value of a port register::
2518 testpmd> read reg (port_id) (address)
2520 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2522 testpmd> read reg 0 0xEE00
2523 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2528 Display a port register bit field::
2530 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2532 For example, reading the lowest two bits from the register in the example above::
2534 testpmd> read regfield 0 0xEE00 0 1
2535 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2540 Display a single port register bit::
2542 testpmd> read regbit (port_id) (address) (bit_x)
2544 For example, reading the lowest bit from the register in the example above::
2546 testpmd> read regbit 0 0xEE00 0
2547 port 0 PCI register at offset 0xEE00: bit 0=1
2552 Set the value of a port register::
2554 testpmd> write reg (port_id) (address) (value)
2556 For example, to clear a register::
2558 testpmd> write reg 0 0xEE00 0x0
2559 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2564 Set bit field of a port register::
2566 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2568 For example, writing to the register cleared in the example above::
2570 testpmd> write regfield 0 0xEE00 0 1 2
2571 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2576 Set single bit value of a port register::
2578 testpmd> write regbit (port_id) (address) (bit_x) (value)
2580 For example, to set the high bit in the register from the example above::
2582 testpmd> write regbit 0 0xEE00 31 1
2583 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2585 Traffic Metering and Policing
2586 -----------------------------
2588 The following section shows functions for configuring traffic metering and
2589 policing on the ethernet device through the use of generic ethdev API.
2591 show port traffic management capability
2592 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2594 Show traffic metering and policing capability of the port::
2596 testpmd> show port meter cap (port_id)
2598 add port meter profile (srTCM rfc2967)
2599 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2601 Add meter profile (srTCM rfc2697) to the ethernet device::
2603 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2608 * ``profile_id``: ID for the meter profile.
2609 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2610 * ``cbs``: Committed Burst Size (CBS) (bytes).
2611 * ``ebs``: Excess Burst Size (EBS) (bytes).
2613 add port meter profile (trTCM rfc2968)
2614 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2616 Add meter profile (srTCM rfc2698) to the ethernet device::
2618 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2619 (cir) (pir) (cbs) (pbs)
2623 * ``profile_id``: ID for the meter profile.
2624 * ``cir``: Committed information rate (bytes/second).
2625 * ``pir``: Peak information rate (bytes/second).
2626 * ``cbs``: Committed burst size (bytes).
2627 * ``pbs``: Peak burst size (bytes).
2629 add port meter profile (trTCM rfc4115)
2630 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2632 Add meter profile (trTCM rfc4115) to the ethernet device::
2634 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2635 (cir) (eir) (cbs) (ebs)
2639 * ``profile_id``: ID for the meter profile.
2640 * ``cir``: Committed information rate (bytes/second).
2641 * ``eir``: Excess information rate (bytes/second).
2642 * ``cbs``: Committed burst size (bytes).
2643 * ``ebs``: Excess burst size (bytes).
2645 delete port meter profile
2646 ~~~~~~~~~~~~~~~~~~~~~~~~~
2648 Delete meter profile from the ethernet device::
2650 testpmd> del port meter profile (port_id) (profile_id)
2655 Create new meter object for the ethernet device::
2657 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2658 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2659 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2664 * ``mtr_id``: meter object ID.
2665 * ``profile_id``: ID for the meter profile.
2666 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2667 gets enabled at the time of creation, otherwise remains disabled.
2668 * ``g_action``: Policer action for the packet with green color.
2669 * ``y_action``: Policer action for the packet with yellow color.
2670 * ``r_action``: Policer action for the packet with red color.
2671 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2673 * ``shared``: When this parameter has a non-zero value, the meter object is
2674 shared by multiple flows. Otherwise, meter object is used by single flow.
2675 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2676 input color for the current meter object is determined by the latest meter
2677 object in the same flow. Otherwise, the current meter object uses the
2678 *dscp_table* to determine the input color.
2679 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2680 color, 0 <= x <= 63.
2685 Enable meter for the ethernet device::
2687 testpmd> enable port meter (port_id) (mtr_id)
2692 Disable meter for the ethernet device::
2694 testpmd> disable port meter (port_id) (mtr_id)
2699 Delete meter for the ethernet device::
2701 testpmd> del port meter (port_id) (mtr_id)
2703 Set port meter profile
2704 ~~~~~~~~~~~~~~~~~~~~~~
2706 Set meter profile for the ethernet device::
2708 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2710 set port meter dscp table
2711 ~~~~~~~~~~~~~~~~~~~~~~~~~
2713 Set meter dscp table for the ethernet device::
2715 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2716 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2718 set port meter policer action
2719 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2721 Set meter policer action for the ethernet device::
2723 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2724 (action0) [(action1) (action1)]
2728 * ``action_mask``: Bit mask indicating which policer actions need to be
2729 updated. One or more policer actions can be updated in a single function
2730 invocation. To update the policer action associated with color C, bit
2731 (1 << C) needs to be set in *action_mask* and element at position C
2732 in the *actions* array needs to be valid.
2733 * ``actionx``: Policer action for the color x,
2734 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2736 set port meter stats mask
2737 ~~~~~~~~~~~~~~~~~~~~~~~~~
2739 Set meter stats mask for the ethernet device::
2741 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2745 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2747 show port meter stats
2748 ~~~~~~~~~~~~~~~~~~~~~
2750 Show meter stats of the ethernet device::
2752 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2756 * ``clear``: Flag that indicates whether the statistics counters should
2757 be cleared (i.e. set to zero) immediately after they have been read or not.
2762 The following section shows functions for configuring traffic management on
2763 the ethernet device through the use of generic TM API.
2765 show port traffic management capability
2766 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2768 Show traffic management capability of the port::
2770 testpmd> show port tm cap (port_id)
2772 show port traffic management capability (hierarchy level)
2773 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2775 Show traffic management hierarchy level capability of the port::
2777 testpmd> show port tm level cap (port_id) (level_id)
2779 show port traffic management capability (hierarchy node level)
2780 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2782 Show the traffic management hierarchy node capability of the port::
2784 testpmd> show port tm node cap (port_id) (node_id)
2786 show port traffic management hierarchy node type
2787 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2789 Show the port traffic management hierarchy node type::
2791 testpmd> show port tm node type (port_id) (node_id)
2793 show port traffic management hierarchy node stats
2794 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2796 Show the port traffic management hierarchy node statistics::
2798 testpmd> show port tm node stats (port_id) (node_id) (clear)
2802 * ``clear``: When this parameter has a non-zero value, the statistics counters
2803 are cleared (i.e. set to zero) immediately after they have been read,
2804 otherwise the statistics counters are left untouched.
2806 Add port traffic management private shaper profile
2807 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2809 Add the port traffic management private shaper profile::
2811 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2812 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2813 (packet_length_adjust)
2817 * ``shaper_profile id``: Shaper profile ID for the new profile.
2818 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2819 * ``cmit_tb_size``: Committed token bucket size (bytes).
2820 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2821 * ``peak_tb_size``: Peak token bucket size (bytes).
2822 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2823 each packet for the purpose of shaping. This parameter value can be used to
2824 correct the packet length with the framing overhead bytes that are consumed
2827 Delete port traffic management private shaper profile
2828 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2830 Delete the port traffic management private shaper::
2832 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2836 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2838 Add port traffic management shared shaper
2839 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2841 Create the port traffic management shared shaper::
2843 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2848 * ``shared_shaper_id``: Shared shaper ID to be created.
2849 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2851 Set port traffic management shared shaper
2852 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2854 Update the port traffic management shared shaper::
2856 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2861 * ``shared_shaper_id``: Shared shaper ID to be update.
2862 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2864 Delete port traffic management shared shaper
2865 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2867 Delete the port traffic management shared shaper::
2869 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2873 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2875 Set port traffic management hierarchy node private shaper
2876 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2878 set the port traffic management hierarchy node private shaper::
2880 testpmd> set port tm node shaper profile (port_id) (node_id) \
2885 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2888 Add port traffic management WRED profile
2889 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2891 Create a new WRED profile::
2893 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2894 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2895 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2896 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2900 * ``wred_profile id``: Identifier for the newly create WRED profile
2901 * ``color_g``: Packet color (green)
2902 * ``min_th_g``: Minimum queue threshold for packet with green color
2903 * ``max_th_g``: Minimum queue threshold for packet with green color
2904 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2905 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2906 * ``color_y``: Packet color (yellow)
2907 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2908 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2909 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2910 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2911 * ``color_r``: Packet color (red)
2912 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2913 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2914 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2915 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2917 Delete port traffic management WRED profile
2918 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2920 Delete the WRED profile::
2922 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2924 Add port traffic management hierarchy nonleaf node
2925 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2927 Add nonleaf node to port traffic management hierarchy::
2929 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2930 (priority) (weight) (level_id) (shaper_profile_id) \
2931 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2932 [(shared_shaper_0) (shared_shaper_1) ...] \
2936 * ``parent_node_id``: Node ID of the parent.
2937 * ``priority``: Node priority (highest node priority is zero). This is used by
2938 the SP algorithm running on the parent node for scheduling this node.
2939 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2940 to the weight sum of all siblings that have the same priority. It is used by
2941 the WFQ algorithm running on the parent node for scheduling this node.
2942 * ``level_id``: Hierarchy level of the node.
2943 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2945 * ``n_sp_priorities``: Number of strict priorities.
2946 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2947 * ``n_shared_shapers``: Number of shared shapers.
2948 * ``shared_shaper_id``: Shared shaper id.
2950 Add port traffic management hierarchy leaf node
2951 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2953 Add leaf node to port traffic management hierarchy::
2955 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2956 (priority) (weight) (level_id) (shaper_profile_id) \
2957 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2958 [(shared_shaper_id) (shared_shaper_id) ...] \
2962 * ``parent_node_id``: Node ID of the parent.
2963 * ``priority``: Node priority (highest node priority is zero). This is used by
2964 the SP algorithm running on the parent node for scheduling this node.
2965 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2966 to the weight sum of all siblings that have the same priority. It is used by
2967 the WFQ algorithm running on the parent node for scheduling this node.
2968 * ``level_id``: Hierarchy level of the node.
2969 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2971 * ``cman_mode``: Congestion management mode to be enabled for this node.
2972 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2973 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2974 * ``n_shared_shapers``: Number of shared shapers.
2975 * ``shared_shaper_id``: Shared shaper id.
2977 Delete port traffic management hierarchy node
2978 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2980 Delete node from port traffic management hierarchy::
2982 testpmd> del port tm node (port_id) (node_id)
2984 Update port traffic management hierarchy parent node
2985 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2987 Update port traffic management hierarchy parent node::
2989 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
2992 This function can only be called after the hierarchy commit invocation. Its
2993 success depends on the port support for this operation, as advertised through
2994 the port capability set. This function is valid for all nodes of the traffic
2995 management hierarchy except root node.
2997 Suspend port traffic management hierarchy node
2998 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3000 testpmd> suspend port tm node (port_id) (node_id)
3002 Resume port traffic management hierarchy node
3003 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3005 testpmd> resume port tm node (port_id) (node_id)
3007 Commit port traffic management hierarchy
3008 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3010 Commit the traffic management hierarchy on the port::
3012 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3016 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3017 call failure. On the other hand, hierarchy is preserved when this parameter
3020 Set port traffic management mark VLAN dei
3021 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3023 Enables/Disables the traffic management marking on the port for VLAN packets::
3025 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3029 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3030 ``yellow`` or ``red`` will have dei bit enabled
3032 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3034 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3036 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3038 Set port traffic management mark IP dscp
3039 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3041 Enables/Disables the traffic management marking on the port for IP dscp packets::
3043 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3047 * ``port_id``: The port which on which IP packets marked as ``green`` or
3048 ``yellow`` or ``red`` will have IP dscp bits updated
3050 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3052 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3054 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3056 Set port traffic management mark IP ecn
3057 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3059 Enables/Disables the traffic management marking on the port for IP ecn packets::
3061 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3065 * ``port_id``: The port which on which IP packets marked as ``green`` or
3066 ``yellow`` or ``red`` will have IP ecn bits updated
3068 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3069 to ecn of 2'b11 when IP is caring TCP or SCTP
3071 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3072 to ecn of 2'b11 when IP is caring TCP or SCTP
3074 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3075 to ecn of 2'b11 when IP is caring TCP or SCTP
3077 Set port traffic management default hierarchy (softnic forwarding mode)
3078 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3080 set the traffic management default hierarchy on the port::
3082 testpmd> set port tm hierarchy default (port_id)
3087 This section details the available filter functions that are available.
3089 Note these functions interface the deprecated legacy filtering framework,
3090 superseded by *rte_flow*. See `Flow rules management`_.
3093 ~~~~~~~~~~~~~~~~~~~~
3095 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3097 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3098 ethertype (ether_type) (drop|fwd) queue (queue_id)
3100 The available information parameters are:
3102 * ``port_id``: The port which the Ethertype filter assigned on.
3104 * ``mac_addr``: Compare destination mac address.
3106 * ``mac_ignr``: Ignore destination mac address match.
3108 * ``mac_address``: Destination mac address to match.
3110 * ``ether_type``: The EtherType value want to match,
3111 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3113 * ``queue_id``: The receive queue associated with this EtherType filter.
3114 It is meaningless when deleting or dropping.
3116 Example, to add/remove an ethertype filter rule::
3118 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3119 ethertype 0x0806 fwd queue 3
3121 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3122 ethertype 0x0806 fwd queue 3
3127 Add or delete a 2-tuple filter,
3128 which identifies packets by specific protocol and destination TCP/UDP port
3129 and forwards packets into one of the receive queues::
3131 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3132 protocol (protocol_value) mask (mask_value) \
3133 tcp_flags (tcp_flags_value) priority (prio_value) \
3136 The available information parameters are:
3138 * ``port_id``: The port which the 2-tuple filter assigned on.
3140 * ``dst_port_value``: Destination port in L4.
3142 * ``protocol_value``: IP L4 protocol.
3144 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3146 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3148 * ``prio_value``: Priority of this filter.
3150 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3152 Example, to add/remove an 2tuple filter rule::
3154 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3155 tcp_flags 0x02 priority 3 queue 3
3157 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3158 tcp_flags 0x02 priority 3 queue 3
3163 Add or delete a 5-tuple filter,
3164 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3165 and routes packets into one of the receive queues::
3167 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3168 (src_address) dst_port (dst_port_value) \
3169 src_port (src_port_value) protocol (protocol_value) \
3170 mask (mask_value) tcp_flags (tcp_flags_value) \
3171 priority (prio_value) queue (queue_id)
3173 The available information parameters are:
3175 * ``port_id``: The port which the 5-tuple filter assigned on.
3177 * ``dst_address``: Destination IP address.
3179 * ``src_address``: Source IP address.
3181 * ``dst_port_value``: TCP/UDP destination port.
3183 * ``src_port_value``: TCP/UDP source port.
3185 * ``protocol_value``: L4 protocol.
3187 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3189 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3191 * ``prio_value``: The priority of this filter.
3193 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3195 Example, to add/remove an 5tuple filter rule::
3197 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3198 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3199 flags 0x0 priority 3 queue 3
3201 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3202 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3203 flags 0x0 priority 3 queue 3
3208 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3210 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3212 The available information parameters are:
3214 * ``port_id``: The port which the SYN filter assigned on.
3216 * ``high``: This SYN filter has higher priority than other filters.
3218 * ``low``: This SYN filter has lower priority than other filters.
3220 * ``queue_id``: The receive queue associated with this SYN filter
3224 testpmd> syn_filter 0 add priority high queue 3
3229 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3230 and routed into one of the receive queues::
3232 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3233 mask (mask_value) priority (prio_value) queue (queue_id)
3235 The available information parameters are:
3237 * ``port_id``: The port which the Flex filter is assigned on.
3239 * ``len_value``: Filter length in bytes, no greater than 128.
3241 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3243 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3245 * ``prio_value``: The priority of this filter.
3247 * ``queue_id``: The receive queue associated with this Flex filter.
3251 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3252 mask 000C priority 3 queue 3
3254 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3255 mask 000C priority 3 queue 3
3258 .. _testpmd_flow_director:
3260 flow_director_filter
3261 ~~~~~~~~~~~~~~~~~~~~
3263 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3265 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3266 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3268 * Perfect match filters.
3269 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3270 The masked fields are for IP flow.
3272 * Signature filters.
3273 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3275 * Perfect-mac-vlan match filters.
3276 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3277 The masked fields are for MAC VLAN flow.
3279 * Perfect-tunnel match filters.
3280 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3281 The masked fields are for tunnel flow.
3283 * Perfect-raw-flow-type match filters.
3284 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3285 The masked fields are specified by input sets.
3287 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3288 per flow type and the flexible payload.
3290 The Flow Director can also mask out parts of all of these fields so that filters
3291 are only applied to certain fields or parts of the fields.
3293 Note that for raw flow type mode the source and destination fields in the
3294 raw packet buffer need to be presented in a reversed order with respect
3295 to the expected received packets.
3296 For example: IP source and destination addresses or TCP/UDP/SCTP
3297 source and destination ports
3299 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3301 # Commands to add flow director filters of different flow types::
3303 flow_director_filter (port_id) mode IP (add|del|update) \
3304 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3305 src (src_ip_address) dst (dst_ip_address) \
3306 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3307 vlan (vlan_value) flexbytes (flexbytes_value) \
3308 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3311 flow_director_filter (port_id) mode IP (add|del|update) \
3312 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3313 src (src_ip_address) (src_port) \
3314 dst (dst_ip_address) (dst_port) \
3315 tos (tos_value) ttl (ttl_value) \
3316 vlan (vlan_value) flexbytes (flexbytes_value) \
3317 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3320 flow_director_filter (port_id) mode IP (add|del|update) \
3321 flow (ipv4-sctp|ipv6-sctp) \
3322 src (src_ip_address) (src_port) \
3323 dst (dst_ip_address) (dst_port) \
3324 tos (tos_value) ttl (ttl_value) \
3325 tag (verification_tag) vlan (vlan_value) \
3326 flexbytes (flexbytes_value) (drop|fwd) \
3327 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3329 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3330 ether (ethertype) flexbytes (flexbytes_value) \
3331 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3334 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3335 mac (mac_address) vlan (vlan_value) \
3336 flexbytes (flexbytes_value) (drop|fwd) \
3337 queue (queue_id) fd_id (fd_id_value)
3339 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3340 mac (mac_address) vlan (vlan_value) \
3341 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3342 flexbytes (flexbytes_value) (drop|fwd) \
3343 queue (queue_id) fd_id (fd_id_value)
3345 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3346 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3347 packet (packet file name)
3349 For example, to add an ipv4-udp flow type filter::
3351 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3352 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3353 fwd pf queue 1 fd_id 1
3355 For example, add an ipv4-other flow type filter::
3357 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3358 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3359 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3364 Flush all flow director filters on a device::
3366 testpmd> flush_flow_director (port_id)
3368 Example, to flush all flow director filter on port 0::
3370 testpmd> flush_flow_director 0
3375 Set flow director's input masks::
3377 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3378 src_mask (ipv4_src) (ipv6_src) (src_port) \
3379 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3381 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3383 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3384 mac (mac_value) tunnel-type (tunnel_type_value) \
3385 tunnel-id (tunnel_id_value)
3387 Example, to set flow director mask on port 0::
3389 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3390 src_mask 255.255.255.255 \
3391 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3392 dst_mask 255.255.255.255 \
3393 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3395 flow_director_flex_mask
3396 ~~~~~~~~~~~~~~~~~~~~~~~
3398 set masks of flow director's flexible payload based on certain flow type::
3400 testpmd> flow_director_flex_mask (port_id) \
3401 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3402 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3403 l2_payload|all) (mask)
3405 Example, to set flow director's flex mask for all flow type on port 0::
3407 testpmd> flow_director_flex_mask 0 flow all \
3408 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3411 flow_director_flex_payload
3412 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3414 Configure flexible payload selection::
3416 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3418 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3420 testpmd> flow_director_flex_payload 0 l4 \
3421 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3423 get_sym_hash_ena_per_port
3424 ~~~~~~~~~~~~~~~~~~~~~~~~~
3426 Get symmetric hash enable configuration per port::
3428 get_sym_hash_ena_per_port (port_id)
3430 For example, to get symmetric hash enable configuration of port 1::
3432 testpmd> get_sym_hash_ena_per_port 1
3434 set_sym_hash_ena_per_port
3435 ~~~~~~~~~~~~~~~~~~~~~~~~~
3437 Set symmetric hash enable configuration per port to enable or disable::
3439 set_sym_hash_ena_per_port (port_id) (enable|disable)
3441 For example, to set symmetric hash enable configuration of port 1 to enable::
3443 testpmd> set_sym_hash_ena_per_port 1 enable
3445 get_hash_global_config
3446 ~~~~~~~~~~~~~~~~~~~~~~
3448 Get the global configurations of hash filters::
3450 get_hash_global_config (port_id)
3452 For example, to get the global configurations of hash filters of port 1::
3454 testpmd> get_hash_global_config 1
3456 set_hash_global_config
3457 ~~~~~~~~~~~~~~~~~~~~~~
3459 Set the global configurations of hash filters::
3461 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3462 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3463 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3466 For example, to enable simple_xor for flow type of ipv6 on port 2::
3468 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3473 Set the input set for hash::
3475 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3476 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3477 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3478 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3479 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3480 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3481 fld-8th|none) (select|add)
3483 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3485 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3490 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3491 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3493 Set the input set for flow director::
3495 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3496 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3497 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3498 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3499 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3500 sctp-dst-port|sctp-veri-tag|none) (select|add)
3502 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3504 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3509 Set different GRE key length for input set::
3511 global_config (port_id) gre-key-len (number in bytes)
3513 For example to set GRE key length for input set to 4 bytes on port 0::
3515 testpmd> global_config 0 gre-key-len 4
3518 .. _testpmd_rte_flow:
3520 Flow rules management
3521 ---------------------
3523 Control of the generic flow API (*rte_flow*) is fully exposed through the
3524 ``flow`` command (validation, creation, destruction, queries and operation
3527 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3528 features simultaneously may cause undefined side-effects and is therefore
3534 Because the ``flow`` command uses dynamic tokens to handle the large number
3535 of possible flow rules combinations, its behavior differs slightly from
3536 other commands, in particular:
3538 - Pressing *?* or the *<tab>* key displays contextual help for the current
3539 token, not that of the entire command.
3541 - Optional and repeated parameters are supported (provided they are listed
3542 in the contextual help).
3544 The first parameter stands for the operation mode. Possible operations and
3545 their general syntax are described below. They are covered in detail in the
3548 - Check whether a flow rule can be created::
3550 flow validate {port_id}
3551 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3552 pattern {item} [/ {item} [...]] / end
3553 actions {action} [/ {action} [...]] / end
3555 - Create a flow rule::
3557 flow create {port_id}
3558 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3559 pattern {item} [/ {item} [...]] / end
3560 actions {action} [/ {action} [...]] / end
3562 - Destroy specific flow rules::
3564 flow destroy {port_id} rule {rule_id} [...]
3566 - Destroy all flow rules::
3568 flow flush {port_id}
3570 - Query an existing flow rule::
3572 flow query {port_id} {rule_id} {action}
3574 - List existing flow rules sorted by priority, filtered by group
3577 flow list {port_id} [group {group_id}] [...]
3579 - Restrict ingress traffic to the defined flow rules::
3581 flow isolate {port_id} {boolean}
3583 Validating flow rules
3584 ~~~~~~~~~~~~~~~~~~~~~
3586 ``flow validate`` reports whether a flow rule would be accepted by the
3587 underlying device in its current state but stops short of creating it. It is
3588 bound to ``rte_flow_validate()``::
3590 flow validate {port_id}
3591 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3592 pattern {item} [/ {item} [...]] / end
3593 actions {action} [/ {action} [...]] / end
3595 If successful, it will show::
3599 Otherwise it will show an error message of the form::
3601 Caught error type [...] ([...]): [...]
3603 This command uses the same parameters as ``flow create``, their format is
3604 described in `Creating flow rules`_.
3606 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3607 index 6 is supported::
3609 testpmd> flow validate 0 ingress pattern eth / end
3610 actions queue index 6 / end
3614 Port 0 does not support TCPv6 rules::
3616 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3618 Caught error type 9 (specific pattern item): Invalid argument
3624 ``flow create`` validates and creates the specified flow rule. It is bound
3625 to ``rte_flow_create()``::
3627 flow create {port_id}
3628 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3629 pattern {item} [/ {item} [...]] / end
3630 actions {action} [/ {action} [...]] / end
3632 If successful, it will return a flow rule ID usable with other commands::
3634 Flow rule #[...] created
3636 Otherwise it will show an error message of the form::
3638 Caught error type [...] ([...]): [...]
3640 Parameters describe in the following order:
3642 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3643 - A matching pattern, starting with the *pattern* token and terminated by an
3645 - Actions, starting with the *actions* token and terminated by an *end*
3648 These translate directly to *rte_flow* objects provided as-is to the
3649 underlying functions.
3651 The shortest valid definition only comprises mandatory tokens::
3653 testpmd> flow create 0 pattern end actions end
3655 Note that PMDs may refuse rules that essentially do nothing such as this
3658 **All unspecified object values are automatically initialized to 0.**
3663 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3664 specified before the ``pattern`` token.
3666 - ``group {group id}``: priority group.
3667 - ``priority {level}``: priority level within group.
3668 - ``ingress``: rule applies to ingress traffic.
3669 - ``egress``: rule applies to egress traffic.
3670 - ``transfer``: apply rule directly to endpoints found in pattern.
3672 Each instance of an attribute specified several times overrides the previous
3673 value as shown below (group 4 is used)::
3675 testpmd> flow create 0 group 42 group 24 group 4 [...]
3677 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3679 While not specifying a direction is an error, some rules may allow both
3682 Most rules affect RX therefore contain the ``ingress`` token::
3684 testpmd> flow create 0 ingress pattern [...]
3689 A matching pattern starts after the ``pattern`` token. It is made of pattern
3690 items and is terminated by a mandatory ``end`` item.
3692 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3693 rte_flow_item_type``).
3695 The ``/`` token is used as a separator between pattern items as shown
3698 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3700 Note that protocol items like these must be stacked from lowest to highest
3701 layer to make sense. For instance, the following rule is either invalid or
3702 unlikely to match any packet::
3704 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3706 More information on these restrictions can be found in the *rte_flow*
3709 Several items support additional specification structures, for example
3710 ``ipv4`` allows specifying source and destination addresses as follows::
3712 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3713 dst is 10.2.0.0 / end [...]
3715 This rule matches all IPv4 traffic with the specified properties.
3717 In this example, ``src`` and ``dst`` are field names of the underlying
3718 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3719 in a similar fashion.
3721 The ``is`` token means that the subsequent value must be matched exactly,
3722 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3723 accordingly. Possible assignment tokens are:
3725 - ``is``: match value perfectly (with full bit-mask).
3726 - ``spec``: match value according to configured bit-mask.
3727 - ``last``: specify upper bound to establish a range.
3728 - ``mask``: specify bit-mask with relevant bits set to one.
3729 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3731 These yield identical results::
3733 ipv4 src is 10.1.1.1
3737 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3741 ipv4 src spec 10.1.1.1 src prefix 32
3745 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3749 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3751 Inclusive ranges can be defined with ``last``::
3753 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3755 Note that ``mask`` affects both ``spec`` and ``last``::
3757 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3758 # matches 10.1.0.0 to 10.2.255.255
3760 Properties can be modified multiple times::
3762 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3766 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3771 This section lists supported pattern items and their attributes, if any.
3773 - ``end``: end list of pattern items.
3775 - ``void``: no-op pattern item.
3777 - ``invert``: perform actions when pattern does not match.
3779 - ``any``: match any protocol for the current layer.
3781 - ``num {unsigned}``: number of layers covered.
3783 - ``pf``: match traffic from/to the physical function.
3785 - ``vf``: match traffic from/to a virtual function ID.
3787 - ``id {unsigned}``: VF ID.
3789 - ``phy_port``: match traffic from/to a specific physical port.
3791 - ``index {unsigned}``: physical port index.
3793 - ``port_id``: match traffic from/to a given DPDK port ID.
3795 - ``id {unsigned}``: DPDK port ID.
3797 - ``mark``: match value set in previously matched flow rule using the mark action.
3799 - ``id {unsigned}``: arbitrary integer value.
3801 - ``raw``: match an arbitrary byte string.
3803 - ``relative {boolean}``: look for pattern after the previous item.
3804 - ``search {boolean}``: search pattern from offset (see also limit).
3805 - ``offset {integer}``: absolute or relative offset for pattern.
3806 - ``limit {unsigned}``: search area limit for start of pattern.
3807 - ``pattern {string}``: byte string to look for.
3809 - ``eth``: match Ethernet header.
3811 - ``dst {MAC-48}``: destination MAC.
3812 - ``src {MAC-48}``: source MAC.
3813 - ``type {unsigned}``: EtherType or TPID.
3815 - ``vlan``: match 802.1Q/ad VLAN tag.
3817 - ``tci {unsigned}``: tag control information.
3818 - ``pcp {unsigned}``: priority code point.
3819 - ``dei {unsigned}``: drop eligible indicator.
3820 - ``vid {unsigned}``: VLAN identifier.
3821 - ``inner_type {unsigned}``: inner EtherType or TPID.
3823 - ``ipv4``: match IPv4 header.
3825 - ``tos {unsigned}``: type of service.
3826 - ``ttl {unsigned}``: time to live.
3827 - ``proto {unsigned}``: next protocol ID.
3828 - ``src {ipv4 address}``: source address.
3829 - ``dst {ipv4 address}``: destination address.
3831 - ``ipv6``: match IPv6 header.
3833 - ``tc {unsigned}``: traffic class.
3834 - ``flow {unsigned}``: flow label.
3835 - ``proto {unsigned}``: protocol (next header).
3836 - ``hop {unsigned}``: hop limit.
3837 - ``src {ipv6 address}``: source address.
3838 - ``dst {ipv6 address}``: destination address.
3840 - ``icmp``: match ICMP header.
3842 - ``type {unsigned}``: ICMP packet type.
3843 - ``code {unsigned}``: ICMP packet code.
3845 - ``udp``: match UDP header.
3847 - ``src {unsigned}``: UDP source port.
3848 - ``dst {unsigned}``: UDP destination port.
3850 - ``tcp``: match TCP header.
3852 - ``src {unsigned}``: TCP source port.
3853 - ``dst {unsigned}``: TCP destination port.
3855 - ``sctp``: match SCTP header.
3857 - ``src {unsigned}``: SCTP source port.
3858 - ``dst {unsigned}``: SCTP destination port.
3859 - ``tag {unsigned}``: validation tag.
3860 - ``cksum {unsigned}``: checksum.
3862 - ``vxlan``: match VXLAN header.
3864 - ``vni {unsigned}``: VXLAN identifier.
3866 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3868 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3870 - ``nvgre``: match NVGRE header.
3872 - ``tni {unsigned}``: virtual subnet ID.
3874 - ``mpls``: match MPLS header.
3876 - ``label {unsigned}``: MPLS label.
3878 - ``gre``: match GRE header.
3880 - ``protocol {unsigned}``: protocol type.
3882 - ``gre_key``: match GRE optional key field.
3884 - ``value {unsigned}``: key value.
3886 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3888 - ``thresh {unsigned}``: accuracy threshold.
3890 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3892 - ``teid {unsigned}``: tunnel endpoint identifier.
3894 - ``geneve``: match GENEVE header.
3896 - ``vni {unsigned}``: virtual network identifier.
3897 - ``protocol {unsigned}``: protocol type.
3899 - ``vxlan-gpe``: match VXLAN-GPE header.
3901 - ``vni {unsigned}``: VXLAN-GPE identifier.
3903 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3905 - ``sha {MAC-48}``: sender hardware address.
3906 - ``spa {ipv4 address}``: sender IPv4 address.
3907 - ``tha {MAC-48}``: target hardware address.
3908 - ``tpa {ipv4 address}``: target IPv4 address.
3910 - ``ipv6_ext``: match presence of any IPv6 extension header.
3912 - ``next_hdr {unsigned}``: next header.
3914 - ``icmp6``: match any ICMPv6 header.
3916 - ``type {unsigned}``: ICMPv6 type.
3917 - ``code {unsigned}``: ICMPv6 code.
3919 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3921 - ``target_addr {ipv6 address}``: target address.
3923 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3925 - ``target_addr {ipv6 address}``: target address.
3927 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3929 - ``type {unsigned}``: ND option type.
3931 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3932 link-layer address option.
3934 - ``sla {MAC-48}``: source Ethernet LLA.
3936 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3937 link-layer address option.
3939 - ``tla {MAC-48}``: target Ethernet LLA.
3941 - ``meta``: match application specific metadata.
3943 - ``data {unsigned}``: metadata value.
3945 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3947 - ``pdu_type {unsigned}``: PDU type.
3948 - ``qfi {unsigned}``: QoS flow identifier.
3950 - ``pppoes``, ``pppoed``: match PPPoE header.
3952 - ``session_id {unsigned}``: session identifier.
3954 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3956 - ``proto_id {unsigned}``: PPP protocol identifier.
3961 A list of actions starts after the ``actions`` token in the same fashion as
3962 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3963 terminated by a mandatory ``end`` action.
3965 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3966 rte_flow_action_type``).
3968 Dropping all incoming UDPv4 packets can be expressed as follows::
3970 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3973 Several actions have configurable properties which must be specified when
3974 there is no valid default value. For example, ``queue`` requires a target
3977 This rule redirects incoming UDPv4 traffic to queue index 6::
3979 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3980 actions queue index 6 / end
3982 While this one could be rejected by PMDs (unspecified queue index)::
3984 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3987 As defined by *rte_flow*, the list is not ordered, all actions of a given
3988 rule are performed simultaneously. These are equivalent::
3990 queue index 6 / void / mark id 42 / end
3994 void / mark id 42 / queue index 6 / end
3996 All actions in a list should have different types, otherwise only the last
3997 action of a given type is taken into account::
3999 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4003 drop / drop / drop / end # drop is performed only once
4007 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4009 Considering they are performed simultaneously, opposite and overlapping
4010 actions can sometimes be combined when the end result is unambiguous::
4012 drop / queue index 6 / end # drop has no effect
4016 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4020 drop / passthru / end # drop has no effect
4022 Note that PMDs may still refuse such combinations.
4027 This section lists supported actions and their attributes, if any.
4029 - ``end``: end list of actions.
4031 - ``void``: no-op action.
4033 - ``passthru``: let subsequent rule process matched packets.
4035 - ``jump``: redirect traffic to group on device.
4037 - ``group {unsigned}``: group to redirect to.
4039 - ``mark``: attach 32 bit value to packets.
4041 - ``id {unsigned}``: 32 bit value to return with packets.
4043 - ``flag``: flag packets.
4045 - ``queue``: assign packets to a given queue index.
4047 - ``index {unsigned}``: queue index to use.
4049 - ``drop``: drop packets (note: passthru has priority).
4051 - ``count``: enable counters for this rule.
4053 - ``rss``: spread packets among several queues.
4055 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4056 the same as `set_hash_global_config`_.
4058 - ``level {unsigned}``: encapsulation level for ``types``.
4060 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4061 tokens are the same as `set_hash_input_set`_, except that an empty list
4062 does not disable RSS but instead requests unspecified "best-effort"
4065 - ``key {string}``: RSS hash key, overrides ``key_len``.
4067 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4068 conjunction with ``key`` to pad or truncate it.
4070 - ``queues [{unsigned} [...]] end``: queue indices to use.
4072 - ``pf``: direct traffic to physical function.
4074 - ``vf``: direct traffic to a virtual function ID.
4076 - ``original {boolean}``: use original VF ID if possible.
4077 - ``id {unsigned}``: VF ID.
4079 - ``phy_port``: direct packets to physical port index.
4081 - ``original {boolean}``: use original port index if possible.
4082 - ``index {unsigned}``: physical port index.
4084 - ``port_id``: direct matching traffic to a given DPDK port ID.
4086 - ``original {boolean}``: use original DPDK port ID if possible.
4087 - ``id {unsigned}``: DPDK port ID.
4089 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4091 - ``mpls_ttl``: MPLS TTL.
4093 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4095 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4097 - ``nw_ttl``: IP TTL.
4099 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4101 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4103 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4105 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4107 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4109 - ``ethertype``: Ethertype.
4111 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4113 - ``vlan_vid``: VLAN id.
4115 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4117 - ``vlan_pcp``: VLAN priority.
4119 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4121 - ``ethertype``: Ethertype.
4123 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4125 - ``ethertype``: Ethertype.
4127 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4128 is done through `Config VXLAN Encap outer layers`_.
4130 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4131 the VXLAN tunnel network overlay from the matched flow.
4133 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4134 is done through `Config NVGRE Encap outer layers`_.
4136 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4137 the NVGRE tunnel network overlay from the matched flow.
4139 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4140 is done through `Config L2 Encap`_.
4142 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4143 is done through `Config L2 Decap`_.
4145 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4146 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4148 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4149 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4151 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4152 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4154 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4155 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4157 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4159 - ``ipv4_addr``: New IPv4 source address.
4161 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4164 - ``ipv4_addr``: New IPv4 destination address.
4166 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4168 - ``ipv6_addr``: New IPv6 source address.
4170 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4173 - ``ipv6_addr``: New IPv6 destination address.
4175 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4178 - ``port``: New TCP/UDP source port number.
4180 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4183 - ``port``: New TCP/UDP destination port number.
4185 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4188 - ``dec_ttl``: Performs a decrease TTL value action
4190 - ``set_ttl``: Set TTL value with specified value
4191 - ``ttl_value {unsigned}``: The new TTL value to be set
4193 - ``set_mac_src``: set source MAC address
4195 - ``mac_addr {MAC-48}``: new source MAC address
4197 - ``set_mac_dst``: set destination MAC address
4199 - ``mac_addr {MAC-48}``: new destination MAC address
4201 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4203 - ``value {unsigned}``: Value to increase TCP sequence number by.
4205 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4207 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4209 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4211 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4213 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4215 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4217 Destroying flow rules
4218 ~~~~~~~~~~~~~~~~~~~~~
4220 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4221 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4222 times as necessary::
4224 flow destroy {port_id} rule {rule_id} [...]
4226 If successful, it will show::
4228 Flow rule #[...] destroyed
4230 It does not report anything for rule IDs that do not exist. The usual error
4231 message is shown when a rule cannot be destroyed::
4233 Caught error type [...] ([...]): [...]
4235 ``flow flush`` destroys all rules on a device and does not take extra
4236 arguments. It is bound to ``rte_flow_flush()``::
4238 flow flush {port_id}
4240 Any errors are reported as above.
4242 Creating several rules and destroying them::
4244 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4245 actions queue index 2 / end
4246 Flow rule #0 created
4247 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4248 actions queue index 3 / end
4249 Flow rule #1 created
4250 testpmd> flow destroy 0 rule 0 rule 1
4251 Flow rule #1 destroyed
4252 Flow rule #0 destroyed
4255 The same result can be achieved using ``flow flush``::
4257 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4258 actions queue index 2 / end
4259 Flow rule #0 created
4260 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4261 actions queue index 3 / end
4262 Flow rule #1 created
4263 testpmd> flow flush 0
4266 Non-existent rule IDs are ignored::
4268 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4269 actions queue index 2 / end
4270 Flow rule #0 created
4271 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4272 actions queue index 3 / end
4273 Flow rule #1 created
4274 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4276 testpmd> flow destroy 0 rule 0
4277 Flow rule #0 destroyed
4283 ``flow query`` queries a specific action of a flow rule having that
4284 ability. Such actions collect information that can be reported using this
4285 command. It is bound to ``rte_flow_query()``::
4287 flow query {port_id} {rule_id} {action}
4289 If successful, it will display either the retrieved data for known actions
4290 or the following message::
4292 Cannot display result for action type [...] ([...])
4294 Otherwise, it will complain either that the rule does not exist or that some
4297 Flow rule #[...] not found
4301 Caught error type [...] ([...]): [...]
4303 Currently only the ``count`` action is supported. This action reports the
4304 number of packets that hit the flow rule and the total number of bytes. Its
4305 output has the following format::
4308 hits_set: [...] # whether "hits" contains a valid value
4309 bytes_set: [...] # whether "bytes" contains a valid value
4310 hits: [...] # number of packets
4311 bytes: [...] # number of bytes
4313 Querying counters for TCPv6 packets redirected to queue 6::
4315 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4316 actions queue index 6 / count / end
4317 Flow rule #4 created
4318 testpmd> flow query 0 4 count
4329 ``flow list`` lists existing flow rules sorted by priority and optionally
4330 filtered by group identifiers::
4332 flow list {port_id} [group {group_id}] [...]
4334 This command only fails with the following message if the device does not
4339 Output consists of a header line followed by a short description of each
4340 flow rule, one per line. There is no output at all when no flow rules are
4341 configured on the device::
4343 ID Group Prio Attr Rule
4344 [...] [...] [...] [...] [...]
4346 ``Attr`` column flags:
4348 - ``i`` for ``ingress``.
4349 - ``e`` for ``egress``.
4351 Creating several flow rules and listing them::
4353 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4354 actions queue index 6 / end
4355 Flow rule #0 created
4356 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4357 actions queue index 2 / end
4358 Flow rule #1 created
4359 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4360 actions rss queues 6 7 8 end / end
4361 Flow rule #2 created
4362 testpmd> flow list 0
4363 ID Group Prio Attr Rule
4364 0 0 0 i- ETH IPV4 => QUEUE
4365 1 0 0 i- ETH IPV6 => QUEUE
4366 2 0 5 i- ETH IPV4 UDP => RSS
4369 Rules are sorted by priority (i.e. group ID first, then priority level)::
4371 testpmd> flow list 1
4372 ID Group Prio Attr Rule
4373 0 0 0 i- ETH => COUNT
4374 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4375 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4376 1 24 0 i- ETH IPV4 UDP => QUEUE
4377 4 24 10 i- ETH IPV4 TCP => DROP
4378 3 24 20 i- ETH IPV4 => DROP
4379 2 24 42 i- ETH IPV4 UDP => QUEUE
4380 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4383 Output can be limited to specific groups::
4385 testpmd> flow list 1 group 0 group 63
4386 ID Group Prio Attr Rule
4387 0 0 0 i- ETH => COUNT
4388 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4389 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4390 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4393 Toggling isolated mode
4394 ~~~~~~~~~~~~~~~~~~~~~~
4396 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4397 must only be injected from the defined flow rules; that no default traffic
4398 is expected outside those rules and the driver is free to assign more
4399 resources to handle them. It is bound to ``rte_flow_isolate()``::
4401 flow isolate {port_id} {boolean}
4403 If successful, enabling or disabling isolated mode shows either::
4405 Ingress traffic on port [...]
4406 is now restricted to the defined flow rules
4410 Ingress traffic on port [...]
4411 is not restricted anymore to the defined flow rules
4413 Otherwise, in case of error::
4415 Caught error type [...] ([...]): [...]
4417 Mainly due to its side effects, PMDs supporting this mode may not have the
4418 ability to toggle it more than once without reinitializing affected ports
4419 first (e.g. by exiting testpmd).
4421 Enabling isolated mode::
4423 testpmd> flow isolate 0 true
4424 Ingress traffic on port 0 is now restricted to the defined flow rules
4427 Disabling isolated mode::
4429 testpmd> flow isolate 0 false
4430 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4433 Sample QinQ flow rules
4434 ~~~~~~~~~~~~~~~~~~~~~~
4436 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4438 testpmd> port stop 0
4439 testpmd> vlan set qinq_strip on 0
4441 The above command sets the inner and outer TPID's to 0x8100.
4443 To change the TPID's the following commands should be used::
4445 testpmd> vlan set outer tpid 0xa100 0
4446 testpmd> vlan set inner tpid 0x9100 0
4447 testpmd> port start 0
4449 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4453 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4454 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4455 Flow rule #0 validated
4457 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4458 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4459 Flow rule #0 created
4461 testpmd> flow list 0
4462 ID Group Prio Attr Rule
4463 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4465 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4469 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4470 vlan tci is 654 / end actions pf / queue index 0 / end
4471 Flow rule #1 validated
4473 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4474 vlan tci is 654 / end actions pf / queue index 1 / end
4475 Flow rule #1 created
4477 testpmd> flow list 0
4478 ID Group Prio Attr Rule
4479 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4480 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4482 Sample VXLAN encapsulation rule
4483 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4485 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4486 source code, those can be changed by using the following commands
4488 IPv4 VXLAN outer header::
4490 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4491 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4492 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4495 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4496 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4497 eth-dst 22:22:22:22:22:22
4498 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4501 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4502 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4503 eth-dst 22:22:22:22:22:22
4504 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4507 IPv6 VXLAN outer header::
4509 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4510 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4511 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4514 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4515 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4516 eth-dst 22:22:22:22:22:22
4517 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4520 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4521 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4522 eth-dst 22:22:22:22:22:22
4523 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4526 Sample NVGRE encapsulation rule
4527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4529 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4530 source code, those can be changed by using the following commands
4532 IPv4 NVGRE outer header::
4534 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4535 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4536 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4539 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4540 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4541 eth-dst 22:22:22:22:22:22
4542 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4545 IPv6 NVGRE outer header::
4547 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4548 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4549 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4552 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4553 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4554 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4557 Sample L2 encapsulation rule
4558 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4560 L2 encapsulation has default value pre-configured in testpmd
4561 source code, those can be changed by using the following commands
4565 testpmd> set l2_encap ip-version ipv4
4566 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4567 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4568 mplsoudp_decap / l2_encap / end
4570 L2 with VXLAN header::
4572 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4573 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4574 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4575 mplsoudp_decap / l2_encap / end
4577 Sample L2 decapsulation rule
4578 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4580 L2 decapsulation has default value pre-configured in testpmd
4581 source code, those can be changed by using the following commands
4585 testpmd> set l2_decap
4586 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4589 L2 with VXLAN header::
4591 testpmd> set l2_encap-with-vlan
4592 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4595 Sample MPLSoGRE encapsulation rule
4596 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4598 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4599 source code, those can be changed by using the following commands
4601 IPv4 MPLSoGRE outer header::
4603 testpmd> set mplsogre_encap ip-version ipv4 label 4
4604 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4605 eth-dst 22:22:22:22:22:22
4606 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4607 mplsogre_encap / end
4609 IPv4 MPLSoGRE with VLAN outer header::
4611 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4612 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4613 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4614 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4615 mplsogre_encap / end
4617 IPv6 MPLSoGRE outer header::
4619 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4620 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4621 eth-dst 22:22:22:22:22:22
4622 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4623 mplsogre_encap / end
4625 IPv6 MPLSoGRE with VLAN outer header::
4627 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4628 ip-src ::1 ip-dst ::2222 vlan-tci 34
4629 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4630 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4631 mplsogre_encap / end
4633 Sample MPLSoGRE decapsulation rule
4634 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4636 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4637 source code, those can be changed by using the following commands
4639 IPv4 MPLSoGRE outer header::
4641 testpmd> set mplsogre_decap ip-version ipv4
4642 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4643 mplsogre_decap / l2_encap / end
4645 IPv4 MPLSoGRE with VLAN outer header::
4647 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4648 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4649 actions mplsogre_decap / l2_encap / end
4651 IPv6 MPLSoGRE outer header::
4653 testpmd> set mplsogre_decap ip-version ipv6
4654 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4655 actions mplsogre_decap / l2_encap / end
4657 IPv6 MPLSoGRE with VLAN outer header::
4659 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4660 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4661 actions mplsogre_decap / l2_encap / end
4663 Sample MPLSoUDP encapsulation rule
4664 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4666 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4667 source code, those can be changed by using the following commands
4669 IPv4 MPLSoUDP outer header::
4671 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4672 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4673 eth-dst 22:22:22:22:22:22
4674 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4675 mplsoudp_encap / end
4677 IPv4 MPLSoUDP with VLAN outer header::
4679 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4680 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4681 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4682 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4683 mplsoudp_encap / end
4685 IPv6 MPLSoUDP outer header::
4687 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4688 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4689 eth-dst 22:22:22:22:22:22
4690 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4691 mplsoudp_encap / end
4693 IPv6 MPLSoUDP with VLAN outer header::
4695 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4696 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4697 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4698 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4699 mplsoudp_encap / end
4701 Sample MPLSoUDP decapsulation rule
4702 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4704 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4705 source code, those can be changed by using the following commands
4707 IPv4 MPLSoUDP outer header::
4709 testpmd> set mplsoudp_decap ip-version ipv4
4710 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4711 mplsoudp_decap / l2_encap / end
4713 IPv4 MPLSoUDP with VLAN outer header::
4715 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4716 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4717 actions mplsoudp_decap / l2_encap / end
4719 IPv6 MPLSoUDP outer header::
4721 testpmd> set mplsoudp_decap ip-version ipv6
4722 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4723 actions mplsoudp_decap / l2_encap / end
4725 IPv6 MPLSoUDP with VLAN outer header::
4727 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4728 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4729 actions mplsoudp_decap / l2_encap / end
4731 Sample Raw encapsulation rule
4732 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4734 Raw encapsulation configuration can be set by the following commands
4736 Eecapsulating VxLAN::
4738 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4739 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4741 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4742 raw_encap index 4 / end
4744 Sample Raw decapsulation rule
4745 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4747 Raw decapsulation configuration can be set by the following commands
4749 Decapsulating VxLAN::
4751 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4752 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4753 end actions raw_decap / queue index 0 / end
4758 The following sections show functions to load/unload eBPF based filters.
4763 Load an eBPF program as a callback for particular RX/TX queue::
4765 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4767 The available load-flags are:
4769 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4771 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4777 You'll need clang v3.7 or above to build bpf program you'd like to load
4781 .. code-block:: console
4784 clang -O2 -target bpf -c t1.c
4786 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4788 .. code-block:: console
4790 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4792 To load (not JITed) t1.o at TX queue 0, port 0:
4794 .. code-block:: console
4796 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4801 Unload previously loaded eBPF program for particular RX/TX queue::
4803 testpmd> bpf-unload rx|tx (portid) (queueid)
4805 For example to unload BPF filter from TX queue 0, port 0:
4807 .. code-block:: console
4809 testpmd> bpf-unload tx 0 0