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 Configuration Functions
549 -----------------------
551 The testpmd application can be configured from the runtime as well as from the command-line.
553 This section details the available configuration functions that are available.
557 Configuration changes only become active when forwarding is started/restarted.
562 Reset forwarding to the default configuration::
569 Set the debug verbosity level::
571 testpmd> set verbose (level)
573 Available levels are as following:
575 * ``0`` silent except for error.
576 * ``1`` fully verbose except for Tx packets.
577 * ``2`` fully verbose except for Rx packets.
578 * ``> 2`` fully verbose.
583 Set the log level for a log type::
585 testpmd> set log global|(type) (level)
589 * ``type`` is the log name.
591 * ``level`` is the log level.
593 For example, to change the global log level::
595 testpmd> set log global (level)
597 Regexes can also be used for type. To change log level of user1, user2 and user3::
599 testpmd> set log user[1-3] (level)
604 Set the number of ports used by the application:
608 This is equivalent to the ``--nb-ports`` command-line option.
613 Set the number of cores used by the application::
615 testpmd> set nbcore (num)
617 This is equivalent to the ``--nb-cores`` command-line option.
621 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
626 Set the forwarding cores hexadecimal mask::
628 testpmd> set coremask (mask)
630 This is equivalent to the ``--coremask`` command-line option.
634 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
639 Set the forwarding ports hexadecimal mask::
641 testpmd> set portmask (mask)
643 This is equivalent to the ``--portmask`` command-line option.
648 Set number of packets per burst::
650 testpmd> set burst (num)
652 This is equivalent to the ``--burst command-line`` option.
654 When retry is enabled, the transmit delay time and number of retries can also be set::
656 testpmd> set burst tx delay (microseconds) retry (num)
661 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
663 testpmd> set txpkts (x[,y]*)
665 Where x[,y]* represents a CSV list of values, without white space.
670 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
672 testpmd> set txsplit (off|on|rand)
676 * ``off`` disable packet copy & split for CSUM mode.
678 * ``on`` split outgoing packet into multiple segments. Size of each segment
679 and number of segments per packet is determined by ``set txpkts`` command
682 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
687 Set the list of forwarding cores::
689 testpmd> set corelist (x[,y]*)
691 For example, to change the forwarding cores:
693 .. code-block:: console
695 testpmd> set corelist 3,1
696 testpmd> show config fwd
698 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
699 Logical Core 3 (socket 0) forwards packets on 1 streams:
700 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
701 Logical Core 1 (socket 0) forwards packets on 1 streams:
702 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
706 The cores are used in the same order as specified on the command line.
711 Set the list of forwarding ports::
713 testpmd> set portlist (x[,y]*)
715 For example, to change the port forwarding:
717 .. code-block:: console
719 testpmd> set portlist 0,2,1,3
720 testpmd> show config fwd
722 io packet forwarding - ports=4 - cores=1 - streams=4
723 Logical Core 3 (socket 0) forwards packets on 4 streams:
724 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
725 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
726 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
727 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
732 Select how to retrieve new ports created after "port attach" command::
734 testpmd> set port setup on (iterator|event)
736 For each new port, a setup is done.
737 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
738 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
743 Enable/disable tx loopback::
745 testpmd> set tx loopback (port_id) (on|off)
750 set drop enable bit for all queues::
752 testpmd> set all queues drop (port_id) (on|off)
754 set split drop enable (for VF)
755 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
757 set split drop enable bit for VF from PF::
759 testpmd> set vf split drop (port_id) (vf_id) (on|off)
761 set mac antispoof (for VF)
762 ~~~~~~~~~~~~~~~~~~~~~~~~~~
764 Set mac antispoof for a VF from the PF::
766 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
771 Enable/disable MACsec offload::
773 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
774 testpmd> set macsec offload (port_id) off
779 Configure MACsec secure connection (SC)::
781 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
785 The pi argument is ignored for tx.
786 Check the NIC Datasheet for hardware limits.
791 Configure MACsec secure association (SA)::
793 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
797 The IDX value must be 0 or 1.
798 Check the NIC Datasheet for hardware limits.
800 set broadcast mode (for VF)
801 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
803 Set broadcast mode for a VF from the PF::
805 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
810 Set the VLAN strip for a queue on a port::
812 testpmd> vlan set stripq (on|off) (port_id,queue_id)
814 vlan set stripq (for VF)
815 ~~~~~~~~~~~~~~~~~~~~~~~~
817 Set VLAN strip for all queues in a pool for a VF from the PF::
819 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
821 vlan set insert (for VF)
822 ~~~~~~~~~~~~~~~~~~~~~~~~
824 Set VLAN insert for a VF from the PF::
826 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
828 vlan set tag (for VF)
829 ~~~~~~~~~~~~~~~~~~~~~
831 Set VLAN tag for a VF from the PF::
833 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
835 vlan set antispoof (for VF)
836 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
838 Set VLAN antispoof for a VF from the PF::
840 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
842 vlan set (strip|filter|qinq_strip|extend)
843 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
844 Set the VLAN strip/filter/QinQ strip/extend on for a port::
846 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
851 Set the inner or outer VLAN TPID for packet filtering on a port::
853 testpmd> vlan set (inner|outer) tpid (value) (port_id)
857 TPID value must be a 16-bit number (value <= 65536).
862 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
864 testpmd> rx_vlan add (vlan_id|all) (port_id)
868 VLAN filter must be set on that port. VLAN ID < 4096.
869 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
870 in VFTA table. This is important if enabling all vlan_ids.
875 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
877 testpmd> rx_vlan rm (vlan_id|all) (port_id)
882 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
884 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
889 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
891 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
896 Add a tunnel filter on a port::
898 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
899 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
900 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
902 The available information categories are:
904 * ``vxlan``: Set tunnel type as VXLAN.
906 * ``nvgre``: Set tunnel type as NVGRE.
908 * ``ipingre``: Set tunnel type as IP-in-GRE.
910 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
912 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
914 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
916 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
918 * ``imac``: Set filter type as Inner MAC.
920 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
922 * ``oip``: Set filter type as Outer IP.
924 * ``iip``: Set filter type as Inner IP.
928 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
929 192.168.2.2 0 ipingre oip 1 1
931 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
936 Remove a tunnel filter on a port::
938 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
939 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
940 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
945 Add an UDP port for VXLAN packet filter on a port::
947 testpmd> rx_vxlan_port add (udp_port) (port_id)
952 Remove an UDP port for VXLAN packet filter on a port::
954 testpmd> rx_vxlan_port rm (udp_port) (port_id)
959 Set hardware insertion of VLAN IDs in packets sent on a port::
961 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
963 For example, set a single VLAN ID (5) insertion on port 0::
967 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
975 Set port based hardware insertion of VLAN ID in packets sent on a port::
977 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
982 Disable hardware insertion of a VLAN header in packets sent on a port::
984 testpmd> tx_vlan reset (port_id)
989 Select hardware or software calculation of the checksum when
990 transmitting a packet using the ``csum`` forwarding engine::
992 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
996 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
998 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
999 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
1000 supported). See also the ``csum parse-tunnel`` command.
1002 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1003 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
1004 supported). See also the ``csum parse-tunnel`` command.
1008 Check the NIC Datasheet for hardware limits.
1013 Set RSS queue region span on a port::
1015 testpmd> set port (port_id) queue-region region_id (value) \
1016 queue_start_index (value) queue_num (value)
1018 Set flowtype mapping on a RSS queue region on a port::
1020 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1024 * For the flowtype(pctype) of packet,the specific index for each type has
1025 been defined in file i40e_type.h as enum i40e_filter_pctype.
1027 Set user priority mapping on a RSS queue region on a port::
1029 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1031 Flush all queue region related configuration on a port::
1033 testpmd> set port (port_id) queue-region flush (on|off)
1037 * ``on``: is just an enable function which server for other configuration,
1038 it is for all configuration about queue region from up layer,
1039 at first will only keep in DPDK software stored in driver,
1040 only after "flush on", it commit all configuration to HW.
1042 * ``"off``: is just clean all configuration about queue region just now,
1043 and restore all to DPDK i40e driver default config when start up.
1045 Show all queue region related configuration info on a port::
1047 testpmd> show port (port_id) queue-region
1051 Queue region only support on PF by now, so these command is
1052 only for configuration of queue region on PF port.
1057 Define how tunneled packets should be handled by the csum forward
1060 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1062 If enabled, the csum forward engine will try to recognize supported
1063 tunnel headers (vxlan, gre, ipip).
1065 If disabled, treat tunnel packets as non-tunneled packets (a inner
1066 header is handled as a packet payload).
1070 The port argument is the TX port like in the ``csum set`` command.
1074 Consider a packet in packet like the following::
1076 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1078 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1079 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1080 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1082 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1083 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1088 Display tx checksum offload configuration::
1090 testpmd> csum show (port_id)
1095 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1097 testpmd> tso set (segsize) (port_id)
1101 Check the NIC datasheet for hardware limits.
1106 Display the status of TCP Segmentation Offload::
1108 testpmd> tso show (port_id)
1113 Set tso segment size of tunneled packets for a port in csum engine::
1115 testpmd> tunnel_tso set (tso_segsz) (port_id)
1120 Display the status of tunneled TCP Segmentation Offload for a port::
1122 testpmd> tunnel_tso show (port_id)
1127 Enable or disable GRO in ``csum`` forwarding engine::
1129 testpmd> set port <port_id> gro on|off
1131 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1132 packets received from the given port.
1134 If disabled, packets received from the given port won't be performed
1135 GRO. By default, GRO is disabled for all ports.
1139 When enable GRO for a port, TCP/IPv4 packets received from the port
1140 will be performed GRO. After GRO, all merged packets have bad
1141 checksums, since the GRO library doesn't re-calculate checksums for
1142 the merged packets. Therefore, if users want the merged packets to
1143 have correct checksums, please select HW IP checksum calculation and
1144 HW TCP checksum calculation for the port which the merged packets are
1150 Display GRO configuration for a given port::
1152 testpmd> show port <port_id> gro
1157 Set the cycle to flush the GROed packets from reassembly tables::
1159 testpmd> set gro flush <cycles>
1161 When enable GRO, the csum forwarding engine performs GRO on received
1162 packets, and the GROed packets are stored in reassembly tables. Users
1163 can use this command to determine when the GROed packets are flushed
1164 from the reassembly tables.
1166 The ``cycles`` is measured in GRO operation times. The csum forwarding
1167 engine flushes the GROed packets from the tables every ``cycles`` GRO
1170 By default, the value of ``cycles`` is 1, which means flush GROed packets
1171 from the reassembly tables as soon as one GRO operation finishes. The value
1172 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1174 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1175 stack performance. Because the GROed packets are delayed to arrive the
1176 stack, thus causing more duplicated ACKs and TCP retransmissions.
1181 Toggle per-port GSO support in ``csum`` forwarding engine::
1183 testpmd> set port <port_id> gso on|off
1185 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1186 packets, transmitted on the given port.
1188 If disabled, packets transmitted on the given port will not undergo GSO.
1189 By default, GSO is disabled for all ports.
1193 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1194 port undergo GSO. Afterwards, the segmented packets are represented by
1195 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1196 of checksums for GSO'd segments in SW. As a result, if users want correct
1197 checksums in GSO segments, they should enable HW checksum calculation for
1200 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1201 by setting the following options in the csum forwarding engine:
1203 testpmd> csum set outer_ip hw <port_id>
1205 testpmd> csum set ip hw <port_id>
1207 testpmd> csum set tcp hw <port_id>
1209 UDP GSO is the same as IP fragmentation, which treats the UDP header
1210 as the payload and does not modify it during segmentation. That is,
1211 after UDP GSO, only the first output fragment has the original UDP
1212 header. Therefore, users need to enable HW IP checksum calculation
1213 and SW UDP checksum calculation for GSO-enabled ports, if they want
1214 correct checksums for UDP/IPv4 packets.
1219 Set the maximum GSO segment size (measured in bytes), which includes the
1220 packet header and the packet payload for GSO-enabled ports (global)::
1222 testpmd> set gso segsz <length>
1227 Display the status of Generic Segmentation Offload for a given port::
1229 testpmd> show port <port_id> gso
1234 Add an alternative MAC address to a port::
1236 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1241 Remove a MAC address from a port::
1243 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1248 To add the multicast MAC address to/from the set of multicast addresses
1251 testpmd> mcast_addr add (port_id) (mcast_addr)
1256 To remove the multicast MAC address to/from the set of multicast addresses
1259 testpmd> mcast_addr remove (port_id) (mcast_addr)
1261 mac_addr add (for VF)
1262 ~~~~~~~~~~~~~~~~~~~~~
1264 Add an alternative MAC address for a VF to a port::
1266 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1271 Set the default MAC address for a port::
1273 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1275 mac_addr set (for VF)
1276 ~~~~~~~~~~~~~~~~~~~~~
1278 Set the MAC address for a VF from the PF::
1280 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1285 Set the forwarding peer address for certain port::
1287 testpmd> set eth-peer (port_id) (peer_addr)
1289 This is equivalent to the ``--eth-peer`` command-line option.
1294 Set the unicast hash filter(s) on/off for a port::
1296 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1301 Set the promiscuous mode on for a port or for all ports.
1302 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1304 testpmd> set promisc (port_id|all) (on|off)
1309 Set the allmulti mode for a port or for all ports::
1311 testpmd> set allmulti (port_id|all) (on|off)
1313 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1315 set promisc (for VF)
1316 ~~~~~~~~~~~~~~~~~~~~
1318 Set the unicast promiscuous mode for a VF from PF.
1319 It's supported by Intel i40e NICs now.
1320 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1322 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1324 set allmulticast (for VF)
1325 ~~~~~~~~~~~~~~~~~~~~~~~~~
1327 Set the multicast promiscuous mode for a VF from PF.
1328 It's supported by Intel i40e NICs now.
1329 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1331 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1333 set tx max bandwidth (for VF)
1334 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1336 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1338 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1340 set tc tx min bandwidth (for VF)
1341 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1343 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1345 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1347 set tc tx max bandwidth (for VF)
1348 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1350 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1352 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1354 set tc strict link priority mode
1355 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1357 Set some TCs' strict link priority mode on a physical port::
1359 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1361 set tc tx min bandwidth
1362 ~~~~~~~~~~~~~~~~~~~~~~~
1364 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1366 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1371 Set the link flow control parameter on a port::
1373 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1374 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1375 autoneg (on|off) (port_id)
1379 * ``high_water`` (integer): High threshold value to trigger XOFF.
1381 * ``low_water`` (integer): Low threshold value to trigger XON.
1383 * ``pause_time`` (integer): Pause quota in the Pause frame.
1385 * ``send_xon`` (0/1): Send XON frame.
1387 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1389 * ``autoneg``: Change the auto-negotiation parameter.
1394 Set the priority flow control parameter on a port::
1396 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1397 (pause_time) (priority) (port_id)
1401 * ``high_water`` (integer): High threshold value.
1403 * ``low_water`` (integer): Low threshold value.
1405 * ``pause_time`` (integer): Pause quota in the Pause frame.
1407 * ``priority`` (0-7): VLAN User Priority.
1412 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1414 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1416 For example, to set rx queue 2 on port 0 to mapping 5::
1418 testpmd>set stat_qmap rx 0 2 5
1420 set xstats-hide-zero
1421 ~~~~~~~~~~~~~~~~~~~~
1423 Set the option to hide zero values for xstats display::
1425 testpmd> set xstats-hide-zero on|off
1429 By default, the zero values are displayed for xstats.
1431 set port - rx/tx (for VF)
1432 ~~~~~~~~~~~~~~~~~~~~~~~~~
1434 Set VF receive/transmit from a port::
1436 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1438 set port - mac address filter (for VF)
1439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1441 Add/Remove unicast or multicast MAC addr filter for a VF::
1443 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1444 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1446 set port - rx mode(for VF)
1447 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1449 Set the VF receive mode of a port::
1451 testpmd> set port (port_id) vf (vf_id) \
1452 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1454 The available receive modes are:
1456 * ``AUPE``: Accepts untagged VLAN.
1458 * ``ROPE``: Accepts unicast hash.
1460 * ``BAM``: Accepts broadcast packets.
1462 * ``MPE``: Accepts all multicast packets.
1464 set port - tx_rate (for Queue)
1465 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1467 Set TX rate limitation for a queue on a port::
1469 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1471 set port - tx_rate (for VF)
1472 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1474 Set TX rate limitation for queues in VF on a port::
1476 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1478 set port - mirror rule
1479 ~~~~~~~~~~~~~~~~~~~~~~
1481 Set pool or vlan type mirror rule for a port::
1483 testpmd> set port (port_id) mirror-rule (rule_id) \
1484 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1485 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1487 Set link mirror rule for a port::
1489 testpmd> set port (port_id) mirror-rule (rule_id) \
1490 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1492 For example to enable mirror traffic with vlan 0,1 to pool 0::
1494 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1496 reset port - mirror rule
1497 ~~~~~~~~~~~~~~~~~~~~~~~~
1499 Reset a mirror rule for a port::
1501 testpmd> reset port (port_id) mirror-rule (rule_id)
1506 Set the flush on RX streams before forwarding.
1507 The default is flush ``on``.
1508 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1510 testpmd> set flush_rx off
1515 Set the bypass mode for the lowest port on bypass enabled NIC::
1517 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1522 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1524 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1525 mode (normal|bypass|isolate) (port_id)
1529 * ``timeout``: Enable bypass after watchdog timeout.
1531 * ``os_on``: Enable bypass when OS/board is powered on.
1533 * ``os_off``: Enable bypass when OS/board is powered off.
1535 * ``power_on``: Enable bypass when power supply is turned on.
1537 * ``power_off``: Enable bypass when power supply is turned off.
1543 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1545 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1550 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1552 testpmd> show bypass config (port_id)
1557 Set link up for a port::
1559 testpmd> set link-up port (port id)
1564 Set link down for a port::
1566 testpmd> set link-down port (port id)
1571 Enable E-tag insertion for a VF on a port::
1573 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1575 Disable E-tag insertion for a VF on a port::
1577 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1579 Enable/disable E-tag stripping on a port::
1581 testpmd> E-tag set stripping (on|off) port (port_id)
1583 Enable/disable E-tag based forwarding on a port::
1585 testpmd> E-tag set forwarding (on|off) port (port_id)
1587 Add an E-tag forwarding filter on a port::
1589 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1591 Delete an E-tag forwarding filter on a port::
1592 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1597 Load a dynamic device personalization (DDP) profile and store backup profile::
1599 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1604 Delete a dynamic device personalization profile and restore backup profile::
1606 testpmd> ddp del (port_id) (backup_profile_path)
1611 List all items from the ptype mapping table::
1613 testpmd> ptype mapping get (port_id) (valid_only)
1617 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1619 Replace a specific or a group of software defined ptype with a new one::
1621 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1625 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1627 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1629 * ``pkt_type``: The new software ptype to replace the old ones.
1631 Update hardware defined ptype to software defined packet type mapping table::
1633 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1637 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1639 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1641 Reset ptype mapping table::
1643 testpmd> ptype mapping reset (port_id)
1645 config per port Rx offloading
1646 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1648 Enable or disable a per port Rx offloading on all Rx queues of a port::
1650 testpmd> port config (port_id) rx_offload (offloading) on|off
1652 * ``offloading``: can be any of these offloading capability:
1653 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1654 qinq_strip, outer_ipv4_cksum, macsec_strip,
1655 header_split, vlan_filter, vlan_extend, jumbo_frame,
1656 crc_strip, scatter, timestamp, security, keep_crc
1658 This command should be run when the port is stopped, or else it will fail.
1660 config per queue Rx offloading
1661 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1663 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1665 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1667 * ``offloading``: can be any of these offloading capability:
1668 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1669 qinq_strip, outer_ipv4_cksum, macsec_strip,
1670 header_split, vlan_filter, vlan_extend, jumbo_frame,
1671 crc_strip, scatter, timestamp, security, keep_crc
1673 This command should be run when the port is stopped, or else it will fail.
1675 config per port Tx offloading
1676 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1678 Enable or disable a per port Tx offloading on all Tx queues of a port::
1680 testpmd> port config (port_id) tx_offload (offloading) on|off
1682 * ``offloading``: can be any of these offloading capability:
1683 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1684 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1685 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1686 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1687 mt_lockfree, multi_segs, mbuf_fast_free, security,
1690 This command should be run when the port is stopped, or else it will fail.
1692 config per queue Tx offloading
1693 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1695 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1697 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1699 * ``offloading``: can be any of these offloading capability:
1700 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1701 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1702 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1703 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1704 mt_lockfree, multi_segs, mbuf_fast_free, security
1706 This command should be run when the port is stopped, or else it will fail.
1708 Config VXLAN Encap outer layers
1709 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1711 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1713 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1714 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1717 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1718 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1719 eth-src (eth-src) eth-dst (eth-dst)
1721 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1722 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1723 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1725 These commands will set an internal configuration inside testpmd, any following
1726 flow rule using the action vxlan_encap will use the last configuration set.
1727 To have a different encapsulation header, one of those commands must be called
1728 before the flow rule creation.
1730 Config NVGRE Encap outer layers
1731 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1733 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1735 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1736 eth-src (eth-src) eth-dst (eth-dst)
1737 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1738 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1740 These commands will set an internal configuration inside testpmd, any following
1741 flow rule using the action nvgre_encap will use the last configuration set.
1742 To have a different encapsulation header, one of those commands must be called
1743 before the flow rule creation.
1748 Configure the l2 to be used when encapsulating a packet with L2::
1750 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1751 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1752 eth-src (eth-src) eth-dst (eth-dst)
1754 Those commands will set an internal configuration inside testpmd, any following
1755 flow rule using the action l2_encap will use the last configuration set.
1756 To have a different encapsulation header, one of those commands must be called
1757 before the flow rule creation.
1762 Configure the l2 to be removed when decapsulating a packet with L2::
1764 set l2_decap ip-version (ipv4|ipv6)
1765 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1767 Those commands will set an internal configuration inside testpmd, any following
1768 flow rule using the action l2_decap will use the last configuration set.
1769 To have a different encapsulation header, one of those commands must be called
1770 before the flow rule creation.
1772 Config MPLSoGRE Encap outer layers
1773 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1775 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1777 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1778 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1779 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1780 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1781 eth-src (eth-src) eth-dst (eth-dst)
1783 These commands will set an internal configuration inside testpmd, any following
1784 flow rule using the action mplsogre_encap will use the last configuration set.
1785 To have a different encapsulation header, one of those commands must be called
1786 before the flow rule creation.
1788 Config MPLSoGRE Decap outer layers
1789 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1791 Configure the outer layer to decapsulate MPLSoGRE packet::
1793 set mplsogre_decap ip-version (ipv4|ipv6)
1794 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1796 These commands will set an internal configuration inside testpmd, any following
1797 flow rule using the action mplsogre_decap will use the last configuration set.
1798 To have a different decapsulation header, one of those commands must be called
1799 before the flow rule creation.
1801 Config MPLSoUDP Encap outer layers
1802 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1804 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1806 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1807 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1808 eth-src (eth-src) eth-dst (eth-dst)
1809 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1810 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1811 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1813 These commands will set an internal configuration inside testpmd, any following
1814 flow rule using the action mplsoudp_encap will use the last configuration set.
1815 To have a different encapsulation header, one of those commands must be called
1816 before the flow rule creation.
1818 Config MPLSoUDP Decap outer layers
1819 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1821 Configure the outer layer to decapsulate MPLSoUDP packet::
1823 set mplsoudp_decap ip-version (ipv4|ipv6)
1824 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1826 These commands will set an internal configuration inside testpmd, any following
1827 flow rule using the action mplsoudp_decap will use the last configuration set.
1828 To have a different decapsulation header, one of those commands must be called
1829 before the flow rule creation.
1831 Config Raw Encapsulation
1832 ~~~~~~~~~~~~~~~~~~~~~~~~~
1834 Configure the raw data to be used when encapsulating a packet by
1835 rte_flow_action_raw_encap::
1837 set raw_encap {item} [/ {item} [...]] / end_set
1839 This command will set an internal buffer inside testpmd, any following flow rule
1840 using the action raw_encap will use the last configuration set.
1841 To have a different encapsulation header, this command must be called before the
1844 Config Raw Decapsulation
1845 ~~~~~~~~~~~~~~~~~~~~~~~~
1847 Configure the raw data to be used when decapsulating a packet by
1848 rte_flow_action_raw_decap::
1850 set raw_decap {item} [/ {item} [...]] / end_set
1852 This command will set an internal buffer inside testpmd, any following flow rule
1853 using the action raw_decap will use the last configuration set.
1858 The following sections show functions for configuring ports.
1862 Port configuration changes only become active when forwarding is started/restarted.
1867 Attach a port specified by pci address or virtual device args::
1869 testpmd> port attach (identifier)
1871 To attach a new pci device, the device should be recognized by kernel first.
1872 Then it should be moved under DPDK management.
1873 Finally the port can be attached to testpmd.
1875 For example, to move a pci device using ixgbe under DPDK management:
1877 .. code-block:: console
1879 # Check the status of the available devices.
1880 ./usertools/dpdk-devbind.py --status
1882 Network devices using DPDK-compatible driver
1883 ============================================
1886 Network devices using kernel driver
1887 ===================================
1888 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1891 # Bind the device to igb_uio.
1892 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1895 # Recheck the status of the devices.
1896 ./usertools/dpdk-devbind.py --status
1897 Network devices using DPDK-compatible driver
1898 ============================================
1899 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1901 To attach a port created by virtual device, above steps are not needed.
1903 For example, to attach a port whose pci address is 0000:0a:00.0.
1905 .. code-block:: console
1907 testpmd> port attach 0000:0a:00.0
1908 Attaching a new port...
1909 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1910 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1911 EAL: PCI memory mapped at 0x7f83bfa00000
1912 EAL: PCI memory mapped at 0x7f83bfa80000
1913 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1914 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1915 Port 0 is attached. Now total ports is 1
1918 For example, to attach a port created by pcap PMD.
1920 .. code-block:: console
1922 testpmd> port attach net_pcap0
1923 Attaching a new port...
1924 PMD: Initializing pmd_pcap for net_pcap0
1925 PMD: Creating pcap-backed ethdev on numa socket 0
1926 Port 0 is attached. Now total ports is 1
1929 In this case, identifier is ``net_pcap0``.
1930 This identifier format is the same as ``--vdev`` format of DPDK applications.
1932 For example, to re-attach a bonded port which has been previously detached,
1933 the mode and slave parameters must be given.
1935 .. code-block:: console
1937 testpmd> port attach net_bond_0,mode=0,slave=1
1938 Attaching a new port...
1939 EAL: Initializing pmd_bond for net_bond_0
1940 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1941 Port 0 is attached. Now total ports is 1
1948 Detach a specific port::
1950 testpmd> port detach (port_id)
1952 Before detaching a port, the port should be stopped and closed.
1954 For example, to detach a pci device port 0.
1956 .. code-block:: console
1958 testpmd> port stop 0
1961 testpmd> port close 0
1965 testpmd> port detach 0
1967 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1968 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1969 EAL: PCI memory unmapped at 0x7f83bfa00000
1970 EAL: PCI memory unmapped at 0x7f83bfa80000
1974 For example, to detach a virtual device port 0.
1976 .. code-block:: console
1978 testpmd> port stop 0
1981 testpmd> port close 0
1985 testpmd> port detach 0
1987 PMD: Closing pcap ethdev on numa socket 0
1988 Port 'net_pcap0' is detached. Now total ports is 0
1991 To remove a pci device completely from the system, first detach the port from testpmd.
1992 Then the device should be moved under kernel management.
1993 Finally the device can be removed using kernel pci hotplug functionality.
1995 For example, to move a pci device under kernel management:
1997 .. code-block:: console
1999 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2001 ./usertools/dpdk-devbind.py --status
2003 Network devices using DPDK-compatible driver
2004 ============================================
2007 Network devices using kernel driver
2008 ===================================
2009 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2011 To remove a port created by a virtual device, above steps are not needed.
2016 Start all ports or a specific port::
2018 testpmd> port start (port_id|all)
2023 Stop all ports or a specific port::
2025 testpmd> port stop (port_id|all)
2030 Close all ports or a specific port::
2032 testpmd> port close (port_id|all)
2037 Reset all ports or a specific port::
2039 testpmd> port reset (port_id|all)
2041 User should stop port(s) before resetting and (re-)start after reset.
2043 port config - queue ring size
2044 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2046 Configure a rx/tx queue ring size::
2048 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2050 Only take effect after command that (re-)start the port or command that setup specific queue.
2052 port start/stop queue
2053 ~~~~~~~~~~~~~~~~~~~~~
2055 Start/stop a rx/tx queue on a specific port::
2057 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2059 port config - queue deferred start
2060 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2062 Switch on/off deferred start of a specific port queue::
2064 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2067 ~~~~~~~~~~~~~~~~~~~~~
2069 Setup a rx/tx queue on a specific port::
2071 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2073 Only take effect when port is started.
2078 Set the speed and duplex mode for all ports or a specific port::
2080 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
2081 duplex (half|full|auto)
2083 port config - queues/descriptors
2084 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2086 Set number of queues/descriptors for rxq, txq, rxd and txd::
2088 testpmd> port config all (rxq|txq|rxd|txd) (value)
2090 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2092 port config - max-pkt-len
2093 ~~~~~~~~~~~~~~~~~~~~~~~~~
2095 Set the maximum packet length::
2097 testpmd> port config all max-pkt-len (value)
2099 This is equivalent to the ``--max-pkt-len`` command-line option.
2101 port config - Drop Packets
2102 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2104 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2106 testpmd> port config all drop-en (on|off)
2108 Packet dropping when no receive buffers available is off by default.
2110 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2115 Set the RSS (Receive Side Scaling) mode on or off::
2117 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|none)
2119 RSS is on by default.
2121 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
2122 The ``default`` option enables all supported RSS types reported by device info.
2123 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2125 port config - RSS Reta
2126 ~~~~~~~~~~~~~~~~~~~~~~
2128 Set the RSS (Receive Side Scaling) redirection table::
2130 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2135 Set the DCB mode for an individual port::
2137 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2139 The traffic class should be 4 or 8.
2144 Set the number of packets per burst::
2146 testpmd> port config all burst (value)
2148 This is equivalent to the ``--burst`` command-line option.
2150 port config - Threshold
2151 ~~~~~~~~~~~~~~~~~~~~~~~
2153 Set thresholds for TX/RX queues::
2155 testpmd> port config all (threshold) (value)
2157 Where the threshold type can be:
2159 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2161 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2163 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2165 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2167 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2169 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2171 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2173 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2175 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2177 These threshold options are also available from the command-line.
2182 Set the value of ether-type for E-tag::
2184 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2186 Enable/disable the E-tag support::
2188 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2190 port config pctype mapping
2191 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2193 Reset pctype mapping table::
2195 testpmd> port config (port_id) pctype mapping reset
2197 Update hardware defined pctype to software defined flow type mapping table::
2199 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2203 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2205 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2207 port config input set
2208 ~~~~~~~~~~~~~~~~~~~~~
2210 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2212 testpmd> port config (port_id) pctype (pctype_id) \
2213 (hash_inset|fdir_inset|fdir_flx_inset) \
2214 (get|set|clear) field (field_idx)
2216 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2218 testpmd> port config (port_id) pctype (pctype_id) \
2219 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2223 * ``pctype_id``: hardware packet classification types.
2224 * ``field_idx``: hardware field index.
2226 port config udp_tunnel_port
2227 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2229 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2231 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2233 port config tx_metadata
2234 ~~~~~~~~~~~~~~~~~~~~~~~
2236 Set Tx metadata value per port.
2237 testpmd will add this value to any Tx packet sent from this port::
2239 testpmd> port config (port_id) tx_metadata (value)
2244 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2246 testpmd> port config mtu (port_id) (value)
2248 port config rss hash key
2249 ~~~~~~~~~~~~~~~~~~~~~~~~
2251 To configure the RSS hash key used to compute the RSS
2252 hash of input [IP] packets received on port::
2254 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2255 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2256 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2257 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2258 ipv6-udp-ex <string of hex digits \
2259 (variable length, NIC dependent)>)
2264 The following sections show functions for device operations.
2269 Detach a device specified by pci address or virtual device args::
2271 testpmd> device detach (identifier)
2273 Before detaching a device associated with ports, the ports should be stopped and closed.
2275 For example, to detach a pci device whose address is 0002:03:00.0.
2277 .. code-block:: console
2279 testpmd> device detach 0002:03:00.0
2280 Removing a device...
2281 Port 1 is now closed
2282 EAL: Releasing pci mapped resource for 0002:03:00.0
2283 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2284 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2285 Device 0002:03:00.0 is detached
2286 Now total ports is 1
2288 For example, to detach a port created by pcap PMD.
2290 .. code-block:: console
2292 testpmd> device detach net_pcap0
2293 Removing a device...
2294 Port 0 is now closed
2295 Device net_pcap0 is detached
2296 Now total ports is 0
2299 In this case, identifier is ``net_pcap0``.
2300 This identifier format is the same as ``--vdev`` format of DPDK applications.
2302 Link Bonding Functions
2303 ----------------------
2305 The Link Bonding functions make it possible to dynamically create and
2306 manage link bonding devices from within testpmd interactive prompt.
2308 create bonded device
2309 ~~~~~~~~~~~~~~~~~~~~
2311 Create a new bonding device::
2313 testpmd> create bonded device (mode) (socket)
2315 For example, to create a bonded device in mode 1 on socket 0::
2317 testpmd> create bonded device 1 0
2318 created new bonded device (port X)
2323 Adds Ethernet device to a Link Bonding device::
2325 testpmd> add bonding slave (slave id) (port id)
2327 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2329 testpmd> add bonding slave 6 10
2332 remove bonding slave
2333 ~~~~~~~~~~~~~~~~~~~~
2335 Removes an Ethernet slave device from a Link Bonding device::
2337 testpmd> remove bonding slave (slave id) (port id)
2339 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2341 testpmd> remove bonding slave 6 10
2346 Set the Link Bonding mode of a Link Bonding device::
2348 testpmd> set bonding mode (value) (port id)
2350 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2352 testpmd> set bonding mode 3 10
2357 Set an Ethernet slave device as the primary device on a Link Bonding device::
2359 testpmd> set bonding primary (slave id) (port id)
2361 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2363 testpmd> set bonding primary 6 10
2368 Set the MAC address of a Link Bonding device::
2370 testpmd> set bonding mac (port id) (mac)
2372 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2374 testpmd> set bonding mac 10 00:00:00:00:00:01
2376 set bonding xmit_balance_policy
2377 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2379 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2381 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2383 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2385 testpmd> set bonding xmit_balance_policy 10 l34
2388 set bonding mon_period
2389 ~~~~~~~~~~~~~~~~~~~~~~
2391 Set the link status monitoring polling period in milliseconds for a bonding device.
2393 This adds support for PMD slave devices which do not support link status interrupts.
2394 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2395 link status ISR will be queried every polling interval to check if their link status has changed::
2397 testpmd> set bonding mon_period (port_id) (value)
2399 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2401 testpmd> set bonding mon_period 5 150
2404 set bonding lacp dedicated_queue
2405 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2407 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2408 when in mode 4 (link-aggregation-802.3ad)::
2410 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2413 set bonding agg_mode
2414 ~~~~~~~~~~~~~~~~~~~~
2416 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2418 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2424 Show the current configuration of a Link Bonding device::
2426 testpmd> show bonding config (port id)
2429 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2430 in balance mode with a transmission policy of layer 2+3::
2432 testpmd> show bonding config 9
2434 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2436 Active Slaves (3): [1 3 4]
2443 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2444 This is mainly useful for debugging purposes.
2445 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2446 and fields that can be accessed.
2451 Display the value of a port register::
2453 testpmd> read reg (port_id) (address)
2455 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2457 testpmd> read reg 0 0xEE00
2458 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2463 Display a port register bit field::
2465 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2467 For example, reading the lowest two bits from the register in the example above::
2469 testpmd> read regfield 0 0xEE00 0 1
2470 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2475 Display a single port register bit::
2477 testpmd> read regbit (port_id) (address) (bit_x)
2479 For example, reading the lowest bit from the register in the example above::
2481 testpmd> read regbit 0 0xEE00 0
2482 port 0 PCI register at offset 0xEE00: bit 0=1
2487 Set the value of a port register::
2489 testpmd> write reg (port_id) (address) (value)
2491 For example, to clear a register::
2493 testpmd> write reg 0 0xEE00 0x0
2494 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2499 Set bit field of a port register::
2501 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2503 For example, writing to the register cleared in the example above::
2505 testpmd> write regfield 0 0xEE00 0 1 2
2506 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2511 Set single bit value of a port register::
2513 testpmd> write regbit (port_id) (address) (bit_x) (value)
2515 For example, to set the high bit in the register from the example above::
2517 testpmd> write regbit 0 0xEE00 31 1
2518 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2520 Traffic Metering and Policing
2521 -----------------------------
2523 The following section shows functions for configuring traffic metering and
2524 policing on the ethernet device through the use of generic ethdev API.
2526 show port traffic management capability
2527 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2529 Show traffic metering and policing capability of the port::
2531 testpmd> show port meter cap (port_id)
2533 add port meter profile (srTCM rfc2967)
2534 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2536 Add meter profile (srTCM rfc2697) to the ethernet device::
2538 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2543 * ``profile_id``: ID for the meter profile.
2544 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2545 * ``cbs``: Committed Burst Size (CBS) (bytes).
2546 * ``ebs``: Excess Burst Size (EBS) (bytes).
2548 add port meter profile (trTCM rfc2968)
2549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2551 Add meter profile (srTCM rfc2698) to the ethernet device::
2553 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2554 (cir) (pir) (cbs) (pbs)
2558 * ``profile_id``: ID for the meter profile.
2559 * ``cir``: Committed information rate (bytes/second).
2560 * ``pir``: Peak information rate (bytes/second).
2561 * ``cbs``: Committed burst size (bytes).
2562 * ``pbs``: Peak burst size (bytes).
2564 add port meter profile (trTCM rfc4115)
2565 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2567 Add meter profile (trTCM rfc4115) to the ethernet device::
2569 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2570 (cir) (eir) (cbs) (ebs)
2574 * ``profile_id``: ID for the meter profile.
2575 * ``cir``: Committed information rate (bytes/second).
2576 * ``eir``: Excess information rate (bytes/second).
2577 * ``cbs``: Committed burst size (bytes).
2578 * ``ebs``: Excess burst size (bytes).
2580 delete port meter profile
2581 ~~~~~~~~~~~~~~~~~~~~~~~~~
2583 Delete meter profile from the ethernet device::
2585 testpmd> del port meter profile (port_id) (profile_id)
2590 Create new meter object for the ethernet device::
2592 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2593 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2594 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2599 * ``mtr_id``: meter object ID.
2600 * ``profile_id``: ID for the meter profile.
2601 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2602 gets enabled at the time of creation, otherwise remains disabled.
2603 * ``g_action``: Policer action for the packet with green color.
2604 * ``y_action``: Policer action for the packet with yellow color.
2605 * ``r_action``: Policer action for the packet with red color.
2606 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2608 * ``shared``: When this parameter has a non-zero value, the meter object is
2609 shared by multiple flows. Otherwise, meter object is used by single flow.
2610 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2611 input color for the current meter object is determined by the latest meter
2612 object in the same flow. Otherwise, the current meter object uses the
2613 *dscp_table* to determine the input color.
2614 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2615 color, 0 <= x <= 63.
2620 Enable meter for the ethernet device::
2622 testpmd> enable port meter (port_id) (mtr_id)
2627 Disable meter for the ethernet device::
2629 testpmd> disable port meter (port_id) (mtr_id)
2634 Delete meter for the ethernet device::
2636 testpmd> del port meter (port_id) (mtr_id)
2638 Set port meter profile
2639 ~~~~~~~~~~~~~~~~~~~~~~
2641 Set meter profile for the ethernet device::
2643 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2645 set port meter dscp table
2646 ~~~~~~~~~~~~~~~~~~~~~~~~~
2648 Set meter dscp table for the ethernet device::
2650 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2651 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2653 set port meter policer action
2654 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2656 Set meter policer action for the ethernet device::
2658 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2659 (action0) [(action1) (action1)]
2663 * ``action_mask``: Bit mask indicating which policer actions need to be
2664 updated. One or more policer actions can be updated in a single function
2665 invocation. To update the policer action associated with color C, bit
2666 (1 << C) needs to be set in *action_mask* and element at position C
2667 in the *actions* array needs to be valid.
2668 * ``actionx``: Policer action for the color x,
2669 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2671 set port meter stats mask
2672 ~~~~~~~~~~~~~~~~~~~~~~~~~
2674 Set meter stats mask for the ethernet device::
2676 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2680 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2682 show port meter stats
2683 ~~~~~~~~~~~~~~~~~~~~~
2685 Show meter stats of the ethernet device::
2687 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2691 * ``clear``: Flag that indicates whether the statistics counters should
2692 be cleared (i.e. set to zero) immediately after they have been read or not.
2697 The following section shows functions for configuring traffic management on
2698 on the ethernet device through the use of generic TM API.
2700 show port traffic management capability
2701 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2703 Show traffic management capability of the port::
2705 testpmd> show port tm cap (port_id)
2707 show port traffic management capability (hierarchy level)
2708 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2710 Show traffic management hierarchy level capability of the port::
2712 testpmd> show port tm level cap (port_id) (level_id)
2714 show port traffic management capability (hierarchy node level)
2715 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2717 Show the traffic management hierarchy node capability of the port::
2719 testpmd> show port tm node cap (port_id) (node_id)
2721 show port traffic management hierarchy node type
2722 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2724 Show the port traffic management hierarchy node type::
2726 testpmd> show port tm node type (port_id) (node_id)
2728 show port traffic management hierarchy node stats
2729 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2731 Show the port traffic management hierarchy node statistics::
2733 testpmd> show port tm node stats (port_id) (node_id) (clear)
2737 * ``clear``: When this parameter has a non-zero value, the statistics counters
2738 are cleared (i.e. set to zero) immediately after they have been read,
2739 otherwise the statistics counters are left untouched.
2741 Add port traffic management private shaper profile
2742 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2744 Add the port traffic management private shaper profile::
2746 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2747 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2748 (packet_length_adjust)
2752 * ``shaper_profile id``: Shaper profile ID for the new profile.
2753 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2754 * ``cmit_tb_size``: Committed token bucket size (bytes).
2755 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2756 * ``peak_tb_size``: Peak token bucket size (bytes).
2757 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2758 each packet for the purpose of shaping. This parameter value can be used to
2759 correct the packet length with the framing overhead bytes that are consumed
2762 Delete port traffic management private shaper profile
2763 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2765 Delete the port traffic management private shaper::
2767 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2771 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2773 Add port traffic management shared shaper
2774 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2776 Create the port traffic management shared shaper::
2778 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2783 * ``shared_shaper_id``: Shared shaper ID to be created.
2784 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2786 Set port traffic management shared shaper
2787 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2789 Update the port traffic management shared shaper::
2791 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2796 * ``shared_shaper_id``: Shared shaper ID to be update.
2797 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2799 Delete port traffic management shared shaper
2800 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2802 Delete the port traffic management shared shaper::
2804 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2808 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2810 Set port traffic management hierarchy node private shaper
2811 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2813 set the port traffic management hierarchy node private shaper::
2815 testpmd> set port tm node shaper profile (port_id) (node_id) \
2820 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2823 Add port traffic management WRED profile
2824 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2826 Create a new WRED profile::
2828 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2829 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2830 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2831 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2835 * ``wred_profile id``: Identifier for the newly create WRED profile
2836 * ``color_g``: Packet color (green)
2837 * ``min_th_g``: Minimum queue threshold for packet with green color
2838 * ``max_th_g``: Minimum queue threshold for packet with green color
2839 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2840 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2841 * ``color_y``: Packet color (yellow)
2842 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2843 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2844 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2845 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2846 * ``color_r``: Packet color (red)
2847 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2848 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2849 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2850 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2852 Delete port traffic management WRED profile
2853 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2855 Delete the WRED profile::
2857 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2859 Add port traffic management hierarchy nonleaf node
2860 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2862 Add nonleaf node to port traffic management hierarchy::
2864 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2865 (priority) (weight) (level_id) (shaper_profile_id) \
2866 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2867 [(shared_shaper_0) (shared_shaper_1) ...] \
2871 * ``parent_node_id``: Node ID of the parent.
2872 * ``priority``: Node priority (highest node priority is zero). This is used by
2873 the SP algorithm running on the parent node for scheduling this node.
2874 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2875 to the weight sum of all siblings that have the same priority. It is used by
2876 the WFQ algorithm running on the parent node for scheduling this node.
2877 * ``level_id``: Hierarchy level of the node.
2878 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2880 * ``n_sp_priorities``: Number of strict priorities.
2881 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2882 * ``n_shared_shapers``: Number of shared shapers.
2883 * ``shared_shaper_id``: Shared shaper id.
2885 Add port traffic management hierarchy leaf node
2886 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2888 Add leaf node to port traffic management hierarchy::
2890 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2891 (priority) (weight) (level_id) (shaper_profile_id) \
2892 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2893 [(shared_shaper_id) (shared_shaper_id) ...] \
2897 * ``parent_node_id``: Node ID of the parent.
2898 * ``priority``: Node priority (highest node priority is zero). This is used by
2899 the SP algorithm running on the parent node for scheduling this node.
2900 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2901 to the weight sum of all siblings that have the same priority. It is used by
2902 the WFQ algorithm running on the parent node for scheduling this node.
2903 * ``level_id``: Hierarchy level of the node.
2904 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2906 * ``cman_mode``: Congestion management mode to be enabled for this node.
2907 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2908 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2909 * ``n_shared_shapers``: Number of shared shapers.
2910 * ``shared_shaper_id``: Shared shaper id.
2912 Delete port traffic management hierarchy node
2913 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2915 Delete node from port traffic management hierarchy::
2917 testpmd> del port tm node (port_id) (node_id)
2919 Update port traffic management hierarchy parent node
2920 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2922 Update port traffic management hierarchy parent node::
2924 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
2927 This function can only be called after the hierarchy commit invocation. Its
2928 success depends on the port support for this operation, as advertised through
2929 the port capability set. This function is valid for all nodes of the traffic
2930 management hierarchy except root node.
2932 Suspend port traffic management hierarchy node
2933 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2935 testpmd> suspend port tm node (port_id) (node_id)
2937 Resume port traffic management hierarchy node
2938 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2940 testpmd> resume port tm node (port_id) (node_id)
2942 Commit port traffic management hierarchy
2943 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2945 Commit the traffic management hierarchy on the port::
2947 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
2951 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
2952 call failure. On the other hand, hierarchy is preserved when this parameter
2955 Set port traffic management mark VLAN dei
2956 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2958 Enables/Disables the traffic management marking on the port for VLAN packets::
2960 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
2964 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
2965 ``yellow`` or ``red`` will have dei bit enabled
2967 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
2969 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
2971 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
2973 Set port traffic management mark IP dscp
2974 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2976 Enables/Disables the traffic management marking on the port for IP dscp packets::
2978 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
2982 * ``port_id``: The port which on which IP packets marked as ``green`` or
2983 ``yellow`` or ``red`` will have IP dscp bits updated
2985 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
2987 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
2989 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
2991 Set port traffic management mark IP ecn
2992 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2994 Enables/Disables the traffic management marking on the port for IP ecn packets::
2996 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3000 * ``port_id``: The port which on which IP packets marked as ``green`` or
3001 ``yellow`` or ``red`` will have IP ecn bits updated
3003 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3004 to ecn of 2'b11 when IP is caring TCP or SCTP
3006 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3007 to ecn of 2'b11 when IP is caring TCP or SCTP
3009 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3010 to ecn of 2'b11 when IP is caring TCP or SCTP
3012 Set port traffic management default hierarchy (softnic forwarding mode)
3013 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3015 set the traffic management default hierarchy on the port::
3017 testpmd> set port tm hierarchy default (port_id)
3022 This section details the available filter functions that are available.
3024 Note these functions interface the deprecated legacy filtering framework,
3025 superseded by *rte_flow*. See `Flow rules management`_.
3028 ~~~~~~~~~~~~~~~~~~~~
3030 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3032 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3033 ethertype (ether_type) (drop|fwd) queue (queue_id)
3035 The available information parameters are:
3037 * ``port_id``: The port which the Ethertype filter assigned on.
3039 * ``mac_addr``: Compare destination mac address.
3041 * ``mac_ignr``: Ignore destination mac address match.
3043 * ``mac_address``: Destination mac address to match.
3045 * ``ether_type``: The EtherType value want to match,
3046 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3048 * ``queue_id``: The receive queue associated with this EtherType filter.
3049 It is meaningless when deleting or dropping.
3051 Example, to add/remove an ethertype filter rule::
3053 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3054 ethertype 0x0806 fwd queue 3
3056 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3057 ethertype 0x0806 fwd queue 3
3062 Add or delete a 2-tuple filter,
3063 which identifies packets by specific protocol and destination TCP/UDP port
3064 and forwards packets into one of the receive queues::
3066 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3067 protocol (protocol_value) mask (mask_value) \
3068 tcp_flags (tcp_flags_value) priority (prio_value) \
3071 The available information parameters are:
3073 * ``port_id``: The port which the 2-tuple filter assigned on.
3075 * ``dst_port_value``: Destination port in L4.
3077 * ``protocol_value``: IP L4 protocol.
3079 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3081 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3083 * ``prio_value``: Priority of this filter.
3085 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3087 Example, to add/remove an 2tuple filter rule::
3089 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3090 tcp_flags 0x02 priority 3 queue 3
3092 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3093 tcp_flags 0x02 priority 3 queue 3
3098 Add or delete a 5-tuple filter,
3099 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3100 and routes packets into one of the receive queues::
3102 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3103 (src_address) dst_port (dst_port_value) \
3104 src_port (src_port_value) protocol (protocol_value) \
3105 mask (mask_value) tcp_flags (tcp_flags_value) \
3106 priority (prio_value) queue (queue_id)
3108 The available information parameters are:
3110 * ``port_id``: The port which the 5-tuple filter assigned on.
3112 * ``dst_address``: Destination IP address.
3114 * ``src_address``: Source IP address.
3116 * ``dst_port_value``: TCP/UDP destination port.
3118 * ``src_port_value``: TCP/UDP source port.
3120 * ``protocol_value``: L4 protocol.
3122 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3124 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3126 * ``prio_value``: The priority of this filter.
3128 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3130 Example, to add/remove an 5tuple filter rule::
3132 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3133 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3134 flags 0x0 priority 3 queue 3
3136 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3137 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3138 flags 0x0 priority 3 queue 3
3143 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3145 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3147 The available information parameters are:
3149 * ``port_id``: The port which the SYN filter assigned on.
3151 * ``high``: This SYN filter has higher priority than other filters.
3153 * ``low``: This SYN filter has lower priority than other filters.
3155 * ``queue_id``: The receive queue associated with this SYN filter
3159 testpmd> syn_filter 0 add priority high queue 3
3164 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3165 and routed into one of the receive queues::
3167 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3168 mask (mask_value) priority (prio_value) queue (queue_id)
3170 The available information parameters are:
3172 * ``port_id``: The port which the Flex filter is assigned on.
3174 * ``len_value``: Filter length in bytes, no greater than 128.
3176 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3178 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3180 * ``prio_value``: The priority of this filter.
3182 * ``queue_id``: The receive queue associated with this Flex filter.
3186 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3187 mask 000C priority 3 queue 3
3189 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3190 mask 000C priority 3 queue 3
3193 .. _testpmd_flow_director:
3195 flow_director_filter
3196 ~~~~~~~~~~~~~~~~~~~~
3198 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3200 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3201 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3203 * Perfect match filters.
3204 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3205 The masked fields are for IP flow.
3207 * Signature filters.
3208 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3210 * Perfect-mac-vlan match filters.
3211 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3212 The masked fields are for MAC VLAN flow.
3214 * Perfect-tunnel match filters.
3215 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3216 The masked fields are for tunnel flow.
3218 * Perfect-raw-flow-type match filters.
3219 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3220 The masked fields are specified by input sets.
3222 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3223 per flow type and the flexible payload.
3225 The Flow Director can also mask out parts of all of these fields so that filters
3226 are only applied to certain fields or parts of the fields.
3228 Note that for raw flow type mode the source and destination fields in the
3229 raw packet buffer need to be presented in a reversed order with respect
3230 to the expected received packets.
3231 For example: IP source and destination addresses or TCP/UDP/SCTP
3232 source and destination ports
3234 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3236 # Commands to add flow director filters of different flow types::
3238 flow_director_filter (port_id) mode IP (add|del|update) \
3239 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3240 src (src_ip_address) dst (dst_ip_address) \
3241 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3242 vlan (vlan_value) flexbytes (flexbytes_value) \
3243 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3246 flow_director_filter (port_id) mode IP (add|del|update) \
3247 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3248 src (src_ip_address) (src_port) \
3249 dst (dst_ip_address) (dst_port) \
3250 tos (tos_value) ttl (ttl_value) \
3251 vlan (vlan_value) flexbytes (flexbytes_value) \
3252 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3255 flow_director_filter (port_id) mode IP (add|del|update) \
3256 flow (ipv4-sctp|ipv6-sctp) \
3257 src (src_ip_address) (src_port) \
3258 dst (dst_ip_address) (dst_port) \
3259 tos (tos_value) ttl (ttl_value) \
3260 tag (verification_tag) vlan (vlan_value) \
3261 flexbytes (flexbytes_value) (drop|fwd) \
3262 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3264 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3265 ether (ethertype) flexbytes (flexbytes_value) \
3266 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3269 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3270 mac (mac_address) vlan (vlan_value) \
3271 flexbytes (flexbytes_value) (drop|fwd) \
3272 queue (queue_id) fd_id (fd_id_value)
3274 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3275 mac (mac_address) vlan (vlan_value) \
3276 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3277 flexbytes (flexbytes_value) (drop|fwd) \
3278 queue (queue_id) fd_id (fd_id_value)
3280 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3281 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3282 packet (packet file name)
3284 For example, to add an ipv4-udp flow type filter::
3286 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3287 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3288 fwd pf queue 1 fd_id 1
3290 For example, add an ipv4-other flow type filter::
3292 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3293 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3294 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3299 Flush all flow director filters on a device::
3301 testpmd> flush_flow_director (port_id)
3303 Example, to flush all flow director filter on port 0::
3305 testpmd> flush_flow_director 0
3310 Set flow director's input masks::
3312 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3313 src_mask (ipv4_src) (ipv6_src) (src_port) \
3314 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3316 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3318 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3319 mac (mac_value) tunnel-type (tunnel_type_value) \
3320 tunnel-id (tunnel_id_value)
3322 Example, to set flow director mask on port 0::
3324 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3325 src_mask 255.255.255.255 \
3326 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3327 dst_mask 255.255.255.255 \
3328 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3330 flow_director_flex_mask
3331 ~~~~~~~~~~~~~~~~~~~~~~~
3333 set masks of flow director's flexible payload based on certain flow type::
3335 testpmd> flow_director_flex_mask (port_id) \
3336 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3337 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3338 l2_payload|all) (mask)
3340 Example, to set flow director's flex mask for all flow type on port 0::
3342 testpmd> flow_director_flex_mask 0 flow all \
3343 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3346 flow_director_flex_payload
3347 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3349 Configure flexible payload selection::
3351 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3353 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3355 testpmd> flow_director_flex_payload 0 l4 \
3356 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3358 get_sym_hash_ena_per_port
3359 ~~~~~~~~~~~~~~~~~~~~~~~~~
3361 Get symmetric hash enable configuration per port::
3363 get_sym_hash_ena_per_port (port_id)
3365 For example, to get symmetric hash enable configuration of port 1::
3367 testpmd> get_sym_hash_ena_per_port 1
3369 set_sym_hash_ena_per_port
3370 ~~~~~~~~~~~~~~~~~~~~~~~~~
3372 Set symmetric hash enable configuration per port to enable or disable::
3374 set_sym_hash_ena_per_port (port_id) (enable|disable)
3376 For example, to set symmetric hash enable configuration of port 1 to enable::
3378 testpmd> set_sym_hash_ena_per_port 1 enable
3380 get_hash_global_config
3381 ~~~~~~~~~~~~~~~~~~~~~~
3383 Get the global configurations of hash filters::
3385 get_hash_global_config (port_id)
3387 For example, to get the global configurations of hash filters of port 1::
3389 testpmd> get_hash_global_config 1
3391 set_hash_global_config
3392 ~~~~~~~~~~~~~~~~~~~~~~
3394 Set the global configurations of hash filters::
3396 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3397 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3398 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3401 For example, to enable simple_xor for flow type of ipv6 on port 2::
3403 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3408 Set the input set for hash::
3410 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3411 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3412 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3413 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3414 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3415 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3416 fld-8th|none) (select|add)
3418 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3420 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3425 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3426 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3428 Set the input set for flow director::
3430 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3431 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3432 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3433 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3434 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3435 sctp-dst-port|sctp-veri-tag|none) (select|add)
3437 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3439 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3444 Set different GRE key length for input set::
3446 global_config (port_id) gre-key-len (number in bytes)
3448 For example to set GRE key length for input set to 4 bytes on port 0::
3450 testpmd> global_config 0 gre-key-len 4
3453 .. _testpmd_rte_flow:
3455 Flow rules management
3456 ---------------------
3458 Control of the generic flow API (*rte_flow*) is fully exposed through the
3459 ``flow`` command (validation, creation, destruction, queries and operation
3462 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3463 features simultaneously may cause undefined side-effects and is therefore
3469 Because the ``flow`` command uses dynamic tokens to handle the large number
3470 of possible flow rules combinations, its behavior differs slightly from
3471 other commands, in particular:
3473 - Pressing *?* or the *<tab>* key displays contextual help for the current
3474 token, not that of the entire command.
3476 - Optional and repeated parameters are supported (provided they are listed
3477 in the contextual help).
3479 The first parameter stands for the operation mode. Possible operations and
3480 their general syntax are described below. They are covered in detail in the
3483 - Check whether a flow rule can be created::
3485 flow validate {port_id}
3486 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3487 pattern {item} [/ {item} [...]] / end
3488 actions {action} [/ {action} [...]] / end
3490 - Create a flow rule::
3492 flow create {port_id}
3493 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3494 pattern {item} [/ {item} [...]] / end
3495 actions {action} [/ {action} [...]] / end
3497 - Destroy specific flow rules::
3499 flow destroy {port_id} rule {rule_id} [...]
3501 - Destroy all flow rules::
3503 flow flush {port_id}
3505 - Query an existing flow rule::
3507 flow query {port_id} {rule_id} {action}
3509 - List existing flow rules sorted by priority, filtered by group
3512 flow list {port_id} [group {group_id}] [...]
3514 - Restrict ingress traffic to the defined flow rules::
3516 flow isolate {port_id} {boolean}
3518 Validating flow rules
3519 ~~~~~~~~~~~~~~~~~~~~~
3521 ``flow validate`` reports whether a flow rule would be accepted by the
3522 underlying device in its current state but stops short of creating it. It is
3523 bound to ``rte_flow_validate()``::
3525 flow validate {port_id}
3526 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3527 pattern {item} [/ {item} [...]] / end
3528 actions {action} [/ {action} [...]] / end
3530 If successful, it will show::
3534 Otherwise it will show an error message of the form::
3536 Caught error type [...] ([...]): [...]
3538 This command uses the same parameters as ``flow create``, their format is
3539 described in `Creating flow rules`_.
3541 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3542 index 6 is supported::
3544 testpmd> flow validate 0 ingress pattern eth / end
3545 actions queue index 6 / end
3549 Port 0 does not support TCPv6 rules::
3551 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3553 Caught error type 9 (specific pattern item): Invalid argument
3559 ``flow create`` validates and creates the specified flow rule. It is bound
3560 to ``rte_flow_create()``::
3562 flow create {port_id}
3563 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3564 pattern {item} [/ {item} [...]] / end
3565 actions {action} [/ {action} [...]] / end
3567 If successful, it will return a flow rule ID usable with other commands::
3569 Flow rule #[...] created
3571 Otherwise it will show an error message of the form::
3573 Caught error type [...] ([...]): [...]
3575 Parameters describe in the following order:
3577 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3578 - A matching pattern, starting with the *pattern* token and terminated by an
3580 - Actions, starting with the *actions* token and terminated by an *end*
3583 These translate directly to *rte_flow* objects provided as-is to the
3584 underlying functions.
3586 The shortest valid definition only comprises mandatory tokens::
3588 testpmd> flow create 0 pattern end actions end
3590 Note that PMDs may refuse rules that essentially do nothing such as this
3593 **All unspecified object values are automatically initialized to 0.**
3598 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3599 specified before the ``pattern`` token.
3601 - ``group {group id}``: priority group.
3602 - ``priority {level}``: priority level within group.
3603 - ``ingress``: rule applies to ingress traffic.
3604 - ``egress``: rule applies to egress traffic.
3605 - ``transfer``: apply rule directly to endpoints found in pattern.
3607 Each instance of an attribute specified several times overrides the previous
3608 value as shown below (group 4 is used)::
3610 testpmd> flow create 0 group 42 group 24 group 4 [...]
3612 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3614 While not specifying a direction is an error, some rules may allow both
3617 Most rules affect RX therefore contain the ``ingress`` token::
3619 testpmd> flow create 0 ingress pattern [...]
3624 A matching pattern starts after the ``pattern`` token. It is made of pattern
3625 items and is terminated by a mandatory ``end`` item.
3627 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3628 rte_flow_item_type``).
3630 The ``/`` token is used as a separator between pattern items as shown
3633 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3635 Note that protocol items like these must be stacked from lowest to highest
3636 layer to make sense. For instance, the following rule is either invalid or
3637 unlikely to match any packet::
3639 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3641 More information on these restrictions can be found in the *rte_flow*
3644 Several items support additional specification structures, for example
3645 ``ipv4`` allows specifying source and destination addresses as follows::
3647 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3648 dst is 10.2.0.0 / end [...]
3650 This rule matches all IPv4 traffic with the specified properties.
3652 In this example, ``src`` and ``dst`` are field names of the underlying
3653 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3654 in a similar fashion.
3656 The ``is`` token means that the subsequent value must be matched exactly,
3657 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3658 accordingly. Possible assignment tokens are:
3660 - ``is``: match value perfectly (with full bit-mask).
3661 - ``spec``: match value according to configured bit-mask.
3662 - ``last``: specify upper bound to establish a range.
3663 - ``mask``: specify bit-mask with relevant bits set to one.
3664 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3666 These yield identical results::
3668 ipv4 src is 10.1.1.1
3672 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3676 ipv4 src spec 10.1.1.1 src prefix 32
3680 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3684 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3686 Inclusive ranges can be defined with ``last``::
3688 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3690 Note that ``mask`` affects both ``spec`` and ``last``::
3692 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3693 # matches 10.1.0.0 to 10.2.255.255
3695 Properties can be modified multiple times::
3697 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3701 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3706 This section lists supported pattern items and their attributes, if any.
3708 - ``end``: end list of pattern items.
3710 - ``void``: no-op pattern item.
3712 - ``invert``: perform actions when pattern does not match.
3714 - ``any``: match any protocol for the current layer.
3716 - ``num {unsigned}``: number of layers covered.
3718 - ``pf``: match traffic from/to the physical function.
3720 - ``vf``: match traffic from/to a virtual function ID.
3722 - ``id {unsigned}``: VF ID.
3724 - ``phy_port``: match traffic from/to a specific physical port.
3726 - ``index {unsigned}``: physical port index.
3728 - ``port_id``: match traffic from/to a given DPDK port ID.
3730 - ``id {unsigned}``: DPDK port ID.
3732 - ``mark``: match value set in previously matched flow rule using the mark action.
3734 - ``id {unsigned}``: arbitrary integer value.
3736 - ``raw``: match an arbitrary byte string.
3738 - ``relative {boolean}``: look for pattern after the previous item.
3739 - ``search {boolean}``: search pattern from offset (see also limit).
3740 - ``offset {integer}``: absolute or relative offset for pattern.
3741 - ``limit {unsigned}``: search area limit for start of pattern.
3742 - ``pattern {string}``: byte string to look for.
3744 - ``eth``: match Ethernet header.
3746 - ``dst {MAC-48}``: destination MAC.
3747 - ``src {MAC-48}``: source MAC.
3748 - ``type {unsigned}``: EtherType or TPID.
3750 - ``vlan``: match 802.1Q/ad VLAN tag.
3752 - ``tci {unsigned}``: tag control information.
3753 - ``pcp {unsigned}``: priority code point.
3754 - ``dei {unsigned}``: drop eligible indicator.
3755 - ``vid {unsigned}``: VLAN identifier.
3756 - ``inner_type {unsigned}``: inner EtherType or TPID.
3758 - ``ipv4``: match IPv4 header.
3760 - ``tos {unsigned}``: type of service.
3761 - ``ttl {unsigned}``: time to live.
3762 - ``proto {unsigned}``: next protocol ID.
3763 - ``src {ipv4 address}``: source address.
3764 - ``dst {ipv4 address}``: destination address.
3766 - ``ipv6``: match IPv6 header.
3768 - ``tc {unsigned}``: traffic class.
3769 - ``flow {unsigned}``: flow label.
3770 - ``proto {unsigned}``: protocol (next header).
3771 - ``hop {unsigned}``: hop limit.
3772 - ``src {ipv6 address}``: source address.
3773 - ``dst {ipv6 address}``: destination address.
3775 - ``icmp``: match ICMP header.
3777 - ``type {unsigned}``: ICMP packet type.
3778 - ``code {unsigned}``: ICMP packet code.
3780 - ``udp``: match UDP header.
3782 - ``src {unsigned}``: UDP source port.
3783 - ``dst {unsigned}``: UDP destination port.
3785 - ``tcp``: match TCP header.
3787 - ``src {unsigned}``: TCP source port.
3788 - ``dst {unsigned}``: TCP destination port.
3790 - ``sctp``: match SCTP header.
3792 - ``src {unsigned}``: SCTP source port.
3793 - ``dst {unsigned}``: SCTP destination port.
3794 - ``tag {unsigned}``: validation tag.
3795 - ``cksum {unsigned}``: checksum.
3797 - ``vxlan``: match VXLAN header.
3799 - ``vni {unsigned}``: VXLAN identifier.
3801 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3803 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3805 - ``nvgre``: match NVGRE header.
3807 - ``tni {unsigned}``: virtual subnet ID.
3809 - ``mpls``: match MPLS header.
3811 - ``label {unsigned}``: MPLS label.
3813 - ``gre``: match GRE header.
3815 - ``protocol {unsigned}``: protocol type.
3817 - ``gre_key``: match GRE optional key field.
3819 - ``value {unsigned}``: key value.
3821 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3823 - ``thresh {unsigned}``: accuracy threshold.
3825 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3827 - ``teid {unsigned}``: tunnel endpoint identifier.
3829 - ``geneve``: match GENEVE header.
3831 - ``vni {unsigned}``: virtual network identifier.
3832 - ``protocol {unsigned}``: protocol type.
3834 - ``vxlan-gpe``: match VXLAN-GPE header.
3836 - ``vni {unsigned}``: VXLAN-GPE identifier.
3838 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3840 - ``sha {MAC-48}``: sender hardware address.
3841 - ``spa {ipv4 address}``: sender IPv4 address.
3842 - ``tha {MAC-48}``: target hardware address.
3843 - ``tpa {ipv4 address}``: target IPv4 address.
3845 - ``ipv6_ext``: match presence of any IPv6 extension header.
3847 - ``next_hdr {unsigned}``: next header.
3849 - ``icmp6``: match any ICMPv6 header.
3851 - ``type {unsigned}``: ICMPv6 type.
3852 - ``code {unsigned}``: ICMPv6 code.
3854 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3856 - ``target_addr {ipv6 address}``: target address.
3858 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3860 - ``target_addr {ipv6 address}``: target address.
3862 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3864 - ``type {unsigned}``: ND option type.
3866 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3867 link-layer address option.
3869 - ``sla {MAC-48}``: source Ethernet LLA.
3871 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3872 link-layer address option.
3874 - ``tla {MAC-48}``: target Ethernet LLA.
3876 - ``meta``: match application specific metadata.
3878 - ``data {unsigned}``: metadata value.
3880 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3882 - ``pdu_type {unsigned}``: PDU type.
3883 - ``qfi {unsigned}``: QoS flow identifier.
3885 - ``pppoes``, ``pppoed``: match PPPoE header.
3887 - ``session_id {unsigned}``: session identifier.
3889 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3891 - ``proto_id {unsigned}``: PPP protocol identifier.
3896 A list of actions starts after the ``actions`` token in the same fashion as
3897 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3898 terminated by a mandatory ``end`` action.
3900 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3901 rte_flow_action_type``).
3903 Dropping all incoming UDPv4 packets can be expressed as follows::
3905 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3908 Several actions have configurable properties which must be specified when
3909 there is no valid default value. For example, ``queue`` requires a target
3912 This rule redirects incoming UDPv4 traffic to queue index 6::
3914 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3915 actions queue index 6 / end
3917 While this one could be rejected by PMDs (unspecified queue index)::
3919 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3922 As defined by *rte_flow*, the list is not ordered, all actions of a given
3923 rule are performed simultaneously. These are equivalent::
3925 queue index 6 / void / mark id 42 / end
3929 void / mark id 42 / queue index 6 / end
3931 All actions in a list should have different types, otherwise only the last
3932 action of a given type is taken into account::
3934 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
3938 drop / drop / drop / end # drop is performed only once
3942 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
3944 Considering they are performed simultaneously, opposite and overlapping
3945 actions can sometimes be combined when the end result is unambiguous::
3947 drop / queue index 6 / end # drop has no effect
3951 queue index 6 / rss queues 6 7 8 / end # queue has no effect
3955 drop / passthru / end # drop has no effect
3957 Note that PMDs may still refuse such combinations.
3962 This section lists supported actions and their attributes, if any.
3964 - ``end``: end list of actions.
3966 - ``void``: no-op action.
3968 - ``passthru``: let subsequent rule process matched packets.
3970 - ``jump``: redirect traffic to group on device.
3972 - ``group {unsigned}``: group to redirect to.
3974 - ``mark``: attach 32 bit value to packets.
3976 - ``id {unsigned}``: 32 bit value to return with packets.
3978 - ``flag``: flag packets.
3980 - ``queue``: assign packets to a given queue index.
3982 - ``index {unsigned}``: queue index to use.
3984 - ``drop``: drop packets (note: passthru has priority).
3986 - ``count``: enable counters for this rule.
3988 - ``rss``: spread packets among several queues.
3990 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
3991 the same as `set_hash_global_config`_.
3993 - ``level {unsigned}``: encapsulation level for ``types``.
3995 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
3996 tokens are the same as `set_hash_input_set`_, except that an empty list
3997 does not disable RSS but instead requests unspecified "best-effort"
4000 - ``key {string}``: RSS hash key, overrides ``key_len``.
4002 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4003 conjunction with ``key`` to pad or truncate it.
4005 - ``queues [{unsigned} [...]] end``: queue indices to use.
4007 - ``pf``: direct traffic to physical function.
4009 - ``vf``: direct traffic to a virtual function ID.
4011 - ``original {boolean}``: use original VF ID if possible.
4012 - ``id {unsigned}``: VF ID.
4014 - ``phy_port``: direct packets to physical port index.
4016 - ``original {boolean}``: use original port index if possible.
4017 - ``index {unsigned}``: physical port index.
4019 - ``port_id``: direct matching traffic to a given DPDK port ID.
4021 - ``original {boolean}``: use original DPDK port ID if possible.
4022 - ``id {unsigned}``: DPDK port ID.
4024 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4026 - ``mpls_ttl``: MPLS TTL.
4028 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4030 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4032 - ``nw_ttl``: IP TTL.
4034 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4036 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4038 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4040 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4042 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4044 - ``ethertype``: Ethertype.
4046 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4048 - ``vlan_vid``: VLAN id.
4050 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4052 - ``vlan_pcp``: VLAN priority.
4054 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4056 - ``ethertype``: Ethertype.
4058 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4060 - ``ethertype``: Ethertype.
4062 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4063 is done through `Config VXLAN Encap outer layers`_.
4065 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4066 the VXLAN tunnel network overlay from the matched flow.
4068 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4069 is done through `Config NVGRE Encap outer layers`_.
4071 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4072 the NVGRE tunnel network overlay from the matched flow.
4074 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4075 is done through `Config L2 Encap`_.
4077 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4078 is done through `Config L2 Decap`_.
4080 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4081 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4083 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4084 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4086 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4087 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4089 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4090 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4092 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4094 - ``ipv4_addr``: New IPv4 source address.
4096 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4099 - ``ipv4_addr``: New IPv4 destination address.
4101 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4103 - ``ipv6_addr``: New IPv6 source address.
4105 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4108 - ``ipv6_addr``: New IPv6 destination address.
4110 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4113 - ``port``: New TCP/UDP source port number.
4115 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4118 - ``port``: New TCP/UDP destination port number.
4120 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4123 - ``dec_ttl``: Performs a decrease TTL value action
4125 - ``set_ttl``: Set TTL value with specified value
4126 - ``ttl_value {unsigned}``: The new TTL value to be set
4128 - ``set_mac_src``: set source MAC address
4130 - ``mac_addr {MAC-48}``: new source MAC address
4132 - ``set_mac_dst``: set destination MAC address
4134 - ``mac_addr {MAC-48}``: new destination MAC address
4136 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4138 - ``value {unsigned}``: Value to increase TCP sequence number by.
4140 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4142 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4144 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4146 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4148 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4150 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4152 Destroying flow rules
4153 ~~~~~~~~~~~~~~~~~~~~~
4155 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4156 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4157 times as necessary::
4159 flow destroy {port_id} rule {rule_id} [...]
4161 If successful, it will show::
4163 Flow rule #[...] destroyed
4165 It does not report anything for rule IDs that do not exist. The usual error
4166 message is shown when a rule cannot be destroyed::
4168 Caught error type [...] ([...]): [...]
4170 ``flow flush`` destroys all rules on a device and does not take extra
4171 arguments. It is bound to ``rte_flow_flush()``::
4173 flow flush {port_id}
4175 Any errors are reported as above.
4177 Creating several rules and destroying them::
4179 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4180 actions queue index 2 / end
4181 Flow rule #0 created
4182 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4183 actions queue index 3 / end
4184 Flow rule #1 created
4185 testpmd> flow destroy 0 rule 0 rule 1
4186 Flow rule #1 destroyed
4187 Flow rule #0 destroyed
4190 The same result can be achieved using ``flow flush``::
4192 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4193 actions queue index 2 / end
4194 Flow rule #0 created
4195 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4196 actions queue index 3 / end
4197 Flow rule #1 created
4198 testpmd> flow flush 0
4201 Non-existent rule IDs are ignored::
4203 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4204 actions queue index 2 / end
4205 Flow rule #0 created
4206 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4207 actions queue index 3 / end
4208 Flow rule #1 created
4209 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4211 testpmd> flow destroy 0 rule 0
4212 Flow rule #0 destroyed
4218 ``flow query`` queries a specific action of a flow rule having that
4219 ability. Such actions collect information that can be reported using this
4220 command. It is bound to ``rte_flow_query()``::
4222 flow query {port_id} {rule_id} {action}
4224 If successful, it will display either the retrieved data for known actions
4225 or the following message::
4227 Cannot display result for action type [...] ([...])
4229 Otherwise, it will complain either that the rule does not exist or that some
4232 Flow rule #[...] not found
4236 Caught error type [...] ([...]): [...]
4238 Currently only the ``count`` action is supported. This action reports the
4239 number of packets that hit the flow rule and the total number of bytes. Its
4240 output has the following format::
4243 hits_set: [...] # whether "hits" contains a valid value
4244 bytes_set: [...] # whether "bytes" contains a valid value
4245 hits: [...] # number of packets
4246 bytes: [...] # number of bytes
4248 Querying counters for TCPv6 packets redirected to queue 6::
4250 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4251 actions queue index 6 / count / end
4252 Flow rule #4 created
4253 testpmd> flow query 0 4 count
4264 ``flow list`` lists existing flow rules sorted by priority and optionally
4265 filtered by group identifiers::
4267 flow list {port_id} [group {group_id}] [...]
4269 This command only fails with the following message if the device does not
4274 Output consists of a header line followed by a short description of each
4275 flow rule, one per line. There is no output at all when no flow rules are
4276 configured on the device::
4278 ID Group Prio Attr Rule
4279 [...] [...] [...] [...] [...]
4281 ``Attr`` column flags:
4283 - ``i`` for ``ingress``.
4284 - ``e`` for ``egress``.
4286 Creating several flow rules and listing them::
4288 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4289 actions queue index 6 / end
4290 Flow rule #0 created
4291 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4292 actions queue index 2 / end
4293 Flow rule #1 created
4294 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4295 actions rss queues 6 7 8 end / end
4296 Flow rule #2 created
4297 testpmd> flow list 0
4298 ID Group Prio Attr Rule
4299 0 0 0 i- ETH IPV4 => QUEUE
4300 1 0 0 i- ETH IPV6 => QUEUE
4301 2 0 5 i- ETH IPV4 UDP => RSS
4304 Rules are sorted by priority (i.e. group ID first, then priority level)::
4306 testpmd> flow list 1
4307 ID Group Prio Attr Rule
4308 0 0 0 i- ETH => COUNT
4309 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4310 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4311 1 24 0 i- ETH IPV4 UDP => QUEUE
4312 4 24 10 i- ETH IPV4 TCP => DROP
4313 3 24 20 i- ETH IPV4 => DROP
4314 2 24 42 i- ETH IPV4 UDP => QUEUE
4315 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4318 Output can be limited to specific groups::
4320 testpmd> flow list 1 group 0 group 63
4321 ID Group Prio Attr Rule
4322 0 0 0 i- ETH => COUNT
4323 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4324 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4325 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4328 Toggling isolated mode
4329 ~~~~~~~~~~~~~~~~~~~~~~
4331 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4332 must only be injected from the defined flow rules; that no default traffic
4333 is expected outside those rules and the driver is free to assign more
4334 resources to handle them. It is bound to ``rte_flow_isolate()``::
4336 flow isolate {port_id} {boolean}
4338 If successful, enabling or disabling isolated mode shows either::
4340 Ingress traffic on port [...]
4341 is now restricted to the defined flow rules
4345 Ingress traffic on port [...]
4346 is not restricted anymore to the defined flow rules
4348 Otherwise, in case of error::
4350 Caught error type [...] ([...]): [...]
4352 Mainly due to its side effects, PMDs supporting this mode may not have the
4353 ability to toggle it more than once without reinitializing affected ports
4354 first (e.g. by exiting testpmd).
4356 Enabling isolated mode::
4358 testpmd> flow isolate 0 true
4359 Ingress traffic on port 0 is now restricted to the defined flow rules
4362 Disabling isolated mode::
4364 testpmd> flow isolate 0 false
4365 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4368 Sample QinQ flow rules
4369 ~~~~~~~~~~~~~~~~~~~~~~
4371 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4373 testpmd> port stop 0
4374 testpmd> vlan set qinq_strip on 0
4376 The above command sets the inner and outer TPID's to 0x8100.
4378 To change the TPID's the following commands should be used::
4380 testpmd> vlan set outer tpid 0xa100 0
4381 testpmd> vlan set inner tpid 0x9100 0
4382 testpmd> port start 0
4384 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4388 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4389 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4390 Flow rule #0 validated
4392 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4393 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4394 Flow rule #0 created
4396 testpmd> flow list 0
4397 ID Group Prio Attr Rule
4398 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4400 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4404 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4405 vlan tci is 654 / end actions pf / queue index 0 / end
4406 Flow rule #1 validated
4408 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4409 vlan tci is 654 / end actions pf / queue index 1 / end
4410 Flow rule #1 created
4412 testpmd> flow list 0
4413 ID Group Prio Attr Rule
4414 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4415 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4417 Sample VXLAN encapsulation rule
4418 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4420 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4421 source code, those can be changed by using the following commands
4423 IPv4 VXLAN outer header::
4425 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4426 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4427 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4430 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4431 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4432 eth-dst 22:22:22:22:22:22
4433 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4436 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4437 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4438 eth-dst 22:22:22:22:22:22
4439 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4442 IPv6 VXLAN outer header::
4444 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4445 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4446 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4449 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4450 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4451 eth-dst 22:22:22:22:22:22
4452 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4455 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4456 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4457 eth-dst 22:22:22:22:22:22
4458 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4461 Sample NVGRE encapsulation rule
4462 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4464 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4465 source code, those can be changed by using the following commands
4467 IPv4 NVGRE outer header::
4469 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4470 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4471 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4474 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4475 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4476 eth-dst 22:22:22:22:22:22
4477 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4480 IPv6 NVGRE outer header::
4482 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4483 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4484 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4487 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4488 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4489 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4492 Sample L2 encapsulation rule
4493 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4495 L2 encapsulation has default value pre-configured in testpmd
4496 source code, those can be changed by using the following commands
4500 testpmd> set l2_encap ip-version ipv4
4501 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4502 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4503 mplsoudp_decap / l2_encap / end
4505 L2 with VXLAN header::
4507 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4508 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4509 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4510 mplsoudp_decap / l2_encap / end
4512 Sample L2 decapsulation rule
4513 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4515 L2 decapsulation has default value pre-configured in testpmd
4516 source code, those can be changed by using the following commands
4520 testpmd> set l2_decap
4521 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4524 L2 with VXLAN header::
4526 testpmd> set l2_encap-with-vlan
4527 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4530 Sample MPLSoGRE encapsulation rule
4531 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4533 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4534 source code, those can be changed by using the following commands
4536 IPv4 MPLSoGRE outer header::
4538 testpmd> set mplsogre_encap ip-version ipv4 label 4
4539 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4540 eth-dst 22:22:22:22:22:22
4541 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4542 mplsogre_encap / end
4544 IPv4 MPLSoGRE with VLAN outer header::
4546 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4547 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4548 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4549 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4550 mplsogre_encap / end
4552 IPv6 MPLSoGRE outer header::
4554 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4555 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4556 eth-dst 22:22:22:22:22:22
4557 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4558 mplsogre_encap / end
4560 IPv6 MPLSoGRE with VLAN outer header::
4562 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4563 ip-src ::1 ip-dst ::2222 vlan-tci 34
4564 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4565 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4566 mplsogre_encap / end
4568 Sample MPLSoGRE decapsulation rule
4569 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4571 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4572 source code, those can be changed by using the following commands
4574 IPv4 MPLSoGRE outer header::
4576 testpmd> set mplsogre_decap ip-version ipv4
4577 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4578 mplsogre_decap / l2_encap / end
4580 IPv4 MPLSoGRE with VLAN outer header::
4582 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4583 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4584 actions mplsogre_decap / l2_encap / end
4586 IPv6 MPLSoGRE outer header::
4588 testpmd> set mplsogre_decap ip-version ipv6
4589 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4590 actions mplsogre_decap / l2_encap / end
4592 IPv6 MPLSoGRE with VLAN outer header::
4594 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4595 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4596 actions mplsogre_decap / l2_encap / end
4598 Sample MPLSoUDP encapsulation rule
4599 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4601 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4602 source code, those can be changed by using the following commands
4604 IPv4 MPLSoUDP outer header::
4606 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4607 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4608 eth-dst 22:22:22:22:22:22
4609 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4610 mplsoudp_encap / end
4612 IPv4 MPLSoUDP with VLAN outer header::
4614 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4615 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4616 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4617 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4618 mplsoudp_encap / end
4620 IPv6 MPLSoUDP outer header::
4622 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4623 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4624 eth-dst 22:22:22:22:22:22
4625 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4626 mplsoudp_encap / end
4628 IPv6 MPLSoUDP with VLAN outer header::
4630 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4631 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4632 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4633 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4634 mplsoudp_encap / end
4636 Sample MPLSoUDP decapsulation rule
4637 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4639 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4640 source code, those can be changed by using the following commands
4642 IPv4 MPLSoUDP outer header::
4644 testpmd> set mplsoudp_decap ip-version ipv4
4645 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4646 mplsoudp_decap / l2_encap / end
4648 IPv4 MPLSoUDP with VLAN outer header::
4650 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4651 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4652 actions mplsoudp_decap / l2_encap / end
4654 IPv6 MPLSoUDP outer header::
4656 testpmd> set mplsoudp_decap ip-version ipv6
4657 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4658 actions mplsoudp_decap / l2_encap / end
4660 IPv6 MPLSoUDP with VLAN outer header::
4662 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4663 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4664 actions mplsoudp_decap / l2_encap / end
4666 Sample Raw encapsulation rule
4667 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4669 Raw encapsulation configuration can be set by the following commands
4671 Eecapsulating VxLAN::
4673 testpmd> set raw_encap eth src is 10:11:22:33:44:55 / vlan tci is 1
4674 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4676 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4679 Sample Raw decapsulation rule
4680 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4682 Raw decapsulation configuration can be set by the following commands
4684 Decapsulating VxLAN::
4686 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4687 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4688 end actions raw_decap / queue index 0 / end
4693 The following sections show functions to load/unload eBPF based filters.
4698 Load an eBPF program as a callback for particular RX/TX queue::
4700 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4702 The available load-flags are:
4704 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4706 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4712 You'll need clang v3.7 or above to build bpf program you'd like to load
4716 .. code-block:: console
4719 clang -O2 -target bpf -c t1.c
4721 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4723 .. code-block:: console
4725 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4727 To load (not JITed) t1.o at TX queue 0, port 0:
4729 .. code-block:: console
4731 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4736 Unload previously loaded eBPF program for particular RX/TX queue::
4738 testpmd> bpf-unload rx|tx (portid) (queueid)
4740 For example to unload BPF filter from TX queue 0, port 0:
4742 .. code-block:: console
4744 testpmd> bpf-unload tx 0 0