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 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)
258 Displays the configuration of the application.
259 The configuration comes from the command-line, the runtime or the application defaults::
261 testpmd> show config (rxtx|cores|fwd|txpkts)
263 The available information categories are:
265 * ``rxtx``: RX/TX configuration items.
267 * ``cores``: List of forwarding cores.
269 * ``fwd``: Packet forwarding configuration.
271 * ``txpkts``: Packets to TX configuration.
275 .. code-block:: console
277 testpmd> show config rxtx
279 io packet forwarding - CRC stripping disabled - packets/burst=16
280 nb forwarding cores=2 - nb forwarding ports=1
281 RX queues=1 - RX desc=128 - RX free threshold=0
282 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
283 TX queues=1 - TX desc=512 - TX free threshold=0
284 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
285 TX RS bit threshold=0 - TXQ flags=0x0
290 Set the packet forwarding mode::
292 testpmd> set fwd (io|mac|macswap|flowgen| \
293 rxonly|txonly|csum|icmpecho|noisy) (""|retry)
295 ``retry`` can be specified for forwarding engines except ``rx_only``.
297 The available information categories are:
299 * ``io``: Forwards packets "as-is" in I/O mode.
300 This is the fastest possible forwarding operation as it does not access packets data.
301 This is the default mode.
303 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
304 Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination
305 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
306 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
308 * ``macswap``: MAC swap forwarding mode.
309 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
311 * ``flowgen``: Multi-flow generation mode.
312 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
314 * ``rxonly``: Receives packets but doesn't transmit them.
316 * ``txonly``: Generates and transmits packets without receiving any.
318 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
320 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
322 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
324 * ``softnic``: Demonstrates the softnic forwarding operation. In this mode, packet forwarding is
325 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``.
327 * ``noisy``: Noisy neighbor simulation.
328 Simulate more realistic behavior of a guest machine engaged in receiving
329 and sending packets performing Virtual Network Function (VNF).
333 testpmd> set fwd rxonly
335 Set rxonly packet forwarding mode
341 When running, forwarding engines maintain statistics from the time they have been started.
342 Example for the io forwarding engine, with some packet drops on the tx side::
344 testpmd> show fwd stats all
346 ------- Forward Stats for RX Port= 0/Queue= 0 -> TX Port= 1/Queue= 0 -------
347 RX-packets: 274293770 TX-packets: 274293642 TX-dropped: 128
349 ------- Forward Stats for RX Port= 1/Queue= 0 -> TX Port= 0/Queue= 0 -------
350 RX-packets: 274301850 TX-packets: 274301850 TX-dropped: 0
352 ---------------------- Forward statistics for port 0 ----------------------
353 RX-packets: 274293802 RX-dropped: 0 RX-total: 274293802
354 TX-packets: 274301862 TX-dropped: 0 TX-total: 274301862
355 ----------------------------------------------------------------------------
357 ---------------------- Forward statistics for port 1 ----------------------
358 RX-packets: 274301894 RX-dropped: 0 RX-total: 274301894
359 TX-packets: 274293706 TX-dropped: 128 TX-total: 274293834
360 ----------------------------------------------------------------------------
362 +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
363 RX-packets: 548595696 RX-dropped: 0 RX-total: 548595696
364 TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
365 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
370 Clear the forwarding engines statistics::
372 testpmd> clear fwd stats all
377 Display an RX descriptor for a port RX queue::
379 testpmd> read rxd (port_id) (queue_id) (rxd_id)
383 testpmd> read rxd 0 0 4
384 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
389 Display a TX descriptor for a port TX queue::
391 testpmd> read txd (port_id) (queue_id) (txd_id)
395 testpmd> read txd 0 0 4
396 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
401 Get loaded dynamic device personalization (DDP) package info list::
403 testpmd> ddp get list (port_id)
408 Display information about dynamic device personalization (DDP) profile::
410 testpmd> ddp get info (profile_path)
415 Display VF statistics::
417 testpmd> show vf stats (port_id) (vf_id)
422 Reset VF statistics::
424 testpmd> clear vf stats (port_id) (vf_id)
426 show port pctype mapping
427 ~~~~~~~~~~~~~~~~~~~~~~~~
429 List all items from the pctype mapping table::
431 testpmd> show port (port_id) pctype mapping
433 show rx offloading capabilities
434 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
436 List all per queue and per port Rx offloading capabilities of a port::
438 testpmd> show port (port_id) rx_offload capabilities
440 show rx offloading configuration
441 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
443 List port level and all queue level Rx offloading configuration::
445 testpmd> show port (port_id) rx_offload configuration
447 show tx offloading capabilities
448 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
450 List all per queue and per port Tx offloading capabilities of a port::
452 testpmd> show port (port_id) tx_offload capabilities
454 show tx offloading configuration
455 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
457 List port level and all queue level Tx offloading configuration::
459 testpmd> show port (port_id) tx_offload configuration
461 show tx metadata setting
462 ~~~~~~~~~~~~~~~~~~~~~~~~
464 Show Tx metadata value set for a specific port::
466 testpmd> show port (port_id) tx_metadata
468 show port supported ptypes
469 ~~~~~~~~~~~~~~~~~~~~~~~~~~
471 Show ptypes supported for a specific port::
473 testpmd> show port (port_id) ptypes
478 Show general information about devices probed::
480 testpmd> show device info (<identifier>|all)
484 .. code-block:: console
486 testpmd> show device info net_pcap0
488 ********************* Infos for device net_pcap0 *********************
490 Driver name: net_pcap
491 Devargs: iface=enP2p6s0,phy_mac=1
492 Connect to socket: -1
495 MAC address: 1E:37:93:28:04:B8
496 Device name: net_pcap0
501 Dumps all physical memory segment layouts::
503 testpmd> dump_physmem
508 Dumps the layout of all memory zones::
510 testpmd> dump_memzone
516 Dumps the size of all memory structures::
518 testpmd> dump_struct_sizes
523 Dumps the status of all or specific element in DPDK rings::
525 testpmd> dump_ring [ring_name]
530 Dumps the statistics of all or specific memory pool::
532 testpmd> dump_mempool [mempool_name]
537 Dumps the user device list::
539 testpmd> dump_devargs
544 Dumps the log level for all the dpdk modules::
546 testpmd> dump_log_types
548 show (raw_encap|raw_decap)
549 ~~~~~~~~~~~~~~~~~~~~~~~~~~
551 Display content of raw_encap/raw_decap buffers in hex::
553 testpmd> show <raw_encap|raw_decap> <index>
554 testpmd> show <raw_encap|raw_decap> all
558 testpmd> show raw_encap 6
560 index: 6 at [0x1c565b0], len=50
561 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
562 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
563 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
567 Configuration Functions
568 -----------------------
570 The testpmd application can be configured from the runtime as well as from the command-line.
572 This section details the available configuration functions that are available.
576 Configuration changes only become active when forwarding is started/restarted.
581 Reset forwarding to the default configuration::
588 Set the debug verbosity level::
590 testpmd> set verbose (level)
592 Available levels are as following:
594 * ``0`` silent except for error.
595 * ``1`` fully verbose except for Tx packets.
596 * ``2`` fully verbose except for Rx packets.
597 * ``> 2`` fully verbose.
602 Set the log level for a log type::
604 testpmd> set log global|(type) (level)
608 * ``type`` is the log name.
610 * ``level`` is the log level.
612 For example, to change the global log level::
614 testpmd> set log global (level)
616 Regexes can also be used for type. To change log level of user1, user2 and user3::
618 testpmd> set log user[1-3] (level)
623 Set the number of ports used by the application:
627 This is equivalent to the ``--nb-ports`` command-line option.
632 Set the number of cores used by the application::
634 testpmd> set nbcore (num)
636 This is equivalent to the ``--nb-cores`` command-line option.
640 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
645 Set the forwarding cores hexadecimal mask::
647 testpmd> set coremask (mask)
649 This is equivalent to the ``--coremask`` command-line option.
653 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
658 Set the forwarding ports hexadecimal mask::
660 testpmd> set portmask (mask)
662 This is equivalent to the ``--portmask`` command-line option.
667 Set number of packets per burst::
669 testpmd> set burst (num)
671 This is equivalent to the ``--burst command-line`` option.
673 When retry is enabled, the transmit delay time and number of retries can also be set::
675 testpmd> set burst tx delay (microseconds) retry (num)
680 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
682 testpmd> set txpkts (x[,y]*)
684 Where x[,y]* represents a CSV list of values, without white space.
689 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
691 testpmd> set txsplit (off|on|rand)
695 * ``off`` disable packet copy & split for CSUM mode.
697 * ``on`` split outgoing packet into multiple segments. Size of each segment
698 and number of segments per packet is determined by ``set txpkts`` command
701 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
706 Set the list of forwarding cores::
708 testpmd> set corelist (x[,y]*)
710 For example, to change the forwarding cores:
712 .. code-block:: console
714 testpmd> set corelist 3,1
715 testpmd> show config fwd
717 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
718 Logical Core 3 (socket 0) forwards packets on 1 streams:
719 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
720 Logical Core 1 (socket 0) forwards packets on 1 streams:
721 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
725 The cores are used in the same order as specified on the command line.
730 Set the list of forwarding ports::
732 testpmd> set portlist (x[,y]*)
734 For example, to change the port forwarding:
736 .. code-block:: console
738 testpmd> set portlist 0,2,1,3
739 testpmd> show config fwd
741 io packet forwarding - ports=4 - cores=1 - streams=4
742 Logical Core 3 (socket 0) forwards packets on 4 streams:
743 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
744 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
745 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
746 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
751 Select how to retrieve new ports created after "port attach" command::
753 testpmd> set port setup on (iterator|event)
755 For each new port, a setup is done.
756 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
757 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
762 Enable/disable tx loopback::
764 testpmd> set tx loopback (port_id) (on|off)
769 set drop enable bit for all queues::
771 testpmd> set all queues drop (port_id) (on|off)
773 set split drop enable (for VF)
774 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
776 set split drop enable bit for VF from PF::
778 testpmd> set vf split drop (port_id) (vf_id) (on|off)
780 set mac antispoof (for VF)
781 ~~~~~~~~~~~~~~~~~~~~~~~~~~
783 Set mac antispoof for a VF from the PF::
785 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
790 Enable/disable MACsec offload::
792 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
793 testpmd> set macsec offload (port_id) off
798 Configure MACsec secure connection (SC)::
800 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
804 The pi argument is ignored for tx.
805 Check the NIC Datasheet for hardware limits.
810 Configure MACsec secure association (SA)::
812 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
816 The IDX value must be 0 or 1.
817 Check the NIC Datasheet for hardware limits.
819 set broadcast mode (for VF)
820 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
822 Set broadcast mode for a VF from the PF::
824 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
829 Set the VLAN strip for a queue on a port::
831 testpmd> vlan set stripq (on|off) (port_id,queue_id)
833 vlan set stripq (for VF)
834 ~~~~~~~~~~~~~~~~~~~~~~~~
836 Set VLAN strip for all queues in a pool for a VF from the PF::
838 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
840 vlan set insert (for VF)
841 ~~~~~~~~~~~~~~~~~~~~~~~~
843 Set VLAN insert for a VF from the PF::
845 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
847 vlan set tag (for VF)
848 ~~~~~~~~~~~~~~~~~~~~~
850 Set VLAN tag for a VF from the PF::
852 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
854 vlan set antispoof (for VF)
855 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
857 Set VLAN antispoof for a VF from the PF::
859 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
861 vlan set (strip|filter|qinq_strip|extend)
862 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
863 Set the VLAN strip/filter/QinQ strip/extend on for a port::
865 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
870 Set the inner or outer VLAN TPID for packet filtering on a port::
872 testpmd> vlan set (inner|outer) tpid (value) (port_id)
876 TPID value must be a 16-bit number (value <= 65536).
881 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
883 testpmd> rx_vlan add (vlan_id|all) (port_id)
887 VLAN filter must be set on that port. VLAN ID < 4096.
888 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
889 in VFTA table. This is important if enabling all vlan_ids.
894 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
896 testpmd> rx_vlan rm (vlan_id|all) (port_id)
901 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
903 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
908 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
910 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
915 Add a tunnel filter on a port::
917 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
918 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
919 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
921 The available information categories are:
923 * ``vxlan``: Set tunnel type as VXLAN.
925 * ``nvgre``: Set tunnel type as NVGRE.
927 * ``ipingre``: Set tunnel type as IP-in-GRE.
929 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
931 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
933 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
935 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
937 * ``imac``: Set filter type as Inner MAC.
939 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
941 * ``oip``: Set filter type as Outer IP.
943 * ``iip``: Set filter type as Inner IP.
947 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
948 192.168.2.2 0 ipingre oip 1 1
950 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
955 Remove a tunnel filter on a port::
957 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
958 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
959 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
964 Add an UDP port for VXLAN packet filter on a port::
966 testpmd> rx_vxlan_port add (udp_port) (port_id)
971 Remove an UDP port for VXLAN packet filter on a port::
973 testpmd> rx_vxlan_port rm (udp_port) (port_id)
978 Set hardware insertion of VLAN IDs in packets sent on a port::
980 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
982 For example, set a single VLAN ID (5) insertion on port 0::
986 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
994 Set port based hardware insertion of VLAN ID in packets sent on a port::
996 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1001 Disable hardware insertion of a VLAN header in packets sent on a port::
1003 testpmd> tx_vlan reset (port_id)
1008 Select hardware or software calculation of the checksum when
1009 transmitting a packet using the ``csum`` forwarding engine::
1011 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1015 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1017 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1018 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
1019 supported). See also the ``csum parse-tunnel`` command.
1021 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1022 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
1023 supported). See also the ``csum parse-tunnel`` command.
1027 Check the NIC Datasheet for hardware limits.
1032 Set RSS queue region span on a port::
1034 testpmd> set port (port_id) queue-region region_id (value) \
1035 queue_start_index (value) queue_num (value)
1037 Set flowtype mapping on a RSS queue region on a port::
1039 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1043 * For the flowtype(pctype) of packet,the specific index for each type has
1044 been defined in file i40e_type.h as enum i40e_filter_pctype.
1046 Set user priority mapping on a RSS queue region on a port::
1048 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1050 Flush all queue region related configuration on a port::
1052 testpmd> set port (port_id) queue-region flush (on|off)
1056 * ``on``: is just an enable function which server for other configuration,
1057 it is for all configuration about queue region from up layer,
1058 at first will only keep in DPDK software stored in driver,
1059 only after "flush on", it commit all configuration to HW.
1061 * ``"off``: is just clean all configuration about queue region just now,
1062 and restore all to DPDK i40e driver default config when start up.
1064 Show all queue region related configuration info on a port::
1066 testpmd> show port (port_id) queue-region
1070 Queue region only support on PF by now, so these command is
1071 only for configuration of queue region on PF port.
1076 Define how tunneled packets should be handled by the csum forward
1079 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1081 If enabled, the csum forward engine will try to recognize supported
1082 tunnel headers (vxlan, gre, ipip).
1084 If disabled, treat tunnel packets as non-tunneled packets (a inner
1085 header is handled as a packet payload).
1089 The port argument is the TX port like in the ``csum set`` command.
1093 Consider a packet in packet like the following::
1095 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1097 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1098 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1099 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1101 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1102 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1107 Display tx checksum offload configuration::
1109 testpmd> csum show (port_id)
1114 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1116 testpmd> tso set (segsize) (port_id)
1120 Check the NIC datasheet for hardware limits.
1125 Display the status of TCP Segmentation Offload::
1127 testpmd> tso show (port_id)
1132 Set tso segment size of tunneled packets for a port in csum engine::
1134 testpmd> tunnel_tso set (tso_segsz) (port_id)
1139 Display the status of tunneled TCP Segmentation Offload for a port::
1141 testpmd> tunnel_tso show (port_id)
1146 Enable or disable GRO in ``csum`` forwarding engine::
1148 testpmd> set port <port_id> gro on|off
1150 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1151 packets received from the given port.
1153 If disabled, packets received from the given port won't be performed
1154 GRO. By default, GRO is disabled for all ports.
1158 When enable GRO for a port, TCP/IPv4 packets received from the port
1159 will be performed GRO. After GRO, all merged packets have bad
1160 checksums, since the GRO library doesn't re-calculate checksums for
1161 the merged packets. Therefore, if users want the merged packets to
1162 have correct checksums, please select HW IP checksum calculation and
1163 HW TCP checksum calculation for the port which the merged packets are
1169 Display GRO configuration for a given port::
1171 testpmd> show port <port_id> gro
1176 Set the cycle to flush the GROed packets from reassembly tables::
1178 testpmd> set gro flush <cycles>
1180 When enable GRO, the csum forwarding engine performs GRO on received
1181 packets, and the GROed packets are stored in reassembly tables. Users
1182 can use this command to determine when the GROed packets are flushed
1183 from the reassembly tables.
1185 The ``cycles`` is measured in GRO operation times. The csum forwarding
1186 engine flushes the GROed packets from the tables every ``cycles`` GRO
1189 By default, the value of ``cycles`` is 1, which means flush GROed packets
1190 from the reassembly tables as soon as one GRO operation finishes. The value
1191 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1193 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1194 stack performance. Because the GROed packets are delayed to arrive the
1195 stack, thus causing more duplicated ACKs and TCP retransmissions.
1200 Toggle per-port GSO support in ``csum`` forwarding engine::
1202 testpmd> set port <port_id> gso on|off
1204 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1205 packets, transmitted on the given port.
1207 If disabled, packets transmitted on the given port will not undergo GSO.
1208 By default, GSO is disabled for all ports.
1212 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1213 port undergo GSO. Afterwards, the segmented packets are represented by
1214 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1215 of checksums for GSO'd segments in SW. As a result, if users want correct
1216 checksums in GSO segments, they should enable HW checksum calculation for
1219 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1220 by setting the following options in the csum forwarding engine:
1222 testpmd> csum set outer_ip hw <port_id>
1224 testpmd> csum set ip hw <port_id>
1226 testpmd> csum set tcp hw <port_id>
1228 UDP GSO is the same as IP fragmentation, which treats the UDP header
1229 as the payload and does not modify it during segmentation. That is,
1230 after UDP GSO, only the first output fragment has the original UDP
1231 header. Therefore, users need to enable HW IP checksum calculation
1232 and SW UDP checksum calculation for GSO-enabled ports, if they want
1233 correct checksums for UDP/IPv4 packets.
1238 Set the maximum GSO segment size (measured in bytes), which includes the
1239 packet header and the packet payload for GSO-enabled ports (global)::
1241 testpmd> set gso segsz <length>
1246 Display the status of Generic Segmentation Offload for a given port::
1248 testpmd> show port <port_id> gso
1253 Add an alternative MAC address to a port::
1255 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1260 Remove a MAC address from a port::
1262 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1267 To add the multicast MAC address to/from the set of multicast addresses
1270 testpmd> mcast_addr add (port_id) (mcast_addr)
1275 To remove the multicast MAC address to/from the set of multicast addresses
1278 testpmd> mcast_addr remove (port_id) (mcast_addr)
1280 mac_addr add (for VF)
1281 ~~~~~~~~~~~~~~~~~~~~~
1283 Add an alternative MAC address for a VF to a port::
1285 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1290 Set the default MAC address for a port::
1292 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1294 mac_addr set (for VF)
1295 ~~~~~~~~~~~~~~~~~~~~~
1297 Set the MAC address for a VF from the PF::
1299 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1304 Set the forwarding peer address for certain port::
1306 testpmd> set eth-peer (port_id) (peer_addr)
1308 This is equivalent to the ``--eth-peer`` command-line option.
1313 Set the unicast hash filter(s) on/off for a port::
1315 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1320 Set the promiscuous mode on for a port or for all ports.
1321 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1323 testpmd> set promisc (port_id|all) (on|off)
1328 Set the allmulti mode for a port or for all ports::
1330 testpmd> set allmulti (port_id|all) (on|off)
1332 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1334 set promisc (for VF)
1335 ~~~~~~~~~~~~~~~~~~~~
1337 Set the unicast promiscuous mode for a VF from PF.
1338 It's supported by Intel i40e NICs now.
1339 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1341 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1343 set allmulticast (for VF)
1344 ~~~~~~~~~~~~~~~~~~~~~~~~~
1346 Set the multicast promiscuous mode for a VF from PF.
1347 It's supported by Intel i40e NICs now.
1348 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1350 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1352 set tx max bandwidth (for VF)
1353 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1355 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1357 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1359 set tc tx min bandwidth (for VF)
1360 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1362 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1364 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1366 set tc tx max bandwidth (for VF)
1367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1369 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1371 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1373 set tc strict link priority mode
1374 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1376 Set some TCs' strict link priority mode on a physical port::
1378 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1380 set tc tx min bandwidth
1381 ~~~~~~~~~~~~~~~~~~~~~~~
1383 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1385 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1390 Set the link flow control parameter on a port::
1392 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1393 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1394 autoneg (on|off) (port_id)
1398 * ``high_water`` (integer): High threshold value to trigger XOFF.
1400 * ``low_water`` (integer): Low threshold value to trigger XON.
1402 * ``pause_time`` (integer): Pause quota in the Pause frame.
1404 * ``send_xon`` (0/1): Send XON frame.
1406 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1408 * ``autoneg``: Change the auto-negotiation parameter.
1413 Set the priority flow control parameter on a port::
1415 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1416 (pause_time) (priority) (port_id)
1420 * ``high_water`` (integer): High threshold value.
1422 * ``low_water`` (integer): Low threshold value.
1424 * ``pause_time`` (integer): Pause quota in the Pause frame.
1426 * ``priority`` (0-7): VLAN User Priority.
1431 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1433 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1435 For example, to set rx queue 2 on port 0 to mapping 5::
1437 testpmd>set stat_qmap rx 0 2 5
1439 set xstats-hide-zero
1440 ~~~~~~~~~~~~~~~~~~~~
1442 Set the option to hide zero values for xstats display::
1444 testpmd> set xstats-hide-zero on|off
1448 By default, the zero values are displayed for xstats.
1450 set port - rx/tx (for VF)
1451 ~~~~~~~~~~~~~~~~~~~~~~~~~
1453 Set VF receive/transmit from a port::
1455 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1457 set port - mac address filter (for VF)
1458 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1460 Add/Remove unicast or multicast MAC addr filter for a VF::
1462 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1463 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1465 set port - rx mode(for VF)
1466 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1468 Set the VF receive mode of a port::
1470 testpmd> set port (port_id) vf (vf_id) \
1471 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1473 The available receive modes are:
1475 * ``AUPE``: Accepts untagged VLAN.
1477 * ``ROPE``: Accepts unicast hash.
1479 * ``BAM``: Accepts broadcast packets.
1481 * ``MPE``: Accepts all multicast packets.
1483 set port - tx_rate (for Queue)
1484 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1486 Set TX rate limitation for a queue on a port::
1488 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1490 set port - tx_rate (for VF)
1491 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1493 Set TX rate limitation for queues in VF on a port::
1495 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1497 set port - mirror rule
1498 ~~~~~~~~~~~~~~~~~~~~~~
1500 Set pool or vlan type mirror rule for a port::
1502 testpmd> set port (port_id) mirror-rule (rule_id) \
1503 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1504 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1506 Set link mirror rule for a port::
1508 testpmd> set port (port_id) mirror-rule (rule_id) \
1509 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1511 For example to enable mirror traffic with vlan 0,1 to pool 0::
1513 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1515 reset port - mirror rule
1516 ~~~~~~~~~~~~~~~~~~~~~~~~
1518 Reset a mirror rule for a port::
1520 testpmd> reset port (port_id) mirror-rule (rule_id)
1525 Set the flush on RX streams before forwarding.
1526 The default is flush ``on``.
1527 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1529 testpmd> set flush_rx off
1534 Set the bypass mode for the lowest port on bypass enabled NIC::
1536 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1541 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1543 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1544 mode (normal|bypass|isolate) (port_id)
1548 * ``timeout``: Enable bypass after watchdog timeout.
1550 * ``os_on``: Enable bypass when OS/board is powered on.
1552 * ``os_off``: Enable bypass when OS/board is powered off.
1554 * ``power_on``: Enable bypass when power supply is turned on.
1556 * ``power_off``: Enable bypass when power supply is turned off.
1562 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1564 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1569 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1571 testpmd> show bypass config (port_id)
1576 Set link up for a port::
1578 testpmd> set link-up port (port id)
1583 Set link down for a port::
1585 testpmd> set link-down port (port id)
1590 Enable E-tag insertion for a VF on a port::
1592 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1594 Disable E-tag insertion for a VF on a port::
1596 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1598 Enable/disable E-tag stripping on a port::
1600 testpmd> E-tag set stripping (on|off) port (port_id)
1602 Enable/disable E-tag based forwarding on a port::
1604 testpmd> E-tag set forwarding (on|off) port (port_id)
1606 Add an E-tag forwarding filter on a port::
1608 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1610 Delete an E-tag forwarding filter on a port::
1611 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1616 Load a dynamic device personalization (DDP) profile and store backup profile::
1618 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1623 Delete a dynamic device personalization profile and restore backup profile::
1625 testpmd> ddp del (port_id) (backup_profile_path)
1630 List all items from the ptype mapping table::
1632 testpmd> ptype mapping get (port_id) (valid_only)
1636 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1638 Replace a specific or a group of software defined ptype with a new one::
1640 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1644 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1646 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1648 * ``pkt_type``: The new software ptype to replace the old ones.
1650 Update hardware defined ptype to software defined packet type mapping table::
1652 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1656 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1658 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1660 Reset ptype mapping table::
1662 testpmd> ptype mapping reset (port_id)
1664 config per port Rx offloading
1665 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1667 Enable or disable a per port Rx offloading on all Rx queues of a port::
1669 testpmd> port config (port_id) rx_offload (offloading) on|off
1671 * ``offloading``: can be any of these offloading capability:
1672 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1673 qinq_strip, outer_ipv4_cksum, macsec_strip,
1674 header_split, vlan_filter, vlan_extend, jumbo_frame,
1675 scatter, timestamp, security, keep_crc
1677 This command should be run when the port is stopped, or else it will fail.
1679 config per queue Rx offloading
1680 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1682 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1684 testpmd> port (port_id) rxq (queue_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
1692 This command should be run when the port is stopped, or else it will fail.
1694 config per port Tx offloading
1695 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1697 Enable or disable a per port Tx offloading on all Tx queues of a port::
1699 testpmd> port config (port_id) tx_offload (offloading) on|off
1701 * ``offloading``: can be any of these offloading capability:
1702 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1703 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1704 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1705 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1706 mt_lockfree, multi_segs, mbuf_fast_free, security,
1709 This command should be run when the port is stopped, or else it will fail.
1711 config per queue Tx offloading
1712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1714 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1716 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1718 * ``offloading``: can be any of these offloading capability:
1719 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1720 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1721 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1722 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1723 mt_lockfree, multi_segs, mbuf_fast_free, security
1725 This command should be run when the port is stopped, or else it will fail.
1727 Config VXLAN Encap outer layers
1728 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1730 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1732 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1733 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1736 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1737 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1738 eth-src (eth-src) eth-dst (eth-dst)
1740 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1741 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1742 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1744 These commands will set an internal configuration inside testpmd, any following
1745 flow rule using the action vxlan_encap will use the last configuration set.
1746 To have a different encapsulation header, one of those commands must be called
1747 before the flow rule creation.
1749 Config NVGRE Encap outer layers
1750 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1752 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1754 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1755 eth-src (eth-src) eth-dst (eth-dst)
1756 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1757 ip-dst (ip-dst) vlan-tci (vlan-tci) 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 nvgre_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.
1767 Configure the l2 to be used when encapsulating a packet with L2::
1769 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1770 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1771 eth-src (eth-src) eth-dst (eth-dst)
1773 Those commands will set an internal configuration inside testpmd, any following
1774 flow rule using the action l2_encap will use the last configuration set.
1775 To have a different encapsulation header, one of those commands must be called
1776 before the flow rule creation.
1781 Configure the l2 to be removed when decapsulating a packet with L2::
1783 set l2_decap ip-version (ipv4|ipv6)
1784 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1786 Those commands will set an internal configuration inside testpmd, any following
1787 flow rule using the action l2_decap will use the last configuration set.
1788 To have a different encapsulation header, one of those commands must be called
1789 before the flow rule creation.
1791 Config MPLSoGRE Encap outer layers
1792 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1794 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1796 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1797 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1798 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1799 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1800 eth-src (eth-src) eth-dst (eth-dst)
1802 These commands will set an internal configuration inside testpmd, any following
1803 flow rule using the action mplsogre_encap will use the last configuration set.
1804 To have a different encapsulation header, one of those commands must be called
1805 before the flow rule creation.
1807 Config MPLSoGRE Decap outer layers
1808 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1810 Configure the outer layer to decapsulate MPLSoGRE packet::
1812 set mplsogre_decap ip-version (ipv4|ipv6)
1813 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1815 These commands will set an internal configuration inside testpmd, any following
1816 flow rule using the action mplsogre_decap will use the last configuration set.
1817 To have a different decapsulation header, one of those commands must be called
1818 before the flow rule creation.
1820 Config MPLSoUDP Encap outer layers
1821 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1823 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1825 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1826 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1827 eth-src (eth-src) eth-dst (eth-dst)
1828 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1829 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1830 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1832 These commands will set an internal configuration inside testpmd, any following
1833 flow rule using the action mplsoudp_encap will use the last configuration set.
1834 To have a different encapsulation header, one of those commands must be called
1835 before the flow rule creation.
1837 Config MPLSoUDP Decap outer layers
1838 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1840 Configure the outer layer to decapsulate MPLSoUDP packet::
1842 set mplsoudp_decap ip-version (ipv4|ipv6)
1843 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1845 These commands will set an internal configuration inside testpmd, any following
1846 flow rule using the action mplsoudp_decap will use the last configuration set.
1847 To have a different decapsulation header, one of those commands must be called
1848 before the flow rule creation.
1850 Config Raw Encapsulation
1851 ~~~~~~~~~~~~~~~~~~~~~~~~~
1853 Configure the raw data to be used when encapsulating a packet by
1854 rte_flow_action_raw_encap::
1856 set raw_encap {index} {item} [/ {item} [...]] / end_set
1858 There are multiple global buffers for ``raw_encap``, this command will set one
1859 internal buffer index by ``{index}``.
1860 If there is no ``{index}`` specified::
1862 set raw_encap {item} [/ {item} [...]] / end_set
1864 the default index ``0`` is used.
1865 In order to use different encapsulating header, ``index`` must be specified
1866 during the flow rule creation::
1868 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1869 raw_encap index 2 / end
1871 Otherwise the default index ``0`` is used.
1873 Config Raw Decapsulation
1874 ~~~~~~~~~~~~~~~~~~~~~~~~
1876 Configure the raw data to be used when decapsulating a packet by
1877 rte_flow_action_raw_decap::
1879 set raw_decap {index} {item} [/ {item} [...]] / end_set
1881 There are multiple global buffers for ``raw_decap``, this command will set
1882 one internal buffer index by ``{index}``.
1883 If there is no ``{index}`` specified::
1885 set raw_decap {item} [/ {item} [...]] / end_set
1887 the default index ``0`` is used.
1888 In order to use different decapsulating header, ``index`` must be specified
1889 during the flow rule creation::
1891 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1892 raw_encap index 3 / end
1894 Otherwise the default index ``0`` is used.
1899 The following sections show functions for configuring ports.
1903 Port configuration changes only become active when forwarding is started/restarted.
1908 Attach a port specified by pci address or virtual device args::
1910 testpmd> port attach (identifier)
1912 To attach a new pci device, the device should be recognized by kernel first.
1913 Then it should be moved under DPDK management.
1914 Finally the port can be attached to testpmd.
1916 For example, to move a pci device using ixgbe under DPDK management:
1918 .. code-block:: console
1920 # Check the status of the available devices.
1921 ./usertools/dpdk-devbind.py --status
1923 Network devices using DPDK-compatible driver
1924 ============================================
1927 Network devices using kernel driver
1928 ===================================
1929 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1932 # Bind the device to igb_uio.
1933 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1936 # Recheck the status of the devices.
1937 ./usertools/dpdk-devbind.py --status
1938 Network devices using DPDK-compatible driver
1939 ============================================
1940 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1942 To attach a port created by virtual device, above steps are not needed.
1944 For example, to attach a port whose pci address is 0000:0a:00.0.
1946 .. code-block:: console
1948 testpmd> port attach 0000:0a:00.0
1949 Attaching a new port...
1950 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1951 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1952 EAL: PCI memory mapped at 0x7f83bfa00000
1953 EAL: PCI memory mapped at 0x7f83bfa80000
1954 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1955 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1956 Port 0 is attached. Now total ports is 1
1959 For example, to attach a port created by pcap PMD.
1961 .. code-block:: console
1963 testpmd> port attach net_pcap0
1964 Attaching a new port...
1965 PMD: Initializing pmd_pcap for net_pcap0
1966 PMD: Creating pcap-backed ethdev on numa socket 0
1967 Port 0 is attached. Now total ports is 1
1970 In this case, identifier is ``net_pcap0``.
1971 This identifier format is the same as ``--vdev`` format of DPDK applications.
1973 For example, to re-attach a bonded port which has been previously detached,
1974 the mode and slave parameters must be given.
1976 .. code-block:: console
1978 testpmd> port attach net_bond_0,mode=0,slave=1
1979 Attaching a new port...
1980 EAL: Initializing pmd_bond for net_bond_0
1981 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1982 Port 0 is attached. Now total ports is 1
1989 Detach a specific port::
1991 testpmd> port detach (port_id)
1993 Before detaching a port, the port should be stopped and closed.
1995 For example, to detach a pci device port 0.
1997 .. code-block:: console
1999 testpmd> port stop 0
2002 testpmd> port close 0
2006 testpmd> port detach 0
2008 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2009 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2010 EAL: PCI memory unmapped at 0x7f83bfa00000
2011 EAL: PCI memory unmapped at 0x7f83bfa80000
2015 For example, to detach a virtual device port 0.
2017 .. code-block:: console
2019 testpmd> port stop 0
2022 testpmd> port close 0
2026 testpmd> port detach 0
2028 PMD: Closing pcap ethdev on numa socket 0
2029 Port 'net_pcap0' is detached. Now total ports is 0
2032 To remove a pci device completely from the system, first detach the port from testpmd.
2033 Then the device should be moved under kernel management.
2034 Finally the device can be removed using kernel pci hotplug functionality.
2036 For example, to move a pci device under kernel management:
2038 .. code-block:: console
2040 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2042 ./usertools/dpdk-devbind.py --status
2044 Network devices using DPDK-compatible driver
2045 ============================================
2048 Network devices using kernel driver
2049 ===================================
2050 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2052 To remove a port created by a virtual device, above steps are not needed.
2057 Start all ports or a specific port::
2059 testpmd> port start (port_id|all)
2064 Stop all ports or a specific port::
2066 testpmd> port stop (port_id|all)
2071 Close all ports or a specific port::
2073 testpmd> port close (port_id|all)
2078 Reset all ports or a specific port::
2080 testpmd> port reset (port_id|all)
2082 User should stop port(s) before resetting and (re-)start after reset.
2084 port config - queue ring size
2085 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2087 Configure a rx/tx queue ring size::
2089 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2091 Only take effect after command that (re-)start the port or command that setup specific queue.
2093 port start/stop queue
2094 ~~~~~~~~~~~~~~~~~~~~~
2096 Start/stop a rx/tx queue on a specific port::
2098 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2100 port config - queue deferred start
2101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2103 Switch on/off deferred start of a specific port queue::
2105 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2108 ~~~~~~~~~~~~~~~~~~~~~
2110 Setup a rx/tx queue on a specific port::
2112 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2114 Only take effect when port is started.
2119 Set the speed and duplex mode for all ports or a specific port::
2121 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
2122 duplex (half|full|auto)
2124 port config - queues/descriptors
2125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2127 Set number of queues/descriptors for rxq, txq, rxd and txd::
2129 testpmd> port config all (rxq|txq|rxd|txd) (value)
2131 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2133 port config - max-pkt-len
2134 ~~~~~~~~~~~~~~~~~~~~~~~~~
2136 Set the maximum packet length::
2138 testpmd> port config all max-pkt-len (value)
2140 This is equivalent to the ``--max-pkt-len`` command-line option.
2142 port config - Drop Packets
2143 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2145 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2147 testpmd> port config all drop-en (on|off)
2149 Packet dropping when no receive buffers available is off by default.
2151 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2156 Set the RSS (Receive Side Scaling) mode on or off::
2158 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|none)
2160 RSS is on by default.
2162 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
2163 The ``default`` option enables all supported RSS types reported by device info.
2164 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2166 port config - RSS Reta
2167 ~~~~~~~~~~~~~~~~~~~~~~
2169 Set the RSS (Receive Side Scaling) redirection table::
2171 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2176 Set the DCB mode for an individual port::
2178 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2180 The traffic class should be 4 or 8.
2185 Set the number of packets per burst::
2187 testpmd> port config all burst (value)
2189 This is equivalent to the ``--burst`` command-line option.
2191 port config - Threshold
2192 ~~~~~~~~~~~~~~~~~~~~~~~
2194 Set thresholds for TX/RX queues::
2196 testpmd> port config all (threshold) (value)
2198 Where the threshold type can be:
2200 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2202 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2204 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2206 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2208 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2210 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2212 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2214 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2216 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2218 These threshold options are also available from the command-line.
2223 Set the value of ether-type for E-tag::
2225 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2227 Enable/disable the E-tag support::
2229 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2231 port config pctype mapping
2232 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2234 Reset pctype mapping table::
2236 testpmd> port config (port_id) pctype mapping reset
2238 Update hardware defined pctype to software defined flow type mapping table::
2240 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2244 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2246 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2248 port config input set
2249 ~~~~~~~~~~~~~~~~~~~~~
2251 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2253 testpmd> port config (port_id) pctype (pctype_id) \
2254 (hash_inset|fdir_inset|fdir_flx_inset) \
2255 (get|set|clear) field (field_idx)
2257 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2259 testpmd> port config (port_id) pctype (pctype_id) \
2260 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2264 * ``pctype_id``: hardware packet classification types.
2265 * ``field_idx``: hardware field index.
2267 port config udp_tunnel_port
2268 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2270 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2272 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2274 port config tx_metadata
2275 ~~~~~~~~~~~~~~~~~~~~~~~
2277 Set Tx metadata value per port.
2278 testpmd will add this value to any Tx packet sent from this port::
2280 testpmd> port config (port_id) tx_metadata (value)
2285 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2287 testpmd> port config mtu (port_id) (value)
2289 port config rss hash key
2290 ~~~~~~~~~~~~~~~~~~~~~~~~
2292 To configure the RSS hash key used to compute the RSS
2293 hash of input [IP] packets received on port::
2295 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2296 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2297 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2298 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2299 ipv6-udp-ex <string of hex digits \
2300 (variable length, NIC dependent)>)
2305 The following sections show functions for device operations.
2310 Detach a device specified by pci address or virtual device args::
2312 testpmd> device detach (identifier)
2314 Before detaching a device associated with ports, the ports should be stopped and closed.
2316 For example, to detach a pci device whose address is 0002:03:00.0.
2318 .. code-block:: console
2320 testpmd> device detach 0002:03:00.0
2321 Removing a device...
2322 Port 1 is now closed
2323 EAL: Releasing pci mapped resource for 0002:03:00.0
2324 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2325 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2326 Device 0002:03:00.0 is detached
2327 Now total ports is 1
2329 For example, to detach a port created by pcap PMD.
2331 .. code-block:: console
2333 testpmd> device detach net_pcap0
2334 Removing a device...
2335 Port 0 is now closed
2336 Device net_pcap0 is detached
2337 Now total ports is 0
2340 In this case, identifier is ``net_pcap0``.
2341 This identifier format is the same as ``--vdev`` format of DPDK applications.
2343 Link Bonding Functions
2344 ----------------------
2346 The Link Bonding functions make it possible to dynamically create and
2347 manage link bonding devices from within testpmd interactive prompt.
2349 create bonded device
2350 ~~~~~~~~~~~~~~~~~~~~
2352 Create a new bonding device::
2354 testpmd> create bonded device (mode) (socket)
2356 For example, to create a bonded device in mode 1 on socket 0::
2358 testpmd> create bonded device 1 0
2359 created new bonded device (port X)
2364 Adds Ethernet device to a Link Bonding device::
2366 testpmd> add bonding slave (slave id) (port id)
2368 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2370 testpmd> add bonding slave 6 10
2373 remove bonding slave
2374 ~~~~~~~~~~~~~~~~~~~~
2376 Removes an Ethernet slave device from a Link Bonding device::
2378 testpmd> remove bonding slave (slave id) (port id)
2380 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2382 testpmd> remove bonding slave 6 10
2387 Set the Link Bonding mode of a Link Bonding device::
2389 testpmd> set bonding mode (value) (port id)
2391 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2393 testpmd> set bonding mode 3 10
2398 Set an Ethernet slave device as the primary device on a Link Bonding device::
2400 testpmd> set bonding primary (slave id) (port id)
2402 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2404 testpmd> set bonding primary 6 10
2409 Set the MAC address of a Link Bonding device::
2411 testpmd> set bonding mac (port id) (mac)
2413 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2415 testpmd> set bonding mac 10 00:00:00:00:00:01
2417 set bonding xmit_balance_policy
2418 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2420 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2422 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2424 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2426 testpmd> set bonding xmit_balance_policy 10 l34
2429 set bonding mon_period
2430 ~~~~~~~~~~~~~~~~~~~~~~
2432 Set the link status monitoring polling period in milliseconds for a bonding device.
2434 This adds support for PMD slave devices which do not support link status interrupts.
2435 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2436 link status ISR will be queried every polling interval to check if their link status has changed::
2438 testpmd> set bonding mon_period (port_id) (value)
2440 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2442 testpmd> set bonding mon_period 5 150
2445 set bonding lacp dedicated_queue
2446 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2448 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2449 when in mode 4 (link-aggregation-802.3ad)::
2451 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2454 set bonding agg_mode
2455 ~~~~~~~~~~~~~~~~~~~~
2457 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2459 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2465 Show the current configuration of a Link Bonding device::
2467 testpmd> show bonding config (port id)
2470 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2471 in balance mode with a transmission policy of layer 2+3::
2473 testpmd> show bonding config 9
2475 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2477 Active Slaves (3): [1 3 4]
2484 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2485 This is mainly useful for debugging purposes.
2486 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2487 and fields that can be accessed.
2492 Display the value of a port register::
2494 testpmd> read reg (port_id) (address)
2496 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2498 testpmd> read reg 0 0xEE00
2499 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2504 Display a port register bit field::
2506 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2508 For example, reading the lowest two bits from the register in the example above::
2510 testpmd> read regfield 0 0xEE00 0 1
2511 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2516 Display a single port register bit::
2518 testpmd> read regbit (port_id) (address) (bit_x)
2520 For example, reading the lowest bit from the register in the example above::
2522 testpmd> read regbit 0 0xEE00 0
2523 port 0 PCI register at offset 0xEE00: bit 0=1
2528 Set the value of a port register::
2530 testpmd> write reg (port_id) (address) (value)
2532 For example, to clear a register::
2534 testpmd> write reg 0 0xEE00 0x0
2535 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2540 Set bit field of a port register::
2542 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2544 For example, writing to the register cleared in the example above::
2546 testpmd> write regfield 0 0xEE00 0 1 2
2547 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2552 Set single bit value of a port register::
2554 testpmd> write regbit (port_id) (address) (bit_x) (value)
2556 For example, to set the high bit in the register from the example above::
2558 testpmd> write regbit 0 0xEE00 31 1
2559 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2561 Traffic Metering and Policing
2562 -----------------------------
2564 The following section shows functions for configuring traffic metering and
2565 policing on the ethernet device through the use of generic ethdev API.
2567 show port traffic management capability
2568 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2570 Show traffic metering and policing capability of the port::
2572 testpmd> show port meter cap (port_id)
2574 add port meter profile (srTCM rfc2967)
2575 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2577 Add meter profile (srTCM rfc2697) to the ethernet device::
2579 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2584 * ``profile_id``: ID for the meter profile.
2585 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2586 * ``cbs``: Committed Burst Size (CBS) (bytes).
2587 * ``ebs``: Excess Burst Size (EBS) (bytes).
2589 add port meter profile (trTCM rfc2968)
2590 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2592 Add meter profile (srTCM rfc2698) to the ethernet device::
2594 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2595 (cir) (pir) (cbs) (pbs)
2599 * ``profile_id``: ID for the meter profile.
2600 * ``cir``: Committed information rate (bytes/second).
2601 * ``pir``: Peak information rate (bytes/second).
2602 * ``cbs``: Committed burst size (bytes).
2603 * ``pbs``: Peak burst size (bytes).
2605 add port meter profile (trTCM rfc4115)
2606 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2608 Add meter profile (trTCM rfc4115) to the ethernet device::
2610 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2611 (cir) (eir) (cbs) (ebs)
2615 * ``profile_id``: ID for the meter profile.
2616 * ``cir``: Committed information rate (bytes/second).
2617 * ``eir``: Excess information rate (bytes/second).
2618 * ``cbs``: Committed burst size (bytes).
2619 * ``ebs``: Excess burst size (bytes).
2621 delete port meter profile
2622 ~~~~~~~~~~~~~~~~~~~~~~~~~
2624 Delete meter profile from the ethernet device::
2626 testpmd> del port meter profile (port_id) (profile_id)
2631 Create new meter object for the ethernet device::
2633 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2634 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2635 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2640 * ``mtr_id``: meter object ID.
2641 * ``profile_id``: ID for the meter profile.
2642 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2643 gets enabled at the time of creation, otherwise remains disabled.
2644 * ``g_action``: Policer action for the packet with green color.
2645 * ``y_action``: Policer action for the packet with yellow color.
2646 * ``r_action``: Policer action for the packet with red color.
2647 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2649 * ``shared``: When this parameter has a non-zero value, the meter object is
2650 shared by multiple flows. Otherwise, meter object is used by single flow.
2651 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2652 input color for the current meter object is determined by the latest meter
2653 object in the same flow. Otherwise, the current meter object uses the
2654 *dscp_table* to determine the input color.
2655 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2656 color, 0 <= x <= 63.
2661 Enable meter for the ethernet device::
2663 testpmd> enable port meter (port_id) (mtr_id)
2668 Disable meter for the ethernet device::
2670 testpmd> disable port meter (port_id) (mtr_id)
2675 Delete meter for the ethernet device::
2677 testpmd> del port meter (port_id) (mtr_id)
2679 Set port meter profile
2680 ~~~~~~~~~~~~~~~~~~~~~~
2682 Set meter profile for the ethernet device::
2684 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2686 set port meter dscp table
2687 ~~~~~~~~~~~~~~~~~~~~~~~~~
2689 Set meter dscp table for the ethernet device::
2691 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2692 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2694 set port meter policer action
2695 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2697 Set meter policer action for the ethernet device::
2699 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2700 (action0) [(action1) (action1)]
2704 * ``action_mask``: Bit mask indicating which policer actions need to be
2705 updated. One or more policer actions can be updated in a single function
2706 invocation. To update the policer action associated with color C, bit
2707 (1 << C) needs to be set in *action_mask* and element at position C
2708 in the *actions* array needs to be valid.
2709 * ``actionx``: Policer action for the color x,
2710 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2712 set port meter stats mask
2713 ~~~~~~~~~~~~~~~~~~~~~~~~~
2715 Set meter stats mask for the ethernet device::
2717 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2721 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2723 show port meter stats
2724 ~~~~~~~~~~~~~~~~~~~~~
2726 Show meter stats of the ethernet device::
2728 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2732 * ``clear``: Flag that indicates whether the statistics counters should
2733 be cleared (i.e. set to zero) immediately after they have been read or not.
2738 The following section shows functions for configuring traffic management on
2739 on the ethernet device through the use of generic TM API.
2741 show port traffic management capability
2742 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2744 Show traffic management capability of the port::
2746 testpmd> show port tm cap (port_id)
2748 show port traffic management capability (hierarchy level)
2749 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2751 Show traffic management hierarchy level capability of the port::
2753 testpmd> show port tm level cap (port_id) (level_id)
2755 show port traffic management capability (hierarchy node level)
2756 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2758 Show the traffic management hierarchy node capability of the port::
2760 testpmd> show port tm node cap (port_id) (node_id)
2762 show port traffic management hierarchy node type
2763 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2765 Show the port traffic management hierarchy node type::
2767 testpmd> show port tm node type (port_id) (node_id)
2769 show port traffic management hierarchy node stats
2770 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2772 Show the port traffic management hierarchy node statistics::
2774 testpmd> show port tm node stats (port_id) (node_id) (clear)
2778 * ``clear``: When this parameter has a non-zero value, the statistics counters
2779 are cleared (i.e. set to zero) immediately after they have been read,
2780 otherwise the statistics counters are left untouched.
2782 Add port traffic management private shaper profile
2783 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2785 Add the port traffic management private shaper profile::
2787 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2788 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2789 (packet_length_adjust)
2793 * ``shaper_profile id``: Shaper profile ID for the new profile.
2794 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2795 * ``cmit_tb_size``: Committed token bucket size (bytes).
2796 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2797 * ``peak_tb_size``: Peak token bucket size (bytes).
2798 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2799 each packet for the purpose of shaping. This parameter value can be used to
2800 correct the packet length with the framing overhead bytes that are consumed
2803 Delete port traffic management private shaper profile
2804 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2806 Delete the port traffic management private shaper::
2808 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2812 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2814 Add port traffic management shared shaper
2815 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2817 Create the port traffic management shared shaper::
2819 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2824 * ``shared_shaper_id``: Shared shaper ID to be created.
2825 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2827 Set port traffic management shared shaper
2828 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2830 Update the port traffic management shared shaper::
2832 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2837 * ``shared_shaper_id``: Shared shaper ID to be update.
2838 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2840 Delete port traffic management shared shaper
2841 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2843 Delete the port traffic management shared shaper::
2845 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2849 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2851 Set port traffic management hierarchy node private shaper
2852 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2854 set the port traffic management hierarchy node private shaper::
2856 testpmd> set port tm node shaper profile (port_id) (node_id) \
2861 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2864 Add port traffic management WRED profile
2865 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2867 Create a new WRED profile::
2869 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2870 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2871 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2872 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2876 * ``wred_profile id``: Identifier for the newly create WRED profile
2877 * ``color_g``: Packet color (green)
2878 * ``min_th_g``: Minimum queue threshold for packet with green color
2879 * ``max_th_g``: Minimum queue threshold for packet with green color
2880 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2881 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2882 * ``color_y``: Packet color (yellow)
2883 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2884 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2885 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2886 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2887 * ``color_r``: Packet color (red)
2888 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2889 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2890 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2891 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2893 Delete port traffic management WRED profile
2894 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2896 Delete the WRED profile::
2898 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2900 Add port traffic management hierarchy nonleaf node
2901 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2903 Add nonleaf node to port traffic management hierarchy::
2905 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2906 (priority) (weight) (level_id) (shaper_profile_id) \
2907 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2908 [(shared_shaper_0) (shared_shaper_1) ...] \
2912 * ``parent_node_id``: Node ID of the parent.
2913 * ``priority``: Node priority (highest node priority is zero). This is used by
2914 the SP algorithm running on the parent node for scheduling this node.
2915 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2916 to the weight sum of all siblings that have the same priority. It is used by
2917 the WFQ algorithm running on the parent node for scheduling this node.
2918 * ``level_id``: Hierarchy level of the node.
2919 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2921 * ``n_sp_priorities``: Number of strict priorities.
2922 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2923 * ``n_shared_shapers``: Number of shared shapers.
2924 * ``shared_shaper_id``: Shared shaper id.
2926 Add port traffic management hierarchy leaf node
2927 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2929 Add leaf node to port traffic management hierarchy::
2931 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2932 (priority) (weight) (level_id) (shaper_profile_id) \
2933 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2934 [(shared_shaper_id) (shared_shaper_id) ...] \
2938 * ``parent_node_id``: Node ID of the parent.
2939 * ``priority``: Node priority (highest node priority is zero). This is used by
2940 the SP algorithm running on the parent node for scheduling this node.
2941 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2942 to the weight sum of all siblings that have the same priority. It is used by
2943 the WFQ algorithm running on the parent node for scheduling this node.
2944 * ``level_id``: Hierarchy level of the node.
2945 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2947 * ``cman_mode``: Congestion management mode to be enabled for this node.
2948 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2949 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2950 * ``n_shared_shapers``: Number of shared shapers.
2951 * ``shared_shaper_id``: Shared shaper id.
2953 Delete port traffic management hierarchy node
2954 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2956 Delete node from port traffic management hierarchy::
2958 testpmd> del port tm node (port_id) (node_id)
2960 Update port traffic management hierarchy parent node
2961 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2963 Update port traffic management hierarchy parent node::
2965 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
2968 This function can only be called after the hierarchy commit invocation. Its
2969 success depends on the port support for this operation, as advertised through
2970 the port capability set. This function is valid for all nodes of the traffic
2971 management hierarchy except root node.
2973 Suspend port traffic management hierarchy node
2974 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2976 testpmd> suspend port tm node (port_id) (node_id)
2978 Resume port traffic management hierarchy node
2979 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2981 testpmd> resume port tm node (port_id) (node_id)
2983 Commit port traffic management hierarchy
2984 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2986 Commit the traffic management hierarchy on the port::
2988 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
2992 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
2993 call failure. On the other hand, hierarchy is preserved when this parameter
2996 Set port traffic management mark VLAN dei
2997 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2999 Enables/Disables the traffic management marking on the port for VLAN packets::
3001 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3005 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3006 ``yellow`` or ``red`` will have dei bit enabled
3008 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3010 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3012 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3014 Set port traffic management mark IP dscp
3015 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3017 Enables/Disables the traffic management marking on the port for IP dscp packets::
3019 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3023 * ``port_id``: The port which on which IP packets marked as ``green`` or
3024 ``yellow`` or ``red`` will have IP dscp bits updated
3026 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3028 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3030 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3032 Set port traffic management mark IP ecn
3033 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3035 Enables/Disables the traffic management marking on the port for IP ecn packets::
3037 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3041 * ``port_id``: The port which on which IP packets marked as ``green`` or
3042 ``yellow`` or ``red`` will have IP ecn bits updated
3044 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3045 to ecn of 2'b11 when IP is caring TCP or SCTP
3047 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3048 to ecn of 2'b11 when IP is caring TCP or SCTP
3050 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3051 to ecn of 2'b11 when IP is caring TCP or SCTP
3053 Set port traffic management default hierarchy (softnic forwarding mode)
3054 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3056 set the traffic management default hierarchy on the port::
3058 testpmd> set port tm hierarchy default (port_id)
3063 This section details the available filter functions that are available.
3065 Note these functions interface the deprecated legacy filtering framework,
3066 superseded by *rte_flow*. See `Flow rules management`_.
3069 ~~~~~~~~~~~~~~~~~~~~
3071 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3073 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3074 ethertype (ether_type) (drop|fwd) queue (queue_id)
3076 The available information parameters are:
3078 * ``port_id``: The port which the Ethertype filter assigned on.
3080 * ``mac_addr``: Compare destination mac address.
3082 * ``mac_ignr``: Ignore destination mac address match.
3084 * ``mac_address``: Destination mac address to match.
3086 * ``ether_type``: The EtherType value want to match,
3087 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3089 * ``queue_id``: The receive queue associated with this EtherType filter.
3090 It is meaningless when deleting or dropping.
3092 Example, to add/remove an ethertype filter rule::
3094 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3095 ethertype 0x0806 fwd queue 3
3097 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3098 ethertype 0x0806 fwd queue 3
3103 Add or delete a 2-tuple filter,
3104 which identifies packets by specific protocol and destination TCP/UDP port
3105 and forwards packets into one of the receive queues::
3107 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3108 protocol (protocol_value) mask (mask_value) \
3109 tcp_flags (tcp_flags_value) priority (prio_value) \
3112 The available information parameters are:
3114 * ``port_id``: The port which the 2-tuple filter assigned on.
3116 * ``dst_port_value``: Destination port in L4.
3118 * ``protocol_value``: IP L4 protocol.
3120 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3122 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3124 * ``prio_value``: Priority of this filter.
3126 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3128 Example, to add/remove an 2tuple filter rule::
3130 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3131 tcp_flags 0x02 priority 3 queue 3
3133 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3134 tcp_flags 0x02 priority 3 queue 3
3139 Add or delete a 5-tuple filter,
3140 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3141 and routes packets into one of the receive queues::
3143 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3144 (src_address) dst_port (dst_port_value) \
3145 src_port (src_port_value) protocol (protocol_value) \
3146 mask (mask_value) tcp_flags (tcp_flags_value) \
3147 priority (prio_value) queue (queue_id)
3149 The available information parameters are:
3151 * ``port_id``: The port which the 5-tuple filter assigned on.
3153 * ``dst_address``: Destination IP address.
3155 * ``src_address``: Source IP address.
3157 * ``dst_port_value``: TCP/UDP destination port.
3159 * ``src_port_value``: TCP/UDP source port.
3161 * ``protocol_value``: L4 protocol.
3163 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3165 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3167 * ``prio_value``: The priority of this filter.
3169 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3171 Example, to add/remove an 5tuple filter rule::
3173 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3174 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3175 flags 0x0 priority 3 queue 3
3177 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3178 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3179 flags 0x0 priority 3 queue 3
3184 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3186 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3188 The available information parameters are:
3190 * ``port_id``: The port which the SYN filter assigned on.
3192 * ``high``: This SYN filter has higher priority than other filters.
3194 * ``low``: This SYN filter has lower priority than other filters.
3196 * ``queue_id``: The receive queue associated with this SYN filter
3200 testpmd> syn_filter 0 add priority high queue 3
3205 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3206 and routed into one of the receive queues::
3208 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3209 mask (mask_value) priority (prio_value) queue (queue_id)
3211 The available information parameters are:
3213 * ``port_id``: The port which the Flex filter is assigned on.
3215 * ``len_value``: Filter length in bytes, no greater than 128.
3217 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3219 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3221 * ``prio_value``: The priority of this filter.
3223 * ``queue_id``: The receive queue associated with this Flex filter.
3227 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3228 mask 000C priority 3 queue 3
3230 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3231 mask 000C priority 3 queue 3
3234 .. _testpmd_flow_director:
3236 flow_director_filter
3237 ~~~~~~~~~~~~~~~~~~~~
3239 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3241 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3242 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3244 * Perfect match filters.
3245 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3246 The masked fields are for IP flow.
3248 * Signature filters.
3249 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3251 * Perfect-mac-vlan match filters.
3252 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3253 The masked fields are for MAC VLAN flow.
3255 * Perfect-tunnel match filters.
3256 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3257 The masked fields are for tunnel flow.
3259 * Perfect-raw-flow-type match filters.
3260 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3261 The masked fields are specified by input sets.
3263 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3264 per flow type and the flexible payload.
3266 The Flow Director can also mask out parts of all of these fields so that filters
3267 are only applied to certain fields or parts of the fields.
3269 Note that for raw flow type mode the source and destination fields in the
3270 raw packet buffer need to be presented in a reversed order with respect
3271 to the expected received packets.
3272 For example: IP source and destination addresses or TCP/UDP/SCTP
3273 source and destination ports
3275 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3277 # Commands to add flow director filters of different flow types::
3279 flow_director_filter (port_id) mode IP (add|del|update) \
3280 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3281 src (src_ip_address) dst (dst_ip_address) \
3282 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3283 vlan (vlan_value) flexbytes (flexbytes_value) \
3284 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3287 flow_director_filter (port_id) mode IP (add|del|update) \
3288 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3289 src (src_ip_address) (src_port) \
3290 dst (dst_ip_address) (dst_port) \
3291 tos (tos_value) ttl (ttl_value) \
3292 vlan (vlan_value) flexbytes (flexbytes_value) \
3293 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3296 flow_director_filter (port_id) mode IP (add|del|update) \
3297 flow (ipv4-sctp|ipv6-sctp) \
3298 src (src_ip_address) (src_port) \
3299 dst (dst_ip_address) (dst_port) \
3300 tos (tos_value) ttl (ttl_value) \
3301 tag (verification_tag) vlan (vlan_value) \
3302 flexbytes (flexbytes_value) (drop|fwd) \
3303 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3305 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3306 ether (ethertype) flexbytes (flexbytes_value) \
3307 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3310 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3311 mac (mac_address) vlan (vlan_value) \
3312 flexbytes (flexbytes_value) (drop|fwd) \
3313 queue (queue_id) fd_id (fd_id_value)
3315 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3316 mac (mac_address) vlan (vlan_value) \
3317 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3318 flexbytes (flexbytes_value) (drop|fwd) \
3319 queue (queue_id) fd_id (fd_id_value)
3321 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3322 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3323 packet (packet file name)
3325 For example, to add an ipv4-udp flow type filter::
3327 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3328 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3329 fwd pf queue 1 fd_id 1
3331 For example, add an ipv4-other flow type filter::
3333 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3334 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3335 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3340 Flush all flow director filters on a device::
3342 testpmd> flush_flow_director (port_id)
3344 Example, to flush all flow director filter on port 0::
3346 testpmd> flush_flow_director 0
3351 Set flow director's input masks::
3353 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3354 src_mask (ipv4_src) (ipv6_src) (src_port) \
3355 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3357 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3359 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3360 mac (mac_value) tunnel-type (tunnel_type_value) \
3361 tunnel-id (tunnel_id_value)
3363 Example, to set flow director mask on port 0::
3365 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3366 src_mask 255.255.255.255 \
3367 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3368 dst_mask 255.255.255.255 \
3369 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3371 flow_director_flex_mask
3372 ~~~~~~~~~~~~~~~~~~~~~~~
3374 set masks of flow director's flexible payload based on certain flow type::
3376 testpmd> flow_director_flex_mask (port_id) \
3377 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3378 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3379 l2_payload|all) (mask)
3381 Example, to set flow director's flex mask for all flow type on port 0::
3383 testpmd> flow_director_flex_mask 0 flow all \
3384 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3387 flow_director_flex_payload
3388 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3390 Configure flexible payload selection::
3392 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3394 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3396 testpmd> flow_director_flex_payload 0 l4 \
3397 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3399 get_sym_hash_ena_per_port
3400 ~~~~~~~~~~~~~~~~~~~~~~~~~
3402 Get symmetric hash enable configuration per port::
3404 get_sym_hash_ena_per_port (port_id)
3406 For example, to get symmetric hash enable configuration of port 1::
3408 testpmd> get_sym_hash_ena_per_port 1
3410 set_sym_hash_ena_per_port
3411 ~~~~~~~~~~~~~~~~~~~~~~~~~
3413 Set symmetric hash enable configuration per port to enable or disable::
3415 set_sym_hash_ena_per_port (port_id) (enable|disable)
3417 For example, to set symmetric hash enable configuration of port 1 to enable::
3419 testpmd> set_sym_hash_ena_per_port 1 enable
3421 get_hash_global_config
3422 ~~~~~~~~~~~~~~~~~~~~~~
3424 Get the global configurations of hash filters::
3426 get_hash_global_config (port_id)
3428 For example, to get the global configurations of hash filters of port 1::
3430 testpmd> get_hash_global_config 1
3432 set_hash_global_config
3433 ~~~~~~~~~~~~~~~~~~~~~~
3435 Set the global configurations of hash filters::
3437 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3438 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3439 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3442 For example, to enable simple_xor for flow type of ipv6 on port 2::
3444 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3449 Set the input set for hash::
3451 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3452 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3453 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3454 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3455 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3456 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3457 fld-8th|none) (select|add)
3459 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3461 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3466 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3467 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3469 Set the input set for flow director::
3471 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3472 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3473 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3474 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3475 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3476 sctp-dst-port|sctp-veri-tag|none) (select|add)
3478 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3480 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3485 Set different GRE key length for input set::
3487 global_config (port_id) gre-key-len (number in bytes)
3489 For example to set GRE key length for input set to 4 bytes on port 0::
3491 testpmd> global_config 0 gre-key-len 4
3494 .. _testpmd_rte_flow:
3496 Flow rules management
3497 ---------------------
3499 Control of the generic flow API (*rte_flow*) is fully exposed through the
3500 ``flow`` command (validation, creation, destruction, queries and operation
3503 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3504 features simultaneously may cause undefined side-effects and is therefore
3510 Because the ``flow`` command uses dynamic tokens to handle the large number
3511 of possible flow rules combinations, its behavior differs slightly from
3512 other commands, in particular:
3514 - Pressing *?* or the *<tab>* key displays contextual help for the current
3515 token, not that of the entire command.
3517 - Optional and repeated parameters are supported (provided they are listed
3518 in the contextual help).
3520 The first parameter stands for the operation mode. Possible operations and
3521 their general syntax are described below. They are covered in detail in the
3524 - Check whether a flow rule can be created::
3526 flow validate {port_id}
3527 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3528 pattern {item} [/ {item} [...]] / end
3529 actions {action} [/ {action} [...]] / end
3531 - Create a flow rule::
3533 flow create {port_id}
3534 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3535 pattern {item} [/ {item} [...]] / end
3536 actions {action} [/ {action} [...]] / end
3538 - Destroy specific flow rules::
3540 flow destroy {port_id} rule {rule_id} [...]
3542 - Destroy all flow rules::
3544 flow flush {port_id}
3546 - Query an existing flow rule::
3548 flow query {port_id} {rule_id} {action}
3550 - List existing flow rules sorted by priority, filtered by group
3553 flow list {port_id} [group {group_id}] [...]
3555 - Restrict ingress traffic to the defined flow rules::
3557 flow isolate {port_id} {boolean}
3559 Validating flow rules
3560 ~~~~~~~~~~~~~~~~~~~~~
3562 ``flow validate`` reports whether a flow rule would be accepted by the
3563 underlying device in its current state but stops short of creating it. It is
3564 bound to ``rte_flow_validate()``::
3566 flow validate {port_id}
3567 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3568 pattern {item} [/ {item} [...]] / end
3569 actions {action} [/ {action} [...]] / end
3571 If successful, it will show::
3575 Otherwise it will show an error message of the form::
3577 Caught error type [...] ([...]): [...]
3579 This command uses the same parameters as ``flow create``, their format is
3580 described in `Creating flow rules`_.
3582 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3583 index 6 is supported::
3585 testpmd> flow validate 0 ingress pattern eth / end
3586 actions queue index 6 / end
3590 Port 0 does not support TCPv6 rules::
3592 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3594 Caught error type 9 (specific pattern item): Invalid argument
3600 ``flow create`` validates and creates the specified flow rule. It is bound
3601 to ``rte_flow_create()``::
3603 flow create {port_id}
3604 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3605 pattern {item} [/ {item} [...]] / end
3606 actions {action} [/ {action} [...]] / end
3608 If successful, it will return a flow rule ID usable with other commands::
3610 Flow rule #[...] created
3612 Otherwise it will show an error message of the form::
3614 Caught error type [...] ([...]): [...]
3616 Parameters describe in the following order:
3618 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3619 - A matching pattern, starting with the *pattern* token and terminated by an
3621 - Actions, starting with the *actions* token and terminated by an *end*
3624 These translate directly to *rte_flow* objects provided as-is to the
3625 underlying functions.
3627 The shortest valid definition only comprises mandatory tokens::
3629 testpmd> flow create 0 pattern end actions end
3631 Note that PMDs may refuse rules that essentially do nothing such as this
3634 **All unspecified object values are automatically initialized to 0.**
3639 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3640 specified before the ``pattern`` token.
3642 - ``group {group id}``: priority group.
3643 - ``priority {level}``: priority level within group.
3644 - ``ingress``: rule applies to ingress traffic.
3645 - ``egress``: rule applies to egress traffic.
3646 - ``transfer``: apply rule directly to endpoints found in pattern.
3648 Each instance of an attribute specified several times overrides the previous
3649 value as shown below (group 4 is used)::
3651 testpmd> flow create 0 group 42 group 24 group 4 [...]
3653 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3655 While not specifying a direction is an error, some rules may allow both
3658 Most rules affect RX therefore contain the ``ingress`` token::
3660 testpmd> flow create 0 ingress pattern [...]
3665 A matching pattern starts after the ``pattern`` token. It is made of pattern
3666 items and is terminated by a mandatory ``end`` item.
3668 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3669 rte_flow_item_type``).
3671 The ``/`` token is used as a separator between pattern items as shown
3674 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3676 Note that protocol items like these must be stacked from lowest to highest
3677 layer to make sense. For instance, the following rule is either invalid or
3678 unlikely to match any packet::
3680 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3682 More information on these restrictions can be found in the *rte_flow*
3685 Several items support additional specification structures, for example
3686 ``ipv4`` allows specifying source and destination addresses as follows::
3688 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3689 dst is 10.2.0.0 / end [...]
3691 This rule matches all IPv4 traffic with the specified properties.
3693 In this example, ``src`` and ``dst`` are field names of the underlying
3694 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3695 in a similar fashion.
3697 The ``is`` token means that the subsequent value must be matched exactly,
3698 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3699 accordingly. Possible assignment tokens are:
3701 - ``is``: match value perfectly (with full bit-mask).
3702 - ``spec``: match value according to configured bit-mask.
3703 - ``last``: specify upper bound to establish a range.
3704 - ``mask``: specify bit-mask with relevant bits set to one.
3705 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3707 These yield identical results::
3709 ipv4 src is 10.1.1.1
3713 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3717 ipv4 src spec 10.1.1.1 src prefix 32
3721 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3725 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3727 Inclusive ranges can be defined with ``last``::
3729 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3731 Note that ``mask`` affects both ``spec`` and ``last``::
3733 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3734 # matches 10.1.0.0 to 10.2.255.255
3736 Properties can be modified multiple times::
3738 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3742 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3747 This section lists supported pattern items and their attributes, if any.
3749 - ``end``: end list of pattern items.
3751 - ``void``: no-op pattern item.
3753 - ``invert``: perform actions when pattern does not match.
3755 - ``any``: match any protocol for the current layer.
3757 - ``num {unsigned}``: number of layers covered.
3759 - ``pf``: match traffic from/to the physical function.
3761 - ``vf``: match traffic from/to a virtual function ID.
3763 - ``id {unsigned}``: VF ID.
3765 - ``phy_port``: match traffic from/to a specific physical port.
3767 - ``index {unsigned}``: physical port index.
3769 - ``port_id``: match traffic from/to a given DPDK port ID.
3771 - ``id {unsigned}``: DPDK port ID.
3773 - ``mark``: match value set in previously matched flow rule using the mark action.
3775 - ``id {unsigned}``: arbitrary integer value.
3777 - ``raw``: match an arbitrary byte string.
3779 - ``relative {boolean}``: look for pattern after the previous item.
3780 - ``search {boolean}``: search pattern from offset (see also limit).
3781 - ``offset {integer}``: absolute or relative offset for pattern.
3782 - ``limit {unsigned}``: search area limit for start of pattern.
3783 - ``pattern {string}``: byte string to look for.
3785 - ``eth``: match Ethernet header.
3787 - ``dst {MAC-48}``: destination MAC.
3788 - ``src {MAC-48}``: source MAC.
3789 - ``type {unsigned}``: EtherType or TPID.
3791 - ``vlan``: match 802.1Q/ad VLAN tag.
3793 - ``tci {unsigned}``: tag control information.
3794 - ``pcp {unsigned}``: priority code point.
3795 - ``dei {unsigned}``: drop eligible indicator.
3796 - ``vid {unsigned}``: VLAN identifier.
3797 - ``inner_type {unsigned}``: inner EtherType or TPID.
3799 - ``ipv4``: match IPv4 header.
3801 - ``tos {unsigned}``: type of service.
3802 - ``ttl {unsigned}``: time to live.
3803 - ``proto {unsigned}``: next protocol ID.
3804 - ``src {ipv4 address}``: source address.
3805 - ``dst {ipv4 address}``: destination address.
3807 - ``ipv6``: match IPv6 header.
3809 - ``tc {unsigned}``: traffic class.
3810 - ``flow {unsigned}``: flow label.
3811 - ``proto {unsigned}``: protocol (next header).
3812 - ``hop {unsigned}``: hop limit.
3813 - ``src {ipv6 address}``: source address.
3814 - ``dst {ipv6 address}``: destination address.
3816 - ``icmp``: match ICMP header.
3818 - ``type {unsigned}``: ICMP packet type.
3819 - ``code {unsigned}``: ICMP packet code.
3821 - ``udp``: match UDP header.
3823 - ``src {unsigned}``: UDP source port.
3824 - ``dst {unsigned}``: UDP destination port.
3826 - ``tcp``: match TCP header.
3828 - ``src {unsigned}``: TCP source port.
3829 - ``dst {unsigned}``: TCP destination port.
3831 - ``sctp``: match SCTP header.
3833 - ``src {unsigned}``: SCTP source port.
3834 - ``dst {unsigned}``: SCTP destination port.
3835 - ``tag {unsigned}``: validation tag.
3836 - ``cksum {unsigned}``: checksum.
3838 - ``vxlan``: match VXLAN header.
3840 - ``vni {unsigned}``: VXLAN identifier.
3842 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3844 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3846 - ``nvgre``: match NVGRE header.
3848 - ``tni {unsigned}``: virtual subnet ID.
3850 - ``mpls``: match MPLS header.
3852 - ``label {unsigned}``: MPLS label.
3854 - ``gre``: match GRE header.
3856 - ``protocol {unsigned}``: protocol type.
3858 - ``gre_key``: match GRE optional key field.
3860 - ``value {unsigned}``: key value.
3862 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3864 - ``thresh {unsigned}``: accuracy threshold.
3866 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3868 - ``teid {unsigned}``: tunnel endpoint identifier.
3870 - ``geneve``: match GENEVE header.
3872 - ``vni {unsigned}``: virtual network identifier.
3873 - ``protocol {unsigned}``: protocol type.
3875 - ``vxlan-gpe``: match VXLAN-GPE header.
3877 - ``vni {unsigned}``: VXLAN-GPE identifier.
3879 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3881 - ``sha {MAC-48}``: sender hardware address.
3882 - ``spa {ipv4 address}``: sender IPv4 address.
3883 - ``tha {MAC-48}``: target hardware address.
3884 - ``tpa {ipv4 address}``: target IPv4 address.
3886 - ``ipv6_ext``: match presence of any IPv6 extension header.
3888 - ``next_hdr {unsigned}``: next header.
3890 - ``icmp6``: match any ICMPv6 header.
3892 - ``type {unsigned}``: ICMPv6 type.
3893 - ``code {unsigned}``: ICMPv6 code.
3895 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3897 - ``target_addr {ipv6 address}``: target address.
3899 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3901 - ``target_addr {ipv6 address}``: target address.
3903 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3905 - ``type {unsigned}``: ND option type.
3907 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3908 link-layer address option.
3910 - ``sla {MAC-48}``: source Ethernet LLA.
3912 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3913 link-layer address option.
3915 - ``tla {MAC-48}``: target Ethernet LLA.
3917 - ``meta``: match application specific metadata.
3919 - ``data {unsigned}``: metadata value.
3921 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3923 - ``pdu_type {unsigned}``: PDU type.
3924 - ``qfi {unsigned}``: QoS flow identifier.
3926 - ``pppoes``, ``pppoed``: match PPPoE header.
3928 - ``session_id {unsigned}``: session identifier.
3930 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3932 - ``proto_id {unsigned}``: PPP protocol identifier.
3937 A list of actions starts after the ``actions`` token in the same fashion as
3938 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3939 terminated by a mandatory ``end`` action.
3941 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3942 rte_flow_action_type``).
3944 Dropping all incoming UDPv4 packets can be expressed as follows::
3946 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3949 Several actions have configurable properties which must be specified when
3950 there is no valid default value. For example, ``queue`` requires a target
3953 This rule redirects incoming UDPv4 traffic to queue index 6::
3955 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3956 actions queue index 6 / end
3958 While this one could be rejected by PMDs (unspecified queue index)::
3960 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3963 As defined by *rte_flow*, the list is not ordered, all actions of a given
3964 rule are performed simultaneously. These are equivalent::
3966 queue index 6 / void / mark id 42 / end
3970 void / mark id 42 / queue index 6 / end
3972 All actions in a list should have different types, otherwise only the last
3973 action of a given type is taken into account::
3975 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
3979 drop / drop / drop / end # drop is performed only once
3983 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
3985 Considering they are performed simultaneously, opposite and overlapping
3986 actions can sometimes be combined when the end result is unambiguous::
3988 drop / queue index 6 / end # drop has no effect
3992 queue index 6 / rss queues 6 7 8 / end # queue has no effect
3996 drop / passthru / end # drop has no effect
3998 Note that PMDs may still refuse such combinations.
4003 This section lists supported actions and their attributes, if any.
4005 - ``end``: end list of actions.
4007 - ``void``: no-op action.
4009 - ``passthru``: let subsequent rule process matched packets.
4011 - ``jump``: redirect traffic to group on device.
4013 - ``group {unsigned}``: group to redirect to.
4015 - ``mark``: attach 32 bit value to packets.
4017 - ``id {unsigned}``: 32 bit value to return with packets.
4019 - ``flag``: flag packets.
4021 - ``queue``: assign packets to a given queue index.
4023 - ``index {unsigned}``: queue index to use.
4025 - ``drop``: drop packets (note: passthru has priority).
4027 - ``count``: enable counters for this rule.
4029 - ``rss``: spread packets among several queues.
4031 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4032 the same as `set_hash_global_config`_.
4034 - ``level {unsigned}``: encapsulation level for ``types``.
4036 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4037 tokens are the same as `set_hash_input_set`_, except that an empty list
4038 does not disable RSS but instead requests unspecified "best-effort"
4041 - ``key {string}``: RSS hash key, overrides ``key_len``.
4043 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4044 conjunction with ``key`` to pad or truncate it.
4046 - ``queues [{unsigned} [...]] end``: queue indices to use.
4048 - ``pf``: direct traffic to physical function.
4050 - ``vf``: direct traffic to a virtual function ID.
4052 - ``original {boolean}``: use original VF ID if possible.
4053 - ``id {unsigned}``: VF ID.
4055 - ``phy_port``: direct packets to physical port index.
4057 - ``original {boolean}``: use original port index if possible.
4058 - ``index {unsigned}``: physical port index.
4060 - ``port_id``: direct matching traffic to a given DPDK port ID.
4062 - ``original {boolean}``: use original DPDK port ID if possible.
4063 - ``id {unsigned}``: DPDK port ID.
4065 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4067 - ``mpls_ttl``: MPLS TTL.
4069 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4071 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4073 - ``nw_ttl``: IP TTL.
4075 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4077 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4079 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4081 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4083 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4085 - ``ethertype``: Ethertype.
4087 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4089 - ``vlan_vid``: VLAN id.
4091 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4093 - ``vlan_pcp``: VLAN priority.
4095 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4097 - ``ethertype``: Ethertype.
4099 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4101 - ``ethertype``: Ethertype.
4103 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4104 is done through `Config VXLAN Encap outer layers`_.
4106 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4107 the VXLAN tunnel network overlay from the matched flow.
4109 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4110 is done through `Config NVGRE Encap outer layers`_.
4112 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4113 the NVGRE tunnel network overlay from the matched flow.
4115 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4116 is done through `Config L2 Encap`_.
4118 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4119 is done through `Config L2 Decap`_.
4121 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4122 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4124 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4125 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4127 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4128 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4130 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4131 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4133 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4135 - ``ipv4_addr``: New IPv4 source address.
4137 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4140 - ``ipv4_addr``: New IPv4 destination address.
4142 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4144 - ``ipv6_addr``: New IPv6 source address.
4146 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4149 - ``ipv6_addr``: New IPv6 destination address.
4151 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4154 - ``port``: New TCP/UDP source port number.
4156 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4159 - ``port``: New TCP/UDP destination port number.
4161 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4164 - ``dec_ttl``: Performs a decrease TTL value action
4166 - ``set_ttl``: Set TTL value with specified value
4167 - ``ttl_value {unsigned}``: The new TTL value to be set
4169 - ``set_mac_src``: set source MAC address
4171 - ``mac_addr {MAC-48}``: new source MAC address
4173 - ``set_mac_dst``: set destination MAC address
4175 - ``mac_addr {MAC-48}``: new destination MAC address
4177 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4179 - ``value {unsigned}``: Value to increase TCP sequence number by.
4181 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4183 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4185 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4187 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4189 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4191 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4193 Destroying flow rules
4194 ~~~~~~~~~~~~~~~~~~~~~
4196 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4197 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4198 times as necessary::
4200 flow destroy {port_id} rule {rule_id} [...]
4202 If successful, it will show::
4204 Flow rule #[...] destroyed
4206 It does not report anything for rule IDs that do not exist. The usual error
4207 message is shown when a rule cannot be destroyed::
4209 Caught error type [...] ([...]): [...]
4211 ``flow flush`` destroys all rules on a device and does not take extra
4212 arguments. It is bound to ``rte_flow_flush()``::
4214 flow flush {port_id}
4216 Any errors are reported as above.
4218 Creating several rules and destroying them::
4220 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4221 actions queue index 2 / end
4222 Flow rule #0 created
4223 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4224 actions queue index 3 / end
4225 Flow rule #1 created
4226 testpmd> flow destroy 0 rule 0 rule 1
4227 Flow rule #1 destroyed
4228 Flow rule #0 destroyed
4231 The same result can be achieved using ``flow flush``::
4233 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4234 actions queue index 2 / end
4235 Flow rule #0 created
4236 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4237 actions queue index 3 / end
4238 Flow rule #1 created
4239 testpmd> flow flush 0
4242 Non-existent rule IDs are ignored::
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 42 rule 10 rule 2
4252 testpmd> flow destroy 0 rule 0
4253 Flow rule #0 destroyed
4259 ``flow query`` queries a specific action of a flow rule having that
4260 ability. Such actions collect information that can be reported using this
4261 command. It is bound to ``rte_flow_query()``::
4263 flow query {port_id} {rule_id} {action}
4265 If successful, it will display either the retrieved data for known actions
4266 or the following message::
4268 Cannot display result for action type [...] ([...])
4270 Otherwise, it will complain either that the rule does not exist or that some
4273 Flow rule #[...] not found
4277 Caught error type [...] ([...]): [...]
4279 Currently only the ``count`` action is supported. This action reports the
4280 number of packets that hit the flow rule and the total number of bytes. Its
4281 output has the following format::
4284 hits_set: [...] # whether "hits" contains a valid value
4285 bytes_set: [...] # whether "bytes" contains a valid value
4286 hits: [...] # number of packets
4287 bytes: [...] # number of bytes
4289 Querying counters for TCPv6 packets redirected to queue 6::
4291 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4292 actions queue index 6 / count / end
4293 Flow rule #4 created
4294 testpmd> flow query 0 4 count
4305 ``flow list`` lists existing flow rules sorted by priority and optionally
4306 filtered by group identifiers::
4308 flow list {port_id} [group {group_id}] [...]
4310 This command only fails with the following message if the device does not
4315 Output consists of a header line followed by a short description of each
4316 flow rule, one per line. There is no output at all when no flow rules are
4317 configured on the device::
4319 ID Group Prio Attr Rule
4320 [...] [...] [...] [...] [...]
4322 ``Attr`` column flags:
4324 - ``i`` for ``ingress``.
4325 - ``e`` for ``egress``.
4327 Creating several flow rules and listing them::
4329 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4330 actions queue index 6 / end
4331 Flow rule #0 created
4332 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4333 actions queue index 2 / end
4334 Flow rule #1 created
4335 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4336 actions rss queues 6 7 8 end / end
4337 Flow rule #2 created
4338 testpmd> flow list 0
4339 ID Group Prio Attr Rule
4340 0 0 0 i- ETH IPV4 => QUEUE
4341 1 0 0 i- ETH IPV6 => QUEUE
4342 2 0 5 i- ETH IPV4 UDP => RSS
4345 Rules are sorted by priority (i.e. group ID first, then priority level)::
4347 testpmd> flow list 1
4348 ID Group Prio Attr Rule
4349 0 0 0 i- ETH => COUNT
4350 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4351 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4352 1 24 0 i- ETH IPV4 UDP => QUEUE
4353 4 24 10 i- ETH IPV4 TCP => DROP
4354 3 24 20 i- ETH IPV4 => DROP
4355 2 24 42 i- ETH IPV4 UDP => QUEUE
4356 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4359 Output can be limited to specific groups::
4361 testpmd> flow list 1 group 0 group 63
4362 ID Group Prio Attr Rule
4363 0 0 0 i- ETH => COUNT
4364 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4365 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4366 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4369 Toggling isolated mode
4370 ~~~~~~~~~~~~~~~~~~~~~~
4372 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4373 must only be injected from the defined flow rules; that no default traffic
4374 is expected outside those rules and the driver is free to assign more
4375 resources to handle them. It is bound to ``rte_flow_isolate()``::
4377 flow isolate {port_id} {boolean}
4379 If successful, enabling or disabling isolated mode shows either::
4381 Ingress traffic on port [...]
4382 is now restricted to the defined flow rules
4386 Ingress traffic on port [...]
4387 is not restricted anymore to the defined flow rules
4389 Otherwise, in case of error::
4391 Caught error type [...] ([...]): [...]
4393 Mainly due to its side effects, PMDs supporting this mode may not have the
4394 ability to toggle it more than once without reinitializing affected ports
4395 first (e.g. by exiting testpmd).
4397 Enabling isolated mode::
4399 testpmd> flow isolate 0 true
4400 Ingress traffic on port 0 is now restricted to the defined flow rules
4403 Disabling isolated mode::
4405 testpmd> flow isolate 0 false
4406 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4409 Sample QinQ flow rules
4410 ~~~~~~~~~~~~~~~~~~~~~~
4412 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4414 testpmd> port stop 0
4415 testpmd> vlan set qinq_strip on 0
4417 The above command sets the inner and outer TPID's to 0x8100.
4419 To change the TPID's the following commands should be used::
4421 testpmd> vlan set outer tpid 0xa100 0
4422 testpmd> vlan set inner tpid 0x9100 0
4423 testpmd> port start 0
4425 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4429 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4430 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4431 Flow rule #0 validated
4433 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4434 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4435 Flow rule #0 created
4437 testpmd> flow list 0
4438 ID Group Prio Attr Rule
4439 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4441 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4445 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4446 vlan tci is 654 / end actions pf / queue index 0 / end
4447 Flow rule #1 validated
4449 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4450 vlan tci is 654 / end actions pf / queue index 1 / end
4451 Flow rule #1 created
4453 testpmd> flow list 0
4454 ID Group Prio Attr Rule
4455 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4456 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4458 Sample VXLAN encapsulation rule
4459 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4461 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4462 source code, those can be changed by using the following commands
4464 IPv4 VXLAN outer header::
4466 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4467 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4468 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4471 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4472 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4473 eth-dst 22:22:22:22:22:22
4474 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4477 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4478 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4479 eth-dst 22:22:22:22:22:22
4480 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4483 IPv6 VXLAN outer header::
4485 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4486 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4487 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4490 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4491 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4492 eth-dst 22:22:22:22:22:22
4493 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4496 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4497 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4498 eth-dst 22:22:22:22:22:22
4499 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4502 Sample NVGRE encapsulation rule
4503 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4505 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4506 source code, those can be changed by using the following commands
4508 IPv4 NVGRE outer header::
4510 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4511 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4512 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4515 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4516 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4517 eth-dst 22:22:22:22:22:22
4518 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4521 IPv6 NVGRE outer header::
4523 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4524 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4525 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4528 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4529 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4530 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4533 Sample L2 encapsulation rule
4534 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4536 L2 encapsulation has default value pre-configured in testpmd
4537 source code, those can be changed by using the following commands
4541 testpmd> set l2_encap ip-version ipv4
4542 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4543 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4544 mplsoudp_decap / l2_encap / end
4546 L2 with VXLAN header::
4548 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4549 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4550 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4551 mplsoudp_decap / l2_encap / end
4553 Sample L2 decapsulation rule
4554 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4556 L2 decapsulation has default value pre-configured in testpmd
4557 source code, those can be changed by using the following commands
4561 testpmd> set l2_decap
4562 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4565 L2 with VXLAN header::
4567 testpmd> set l2_encap-with-vlan
4568 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4571 Sample MPLSoGRE encapsulation rule
4572 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4574 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4575 source code, those can be changed by using the following commands
4577 IPv4 MPLSoGRE outer header::
4579 testpmd> set mplsogre_encap ip-version ipv4 label 4
4580 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4581 eth-dst 22:22:22:22:22:22
4582 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4583 mplsogre_encap / end
4585 IPv4 MPLSoGRE with VLAN outer header::
4587 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4588 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4589 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4590 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4591 mplsogre_encap / end
4593 IPv6 MPLSoGRE outer header::
4595 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4596 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4597 eth-dst 22:22:22:22:22:22
4598 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4599 mplsogre_encap / end
4601 IPv6 MPLSoGRE with VLAN outer header::
4603 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4604 ip-src ::1 ip-dst ::2222 vlan-tci 34
4605 eth-src 11:11:11:11:11:11 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 Sample MPLSoGRE decapsulation rule
4610 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4612 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4613 source code, those can be changed by using the following commands
4615 IPv4 MPLSoGRE outer header::
4617 testpmd> set mplsogre_decap ip-version ipv4
4618 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4619 mplsogre_decap / l2_encap / end
4621 IPv4 MPLSoGRE with VLAN outer header::
4623 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4624 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4625 actions mplsogre_decap / l2_encap / end
4627 IPv6 MPLSoGRE outer header::
4629 testpmd> set mplsogre_decap ip-version ipv6
4630 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4631 actions mplsogre_decap / l2_encap / end
4633 IPv6 MPLSoGRE with VLAN outer header::
4635 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4636 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4637 actions mplsogre_decap / l2_encap / end
4639 Sample MPLSoUDP encapsulation rule
4640 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4642 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4643 source code, those can be changed by using the following commands
4645 IPv4 MPLSoUDP outer header::
4647 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4648 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4649 eth-dst 22:22:22:22:22:22
4650 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4651 mplsoudp_encap / end
4653 IPv4 MPLSoUDP with VLAN outer header::
4655 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4656 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4657 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4658 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4659 mplsoudp_encap / end
4661 IPv6 MPLSoUDP outer header::
4663 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4664 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4665 eth-dst 22:22:22:22:22:22
4666 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4667 mplsoudp_encap / end
4669 IPv6 MPLSoUDP with VLAN outer header::
4671 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4672 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4673 eth-src 11:11:11:11:11:11 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 Sample MPLSoUDP decapsulation rule
4678 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4680 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4681 source code, those can be changed by using the following commands
4683 IPv4 MPLSoUDP outer header::
4685 testpmd> set mplsoudp_decap ip-version ipv4
4686 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4687 mplsoudp_decap / l2_encap / end
4689 IPv4 MPLSoUDP with VLAN outer header::
4691 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4692 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4693 actions mplsoudp_decap / l2_encap / end
4695 IPv6 MPLSoUDP outer header::
4697 testpmd> set mplsoudp_decap ip-version ipv6
4698 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4699 actions mplsoudp_decap / l2_encap / end
4701 IPv6 MPLSoUDP with VLAN outer header::
4703 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4704 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4705 actions mplsoudp_decap / l2_encap / end
4707 Sample Raw encapsulation rule
4708 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4710 Raw encapsulation configuration can be set by the following commands
4712 Eecapsulating VxLAN::
4714 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4715 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4717 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4718 raw_encap index 4 / end
4720 Sample Raw decapsulation rule
4721 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4723 Raw decapsulation configuration can be set by the following commands
4725 Decapsulating VxLAN::
4727 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4728 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4729 end actions raw_decap / queue index 0 / end
4734 The following sections show functions to load/unload eBPF based filters.
4739 Load an eBPF program as a callback for particular RX/TX queue::
4741 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4743 The available load-flags are:
4745 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4747 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4753 You'll need clang v3.7 or above to build bpf program you'd like to load
4757 .. code-block:: console
4760 clang -O2 -target bpf -c t1.c
4762 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4764 .. code-block:: console
4766 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4768 To load (not JITed) t1.o at TX queue 0, port 0:
4770 .. code-block:: console
4772 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4777 Unload previously loaded eBPF program for particular RX/TX queue::
4779 testpmd> bpf-unload rx|tx (portid) (queueid)
4781 For example to unload BPF filter from TX queue 0, port 0:
4783 .. code-block:: console
4785 testpmd> bpf-unload tx 0 0