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|dcb_tc|cap X
28 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|dcb_tc|cap all
29 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|dcb_tc|cap X
30 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|dcb_tc|cap all
36 Some examples in this document are too long to fit on one line are shown wrapped at `"\\"` for display purposes::
38 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
39 (pause_time) (send_xon) (port_id)
41 In the real ``testpmd>`` prompt these commands should be on a single line.
46 The testpmd has on-line help for the functions that are available at runtime.
47 These are divided into sections and can be accessed using help, help section or help all:
49 .. code-block:: console
53 help control : Start and stop forwarding.
54 help display : Displaying port, stats and config information.
55 help config : Configuration information.
56 help ports : Configuring ports.
57 help registers : Reading and setting port registers.
58 help filters : Filters configuration help.
59 help all : All of the above sections.
62 Command File Functions
63 ----------------------
65 To facilitate loading large number of commands or to avoid cutting and pasting where not
66 practical or possible testpmd supports alternative methods for executing commands.
68 * If started with the ``--cmdline-file=FILENAME`` command line argument testpmd
69 will execute all CLI commands contained within the file immediately before
70 starting packet forwarding or entering interactive mode.
72 .. code-block:: console
74 ./dpdk-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|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 * ``dcb_tc``: DCB information such as TC mapping.
180 .. code-block:: console
182 testpmd> show port info 0
184 ********************* Infos for port 0 *********************
186 MAC address: XX:XX:XX:XX:XX:XX
188 memory allocation on the socket: 0
190 Link speed: 40000 Mbps
191 Link duplex: full-duplex
192 Promiscuous mode: enabled
193 Allmulticast mode: disabled
194 Maximum number of MAC addresses: 64
195 Maximum number of MAC addresses of hash filtering: 0
197 strip on, filter on, extend off, qinq strip off
198 Redirection table size: 512
199 Supported flow types:
217 show port (module_eeprom|eeprom)
218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
220 Display the EEPROM information of a port::
222 testpmd> show port (port_id) (module_eeprom|eeprom)
227 Display the rss redirection table entry indicated by masks on port X::
229 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
231 size is used to indicate the hardware supported reta size
236 Display the RSS hash functions and RSS hash key of a port::
238 testpmd> show port (port_id) rss-hash [key]
243 Clear the port statistics and forward engine statistics for a given port or for all ports::
245 testpmd> clear port (info|stats|xstats|fdir) (port_id|all)
249 testpmd> clear port stats all
254 Display information for a given port's RX/TX queue::
256 testpmd> show (rxq|txq) info (port_id) (queue_id)
258 show desc status(rxq|txq)
259 ~~~~~~~~~~~~~~~~~~~~~~~~~
261 Display information for a given port's RX/TX descriptor status::
263 testpmd> show port (port_id) (rxq|txq) (queue_id) desc (desc_id) status
265 show rxq desc used count
266 ~~~~~~~~~~~~~~~~~~~~~~~~
268 Display the number of receive packet descriptors currently filled by hardware
269 and ready to be processed by the driver on a given RX queue::
271 testpmd> show port (port_id) rxq (queue_id) desc used count
276 Displays the configuration of the application.
277 The configuration comes from the command-line, the runtime or the application defaults::
279 testpmd> show config (rxtx|cores|fwd|rxoffs|rxpkts|txpkts|txtimes)
281 The available information categories are:
283 * ``rxtx``: RX/TX configuration items.
285 * ``cores``: List of forwarding cores.
287 * ``fwd``: Packet forwarding configuration.
289 * ``rxoffs``: Packet offsets for RX split.
291 * ``rxpkts``: Packets to RX split configuration.
293 * ``txpkts``: Packets to TX configuration.
295 * ``txtimes``: Burst time pattern for Tx only mode.
299 .. code-block:: console
301 testpmd> show config rxtx
303 io packet forwarding - CRC stripping disabled - packets/burst=16
304 nb forwarding cores=2 - nb forwarding ports=1
305 RX queues=1 - RX desc=128 - RX free threshold=0
306 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
307 TX queues=1 - TX desc=512 - TX free threshold=0
308 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
309 TX RS bit threshold=0 - TXQ flags=0x0
314 Set the packet forwarding mode::
316 testpmd> set fwd (io|mac|macswap|flowgen| \
317 rxonly|txonly|csum|icmpecho|noisy|5tswap|shared-rxq) (""|retry)
319 ``retry`` can be specified for forwarding engines except ``rx_only``.
321 The available information categories are:
323 * ``io``: Forwards packets "as-is" in I/O mode.
324 This is the fastest possible forwarding operation as it does not access packets data.
325 This is the default mode.
327 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
328 Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination
329 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
330 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
332 * ``macswap``: MAC swap forwarding mode.
333 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
335 * ``flowgen``: Multi-flow generation mode.
336 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
338 * ``rxonly``: Receives packets but doesn't transmit them.
340 * ``txonly``: Generates and transmits packets without receiving any.
342 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
344 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
346 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX.
348 * ``noisy``: Noisy neighbor simulation.
349 Simulate more realistic behavior of a guest machine engaged in receiving
350 and sending packets performing Virtual Network Function (VNF).
352 * ``5tswap``: Swap the source and destination of L2,L3,L4 if they exist.
354 L2 swaps the source address and destination address of Ethernet, as same as ``macswap``.
356 L3 swaps the source address and destination address of IP (v4 and v6).
358 L4 swaps the source port and destination port of transport layer (TCP and UDP).
360 * ``shared-rxq``: Receive only for shared Rx queue.
361 Resolve packet source port from mbuf and update stream statistics accordingly.
365 testpmd> set fwd rxonly
367 Set rxonly packet forwarding mode
373 When running, forwarding engines maintain statistics from the time they have been started.
374 Example for the io forwarding engine, with some packet drops on the tx side::
376 testpmd> show fwd stats all
378 ------- Forward Stats for RX Port= 0/Queue= 0 -> TX Port= 1/Queue= 0 -------
379 RX-packets: 274293770 TX-packets: 274293642 TX-dropped: 128
381 ------- Forward Stats for RX Port= 1/Queue= 0 -> TX Port= 0/Queue= 0 -------
382 RX-packets: 274301850 TX-packets: 274301850 TX-dropped: 0
384 ---------------------- Forward statistics for port 0 ----------------------
385 RX-packets: 274293802 RX-dropped: 0 RX-total: 274293802
386 TX-packets: 274301862 TX-dropped: 0 TX-total: 274301862
387 ----------------------------------------------------------------------------
389 ---------------------- Forward statistics for port 1 ----------------------
390 RX-packets: 274301894 RX-dropped: 0 RX-total: 274301894
391 TX-packets: 274293706 TX-dropped: 128 TX-total: 274293834
392 ----------------------------------------------------------------------------
394 +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
395 RX-packets: 548595696 RX-dropped: 0 RX-total: 548595696
396 TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
397 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
403 Clear the forwarding engines statistics::
405 testpmd> clear fwd stats all
410 Display an RX descriptor for a port RX queue::
412 testpmd> read rxd (port_id) (queue_id) (rxd_id)
416 testpmd> read rxd 0 0 4
417 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
422 Display a TX descriptor for a port TX queue::
424 testpmd> read txd (port_id) (queue_id) (txd_id)
428 testpmd> read txd 0 0 4
429 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
434 Get loaded dynamic device personalization (DDP) package info list::
436 testpmd> ddp get list (port_id)
441 Display information about dynamic device personalization (DDP) profile::
443 testpmd> ddp get info (profile_path)
448 Display VF statistics::
450 testpmd> show vf stats (port_id) (vf_id)
455 Reset VF statistics::
457 testpmd> clear vf stats (port_id) (vf_id)
459 show port pctype mapping
460 ~~~~~~~~~~~~~~~~~~~~~~~~
462 List all items from the pctype mapping table::
464 testpmd> show port (port_id) pctype mapping
466 show rx offloading capabilities
467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
469 List all per queue and per port Rx offloading capabilities of a port::
471 testpmd> show port (port_id) rx_offload capabilities
473 show rx offloading configuration
474 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
476 List port level and all queue level Rx offloading configuration::
478 testpmd> show port (port_id) rx_offload configuration
480 show tx offloading capabilities
481 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
483 List all per queue and per port Tx offloading capabilities of a port::
485 testpmd> show port (port_id) tx_offload capabilities
487 show tx offloading configuration
488 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
490 List port level and all queue level Tx offloading configuration::
492 testpmd> show port (port_id) tx_offload configuration
494 show tx metadata setting
495 ~~~~~~~~~~~~~~~~~~~~~~~~
497 Show Tx metadata value set for a specific port::
499 testpmd> show port (port_id) tx_metadata
501 show port supported ptypes
502 ~~~~~~~~~~~~~~~~~~~~~~~~~~
504 Show ptypes supported for a specific port::
506 testpmd> show port (port_id) ptypes
508 set port supported ptypes
509 ~~~~~~~~~~~~~~~~~~~~~~~~~
511 set packet types classification for a specific port::
513 testpmd> set port (port_id) ptypes_mask (mask)
515 show port mac addresses info
516 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
518 Show mac addresses added for a specific port::
520 testpmd> show port (port_id) macs
523 show port multicast mac addresses info
524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
526 Show multicast mac addresses added for a specific port::
528 testpmd> show port (port_id) mcast_macs
530 show flow transfer proxy port ID for the given port
531 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
533 Show proxy port ID to use as the 1st argument in commands to
534 manage ``transfer`` flows and their indirect components.
537 testpmd> show port (port_id) flow transfer proxy
542 Show general information about devices probed::
544 testpmd> show device info (<identifier>|all)
548 .. code-block:: console
550 testpmd> show device info net_pcap0
552 ********************* Infos for device net_pcap0 *********************
554 Driver name: net_pcap
555 Devargs: iface=enP2p6s0,phy_mac=1
556 Connect to socket: -1
559 MAC address: 1E:37:93:28:04:B8
560 Device name: net_pcap0
565 Dumps all physical memory segment layouts::
567 testpmd> dump_physmem
572 Dumps the layout of all memory zones::
574 testpmd> dump_memzone
579 Dumps the memory usage of all sockets::
581 testpmd> dump_socket_mem
586 Dumps the size of all memory structures::
588 testpmd> dump_struct_sizes
593 Dumps the status of all or specific element in DPDK rings::
595 testpmd> dump_ring [ring_name]
600 Dumps the statistics of all or specific memory pool::
602 testpmd> dump_mempool [mempool_name]
607 Dumps the user device list::
609 testpmd> dump_devargs
614 Dumps the log level for all the dpdk modules::
616 testpmd> dump_log_types
618 show (raw_encap|raw_decap)
619 ~~~~~~~~~~~~~~~~~~~~~~~~~~
621 Display content of raw_encap/raw_decap buffers in hex::
623 testpmd> show <raw_encap|raw_decap> <index>
624 testpmd> show <raw_encap|raw_decap> all
628 testpmd> show raw_encap 6
630 index: 6 at [0x1c565b0], len=50
631 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
632 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
633 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
636 show fec capabilities
637 ~~~~~~~~~~~~~~~~~~~~~
639 Show fec capabilities of a port::
641 testpmd> show port (port_id) fec capabilities
646 Show fec mode of a port::
648 testpmd> show port (port_id) fec_mode
651 Configuration Functions
652 -----------------------
654 The testpmd application can be configured from the runtime as well as from the command-line.
656 This section details the available configuration functions that are available.
660 Configuration changes only become active when forwarding is started/restarted.
665 Reset forwarding to the default configuration::
672 Set the debug verbosity level::
674 testpmd> set verbose (level)
676 Available levels are as following:
678 * ``0`` silent except for error.
679 * ``1`` fully verbose except for Tx packets.
680 * ``2`` fully verbose except for Rx packets.
681 * ``> 2`` fully verbose.
686 Set the log level for a log type::
688 testpmd> set log global|(type) (level)
692 * ``type`` is the log name.
694 * ``level`` is the log level.
696 For example, to change the global log level::
698 testpmd> set log global (level)
700 Regexes can also be used for type. To change log level of user1, user2 and user3::
702 testpmd> set log user[1-3] (level)
707 Set the number of ports used by the application:
711 This is equivalent to the ``--nb-ports`` command-line option.
716 Set the number of cores used by the application::
718 testpmd> set nbcore (num)
720 This is equivalent to the ``--nb-cores`` command-line option.
724 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
729 Set the forwarding cores hexadecimal mask::
731 testpmd> set coremask (mask)
733 This is equivalent to the ``--coremask`` command-line option.
737 The main lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
742 Set the forwarding ports hexadecimal mask::
744 testpmd> set portmask (mask)
746 This is equivalent to the ``--portmask`` command-line option.
748 set record-core-cycles
749 ~~~~~~~~~~~~~~~~~~~~~~
751 Set the recording of CPU cycles::
753 testpmd> set record-core-cycles (on|off)
757 * ``on`` enables measurement of CPU cycles per packet.
759 * ``off`` disables measurement of CPU cycles per packet.
761 This is equivalent to the ``--record-core-cycles command-line`` option.
763 set record-burst-stats
764 ~~~~~~~~~~~~~~~~~~~~~~
766 Set the displaying of RX and TX bursts::
768 testpmd> set record-burst-stats (on|off)
772 * ``on`` enables display of RX and TX bursts.
774 * ``off`` disables display of RX and TX bursts.
776 This is equivalent to the ``--record-burst-stats command-line`` option.
781 Set number of packets per burst::
783 testpmd> set burst (num)
785 This is equivalent to the ``--burst command-line`` option.
787 When retry is enabled, the transmit delay time and number of retries can also be set::
789 testpmd> set burst tx delay (microseconds) retry (num)
794 Set the offsets of segments relating to the data buffer beginning on receiving
795 if split feature is engaged. Affects only the queues configured with split
796 offloads (currently BUFFER_SPLIT is supported only).
798 testpmd> set rxoffs (x[,y]*)
800 Where x[,y]* represents a CSV list of values, without white space. If the list
801 of offsets is shorter than the list of segments the zero offsets will be used
802 for the remaining segments.
807 Set the length of segments to scatter packets on receiving if split
808 feature is engaged. Affects only the queues configured with split offloads
809 (currently BUFFER_SPLIT is supported only). Optionally the multiple memory
810 pools can be specified with --mbuf-size command line parameter and the mbufs
811 to receive will be allocated sequentially from these extra memory pools (the
812 mbuf for the first segment is allocated from the first pool, the second one
813 from the second pool, and so on, if segment number is greater then pool's the
814 mbuf for remaining segments will be allocated from the last valid pool).
816 testpmd> set rxpkts (x[,y]*)
818 Where x[,y]* represents a CSV list of values, without white space. Zero value
819 means to use the corresponding memory pool data buffer size.
824 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
826 testpmd> set txpkts (x[,y]*)
828 Where x[,y]* represents a CSV list of values, without white space.
833 Configure the timing burst pattern for Tx only mode. This command enables
834 the packet send scheduling on dynamic timestamp mbuf field and configures
835 timing pattern in Tx only mode. In this mode, if scheduling is enabled
836 application provides timestamps in the packets being sent. It is possible
837 to configure delay (in unspecified device clock units) between bursts
838 and between the packets within the burst::
840 testpmd> set txtimes (inter),(intra)
844 * ``inter`` is the delay between the bursts in the device clock units.
845 If ``intra`` is zero, this is the time between the beginnings of the
846 first packets in the neighbour bursts, if ``intra`` is not zero,
847 ``inter`` specifies the time between the beginning of the first packet
848 of the current burst and the beginning of the last packet of the
849 previous burst. If ``inter`` parameter is zero the send scheduling
850 on timestamps is disabled (default).
852 * ``intra`` is the delay between the packets within the burst specified
853 in the device clock units. The number of packets in the burst is defined
854 by regular burst setting. If ``intra`` parameter is zero no timestamps
855 provided in the packets excepting the first one in the burst.
857 As the result the bursts of packet will be transmitted with specific
858 delays between the packets within the burst and specific delay between
859 the bursts. The rte_eth_read_clock() must be supported by the device(s)
860 and is supposed to be engaged to get the current device clock value
861 and provide the reference for the timestamps. If there is no supported
862 rte_eth_read_clock() there will be no send scheduling provided on the port.
867 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
869 testpmd> set txsplit (off|on|rand)
873 * ``off`` disable packet copy & split for CSUM mode.
875 * ``on`` split outgoing packet into multiple segments. Size of each segment
876 and number of segments per packet is determined by ``set txpkts`` command
879 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
884 Set the list of forwarding cores::
886 testpmd> set corelist (x[,y]*)
888 For example, to change the forwarding cores:
890 .. code-block:: console
892 testpmd> set corelist 3,1
893 testpmd> show config fwd
895 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
896 Logical Core 3 (socket 0) forwards packets on 1 streams:
897 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
898 Logical Core 1 (socket 0) forwards packets on 1 streams:
899 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
903 The cores are used in the same order as specified on the command line.
908 Set the list of forwarding ports::
910 testpmd> set portlist (x[,y]*)
912 For example, to change the port forwarding:
914 .. code-block:: console
916 testpmd> set portlist 0,2,1,3
917 testpmd> show config fwd
919 io packet forwarding - ports=4 - cores=1 - streams=4
920 Logical Core 3 (socket 0) forwards packets on 4 streams:
921 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
922 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
923 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
924 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
929 Select how to retrieve new ports created after "port attach" command::
931 testpmd> set port setup on (iterator|event)
933 For each new port, a setup is done.
934 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
935 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
940 Enable/disable tx loopback::
942 testpmd> set tx loopback (port_id) (on|off)
947 set drop enable bit for all queues::
949 testpmd> set all queues drop (port_id) (on|off)
951 set split drop enable (for VF)
952 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
954 set split drop enable bit for VF from PF::
956 testpmd> set vf split drop (port_id) (vf_id) (on|off)
958 set mac antispoof (for VF)
959 ~~~~~~~~~~~~~~~~~~~~~~~~~~
961 Set mac antispoof for a VF from the PF::
963 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
968 Enable/disable MACsec offload::
970 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
971 testpmd> set macsec offload (port_id) off
976 Configure MACsec secure connection (SC)::
978 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
982 The pi argument is ignored for tx.
983 Check the NIC Datasheet for hardware limits.
988 Configure MACsec secure association (SA)::
990 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
994 The IDX value must be 0 or 1.
995 Check the NIC Datasheet for hardware limits.
997 set broadcast mode (for VF)
998 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1000 Set broadcast mode for a VF from the PF::
1002 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
1007 Set the VLAN strip for a queue on a port::
1009 testpmd> vlan set stripq (on|off) (port_id,queue_id)
1011 vlan set stripq (for VF)
1012 ~~~~~~~~~~~~~~~~~~~~~~~~
1014 Set VLAN strip for all queues in a pool for a VF from the PF::
1016 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
1018 vlan set insert (for VF)
1019 ~~~~~~~~~~~~~~~~~~~~~~~~
1021 Set VLAN insert for a VF from the PF::
1023 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
1025 vlan set tag (for VF)
1026 ~~~~~~~~~~~~~~~~~~~~~
1028 Set VLAN tag for a VF from the PF::
1030 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
1032 vlan set antispoof (for VF)
1033 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1035 Set VLAN antispoof for a VF from the PF::
1037 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
1039 vlan set (strip|filter|qinq_strip|extend)
1040 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1041 Set the VLAN strip/filter/QinQ strip/extend on for a port::
1043 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
1048 Set the inner or outer VLAN TPID for packet filtering on a port::
1050 testpmd> vlan set (inner|outer) tpid (value) (port_id)
1054 TPID value must be a 16-bit number (value <= 65536).
1059 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
1061 testpmd> rx_vlan add (vlan_id|all) (port_id)
1065 VLAN filter must be set on that port. VLAN ID < 4096.
1066 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
1067 in VFTA table. This is important if enabling all vlan_ids.
1072 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
1074 testpmd> rx_vlan rm (vlan_id|all) (port_id)
1076 rx_vlan add (for VF)
1077 ~~~~~~~~~~~~~~~~~~~~
1079 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
1081 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
1086 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
1088 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
1093 Add an UDP port for VXLAN packet filter on a port::
1095 testpmd> rx_vxlan_port add (udp_port) (port_id)
1097 rx_vxlan_port remove
1098 ~~~~~~~~~~~~~~~~~~~~
1100 Remove an UDP port for VXLAN packet filter on a port::
1102 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1107 Set hardware insertion of VLAN IDs in packets sent on a port::
1109 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1111 For example, set a single VLAN ID (5) insertion on port 0::
1115 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1123 Set port based hardware insertion of VLAN ID in packets sent on a port::
1125 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1130 Disable hardware insertion of a VLAN header in packets sent on a port::
1132 testpmd> tx_vlan reset (port_id)
1137 Select hardware or software calculation of the checksum when
1138 transmitting a packet using the ``csum`` forwarding engine::
1140 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1144 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1146 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1147 as a tunnel packet by the forwarding engine (geneve, gre, gtp, ipip, vxlan and vxlan-gpe are
1148 supported). See also the ``csum parse-tunnel`` command.
1150 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1151 as a tunnel packet by the forwarding engine (geneve, gtp, vxlan and vxlan-gpe are
1152 supported). See also the ``csum parse-tunnel`` command.
1156 Check the NIC Datasheet for hardware limits.
1161 Set RSS queue region span on a port::
1163 testpmd> set port (port_id) queue-region region_id (value) \
1164 queue_start_index (value) queue_num (value)
1166 Set flowtype mapping on a RSS queue region on a port::
1168 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1172 * For the flowtype(pctype) of packet,the specific index for each type has
1173 been defined in file i40e_type.h as enum i40e_filter_pctype.
1175 Set user priority mapping on a RSS queue region on a port::
1177 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1179 Flush all queue region related configuration on a port::
1181 testpmd> set port (port_id) queue-region flush (on|off)
1185 * ``on``: is just an enable function which server for other configuration,
1186 it is for all configuration about queue region from up layer,
1187 at first will only keep in DPDK software stored in driver,
1188 only after "flush on", it commit all configuration to HW.
1190 * ``"off``: is just clean all configuration about queue region just now,
1191 and restore all to DPDK i40e driver default config when start up.
1193 Show all queue region related configuration info on a port::
1195 testpmd> show port (port_id) queue-region
1199 Queue region only support on PF by now, so these command is
1200 only for configuration of queue region on PF port.
1205 Define how tunneled packets should be handled by the csum forward
1208 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1210 If enabled, the csum forward engine will try to recognize supported
1211 tunnel headers (geneve, gtp, gre, ipip, vxlan, vxlan-gpe).
1213 If disabled, treat tunnel packets as non-tunneled packets (a inner
1214 header is handled as a packet payload).
1218 The port argument is the TX port like in the ``csum set`` command.
1222 Consider a packet in packet like the following::
1224 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1226 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1227 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1228 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1230 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1231 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1236 Display tx checksum offload configuration::
1238 testpmd> csum show (port_id)
1243 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1245 testpmd> tso set (segsize) (port_id)
1249 Check the NIC datasheet for hardware limits.
1254 Display the status of TCP Segmentation Offload::
1256 testpmd> tso show (port_id)
1261 Set tso segment size of tunneled packets for a port in csum engine::
1263 testpmd> tunnel_tso set (tso_segsz) (port_id)
1268 Display the status of tunneled TCP Segmentation Offload for a port::
1270 testpmd> tunnel_tso show (port_id)
1275 Enable or disable GRO in ``csum`` forwarding engine::
1277 testpmd> set port <port_id> gro on|off
1279 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1280 packets received from the given port.
1282 If disabled, packets received from the given port won't be performed
1283 GRO. By default, GRO is disabled for all ports.
1287 When enable GRO for a port, TCP/IPv4 packets received from the port
1288 will be performed GRO. After GRO, all merged packets have bad
1289 checksums, since the GRO library doesn't re-calculate checksums for
1290 the merged packets. Therefore, if users want the merged packets to
1291 have correct checksums, please select HW IP checksum calculation and
1292 HW TCP checksum calculation for the port which the merged packets are
1298 Display GRO configuration for a given port::
1300 testpmd> show port <port_id> gro
1305 Set the cycle to flush the GROed packets from reassembly tables::
1307 testpmd> set gro flush <cycles>
1309 When enable GRO, the csum forwarding engine performs GRO on received
1310 packets, and the GROed packets are stored in reassembly tables. Users
1311 can use this command to determine when the GROed packets are flushed
1312 from the reassembly tables.
1314 The ``cycles`` is measured in GRO operation times. The csum forwarding
1315 engine flushes the GROed packets from the tables every ``cycles`` GRO
1318 By default, the value of ``cycles`` is 1, which means flush GROed packets
1319 from the reassembly tables as soon as one GRO operation finishes. The value
1320 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1322 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1323 stack performance. Because the GROed packets are delayed to arrive the
1324 stack, thus causing more duplicated ACKs and TCP retransmissions.
1329 Toggle per-port GSO support in ``csum`` forwarding engine::
1331 testpmd> set port <port_id> gso on|off
1333 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1334 packets, transmitted on the given port.
1336 If disabled, packets transmitted on the given port will not undergo GSO.
1337 By default, GSO is disabled for all ports.
1341 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1342 port undergo GSO. Afterwards, the segmented packets are represented by
1343 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1344 of checksums for GSO'd segments in SW. As a result, if users want correct
1345 checksums in GSO segments, they should enable HW checksum calculation for
1348 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1349 by setting the following options in the csum forwarding engine:
1351 testpmd> csum set outer_ip hw <port_id>
1353 testpmd> csum set ip hw <port_id>
1355 testpmd> csum set tcp hw <port_id>
1357 UDP GSO is the same as IP fragmentation, which treats the UDP header
1358 as the payload and does not modify it during segmentation. That is,
1359 after UDP GSO, only the first output fragment has the original UDP
1360 header. Therefore, users need to enable HW IP checksum calculation
1361 and SW UDP checksum calculation for GSO-enabled ports, if they want
1362 correct checksums for UDP/IPv4 packets.
1367 Set the maximum GSO segment size (measured in bytes), which includes the
1368 packet header and the packet payload for GSO-enabled ports (global)::
1370 testpmd> set gso segsz <length>
1375 Display the status of Generic Segmentation Offload for a given port::
1377 testpmd> show port <port_id> gso
1382 Add an alternative MAC address to a port::
1384 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1389 Remove a MAC address from a port::
1391 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1396 To add the multicast MAC address to/from the set of multicast addresses
1399 testpmd> mcast_addr add (port_id) (mcast_addr)
1404 To remove the multicast MAC address to/from the set of multicast addresses
1407 testpmd> mcast_addr remove (port_id) (mcast_addr)
1409 mac_addr add (for VF)
1410 ~~~~~~~~~~~~~~~~~~~~~
1412 Add an alternative MAC address for a VF to a port::
1414 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1419 Set the default MAC address for a port::
1421 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1423 mac_addr set (for VF)
1424 ~~~~~~~~~~~~~~~~~~~~~
1426 Set the MAC address for a VF from the PF::
1428 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1433 Set the forwarding peer address for certain port::
1435 testpmd> set eth-peer (port_id) (peer_addr)
1437 This is equivalent to the ``--eth-peer`` command-line option.
1442 Set the unicast hash filter(s) on/off for a port::
1444 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1449 Set the promiscuous mode on for a port or for all ports.
1450 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1452 testpmd> set promisc (port_id|all) (on|off)
1457 Set the allmulti mode for a port or for all ports::
1459 testpmd> set allmulti (port_id|all) (on|off)
1461 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1463 set promisc (for VF)
1464 ~~~~~~~~~~~~~~~~~~~~
1466 Set the unicast promiscuous mode for a VF from PF.
1467 It's supported by Intel i40e NICs now.
1468 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1470 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1472 set allmulticast (for VF)
1473 ~~~~~~~~~~~~~~~~~~~~~~~~~
1475 Set the multicast promiscuous mode for a VF from PF.
1476 It's supported by Intel i40e NICs now.
1477 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1479 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1481 set tx max bandwidth (for VF)
1482 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1484 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1486 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1488 set tc tx min bandwidth (for VF)
1489 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1491 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1493 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1495 set tc tx max bandwidth (for VF)
1496 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1498 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1500 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1502 set tc strict link priority mode
1503 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1505 Set some TCs' strict link priority mode on a physical port::
1507 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1509 set tc tx min bandwidth
1510 ~~~~~~~~~~~~~~~~~~~~~~~
1512 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1514 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1519 Set the link flow control parameter on a port::
1521 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1522 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1523 autoneg (on|off) (port_id)
1527 * ``high_water`` (integer): High threshold value to trigger XOFF.
1529 * ``low_water`` (integer): Low threshold value to trigger XON.
1531 * ``pause_time`` (integer): Pause quota in the Pause frame.
1533 * ``send_xon`` (0/1): Send XON frame.
1535 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1537 * ``autoneg``: Change the auto-negotiation parameter.
1542 show the link flow control parameter on a port::
1544 testpmd> show port <port_id> flow_ctrl
1549 Set the priority flow control parameter on a port::
1551 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1552 (pause_time) (priority) (port_id)
1556 * ``high_water`` (integer): High threshold value.
1558 * ``low_water`` (integer): Low threshold value.
1560 * ``pause_time`` (integer): Pause quota in the Pause frame.
1562 * ``priority`` (0-7): VLAN User Priority.
1567 Set the priority flow control parameter on a given Rx and Tx queue of a port::
1569 testpmd> set pfc_queue_ctrl <port_id> rx (on|off) <tx_qid> <tx_tc> \
1570 tx (on|off) <rx_qid> <rx_tc> <pause_time>
1574 * ``tx_qid`` (integer): Tx qid for which ``tx_tc`` will be applied and traffic
1575 will be paused when PFC frame is received with ``tx_tc`` enabled.
1577 * ``tx_tc`` (0-15): TC for which traffic is to be paused for xmit.
1579 * ``rx_qid`` (integer): Rx qid for which threshold will be applied and PFC
1580 frame will be generated with ``tx_tc`` when exceeds the threshold.
1582 * ``rx_tc`` (0-15): TC filled in PFC frame for which remote Tx is to be paused.
1584 * ``pause_time`` (integer): Pause quanta filled in the PFC frame for which
1585 interval, remote Tx will be paused. Valid only if Tx pause is on.
1590 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1592 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1594 For example, to set rx queue 2 on port 0 to mapping 5::
1596 testpmd>set stat_qmap rx 0 2 5
1598 set xstats-hide-zero
1599 ~~~~~~~~~~~~~~~~~~~~
1601 Set the option to hide zero values for xstats display::
1603 testpmd> set xstats-hide-zero on|off
1607 By default, the zero values are displayed for xstats.
1609 set port - rx/tx (for VF)
1610 ~~~~~~~~~~~~~~~~~~~~~~~~~
1612 Set VF receive/transmit from a port::
1614 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1616 set port - rx mode(for VF)
1617 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1619 Set the VF receive mode of a port::
1621 testpmd> set port (port_id) vf (vf_id) \
1622 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1624 The available receive modes are:
1626 * ``AUPE``: Accepts untagged VLAN.
1628 * ``ROPE``: Accepts unicast hash.
1630 * ``BAM``: Accepts broadcast packets.
1632 * ``MPE``: Accepts all multicast packets.
1634 set port - tx_rate (for Queue)
1635 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1637 Set TX rate limitation for a queue on a port::
1639 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1641 set port - tx_rate (for VF)
1642 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1644 Set TX rate limitation for queues in VF on a port::
1646 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1651 Set the flush on RX streams before forwarding.
1652 The default is flush ``on``.
1653 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1655 testpmd> set flush_rx off
1660 Set the bypass mode for the lowest port on bypass enabled NIC::
1662 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1667 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1669 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1670 mode (normal|bypass|isolate) (port_id)
1674 * ``timeout``: Enable bypass after watchdog timeout.
1676 * ``os_on``: Enable bypass when OS/board is powered on.
1678 * ``os_off``: Enable bypass when OS/board is powered off.
1680 * ``power_on``: Enable bypass when power supply is turned on.
1682 * ``power_off``: Enable bypass when power supply is turned off.
1688 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1690 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1695 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1697 testpmd> show bypass config (port_id)
1702 Set link up for a port::
1704 testpmd> set link-up port (port id)
1709 Set link down for a port::
1711 testpmd> set link-down port (port id)
1716 Enable E-tag insertion for a VF on a port::
1718 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1720 Disable E-tag insertion for a VF on a port::
1722 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1724 Enable/disable E-tag stripping on a port::
1726 testpmd> E-tag set stripping (on|off) port (port_id)
1728 Enable/disable E-tag based forwarding on a port::
1730 testpmd> E-tag set forwarding (on|off) port (port_id)
1735 Load a dynamic device personalization (DDP) profile and store backup profile::
1737 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1742 Delete a dynamic device personalization profile and restore backup profile::
1744 testpmd> ddp del (port_id) (backup_profile_path)
1749 List all items from the ptype mapping table::
1751 testpmd> ptype mapping get (port_id) (valid_only)
1755 * ``valid_only``: A flag indicates if only list valid items(=1) or all items(=0).
1757 Replace a specific or a group of software defined ptype with a new one::
1759 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1763 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1765 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1767 * ``pkt_type``: The new software ptype to replace the old ones.
1769 Update hardware defined ptype to software defined packet type mapping table::
1771 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1775 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1777 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1779 Reset ptype mapping table::
1781 testpmd> ptype mapping reset (port_id)
1783 config per port Rx offloading
1784 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1786 Enable or disable a per port Rx offloading on all Rx queues of a port::
1788 testpmd> port config (port_id) rx_offload (offloading) on|off
1790 * ``offloading``: can be any of these offloading capability:
1791 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1792 qinq_strip, outer_ipv4_cksum, macsec_strip,
1793 header_split, vlan_filter, vlan_extend, jumbo_frame,
1794 scatter, timestamp, security, keep_crc, rss_hash
1796 This command should be run when the port is stopped, or else it will fail.
1798 config per queue Rx offloading
1799 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1801 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1803 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1805 * ``offloading``: can be any of these offloading capability:
1806 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1807 qinq_strip, outer_ipv4_cksum, macsec_strip,
1808 header_split, vlan_filter, vlan_extend, jumbo_frame,
1809 scatter, timestamp, security, keep_crc
1811 This command should be run when the port is stopped, or else it will fail.
1813 config per port Tx offloading
1814 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1816 Enable or disable a per port Tx offloading on all Tx queues of a port::
1818 testpmd> port config (port_id) tx_offload (offloading) on|off
1820 * ``offloading``: can be any of these offloading capability:
1821 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1822 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1823 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1824 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1825 mt_lockfree, multi_segs, mbuf_fast_free, security
1827 This command should be run when the port is stopped, or else it will fail.
1829 config per queue Tx offloading
1830 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1832 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1834 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1836 * ``offloading``: can be any of these offloading capability:
1837 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1838 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1839 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1840 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1841 mt_lockfree, multi_segs, mbuf_fast_free, security
1843 This command should be run when the port is stopped, or else it will fail.
1845 Config VXLAN Encap outer layers
1846 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1848 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1850 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1851 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1854 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1855 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1856 eth-src (eth-src) eth-dst (eth-dst)
1858 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1859 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1860 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1862 These commands will set an internal configuration inside testpmd, any following
1863 flow rule using the action vxlan_encap will use the last configuration set.
1864 To have a different encapsulation header, one of those commands must be called
1865 before the flow rule creation.
1867 Config NVGRE Encap outer layers
1868 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1870 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1872 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1873 eth-src (eth-src) eth-dst (eth-dst)
1874 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1875 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1877 These commands will set an internal configuration inside testpmd, any following
1878 flow rule using the action nvgre_encap will use the last configuration set.
1879 To have a different encapsulation header, one of those commands must be called
1880 before the flow rule creation.
1885 Configure the l2 to be used when encapsulating a packet with L2::
1887 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1888 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1889 eth-src (eth-src) eth-dst (eth-dst)
1891 Those commands will set an internal configuration inside testpmd, any following
1892 flow rule using the action l2_encap will use the last configuration set.
1893 To have a different encapsulation header, one of those commands must be called
1894 before the flow rule creation.
1899 Configure the l2 to be removed when decapsulating a packet with L2::
1901 set l2_decap ip-version (ipv4|ipv6)
1902 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1904 Those commands will set an internal configuration inside testpmd, any following
1905 flow rule using the action l2_decap will use the last configuration set.
1906 To have a different encapsulation header, one of those commands must be called
1907 before the flow rule creation.
1909 Config MPLSoGRE Encap outer layers
1910 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1912 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1914 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1915 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1916 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1917 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1918 eth-src (eth-src) eth-dst (eth-dst)
1920 These commands will set an internal configuration inside testpmd, any following
1921 flow rule using the action mplsogre_encap will use the last configuration set.
1922 To have a different encapsulation header, one of those commands must be called
1923 before the flow rule creation.
1925 Config MPLSoGRE Decap outer layers
1926 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1928 Configure the outer layer to decapsulate MPLSoGRE packet::
1930 set mplsogre_decap ip-version (ipv4|ipv6)
1931 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1933 These commands will set an internal configuration inside testpmd, any following
1934 flow rule using the action mplsogre_decap will use the last configuration set.
1935 To have a different decapsulation header, one of those commands must be called
1936 before the flow rule creation.
1938 Config MPLSoUDP Encap outer layers
1939 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1941 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1943 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1944 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1945 eth-src (eth-src) eth-dst (eth-dst)
1946 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1947 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1948 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1950 These commands will set an internal configuration inside testpmd, any following
1951 flow rule using the action mplsoudp_encap will use the last configuration set.
1952 To have a different encapsulation header, one of those commands must be called
1953 before the flow rule creation.
1955 Config MPLSoUDP Decap outer layers
1956 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1958 Configure the outer layer to decapsulate MPLSoUDP packet::
1960 set mplsoudp_decap ip-version (ipv4|ipv6)
1961 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1963 These commands will set an internal configuration inside testpmd, any following
1964 flow rule using the action mplsoudp_decap will use the last configuration set.
1965 To have a different decapsulation header, one of those commands must be called
1966 before the flow rule creation.
1968 Config Raw Encapsulation
1969 ~~~~~~~~~~~~~~~~~~~~~~~~~
1971 Configure the raw data to be used when encapsulating a packet by
1972 rte_flow_action_raw_encap::
1974 set raw_encap {index} {item} [/ {item} [...]] / end_set
1976 There are multiple global buffers for ``raw_encap``, this command will set one
1977 internal buffer index by ``{index}``.
1978 If there is no ``{index}`` specified::
1980 set raw_encap {item} [/ {item} [...]] / end_set
1982 the default index ``0`` is used.
1983 In order to use different encapsulating header, ``index`` must be specified
1984 during the flow rule creation::
1986 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1987 raw_encap index 2 / end
1989 Otherwise the default index ``0`` is used.
1991 Config Raw Decapsulation
1992 ~~~~~~~~~~~~~~~~~~~~~~~~
1994 Configure the raw data to be used when decapsulating a packet by
1995 rte_flow_action_raw_decap::
1997 set raw_decap {index} {item} [/ {item} [...]] / end_set
1999 There are multiple global buffers for ``raw_decap``, this command will set
2000 one internal buffer index by ``{index}``.
2001 If there is no ``{index}`` specified::
2003 set raw_decap {item} [/ {item} [...]] / end_set
2005 the default index ``0`` is used.
2006 In order to use different decapsulating header, ``index`` must be specified
2007 during the flow rule creation::
2009 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
2010 raw_encap index 3 / end
2012 Otherwise the default index ``0`` is used.
2017 Set fec mode for a specific port::
2019 testpmd> set port (port_id) fec_mode auto|off|rs|baser
2021 Config Sample actions list
2022 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2024 Configure the sample actions list to be used when sampling a packet by
2025 rte_flow_action_sample::
2027 set sample_actions {index} {action} [/ {action} [...]] / end
2029 There are multiple global buffers for ``sample_actions``, this command will set
2030 one internal buffer index by ``{index}``.
2032 In order to use different sample actions list, ``index`` must be specified
2033 during the flow rule creation::
2035 testpmd> flow create 0 ingress pattern eth / ipv4 / end actions
2036 sample ratio 2 index 2 / end
2038 Otherwise the default index ``0`` is used.
2043 The following sections show functions for configuring ports.
2047 Port configuration changes only become active when forwarding is started/restarted.
2052 Attach a port specified by pci address or virtual device args::
2054 testpmd> port attach (identifier)
2056 To attach a new pci device, the device should be recognized by kernel first.
2057 Then it should be moved under DPDK management.
2058 Finally the port can be attached to testpmd.
2060 For example, to move a pci device using ixgbe under DPDK management:
2062 .. code-block:: console
2064 # Check the status of the available devices.
2065 ./usertools/dpdk-devbind.py --status
2067 Network devices using DPDK-compatible driver
2068 ============================================
2071 Network devices using kernel driver
2072 ===================================
2073 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
2076 # Bind the device to igb_uio.
2077 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
2080 # Recheck the status of the devices.
2081 ./usertools/dpdk-devbind.py --status
2082 Network devices using DPDK-compatible driver
2083 ============================================
2084 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
2086 To attach a port created by virtual device, above steps are not needed.
2088 For example, to attach a port whose pci address is 0000:0a:00.0.
2090 .. code-block:: console
2092 testpmd> port attach 0000:0a:00.0
2093 Attaching a new port...
2094 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2095 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
2096 EAL: PCI memory mapped at 0x7f83bfa00000
2097 EAL: PCI memory mapped at 0x7f83bfa80000
2098 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
2099 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
2100 Port 0 is attached. Now total ports is 1
2103 For example, to attach a port created by pcap PMD.
2105 .. code-block:: console
2107 testpmd> port attach net_pcap0
2108 Attaching a new port...
2109 PMD: Initializing pmd_pcap for net_pcap0
2110 PMD: Creating pcap-backed ethdev on numa socket 0
2111 Port 0 is attached. Now total ports is 1
2114 In this case, identifier is ``net_pcap0``.
2115 This identifier format is the same as ``--vdev`` format of DPDK applications.
2117 For example, to re-attach a bonded port which has been previously detached,
2118 the mode and slave parameters must be given.
2120 .. code-block:: console
2122 testpmd> port attach net_bond_0,mode=0,slave=1
2123 Attaching a new port...
2124 EAL: Initializing pmd_bond for net_bond_0
2125 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2126 Port 0 is attached. Now total ports is 1
2133 Detach a specific port::
2135 testpmd> port detach (port_id)
2137 Before detaching a port, the port should be stopped and closed.
2139 For example, to detach a pci device port 0.
2141 .. code-block:: console
2143 testpmd> port stop 0
2146 testpmd> port close 0
2150 testpmd> port detach 0
2152 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2153 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2154 EAL: PCI memory unmapped at 0x7f83bfa00000
2155 EAL: PCI memory unmapped at 0x7f83bfa80000
2159 For example, to detach a virtual device port 0.
2161 .. code-block:: console
2163 testpmd> port stop 0
2166 testpmd> port close 0
2170 testpmd> port detach 0
2172 PMD: Closing pcap ethdev on numa socket 0
2173 Port 'net_pcap0' is detached. Now total ports is 0
2176 To remove a pci device completely from the system, first detach the port from testpmd.
2177 Then the device should be moved under kernel management.
2178 Finally the device can be removed using kernel pci hotplug functionality.
2180 For example, to move a pci device under kernel management:
2182 .. code-block:: console
2184 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2186 ./usertools/dpdk-devbind.py --status
2188 Network devices using DPDK-compatible driver
2189 ============================================
2192 Network devices using kernel driver
2193 ===================================
2194 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2196 To remove a port created by a virtual device, above steps are not needed.
2201 Start all ports or a specific port::
2203 testpmd> port start (port_id|all)
2208 Stop all ports or a specific port::
2210 testpmd> port stop (port_id|all)
2215 Close all ports or a specific port::
2217 testpmd> port close (port_id|all)
2222 Reset all ports or a specific port::
2224 testpmd> port reset (port_id|all)
2226 User should stop port(s) before resetting and (re-)start after reset.
2228 port config - queue ring size
2229 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2231 Configure a rx/tx queue ring size::
2233 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2235 Only take effect after command that (re-)start the port or command that setup specific queue.
2237 port start/stop queue
2238 ~~~~~~~~~~~~~~~~~~~~~
2240 Start/stop a rx/tx queue on a specific port::
2242 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2244 port config - queue deferred start
2245 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2247 Switch on/off deferred start of a specific port queue::
2249 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2252 ~~~~~~~~~~~~~~~~~~~~~
2254 Setup a rx/tx queue on a specific port::
2256 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2258 Only take effect when port is started.
2263 Set the speed and duplex mode for all ports or a specific port::
2265 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \
2266 duplex (half|full|auto)
2268 port config - queues/descriptors
2269 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2271 Set number of queues/descriptors for rxq, txq, rxd and txd::
2273 testpmd> port config all (rxq|txq|rxd|txd) (value)
2275 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2277 port config - max-pkt-len
2278 ~~~~~~~~~~~~~~~~~~~~~~~~~
2280 Set the maximum packet length::
2282 testpmd> port config all max-pkt-len (value)
2284 This is equivalent to the ``--max-pkt-len`` command-line option.
2286 port config - max-lro-pkt-size
2287 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2289 Set the maximum LRO aggregated packet size::
2291 testpmd> port config all max-lro-pkt-size (value)
2293 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2295 port config - Drop Packets
2296 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2298 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2300 testpmd> port config all drop-en (on|off)
2302 Packet dropping when no receive buffers available is off by default.
2304 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2309 Set the RSS (Receive Side Scaling) mode on or off::
2311 testpmd> port config all rss (all|default|eth|vlan|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|l2tpv3|esp|ah|pfcp|ecpri|mpls|l2tpv2|none)
2313 RSS is on by default.
2315 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp|l2tpv2.
2317 The ``default`` option enables all supported RSS types reported by device info.
2319 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2321 port config - RSS Reta
2322 ~~~~~~~~~~~~~~~~~~~~~~
2324 Set the RSS (Receive Side Scaling) redirection table::
2326 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2331 Set the DCB mode for an individual port::
2333 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2335 The traffic class should be 4 or 8.
2340 Set the number of packets per burst::
2342 testpmd> port config all burst (value)
2344 This is equivalent to the ``--burst`` command-line option.
2346 port config - Threshold
2347 ~~~~~~~~~~~~~~~~~~~~~~~
2349 Set thresholds for TX/RX queues::
2351 testpmd> port config all (threshold) (value)
2353 Where the threshold type can be:
2355 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2357 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2359 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2361 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2363 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2365 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2367 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2369 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2371 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2373 These threshold options are also available from the command-line.
2375 port config pctype mapping
2376 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2378 Reset pctype mapping table::
2380 testpmd> port config (port_id) pctype mapping reset
2382 Update hardware defined pctype to software defined flow type mapping table::
2384 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2388 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2390 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2392 port config input set
2393 ~~~~~~~~~~~~~~~~~~~~~
2395 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2397 testpmd> port config (port_id) pctype (pctype_id) \
2398 (hash_inset|fdir_inset|fdir_flx_inset) \
2399 (get|set|clear) field (field_idx)
2401 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2403 testpmd> port config (port_id) pctype (pctype_id) \
2404 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2408 * ``pctype_id``: hardware packet classification types.
2409 * ``field_idx``: hardware field index.
2411 port config udp_tunnel_port
2412 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2414 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2416 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe|ecpri (udp_port)
2418 port config tx_metadata
2419 ~~~~~~~~~~~~~~~~~~~~~~~
2421 Set Tx metadata value per port.
2422 testpmd will add this value to any Tx packet sent from this port::
2424 testpmd> port config (port_id) tx_metadata (value)
2429 Set/clear dynamic flag per port.
2430 testpmd will register this flag in the mbuf (same registration
2431 for both Tx and Rx). Then set/clear this flag for each Tx
2432 packet sent from this port. The set bit only works for Tx packet::
2434 testpmd> port config (port_id) dynf (name) (set|clear)
2439 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2441 testpmd> port config mtu (port_id) (value)
2443 port config rss hash key
2444 ~~~~~~~~~~~~~~~~~~~~~~~~
2446 To configure the RSS hash key used to compute the RSS
2447 hash of input [IP] packets received on port::
2449 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2450 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2451 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2452 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2453 ipv6-udp-ex <string of hex digits \
2454 (variable length, NIC dependent)>)
2456 port cleanup txq mbufs
2457 ~~~~~~~~~~~~~~~~~~~~~~
2459 To cleanup txq mbufs currently cached by driver::
2461 testpmd> port cleanup (port_id) txq (queue_id) (free_cnt)
2463 If the value of ``free_cnt`` is 0, driver should free all cached mbufs.
2468 The following sections show functions for device operations.
2473 Detach a device specified by pci address or virtual device args::
2475 testpmd> device detach (identifier)
2477 Before detaching a device associated with ports, the ports should be stopped and closed.
2479 For example, to detach a pci device whose address is 0002:03:00.0.
2481 .. code-block:: console
2483 testpmd> device detach 0002:03:00.0
2484 Removing a device...
2485 Port 1 is now closed
2486 EAL: Releasing pci mapped resource for 0002:03:00.0
2487 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2488 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2489 Device 0002:03:00.0 is detached
2490 Now total ports is 1
2492 For example, to detach a port created by pcap PMD.
2494 .. code-block:: console
2496 testpmd> device detach net_pcap0
2497 Removing a device...
2498 Port 0 is now closed
2499 Device net_pcap0 is detached
2500 Now total ports is 0
2503 In this case, identifier is ``net_pcap0``.
2504 This identifier format is the same as ``--vdev`` format of DPDK applications.
2506 Link Bonding Functions
2507 ----------------------
2509 The Link Bonding functions make it possible to dynamically create and
2510 manage link bonding devices from within testpmd interactive prompt.
2512 create bonded device
2513 ~~~~~~~~~~~~~~~~~~~~
2515 Create a new bonding device::
2517 testpmd> create bonded device (mode) (socket)
2519 For example, to create a bonded device in mode 1 on socket 0::
2521 testpmd> create bonded device 1 0
2522 created new bonded device (port X)
2527 Adds Ethernet device to a Link Bonding device::
2529 testpmd> add bonding slave (slave id) (port id)
2531 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2533 testpmd> add bonding slave 6 10
2536 remove bonding slave
2537 ~~~~~~~~~~~~~~~~~~~~
2539 Removes an Ethernet slave device from a Link Bonding device::
2541 testpmd> remove bonding slave (slave id) (port id)
2543 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2545 testpmd> remove bonding slave 6 10
2550 Set the Link Bonding mode of a Link Bonding device::
2552 testpmd> set bonding mode (value) (port id)
2554 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2556 testpmd> set bonding mode 3 10
2561 Set an Ethernet slave device as the primary device on a Link Bonding device::
2563 testpmd> set bonding primary (slave id) (port id)
2565 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2567 testpmd> set bonding primary 6 10
2572 Set the MAC address of a Link Bonding device::
2574 testpmd> set bonding mac (port id) (mac)
2576 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2578 testpmd> set bonding mac 10 00:00:00:00:00:01
2580 set bonding balance_xmit_policy
2581 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2583 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2585 testpmd> set bonding balance_xmit_policy (port_id) (l2|l23|l34)
2587 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2589 testpmd> set bonding balance_xmit_policy 10 l34
2592 set bonding mon_period
2593 ~~~~~~~~~~~~~~~~~~~~~~
2595 Set the link status monitoring polling period in milliseconds for a bonding device.
2597 This adds support for PMD slave devices which do not support link status interrupts.
2598 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2599 link status ISR will be queried every polling interval to check if their link status has changed::
2601 testpmd> set bonding mon_period (port_id) (value)
2603 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2605 testpmd> set bonding mon_period 5 150
2608 set bonding lacp dedicated_queue
2609 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2611 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2612 when in mode 4 (link-aggregation-802.3ad)::
2614 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2617 set bonding agg_mode
2618 ~~~~~~~~~~~~~~~~~~~~
2620 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2622 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2628 Show the current configuration of a Link Bonding device::
2630 testpmd> show bonding config (port id)
2633 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2634 in balance mode with a transmission policy of layer 2+3::
2636 testpmd> show bonding config 9
2638 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2640 Active Slaves (3): [1 3 4]
2643 show bonding lacp info
2644 ~~~~~~~~~~~~~~~~~~~~~~
2646 Show information about the Link Bonding device in mode 4 (link-aggregation-802.3ad)::
2648 testpmd> show bonding lacp info (port_id)
2653 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2654 This is mainly useful for debugging purposes.
2655 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2656 and fields that can be accessed.
2661 Display the value of a port register::
2663 testpmd> read reg (port_id) (address)
2665 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2667 testpmd> read reg 0 0xEE00
2668 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2673 Display a port register bit field::
2675 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2677 For example, reading the lowest two bits from the register in the example above::
2679 testpmd> read regfield 0 0xEE00 0 1
2680 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2685 Display a single port register bit::
2687 testpmd> read regbit (port_id) (address) (bit_x)
2689 For example, reading the lowest bit from the register in the example above::
2691 testpmd> read regbit 0 0xEE00 0
2692 port 0 PCI register at offset 0xEE00: bit 0=1
2697 Set the value of a port register::
2699 testpmd> write reg (port_id) (address) (value)
2701 For example, to clear a register::
2703 testpmd> write reg 0 0xEE00 0x0
2704 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2709 Set bit field of a port register::
2711 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2713 For example, writing to the register cleared in the example above::
2715 testpmd> write regfield 0 0xEE00 0 1 2
2716 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2721 Set single bit value of a port register::
2723 testpmd> write regbit (port_id) (address) (bit_x) (value)
2725 For example, to set the high bit in the register from the example above::
2727 testpmd> write regbit 0 0xEE00 31 1
2728 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2730 Traffic Metering and Policing
2731 -----------------------------
2733 The following section shows functions for configuring traffic metering and
2734 policing on the ethernet device through the use of generic ethdev API.
2736 show port traffic management capability
2737 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2739 Show traffic metering and policing capability of the port::
2741 testpmd> show port meter cap (port_id)
2743 add port meter profile (srTCM rfc2967)
2744 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2746 Add meter profile (srTCM rfc2697) to the ethernet device::
2748 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2749 (cir) (cbs) (ebs) (packet_mode)
2753 * ``profile_id``: ID for the meter profile.
2754 * ``cir``: Committed Information Rate (CIR) (bytes per second or packets per second).
2755 * ``cbs``: Committed Burst Size (CBS) (bytes or packets).
2756 * ``ebs``: Excess Burst Size (EBS) (bytes or packets).
2757 * ``packet_mode``: Packets mode for meter profile.
2759 add port meter profile (trTCM rfc2968)
2760 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2762 Add meter profile (srTCM rfc2698) to the ethernet device::
2764 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2765 (cir) (pir) (cbs) (pbs) (packet_mode)
2769 * ``profile_id``: ID for the meter profile.
2770 * ``cir``: Committed information rate (bytes per second or packets per second).
2771 * ``pir``: Peak information rate (bytes per second or packets per second).
2772 * ``cbs``: Committed burst size (bytes or packets).
2773 * ``pbs``: Peak burst size (bytes or packets).
2774 * ``packet_mode``: Packets mode for meter profile.
2776 add port meter profile (trTCM rfc4115)
2777 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2779 Add meter profile (trTCM rfc4115) to the ethernet device::
2781 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2782 (cir) (eir) (cbs) (ebs) (packet_mode)
2786 * ``profile_id``: ID for the meter profile.
2787 * ``cir``: Committed information rate (bytes per second or packets per second).
2788 * ``eir``: Excess information rate (bytes per second or packets per second).
2789 * ``cbs``: Committed burst size (bytes or packets).
2790 * ``ebs``: Excess burst size (bytes or packets).
2791 * ``packet_mode``: Packets mode for meter profile.
2793 delete port meter profile
2794 ~~~~~~~~~~~~~~~~~~~~~~~~~
2796 Delete meter profile from the ethernet device::
2798 testpmd> del port meter profile (port_id) (profile_id)
2803 Create new policy object for the ethernet device::
2805 testpmd> add port meter policy (port_id) (policy_id) g_actions \
2806 {action} y_actions {action} r_actions {action}
2810 * ``policy_id``: policy ID.
2811 * ``action``: action lists for green/yellow/red colors.
2816 Delete policy object for the ethernet device::
2818 testpmd> del port meter policy (port_id) (policy_id)
2822 * ``policy_id``: policy ID.
2827 Create new meter object for the ethernet device::
2829 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2830 (policy_id) (meter_enable) (stats_mask) (shared) \
2831 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2836 * ``mtr_id``: meter object ID.
2837 * ``profile_id``: ID for the meter profile.
2838 * ``policy_id``: ID for the policy.
2839 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2840 gets enabled at the time of creation, otherwise remains disabled.
2841 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2843 * ``shared``: When this parameter has a non-zero value, the meter object is
2844 shared by multiple flows. Otherwise, meter object is used by single flow.
2845 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2846 input color for the current meter object is determined by the latest meter
2847 object in the same flow. Otherwise, the current meter object uses the
2848 *dscp_table* to determine the input color.
2849 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2850 color, 0 <= x <= 63.
2855 Enable meter for the ethernet device::
2857 testpmd> enable port meter (port_id) (mtr_id)
2862 Disable meter for the ethernet device::
2864 testpmd> disable port meter (port_id) (mtr_id)
2869 Delete meter for the ethernet device::
2871 testpmd> del port meter (port_id) (mtr_id)
2873 Set port meter profile
2874 ~~~~~~~~~~~~~~~~~~~~~~
2876 Set meter profile for the ethernet device::
2878 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2880 set port meter dscp table
2881 ~~~~~~~~~~~~~~~~~~~~~~~~~
2883 Set meter dscp table for the ethernet device::
2885 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2886 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2888 set port meter stats mask
2889 ~~~~~~~~~~~~~~~~~~~~~~~~~
2891 Set meter stats mask for the ethernet device::
2893 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2897 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2899 show port meter stats
2900 ~~~~~~~~~~~~~~~~~~~~~
2902 Show meter stats of the ethernet device::
2904 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2908 * ``clear``: Flag that indicates whether the statistics counters should
2909 be cleared (i.e. set to zero) immediately after they have been read or not.
2914 The following section shows functions for configuring traffic management on
2915 the ethernet device through the use of generic TM API.
2917 show port traffic management capability
2918 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2920 Show traffic management capability of the port::
2922 testpmd> show port tm cap (port_id)
2924 show port traffic management capability (hierarchy level)
2925 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2927 Show traffic management hierarchy level capability of the port::
2929 testpmd> show port tm level cap (port_id) (level_id)
2931 show port traffic management capability (hierarchy node level)
2932 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2934 Show the traffic management hierarchy node capability of the port::
2936 testpmd> show port tm node cap (port_id) (node_id)
2938 show port traffic management hierarchy node type
2939 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2941 Show the port traffic management hierarchy node type::
2943 testpmd> show port tm node type (port_id) (node_id)
2945 show port traffic management hierarchy node stats
2946 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2948 Show the port traffic management hierarchy node statistics::
2950 testpmd> show port tm node stats (port_id) (node_id) (clear)
2954 * ``clear``: When this parameter has a non-zero value, the statistics counters
2955 are cleared (i.e. set to zero) immediately after they have been read,
2956 otherwise the statistics counters are left untouched.
2958 Add port traffic management private shaper profile
2959 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2961 Add the port traffic management private shaper profile::
2963 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2964 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2965 (packet_length_adjust) (packet_mode)
2969 * ``shaper_profile id``: Shaper profile ID for the new profile.
2970 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second or packets per second).
2971 * ``cmit_tb_size``: Committed token bucket size (bytes or packets).
2972 * ``peak_tb_rate``: Peak token bucket rate (bytes per second or packets per second).
2973 * ``peak_tb_size``: Peak token bucket size (bytes or packets).
2974 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2975 each packet for the purpose of shaping. This parameter value can be used to
2976 correct the packet length with the framing overhead bytes that are consumed
2978 * ``packet_mode``: Shaper configured in packet mode. This parameter value if
2979 zero, configures shaper in byte mode and if non-zero configures it in packet
2982 Delete port traffic management private shaper profile
2983 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2985 Delete the port traffic management private shaper::
2987 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2991 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2993 Add port traffic management shared shaper
2994 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2996 Create the port traffic management shared shaper::
2998 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
3003 * ``shared_shaper_id``: Shared shaper ID to be created.
3004 * ``shaper_profile id``: Shaper profile ID for shared shaper.
3006 Set port traffic management shared shaper
3007 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3009 Update the port traffic management shared shaper::
3011 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
3016 * ``shared_shaper_id``: Shared shaper ID to be update.
3017 * ``shaper_profile id``: Shaper profile ID for shared shaper.
3019 Delete port traffic management shared shaper
3020 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3022 Delete the port traffic management shared shaper::
3024 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
3028 * ``shared_shaper_id``: Shared shaper ID to be deleted.
3030 Set port traffic management hierarchy node private shaper
3031 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3033 set the port traffic management hierarchy node private shaper::
3035 testpmd> set port tm node shaper profile (port_id) (node_id) \
3040 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
3043 Add port traffic management WRED profile
3044 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3046 Create a new WRED profile::
3048 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
3049 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
3050 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
3051 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
3055 * ``wred_profile id``: Identifier for the newly create WRED profile
3056 * ``color_g``: Packet color (green)
3057 * ``min_th_g``: Minimum queue threshold for packet with green color
3058 * ``max_th_g``: Minimum queue threshold for packet with green color
3059 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
3060 * ``wq_log2_g``: Negated log2 of queue weight (wq)
3061 * ``color_y``: Packet color (yellow)
3062 * ``min_th_y``: Minimum queue threshold for packet with yellow color
3063 * ``max_th_y``: Minimum queue threshold for packet with yellow color
3064 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
3065 * ``wq_log2_y``: Negated log2 of queue weight (wq)
3066 * ``color_r``: Packet color (red)
3067 * ``min_th_r``: Minimum queue threshold for packet with yellow color
3068 * ``max_th_r``: Minimum queue threshold for packet with yellow color
3069 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
3070 * ``wq_log2_r``: Negated log2 of queue weight (wq)
3072 Delete port traffic management WRED profile
3073 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3075 Delete the WRED profile::
3077 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
3079 Add port traffic management hierarchy nonleaf node
3080 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3082 Add nonleaf node to port traffic management hierarchy::
3084 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
3085 (priority) (weight) (level_id) (shaper_profile_id) \
3086 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3087 [(shared_shaper_0) (shared_shaper_1) ...] \
3091 * ``parent_node_id``: Node ID of the parent.
3092 * ``priority``: Node priority (highest node priority is zero). This is used by
3093 the SP algorithm running on the parent node for scheduling this node.
3094 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3095 to the weight sum of all siblings that have the same priority. It is used by
3096 the WFQ algorithm running on the parent node for scheduling this node.
3097 * ``level_id``: Hierarchy level of the node.
3098 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3100 * ``n_sp_priorities``: Number of strict priorities.
3101 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3102 * ``n_shared_shapers``: Number of shared shapers.
3103 * ``shared_shaper_id``: Shared shaper id.
3105 Add port traffic management hierarchy nonleaf node with packet mode
3106 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3108 Add nonleaf node with packet mode to port traffic management hierarchy::
3110 testpmd> add port tm nonleaf node pktmode (port_id) (node_id) (parent_node_id) \
3111 (priority) (weight) (level_id) (shaper_profile_id) \
3112 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3113 [(shared_shaper_0) (shared_shaper_1) ...] \
3117 * ``parent_node_id``: Node ID of the parent.
3118 * ``priority``: Node priority (highest node priority is zero). This is used by
3119 the SP algorithm running on the parent node for scheduling this node.
3120 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3121 to the weight sum of all siblings that have the same priority. It is used by
3122 the WFQ algorithm running on the parent node for scheduling this node.
3123 * ``level_id``: Hierarchy level of the node.
3124 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3126 * ``n_sp_priorities``: Number of strict priorities. Packet mode is enabled on
3128 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3129 * ``n_shared_shapers``: Number of shared shapers.
3130 * ``shared_shaper_id``: Shared shaper id.
3132 Add port traffic management hierarchy leaf node
3133 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3135 Add leaf node to port traffic management hierarchy::
3137 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
3138 (priority) (weight) (level_id) (shaper_profile_id) \
3139 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
3140 [(shared_shaper_id) (shared_shaper_id) ...] \
3144 * ``parent_node_id``: Node ID of the parent.
3145 * ``priority``: Node priority (highest node priority is zero). This is used by
3146 the SP algorithm running on the parent node for scheduling this node.
3147 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3148 to the weight sum of all siblings that have the same priority. It is used by
3149 the WFQ algorithm running on the parent node for scheduling this node.
3150 * ``level_id``: Hierarchy level of the node.
3151 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3153 * ``cman_mode``: Congestion management mode to be enabled for this node.
3154 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3155 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3156 * ``n_shared_shapers``: Number of shared shapers.
3157 * ``shared_shaper_id``: Shared shaper id.
3159 Delete port traffic management hierarchy node
3160 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3162 Delete node from port traffic management hierarchy::
3164 testpmd> del port tm node (port_id) (node_id)
3166 Update port traffic management hierarchy parent node
3167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3169 Update port traffic management hierarchy parent node::
3171 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3174 This function can only be called after the hierarchy commit invocation. Its
3175 success depends on the port support for this operation, as advertised through
3176 the port capability set. This function is valid for all nodes of the traffic
3177 management hierarchy except root node.
3179 Suspend port traffic management hierarchy node
3180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3182 testpmd> suspend port tm node (port_id) (node_id)
3184 Resume port traffic management hierarchy node
3185 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3187 testpmd> resume port tm node (port_id) (node_id)
3189 Commit port traffic management hierarchy
3190 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3192 Commit the traffic management hierarchy on the port::
3194 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3198 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3199 call failure. On the other hand, hierarchy is preserved when this parameter
3202 Set port traffic management mark VLAN dei
3203 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3205 Enables/Disables the traffic management marking on the port for VLAN packets::
3207 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3211 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3212 ``yellow`` or ``red`` will have dei bit enabled
3214 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3216 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3218 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3220 Set port traffic management mark IP dscp
3221 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3223 Enables/Disables the traffic management marking on the port for IP dscp packets::
3225 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3229 * ``port_id``: The port which on which IP packets marked as ``green`` or
3230 ``yellow`` or ``red`` will have IP dscp bits updated
3232 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3234 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3236 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3238 Set port traffic management mark IP ecn
3239 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3241 Enables/Disables the traffic management marking on the port for IP ecn packets::
3243 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3247 * ``port_id``: The port which on which IP packets marked as ``green`` or
3248 ``yellow`` or ``red`` will have IP ecn bits updated
3250 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3251 to ecn of 2'b11 when IP is caring TCP or SCTP
3253 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3254 to ecn of 2'b11 when IP is caring TCP or SCTP
3256 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3257 to ecn of 2'b11 when IP is caring TCP or SCTP
3262 This section details the available filter functions that are available.
3264 Note these functions interface the deprecated legacy filtering framework,
3265 superseded by *rte_flow*. See `Flow rules management`_.
3267 .. _testpmd_flow_director:
3272 Set flow director's input masks::
3274 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3275 src_mask (ipv4_src) (ipv6_src) (src_port) \
3276 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3278 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3280 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3281 mac (mac_value) tunnel-type (tunnel_type_value) \
3282 tunnel-id (tunnel_id_value)
3284 Example, to set flow director mask on port 0::
3286 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3287 src_mask 255.255.255.255 \
3288 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3289 dst_mask 255.255.255.255 \
3290 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3292 flow_director_flex_payload
3293 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3295 Configure flexible payload selection::
3297 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3299 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3301 testpmd> flow_director_flex_payload 0 l4 \
3302 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3305 .. _testpmd_rte_flow:
3307 Flow rules management
3308 ---------------------
3310 Control of the generic flow API (*rte_flow*) is fully exposed through the
3311 ``flow`` command (configuration, validation, creation, destruction, queries
3312 and operation modes).
3314 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3315 features simultaneously may cause undefined side-effects and is therefore
3321 Because the ``flow`` command uses dynamic tokens to handle the large number
3322 of possible flow rules combinations, its behavior differs slightly from
3323 other commands, in particular:
3325 - Pressing *?* or the *<tab>* key displays contextual help for the current
3326 token, not that of the entire command.
3328 - Optional and repeated parameters are supported (provided they are listed
3329 in the contextual help).
3331 The first parameter stands for the operation mode. Possible operations and
3332 their general syntax are described below. They are covered in detail in the
3335 - Get info about flow engine::
3339 - Configure flow engine::
3341 flow configure {port_id}
3342 [queues_number {number}] [queues_size {size}]
3343 [counters_number {number}]
3344 [aging_counters_number {number}]
3345 [meters_number {number}]
3347 - Create a pattern template::
3348 flow pattern_template {port_id} create [pattern_template_id {id}]
3349 [relaxed {boolean}] [ingress] [egress] [transfer]
3350 template {item} [/ {item} [...]] / end
3352 - Destroy a pattern template::
3354 flow pattern_template {port_id} destroy pattern_template {id} [...]
3356 - Create an actions template::
3358 flow actions_template {port_id} create [actions_template_id {id}]
3359 [ingress] [egress] [transfer]
3360 template {action} [/ {action} [...]] / end
3361 mask {action} [/ {action} [...]] / end
3363 - Destroy an actions template::
3365 flow actions_template {port_id} destroy actions_template {id} [...]
3369 flow table {port_id} create
3371 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3372 rules_number {number}
3373 pattern_template {pattern_template_id}
3374 actions_template {actions_template_id}
3378 flow table {port_id} destroy table {id} [...]
3380 - Check whether a flow rule can be created::
3382 flow validate {port_id}
3383 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3384 pattern {item} [/ {item} [...]] / end
3385 actions {action} [/ {action} [...]] / end
3387 - Enqueue creation of a flow rule::
3389 flow queue {port_id} create {queue_id}
3390 [postpone {boolean}] template_table {table_id}
3391 pattern_template {pattern_template_index}
3392 actions_template {actions_template_index}
3393 pattern {item} [/ {item} [...]] / end
3394 actions {action} [/ {action} [...]] / end
3396 - Enqueue destruction of specific flow rules::
3398 flow queue {port_id} destroy {queue_id}
3399 [postpone {boolean}] rule {rule_id} [...]
3401 - Push enqueued operations::
3403 flow push {port_id} queue {queue_id}
3405 - Pull all operations results from a queue::
3407 flow pull {port_id} queue {queue_id}
3409 - Create a flow rule::
3411 flow create {port_id}
3412 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3413 pattern {item} [/ {item} [...]] / end
3414 actions {action} [/ {action} [...]] / end
3416 - Destroy specific flow rules::
3418 flow destroy {port_id} rule {rule_id} [...]
3420 - Destroy all flow rules::
3422 flow flush {port_id}
3424 - Query an existing flow rule::
3426 flow query {port_id} {rule_id} {action}
3428 - List existing flow rules sorted by priority, filtered by group
3431 flow list {port_id} [group {group_id}] [...]
3433 - Restrict ingress traffic to the defined flow rules::
3435 flow isolate {port_id} {boolean}
3437 - Dump internal representation information of all flows in hardware::
3439 flow dump {port_id} all {output_file}
3443 flow dump {port_id} rule {rule_id} {output_file}
3445 - List and destroy aged flow rules::
3447 flow aged {port_id} [destroy]
3449 - Tunnel offload - create a tunnel stub::
3451 flow tunnel create {port_id} type {tunnel_type}
3453 - Tunnel offload - destroy a tunnel stub::
3455 flow tunnel destroy {port_id} id {tunnel_id}
3457 - Tunnel offload - list port tunnel stubs::
3459 flow tunnel list {port_id}
3461 Retrieving info about flow management engine
3462 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3464 ``flow info`` retrieves info on pre-configurable resources in the underlying
3465 device to give a hint of possible values for flow engine configuration.
3467 ``rte_flow_info_get()``::
3471 If successful, it will show::
3473 Flow engine resources on port #[...]:
3474 Number of queues: #[...]
3475 Size of queues: #[...]
3476 Number of counters: #[...]
3477 Number of aging objects: #[...]
3478 Number of meters: #[...]
3480 Otherwise it will show an error message of the form::
3482 Caught error type [...] ([...]): [...]
3484 Configuring flow management engine
3485 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3487 ``flow configure`` pre-allocates all the needed resources in the underlying
3488 device to be used later at the flow creation. Flow queues are allocated as well
3489 for asynchronous flow creation/destruction operations. It is bound to
3490 ``rte_flow_configure()``::
3492 flow configure {port_id}
3493 [queues_number {number}] [queues_size {size}]
3494 [counters_number {number}]
3495 [aging_counters_number {number}]
3496 [meters_number {number}]
3498 If successful, it will show::
3500 Configure flows on port #[...]: number of queues #[...] with #[...] elements
3502 Otherwise it will show an error message of the form::
3504 Caught error type [...] ([...]): [...]
3506 Creating pattern templates
3507 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3509 ``flow pattern_template create`` creates the specified pattern template.
3510 It is bound to ``rte_flow_pattern_template_create()``::
3512 flow pattern_template {port_id} create [pattern_template_id {id}]
3513 [relaxed {boolean}] [ingress] [egress] [transfer]
3514 template {item} [/ {item} [...]] / end
3516 If successful, it will show::
3518 Pattern template #[...] created
3520 Otherwise it will show an error message of the form::
3522 Caught error type [...] ([...]): [...]
3524 This command uses the same pattern items as ``flow create``,
3525 their format is described in `Creating flow rules`_.
3527 Destroying pattern templates
3528 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3530 ``flow pattern_template destroy`` destroys one or more pattern templates
3531 from their template ID (as returned by ``flow pattern_template create``),
3532 this command calls ``rte_flow_pattern_template_destroy()`` as many
3533 times as necessary::
3535 flow pattern_template {port_id} destroy pattern_template {id} [...]
3537 If successful, it will show::
3539 Pattern template #[...] destroyed
3541 It does not report anything for pattern template IDs that do not exist.
3542 The usual error message is shown when a pattern template cannot be destroyed::
3544 Caught error type [...] ([...]): [...]
3546 Creating actions templates
3547 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3549 ``flow actions_template create`` creates the specified actions template.
3550 It is bound to ``rte_flow_actions_template_create()``::
3552 flow actions_template {port_id} create [actions_template_id {id}]
3553 [ingress] [egress] [transfer]
3554 template {action} [/ {action} [...]] / end
3555 mask {action} [/ {action} [...]] / end
3557 If successful, it will show::
3559 Actions template #[...] created
3561 Otherwise it will show an error message of the form::
3563 Caught error type [...] ([...]): [...]
3565 This command uses the same actions as ``flow create``,
3566 their format is described in `Creating flow rules`_.
3568 Destroying actions templates
3569 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3571 ``flow actions_template destroy`` destroys one or more actions templates
3572 from their template ID (as returned by ``flow actions_template create``),
3573 this command calls ``rte_flow_actions_template_destroy()`` as many
3574 times as necessary::
3576 flow actions_template {port_id} destroy actions_template {id} [...]
3578 If successful, it will show::
3580 Actions template #[...] destroyed
3582 It does not report anything for actions template IDs that do not exist.
3583 The usual error message is shown when an actions template cannot be destroyed::
3585 Caught error type [...] ([...]): [...]
3587 Creating template table
3588 ~~~~~~~~~~~~~~~~~~~~~~~
3590 ``flow template_table create`` creates the specified template table.
3591 It is bound to ``rte_flow_template_table_create()``::
3593 flow template_table {port_id} create
3594 [table_id {id}] [group {group_id}]
3595 [priority {level}] [ingress] [egress] [transfer]
3596 rules_number {number}
3597 pattern_template {pattern_template_id}
3598 actions_template {actions_template_id}
3600 If successful, it will show::
3602 Template table #[...] created
3604 Otherwise it will show an error message of the form::
3606 Caught error type [...] ([...]): [...]
3608 Destroying flow table
3609 ~~~~~~~~~~~~~~~~~~~~~
3611 ``flow template_table destroy`` destroys one or more template tables
3612 from their table ID (as returned by ``flow template_table create``),
3613 this command calls ``rte_flow_template_table_destroy()`` as many
3614 times as necessary::
3616 flow template_table {port_id} destroy table {id} [...]
3618 If successful, it will show::
3620 Template table #[...] destroyed
3622 It does not report anything for table IDs that do not exist.
3623 The usual error message is shown when a table cannot be destroyed::
3625 Caught error type [...] ([...]): [...]
3627 Pushing enqueued operations
3628 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
3630 ``flow push`` pushes all the outstanding enqueued operations
3631 to the underlying device immediately.
3632 It is bound to ``rte_flow_push()``::
3634 flow push {port_id} queue {queue_id}
3636 If successful, it will show::
3638 Queue #[...] operations pushed
3640 The usual error message is shown when operations cannot be pushed::
3642 Caught error type [...] ([...]): [...]
3644 Pulling flow operations results
3645 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3647 ``flow pull`` asks the underlying device about flow queue operations
3648 results and return all the processed (successfully or not) operations.
3649 It is bound to ``rte_flow_pull()``::
3651 flow pull {port_id} queue {queue_id}
3653 If successful, it will show::
3655 Queue #[...] pulled #[...] operations (#[...] failed, #[...] succeeded)
3657 The usual error message is shown when operations results cannot be pulled::
3659 Caught error type [...] ([...]): [...]
3661 Creating a tunnel stub for offload
3662 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3664 ``flow tunnel create`` setup a tunnel stub for tunnel offload flow rules::
3666 flow tunnel create {port_id} type {tunnel_type}
3668 If successful, it will return a tunnel stub ID usable with other commands::
3670 port [...]: flow tunnel #[...] type [...]
3672 Tunnel stub ID is relative to a port.
3674 Destroying tunnel offload stub
3675 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3677 ``flow tunnel destroy`` destroy port tunnel stub::
3679 flow tunnel destroy {port_id} id {tunnel_id}
3681 Listing tunnel offload stubs
3682 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3684 ``flow tunnel list`` list port tunnel offload stubs::
3686 flow tunnel list {port_id}
3688 Validating flow rules
3689 ~~~~~~~~~~~~~~~~~~~~~
3691 ``flow validate`` reports whether a flow rule would be accepted by the
3692 underlying device in its current state but stops short of creating it. It is
3693 bound to ``rte_flow_validate()``::
3695 flow validate {port_id}
3696 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3697 pattern {item} [/ {item} [...]] / end
3698 actions {action} [/ {action} [...]] / end
3700 If successful, it will show::
3704 Otherwise it will show an error message of the form::
3706 Caught error type [...] ([...]): [...]
3708 This command uses the same parameters as ``flow create``, their format is
3709 described in `Creating flow rules`_.
3711 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3712 index 6 is supported::
3714 testpmd> flow validate 0 ingress pattern eth / end
3715 actions queue index 6 / end
3719 Port 0 does not support TCPv6 rules::
3721 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3723 Caught error type 9 (specific pattern item): Invalid argument
3729 ``flow create`` validates and creates the specified flow rule. It is bound
3730 to ``rte_flow_create()``::
3732 flow create {port_id}
3733 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3734 [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}]
3735 pattern {item} [/ {item} [...]] / end
3736 actions {action} [/ {action} [...]] / end
3738 If successful, it will return a flow rule ID usable with other commands::
3740 Flow rule #[...] created
3742 Otherwise it will show an error message of the form::
3744 Caught error type [...] ([...]): [...]
3746 Parameters describe in the following order:
3748 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3749 - Tunnel offload specification (tunnel_set, tunnel_match)
3750 - A matching pattern, starting with the *pattern* token and terminated by an
3752 - Actions, starting with the *actions* token and terminated by an *end*
3755 These translate directly to *rte_flow* objects provided as-is to the
3756 underlying functions.
3758 The shortest valid definition only comprises mandatory tokens::
3760 testpmd> flow create 0 pattern end actions end
3762 Note that PMDs may refuse rules that essentially do nothing such as this
3765 **All unspecified object values are automatically initialized to 0.**
3767 Enqueueing creation of flow rules
3768 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3770 ``flow queue create`` adds creation operation of a flow rule to a queue.
3771 It is bound to ``rte_flow_async_create()``::
3773 flow queue {port_id} create {queue_id}
3774 [postpone {boolean}] template_table {table_id}
3775 pattern_template {pattern_template_index}
3776 actions_template {actions_template_index}
3777 pattern {item} [/ {item} [...]] / end
3778 actions {action} [/ {action} [...]] / end
3780 If successful, it will return a flow rule ID usable with other commands::
3782 Flow rule #[...] creaion enqueued
3784 Otherwise it will show an error message of the form::
3786 Caught error type [...] ([...]): [...]
3788 This command uses the same pattern items and actions as ``flow create``,
3789 their format is described in `Creating flow rules`_.
3791 ``flow queue pull`` must be called to retrieve the operation status.
3796 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3797 specified before the ``pattern`` token.
3799 - ``group {group id}``: priority group.
3800 - ``priority {level}``: priority level within group.
3801 - ``ingress``: rule applies to ingress traffic.
3802 - ``egress``: rule applies to egress traffic.
3803 - ``transfer``: apply rule directly to endpoints found in pattern.
3805 Please note that use of ``transfer`` attribute requires that the flow and
3806 its indirect components be managed via so-called ``transfer`` proxy port.
3807 See `show flow transfer proxy port ID for the given port`_ for details.
3809 Each instance of an attribute specified several times overrides the previous
3810 value as shown below (group 4 is used)::
3812 testpmd> flow create 0 group 42 group 24 group 4 [...]
3814 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3816 While not specifying a direction is an error, some rules may allow both
3819 Most rules affect RX therefore contain the ``ingress`` token::
3821 testpmd> flow create 0 ingress pattern [...]
3826 Indicate tunnel offload rule type
3828 - ``tunnel_set {tunnel_id}``: mark rule as tunnel offload decap_set type.
3829 - ``tunnel_match {tunnel_id}``: mark rule as tunnel offload match type.
3834 A matching pattern starts after the ``pattern`` token. It is made of pattern
3835 items and is terminated by a mandatory ``end`` item.
3837 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3838 rte_flow_item_type``).
3840 The ``/`` token is used as a separator between pattern items as shown
3843 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3845 Note that protocol items like these must be stacked from lowest to highest
3846 layer to make sense. For instance, the following rule is either invalid or
3847 unlikely to match any packet::
3849 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3851 More information on these restrictions can be found in the *rte_flow*
3854 Several items support additional specification structures, for example
3855 ``ipv4`` allows specifying source and destination addresses as follows::
3857 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3858 dst is 10.2.0.0 / end [...]
3860 This rule matches all IPv4 traffic with the specified properties.
3862 In this example, ``src`` and ``dst`` are field names of the underlying
3863 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3864 in a similar fashion.
3866 The ``is`` token means that the subsequent value must be matched exactly,
3867 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3868 accordingly. Possible assignment tokens are:
3870 - ``is``: match value perfectly (with full bit-mask).
3871 - ``spec``: match value according to configured bit-mask.
3872 - ``last``: specify upper bound to establish a range.
3873 - ``mask``: specify bit-mask with relevant bits set to one.
3874 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3876 These yield identical results::
3878 ipv4 src is 10.1.1.1
3882 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3886 ipv4 src spec 10.1.1.1 src prefix 32
3890 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3894 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3896 Inclusive ranges can be defined with ``last``::
3898 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3900 Note that ``mask`` affects both ``spec`` and ``last``::
3902 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3903 # matches 10.1.0.0 to 10.2.255.255
3905 Properties can be modified multiple times::
3907 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3911 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3916 This section lists supported pattern items and their attributes, if any.
3918 - ``end``: end list of pattern items.
3920 - ``void``: no-op pattern item.
3922 - ``invert``: perform actions when pattern does not match.
3924 - ``any``: match any protocol for the current layer.
3926 - ``num {unsigned}``: number of layers covered.
3928 - ``pf``: match traffic from/to the physical function.
3930 - ``vf``: match traffic from/to a virtual function ID.
3932 - ``id {unsigned}``: VF ID.
3934 - ``phy_port``: match traffic from/to a specific physical port.
3936 - ``index {unsigned}``: physical port index.
3938 - ``port_id``: match traffic from/to a given DPDK port ID.
3940 - ``id {unsigned}``: DPDK port ID.
3942 - ``mark``: match value set in previously matched flow rule using the mark action.
3944 - ``id {unsigned}``: arbitrary integer value.
3946 - ``raw``: match an arbitrary byte string.
3948 - ``relative {boolean}``: look for pattern after the previous item.
3949 - ``search {boolean}``: search pattern from offset (see also limit).
3950 - ``offset {integer}``: absolute or relative offset for pattern.
3951 - ``limit {unsigned}``: search area limit for start of pattern.
3952 - ``pattern {string}``: byte string to look for.
3953 - ``pattern_hex {string}``: byte string (provided in hexadecimal) to look for.
3955 - ``eth``: match Ethernet header.
3957 - ``dst {MAC-48}``: destination MAC.
3958 - ``src {MAC-48}``: source MAC.
3959 - ``type {unsigned}``: EtherType or TPID.
3961 - ``vlan``: match 802.1Q/ad VLAN tag.
3963 - ``tci {unsigned}``: tag control information.
3964 - ``pcp {unsigned}``: priority code point.
3965 - ``dei {unsigned}``: drop eligible indicator.
3966 - ``vid {unsigned}``: VLAN identifier.
3967 - ``inner_type {unsigned}``: inner EtherType or TPID.
3969 - ``ipv4``: match IPv4 header.
3971 - ``version_ihl {unsigned}``: IPv4 version and IP header length.
3972 - ``tos {unsigned}``: type of service.
3973 - ``ttl {unsigned}``: time to live.
3974 - ``proto {unsigned}``: next protocol ID.
3975 - ``src {ipv4 address}``: source address.
3976 - ``dst {ipv4 address}``: destination address.
3978 - ``ipv6``: match IPv6 header.
3980 - ``tc {unsigned}``: traffic class.
3981 - ``flow {unsigned}``: flow label.
3982 - ``proto {unsigned}``: protocol (next header).
3983 - ``hop {unsigned}``: hop limit.
3984 - ``src {ipv6 address}``: source address.
3985 - ``dst {ipv6 address}``: destination address.
3987 - ``icmp``: match ICMP header.
3989 - ``type {unsigned}``: ICMP packet type.
3990 - ``code {unsigned}``: ICMP packet code.
3992 - ``udp``: match UDP header.
3994 - ``src {unsigned}``: UDP source port.
3995 - ``dst {unsigned}``: UDP destination port.
3997 - ``tcp``: match TCP header.
3999 - ``src {unsigned}``: TCP source port.
4000 - ``dst {unsigned}``: TCP destination port.
4002 - ``sctp``: match SCTP header.
4004 - ``src {unsigned}``: SCTP source port.
4005 - ``dst {unsigned}``: SCTP destination port.
4006 - ``tag {unsigned}``: validation tag.
4007 - ``cksum {unsigned}``: checksum.
4009 - ``vxlan``: match VXLAN header.
4011 - ``vni {unsigned}``: VXLAN identifier.
4012 - ``last_rsvd {unsigned}``: VXLAN last reserved 8-bits.
4014 - ``e_tag``: match IEEE 802.1BR E-Tag header.
4016 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
4018 - ``nvgre``: match NVGRE header.
4020 - ``tni {unsigned}``: virtual subnet ID.
4022 - ``mpls``: match MPLS header.
4024 - ``label {unsigned}``: MPLS label.
4026 - ``gre``: match GRE header.
4028 - ``protocol {unsigned}``: protocol type.
4030 - ``gre_key``: match GRE optional key field.
4032 - ``value {unsigned}``: key value.
4034 - ``gre_option``: match GRE optional fields(checksum/key/sequence).
4036 - ``checksum {unsigned}``: checksum value.
4037 - ``key {unsigned}``: key value.
4038 - ``sequence {unsigned}``: sequence number value.
4040 - ``fuzzy``: fuzzy pattern match, expect faster than default.
4042 - ``thresh {unsigned}``: accuracy threshold.
4044 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
4046 - ``teid {unsigned}``: tunnel endpoint identifier.
4048 - ``geneve``: match GENEVE header.
4050 - ``vni {unsigned}``: virtual network identifier.
4051 - ``protocol {unsigned}``: protocol type.
4053 - ``geneve-opt``: match GENEVE header option.
4055 - ``class {unsigned}``: GENEVE option class.
4056 - ``type {unsigned}``: GENEVE option type.
4057 - ``length {unsigned}``: GENEVE option length in 32-bit words.
4058 - ``data {hex string}``: GENEVE option data, the length is defined by
4061 - ``vxlan-gpe``: match VXLAN-GPE header.
4063 - ``vni {unsigned}``: VXLAN-GPE identifier.
4065 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
4067 - ``sha {MAC-48}``: sender hardware address.
4068 - ``spa {ipv4 address}``: sender IPv4 address.
4069 - ``tha {MAC-48}``: target hardware address.
4070 - ``tpa {ipv4 address}``: target IPv4 address.
4072 - ``ipv6_ext``: match presence of any IPv6 extension header.
4074 - ``next_hdr {unsigned}``: next header.
4076 - ``icmp6``: match any ICMPv6 header.
4078 - ``type {unsigned}``: ICMPv6 type.
4079 - ``code {unsigned}``: ICMPv6 code.
4081 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
4083 - ``target_addr {ipv6 address}``: target address.
4085 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
4087 - ``target_addr {ipv6 address}``: target address.
4089 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
4091 - ``type {unsigned}``: ND option type.
4093 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
4094 link-layer address option.
4096 - ``sla {MAC-48}``: source Ethernet LLA.
4098 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
4099 link-layer address option.
4101 - ``tla {MAC-48}``: target Ethernet LLA.
4103 - ``meta``: match application specific metadata.
4105 - ``data {unsigned}``: metadata value.
4107 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
4109 - ``pdu_type {unsigned}``: PDU type.
4111 - ``qfi {unsigned}``: QoS flow identifier.
4113 - ``pppoes``, ``pppoed``: match PPPoE header.
4115 - ``session_id {unsigned}``: session identifier.
4117 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
4119 - ``proto_id {unsigned}``: PPP protocol identifier.
4121 - ``l2tpv3oip``: match L2TPv3 over IP header.
4123 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
4125 - ``ah``: match AH header.
4127 - ``spi {unsigned}``: security parameters index.
4129 - ``pfcp``: match PFCP header.
4131 - ``s_field {unsigned}``: S field.
4132 - ``seid {unsigned}``: session endpoint identifier.
4134 - ``integrity``: match packet integrity.
4136 - ``level {unsigned}``: Packet encapsulation level the item should
4137 apply to. See rte_flow_action_rss for details.
4138 - ``value {unsigned}``: A bitmask that specify what packet elements
4139 must be matched for integrity.
4141 - ``conntrack``: match conntrack state.
4143 - ``port_representor``: match traffic entering the embedded switch from the given ethdev
4145 - ``port_id {unsigned}``: ethdev port ID
4147 - ``represented_port``: match traffic entering the embedded switch from
4148 the entity represented by the given ethdev
4150 - ``ethdev_port_id {unsigned}``: ethdev port ID
4152 - ``l2tpv2``: match L2TPv2 header.
4154 - ``length {unsigned}``: L2TPv2 option length.
4155 - ``tunnel_id {unsigned}``: L2TPv2 tunnel identifier.
4156 - ``session_id {unsigned}``: L2TPv2 session identifier.
4157 - ``ns {unsigned}``: L2TPv2 option ns.
4158 - ``nr {unsigned}``: L2TPv2 option nr.
4159 - ``offset_size {unsigned}``: L2TPv2 option offset.
4161 - ``ppp``: match PPP header.
4163 - ``addr {unsigned}``: PPP address.
4164 - ``ctrl {unsigned}``: PPP control.
4165 - ``proto_id {unsigned}``: PPP protocol identifier.
4170 A list of actions starts after the ``actions`` token in the same fashion as
4171 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
4172 terminated by a mandatory ``end`` action.
4174 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
4175 rte_flow_action_type``).
4177 Dropping all incoming UDPv4 packets can be expressed as follows::
4179 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4182 Several actions have configurable properties which must be specified when
4183 there is no valid default value. For example, ``queue`` requires a target
4186 This rule redirects incoming UDPv4 traffic to queue index 6::
4188 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4189 actions queue index 6 / end
4191 While this one could be rejected by PMDs (unspecified queue index)::
4193 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4196 As defined by *rte_flow*, the list is not ordered, all actions of a given
4197 rule are performed simultaneously. These are equivalent::
4199 queue index 6 / void / mark id 42 / end
4203 void / mark id 42 / queue index 6 / end
4205 All actions in a list should have different types, otherwise only the last
4206 action of a given type is taken into account::
4208 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4212 drop / drop / drop / end # drop is performed only once
4216 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4218 Considering they are performed simultaneously, opposite and overlapping
4219 actions can sometimes be combined when the end result is unambiguous::
4221 drop / queue index 6 / end # drop has no effect
4225 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4229 drop / passthru / end # drop has no effect
4231 Note that PMDs may still refuse such combinations.
4236 This section lists supported actions and their attributes, if any.
4238 - ``end``: end list of actions.
4240 - ``void``: no-op action.
4242 - ``passthru``: let subsequent rule process matched packets.
4244 - ``jump``: redirect traffic to group on device.
4246 - ``group {unsigned}``: group to redirect to.
4248 - ``mark``: attach 32 bit value to packets.
4250 - ``id {unsigned}``: 32 bit value to return with packets.
4252 - ``flag``: flag packets.
4254 - ``queue``: assign packets to a given queue index.
4256 - ``index {unsigned}``: queue index to use.
4258 - ``drop``: drop packets (note: passthru has priority).
4260 - ``count``: enable counters for this rule.
4262 - ``rss``: spread packets among several queues.
4264 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4265 ``toeplitz``, ``simple_xor``, ``symmetric_toeplitz`` and ``default``.
4267 - ``level {unsigned}``: encapsulation level for ``types``.
4269 - ``types [{RSS hash type} [...]] end``: specific RSS hash types.
4270 Note that an empty list does not disable RSS but instead requests
4271 unspecified "best-effort" settings.
4273 - ``key {string}``: RSS hash key, overrides ``key_len``.
4275 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4276 conjunction with ``key`` to pad or truncate it.
4278 - ``queues [{unsigned} [...]] end``: queue indices to use.
4280 - ``pf``: direct traffic to physical function.
4282 - ``vf``: direct traffic to a virtual function ID.
4284 - ``original {boolean}``: use original VF ID if possible.
4285 - ``id {unsigned}``: VF ID.
4287 - ``phy_port``: direct packets to physical port index.
4289 - ``original {boolean}``: use original port index if possible.
4290 - ``index {unsigned}``: physical port index.
4292 - ``port_id``: direct matching traffic to a given DPDK port ID.
4294 - ``original {boolean}``: use original DPDK port ID if possible.
4295 - ``id {unsigned}``: DPDK port ID.
4297 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4299 - ``mpls_ttl``: MPLS TTL.
4301 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4303 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4305 - ``nw_ttl``: IP TTL.
4307 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4309 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4311 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4313 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4315 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4317 - ``ethertype``: Ethertype.
4319 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4321 - ``vlan_vid``: VLAN id.
4323 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4325 - ``vlan_pcp``: VLAN priority.
4327 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4329 - ``ethertype``: Ethertype.
4331 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4333 - ``ethertype``: Ethertype.
4335 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4336 is done through `Config VXLAN Encap outer layers`_.
4338 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4339 the VXLAN tunnel network overlay from the matched flow.
4341 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4342 is done through `Config NVGRE Encap outer layers`_.
4344 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4345 the NVGRE tunnel network overlay from the matched flow.
4347 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4348 is done through `Config L2 Encap`_.
4350 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4351 is done through `Config L2 Decap`_.
4353 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4354 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4356 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4357 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4359 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4360 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4362 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4363 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4365 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4367 - ``ipv4_addr``: New IPv4 source address.
4369 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4372 - ``ipv4_addr``: New IPv4 destination address.
4374 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4376 - ``ipv6_addr``: New IPv6 source address.
4378 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4381 - ``ipv6_addr``: New IPv6 destination address.
4383 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4386 - ``port``: New TCP/UDP source port number.
4388 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4391 - ``port``: New TCP/UDP destination port number.
4393 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4396 - ``dec_ttl``: Performs a decrease TTL value action
4398 - ``set_ttl``: Set TTL value with specified value
4399 - ``ttl_value {unsigned}``: The new TTL value to be set
4401 - ``set_mac_src``: set source MAC address
4403 - ``mac_addr {MAC-48}``: new source MAC address
4405 - ``set_mac_dst``: set destination MAC address
4407 - ``mac_addr {MAC-48}``: new destination MAC address
4409 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4411 - ``value {unsigned}``: Value to increase TCP sequence number by.
4413 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4415 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4417 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4419 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4421 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4423 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4425 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4427 - ``dscp_value {unsigned}``: The new DSCP value to be set
4429 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4431 - ``dscp_value {unsigned}``: The new DSCP value to be set
4433 - ``indirect``: Use indirect action created via
4434 ``flow indirect_action {port_id} create``
4436 - ``indirect_action_id {unsigned}``: Indirect action ID to use
4438 - ``color``: Color the packet to reflect the meter color result
4440 - ``type {value}``: Set color type with specified value(green/yellow/red)
4442 - ``port_representor``: at embedded switch level, send matching traffic to
4445 - ``port_id {unsigned}``: ethdev port ID
4447 - ``represented_port``: at embedded switch level, send matching traffic to
4448 the entity represented by the given ethdev
4450 - ``ethdev_port_id {unsigned}``: ethdev port ID
4452 Destroying flow rules
4453 ~~~~~~~~~~~~~~~~~~~~~
4455 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4456 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4457 times as necessary::
4459 flow destroy {port_id} rule {rule_id} [...]
4461 If successful, it will show::
4463 Flow rule #[...] destroyed
4465 It does not report anything for rule IDs that do not exist. The usual error
4466 message is shown when a rule cannot be destroyed::
4468 Caught error type [...] ([...]): [...]
4470 ``flow flush`` destroys all rules on a device and does not take extra
4471 arguments. It is bound to ``rte_flow_flush()``::
4473 flow flush {port_id}
4475 Any errors are reported as above.
4477 Creating several rules and destroying them::
4479 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4480 actions queue index 2 / end
4481 Flow rule #0 created
4482 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4483 actions queue index 3 / end
4484 Flow rule #1 created
4485 testpmd> flow destroy 0 rule 0 rule 1
4486 Flow rule #1 destroyed
4487 Flow rule #0 destroyed
4490 The same result can be achieved using ``flow flush``::
4492 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4493 actions queue index 2 / end
4494 Flow rule #0 created
4495 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4496 actions queue index 3 / end
4497 Flow rule #1 created
4498 testpmd> flow flush 0
4501 Non-existent rule IDs are ignored::
4503 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4504 actions queue index 2 / end
4505 Flow rule #0 created
4506 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4507 actions queue index 3 / end
4508 Flow rule #1 created
4509 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4511 testpmd> flow destroy 0 rule 0
4512 Flow rule #0 destroyed
4515 Enqueueing destruction of flow rules
4516 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4518 ``flow queue destroy`` adds destruction operations to destroy one or more rules
4519 from their rule ID (as returned by ``flow queue create``) to a queue,
4520 this command calls ``rte_flow_async_destroy()`` as many times as necessary::
4522 flow queue {port_id} destroy {queue_id}
4523 [postpone {boolean}] rule {rule_id} [...]
4525 If successful, it will show::
4527 Flow rule #[...] destruction enqueued
4529 It does not report anything for rule IDs that do not exist. The usual error
4530 message is shown when a rule cannot be destroyed::
4532 Caught error type [...] ([...]): [...]
4534 ``flow queue pull`` must be called to retrieve the operation status.
4539 ``flow query`` queries a specific action of a flow rule having that
4540 ability. Such actions collect information that can be reported using this
4541 command. It is bound to ``rte_flow_query()``::
4543 flow query {port_id} {rule_id} {action}
4545 If successful, it will display either the retrieved data for known actions
4546 or the following message::
4548 Cannot display result for action type [...] ([...])
4550 Otherwise, it will complain either that the rule does not exist or that some
4553 Flow rule #[...] not found
4557 Caught error type [...] ([...]): [...]
4559 Currently only the ``count`` action is supported. This action reports the
4560 number of packets that hit the flow rule and the total number of bytes. Its
4561 output has the following format::
4564 hits_set: [...] # whether "hits" contains a valid value
4565 bytes_set: [...] # whether "bytes" contains a valid value
4566 hits: [...] # number of packets
4567 bytes: [...] # number of bytes
4569 Querying counters for TCPv6 packets redirected to queue 6::
4571 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4572 actions queue index 6 / count / end
4573 Flow rule #4 created
4574 testpmd> flow query 0 4 count
4585 ``flow list`` lists existing flow rules sorted by priority and optionally
4586 filtered by group identifiers::
4588 flow list {port_id} [group {group_id}] [...]
4590 This command only fails with the following message if the device does not
4595 Output consists of a header line followed by a short description of each
4596 flow rule, one per line. There is no output at all when no flow rules are
4597 configured on the device::
4599 ID Group Prio Attr Rule
4600 [...] [...] [...] [...] [...]
4602 ``Attr`` column flags:
4604 - ``i`` for ``ingress``.
4605 - ``e`` for ``egress``.
4607 Creating several flow rules and listing them::
4609 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4610 actions queue index 6 / end
4611 Flow rule #0 created
4612 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4613 actions queue index 2 / end
4614 Flow rule #1 created
4615 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4616 actions rss queues 6 7 8 end / end
4617 Flow rule #2 created
4618 testpmd> flow list 0
4619 ID Group Prio Attr Rule
4620 0 0 0 i- ETH IPV4 => QUEUE
4621 1 0 0 i- ETH IPV6 => QUEUE
4622 2 0 5 i- ETH IPV4 UDP => RSS
4625 Rules are sorted by priority (i.e. group ID first, then priority level)::
4627 testpmd> flow list 1
4628 ID Group Prio Attr Rule
4629 0 0 0 i- ETH => COUNT
4630 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4631 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4632 1 24 0 i- ETH IPV4 UDP => QUEUE
4633 4 24 10 i- ETH IPV4 TCP => DROP
4634 3 24 20 i- ETH IPV4 => DROP
4635 2 24 42 i- ETH IPV4 UDP => QUEUE
4636 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4639 Output can be limited to specific groups::
4641 testpmd> flow list 1 group 0 group 63
4642 ID Group Prio Attr Rule
4643 0 0 0 i- ETH => COUNT
4644 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4645 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4646 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4649 Toggling isolated mode
4650 ~~~~~~~~~~~~~~~~~~~~~~
4652 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4653 must only be injected from the defined flow rules; that no default traffic
4654 is expected outside those rules and the driver is free to assign more
4655 resources to handle them. It is bound to ``rte_flow_isolate()``::
4657 flow isolate {port_id} {boolean}
4659 If successful, enabling or disabling isolated mode shows either::
4661 Ingress traffic on port [...]
4662 is now restricted to the defined flow rules
4666 Ingress traffic on port [...]
4667 is not restricted anymore to the defined flow rules
4669 Otherwise, in case of error::
4671 Caught error type [...] ([...]): [...]
4673 Mainly due to its side effects, PMDs supporting this mode may not have the
4674 ability to toggle it more than once without reinitializing affected ports
4675 first (e.g. by exiting testpmd).
4677 Enabling isolated mode::
4679 testpmd> flow isolate 0 true
4680 Ingress traffic on port 0 is now restricted to the defined flow rules
4683 Disabling isolated mode::
4685 testpmd> flow isolate 0 false
4686 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4689 Dumping HW internal information
4690 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4692 ``flow dump`` dumps the hardware's internal representation information of
4693 all flows. It is bound to ``rte_flow_dev_dump()``::
4695 flow dump {port_id} {output_file}
4697 If successful, it will show::
4701 Otherwise, it will complain error occurred::
4703 Caught error type [...] ([...]): [...]
4705 Listing and destroying aged flow rules
4706 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4708 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4709 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4711 flow aged {port_id} [destroy]
4713 Listing current aged flow rules::
4715 testpmd> flow aged 0
4716 Port 0 total aged flows: 0
4717 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4718 actions age timeout 5 / queue index 0 / end
4719 Flow rule #0 created
4720 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4721 actions age timeout 4 / queue index 0 / end
4722 Flow rule #1 created
4723 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4724 actions age timeout 2 / queue index 0 / end
4725 Flow rule #2 created
4726 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4727 actions age timeout 3 / queue index 0 / end
4728 Flow rule #3 created
4731 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4732 information, all the aged flows are sorted by the longest timeout time. For example, if
4733 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4734 will be ID 3, ID 1, ID 0::
4736 testpmd> flow aged 0
4737 Port 0 total aged flows: 4
4744 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4746 testpmd> flow aged 0 destroy
4747 Port 0 total aged flows: 4
4754 Flow rule #2 destroyed
4755 Flow rule #3 destroyed
4756 Flow rule #1 destroyed
4757 Flow rule #0 destroyed
4758 4 flows be destroyed
4759 testpmd> flow aged 0
4760 Port 0 total aged flows: 0
4762 Creating indirect actions
4763 ~~~~~~~~~~~~~~~~~~~~~~~~~
4765 ``flow indirect_action {port_id} create`` creates indirect action with optional
4766 indirect action ID. It is bound to ``rte_flow_action_handle_create()``::
4768 flow indirect_action {port_id} create [action_id {indirect_action_id}]
4769 [ingress] [egress] [transfer] action {action} / end
4771 If successful, it will show::
4773 Indirect action #[...] created
4775 Otherwise, it will complain either that indirect action already exists or that
4776 some error occurred::
4778 Indirect action #[...] is already assigned, delete it first
4782 Caught error type [...] ([...]): [...]
4784 Create indirect rss action with id 100 to queues 1 and 2 on port 0::
4786 testpmd> flow indirect_action 0 create action_id 100 \
4787 ingress action rss queues 1 2 end / end
4789 Create indirect rss action with id assigned by testpmd to queues 1 and 2 on
4792 testpmd> flow indirect_action 0 create action_id \
4793 ingress action rss queues 0 1 end / end
4795 Enqueueing creation of indirect actions
4796 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4798 ``flow queue indirect_action create`` adds creation operation of an indirect
4799 action to a queue. It is bound to ``rte_flow_async_action_handle_create()``::
4801 flow queue {port_id} create {queue_id} [postpone {boolean}]
4802 table {table_id} item_template {item_template_id}
4803 action_template {action_template_id}
4804 pattern {item} [/ {item} [...]] / end
4805 actions {action} [/ {action} [...]] / end
4807 If successful, it will show::
4809 Indirect action #[...] creation queued
4811 Otherwise it will show an error message of the form::
4813 Caught error type [...] ([...]): [...]
4815 This command uses the same parameters as ``flow indirect_action create``,
4816 described in `Creating indirect actions`_.
4818 ``flow queue pull`` must be called to retrieve the operation status.
4820 Updating indirect actions
4821 ~~~~~~~~~~~~~~~~~~~~~~~~~
4823 ``flow indirect_action {port_id} update`` updates configuration of the indirect
4824 action from its indirect action ID (as returned by
4825 ``flow indirect_action {port_id} create``). It is bound to
4826 ``rte_flow_action_handle_update()``::
4828 flow indirect_action {port_id} update {indirect_action_id}
4829 action {action} / end
4831 If successful, it will show::
4833 Indirect action #[...] updated
4835 Otherwise, it will complain either that indirect action not found or that some
4838 Failed to find indirect action #[...] on port [...]
4842 Caught error type [...] ([...]): [...]
4844 Update indirect rss action having id 100 on port 0 with rss to queues 0 and 3
4845 (in create example above rss queues were 1 and 2)::
4847 testpmd> flow indirect_action 0 update 100 action rss queues 0 3 end / end
4849 Enqueueing update of indirect actions
4850 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4852 ``flow queue indirect_action update`` adds update operation for an indirect
4853 action to a queue. It is bound to ``rte_flow_async_action_handle_update()``::
4855 flow queue {port_id} indirect_action {queue_id} update
4856 {indirect_action_id} [postpone {boolean}] action {action} / end
4858 If successful, it will show::
4860 Indirect action #[...] update queued
4862 Otherwise it will show an error message of the form::
4864 Caught error type [...] ([...]): [...]
4866 ``flow queue pull`` must be called to retrieve the operation status.
4868 Destroying indirect actions
4869 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
4871 ``flow indirect_action {port_id} destroy`` destroys one or more indirect actions
4872 from their indirect action IDs (as returned by
4873 ``flow indirect_action {port_id} create``). It is bound to
4874 ``rte_flow_action_handle_destroy()``::
4876 flow indirect_action {port_id} destroy action_id {indirect_action_id} [...]
4878 If successful, it will show::
4880 Indirect action #[...] destroyed
4882 It does not report anything for indirect action IDs that do not exist.
4883 The usual error message is shown when a indirect action cannot be destroyed::
4885 Caught error type [...] ([...]): [...]
4887 Destroy indirect actions having id 100 & 101::
4889 testpmd> flow indirect_action 0 destroy action_id 100 action_id 101
4891 Enqueueing destruction of indirect actions
4892 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4894 ``flow queue indirect_action destroy`` adds destruction operation to destroy
4895 one or more indirect actions from their indirect action IDs (as returned by
4896 ``flow queue {port_id} indirect_action {queue_id} create``) to a queue.
4897 It is bound to ``rte_flow_async_action_handle_destroy()``::
4899 flow queue {port_id} indirect_action {queue_id} destroy
4900 [postpone {boolean}] action_id {indirect_action_id} [...]
4902 If successful, it will show::
4904 Indirect action #[...] destruction queued
4906 Otherwise it will show an error message of the form::
4908 Caught error type [...] ([...]): [...]
4910 ``flow queue pull`` must be called to retrieve the operation status.
4912 Query indirect actions
4913 ~~~~~~~~~~~~~~~~~~~~~~
4915 ``flow indirect_action {port_id} query`` queries the indirect action from its
4916 indirect action ID (as returned by ``flow indirect_action {port_id} create``).
4917 It is bound to ``rte_flow_action_handle_query()``::
4919 flow indirect_action {port_id} query {indirect_action_id}
4921 Currently only rss indirect action supported. If successful, it will show::
4923 Indirect RSS action:
4926 Otherwise, it will complain either that indirect action not found or that some
4929 Failed to find indirect action #[...] on port [...]
4933 Caught error type [...] ([...]): [...]
4935 Query indirect action having id 100::
4937 testpmd> flow indirect_action 0 query 100
4939 Sample QinQ flow rules
4940 ~~~~~~~~~~~~~~~~~~~~~~
4942 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4944 testpmd> port stop 0
4945 testpmd> vlan set extend on 0
4947 The above command sets the inner and outer TPID's to 0x8100.
4949 To change the TPID's the following commands should be used::
4951 testpmd> vlan set outer tpid 0x88A8 0
4952 testpmd> vlan set inner tpid 0x8100 0
4953 testpmd> port start 0
4955 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4959 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4960 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4961 Flow rule #0 validated
4963 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4964 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4965 Flow rule #0 created
4967 testpmd> flow list 0
4968 ID Group Prio Attr Rule
4969 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4971 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4975 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4976 vlan tci is 654 / end actions pf / queue index 0 / end
4977 Flow rule #1 validated
4979 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4980 vlan tci is 654 / end actions pf / queue index 1 / end
4981 Flow rule #1 created
4983 testpmd> flow list 0
4984 ID Group Prio Attr Rule
4985 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4986 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4988 Sample VXLAN flow rules
4989 ~~~~~~~~~~~~~~~~~~~~~~~
4991 Before creating VXLAN rule(s), the UDP port should be added for VXLAN packet
4994 testpmd> rx_vxlan_port add 4789 0
4996 Create VXLAN rules on port 0 to steer traffic to PF queues.
5000 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
5001 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 1 / end
5002 Flow rule #0 created
5004 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 3 /
5005 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 2 / end
5006 Flow rule #1 created
5008 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
5009 eth dst is 00:11:22:33:44:55 / vlan tci is 10 / end actions pf /
5011 Flow rule #2 created
5013 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 5 /
5014 eth dst is 00:11:22:33:44:55 / vlan tci is 20 / end actions pf /
5016 Flow rule #3 created
5018 testpmd> flow create 0 ingress pattern eth dst is 00:00:00:00:01:00 / ipv4 /
5019 udp / vxlan vni is 6 / eth dst is 00:11:22:33:44:55 / end actions pf /
5021 Flow rule #4 created
5023 testpmd> flow list 0
5024 ID Group Prio Attr Rule
5025 0 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
5026 1 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
5027 2 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
5028 3 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
5029 4 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
5031 Sample VXLAN encapsulation rule
5032 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5034 VXLAN encapsulation outer layer has default value pre-configured in testpmd
5035 source code, those can be changed by using the following commands
5037 IPv4 VXLAN outer header::
5039 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
5040 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5041 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5044 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
5045 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
5046 eth-dst 22:22:22:22:22:22
5047 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5050 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
5051 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
5052 eth-dst 22:22:22:22:22:22
5053 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5056 IPv6 VXLAN outer header::
5058 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
5059 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5060 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5063 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
5064 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
5065 eth-dst 22:22:22:22:22:22
5066 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5069 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
5070 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
5071 eth-dst 22:22:22:22:22:22
5072 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
5075 Sample NVGRE encapsulation rule
5076 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5078 NVGRE encapsulation outer layer has default value pre-configured in testpmd
5079 source code, those can be changed by using the following commands
5081 IPv4 NVGRE outer header::
5083 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
5084 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5085 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5088 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
5089 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
5090 eth-dst 22:22:22:22:22:22
5091 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5094 IPv6 NVGRE outer header::
5096 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
5097 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5098 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5101 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
5102 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5103 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5106 Sample L2 encapsulation rule
5107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5109 L2 encapsulation has default value pre-configured in testpmd
5110 source code, those can be changed by using the following commands
5114 testpmd> set l2_encap ip-version ipv4
5115 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5116 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5117 mplsoudp_decap / l2_encap / end
5119 L2 with VXLAN header::
5121 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
5122 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5123 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5124 mplsoudp_decap / l2_encap / end
5126 Sample L2 decapsulation rule
5127 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5129 L2 decapsulation has default value pre-configured in testpmd
5130 source code, those can be changed by using the following commands
5134 testpmd> set l2_decap
5135 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
5138 L2 with VXLAN header::
5140 testpmd> set l2_encap-with-vlan
5141 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
5144 Sample MPLSoGRE encapsulation rule
5145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5147 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
5148 source code, those can be changed by using the following commands
5150 IPv4 MPLSoGRE outer header::
5152 testpmd> set mplsogre_encap ip-version ipv4 label 4
5153 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
5154 eth-dst 22:22:22:22:22:22
5155 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5156 mplsogre_encap / end
5158 IPv4 MPLSoGRE with VLAN outer header::
5160 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
5161 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
5162 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5163 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5164 mplsogre_encap / end
5166 IPv6 MPLSoGRE outer header::
5168 testpmd> set mplsogre_encap ip-version ipv6 mask 4
5169 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
5170 eth-dst 22:22:22:22:22:22
5171 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5172 mplsogre_encap / end
5174 IPv6 MPLSoGRE with VLAN outer header::
5176 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
5177 ip-src ::1 ip-dst ::2222 vlan-tci 34
5178 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5179 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5180 mplsogre_encap / end
5182 Sample MPLSoGRE decapsulation rule
5183 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5185 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
5186 source code, those can be changed by using the following commands
5188 IPv4 MPLSoGRE outer header::
5190 testpmd> set mplsogre_decap ip-version ipv4
5191 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
5192 mplsogre_decap / l2_encap / end
5194 IPv4 MPLSoGRE with VLAN outer header::
5196 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
5197 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
5198 actions mplsogre_decap / l2_encap / end
5200 IPv6 MPLSoGRE outer header::
5202 testpmd> set mplsogre_decap ip-version ipv6
5203 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
5204 actions mplsogre_decap / l2_encap / end
5206 IPv6 MPLSoGRE with VLAN outer header::
5208 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
5209 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
5210 actions mplsogre_decap / l2_encap / end
5212 Sample MPLSoUDP encapsulation rule
5213 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5215 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
5216 source code, those can be changed by using the following commands
5218 IPv4 MPLSoUDP outer header::
5220 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
5221 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
5222 eth-dst 22:22:22:22:22:22
5223 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5224 mplsoudp_encap / end
5226 IPv4 MPLSoUDP with VLAN outer header::
5228 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
5229 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
5230 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5231 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5232 mplsoudp_encap / end
5234 IPv6 MPLSoUDP outer header::
5236 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
5237 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
5238 eth-dst 22:22:22:22:22:22
5239 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5240 mplsoudp_encap / end
5242 IPv6 MPLSoUDP with VLAN outer header::
5244 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
5245 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
5246 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5247 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5248 mplsoudp_encap / end
5250 Sample MPLSoUDP decapsulation rule
5251 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5253 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
5254 source code, those can be changed by using the following commands
5256 IPv4 MPLSoUDP outer header::
5258 testpmd> set mplsoudp_decap ip-version ipv4
5259 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5260 mplsoudp_decap / l2_encap / end
5262 IPv4 MPLSoUDP with VLAN outer header::
5264 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
5265 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
5266 actions mplsoudp_decap / l2_encap / end
5268 IPv6 MPLSoUDP outer header::
5270 testpmd> set mplsoudp_decap ip-version ipv6
5271 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
5272 actions mplsoudp_decap / l2_encap / end
5274 IPv6 MPLSoUDP with VLAN outer header::
5276 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
5277 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
5278 actions mplsoudp_decap / l2_encap / end
5280 Sample Raw encapsulation rule
5281 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5283 Raw encapsulation configuration can be set by the following commands
5285 Encapsulating VxLAN::
5287 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
5288 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
5290 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
5291 raw_encap index 4 / end
5293 Sample Raw decapsulation rule
5294 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5296 Raw decapsulation configuration can be set by the following commands
5298 Decapsulating VxLAN::
5300 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
5301 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
5302 end actions raw_decap / queue index 0 / end
5307 ESP rules can be created by the following commands::
5309 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
5311 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
5312 actions queue index 3 / end
5313 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
5315 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
5316 actions queue index 3 / end
5321 AH rules can be created by the following commands::
5323 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
5325 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
5326 actions queue index 3 / end
5327 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
5329 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
5330 actions queue index 3 / end
5335 PFCP rules can be created by the following commands(s_field need to be 1
5338 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
5339 actions queue index 3 / end
5340 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
5341 seid is 1 / end actions queue index 3 / end
5342 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
5343 actions queue index 3 / end
5344 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
5345 seid is 1 / end actions queue index 3 / end
5347 Sample Sampling/Mirroring rules
5348 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5350 Sample/Mirroring rules can be set by the following commands
5352 NIC-RX Sampling rule, the matched ingress packets and sent to the queue 1,
5353 and 50% packets are duplicated and marked with 0x1234 and sent to queue 0.
5357 testpmd> set sample_actions 0 mark id 0x1234 / queue index 0 / end
5358 testpmd> flow create 0 ingress group 1 pattern eth / end actions
5359 sample ratio 2 index 0 / queue index 1 / end
5361 Mirroring rule with port representors (with "transfer" attribute), the matched
5362 ingress packets with encapsulation header are sent to port id 0, and also
5363 mirrored the packets and sent to port id 2.
5367 testpmd> set sample_actions 0 port_id id 2 / end
5368 testpmd> flow create 1 ingress transfer pattern eth / end actions
5369 sample ratio 1 index 0 / raw_encap / port_id id 0 / end
5371 Mirroring rule with port representors (with "transfer" attribute), the matched
5372 ingress packets are sent to port id 2, and also mirrored the packets with
5373 encapsulation header and sent to port id 0.
5377 testpmd> set sample_actions 0 raw_encap / port_id id 0 / end
5378 testpmd> flow create 0 ingress transfer pattern eth / end actions
5379 sample ratio 1 index 0 / port_id id 2 / end
5381 Mirroring rule with port representors (with "transfer" attribute), the matched
5382 ingress packets are sent to port id 2, and also mirrored the packets with
5383 VXLAN encapsulation header and sent to port id 0.
5387 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
5388 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5389 testpmd> set sample_actions 0 vxlan_encap / port_id id 0 / end
5390 testpmd> flow create 0 ingress transfer pattern eth / end actions
5391 sample ratio 1 index 0 / port_id id 2 / end
5393 Mirroring rule with port representors (with "transfer" attribute), the matched
5394 ingress packets are sent to port id 2, and also mirrored the packets with
5395 NVGRE encapsulation header and sent to port id 0.
5399 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
5400 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5401 testpmd> set sample_actions 0 nvgre_encap / port_id id 0 / end
5402 testpmd> flow create 0 ingress transfer pattern eth / end actions
5403 sample ratio 1 index 0 / port_id id 2 / end
5405 Sample integrity rules
5406 ~~~~~~~~~~~~~~~~~~~~~~
5408 Integrity rules can be created by the following commands:
5410 Integrity rule that forwards valid TCP packets to group 1.
5411 TCP packet integrity is matched with the ``l4_ok`` bit 3.
5415 testpmd> flow create 0 ingress
5416 pattern eth / ipv4 / tcp / integrity value mask 8 value spec 8 / end
5417 actions jump group 1 / end
5419 Integrity rule that forwards invalid packets to application.
5420 General packet integrity is matched with the ``packet_ok`` bit 0.
5424 testpmd> flow create 0 ingress pattern integrity value mask 1 value spec 0 / end actions queue index 0 / end
5426 Sample conntrack rules
5427 ~~~~~~~~~~~~~~~~~~~~~~
5429 Conntrack rules can be set by the following commands
5431 Need to construct the connection context with provided information.
5432 In the first table, create a flow rule by using conntrack action and jump to
5433 the next table. In the next table, create a rule to check the state.
5437 testpmd> set conntrack com peer 1 is_orig 1 enable 1 live 1 sack 1 cack 0
5438 last_dir 0 liberal 0 state 1 max_ack_win 7 r_lim 5 last_win 510
5439 last_seq 2632987379 last_ack 2532480967 last_end 2632987379
5441 testpmd> set conntrack orig scale 7 fin 0 acked 1 unack_data 0
5442 sent_end 2632987379 reply_end 2633016339 max_win 28960
5444 testpmd> set conntrack rply scale 7 fin 0 acked 1 unack_data 0
5445 sent_end 2532480967 reply_end 2532546247 max_win 65280
5447 testpmd> flow indirect_action 0 create ingress action conntrack / end
5448 testpmd> flow create 0 group 3 ingress pattern eth / ipv4 / tcp / end actions indirect 0 / jump group 5 / end
5449 testpmd> flow create 0 group 5 ingress pattern eth / ipv4 / tcp / conntrack is 1 / end actions queue index 5 / end
5451 Construct the conntrack again with only "is_orig" set to 0 (other fields are
5452 ignored), then use "update" interface to update the direction. Create flow
5453 rules like above for the peer port.
5457 testpmd> flow indirect_action 0 update 0 action conntrack_update dir / end
5459 Sample meter with policy rules
5460 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5462 Meter with policy rules can be created by the following commands:
5464 Need to create policy first and actions are set for green/yellow/red colors.
5465 Create meter with policy id. Create flow with meter id.
5467 Example for policy with meter color action. The purpose is to color the packet
5468 to reflect the meter color result.
5469 The meter policy action list: ``green -> green, yellow -> yellow, red -> red``.
5473 testpmd> add port meter profile srtcm_rfc2697 0 13 21504 2688 0 0
5474 testpmd> add port meter policy 0 1 g_actions color type green / end y_actions color type yellow / end
5475 r_actions color type red / end
5476 testpmd> create port meter 0 1 13 1 yes 0xffff 0 0
5477 testpmd> flow create 0 priority 0 ingress group 1 pattern eth / end actions meter mtr_id 1 / end
5479 Sample L2TPv2 RSS rules
5480 ~~~~~~~~~~~~~~~~~~~~~~~
5482 L2TPv2 RSS rules can be created by the following commands::
5484 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 type control
5485 / end actions rss types l2tpv2 end queues end / end
5486 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / end
5487 actions rss types eth l2-src-only end queues end / end
5488 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / end
5489 actions rss types l2tpv2 end queues end / end
5490 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4
5491 / end actions rss types ipv4 end queues end / end
5492 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv6
5493 / udp / end actions rss types ipv6-udp end queues end / end
5494 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv4
5495 / tcp / end actions rss types ipv4-tcp end queues end / end
5496 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv6
5497 / end actions rss types ipv6 end queues end / end
5499 Sample L2TPv2 FDIR rules
5500 ~~~~~~~~~~~~~~~~~~~~~~~~
5502 L2TPv2 FDIR rules can be created by the following commands::
5504 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 type control
5505 session_id is 0x1111 / end actions queue index 3 / end
5506 testpmd> flow create 0 ingress pattern eth src is 00:00:00:00:00:01 / ipv4
5507 / udp / l2tpv2 type data / end actions queue index 3 / end
5508 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 type data
5509 session_id is 0x1111 / ppp / end actions queue index 3 / end
5510 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4
5511 src is 10.0.0.1 / end actions queue index 3 / end
5512 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv6
5513 dst is ABAB:910B:6666:3457:8295:3333:1800:2929 / end actions queue index 3 / end
5514 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4
5515 / udp src is 22 / end actions queue index 3 / end
5516 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4
5517 / tcp dst is 23 / end actions queue index 3 / end
5522 A RAW rule can be created as following using ``pattern_hex`` key and mask.
5526 testpmd> flow create 0 group 0 priority 1 ingress pattern raw relative is 0 search is 0 offset
5527 is 0 limit is 0 pattern_hex spec 00000000000000000000000000000000000000000000000000000a0a0a0a
5528 pattern_hex mask 0000000000000000000000000000000000000000000000000000ffffffff / end actions
5534 The following sections show functions to load/unload eBPF based filters.
5539 Load an eBPF program as a callback for particular RX/TX queue::
5541 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
5543 The available load-flags are:
5545 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
5547 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
5553 You'll need clang v3.7 or above to build bpf program you'd like to load
5557 .. code-block:: console
5560 clang -O2 -target bpf -c t1.c
5562 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
5564 .. code-block:: console
5566 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
5568 To load (not JITed) t1.o at TX queue 0, port 0:
5570 .. code-block:: console
5572 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
5577 Unload previously loaded eBPF program for particular RX/TX queue::
5579 testpmd> bpf-unload rx|tx (portid) (queueid)
5581 For example to unload BPF filter from TX queue 0, port 0:
5583 .. code-block:: console
5585 testpmd> bpf-unload tx 0 0
5590 The following sections show functions that configure and create flex item object,
5591 create flex pattern and use it in a flow rule.
5592 The commands will use 20 bytes IPv4 header for examples:
5597 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
5598 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5599 | ver | IHL | TOS | length | +0
5600 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5601 | identification | flg | frag. offset | +4
5602 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5603 | TTL | protocol | checksum | +8
5604 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5605 | source IP address | +12
5606 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5607 | destination IP address | +16
5608 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5614 Flex item object is created by PMD according to a new header configuration. The
5615 header configuration is compiled by the testpmd and stored in
5616 ``rte_flow_item_flex_conf`` type variable.
5620 # flow flex_item create <port> <flex id> <configuration file>
5621 testpmd> flow flex_item init 0 3 ipv4_flex_config.json
5622 port-0: created flex item #3
5624 Flex item configuration is kept in external JSON file.
5625 It describes the following header elements:
5627 **New header length.**
5629 Specify whether the new header has fixed or variable length and the basic/minimal
5630 header length value.
5632 If header length is not fixed, header location with a value that completes header
5633 length calculation and scale/offset function must be added.
5635 Scale function depends on port hardware.
5639 Describes location in the new header that specify following network header type.
5641 **Flow match samples.**
5643 Describes locations in the new header that will be used in flow rules.
5645 Number of flow samples and sample maximal length depend of port hardware.
5649 Describes preceding network header configuration.
5653 Describes conditions that trigger transfer to following network header
5655 .. code-block:: json
5658 "next_header": { "field_mode": "FIELD_MODE_FIXED", "field_size": 20},
5659 "next_protocol": {"field_size": 8, "field_base": 72},
5661 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 0},
5662 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 32},
5663 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 64},
5664 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 96}
5667 {"item": "eth type is 0x0800"},
5668 {"item": "vlan inner_type is 0x0800"}
5671 {"item": "udp", "next": 17},
5672 {"item": "tcp", "next": 6},
5673 {"item": "icmp", "next": 1}
5678 Flex pattern and flow rules
5679 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
5681 Flex pattern describe parts of network header that will trigger flex flow item hit in a flow rule.
5682 Flex pattern directly related to flex item samples configuration.
5683 Flex pattern can be shared between ports.
5685 **Flex pattern and flow rule to match IPv4 version and 20 bytes length**
5689 # set flex_pattern <pattern_id> is <hex bytes sequence>
5690 testpmd> flow flex_item pattern 5 is 45FF
5693 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / flex item is 3 pattern is 5 / end actions mark id 1 / queue index 0 / end
5694 Flow rule #0 created
5696 **Flex pattern and flow rule to match packets with source address 1.2.3.4**
5700 testpmd> flow flex_item pattern 2 spec 45000000000000000000000001020304 mask FF0000000000000000000000FFFFFFFF
5703 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / flex item is 3 pattern is 2 / end actions mark id 1 / queue index 0 / end
5704 Flow rule #0 created