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
204 Redirection table size: 512
205 Supported flow types:
226 Display the rss redirection table entry indicated by masks on port X::
228 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
230 size is used to indicate the hardware supported reta size
235 Display the RSS hash functions and RSS hash key of a port::
237 testpmd> show port (port_id) rss-hash [key]
242 Clear the port statistics for a given port or for all ports::
244 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
248 testpmd> clear port stats all
253 Display information for a given port's RX/TX queue::
255 testpmd> show (rxq|txq) info (port_id) (queue_id)
260 Displays the configuration of the application.
261 The configuration comes from the command-line, the runtime or the application defaults::
263 testpmd> show config (rxtx|cores|fwd|txpkts)
265 The available information categories are:
267 * ``rxtx``: RX/TX configuration items.
269 * ``cores``: List of forwarding cores.
271 * ``fwd``: Packet forwarding configuration.
273 * ``txpkts``: Packets to TX configuration.
277 .. code-block:: console
279 testpmd> show config rxtx
281 io packet forwarding - CRC stripping disabled - packets/burst=16
282 nb forwarding cores=2 - nb forwarding ports=1
283 RX queues=1 - RX desc=128 - RX free threshold=0
284 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
285 TX queues=1 - TX desc=512 - TX free threshold=0
286 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
287 TX RS bit threshold=0 - TXQ flags=0x0
292 Set the packet forwarding mode::
294 testpmd> set fwd (io|mac|macswap|flowgen| \
295 rxonly|txonly|csum|icmpecho|noisy) (""|retry)
297 ``retry`` can be specified for forwarding engines except ``rx_only``.
299 The available information categories are:
301 * ``io``: Forwards packets "as-is" in I/O mode.
302 This is the fastest possible forwarding operation as it does not access packets data.
303 This is the default mode.
305 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
306 Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination
307 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
308 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
310 * ``macswap``: MAC swap forwarding mode.
311 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
313 * ``flowgen``: Multi-flow generation mode.
314 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
316 * ``rxonly``: Receives packets but doesn't transmit them.
318 * ``txonly``: Generates and transmits packets without receiving any.
320 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
322 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
324 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
326 * ``softnic``: Demonstrates the softnic forwarding operation. In this mode, packet forwarding is
327 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``.
329 * ``noisy``: Noisy neighbor simulation.
330 Simulate more realistic behavior of a guest machine engaged in receiving
331 and sending packets performing Virtual Network Function (VNF).
335 testpmd> set fwd rxonly
337 Set rxonly packet forwarding mode
343 When running, forwarding engines maintain statistics from the time they have been started.
344 Example for the io forwarding engine, with some packet drops on the tx side::
346 testpmd> show fwd stats all
348 ------- Forward Stats for RX Port= 0/Queue= 0 -> TX Port= 1/Queue= 0 -------
349 RX-packets: 274293770 TX-packets: 274293642 TX-dropped: 128
351 ------- Forward Stats for RX Port= 1/Queue= 0 -> TX Port= 0/Queue= 0 -------
352 RX-packets: 274301850 TX-packets: 274301850 TX-dropped: 0
354 ---------------------- Forward statistics for port 0 ----------------------
355 RX-packets: 274293802 RX-dropped: 0 RX-total: 274293802
356 TX-packets: 274301862 TX-dropped: 0 TX-total: 274301862
357 ----------------------------------------------------------------------------
359 ---------------------- Forward statistics for port 1 ----------------------
360 RX-packets: 274301894 RX-dropped: 0 RX-total: 274301894
361 TX-packets: 274293706 TX-dropped: 128 TX-total: 274293834
362 ----------------------------------------------------------------------------
364 +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
365 RX-packets: 548595696 RX-dropped: 0 RX-total: 548595696
366 TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
367 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
372 Clear the forwarding engines statistics::
374 testpmd> clear fwd stats all
379 Display an RX descriptor for a port RX queue::
381 testpmd> read rxd (port_id) (queue_id) (rxd_id)
385 testpmd> read rxd 0 0 4
386 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
391 Display a TX descriptor for a port TX queue::
393 testpmd> read txd (port_id) (queue_id) (txd_id)
397 testpmd> read txd 0 0 4
398 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
403 Get loaded dynamic device personalization (DDP) package info list::
405 testpmd> ddp get list (port_id)
410 Display information about dynamic device personalization (DDP) profile::
412 testpmd> ddp get info (profile_path)
417 Display VF statistics::
419 testpmd> show vf stats (port_id) (vf_id)
424 Reset VF statistics::
426 testpmd> clear vf stats (port_id) (vf_id)
428 show port pctype mapping
429 ~~~~~~~~~~~~~~~~~~~~~~~~
431 List all items from the pctype mapping table::
433 testpmd> show port (port_id) pctype mapping
435 show rx offloading capabilities
436 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
438 List all per queue and per port Rx offloading capabilities of a port::
440 testpmd> show port (port_id) rx_offload capabilities
442 show rx offloading configuration
443 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
445 List port level and all queue level Rx offloading configuration::
447 testpmd> show port (port_id) rx_offload configuration
449 show tx offloading capabilities
450 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
452 List all per queue and per port Tx offloading capabilities of a port::
454 testpmd> show port (port_id) tx_offload capabilities
456 show tx offloading configuration
457 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
459 List port level and all queue level Tx offloading configuration::
461 testpmd> show port (port_id) tx_offload configuration
463 show tx metadata setting
464 ~~~~~~~~~~~~~~~~~~~~~~~~
466 Show Tx metadata value set for a specific port::
468 testpmd> show port (port_id) tx_metadata
473 Dumps all physical memory segment layouts::
475 testpmd> dump_physmem
480 Dumps the layout of all memory zones::
482 testpmd> dump_memzone
488 Dumps the size of all memory structures::
490 testpmd> dump_struct_sizes
495 Dumps the status of all or specific element in DPDK rings::
497 testpmd> dump_ring [ring_name]
502 Dumps the statistics of all or specific memory pool::
504 testpmd> dump_mempool [mempool_name]
509 Dumps the user device list::
511 testpmd> dump_devargs
516 Dumps the log level for all the dpdk modules::
518 testpmd> dump_log_types
520 Configuration Functions
521 -----------------------
523 The testpmd application can be configured from the runtime as well as from the command-line.
525 This section details the available configuration functions that are available.
529 Configuration changes only become active when forwarding is started/restarted.
534 Reset forwarding to the default configuration::
541 Set the debug verbosity level::
543 testpmd> set verbose (level)
545 Available levels are as following:
547 * ``0`` silent except for error.
548 * ``1`` fully verbose except for Tx packets.
549 * ``2`` fully verbose except for Rx packets.
550 * ``> 2`` fully verbose.
555 Set the log level for a log type::
557 testpmd> set log global|(type) (level)
561 * ``type`` is the log name.
563 * ``level`` is the log level.
565 For example, to change the global log level::
567 testpmd> set log global (level)
569 Regexes can also be used for type. To change log level of user1, user2 and user3::
571 testpmd> set log user[1-3] (level)
576 Set the number of ports used by the application:
580 This is equivalent to the ``--nb-ports`` command-line option.
585 Set the number of cores used by the application::
587 testpmd> set nbcore (num)
589 This is equivalent to the ``--nb-cores`` command-line option.
593 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
598 Set the forwarding cores hexadecimal mask::
600 testpmd> set coremask (mask)
602 This is equivalent to the ``--coremask`` command-line option.
606 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
611 Set the forwarding ports hexadecimal mask::
613 testpmd> set portmask (mask)
615 This is equivalent to the ``--portmask`` command-line option.
620 Set number of packets per burst::
622 testpmd> set burst (num)
624 This is equivalent to the ``--burst command-line`` option.
626 When retry is enabled, the transmit delay time and number of retries can also be set::
628 testpmd> set burst tx delay (microseconds) retry (num)
633 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
635 testpmd> set txpkts (x[,y]*)
637 Where x[,y]* represents a CSV list of values, without white space.
642 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
644 testpmd> set txsplit (off|on|rand)
648 * ``off`` disable packet copy & split for CSUM mode.
650 * ``on`` split outgoing packet into multiple segments. Size of each segment
651 and number of segments per packet is determined by ``set txpkts`` command
654 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
659 Set the list of forwarding cores::
661 testpmd> set corelist (x[,y]*)
663 For example, to change the forwarding cores:
665 .. code-block:: console
667 testpmd> set corelist 3,1
668 testpmd> show config fwd
670 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
671 Logical Core 3 (socket 0) forwards packets on 1 streams:
672 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
673 Logical Core 1 (socket 0) forwards packets on 1 streams:
674 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
678 The cores are used in the same order as specified on the command line.
683 Set the list of forwarding ports::
685 testpmd> set portlist (x[,y]*)
687 For example, to change the port forwarding:
689 .. code-block:: console
691 testpmd> set portlist 0,2,1,3
692 testpmd> show config fwd
694 io packet forwarding - ports=4 - cores=1 - streams=4
695 Logical Core 3 (socket 0) forwards packets on 4 streams:
696 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
697 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
698 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
699 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
704 Select how to retrieve new ports created after "port attach" command::
706 testpmd> set port setup on (iterator|event)
708 For each new port, a setup is done.
709 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
710 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
715 Enable/disable tx loopback::
717 testpmd> set tx loopback (port_id) (on|off)
722 set drop enable bit for all queues::
724 testpmd> set all queues drop (port_id) (on|off)
726 set split drop enable (for VF)
727 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
729 set split drop enable bit for VF from PF::
731 testpmd> set vf split drop (port_id) (vf_id) (on|off)
733 set mac antispoof (for VF)
734 ~~~~~~~~~~~~~~~~~~~~~~~~~~
736 Set mac antispoof for a VF from the PF::
738 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
743 Enable/disable MACsec offload::
745 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
746 testpmd> set macsec offload (port_id) off
751 Configure MACsec secure connection (SC)::
753 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
757 The pi argument is ignored for tx.
758 Check the NIC Datasheet for hardware limits.
763 Configure MACsec secure association (SA)::
765 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
769 The IDX value must be 0 or 1.
770 Check the NIC Datasheet for hardware limits.
772 set broadcast mode (for VF)
773 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
775 Set broadcast mode for a VF from the PF::
777 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
782 Set the VLAN strip on a port::
784 testpmd> vlan set strip (on|off) (port_id)
789 Set the VLAN strip for a queue on a port::
791 testpmd> vlan set stripq (on|off) (port_id,queue_id)
793 vlan set stripq (for VF)
794 ~~~~~~~~~~~~~~~~~~~~~~~~
796 Set VLAN strip for all queues in a pool for a VF from the PF::
798 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
800 vlan set insert (for VF)
801 ~~~~~~~~~~~~~~~~~~~~~~~~
803 Set VLAN insert for a VF from the PF::
805 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
807 vlan set tag (for VF)
808 ~~~~~~~~~~~~~~~~~~~~~
810 Set VLAN tag for a VF from the PF::
812 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
814 vlan set antispoof (for VF)
815 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
817 Set VLAN antispoof for a VF from the PF::
819 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
824 Set the VLAN filter on a port::
826 testpmd> vlan set filter (on|off) (port_id)
831 Set the VLAN QinQ (extended queue in queue) on for a port::
833 testpmd> vlan set qinq (on|off) (port_id)
838 Set the inner or outer VLAN TPID for packet filtering on a port::
840 testpmd> vlan set (inner|outer) tpid (value) (port_id)
844 TPID value must be a 16-bit number (value <= 65536).
849 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
851 testpmd> rx_vlan add (vlan_id|all) (port_id)
855 VLAN filter must be set on that port. VLAN ID < 4096.
856 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
857 in VFTA table. This is important if enabling all vlan_ids.
862 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
864 testpmd> rx_vlan rm (vlan_id|all) (port_id)
869 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
871 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
876 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
878 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
883 Add a tunnel filter on a port::
885 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
886 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
887 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
889 The available information categories are:
891 * ``vxlan``: Set tunnel type as VXLAN.
893 * ``nvgre``: Set tunnel type as NVGRE.
895 * ``ipingre``: Set tunnel type as IP-in-GRE.
897 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
899 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
901 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
903 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
905 * ``imac``: Set filter type as Inner MAC.
907 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
909 * ``oip``: Set filter type as Outer IP.
911 * ``iip``: Set filter type as Inner IP.
915 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
916 192.168.2.2 0 ipingre oip 1 1
918 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
923 Remove a tunnel filter on a port::
925 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
926 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
927 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
932 Add an UDP port for VXLAN packet filter on a port::
934 testpmd> rx_vxlan_port add (udp_port) (port_id)
939 Remove an UDP port for VXLAN packet filter on a port::
941 testpmd> rx_vxlan_port rm (udp_port) (port_id)
946 Set hardware insertion of VLAN IDs in packets sent on a port::
948 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
950 For example, set a single VLAN ID (5) insertion on port 0::
954 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
962 Set port based hardware insertion of VLAN ID in packets sent on a port::
964 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
969 Disable hardware insertion of a VLAN header in packets sent on a port::
971 testpmd> tx_vlan reset (port_id)
976 Select hardware or software calculation of the checksum when
977 transmitting a packet using the ``csum`` forwarding engine::
979 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
983 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
985 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
986 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
987 supported). See also the ``csum parse-tunnel`` command.
989 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
990 as a tunnel packet by the forwarding engine (vxlan, vxlan-gpe are
991 supported). See also the ``csum parse-tunnel`` command.
995 Check the NIC Datasheet for hardware limits.
1000 Set RSS queue region span on a port::
1002 testpmd> set port (port_id) queue-region region_id (value) \
1003 queue_start_index (value) queue_num (value)
1005 Set flowtype mapping on a RSS queue region on a port::
1007 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1011 * For the flowtype(pctype) of packet,the specific index for each type has
1012 been defined in file i40e_type.h as enum i40e_filter_pctype.
1014 Set user priority mapping on a RSS queue region on a port::
1016 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1018 Flush all queue region related configuration on a port::
1020 testpmd> set port (port_id) queue-region flush (on|off)
1024 * ``on``: is just an enable function which server for other configuration,
1025 it is for all configuration about queue region from up layer,
1026 at first will only keep in DPDK software stored in driver,
1027 only after "flush on", it commit all configuration to HW.
1029 * ``"off``: is just clean all configuration about queue region just now,
1030 and restore all to DPDK i40e driver default config when start up.
1032 Show all queue region related configuration info on a port::
1034 testpmd> show port (port_id) queue-region
1038 Queue region only support on PF by now, so these command is
1039 only for configuration of queue region on PF port.
1044 Define how tunneled packets should be handled by the csum forward
1047 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1049 If enabled, the csum forward engine will try to recognize supported
1050 tunnel headers (vxlan, gre, ipip).
1052 If disabled, treat tunnel packets as non-tunneled packets (a inner
1053 header is handled as a packet payload).
1057 The port argument is the TX port like in the ``csum set`` command.
1061 Consider a packet in packet like the following::
1063 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1065 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1066 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1067 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1069 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1070 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1075 Display tx checksum offload configuration::
1077 testpmd> csum show (port_id)
1082 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1084 testpmd> tso set (segsize) (port_id)
1088 Check the NIC datasheet for hardware limits.
1093 Display the status of TCP Segmentation Offload::
1095 testpmd> tso show (port_id)
1100 Set tso segment size of tunneled packets for a port in csum engine::
1102 testpmd> tunnel_tso set (tso_segsz) (port_id)
1107 Display the status of tunneled TCP Segmentation Offload for a port::
1109 testpmd> tunnel_tso show (port_id)
1114 Enable or disable GRO in ``csum`` forwarding engine::
1116 testpmd> set port <port_id> gro on|off
1118 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1119 packets received from the given port.
1121 If disabled, packets received from the given port won't be performed
1122 GRO. By default, GRO is disabled for all ports.
1126 When enable GRO for a port, TCP/IPv4 packets received from the port
1127 will be performed GRO. After GRO, all merged packets have bad
1128 checksums, since the GRO library doesn't re-calculate checksums for
1129 the merged packets. Therefore, if users want the merged packets to
1130 have correct checksums, please select HW IP checksum calculation and
1131 HW TCP checksum calculation for the port which the merged packets are
1137 Display GRO configuration for a given port::
1139 testpmd> show port <port_id> gro
1144 Set the cycle to flush the GROed packets from reassembly tables::
1146 testpmd> set gro flush <cycles>
1148 When enable GRO, the csum forwarding engine performs GRO on received
1149 packets, and the GROed packets are stored in reassembly tables. Users
1150 can use this command to determine when the GROed packets are flushed
1151 from the reassembly tables.
1153 The ``cycles`` is measured in GRO operation times. The csum forwarding
1154 engine flushes the GROed packets from the tables every ``cycles`` GRO
1157 By default, the value of ``cycles`` is 1, which means flush GROed packets
1158 from the reassembly tables as soon as one GRO operation finishes. The value
1159 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1161 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1162 stack performance. Because the GROed packets are delayed to arrive the
1163 stack, thus causing more duplicated ACKs and TCP retransmissions.
1168 Toggle per-port GSO support in ``csum`` forwarding engine::
1170 testpmd> set port <port_id> gso on|off
1172 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1173 packets, transmitted on the given port.
1175 If disabled, packets transmitted on the given port will not undergo GSO.
1176 By default, GSO is disabled for all ports.
1180 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1181 port undergo GSO. Afterwards, the segmented packets are represented by
1182 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1183 of checksums for GSO'd segments in SW. As a result, if users want correct
1184 checksums in GSO segments, they should enable HW checksum calculation for
1187 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1188 by setting the following options in the csum forwarding engine:
1190 testpmd> csum set outer_ip hw <port_id>
1192 testpmd> csum set ip hw <port_id>
1194 testpmd> csum set tcp hw <port_id>
1196 UDP GSO is the same as IP fragmentation, which treats the UDP header
1197 as the payload and does not modify it during segmentation. That is,
1198 after UDP GSO, only the first output fragment has the original UDP
1199 header. Therefore, users need to enable HW IP checksum calculation
1200 and SW UDP checksum calculation for GSO-enabled ports, if they want
1201 correct checksums for UDP/IPv4 packets.
1206 Set the maximum GSO segment size (measured in bytes), which includes the
1207 packet header and the packet payload for GSO-enabled ports (global)::
1209 testpmd> set gso segsz <length>
1214 Display the status of Generic Segmentation Offload for a given port::
1216 testpmd> show port <port_id> gso
1221 Add an alternative MAC address to a port::
1223 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1228 Remove a MAC address from a port::
1230 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1235 To add the multicast MAC address to/from the set of multicast addresses
1238 testpmd> mcast_addr add (port_id) (mcast_addr)
1243 To remove the multicast MAC address to/from the set of multicast addresses
1246 testpmd> mcast_addr remove (port_id) (mcast_addr)
1248 mac_addr add (for VF)
1249 ~~~~~~~~~~~~~~~~~~~~~
1251 Add an alternative MAC address for a VF to a port::
1253 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1258 Set the default MAC address for a port::
1260 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1262 mac_addr set (for VF)
1263 ~~~~~~~~~~~~~~~~~~~~~
1265 Set the MAC address for a VF from the PF::
1267 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1272 Set the forwarding peer address for certain port::
1274 testpmd> set eth-peer (port_id) (peer_addr)
1276 This is equivalent to the ``--eth-peer`` command-line option.
1281 Set the unicast hash filter(s) on/off for a port::
1283 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1288 Set the promiscuous mode on for a port or for all ports.
1289 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1291 testpmd> set promisc (port_id|all) (on|off)
1296 Set the allmulti mode for a port or for all ports::
1298 testpmd> set allmulti (port_id|all) (on|off)
1300 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1302 set promisc (for VF)
1303 ~~~~~~~~~~~~~~~~~~~~
1305 Set the unicast promiscuous mode for a VF from PF.
1306 It's supported by Intel i40e NICs now.
1307 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1309 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1311 set allmulticast (for VF)
1312 ~~~~~~~~~~~~~~~~~~~~~~~~~
1314 Set the multicast promiscuous mode for a VF from PF.
1315 It's supported by Intel i40e NICs now.
1316 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1318 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1320 set tx max bandwidth (for VF)
1321 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1323 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1325 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1327 set tc tx min bandwidth (for VF)
1328 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1330 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1332 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1334 set tc tx max bandwidth (for VF)
1335 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1337 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1339 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1341 set tc strict link priority mode
1342 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1344 Set some TCs' strict link priority mode on a physical port::
1346 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1348 set tc tx min bandwidth
1349 ~~~~~~~~~~~~~~~~~~~~~~~
1351 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1353 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1358 Set the link flow control parameter on a port::
1360 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1361 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1362 autoneg (on|off) (port_id)
1366 * ``high_water`` (integer): High threshold value to trigger XOFF.
1368 * ``low_water`` (integer): Low threshold value to trigger XON.
1370 * ``pause_time`` (integer): Pause quota in the Pause frame.
1372 * ``send_xon`` (0/1): Send XON frame.
1374 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1376 * ``autoneg``: Change the auto-negotiation parameter.
1381 Set the priority flow control parameter on a port::
1383 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1384 (pause_time) (priority) (port_id)
1388 * ``high_water`` (integer): High threshold value.
1390 * ``low_water`` (integer): Low threshold value.
1392 * ``pause_time`` (integer): Pause quota in the Pause frame.
1394 * ``priority`` (0-7): VLAN User Priority.
1399 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1401 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1403 For example, to set rx queue 2 on port 0 to mapping 5::
1405 testpmd>set stat_qmap rx 0 2 5
1407 set xstats-hide-zero
1408 ~~~~~~~~~~~~~~~~~~~~
1410 Set the option to hide zero values for xstats display::
1412 testpmd> set xstats-hide-zero on|off
1416 By default, the zero values are displayed for xstats.
1418 set port - rx/tx (for VF)
1419 ~~~~~~~~~~~~~~~~~~~~~~~~~
1421 Set VF receive/transmit from a port::
1423 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1425 set port - mac address filter (for VF)
1426 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1428 Add/Remove unicast or multicast MAC addr filter for a VF::
1430 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1431 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1433 set port - rx mode(for VF)
1434 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1436 Set the VF receive mode of a port::
1438 testpmd> set port (port_id) vf (vf_id) \
1439 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1441 The available receive modes are:
1443 * ``AUPE``: Accepts untagged VLAN.
1445 * ``ROPE``: Accepts unicast hash.
1447 * ``BAM``: Accepts broadcast packets.
1449 * ``MPE``: Accepts all multicast packets.
1451 set port - tx_rate (for Queue)
1452 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1454 Set TX rate limitation for a queue on a port::
1456 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1458 set port - tx_rate (for VF)
1459 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1461 Set TX rate limitation for queues in VF on a port::
1463 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1465 set port - mirror rule
1466 ~~~~~~~~~~~~~~~~~~~~~~
1468 Set pool or vlan type mirror rule for a port::
1470 testpmd> set port (port_id) mirror-rule (rule_id) \
1471 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1472 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1474 Set link mirror rule for a port::
1476 testpmd> set port (port_id) mirror-rule (rule_id) \
1477 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1479 For example to enable mirror traffic with vlan 0,1 to pool 0::
1481 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1483 reset port - mirror rule
1484 ~~~~~~~~~~~~~~~~~~~~~~~~
1486 Reset a mirror rule for a port::
1488 testpmd> reset port (port_id) mirror-rule (rule_id)
1493 Set the flush on RX streams before forwarding.
1494 The default is flush ``on``.
1495 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1497 testpmd> set flush_rx off
1502 Set the bypass mode for the lowest port on bypass enabled NIC::
1504 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1509 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1511 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1512 mode (normal|bypass|isolate) (port_id)
1516 * ``timeout``: Enable bypass after watchdog timeout.
1518 * ``os_on``: Enable bypass when OS/board is powered on.
1520 * ``os_off``: Enable bypass when OS/board is powered off.
1522 * ``power_on``: Enable bypass when power supply is turned on.
1524 * ``power_off``: Enable bypass when power supply is turned off.
1530 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1532 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1537 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1539 testpmd> show bypass config (port_id)
1544 Set link up for a port::
1546 testpmd> set link-up port (port id)
1551 Set link down for a port::
1553 testpmd> set link-down port (port id)
1558 Enable E-tag insertion for a VF on a port::
1560 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1562 Disable E-tag insertion for a VF on a port::
1564 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1566 Enable/disable E-tag stripping on a port::
1568 testpmd> E-tag set stripping (on|off) port (port_id)
1570 Enable/disable E-tag based forwarding on a port::
1572 testpmd> E-tag set forwarding (on|off) port (port_id)
1574 Add an E-tag forwarding filter on a port::
1576 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1578 Delete an E-tag forwarding filter on a port::
1579 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1584 Load a dynamic device personalization (DDP) profile and store backup profile::
1586 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1591 Delete a dynamic device personalization profile and restore backup profile::
1593 testpmd> ddp del (port_id) (backup_profile_path)
1598 List all items from the ptype mapping table::
1600 testpmd> ptype mapping get (port_id) (valid_only)
1604 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1606 Replace a specific or a group of software defined ptype with a new one::
1608 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1612 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1614 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1616 * ``pkt_type``: The new software ptype to replace the old ones.
1618 Update hardware defined ptype to software defined packet type mapping table::
1620 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1624 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1626 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1628 Reset ptype mapping table::
1630 testpmd> ptype mapping reset (port_id)
1632 config per port Rx offloading
1633 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1635 Enable or disable a per port Rx offloading on all Rx queues of a port::
1637 testpmd> port config (port_id) rx_offload (offloading) on|off
1639 * ``offloading``: can be any of these offloading capability:
1640 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1641 qinq_strip, outer_ipv4_cksum, macsec_strip,
1642 header_split, vlan_filter, vlan_extend, jumbo_frame,
1643 crc_strip, scatter, timestamp, security, keep_crc
1645 This command should be run when the port is stopped, or else it will fail.
1647 config per queue Rx offloading
1648 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1650 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1652 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1654 * ``offloading``: can be any of these offloading capability:
1655 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1656 qinq_strip, outer_ipv4_cksum, macsec_strip,
1657 header_split, vlan_filter, vlan_extend, jumbo_frame,
1658 crc_strip, scatter, timestamp, security, keep_crc
1660 This command should be run when the port is stopped, or else it will fail.
1662 config per port Tx offloading
1663 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1665 Enable or disable a per port Tx offloading on all Tx queues of a port::
1667 testpmd> port config (port_id) tx_offload (offloading) on|off
1669 * ``offloading``: can be any of these offloading capability:
1670 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1671 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1672 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1673 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1674 mt_lockfree, multi_segs, mbuf_fast_free, security,
1677 This command should be run when the port is stopped, or else it will fail.
1679 config per queue Tx offloading
1680 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1682 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1684 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1686 * ``offloading``: can be any of these offloading capability:
1687 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1688 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1689 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1690 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1691 mt_lockfree, multi_segs, mbuf_fast_free, security
1693 This command should be run when the port is stopped, or else it will fail.
1695 Config VXLAN Encap outer layers
1696 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1698 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1700 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1701 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1704 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1705 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1706 eth-src (eth-src) eth-dst (eth-dst)
1708 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1709 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1710 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1712 These commands will set an internal configuration inside testpmd, any following
1713 flow rule using the action vxlan_encap will use the last configuration set.
1714 To have a different encapsulation header, one of those commands must be called
1715 before the flow rule creation.
1717 Config NVGRE Encap outer layers
1718 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1720 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1722 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1723 eth-src (eth-src) eth-dst (eth-dst)
1724 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1725 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1727 These commands will set an internal configuration inside testpmd, any following
1728 flow rule using the action nvgre_encap will use the last configuration set.
1729 To have a different encapsulation header, one of those commands must be called
1730 before the flow rule creation.
1735 Configure the l2 to be used when encapsulating a packet with L2::
1737 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1738 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1739 eth-src (eth-src) eth-dst (eth-dst)
1741 Those commands will set an internal configuration inside testpmd, any following
1742 flow rule using the action l2_encap will use the last configuration set.
1743 To have a different encapsulation header, one of those commands must be called
1744 before the flow rule creation.
1749 Configure the l2 to be removed when decapsulating a packet with L2::
1751 set l2_decap ip-version (ipv4|ipv6)
1752 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1754 Those commands will set an internal configuration inside testpmd, any following
1755 flow rule using the action l2_decap 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.
1759 Config MPLSoGRE Encap outer layers
1760 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1762 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1764 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1765 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1766 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1767 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1768 eth-src (eth-src) eth-dst (eth-dst)
1770 These commands will set an internal configuration inside testpmd, any following
1771 flow rule using the action mplsogre_encap will use the last configuration set.
1772 To have a different encapsulation header, one of those commands must be called
1773 before the flow rule creation.
1775 Config MPLSoGRE Decap outer layers
1776 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1778 Configure the outer layer to decapsulate MPLSoGRE packet::
1780 set mplsogre_decap ip-version (ipv4|ipv6)
1781 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1783 These commands will set an internal configuration inside testpmd, any following
1784 flow rule using the action mplsogre_decap will use the last configuration set.
1785 To have a different decapsulation header, one of those commands must be called
1786 before the flow rule creation.
1788 Config MPLSoUDP Encap outer layers
1789 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1791 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1793 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1794 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1795 eth-src (eth-src) eth-dst (eth-dst)
1796 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1797 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1798 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1800 These commands will set an internal configuration inside testpmd, any following
1801 flow rule using the action mplsoudp_encap will use the last configuration set.
1802 To have a different encapsulation header, one of those commands must be called
1803 before the flow rule creation.
1805 Config MPLSoUDP Decap outer layers
1806 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1808 Configure the outer layer to decapsulate MPLSoUDP packet::
1810 set mplsoudp_decap ip-version (ipv4|ipv6)
1811 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1813 These commands will set an internal configuration inside testpmd, any following
1814 flow rule using the action mplsoudp_decap will use the last configuration set.
1815 To have a different decapsulation header, one of those commands must be called
1816 before the flow rule creation.
1821 The following sections show functions for configuring ports.
1825 Port configuration changes only become active when forwarding is started/restarted.
1830 Attach a port specified by pci address or virtual device args::
1832 testpmd> port attach (identifier)
1834 To attach a new pci device, the device should be recognized by kernel first.
1835 Then it should be moved under DPDK management.
1836 Finally the port can be attached to testpmd.
1838 For example, to move a pci device using ixgbe under DPDK management:
1840 .. code-block:: console
1842 # Check the status of the available devices.
1843 ./usertools/dpdk-devbind.py --status
1845 Network devices using DPDK-compatible driver
1846 ============================================
1849 Network devices using kernel driver
1850 ===================================
1851 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1854 # Bind the device to igb_uio.
1855 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1858 # Recheck the status of the devices.
1859 ./usertools/dpdk-devbind.py --status
1860 Network devices using DPDK-compatible driver
1861 ============================================
1862 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1864 To attach a port created by virtual device, above steps are not needed.
1866 For example, to attach a port whose pci address is 0000:0a:00.0.
1868 .. code-block:: console
1870 testpmd> port attach 0000:0a:00.0
1871 Attaching a new port...
1872 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1873 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1874 EAL: PCI memory mapped at 0x7f83bfa00000
1875 EAL: PCI memory mapped at 0x7f83bfa80000
1876 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1877 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1878 Port 0 is attached. Now total ports is 1
1881 For example, to attach a port created by pcap PMD.
1883 .. code-block:: console
1885 testpmd> port attach net_pcap0
1886 Attaching a new port...
1887 PMD: Initializing pmd_pcap for net_pcap0
1888 PMD: Creating pcap-backed ethdev on numa socket 0
1889 Port 0 is attached. Now total ports is 1
1892 In this case, identifier is ``net_pcap0``.
1893 This identifier format is the same as ``--vdev`` format of DPDK applications.
1895 For example, to re-attach a bonded port which has been previously detached,
1896 the mode and slave parameters must be given.
1898 .. code-block:: console
1900 testpmd> port attach net_bond_0,mode=0,slave=1
1901 Attaching a new port...
1902 EAL: Initializing pmd_bond for net_bond_0
1903 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1904 Port 0 is attached. Now total ports is 1
1911 Detach a specific port::
1913 testpmd> port detach (port_id)
1915 Before detaching a port, the port should be stopped and closed.
1917 For example, to detach a pci device port 0.
1919 .. code-block:: console
1921 testpmd> port stop 0
1924 testpmd> port close 0
1928 testpmd> port detach 0
1930 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1931 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1932 EAL: PCI memory unmapped at 0x7f83bfa00000
1933 EAL: PCI memory unmapped at 0x7f83bfa80000
1937 For example, to detach a virtual device port 0.
1939 .. code-block:: console
1941 testpmd> port stop 0
1944 testpmd> port close 0
1948 testpmd> port detach 0
1950 PMD: Closing pcap ethdev on numa socket 0
1951 Port 'net_pcap0' is detached. Now total ports is 0
1954 To remove a pci device completely from the system, first detach the port from testpmd.
1955 Then the device should be moved under kernel management.
1956 Finally the device can be removed using kernel pci hotplug functionality.
1958 For example, to move a pci device under kernel management:
1960 .. code-block:: console
1962 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
1964 ./usertools/dpdk-devbind.py --status
1966 Network devices using DPDK-compatible driver
1967 ============================================
1970 Network devices using kernel driver
1971 ===================================
1972 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
1974 To remove a port created by a virtual device, above steps are not needed.
1979 Start all ports or a specific port::
1981 testpmd> port start (port_id|all)
1986 Stop all ports or a specific port::
1988 testpmd> port stop (port_id|all)
1993 Close all ports or a specific port::
1995 testpmd> port close (port_id|all)
1997 port config - queue ring size
1998 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2000 Configure a rx/tx queue ring size::
2002 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2004 Only take effect after command that (re-)start the port or command that setup specific queue.
2006 port start/stop queue
2007 ~~~~~~~~~~~~~~~~~~~~~
2009 Start/stop a rx/tx queue on a specific port::
2011 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2013 port config - queue deferred start
2014 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2016 Switch on/off deferred start of a specific port queue::
2018 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2021 ~~~~~~~~~~~~~~~~~~~~~
2023 Setup a rx/tx queue on a specific port::
2025 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2027 Only take effect when port is started.
2032 Set the speed and duplex mode for all ports or a specific port::
2034 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|auto) \
2035 duplex (half|full|auto)
2037 port config - queues/descriptors
2038 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2040 Set number of queues/descriptors for rxq, txq, rxd and txd::
2042 testpmd> port config all (rxq|txq|rxd|txd) (value)
2044 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2046 port config - max-pkt-len
2047 ~~~~~~~~~~~~~~~~~~~~~~~~~
2049 Set the maximum packet length::
2051 testpmd> port config all max-pkt-len (value)
2053 This is equivalent to the ``--max-pkt-len`` command-line option.
2055 port config - CRC Strip
2056 ~~~~~~~~~~~~~~~~~~~~~~~
2058 Set hardware CRC stripping on or off for all ports::
2060 testpmd> port config all crc-strip (on|off)
2062 CRC stripping is on by default.
2064 The ``off`` option is equivalent to the ``--disable-crc-strip`` command-line option.
2066 port config - scatter
2067 ~~~~~~~~~~~~~~~~~~~~~~~
2069 Set RX scatter mode on or off for all ports::
2071 testpmd> port config all scatter (on|off)
2073 RX scatter mode is off by default.
2075 The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
2077 port config - RX Checksum
2078 ~~~~~~~~~~~~~~~~~~~~~~~~~
2080 Set hardware RX checksum offload to on or off for all ports::
2082 testpmd> port config all rx-cksum (on|off)
2084 Checksum offload is off by default.
2086 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
2091 Set hardware VLAN on or off for all ports::
2093 testpmd> port config all hw-vlan (on|off)
2095 Hardware VLAN is off by default.
2097 The ``on`` option is equivalent to the ``--enable-hw-vlan`` command-line option.
2099 port config - VLAN filter
2100 ~~~~~~~~~~~~~~~~~~~~~~~~~
2102 Set hardware VLAN filter on or off for all ports::
2104 testpmd> port config all hw-vlan-filter (on|off)
2106 Hardware VLAN filter is off by default.
2108 The ``on`` option is equivalent to the ``--enable-hw-vlan-filter`` command-line option.
2110 port config - VLAN strip
2111 ~~~~~~~~~~~~~~~~~~~~~~~~
2113 Set hardware VLAN strip on or off for all ports::
2115 testpmd> port config all hw-vlan-strip (on|off)
2117 Hardware VLAN strip is off by default.
2119 The ``on`` option is equivalent to the ``--enable-hw-vlan-strip`` command-line option.
2121 port config - VLAN extend
2122 ~~~~~~~~~~~~~~~~~~~~~~~~~
2124 Set hardware VLAN extend on or off for all ports::
2126 testpmd> port config all hw-vlan-extend (on|off)
2128 Hardware VLAN extend is off by default.
2130 The ``on`` option is equivalent to the ``--enable-hw-vlan-extend`` command-line option.
2132 port config - Drop Packets
2133 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2135 Set packet drop for packets with no descriptors on or off for all ports::
2137 testpmd> port config all drop-en (on|off)
2139 Packet dropping for packets with no descriptors is off by default.
2141 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2146 Set the RSS (Receive Side Scaling) mode on or off::
2148 testpmd> port config all rss (all|default|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|none)
2150 RSS is on by default.
2152 The ``all`` option is equivalent to ip|tcp|udp|sctp|ether.
2153 The ``default`` option enables all supported RSS types reported by device info.
2154 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2156 port config - RSS Reta
2157 ~~~~~~~~~~~~~~~~~~~~~~
2159 Set the RSS (Receive Side Scaling) redirection table::
2161 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2166 Set the DCB mode for an individual port::
2168 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2170 The traffic class should be 4 or 8.
2175 Set the number of packets per burst::
2177 testpmd> port config all burst (value)
2179 This is equivalent to the ``--burst`` command-line option.
2181 port config - Threshold
2182 ~~~~~~~~~~~~~~~~~~~~~~~
2184 Set thresholds for TX/RX queues::
2186 testpmd> port config all (threshold) (value)
2188 Where the threshold type can be:
2190 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2192 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2194 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2196 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2198 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2200 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2202 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2204 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2206 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2208 These threshold options are also available from the command-line.
2213 Set the value of ether-type for E-tag::
2215 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2217 Enable/disable the E-tag support::
2219 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2221 port config pctype mapping
2222 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2224 Reset pctype mapping table::
2226 testpmd> port config (port_id) pctype mapping reset
2228 Update hardware defined pctype to software defined flow type mapping table::
2230 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2234 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2236 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2238 port config input set
2239 ~~~~~~~~~~~~~~~~~~~~~
2241 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2243 testpmd> port config (port_id) pctype (pctype_id) \
2244 (hash_inset|fdir_inset|fdir_flx_inset) \
2245 (get|set|clear) field (field_idx)
2247 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2249 testpmd> port config (port_id) pctype (pctype_id) \
2250 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2254 * ``pctype_id``: hardware packet classification types.
2255 * ``field_idx``: hardware field index.
2257 port config udp_tunnel_port
2258 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2260 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2262 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2264 port config tx_metadata
2265 ~~~~~~~~~~~~~~~~~~~~~~~
2267 Set Tx metadata value per port.
2268 testpmd will add this value to any Tx packet sent from this port::
2270 testpmd> port config (port_id) tx_metadata (value)
2275 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2277 testpmd> port config mtu (port_id) (value)
2279 port config rss hash key
2280 ~~~~~~~~~~~~~~~~~~~~~~~~
2282 To configure the RSS hash key used to compute the RSS
2283 hash of input [IP] packets received on port::
2285 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2286 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2287 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2288 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2289 ipv6-udp-ex <string of hex digits \
2290 (variable length, NIC dependent)>)
2292 Link Bonding Functions
2293 ----------------------
2295 The Link Bonding functions make it possible to dynamically create and
2296 manage link bonding devices from within testpmd interactive prompt.
2298 create bonded device
2299 ~~~~~~~~~~~~~~~~~~~~
2301 Create a new bonding device::
2303 testpmd> create bonded device (mode) (socket)
2305 For example, to create a bonded device in mode 1 on socket 0::
2307 testpmd> create bonded device 1 0
2308 created new bonded device (port X)
2313 Adds Ethernet device to a Link Bonding device::
2315 testpmd> add bonding slave (slave id) (port id)
2317 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2319 testpmd> add bonding slave 6 10
2322 remove bonding slave
2323 ~~~~~~~~~~~~~~~~~~~~
2325 Removes an Ethernet slave device from a Link Bonding device::
2327 testpmd> remove bonding slave (slave id) (port id)
2329 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2331 testpmd> remove bonding slave 6 10
2336 Set the Link Bonding mode of a Link Bonding device::
2338 testpmd> set bonding mode (value) (port id)
2340 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2342 testpmd> set bonding mode 3 10
2347 Set an Ethernet slave device as the primary device on a Link Bonding device::
2349 testpmd> set bonding primary (slave id) (port id)
2351 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2353 testpmd> set bonding primary 6 10
2358 Set the MAC address of a Link Bonding device::
2360 testpmd> set bonding mac (port id) (mac)
2362 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2364 testpmd> set bonding mac 10 00:00:00:00:00:01
2366 set bonding xmit_balance_policy
2367 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2369 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2371 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2373 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2375 testpmd> set bonding xmit_balance_policy 10 l34
2378 set bonding mon_period
2379 ~~~~~~~~~~~~~~~~~~~~~~
2381 Set the link status monitoring polling period in milliseconds for a bonding device.
2383 This adds support for PMD slave devices which do not support link status interrupts.
2384 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2385 link status ISR will be queried every polling interval to check if their link status has changed::
2387 testpmd> set bonding mon_period (port_id) (value)
2389 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2391 testpmd> set bonding mon_period 5 150
2394 set bonding lacp dedicated_queue
2395 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2397 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2398 when in mode 4 (link-aggregation-802.3ad)::
2400 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2403 set bonding agg_mode
2404 ~~~~~~~~~~~~~~~~~~~~
2406 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2408 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2414 Show the current configuration of a Link Bonding device::
2416 testpmd> show bonding config (port id)
2419 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2420 in balance mode with a transmission policy of layer 2+3::
2422 testpmd> show bonding config 9
2424 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2426 Active Slaves (3): [1 3 4]
2433 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2434 This is mainly useful for debugging purposes.
2435 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2436 and fields that can be accessed.
2441 Display the value of a port register::
2443 testpmd> read reg (port_id) (address)
2445 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2447 testpmd> read reg 0 0xEE00
2448 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2453 Display a port register bit field::
2455 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2457 For example, reading the lowest two bits from the register in the example above::
2459 testpmd> read regfield 0 0xEE00 0 1
2460 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2465 Display a single port register bit::
2467 testpmd> read regbit (port_id) (address) (bit_x)
2469 For example, reading the lowest bit from the register in the example above::
2471 testpmd> read regbit 0 0xEE00 0
2472 port 0 PCI register at offset 0xEE00: bit 0=1
2477 Set the value of a port register::
2479 testpmd> write reg (port_id) (address) (value)
2481 For example, to clear a register::
2483 testpmd> write reg 0 0xEE00 0x0
2484 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2489 Set bit field of a port register::
2491 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2493 For example, writing to the register cleared in the example above::
2495 testpmd> write regfield 0 0xEE00 0 1 2
2496 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2501 Set single bit value of a port register::
2503 testpmd> write regbit (port_id) (address) (bit_x) (value)
2505 For example, to set the high bit in the register from the example above::
2507 testpmd> write regbit 0 0xEE00 31 1
2508 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2510 Traffic Metering and Policing
2511 -----------------------------
2513 The following section shows functions for configuring traffic metering and
2514 policing on the ethernet device through the use of generic ethdev API.
2516 show port traffic management capability
2517 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2519 Show traffic metering and policing capability of the port::
2521 testpmd> show port meter cap (port_id)
2523 add port meter profile (srTCM rfc2967)
2524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2526 Add meter profile (srTCM rfc2697) to the ethernet device::
2528 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2533 * ``profile_id``: ID for the meter profile.
2534 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2535 * ``cbs``: Committed Burst Size (CBS) (bytes).
2536 * ``ebs``: Excess Burst Size (EBS) (bytes).
2538 add port meter profile (trTCM rfc2968)
2539 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2541 Add meter profile (srTCM rfc2698) to the ethernet device::
2543 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2544 (cir) (pir) (cbs) (pbs)
2548 * ``profile_id``: ID for the meter profile.
2549 * ``cir``: Committed information rate (bytes/second).
2550 * ``pir``: Peak information rate (bytes/second).
2551 * ``cbs``: Committed burst size (bytes).
2552 * ``pbs``: Peak burst size (bytes).
2554 add port meter profile (trTCM rfc4115)
2555 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2557 Add meter profile (trTCM rfc4115) to the ethernet device::
2559 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2560 (cir) (eir) (cbs) (ebs)
2564 * ``profile_id``: ID for the meter profile.
2565 * ``cir``: Committed information rate (bytes/second).
2566 * ``eir``: Excess information rate (bytes/second).
2567 * ``cbs``: Committed burst size (bytes).
2568 * ``ebs``: Excess burst size (bytes).
2570 delete port meter profile
2571 ~~~~~~~~~~~~~~~~~~~~~~~~~
2573 Delete meter profile from the ethernet device::
2575 testpmd> del port meter profile (port_id) (profile_id)
2580 Create new meter object for the ethernet device::
2582 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2583 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2584 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2589 * ``mtr_id``: meter object ID.
2590 * ``profile_id``: ID for the meter profile.
2591 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2592 gets enabled at the time of creation, otherwise remains disabled.
2593 * ``g_action``: Policer action for the packet with green color.
2594 * ``y_action``: Policer action for the packet with yellow color.
2595 * ``r_action``: Policer action for the packet with red color.
2596 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2598 * ``shared``: When this parameter has a non-zero value, the meter object is
2599 shared by multiple flows. Otherwise, meter object is used by single flow.
2600 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2601 input color for the current meter object is determined by the latest meter
2602 object in the same flow. Otherwise, the current meter object uses the
2603 *dscp_table* to determine the input color.
2604 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2605 color, 0 <= x <= 63.
2610 Enable meter for the ethernet device::
2612 testpmd> enable port meter (port_id) (mtr_id)
2617 Disable meter for the ethernet device::
2619 testpmd> disable port meter (port_id) (mtr_id)
2624 Delete meter for the ethernet device::
2626 testpmd> del port meter (port_id) (mtr_id)
2628 Set port meter profile
2629 ~~~~~~~~~~~~~~~~~~~~~~
2631 Set meter profile for the ethernet device::
2633 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2635 set port meter dscp table
2636 ~~~~~~~~~~~~~~~~~~~~~~~~~
2638 Set meter dscp table for the ethernet device::
2640 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2641 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2643 set port meter policer action
2644 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2646 Set meter policer action for the ethernet device::
2648 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2649 (action0) [(action1) (action1)]
2653 * ``action_mask``: Bit mask indicating which policer actions need to be
2654 updated. One or more policer actions can be updated in a single function
2655 invocation. To update the policer action associated with color C, bit
2656 (1 << C) needs to be set in *action_mask* and element at position C
2657 in the *actions* array needs to be valid.
2658 * ``actionx``: Policer action for the color x,
2659 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2661 set port meter stats mask
2662 ~~~~~~~~~~~~~~~~~~~~~~~~~
2664 Set meter stats mask for the ethernet device::
2666 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2670 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2672 show port meter stats
2673 ~~~~~~~~~~~~~~~~~~~~~
2675 Show meter stats of the ethernet device::
2677 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2681 * ``clear``: Flag that indicates whether the statistics counters should
2682 be cleared (i.e. set to zero) immediately after they have been read or not.
2687 The following section shows functions for configuring traffic management on
2688 on the ethernet device through the use of generic TM API.
2690 show port traffic management capability
2691 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2693 Show traffic management capability of the port::
2695 testpmd> show port tm cap (port_id)
2697 show port traffic management capability (hierarchy level)
2698 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2700 Show traffic management hierarchy level capability of the port::
2702 testpmd> show port tm level cap (port_id) (level_id)
2704 show port traffic management capability (hierarchy node level)
2705 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2707 Show the traffic management hierarchy node capability of the port::
2709 testpmd> show port tm node cap (port_id) (node_id)
2711 show port traffic management hierarchy node type
2712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2714 Show the port traffic management hierarchy node type::
2716 testpmd> show port tm node type (port_id) (node_id)
2718 show port traffic management hierarchy node stats
2719 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2721 Show the port traffic management hierarchy node statistics::
2723 testpmd> show port tm node stats (port_id) (node_id) (clear)
2727 * ``clear``: When this parameter has a non-zero value, the statistics counters
2728 are cleared (i.e. set to zero) immediately after they have been read,
2729 otherwise the statistics counters are left untouched.
2731 Add port traffic management private shaper profile
2732 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2734 Add the port traffic management private shaper profile::
2736 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2737 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2738 (packet_length_adjust)
2742 * ``shaper_profile id``: Shaper profile ID for the new profile.
2743 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second).
2744 * ``cmit_tb_size``: Committed token bucket size (bytes).
2745 * ``peak_tb_rate``: Peak token bucket rate (bytes per second).
2746 * ``peak_tb_size``: Peak token bucket size (bytes).
2747 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2748 each packet for the purpose of shaping. This parameter value can be used to
2749 correct the packet length with the framing overhead bytes that are consumed
2752 Delete port traffic management private shaper profile
2753 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2755 Delete the port traffic management private shaper::
2757 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2761 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2763 Add port traffic management shared shaper
2764 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2766 Create the port traffic management shared shaper::
2768 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2773 * ``shared_shaper_id``: Shared shaper ID to be created.
2774 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2776 Set port traffic management shared shaper
2777 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2779 Update the port traffic management shared shaper::
2781 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2786 * ``shared_shaper_id``: Shared shaper ID to be update.
2787 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2789 Delete port traffic management shared shaper
2790 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2792 Delete the port traffic management shared shaper::
2794 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2798 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2800 Set port traffic management hierarchy node private shaper
2801 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2803 set the port traffic management hierarchy node private shaper::
2805 testpmd> set port tm node shaper profile (port_id) (node_id) \
2810 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
2813 Add port traffic management WRED profile
2814 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2816 Create a new WRED profile::
2818 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
2819 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
2820 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
2821 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
2825 * ``wred_profile id``: Identifier for the newly create WRED profile
2826 * ``color_g``: Packet color (green)
2827 * ``min_th_g``: Minimum queue threshold for packet with green color
2828 * ``max_th_g``: Minimum queue threshold for packet with green color
2829 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
2830 * ``wq_log2_g``: Negated log2 of queue weight (wq)
2831 * ``color_y``: Packet color (yellow)
2832 * ``min_th_y``: Minimum queue threshold for packet with yellow color
2833 * ``max_th_y``: Minimum queue threshold for packet with yellow color
2834 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
2835 * ``wq_log2_y``: Negated log2 of queue weight (wq)
2836 * ``color_r``: Packet color (red)
2837 * ``min_th_r``: Minimum queue threshold for packet with yellow color
2838 * ``max_th_r``: Minimum queue threshold for packet with yellow color
2839 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
2840 * ``wq_log2_r``: Negated log2 of queue weight (wq)
2842 Delete port traffic management WRED profile
2843 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2845 Delete the WRED profile::
2847 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
2849 Add port traffic management hierarchy nonleaf node
2850 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2852 Add nonleaf node to port traffic management hierarchy::
2854 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
2855 (priority) (weight) (level_id) (shaper_profile_id) \
2856 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
2857 [(shared_shaper_0) (shared_shaper_1) ...] \
2861 * ``parent_node_id``: Node ID of the parent.
2862 * ``priority``: Node priority (highest node priority is zero). This is used by
2863 the SP algorithm running on the parent node for scheduling this node.
2864 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2865 to the weight sum of all siblings that have the same priority. It is used by
2866 the WFQ algorithm running on the parent node for scheduling this node.
2867 * ``level_id``: Hierarchy level of the node.
2868 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2870 * ``n_sp_priorities``: Number of strict priorities.
2871 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2872 * ``n_shared_shapers``: Number of shared shapers.
2873 * ``shared_shaper_id``: Shared shaper id.
2875 Add port traffic management hierarchy leaf node
2876 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2878 Add leaf node to port traffic management hierarchy::
2880 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
2881 (priority) (weight) (level_id) (shaper_profile_id) \
2882 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
2883 [(shared_shaper_id) (shared_shaper_id) ...] \
2887 * ``parent_node_id``: Node ID of the parent.
2888 * ``priority``: Node priority (highest node priority is zero). This is used by
2889 the SP algorithm running on the parent node for scheduling this node.
2890 * ``weight``: Node weight (lowest weight is one). The node weight is relative
2891 to the weight sum of all siblings that have the same priority. It is used by
2892 the WFQ algorithm running on the parent node for scheduling this node.
2893 * ``level_id``: Hierarchy level of the node.
2894 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
2896 * ``cman_mode``: Congestion management mode to be enabled for this node.
2897 * ``wred_profile_id``: WRED profile id to be enabled for this node.
2898 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
2899 * ``n_shared_shapers``: Number of shared shapers.
2900 * ``shared_shaper_id``: Shared shaper id.
2902 Delete port traffic management hierarchy node
2903 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2905 Delete node from port traffic management hierarchy::
2907 testpmd> del port tm node (port_id) (node_id)
2909 Update port traffic management hierarchy parent node
2910 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2912 Update port traffic management hierarchy parent node::
2914 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
2917 This function can only be called after the hierarchy commit invocation. Its
2918 success depends on the port support for this operation, as advertised through
2919 the port capability set. This function is valid for all nodes of the traffic
2920 management hierarchy except root node.
2922 Suspend port traffic management hierarchy node
2923 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2925 testpmd> suspend port tm node (port_id) (node_id)
2927 Resume port traffic management hierarchy node
2928 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2930 testpmd> resume port tm node (port_id) (node_id)
2932 Commit port traffic management hierarchy
2933 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2935 Commit the traffic management hierarchy on the port::
2937 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
2941 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
2942 call failure. On the other hand, hierarchy is preserved when this parameter
2945 Set port traffic management mark VLAN dei
2946 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2948 Enables/Disables the traffic management marking on the port for VLAN packets::
2950 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
2954 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
2955 ``yellow`` or ``red`` will have dei bit enabled
2957 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
2959 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
2961 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
2963 Set port traffic management mark IP dscp
2964 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2966 Enables/Disables the traffic management marking on the port for IP dscp packets::
2968 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
2972 * ``port_id``: The port which on which IP packets marked as ``green`` or
2973 ``yellow`` or ``red`` will have IP dscp bits updated
2975 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
2977 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
2979 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
2981 Set port traffic management mark IP ecn
2982 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2984 Enables/Disables the traffic management marking on the port for IP ecn packets::
2986 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
2990 * ``port_id``: The port which on which IP packets marked as ``green`` or
2991 ``yellow`` or ``red`` will have IP ecn bits updated
2993 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
2994 to ecn of 2'b11 when IP is caring TCP or SCTP
2996 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
2997 to ecn of 2'b11 when IP is caring TCP or SCTP
2999 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3000 to ecn of 2'b11 when IP is caring TCP or SCTP
3002 Set port traffic management default hierarchy (softnic forwarding mode)
3003 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3005 set the traffic management default hierarchy on the port::
3007 testpmd> set port tm hierarchy default (port_id)
3012 This section details the available filter functions that are available.
3014 Note these functions interface the deprecated legacy filtering framework,
3015 superseded by *rte_flow*. See `Flow rules management`_.
3018 ~~~~~~~~~~~~~~~~~~~~
3020 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3022 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3023 ethertype (ether_type) (drop|fwd) queue (queue_id)
3025 The available information parameters are:
3027 * ``port_id``: The port which the Ethertype filter assigned on.
3029 * ``mac_addr``: Compare destination mac address.
3031 * ``mac_ignr``: Ignore destination mac address match.
3033 * ``mac_address``: Destination mac address to match.
3035 * ``ether_type``: The EtherType value want to match,
3036 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3038 * ``queue_id``: The receive queue associated with this EtherType filter.
3039 It is meaningless when deleting or dropping.
3041 Example, to add/remove an ethertype filter rule::
3043 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3044 ethertype 0x0806 fwd queue 3
3046 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3047 ethertype 0x0806 fwd queue 3
3052 Add or delete a 2-tuple filter,
3053 which identifies packets by specific protocol and destination TCP/UDP port
3054 and forwards packets into one of the receive queues::
3056 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3057 protocol (protocol_value) mask (mask_value) \
3058 tcp_flags (tcp_flags_value) priority (prio_value) \
3061 The available information parameters are:
3063 * ``port_id``: The port which the 2-tuple filter assigned on.
3065 * ``dst_port_value``: Destination port in L4.
3067 * ``protocol_value``: IP L4 protocol.
3069 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3071 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3073 * ``prio_value``: Priority of this filter.
3075 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3077 Example, to add/remove an 2tuple filter rule::
3079 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3080 tcp_flags 0x02 priority 3 queue 3
3082 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3083 tcp_flags 0x02 priority 3 queue 3
3088 Add or delete a 5-tuple filter,
3089 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3090 and routes packets into one of the receive queues::
3092 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3093 (src_address) dst_port (dst_port_value) \
3094 src_port (src_port_value) protocol (protocol_value) \
3095 mask (mask_value) tcp_flags (tcp_flags_value) \
3096 priority (prio_value) queue (queue_id)
3098 The available information parameters are:
3100 * ``port_id``: The port which the 5-tuple filter assigned on.
3102 * ``dst_address``: Destination IP address.
3104 * ``src_address``: Source IP address.
3106 * ``dst_port_value``: TCP/UDP destination port.
3108 * ``src_port_value``: TCP/UDP source port.
3110 * ``protocol_value``: L4 protocol.
3112 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3114 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3116 * ``prio_value``: The priority of this filter.
3118 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3120 Example, to add/remove an 5tuple filter rule::
3122 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3123 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3124 flags 0x0 priority 3 queue 3
3126 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3127 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3128 flags 0x0 priority 3 queue 3
3133 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3135 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3137 The available information parameters are:
3139 * ``port_id``: The port which the SYN filter assigned on.
3141 * ``high``: This SYN filter has higher priority than other filters.
3143 * ``low``: This SYN filter has lower priority than other filters.
3145 * ``queue_id``: The receive queue associated with this SYN filter
3149 testpmd> syn_filter 0 add priority high queue 3
3154 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3155 and routed into one of the receive queues::
3157 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3158 mask (mask_value) priority (prio_value) queue (queue_id)
3160 The available information parameters are:
3162 * ``port_id``: The port which the Flex filter is assigned on.
3164 * ``len_value``: Filter length in bytes, no greater than 128.
3166 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3168 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3170 * ``prio_value``: The priority of this filter.
3172 * ``queue_id``: The receive queue associated with this Flex filter.
3176 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3177 mask 000C priority 3 queue 3
3179 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3180 mask 000C priority 3 queue 3
3183 .. _testpmd_flow_director:
3185 flow_director_filter
3186 ~~~~~~~~~~~~~~~~~~~~
3188 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3190 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3191 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3193 * Perfect match filters.
3194 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3195 The masked fields are for IP flow.
3197 * Signature filters.
3198 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3200 * Perfect-mac-vlan match filters.
3201 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3202 The masked fields are for MAC VLAN flow.
3204 * Perfect-tunnel match filters.
3205 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3206 The masked fields are for tunnel flow.
3208 * Perfect-raw-flow-type match filters.
3209 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3210 The masked fields are specified by input sets.
3212 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3213 per flow type and the flexible payload.
3215 The Flow Director can also mask out parts of all of these fields so that filters
3216 are only applied to certain fields or parts of the fields.
3218 Note that for raw flow type mode the source and destination fields in the
3219 raw packet buffer need to be presented in a reversed order with respect
3220 to the expected received packets.
3221 For example: IP source and destination addresses or TCP/UDP/SCTP
3222 source and destination ports
3224 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3226 # Commands to add flow director filters of different flow types::
3228 flow_director_filter (port_id) mode IP (add|del|update) \
3229 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3230 src (src_ip_address) dst (dst_ip_address) \
3231 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3232 vlan (vlan_value) flexbytes (flexbytes_value) \
3233 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3236 flow_director_filter (port_id) mode IP (add|del|update) \
3237 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3238 src (src_ip_address) (src_port) \
3239 dst (dst_ip_address) (dst_port) \
3240 tos (tos_value) ttl (ttl_value) \
3241 vlan (vlan_value) flexbytes (flexbytes_value) \
3242 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3245 flow_director_filter (port_id) mode IP (add|del|update) \
3246 flow (ipv4-sctp|ipv6-sctp) \
3247 src (src_ip_address) (src_port) \
3248 dst (dst_ip_address) (dst_port) \
3249 tos (tos_value) ttl (ttl_value) \
3250 tag (verification_tag) vlan (vlan_value) \
3251 flexbytes (flexbytes_value) (drop|fwd) \
3252 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3254 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3255 ether (ethertype) flexbytes (flexbytes_value) \
3256 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3259 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3260 mac (mac_address) vlan (vlan_value) \
3261 flexbytes (flexbytes_value) (drop|fwd) \
3262 queue (queue_id) fd_id (fd_id_value)
3264 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3265 mac (mac_address) vlan (vlan_value) \
3266 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3267 flexbytes (flexbytes_value) (drop|fwd) \
3268 queue (queue_id) fd_id (fd_id_value)
3270 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3271 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3272 packet (packet file name)
3274 For example, to add an ipv4-udp flow type filter::
3276 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3277 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3278 fwd pf queue 1 fd_id 1
3280 For example, add an ipv4-other flow type filter::
3282 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3283 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3284 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3289 Flush all flow director filters on a device::
3291 testpmd> flush_flow_director (port_id)
3293 Example, to flush all flow director filter on port 0::
3295 testpmd> flush_flow_director 0
3300 Set flow director's input masks::
3302 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3303 src_mask (ipv4_src) (ipv6_src) (src_port) \
3304 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3306 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3308 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3309 mac (mac_value) tunnel-type (tunnel_type_value) \
3310 tunnel-id (tunnel_id_value)
3312 Example, to set flow director mask on port 0::
3314 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3315 src_mask 255.255.255.255 \
3316 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3317 dst_mask 255.255.255.255 \
3318 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3320 flow_director_flex_mask
3321 ~~~~~~~~~~~~~~~~~~~~~~~
3323 set masks of flow director's flexible payload based on certain flow type::
3325 testpmd> flow_director_flex_mask (port_id) \
3326 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3327 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3328 l2_payload|all) (mask)
3330 Example, to set flow director's flex mask for all flow type on port 0::
3332 testpmd> flow_director_flex_mask 0 flow all \
3333 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3336 flow_director_flex_payload
3337 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3339 Configure flexible payload selection::
3341 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3343 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3345 testpmd> flow_director_flex_payload 0 l4 \
3346 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3348 get_sym_hash_ena_per_port
3349 ~~~~~~~~~~~~~~~~~~~~~~~~~
3351 Get symmetric hash enable configuration per port::
3353 get_sym_hash_ena_per_port (port_id)
3355 For example, to get symmetric hash enable configuration of port 1::
3357 testpmd> get_sym_hash_ena_per_port 1
3359 set_sym_hash_ena_per_port
3360 ~~~~~~~~~~~~~~~~~~~~~~~~~
3362 Set symmetric hash enable configuration per port to enable or disable::
3364 set_sym_hash_ena_per_port (port_id) (enable|disable)
3366 For example, to set symmetric hash enable configuration of port 1 to enable::
3368 testpmd> set_sym_hash_ena_per_port 1 enable
3370 get_hash_global_config
3371 ~~~~~~~~~~~~~~~~~~~~~~
3373 Get the global configurations of hash filters::
3375 get_hash_global_config (port_id)
3377 For example, to get the global configurations of hash filters of port 1::
3379 testpmd> get_hash_global_config 1
3381 set_hash_global_config
3382 ~~~~~~~~~~~~~~~~~~~~~~
3384 Set the global configurations of hash filters::
3386 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
3387 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3388 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3391 For example, to enable simple_xor for flow type of ipv6 on port 2::
3393 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3398 Set the input set for hash::
3400 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3401 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3402 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3403 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3404 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3405 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3406 fld-8th|none) (select|add)
3408 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3410 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3415 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3416 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3418 Set the input set for flow director::
3420 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3421 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3422 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3423 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3424 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3425 sctp-dst-port|sctp-veri-tag|none) (select|add)
3427 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3429 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3434 Set different GRE key length for input set::
3436 global_config (port_id) gre-key-len (number in bytes)
3438 For example to set GRE key length for input set to 4 bytes on port 0::
3440 testpmd> global_config 0 gre-key-len 4
3443 .. _testpmd_rte_flow:
3445 Flow rules management
3446 ---------------------
3448 Control of the generic flow API (*rte_flow*) is fully exposed through the
3449 ``flow`` command (validation, creation, destruction, queries and operation
3452 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3453 features simultaneously may cause undefined side-effects and is therefore
3459 Because the ``flow`` command uses dynamic tokens to handle the large number
3460 of possible flow rules combinations, its behavior differs slightly from
3461 other commands, in particular:
3463 - Pressing *?* or the *<tab>* key displays contextual help for the current
3464 token, not that of the entire command.
3466 - Optional and repeated parameters are supported (provided they are listed
3467 in the contextual help).
3469 The first parameter stands for the operation mode. Possible operations and
3470 their general syntax are described below. They are covered in detail in the
3473 - Check whether a flow rule can be created::
3475 flow validate {port_id}
3476 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3477 pattern {item} [/ {item} [...]] / end
3478 actions {action} [/ {action} [...]] / end
3480 - Create a flow rule::
3482 flow create {port_id}
3483 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3484 pattern {item} [/ {item} [...]] / end
3485 actions {action} [/ {action} [...]] / end
3487 - Destroy specific flow rules::
3489 flow destroy {port_id} rule {rule_id} [...]
3491 - Destroy all flow rules::
3493 flow flush {port_id}
3495 - Query an existing flow rule::
3497 flow query {port_id} {rule_id} {action}
3499 - List existing flow rules sorted by priority, filtered by group
3502 flow list {port_id} [group {group_id}] [...]
3504 - Restrict ingress traffic to the defined flow rules::
3506 flow isolate {port_id} {boolean}
3508 Validating flow rules
3509 ~~~~~~~~~~~~~~~~~~~~~
3511 ``flow validate`` reports whether a flow rule would be accepted by the
3512 underlying device in its current state but stops short of creating it. It is
3513 bound to ``rte_flow_validate()``::
3515 flow validate {port_id}
3516 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3517 pattern {item} [/ {item} [...]] / end
3518 actions {action} [/ {action} [...]] / end
3520 If successful, it will show::
3524 Otherwise it will show an error message of the form::
3526 Caught error type [...] ([...]): [...]
3528 This command uses the same parameters as ``flow create``, their format is
3529 described in `Creating flow rules`_.
3531 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3532 index 6 is supported::
3534 testpmd> flow validate 0 ingress pattern eth / end
3535 actions queue index 6 / end
3539 Port 0 does not support TCPv6 rules::
3541 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3543 Caught error type 9 (specific pattern item): Invalid argument
3549 ``flow create`` validates and creates the specified flow rule. It is bound
3550 to ``rte_flow_create()``::
3552 flow create {port_id}
3553 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3554 pattern {item} [/ {item} [...]] / end
3555 actions {action} [/ {action} [...]] / end
3557 If successful, it will return a flow rule ID usable with other commands::
3559 Flow rule #[...] created
3561 Otherwise it will show an error message of the form::
3563 Caught error type [...] ([...]): [...]
3565 Parameters describe in the following order:
3567 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3568 - A matching pattern, starting with the *pattern* token and terminated by an
3570 - Actions, starting with the *actions* token and terminated by an *end*
3573 These translate directly to *rte_flow* objects provided as-is to the
3574 underlying functions.
3576 The shortest valid definition only comprises mandatory tokens::
3578 testpmd> flow create 0 pattern end actions end
3580 Note that PMDs may refuse rules that essentially do nothing such as this
3583 **All unspecified object values are automatically initialized to 0.**
3588 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3589 specified before the ``pattern`` token.
3591 - ``group {group id}``: priority group.
3592 - ``priority {level}``: priority level within group.
3593 - ``ingress``: rule applies to ingress traffic.
3594 - ``egress``: rule applies to egress traffic.
3595 - ``transfer``: apply rule directly to endpoints found in pattern.
3597 Each instance of an attribute specified several times overrides the previous
3598 value as shown below (group 4 is used)::
3600 testpmd> flow create 0 group 42 group 24 group 4 [...]
3602 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3604 While not specifying a direction is an error, some rules may allow both
3607 Most rules affect RX therefore contain the ``ingress`` token::
3609 testpmd> flow create 0 ingress pattern [...]
3614 A matching pattern starts after the ``pattern`` token. It is made of pattern
3615 items and is terminated by a mandatory ``end`` item.
3617 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3618 rte_flow_item_type``).
3620 The ``/`` token is used as a separator between pattern items as shown
3623 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3625 Note that protocol items like these must be stacked from lowest to highest
3626 layer to make sense. For instance, the following rule is either invalid or
3627 unlikely to match any packet::
3629 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3631 More information on these restrictions can be found in the *rte_flow*
3634 Several items support additional specification structures, for example
3635 ``ipv4`` allows specifying source and destination addresses as follows::
3637 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3638 dst is 10.2.0.0 / end [...]
3640 This rule matches all IPv4 traffic with the specified properties.
3642 In this example, ``src`` and ``dst`` are field names of the underlying
3643 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3644 in a similar fashion.
3646 The ``is`` token means that the subsequent value must be matched exactly,
3647 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3648 accordingly. Possible assignment tokens are:
3650 - ``is``: match value perfectly (with full bit-mask).
3651 - ``spec``: match value according to configured bit-mask.
3652 - ``last``: specify upper bound to establish a range.
3653 - ``mask``: specify bit-mask with relevant bits set to one.
3654 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3656 These yield identical results::
3658 ipv4 src is 10.1.1.1
3662 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3666 ipv4 src spec 10.1.1.1 src prefix 32
3670 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3674 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3676 Inclusive ranges can be defined with ``last``::
3678 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3680 Note that ``mask`` affects both ``spec`` and ``last``::
3682 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3683 # matches 10.1.0.0 to 10.2.255.255
3685 Properties can be modified multiple times::
3687 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3691 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3696 This section lists supported pattern items and their attributes, if any.
3698 - ``end``: end list of pattern items.
3700 - ``void``: no-op pattern item.
3702 - ``invert``: perform actions when pattern does not match.
3704 - ``any``: match any protocol for the current layer.
3706 - ``num {unsigned}``: number of layers covered.
3708 - ``pf``: match traffic from/to the physical function.
3710 - ``vf``: match traffic from/to a virtual function ID.
3712 - ``id {unsigned}``: VF ID.
3714 - ``phy_port``: match traffic from/to a specific physical port.
3716 - ``index {unsigned}``: physical port index.
3718 - ``port_id``: match traffic from/to a given DPDK port ID.
3720 - ``id {unsigned}``: DPDK port ID.
3722 - ``mark``: match value set in previously matched flow rule using the mark action.
3724 - ``id {unsigned}``: arbitrary integer value.
3726 - ``raw``: match an arbitrary byte string.
3728 - ``relative {boolean}``: look for pattern after the previous item.
3729 - ``search {boolean}``: search pattern from offset (see also limit).
3730 - ``offset {integer}``: absolute or relative offset for pattern.
3731 - ``limit {unsigned}``: search area limit for start of pattern.
3732 - ``pattern {string}``: byte string to look for.
3734 - ``eth``: match Ethernet header.
3736 - ``dst {MAC-48}``: destination MAC.
3737 - ``src {MAC-48}``: source MAC.
3738 - ``type {unsigned}``: EtherType or TPID.
3740 - ``vlan``: match 802.1Q/ad VLAN tag.
3742 - ``tci {unsigned}``: tag control information.
3743 - ``pcp {unsigned}``: priority code point.
3744 - ``dei {unsigned}``: drop eligible indicator.
3745 - ``vid {unsigned}``: VLAN identifier.
3746 - ``inner_type {unsigned}``: inner EtherType or TPID.
3748 - ``ipv4``: match IPv4 header.
3750 - ``tos {unsigned}``: type of service.
3751 - ``ttl {unsigned}``: time to live.
3752 - ``proto {unsigned}``: next protocol ID.
3753 - ``src {ipv4 address}``: source address.
3754 - ``dst {ipv4 address}``: destination address.
3756 - ``ipv6``: match IPv6 header.
3758 - ``tc {unsigned}``: traffic class.
3759 - ``flow {unsigned}``: flow label.
3760 - ``proto {unsigned}``: protocol (next header).
3761 - ``hop {unsigned}``: hop limit.
3762 - ``src {ipv6 address}``: source address.
3763 - ``dst {ipv6 address}``: destination address.
3765 - ``icmp``: match ICMP header.
3767 - ``type {unsigned}``: ICMP packet type.
3768 - ``code {unsigned}``: ICMP packet code.
3770 - ``udp``: match UDP header.
3772 - ``src {unsigned}``: UDP source port.
3773 - ``dst {unsigned}``: UDP destination port.
3775 - ``tcp``: match TCP header.
3777 - ``src {unsigned}``: TCP source port.
3778 - ``dst {unsigned}``: TCP destination port.
3780 - ``sctp``: match SCTP header.
3782 - ``src {unsigned}``: SCTP source port.
3783 - ``dst {unsigned}``: SCTP destination port.
3784 - ``tag {unsigned}``: validation tag.
3785 - ``cksum {unsigned}``: checksum.
3787 - ``vxlan``: match VXLAN header.
3789 - ``vni {unsigned}``: VXLAN identifier.
3791 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3793 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3795 - ``nvgre``: match NVGRE header.
3797 - ``tni {unsigned}``: virtual subnet ID.
3799 - ``mpls``: match MPLS header.
3801 - ``label {unsigned}``: MPLS label.
3803 - ``gre``: match GRE header.
3805 - ``protocol {unsigned}``: protocol type.
3807 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3809 - ``thresh {unsigned}``: accuracy threshold.
3811 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3813 - ``teid {unsigned}``: tunnel endpoint identifier.
3815 - ``geneve``: match GENEVE header.
3817 - ``vni {unsigned}``: virtual network identifier.
3818 - ``protocol {unsigned}``: protocol type.
3820 - ``vxlan-gpe``: match VXLAN-GPE header.
3822 - ``vni {unsigned}``: VXLAN-GPE identifier.
3824 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3826 - ``sha {MAC-48}``: sender hardware address.
3827 - ``spa {ipv4 address}``: sender IPv4 address.
3828 - ``tha {MAC-48}``: target hardware address.
3829 - ``tpa {ipv4 address}``: target IPv4 address.
3831 - ``ipv6_ext``: match presence of any IPv6 extension header.
3833 - ``next_hdr {unsigned}``: next header.
3835 - ``icmp6``: match any ICMPv6 header.
3837 - ``type {unsigned}``: ICMPv6 type.
3838 - ``code {unsigned}``: ICMPv6 code.
3840 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3842 - ``target_addr {ipv6 address}``: target address.
3844 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3846 - ``target_addr {ipv6 address}``: target address.
3848 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3850 - ``type {unsigned}``: ND option type.
3852 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3853 link-layer address option.
3855 - ``sla {MAC-48}``: source Ethernet LLA.
3857 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3858 link-layer address option.
3860 - ``tla {MAC-48}``: target Ethernet LLA.
3862 - ``meta``: match application specific metadata.
3864 - ``data {unsigned}``: metadata value.
3869 A list of actions starts after the ``actions`` token in the same fashion as
3870 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3871 terminated by a mandatory ``end`` action.
3873 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3874 rte_flow_action_type``).
3876 Dropping all incoming UDPv4 packets can be expressed as follows::
3878 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3881 Several actions have configurable properties which must be specified when
3882 there is no valid default value. For example, ``queue`` requires a target
3885 This rule redirects incoming UDPv4 traffic to queue index 6::
3887 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3888 actions queue index 6 / end
3890 While this one could be rejected by PMDs (unspecified queue index)::
3892 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3895 As defined by *rte_flow*, the list is not ordered, all actions of a given
3896 rule are performed simultaneously. These are equivalent::
3898 queue index 6 / void / mark id 42 / end
3902 void / mark id 42 / queue index 6 / end
3904 All actions in a list should have different types, otherwise only the last
3905 action of a given type is taken into account::
3907 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
3911 drop / drop / drop / end # drop is performed only once
3915 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
3917 Considering they are performed simultaneously, opposite and overlapping
3918 actions can sometimes be combined when the end result is unambiguous::
3920 drop / queue index 6 / end # drop has no effect
3924 queue index 6 / rss queues 6 7 8 / end # queue has no effect
3928 drop / passthru / end # drop has no effect
3930 Note that PMDs may still refuse such combinations.
3935 This section lists supported actions and their attributes, if any.
3937 - ``end``: end list of actions.
3939 - ``void``: no-op action.
3941 - ``passthru``: let subsequent rule process matched packets.
3943 - ``jump``: redirect traffic to group on device.
3945 - ``group {unsigned}``: group to redirect to.
3947 - ``mark``: attach 32 bit value to packets.
3949 - ``id {unsigned}``: 32 bit value to return with packets.
3951 - ``flag``: flag packets.
3953 - ``queue``: assign packets to a given queue index.
3955 - ``index {unsigned}``: queue index to use.
3957 - ``drop``: drop packets (note: passthru has priority).
3959 - ``count``: enable counters for this rule.
3961 - ``rss``: spread packets among several queues.
3963 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
3964 the same as `set_hash_global_config`_.
3966 - ``level {unsigned}``: encapsulation level for ``types``.
3968 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
3969 tokens are the same as `set_hash_input_set`_, except that an empty list
3970 does not disable RSS but instead requests unspecified "best-effort"
3973 - ``key {string}``: RSS hash key, overrides ``key_len``.
3975 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
3976 conjunction with ``key`` to pad or truncate it.
3978 - ``queues [{unsigned} [...]] end``: queue indices to use.
3980 - ``pf``: direct traffic to physical function.
3982 - ``vf``: direct traffic to a virtual function ID.
3984 - ``original {boolean}``: use original VF ID if possible.
3985 - ``id {unsigned}``: VF ID.
3987 - ``phy_port``: direct packets to physical port index.
3989 - ``original {boolean}``: use original port index if possible.
3990 - ``index {unsigned}``: physical port index.
3992 - ``port_id``: direct matching traffic to a given DPDK port ID.
3994 - ``original {boolean}``: use original DPDK port ID if possible.
3995 - ``id {unsigned}``: DPDK port ID.
3997 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
3999 - ``mpls_ttl``: MPLS TTL.
4001 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4003 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4005 - ``nw_ttl``: IP TTL.
4007 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4009 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4011 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4013 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4015 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4017 - ``ethertype``: Ethertype.
4019 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4021 - ``vlan_vid``: VLAN id.
4023 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4025 - ``vlan_pcp``: VLAN priority.
4027 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4029 - ``ethertype``: Ethertype.
4031 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4033 - ``ethertype``: Ethertype.
4035 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4036 is done through `Config VXLAN Encap outer layers`_.
4038 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4039 the VXLAN tunnel network overlay from the matched flow.
4041 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4042 is done through `Config NVGRE Encap outer layers`_.
4044 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4045 the NVGRE tunnel network overlay from the matched flow.
4047 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4048 is done through `Config L2 Encap`_.
4050 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4051 is done through `Config L2 Decap`_.
4053 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4054 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4056 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4057 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4059 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4060 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4062 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4063 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4065 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4067 - ``ipv4_addr``: New IPv4 source address.
4069 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4072 - ``ipv4_addr``: New IPv4 destination address.
4074 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4076 - ``ipv6_addr``: New IPv6 source address.
4078 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4081 - ``ipv6_addr``: New IPv6 destination address.
4083 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4086 - ``port``: New TCP/UDP source port number.
4088 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4091 - ``port``: New TCP/UDP destination port number.
4093 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4096 - ``dec_ttl``: Performs a decrease TTL value action
4098 - ``set_ttl``: Set TTL value with specified value
4099 - ``ttl_value {unsigned}``: The new TTL value to be set
4101 - ``set_mac_src``: set source MAC address
4103 - ``mac_addr {MAC-48}``: new source MAC address
4105 - ``set_mac_dst``: set destination MAC address
4107 - ``mac_addr {MAC-48}``: new destination MAC address
4109 Destroying flow rules
4110 ~~~~~~~~~~~~~~~~~~~~~
4112 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4113 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4114 times as necessary::
4116 flow destroy {port_id} rule {rule_id} [...]
4118 If successful, it will show::
4120 Flow rule #[...] destroyed
4122 It does not report anything for rule IDs that do not exist. The usual error
4123 message is shown when a rule cannot be destroyed::
4125 Caught error type [...] ([...]): [...]
4127 ``flow flush`` destroys all rules on a device and does not take extra
4128 arguments. It is bound to ``rte_flow_flush()``::
4130 flow flush {port_id}
4132 Any errors are reported as above.
4134 Creating several rules and destroying them::
4136 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4137 actions queue index 2 / end
4138 Flow rule #0 created
4139 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4140 actions queue index 3 / end
4141 Flow rule #1 created
4142 testpmd> flow destroy 0 rule 0 rule 1
4143 Flow rule #1 destroyed
4144 Flow rule #0 destroyed
4147 The same result can be achieved using ``flow flush``::
4149 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4150 actions queue index 2 / end
4151 Flow rule #0 created
4152 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4153 actions queue index 3 / end
4154 Flow rule #1 created
4155 testpmd> flow flush 0
4158 Non-existent rule IDs are ignored::
4160 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4161 actions queue index 2 / end
4162 Flow rule #0 created
4163 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4164 actions queue index 3 / end
4165 Flow rule #1 created
4166 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4168 testpmd> flow destroy 0 rule 0
4169 Flow rule #0 destroyed
4175 ``flow query`` queries a specific action of a flow rule having that
4176 ability. Such actions collect information that can be reported using this
4177 command. It is bound to ``rte_flow_query()``::
4179 flow query {port_id} {rule_id} {action}
4181 If successful, it will display either the retrieved data for known actions
4182 or the following message::
4184 Cannot display result for action type [...] ([...])
4186 Otherwise, it will complain either that the rule does not exist or that some
4189 Flow rule #[...] not found
4193 Caught error type [...] ([...]): [...]
4195 Currently only the ``count`` action is supported. This action reports the
4196 number of packets that hit the flow rule and the total number of bytes. Its
4197 output has the following format::
4200 hits_set: [...] # whether "hits" contains a valid value
4201 bytes_set: [...] # whether "bytes" contains a valid value
4202 hits: [...] # number of packets
4203 bytes: [...] # number of bytes
4205 Querying counters for TCPv6 packets redirected to queue 6::
4207 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4208 actions queue index 6 / count / end
4209 Flow rule #4 created
4210 testpmd> flow query 0 4 count
4221 ``flow list`` lists existing flow rules sorted by priority and optionally
4222 filtered by group identifiers::
4224 flow list {port_id} [group {group_id}] [...]
4226 This command only fails with the following message if the device does not
4231 Output consists of a header line followed by a short description of each
4232 flow rule, one per line. There is no output at all when no flow rules are
4233 configured on the device::
4235 ID Group Prio Attr Rule
4236 [...] [...] [...] [...] [...]
4238 ``Attr`` column flags:
4240 - ``i`` for ``ingress``.
4241 - ``e`` for ``egress``.
4243 Creating several flow rules and listing them::
4245 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4246 actions queue index 6 / end
4247 Flow rule #0 created
4248 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4249 actions queue index 2 / end
4250 Flow rule #1 created
4251 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4252 actions rss queues 6 7 8 end / end
4253 Flow rule #2 created
4254 testpmd> flow list 0
4255 ID Group Prio Attr Rule
4256 0 0 0 i- ETH IPV4 => QUEUE
4257 1 0 0 i- ETH IPV6 => QUEUE
4258 2 0 5 i- ETH IPV4 UDP => RSS
4261 Rules are sorted by priority (i.e. group ID first, then priority level)::
4263 testpmd> flow list 1
4264 ID Group Prio Attr Rule
4265 0 0 0 i- ETH => COUNT
4266 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4267 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4268 1 24 0 i- ETH IPV4 UDP => QUEUE
4269 4 24 10 i- ETH IPV4 TCP => DROP
4270 3 24 20 i- ETH IPV4 => DROP
4271 2 24 42 i- ETH IPV4 UDP => QUEUE
4272 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4275 Output can be limited to specific groups::
4277 testpmd> flow list 1 group 0 group 63
4278 ID Group Prio Attr Rule
4279 0 0 0 i- ETH => COUNT
4280 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4281 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4282 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4285 Toggling isolated mode
4286 ~~~~~~~~~~~~~~~~~~~~~~
4288 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4289 must only be injected from the defined flow rules; that no default traffic
4290 is expected outside those rules and the driver is free to assign more
4291 resources to handle them. It is bound to ``rte_flow_isolate()``::
4293 flow isolate {port_id} {boolean}
4295 If successful, enabling or disabling isolated mode shows either::
4297 Ingress traffic on port [...]
4298 is now restricted to the defined flow rules
4302 Ingress traffic on port [...]
4303 is not restricted anymore to the defined flow rules
4305 Otherwise, in case of error::
4307 Caught error type [...] ([...]): [...]
4309 Mainly due to its side effects, PMDs supporting this mode may not have the
4310 ability to toggle it more than once without reinitializing affected ports
4311 first (e.g. by exiting testpmd).
4313 Enabling isolated mode::
4315 testpmd> flow isolate 0 true
4316 Ingress traffic on port 0 is now restricted to the defined flow rules
4319 Disabling isolated mode::
4321 testpmd> flow isolate 0 false
4322 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4325 Sample QinQ flow rules
4326 ~~~~~~~~~~~~~~~~~~~~~~
4328 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4330 testpmd> port stop 0
4331 testpmd> vlan set qinq on 0
4333 The above command sets the inner and outer TPID's to 0x8100.
4335 To change the TPID's the following commands should be used::
4337 testpmd> vlan set outer tpid 0xa100 0
4338 testpmd> vlan set inner tpid 0x9100 0
4339 testpmd> port start 0
4341 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4345 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4346 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4347 Flow rule #0 validated
4349 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4350 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4351 Flow rule #0 created
4353 testpmd> flow list 0
4354 ID Group Prio Attr Rule
4355 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4357 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4361 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4362 vlan tci is 654 / end actions pf / queue index 0 / end
4363 Flow rule #1 validated
4365 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4366 vlan tci is 654 / end actions pf / queue index 1 / end
4367 Flow rule #1 created
4369 testpmd> flow list 0
4370 ID Group Prio Attr Rule
4371 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4372 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4374 Sample VXLAN encapsulation rule
4375 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4377 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4378 source code, those can be changed by using the following commands
4380 IPv4 VXLAN outer header::
4382 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4383 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4384 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4387 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4388 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4389 eth-dst 22:22:22:22:22:22
4390 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4393 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4394 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4395 eth-dst 22:22:22:22:22:22
4396 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4399 IPv6 VXLAN outer header::
4401 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4402 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4403 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4406 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4407 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4408 eth-dst 22:22:22:22:22:22
4409 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4412 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4413 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4414 eth-dst 22:22:22:22:22:22
4415 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4418 Sample NVGRE encapsulation rule
4419 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4421 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4422 source code, those can be changed by using the following commands
4424 IPv4 NVGRE outer header::
4426 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4427 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4428 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4431 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4432 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4433 eth-dst 22:22:22:22:22:22
4434 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4437 IPv6 NVGRE outer header::
4439 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4440 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4441 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4444 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4445 vlan-tci 34 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 nvgre_encap /
4449 Sample L2 encapsulation rule
4450 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4452 L2 encapsulation has default value pre-configured in testpmd
4453 source code, those can be changed by using the following commands
4457 testpmd> set l2_encap ip-version ipv4
4458 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4459 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4460 mplsoudp_decap / l2_encap / end
4462 L2 with VXLAN header::
4464 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4465 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4466 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4467 mplsoudp_decap / l2_encap / end
4469 Sample L2 decapsulation rule
4470 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4472 L2 decapsulation has default value pre-configured in testpmd
4473 source code, those can be changed by using the following commands
4477 testpmd> set l2_decap
4478 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4481 L2 with VXLAN header::
4483 testpmd> set l2_encap-with-vlan
4484 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4487 Sample MPLSoGRE encapsulation rule
4488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4490 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4491 source code, those can be changed by using the following commands
4493 IPv4 MPLSoGRE outer header::
4495 testpmd> set mplsogre_encap ip-version ipv4 label 4
4496 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4497 eth-dst 22:22:22:22:22:22
4498 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4499 mplsogre_encap / end
4501 IPv4 MPLSoGRE with VLAN outer header::
4503 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4504 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4505 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4506 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4507 mplsogre_encap / end
4509 IPv6 MPLSoGRE outer header::
4511 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4512 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4513 eth-dst 22:22:22:22:22:22
4514 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4515 mplsogre_encap / end
4517 IPv6 MPLSoGRE with VLAN outer header::
4519 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4520 ip-src ::1 ip-dst ::2222 vlan-tci 34
4521 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4522 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4523 mplsogre_encap / end
4525 Sample MPLSoGRE decapsulation rule
4526 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4528 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4529 source code, those can be changed by using the following commands
4531 IPv4 MPLSoGRE outer header::
4533 testpmd> set mplsogre_decap ip-version ipv4
4534 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4535 mplsogre_decap / l2_encap / end
4537 IPv4 MPLSoGRE with VLAN outer header::
4539 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4540 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4541 actions mplsogre_decap / l2_encap / end
4543 IPv6 MPLSoGRE outer header::
4545 testpmd> set mplsogre_decap ip-version ipv6
4546 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4547 actions mplsogre_decap / l2_encap / end
4549 IPv6 MPLSoGRE with VLAN outer header::
4551 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4552 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4553 actions mplsogre_decap / l2_encap / end
4555 Sample MPLSoUDP encapsulation rule
4556 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4558 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4559 source code, those can be changed by using the following commands
4561 IPv4 MPLSoUDP outer header::
4563 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4564 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4565 eth-dst 22:22:22:22:22:22
4566 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4567 mplsoudp_encap / end
4569 IPv4 MPLSoUDP with VLAN outer header::
4571 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4572 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4573 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4574 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4575 mplsoudp_encap / end
4577 IPv6 MPLSoUDP outer header::
4579 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4580 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4581 eth-dst 22:22:22:22:22:22
4582 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4583 mplsoudp_encap / end
4585 IPv6 MPLSoUDP with VLAN outer header::
4587 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4588 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4589 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4590 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4591 mplsoudp_encap / end
4593 Sample MPLSoUDP decapsulation rule
4594 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4596 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4597 source code, those can be changed by using the following commands
4599 IPv4 MPLSoUDP outer header::
4601 testpmd> set mplsoudp_decap ip-version ipv4
4602 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4603 mplsoudp_decap / l2_encap / end
4605 IPv4 MPLSoUDP with VLAN outer header::
4607 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4608 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4609 actions mplsoudp_decap / l2_encap / end
4611 IPv6 MPLSoUDP outer header::
4613 testpmd> set mplsoudp_decap ip-version ipv6
4614 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4615 actions mplsoudp_decap / l2_encap / end
4617 IPv6 MPLSoUDP with VLAN outer header::
4619 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4620 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4621 actions mplsoudp_decap / l2_encap / end
4626 The following sections show functions to load/unload eBPF based filters.
4631 Load an eBPF program as a callback for particular RX/TX queue::
4633 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
4635 The available load-flags are:
4637 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
4639 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
4645 You'll need clang v3.7 or above to build bpf program you'd like to load
4649 .. code-block:: console
4652 clang -O2 -target bpf -c t1.c
4654 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
4656 .. code-block:: console
4658 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
4660 To load (not JITed) t1.o at TX queue 0, port 0:
4662 .. code-block:: console
4664 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
4669 Unload previously loaded eBPF program for particular RX/TX queue::
4671 testpmd> bpf-unload rx|tx (portid) (queueid)
4673 For example to unload BPF filter from TX queue 0, port 0:
4675 .. code-block:: console
4677 testpmd> bpf-unload tx 0 0
git.droids-corp.org / dpdk.git / blob