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 statistics mapping (qmapping 0..15) for RX/TX queue on port::
1569 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1571 For example, to set rx queue 2 on port 0 to mapping 5::
1573 testpmd>set stat_qmap rx 0 2 5
1575 set xstats-hide-zero
1576 ~~~~~~~~~~~~~~~~~~~~
1578 Set the option to hide zero values for xstats display::
1580 testpmd> set xstats-hide-zero on|off
1584 By default, the zero values are displayed for xstats.
1586 set port - rx/tx (for VF)
1587 ~~~~~~~~~~~~~~~~~~~~~~~~~
1589 Set VF receive/transmit from a port::
1591 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1593 set port - rx mode(for VF)
1594 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1596 Set the VF receive mode of a port::
1598 testpmd> set port (port_id) vf (vf_id) \
1599 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1601 The available receive modes are:
1603 * ``AUPE``: Accepts untagged VLAN.
1605 * ``ROPE``: Accepts unicast hash.
1607 * ``BAM``: Accepts broadcast packets.
1609 * ``MPE``: Accepts all multicast packets.
1611 set port - tx_rate (for Queue)
1612 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1614 Set TX rate limitation for a queue on a port::
1616 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1618 set port - tx_rate (for VF)
1619 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1621 Set TX rate limitation for queues in VF on a port::
1623 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1628 Set the flush on RX streams before forwarding.
1629 The default is flush ``on``.
1630 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1632 testpmd> set flush_rx off
1637 Set the bypass mode for the lowest port on bypass enabled NIC::
1639 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1644 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1646 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1647 mode (normal|bypass|isolate) (port_id)
1651 * ``timeout``: Enable bypass after watchdog timeout.
1653 * ``os_on``: Enable bypass when OS/board is powered on.
1655 * ``os_off``: Enable bypass when OS/board is powered off.
1657 * ``power_on``: Enable bypass when power supply is turned on.
1659 * ``power_off``: Enable bypass when power supply is turned off.
1665 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1667 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1672 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1674 testpmd> show bypass config (port_id)
1679 Set link up for a port::
1681 testpmd> set link-up port (port id)
1686 Set link down for a port::
1688 testpmd> set link-down port (port id)
1693 Enable E-tag insertion for a VF on a port::
1695 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1697 Disable E-tag insertion for a VF on a port::
1699 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1701 Enable/disable E-tag stripping on a port::
1703 testpmd> E-tag set stripping (on|off) port (port_id)
1705 Enable/disable E-tag based forwarding on a port::
1707 testpmd> E-tag set forwarding (on|off) port (port_id)
1712 Load a dynamic device personalization (DDP) profile and store backup profile::
1714 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1719 Delete a dynamic device personalization profile and restore backup profile::
1721 testpmd> ddp del (port_id) (backup_profile_path)
1726 List all items from the ptype mapping table::
1728 testpmd> ptype mapping get (port_id) (valid_only)
1732 * ``valid_only``: A flag indicates if only list valid items(=1) or all items(=0).
1734 Replace a specific or a group of software defined ptype with a new one::
1736 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1740 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1742 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1744 * ``pkt_type``: The new software ptype to replace the old ones.
1746 Update hardware defined ptype to software defined packet type mapping table::
1748 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1752 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1754 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1756 Reset ptype mapping table::
1758 testpmd> ptype mapping reset (port_id)
1760 config per port Rx offloading
1761 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1763 Enable or disable a per port Rx offloading on all Rx queues of a port::
1765 testpmd> port config (port_id) rx_offload (offloading) on|off
1767 * ``offloading``: can be any of these offloading capability:
1768 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1769 qinq_strip, outer_ipv4_cksum, macsec_strip,
1770 header_split, vlan_filter, vlan_extend, jumbo_frame,
1771 scatter, timestamp, security, keep_crc, rss_hash
1773 This command should be run when the port is stopped, or else it will fail.
1775 config per queue Rx offloading
1776 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1778 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1780 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1782 * ``offloading``: can be any of these offloading capability:
1783 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1784 qinq_strip, outer_ipv4_cksum, macsec_strip,
1785 header_split, vlan_filter, vlan_extend, jumbo_frame,
1786 scatter, timestamp, security, keep_crc
1788 This command should be run when the port is stopped, or else it will fail.
1790 config per port Tx offloading
1791 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1793 Enable or disable a per port Tx offloading on all Tx queues of a port::
1795 testpmd> port config (port_id) tx_offload (offloading) on|off
1797 * ``offloading``: can be any of these offloading capability:
1798 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1799 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1800 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1801 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1802 mt_lockfree, multi_segs, mbuf_fast_free, security
1804 This command should be run when the port is stopped, or else it will fail.
1806 config per queue Tx offloading
1807 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1809 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1811 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1813 * ``offloading``: can be any of these offloading capability:
1814 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1815 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1816 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1817 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1818 mt_lockfree, multi_segs, mbuf_fast_free, security
1820 This command should be run when the port is stopped, or else it will fail.
1822 Config VXLAN Encap outer layers
1823 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1825 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1827 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1828 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1831 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1832 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1833 eth-src (eth-src) eth-dst (eth-dst)
1835 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1836 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1837 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1839 These commands will set an internal configuration inside testpmd, any following
1840 flow rule using the action vxlan_encap will use the last configuration set.
1841 To have a different encapsulation header, one of those commands must be called
1842 before the flow rule creation.
1844 Config NVGRE Encap outer layers
1845 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1847 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1849 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1850 eth-src (eth-src) eth-dst (eth-dst)
1851 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1852 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1854 These commands will set an internal configuration inside testpmd, any following
1855 flow rule using the action nvgre_encap will use the last configuration set.
1856 To have a different encapsulation header, one of those commands must be called
1857 before the flow rule creation.
1862 Configure the l2 to be used when encapsulating a packet with L2::
1864 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1865 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1866 eth-src (eth-src) eth-dst (eth-dst)
1868 Those commands will set an internal configuration inside testpmd, any following
1869 flow rule using the action l2_encap will use the last configuration set.
1870 To have a different encapsulation header, one of those commands must be called
1871 before the flow rule creation.
1876 Configure the l2 to be removed when decapsulating a packet with L2::
1878 set l2_decap ip-version (ipv4|ipv6)
1879 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1881 Those commands will set an internal configuration inside testpmd, any following
1882 flow rule using the action l2_decap will use the last configuration set.
1883 To have a different encapsulation header, one of those commands must be called
1884 before the flow rule creation.
1886 Config MPLSoGRE Encap outer layers
1887 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1889 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1891 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1892 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1893 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1894 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1895 eth-src (eth-src) eth-dst (eth-dst)
1897 These commands will set an internal configuration inside testpmd, any following
1898 flow rule using the action mplsogre_encap will use the last configuration set.
1899 To have a different encapsulation header, one of those commands must be called
1900 before the flow rule creation.
1902 Config MPLSoGRE Decap outer layers
1903 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1905 Configure the outer layer to decapsulate MPLSoGRE packet::
1907 set mplsogre_decap ip-version (ipv4|ipv6)
1908 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1910 These commands will set an internal configuration inside testpmd, any following
1911 flow rule using the action mplsogre_decap will use the last configuration set.
1912 To have a different decapsulation header, one of those commands must be called
1913 before the flow rule creation.
1915 Config MPLSoUDP Encap outer layers
1916 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1918 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1920 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1921 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1922 eth-src (eth-src) eth-dst (eth-dst)
1923 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1924 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1925 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1927 These commands will set an internal configuration inside testpmd, any following
1928 flow rule using the action mplsoudp_encap will use the last configuration set.
1929 To have a different encapsulation header, one of those commands must be called
1930 before the flow rule creation.
1932 Config MPLSoUDP Decap outer layers
1933 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1935 Configure the outer layer to decapsulate MPLSoUDP packet::
1937 set mplsoudp_decap ip-version (ipv4|ipv6)
1938 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1940 These commands will set an internal configuration inside testpmd, any following
1941 flow rule using the action mplsoudp_decap will use the last configuration set.
1942 To have a different decapsulation header, one of those commands must be called
1943 before the flow rule creation.
1945 Config Raw Encapsulation
1946 ~~~~~~~~~~~~~~~~~~~~~~~~~
1948 Configure the raw data to be used when encapsulating a packet by
1949 rte_flow_action_raw_encap::
1951 set raw_encap {index} {item} [/ {item} [...]] / end_set
1953 There are multiple global buffers for ``raw_encap``, this command will set one
1954 internal buffer index by ``{index}``.
1955 If there is no ``{index}`` specified::
1957 set raw_encap {item} [/ {item} [...]] / end_set
1959 the default index ``0`` is used.
1960 In order to use different encapsulating header, ``index`` must be specified
1961 during the flow rule creation::
1963 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1964 raw_encap index 2 / end
1966 Otherwise the default index ``0`` is used.
1968 Config Raw Decapsulation
1969 ~~~~~~~~~~~~~~~~~~~~~~~~
1971 Configure the raw data to be used when decapsulating a packet by
1972 rte_flow_action_raw_decap::
1974 set raw_decap {index} {item} [/ {item} [...]] / end_set
1976 There are multiple global buffers for ``raw_decap``, this command will set
1977 one internal buffer index by ``{index}``.
1978 If there is no ``{index}`` specified::
1980 set raw_decap {item} [/ {item} [...]] / end_set
1982 the default index ``0`` is used.
1983 In order to use different decapsulating 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 3 / end
1989 Otherwise the default index ``0`` is used.
1994 Set fec mode for a specific port::
1996 testpmd> set port (port_id) fec_mode auto|off|rs|baser
1998 Config Sample actions list
1999 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2001 Configure the sample actions list to be used when sampling a packet by
2002 rte_flow_action_sample::
2004 set sample_actions {index} {action} [/ {action} [...]] / end
2006 There are multiple global buffers for ``sample_actions``, this command will set
2007 one internal buffer index by ``{index}``.
2009 In order to use different sample actions list, ``index`` must be specified
2010 during the flow rule creation::
2012 testpmd> flow create 0 ingress pattern eth / ipv4 / end actions
2013 sample ratio 2 index 2 / end
2015 Otherwise the default index ``0`` is used.
2020 The following sections show functions for configuring ports.
2024 Port configuration changes only become active when forwarding is started/restarted.
2029 Attach a port specified by pci address or virtual device args::
2031 testpmd> port attach (identifier)
2033 To attach a new pci device, the device should be recognized by kernel first.
2034 Then it should be moved under DPDK management.
2035 Finally the port can be attached to testpmd.
2037 For example, to move a pci device using ixgbe under DPDK management:
2039 .. code-block:: console
2041 # Check the status of the available devices.
2042 ./usertools/dpdk-devbind.py --status
2044 Network devices using DPDK-compatible driver
2045 ============================================
2048 Network devices using kernel driver
2049 ===================================
2050 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
2053 # Bind the device to igb_uio.
2054 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
2057 # Recheck the status of the devices.
2058 ./usertools/dpdk-devbind.py --status
2059 Network devices using DPDK-compatible driver
2060 ============================================
2061 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
2063 To attach a port created by virtual device, above steps are not needed.
2065 For example, to attach a port whose pci address is 0000:0a:00.0.
2067 .. code-block:: console
2069 testpmd> port attach 0000:0a:00.0
2070 Attaching a new port...
2071 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2072 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
2073 EAL: PCI memory mapped at 0x7f83bfa00000
2074 EAL: PCI memory mapped at 0x7f83bfa80000
2075 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
2076 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
2077 Port 0 is attached. Now total ports is 1
2080 For example, to attach a port created by pcap PMD.
2082 .. code-block:: console
2084 testpmd> port attach net_pcap0
2085 Attaching a new port...
2086 PMD: Initializing pmd_pcap for net_pcap0
2087 PMD: Creating pcap-backed ethdev on numa socket 0
2088 Port 0 is attached. Now total ports is 1
2091 In this case, identifier is ``net_pcap0``.
2092 This identifier format is the same as ``--vdev`` format of DPDK applications.
2094 For example, to re-attach a bonded port which has been previously detached,
2095 the mode and slave parameters must be given.
2097 .. code-block:: console
2099 testpmd> port attach net_bond_0,mode=0,slave=1
2100 Attaching a new port...
2101 EAL: Initializing pmd_bond for net_bond_0
2102 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2103 Port 0 is attached. Now total ports is 1
2110 Detach a specific port::
2112 testpmd> port detach (port_id)
2114 Before detaching a port, the port should be stopped and closed.
2116 For example, to detach a pci device port 0.
2118 .. code-block:: console
2120 testpmd> port stop 0
2123 testpmd> port close 0
2127 testpmd> port detach 0
2129 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2130 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2131 EAL: PCI memory unmapped at 0x7f83bfa00000
2132 EAL: PCI memory unmapped at 0x7f83bfa80000
2136 For example, to detach a virtual device port 0.
2138 .. code-block:: console
2140 testpmd> port stop 0
2143 testpmd> port close 0
2147 testpmd> port detach 0
2149 PMD: Closing pcap ethdev on numa socket 0
2150 Port 'net_pcap0' is detached. Now total ports is 0
2153 To remove a pci device completely from the system, first detach the port from testpmd.
2154 Then the device should be moved under kernel management.
2155 Finally the device can be removed using kernel pci hotplug functionality.
2157 For example, to move a pci device under kernel management:
2159 .. code-block:: console
2161 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2163 ./usertools/dpdk-devbind.py --status
2165 Network devices using DPDK-compatible driver
2166 ============================================
2169 Network devices using kernel driver
2170 ===================================
2171 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2173 To remove a port created by a virtual device, above steps are not needed.
2178 Start all ports or a specific port::
2180 testpmd> port start (port_id|all)
2185 Stop all ports or a specific port::
2187 testpmd> port stop (port_id|all)
2192 Close all ports or a specific port::
2194 testpmd> port close (port_id|all)
2199 Reset all ports or a specific port::
2201 testpmd> port reset (port_id|all)
2203 User should stop port(s) before resetting and (re-)start after reset.
2205 port config - queue ring size
2206 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2208 Configure a rx/tx queue ring size::
2210 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2212 Only take effect after command that (re-)start the port or command that setup specific queue.
2214 port start/stop queue
2215 ~~~~~~~~~~~~~~~~~~~~~
2217 Start/stop a rx/tx queue on a specific port::
2219 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2221 port config - queue deferred start
2222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2224 Switch on/off deferred start of a specific port queue::
2226 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2229 ~~~~~~~~~~~~~~~~~~~~~
2231 Setup a rx/tx queue on a specific port::
2233 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2235 Only take effect when port is started.
2240 Set the speed and duplex mode for all ports or a specific port::
2242 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \
2243 duplex (half|full|auto)
2245 port config - queues/descriptors
2246 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2248 Set number of queues/descriptors for rxq, txq, rxd and txd::
2250 testpmd> port config all (rxq|txq|rxd|txd) (value)
2252 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2254 port config - max-pkt-len
2255 ~~~~~~~~~~~~~~~~~~~~~~~~~
2257 Set the maximum packet length::
2259 testpmd> port config all max-pkt-len (value)
2261 This is equivalent to the ``--max-pkt-len`` command-line option.
2263 port config - max-lro-pkt-size
2264 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2266 Set the maximum LRO aggregated packet size::
2268 testpmd> port config all max-lro-pkt-size (value)
2270 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2272 port config - Drop Packets
2273 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2275 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2277 testpmd> port config all drop-en (on|off)
2279 Packet dropping when no receive buffers available is off by default.
2281 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2286 Set the RSS (Receive Side Scaling) mode on or off::
2288 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|none)
2290 RSS is on by default.
2292 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp.
2294 The ``default`` option enables all supported RSS types reported by device info.
2296 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2298 port config - RSS Reta
2299 ~~~~~~~~~~~~~~~~~~~~~~
2301 Set the RSS (Receive Side Scaling) redirection table::
2303 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2308 Set the DCB mode for an individual port::
2310 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2312 The traffic class should be 4 or 8.
2317 Set the number of packets per burst::
2319 testpmd> port config all burst (value)
2321 This is equivalent to the ``--burst`` command-line option.
2323 port config - Threshold
2324 ~~~~~~~~~~~~~~~~~~~~~~~
2326 Set thresholds for TX/RX queues::
2328 testpmd> port config all (threshold) (value)
2330 Where the threshold type can be:
2332 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2334 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2336 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2338 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2340 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2342 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2344 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2346 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2348 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2350 These threshold options are also available from the command-line.
2352 port config pctype mapping
2353 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2355 Reset pctype mapping table::
2357 testpmd> port config (port_id) pctype mapping reset
2359 Update hardware defined pctype to software defined flow type mapping table::
2361 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2365 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2367 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2369 port config input set
2370 ~~~~~~~~~~~~~~~~~~~~~
2372 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2374 testpmd> port config (port_id) pctype (pctype_id) \
2375 (hash_inset|fdir_inset|fdir_flx_inset) \
2376 (get|set|clear) field (field_idx)
2378 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2380 testpmd> port config (port_id) pctype (pctype_id) \
2381 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2385 * ``pctype_id``: hardware packet classification types.
2386 * ``field_idx``: hardware field index.
2388 port config udp_tunnel_port
2389 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2391 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2393 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe|ecpri (udp_port)
2395 port config tx_metadata
2396 ~~~~~~~~~~~~~~~~~~~~~~~
2398 Set Tx metadata value per port.
2399 testpmd will add this value to any Tx packet sent from this port::
2401 testpmd> port config (port_id) tx_metadata (value)
2406 Set/clear dynamic flag per port.
2407 testpmd will register this flag in the mbuf (same registration
2408 for both Tx and Rx). Then set/clear this flag for each Tx
2409 packet sent from this port. The set bit only works for Tx packet::
2411 testpmd> port config (port_id) dynf (name) (set|clear)
2416 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2418 testpmd> port config mtu (port_id) (value)
2420 port config rss hash key
2421 ~~~~~~~~~~~~~~~~~~~~~~~~
2423 To configure the RSS hash key used to compute the RSS
2424 hash of input [IP] packets received on port::
2426 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2427 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2428 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2429 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2430 ipv6-udp-ex <string of hex digits \
2431 (variable length, NIC dependent)>)
2433 port cleanup txq mbufs
2434 ~~~~~~~~~~~~~~~~~~~~~~
2436 To cleanup txq mbufs currently cached by driver::
2438 testpmd> port cleanup (port_id) txq (queue_id) (free_cnt)
2440 If the value of ``free_cnt`` is 0, driver should free all cached mbufs.
2445 The following sections show functions for device operations.
2450 Detach a device specified by pci address or virtual device args::
2452 testpmd> device detach (identifier)
2454 Before detaching a device associated with ports, the ports should be stopped and closed.
2456 For example, to detach a pci device whose address is 0002:03:00.0.
2458 .. code-block:: console
2460 testpmd> device detach 0002:03:00.0
2461 Removing a device...
2462 Port 1 is now closed
2463 EAL: Releasing pci mapped resource for 0002:03:00.0
2464 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2465 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2466 Device 0002:03:00.0 is detached
2467 Now total ports is 1
2469 For example, to detach a port created by pcap PMD.
2471 .. code-block:: console
2473 testpmd> device detach net_pcap0
2474 Removing a device...
2475 Port 0 is now closed
2476 Device net_pcap0 is detached
2477 Now total ports is 0
2480 In this case, identifier is ``net_pcap0``.
2481 This identifier format is the same as ``--vdev`` format of DPDK applications.
2483 Link Bonding Functions
2484 ----------------------
2486 The Link Bonding functions make it possible to dynamically create and
2487 manage link bonding devices from within testpmd interactive prompt.
2489 create bonded device
2490 ~~~~~~~~~~~~~~~~~~~~
2492 Create a new bonding device::
2494 testpmd> create bonded device (mode) (socket)
2496 For example, to create a bonded device in mode 1 on socket 0::
2498 testpmd> create bonded device 1 0
2499 created new bonded device (port X)
2504 Adds Ethernet device to a Link Bonding device::
2506 testpmd> add bonding slave (slave id) (port id)
2508 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2510 testpmd> add bonding slave 6 10
2513 remove bonding slave
2514 ~~~~~~~~~~~~~~~~~~~~
2516 Removes an Ethernet slave device from a Link Bonding device::
2518 testpmd> remove bonding slave (slave id) (port id)
2520 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2522 testpmd> remove bonding slave 6 10
2527 Set the Link Bonding mode of a Link Bonding device::
2529 testpmd> set bonding mode (value) (port id)
2531 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2533 testpmd> set bonding mode 3 10
2538 Set an Ethernet slave device as the primary device on a Link Bonding device::
2540 testpmd> set bonding primary (slave id) (port id)
2542 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2544 testpmd> set bonding primary 6 10
2549 Set the MAC address of a Link Bonding device::
2551 testpmd> set bonding mac (port id) (mac)
2553 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2555 testpmd> set bonding mac 10 00:00:00:00:00:01
2557 set bonding balance_xmit_policy
2558 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2560 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2562 testpmd> set bonding balance_xmit_policy (port_id) (l2|l23|l34)
2564 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2566 testpmd> set bonding balance_xmit_policy 10 l34
2569 set bonding mon_period
2570 ~~~~~~~~~~~~~~~~~~~~~~
2572 Set the link status monitoring polling period in milliseconds for a bonding device.
2574 This adds support for PMD slave devices which do not support link status interrupts.
2575 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2576 link status ISR will be queried every polling interval to check if their link status has changed::
2578 testpmd> set bonding mon_period (port_id) (value)
2580 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2582 testpmd> set bonding mon_period 5 150
2585 set bonding lacp dedicated_queue
2586 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2588 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2589 when in mode 4 (link-aggregation-802.3ad)::
2591 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2594 set bonding agg_mode
2595 ~~~~~~~~~~~~~~~~~~~~
2597 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2599 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2605 Show the current configuration of a Link Bonding device::
2607 testpmd> show bonding config (port id)
2610 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2611 in balance mode with a transmission policy of layer 2+3::
2613 testpmd> show bonding config 9
2615 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2617 Active Slaves (3): [1 3 4]
2620 show bonding lacp info
2621 ~~~~~~~~~~~~~~~~~~~~~~
2623 Show information about the Link Bonding device in mode 4 (link-aggregation-802.3ad)::
2625 testpmd> show bonding lacp info (port_id)
2630 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2631 This is mainly useful for debugging purposes.
2632 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2633 and fields that can be accessed.
2638 Display the value of a port register::
2640 testpmd> read reg (port_id) (address)
2642 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2644 testpmd> read reg 0 0xEE00
2645 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2650 Display a port register bit field::
2652 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2654 For example, reading the lowest two bits from the register in the example above::
2656 testpmd> read regfield 0 0xEE00 0 1
2657 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2662 Display a single port register bit::
2664 testpmd> read regbit (port_id) (address) (bit_x)
2666 For example, reading the lowest bit from the register in the example above::
2668 testpmd> read regbit 0 0xEE00 0
2669 port 0 PCI register at offset 0xEE00: bit 0=1
2674 Set the value of a port register::
2676 testpmd> write reg (port_id) (address) (value)
2678 For example, to clear a register::
2680 testpmd> write reg 0 0xEE00 0x0
2681 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2686 Set bit field of a port register::
2688 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2690 For example, writing to the register cleared in the example above::
2692 testpmd> write regfield 0 0xEE00 0 1 2
2693 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2698 Set single bit value of a port register::
2700 testpmd> write regbit (port_id) (address) (bit_x) (value)
2702 For example, to set the high bit in the register from the example above::
2704 testpmd> write regbit 0 0xEE00 31 1
2705 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2707 Traffic Metering and Policing
2708 -----------------------------
2710 The following section shows functions for configuring traffic metering and
2711 policing on the ethernet device through the use of generic ethdev API.
2713 show port traffic management capability
2714 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2716 Show traffic metering and policing capability of the port::
2718 testpmd> show port meter cap (port_id)
2720 add port meter profile (srTCM rfc2967)
2721 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2723 Add meter profile (srTCM rfc2697) to the ethernet device::
2725 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2726 (cir) (cbs) (ebs) (packet_mode)
2730 * ``profile_id``: ID for the meter profile.
2731 * ``cir``: Committed Information Rate (CIR) (bytes per second or packets per second).
2732 * ``cbs``: Committed Burst Size (CBS) (bytes or packets).
2733 * ``ebs``: Excess Burst Size (EBS) (bytes or packets).
2734 * ``packet_mode``: Packets mode for meter profile.
2736 add port meter profile (trTCM rfc2968)
2737 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2739 Add meter profile (srTCM rfc2698) to the ethernet device::
2741 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2742 (cir) (pir) (cbs) (pbs) (packet_mode)
2746 * ``profile_id``: ID for the meter profile.
2747 * ``cir``: Committed information rate (bytes per second or packets per second).
2748 * ``pir``: Peak information rate (bytes per second or packets per second).
2749 * ``cbs``: Committed burst size (bytes or packets).
2750 * ``pbs``: Peak burst size (bytes or packets).
2751 * ``packet_mode``: Packets mode for meter profile.
2753 add port meter profile (trTCM rfc4115)
2754 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2756 Add meter profile (trTCM rfc4115) to the ethernet device::
2758 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2759 (cir) (eir) (cbs) (ebs) (packet_mode)
2763 * ``profile_id``: ID for the meter profile.
2764 * ``cir``: Committed information rate (bytes per second or packets per second).
2765 * ``eir``: Excess information rate (bytes per second or packets per second).
2766 * ``cbs``: Committed burst size (bytes or packets).
2767 * ``ebs``: Excess burst size (bytes or packets).
2768 * ``packet_mode``: Packets mode for meter profile.
2770 delete port meter profile
2771 ~~~~~~~~~~~~~~~~~~~~~~~~~
2773 Delete meter profile from the ethernet device::
2775 testpmd> del port meter profile (port_id) (profile_id)
2780 Create new policy object for the ethernet device::
2782 testpmd> add port meter policy (port_id) (policy_id) g_actions \
2783 {action} y_actions {action} r_actions {action}
2787 * ``policy_id``: policy ID.
2788 * ``action``: action lists for green/yellow/red colors.
2793 Delete policy object for the ethernet device::
2795 testpmd> del port meter policy (port_id) (policy_id)
2799 * ``policy_id``: policy ID.
2804 Create new meter object for the ethernet device::
2806 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2807 (policy_id) (meter_enable) (stats_mask) (shared) \
2808 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2813 * ``mtr_id``: meter object ID.
2814 * ``profile_id``: ID for the meter profile.
2815 * ``policy_id``: ID for the policy.
2816 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2817 gets enabled at the time of creation, otherwise remains disabled.
2818 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2820 * ``shared``: When this parameter has a non-zero value, the meter object is
2821 shared by multiple flows. Otherwise, meter object is used by single flow.
2822 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2823 input color for the current meter object is determined by the latest meter
2824 object in the same flow. Otherwise, the current meter object uses the
2825 *dscp_table* to determine the input color.
2826 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2827 color, 0 <= x <= 63.
2832 Enable meter for the ethernet device::
2834 testpmd> enable port meter (port_id) (mtr_id)
2839 Disable meter for the ethernet device::
2841 testpmd> disable port meter (port_id) (mtr_id)
2846 Delete meter for the ethernet device::
2848 testpmd> del port meter (port_id) (mtr_id)
2850 Set port meter profile
2851 ~~~~~~~~~~~~~~~~~~~~~~
2853 Set meter profile for the ethernet device::
2855 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2857 set port meter dscp table
2858 ~~~~~~~~~~~~~~~~~~~~~~~~~
2860 Set meter dscp table for the ethernet device::
2862 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2863 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2865 set port meter stats mask
2866 ~~~~~~~~~~~~~~~~~~~~~~~~~
2868 Set meter stats mask for the ethernet device::
2870 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2874 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2876 show port meter stats
2877 ~~~~~~~~~~~~~~~~~~~~~
2879 Show meter stats of the ethernet device::
2881 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2885 * ``clear``: Flag that indicates whether the statistics counters should
2886 be cleared (i.e. set to zero) immediately after they have been read or not.
2891 The following section shows functions for configuring traffic management on
2892 the ethernet device through the use of generic TM API.
2894 show port traffic management capability
2895 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2897 Show traffic management capability of the port::
2899 testpmd> show port tm cap (port_id)
2901 show port traffic management capability (hierarchy level)
2902 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2904 Show traffic management hierarchy level capability of the port::
2906 testpmd> show port tm level cap (port_id) (level_id)
2908 show port traffic management capability (hierarchy node level)
2909 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2911 Show the traffic management hierarchy node capability of the port::
2913 testpmd> show port tm node cap (port_id) (node_id)
2915 show port traffic management hierarchy node type
2916 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2918 Show the port traffic management hierarchy node type::
2920 testpmd> show port tm node type (port_id) (node_id)
2922 show port traffic management hierarchy node stats
2923 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2925 Show the port traffic management hierarchy node statistics::
2927 testpmd> show port tm node stats (port_id) (node_id) (clear)
2931 * ``clear``: When this parameter has a non-zero value, the statistics counters
2932 are cleared (i.e. set to zero) immediately after they have been read,
2933 otherwise the statistics counters are left untouched.
2935 Add port traffic management private shaper profile
2936 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2938 Add the port traffic management private shaper profile::
2940 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2941 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2942 (packet_length_adjust) (packet_mode)
2946 * ``shaper_profile id``: Shaper profile ID for the new profile.
2947 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second or packets per second).
2948 * ``cmit_tb_size``: Committed token bucket size (bytes or packets).
2949 * ``peak_tb_rate``: Peak token bucket rate (bytes per second or packets per second).
2950 * ``peak_tb_size``: Peak token bucket size (bytes or packets).
2951 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2952 each packet for the purpose of shaping. This parameter value can be used to
2953 correct the packet length with the framing overhead bytes that are consumed
2955 * ``packet_mode``: Shaper configured in packet mode. This parameter value if
2956 zero, configures shaper in byte mode and if non-zero configures it in packet
2959 Delete port traffic management private shaper profile
2960 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2962 Delete the port traffic management private shaper::
2964 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2968 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2970 Add port traffic management shared shaper
2971 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2973 Create the port traffic management shared shaper::
2975 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2980 * ``shared_shaper_id``: Shared shaper ID to be created.
2981 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2983 Set port traffic management shared shaper
2984 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2986 Update the port traffic management shared shaper::
2988 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2993 * ``shared_shaper_id``: Shared shaper ID to be update.
2994 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2996 Delete port traffic management shared shaper
2997 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2999 Delete the port traffic management shared shaper::
3001 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
3005 * ``shared_shaper_id``: Shared shaper ID to be deleted.
3007 Set port traffic management hierarchy node private shaper
3008 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3010 set the port traffic management hierarchy node private shaper::
3012 testpmd> set port tm node shaper profile (port_id) (node_id) \
3017 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
3020 Add port traffic management WRED profile
3021 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3023 Create a new WRED profile::
3025 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
3026 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
3027 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
3028 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
3032 * ``wred_profile id``: Identifier for the newly create WRED profile
3033 * ``color_g``: Packet color (green)
3034 * ``min_th_g``: Minimum queue threshold for packet with green color
3035 * ``max_th_g``: Minimum queue threshold for packet with green color
3036 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
3037 * ``wq_log2_g``: Negated log2 of queue weight (wq)
3038 * ``color_y``: Packet color (yellow)
3039 * ``min_th_y``: Minimum queue threshold for packet with yellow color
3040 * ``max_th_y``: Minimum queue threshold for packet with yellow color
3041 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
3042 * ``wq_log2_y``: Negated log2 of queue weight (wq)
3043 * ``color_r``: Packet color (red)
3044 * ``min_th_r``: Minimum queue threshold for packet with yellow color
3045 * ``max_th_r``: Minimum queue threshold for packet with yellow color
3046 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
3047 * ``wq_log2_r``: Negated log2 of queue weight (wq)
3049 Delete port traffic management WRED profile
3050 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3052 Delete the WRED profile::
3054 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
3056 Add port traffic management hierarchy nonleaf node
3057 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3059 Add nonleaf node to port traffic management hierarchy::
3061 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
3062 (priority) (weight) (level_id) (shaper_profile_id) \
3063 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3064 [(shared_shaper_0) (shared_shaper_1) ...] \
3068 * ``parent_node_id``: Node ID of the parent.
3069 * ``priority``: Node priority (highest node priority is zero). This is used by
3070 the SP algorithm running on the parent node for scheduling this node.
3071 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3072 to the weight sum of all siblings that have the same priority. It is used by
3073 the WFQ algorithm running on the parent node for scheduling this node.
3074 * ``level_id``: Hierarchy level of the node.
3075 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3077 * ``n_sp_priorities``: Number of strict priorities.
3078 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3079 * ``n_shared_shapers``: Number of shared shapers.
3080 * ``shared_shaper_id``: Shared shaper id.
3082 Add port traffic management hierarchy nonleaf node with packet mode
3083 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3085 Add nonleaf node with packet mode to port traffic management hierarchy::
3087 testpmd> add port tm nonleaf node pktmode (port_id) (node_id) (parent_node_id) \
3088 (priority) (weight) (level_id) (shaper_profile_id) \
3089 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3090 [(shared_shaper_0) (shared_shaper_1) ...] \
3094 * ``parent_node_id``: Node ID of the parent.
3095 * ``priority``: Node priority (highest node priority is zero). This is used by
3096 the SP algorithm running on the parent node for scheduling this node.
3097 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3098 to the weight sum of all siblings that have the same priority. It is used by
3099 the WFQ algorithm running on the parent node for scheduling this node.
3100 * ``level_id``: Hierarchy level of the node.
3101 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3103 * ``n_sp_priorities``: Number of strict priorities. Packet mode is enabled on
3105 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3106 * ``n_shared_shapers``: Number of shared shapers.
3107 * ``shared_shaper_id``: Shared shaper id.
3109 Add port traffic management hierarchy leaf node
3110 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3112 Add leaf node to port traffic management hierarchy::
3114 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
3115 (priority) (weight) (level_id) (shaper_profile_id) \
3116 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
3117 [(shared_shaper_id) (shared_shaper_id) ...] \
3121 * ``parent_node_id``: Node ID of the parent.
3122 * ``priority``: Node priority (highest node priority is zero). This is used by
3123 the SP algorithm running on the parent node for scheduling this node.
3124 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3125 to the weight sum of all siblings that have the same priority. It is used by
3126 the WFQ algorithm running on the parent node for scheduling this node.
3127 * ``level_id``: Hierarchy level of the node.
3128 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3130 * ``cman_mode``: Congestion management mode to be enabled for this node.
3131 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3132 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3133 * ``n_shared_shapers``: Number of shared shapers.
3134 * ``shared_shaper_id``: Shared shaper id.
3136 Delete port traffic management hierarchy node
3137 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3139 Delete node from port traffic management hierarchy::
3141 testpmd> del port tm node (port_id) (node_id)
3143 Update port traffic management hierarchy parent node
3144 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3146 Update port traffic management hierarchy parent node::
3148 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3151 This function can only be called after the hierarchy commit invocation. Its
3152 success depends on the port support for this operation, as advertised through
3153 the port capability set. This function is valid for all nodes of the traffic
3154 management hierarchy except root node.
3156 Suspend port traffic management hierarchy node
3157 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3159 testpmd> suspend port tm node (port_id) (node_id)
3161 Resume port traffic management hierarchy node
3162 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3164 testpmd> resume port tm node (port_id) (node_id)
3166 Commit port traffic management hierarchy
3167 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3169 Commit the traffic management hierarchy on the port::
3171 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3175 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3176 call failure. On the other hand, hierarchy is preserved when this parameter
3179 Set port traffic management mark VLAN dei
3180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3182 Enables/Disables the traffic management marking on the port for VLAN packets::
3184 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3188 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3189 ``yellow`` or ``red`` will have dei bit enabled
3191 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3193 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3195 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3197 Set port traffic management mark IP dscp
3198 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3200 Enables/Disables the traffic management marking on the port for IP dscp packets::
3202 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3206 * ``port_id``: The port which on which IP packets marked as ``green`` or
3207 ``yellow`` or ``red`` will have IP dscp bits updated
3209 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3211 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3213 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3215 Set port traffic management mark IP ecn
3216 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3218 Enables/Disables the traffic management marking on the port for IP ecn packets::
3220 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3224 * ``port_id``: The port which on which IP packets marked as ``green`` or
3225 ``yellow`` or ``red`` will have IP ecn bits updated
3227 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3228 to ecn of 2'b11 when IP is caring TCP or SCTP
3230 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3231 to ecn of 2'b11 when IP is caring TCP or SCTP
3233 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3234 to ecn of 2'b11 when IP is caring TCP or SCTP
3239 This section details the available filter functions that are available.
3241 Note these functions interface the deprecated legacy filtering framework,
3242 superseded by *rte_flow*. See `Flow rules management`_.
3244 .. _testpmd_flow_director:
3249 Set flow director's input masks::
3251 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3252 src_mask (ipv4_src) (ipv6_src) (src_port) \
3253 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3255 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3257 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3258 mac (mac_value) tunnel-type (tunnel_type_value) \
3259 tunnel-id (tunnel_id_value)
3261 Example, to set flow director mask on port 0::
3263 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3264 src_mask 255.255.255.255 \
3265 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3266 dst_mask 255.255.255.255 \
3267 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3269 flow_director_flex_payload
3270 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3272 Configure flexible payload selection::
3274 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3276 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3278 testpmd> flow_director_flex_payload 0 l4 \
3279 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3282 .. _testpmd_rte_flow:
3284 Flow rules management
3285 ---------------------
3287 Control of the generic flow API (*rte_flow*) is fully exposed through the
3288 ``flow`` command (validation, creation, destruction, queries and operation
3291 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3292 features simultaneously may cause undefined side-effects and is therefore
3298 Because the ``flow`` command uses dynamic tokens to handle the large number
3299 of possible flow rules combinations, its behavior differs slightly from
3300 other commands, in particular:
3302 - Pressing *?* or the *<tab>* key displays contextual help for the current
3303 token, not that of the entire command.
3305 - Optional and repeated parameters are supported (provided they are listed
3306 in the contextual help).
3308 The first parameter stands for the operation mode. Possible operations and
3309 their general syntax are described below. They are covered in detail in the
3312 - Check whether a flow rule can be created::
3314 flow validate {port_id}
3315 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3316 pattern {item} [/ {item} [...]] / end
3317 actions {action} [/ {action} [...]] / end
3319 - Create a flow rule::
3321 flow create {port_id}
3322 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3323 pattern {item} [/ {item} [...]] / end
3324 actions {action} [/ {action} [...]] / end
3326 - Destroy specific flow rules::
3328 flow destroy {port_id} rule {rule_id} [...]
3330 - Destroy all flow rules::
3332 flow flush {port_id}
3334 - Query an existing flow rule::
3336 flow query {port_id} {rule_id} {action}
3338 - List existing flow rules sorted by priority, filtered by group
3341 flow list {port_id} [group {group_id}] [...]
3343 - Restrict ingress traffic to the defined flow rules::
3345 flow isolate {port_id} {boolean}
3347 - Dump internal representation information of all flows in hardware::
3349 flow dump {port_id} all {output_file}
3353 flow dump {port_id} rule {rule_id} {output_file}
3355 - List and destroy aged flow rules::
3357 flow aged {port_id} [destroy]
3359 - Tunnel offload - create a tunnel stub::
3361 flow tunnel create {port_id} type {tunnel_type}
3363 - Tunnel offload - destroy a tunnel stub::
3365 flow tunnel destroy {port_id} id {tunnel_id}
3367 - Tunnel offload - list port tunnel stubs::
3369 flow tunnel list {port_id}
3371 Creating a tunnel stub for offload
3372 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3374 ``flow tunnel create`` setup a tunnel stub for tunnel offload flow rules::
3376 flow tunnel create {port_id} type {tunnel_type}
3378 If successful, it will return a tunnel stub ID usable with other commands::
3380 port [...]: flow tunnel #[...] type [...]
3382 Tunnel stub ID is relative to a port.
3384 Destroying tunnel offload stub
3385 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3387 ``flow tunnel destroy`` destroy port tunnel stub::
3389 flow tunnel destroy {port_id} id {tunnel_id}
3391 Listing tunnel offload stubs
3392 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3394 ``flow tunnel list`` list port tunnel offload stubs::
3396 flow tunnel list {port_id}
3398 Validating flow rules
3399 ~~~~~~~~~~~~~~~~~~~~~
3401 ``flow validate`` reports whether a flow rule would be accepted by the
3402 underlying device in its current state but stops short of creating it. It is
3403 bound to ``rte_flow_validate()``::
3405 flow validate {port_id}
3406 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3407 pattern {item} [/ {item} [...]] / end
3408 actions {action} [/ {action} [...]] / end
3410 If successful, it will show::
3414 Otherwise it will show an error message of the form::
3416 Caught error type [...] ([...]): [...]
3418 This command uses the same parameters as ``flow create``, their format is
3419 described in `Creating flow rules`_.
3421 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3422 index 6 is supported::
3424 testpmd> flow validate 0 ingress pattern eth / end
3425 actions queue index 6 / end
3429 Port 0 does not support TCPv6 rules::
3431 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3433 Caught error type 9 (specific pattern item): Invalid argument
3439 ``flow create`` validates and creates the specified flow rule. It is bound
3440 to ``rte_flow_create()``::
3442 flow create {port_id}
3443 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3444 [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}]
3445 pattern {item} [/ {item} [...]] / end
3446 actions {action} [/ {action} [...]] / end
3448 If successful, it will return a flow rule ID usable with other commands::
3450 Flow rule #[...] created
3452 Otherwise it will show an error message of the form::
3454 Caught error type [...] ([...]): [...]
3456 Parameters describe in the following order:
3458 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3459 - Tunnel offload specification (tunnel_set, tunnel_match)
3460 - A matching pattern, starting with the *pattern* token and terminated by an
3462 - Actions, starting with the *actions* token and terminated by an *end*
3465 These translate directly to *rte_flow* objects provided as-is to the
3466 underlying functions.
3468 The shortest valid definition only comprises mandatory tokens::
3470 testpmd> flow create 0 pattern end actions end
3472 Note that PMDs may refuse rules that essentially do nothing such as this
3475 **All unspecified object values are automatically initialized to 0.**
3480 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3481 specified before the ``pattern`` token.
3483 - ``group {group id}``: priority group.
3484 - ``priority {level}``: priority level within group.
3485 - ``ingress``: rule applies to ingress traffic.
3486 - ``egress``: rule applies to egress traffic.
3487 - ``transfer``: apply rule directly to endpoints found in pattern.
3489 Please note that use of ``transfer`` attribute requires that the flow and
3490 its indirect components be managed via so-called ``transfer`` proxy port.
3491 See `show flow transfer proxy port ID for the given port`_ for details.
3493 Each instance of an attribute specified several times overrides the previous
3494 value as shown below (group 4 is used)::
3496 testpmd> flow create 0 group 42 group 24 group 4 [...]
3498 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3500 While not specifying a direction is an error, some rules may allow both
3503 Most rules affect RX therefore contain the ``ingress`` token::
3505 testpmd> flow create 0 ingress pattern [...]
3510 Indicate tunnel offload rule type
3512 - ``tunnel_set {tunnel_id}``: mark rule as tunnel offload decap_set type.
3513 - ``tunnel_match {tunnel_id}``: mark rule as tunnel offload match type.
3518 A matching pattern starts after the ``pattern`` token. It is made of pattern
3519 items and is terminated by a mandatory ``end`` item.
3521 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3522 rte_flow_item_type``).
3524 The ``/`` token is used as a separator between pattern items as shown
3527 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3529 Note that protocol items like these must be stacked from lowest to highest
3530 layer to make sense. For instance, the following rule is either invalid or
3531 unlikely to match any packet::
3533 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3535 More information on these restrictions can be found in the *rte_flow*
3538 Several items support additional specification structures, for example
3539 ``ipv4`` allows specifying source and destination addresses as follows::
3541 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3542 dst is 10.2.0.0 / end [...]
3544 This rule matches all IPv4 traffic with the specified properties.
3546 In this example, ``src`` and ``dst`` are field names of the underlying
3547 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3548 in a similar fashion.
3550 The ``is`` token means that the subsequent value must be matched exactly,
3551 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3552 accordingly. Possible assignment tokens are:
3554 - ``is``: match value perfectly (with full bit-mask).
3555 - ``spec``: match value according to configured bit-mask.
3556 - ``last``: specify upper bound to establish a range.
3557 - ``mask``: specify bit-mask with relevant bits set to one.
3558 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3560 These yield identical results::
3562 ipv4 src is 10.1.1.1
3566 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3570 ipv4 src spec 10.1.1.1 src prefix 32
3574 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3578 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3580 Inclusive ranges can be defined with ``last``::
3582 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3584 Note that ``mask`` affects both ``spec`` and ``last``::
3586 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3587 # matches 10.1.0.0 to 10.2.255.255
3589 Properties can be modified multiple times::
3591 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3595 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3600 This section lists supported pattern items and their attributes, if any.
3602 - ``end``: end list of pattern items.
3604 - ``void``: no-op pattern item.
3606 - ``invert``: perform actions when pattern does not match.
3608 - ``any``: match any protocol for the current layer.
3610 - ``num {unsigned}``: number of layers covered.
3612 - ``pf``: match traffic from/to the physical function.
3614 - ``vf``: match traffic from/to a virtual function ID.
3616 - ``id {unsigned}``: VF ID.
3618 - ``phy_port``: match traffic from/to a specific physical port.
3620 - ``index {unsigned}``: physical port index.
3622 - ``port_id``: match traffic from/to a given DPDK port ID.
3624 - ``id {unsigned}``: DPDK port ID.
3626 - ``mark``: match value set in previously matched flow rule using the mark action.
3628 - ``id {unsigned}``: arbitrary integer value.
3630 - ``raw``: match an arbitrary byte string.
3632 - ``relative {boolean}``: look for pattern after the previous item.
3633 - ``search {boolean}``: search pattern from offset (see also limit).
3634 - ``offset {integer}``: absolute or relative offset for pattern.
3635 - ``limit {unsigned}``: search area limit for start of pattern.
3636 - ``pattern {string}``: byte string to look for.
3638 - ``eth``: match Ethernet header.
3640 - ``dst {MAC-48}``: destination MAC.
3641 - ``src {MAC-48}``: source MAC.
3642 - ``type {unsigned}``: EtherType or TPID.
3644 - ``vlan``: match 802.1Q/ad VLAN tag.
3646 - ``tci {unsigned}``: tag control information.
3647 - ``pcp {unsigned}``: priority code point.
3648 - ``dei {unsigned}``: drop eligible indicator.
3649 - ``vid {unsigned}``: VLAN identifier.
3650 - ``inner_type {unsigned}``: inner EtherType or TPID.
3652 - ``ipv4``: match IPv4 header.
3654 - ``version_ihl {unsigned}``: IPv4 version and IP header length.
3655 - ``tos {unsigned}``: type of service.
3656 - ``ttl {unsigned}``: time to live.
3657 - ``proto {unsigned}``: next protocol ID.
3658 - ``src {ipv4 address}``: source address.
3659 - ``dst {ipv4 address}``: destination address.
3661 - ``ipv6``: match IPv6 header.
3663 - ``tc {unsigned}``: traffic class.
3664 - ``flow {unsigned}``: flow label.
3665 - ``proto {unsigned}``: protocol (next header).
3666 - ``hop {unsigned}``: hop limit.
3667 - ``src {ipv6 address}``: source address.
3668 - ``dst {ipv6 address}``: destination address.
3670 - ``icmp``: match ICMP header.
3672 - ``type {unsigned}``: ICMP packet type.
3673 - ``code {unsigned}``: ICMP packet code.
3675 - ``udp``: match UDP header.
3677 - ``src {unsigned}``: UDP source port.
3678 - ``dst {unsigned}``: UDP destination port.
3680 - ``tcp``: match TCP header.
3682 - ``src {unsigned}``: TCP source port.
3683 - ``dst {unsigned}``: TCP destination port.
3685 - ``sctp``: match SCTP header.
3687 - ``src {unsigned}``: SCTP source port.
3688 - ``dst {unsigned}``: SCTP destination port.
3689 - ``tag {unsigned}``: validation tag.
3690 - ``cksum {unsigned}``: checksum.
3692 - ``vxlan``: match VXLAN header.
3694 - ``vni {unsigned}``: VXLAN identifier.
3695 - ``last_rsvd {unsigned}``: VXLAN last reserved 8-bits.
3697 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3699 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3701 - ``nvgre``: match NVGRE header.
3703 - ``tni {unsigned}``: virtual subnet ID.
3705 - ``mpls``: match MPLS header.
3707 - ``label {unsigned}``: MPLS label.
3709 - ``gre``: match GRE header.
3711 - ``protocol {unsigned}``: protocol type.
3713 - ``gre_key``: match GRE optional key field.
3715 - ``value {unsigned}``: key value.
3717 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3719 - ``thresh {unsigned}``: accuracy threshold.
3721 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3723 - ``teid {unsigned}``: tunnel endpoint identifier.
3725 - ``geneve``: match GENEVE header.
3727 - ``vni {unsigned}``: virtual network identifier.
3728 - ``protocol {unsigned}``: protocol type.
3730 - ``geneve-opt``: match GENEVE header option.
3732 - ``class {unsigned}``: GENEVE option class.
3733 - ``type {unsigned}``: GENEVE option type.
3734 - ``length {unsigned}``: GENEVE option length in 32-bit words.
3735 - ``data {hex string}``: GENEVE option data, the length is defined by
3738 - ``vxlan-gpe``: match VXLAN-GPE header.
3740 - ``vni {unsigned}``: VXLAN-GPE identifier.
3742 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3744 - ``sha {MAC-48}``: sender hardware address.
3745 - ``spa {ipv4 address}``: sender IPv4 address.
3746 - ``tha {MAC-48}``: target hardware address.
3747 - ``tpa {ipv4 address}``: target IPv4 address.
3749 - ``ipv6_ext``: match presence of any IPv6 extension header.
3751 - ``next_hdr {unsigned}``: next header.
3753 - ``icmp6``: match any ICMPv6 header.
3755 - ``type {unsigned}``: ICMPv6 type.
3756 - ``code {unsigned}``: ICMPv6 code.
3758 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3760 - ``target_addr {ipv6 address}``: target address.
3762 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3764 - ``target_addr {ipv6 address}``: target address.
3766 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3768 - ``type {unsigned}``: ND option type.
3770 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3771 link-layer address option.
3773 - ``sla {MAC-48}``: source Ethernet LLA.
3775 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3776 link-layer address option.
3778 - ``tla {MAC-48}``: target Ethernet LLA.
3780 - ``meta``: match application specific metadata.
3782 - ``data {unsigned}``: metadata value.
3784 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3786 - ``pdu_type {unsigned}``: PDU type.
3788 - ``qfi {unsigned}``: QoS flow identifier.
3790 - ``pppoes``, ``pppoed``: match PPPoE header.
3792 - ``session_id {unsigned}``: session identifier.
3794 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3796 - ``proto_id {unsigned}``: PPP protocol identifier.
3798 - ``l2tpv3oip``: match L2TPv3 over IP header.
3800 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
3802 - ``ah``: match AH header.
3804 - ``spi {unsigned}``: security parameters index.
3806 - ``pfcp``: match PFCP header.
3808 - ``s_field {unsigned}``: S field.
3809 - ``seid {unsigned}``: session endpoint identifier.
3811 - ``integrity``: match packet integrity.
3813 - ``level {unsigned}``: Packet encapsulation level the item should
3814 apply to. See rte_flow_action_rss for details.
3815 - ``value {unsigned}``: A bitmask that specify what packet elements
3816 must be matched for integrity.
3818 - ``conntrack``: match conntrack state.
3820 - ``port_representor``: match traffic entering the embedded switch from the given ethdev
3822 - ``port_id {unsigned}``: ethdev port ID
3824 - ``represented_port``: match traffic entering the embedded switch from
3825 the entity represented by the given ethdev
3827 - ``ethdev_port_id {unsigned}``: ethdev port ID
3829 - ``l2tpv2``: match L2TPv2 header.
3831 - ``length {unsigned}``: L2TPv2 option length.
3832 - ``tunnel_id {unsigned}``: L2TPv2 tunnel identifier.
3833 - ``session_id {unsigned}``: L2TPv2 session identifier.
3834 - ``ns {unsigned}``: L2TPv2 option ns.
3835 - ``nr {unsigned}``: L2TPv2 option nr.
3837 - ``ppp``: match PPP header.
3839 - ``addr {unsigned}``: PPP address.
3840 - ``ctrl {unsigned}``: PPP control.
3841 - ``proto_id {unsigned}``: PPP protocol identifier.
3846 A list of actions starts after the ``actions`` token in the same fashion as
3847 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3848 terminated by a mandatory ``end`` action.
3850 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3851 rte_flow_action_type``).
3853 Dropping all incoming UDPv4 packets can be expressed as follows::
3855 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3858 Several actions have configurable properties which must be specified when
3859 there is no valid default value. For example, ``queue`` requires a target
3862 This rule redirects incoming UDPv4 traffic to queue index 6::
3864 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3865 actions queue index 6 / end
3867 While this one could be rejected by PMDs (unspecified queue index)::
3869 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3872 As defined by *rte_flow*, the list is not ordered, all actions of a given
3873 rule are performed simultaneously. These are equivalent::
3875 queue index 6 / void / mark id 42 / end
3879 void / mark id 42 / queue index 6 / end
3881 All actions in a list should have different types, otherwise only the last
3882 action of a given type is taken into account::
3884 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
3888 drop / drop / drop / end # drop is performed only once
3892 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
3894 Considering they are performed simultaneously, opposite and overlapping
3895 actions can sometimes be combined when the end result is unambiguous::
3897 drop / queue index 6 / end # drop has no effect
3901 queue index 6 / rss queues 6 7 8 / end # queue has no effect
3905 drop / passthru / end # drop has no effect
3907 Note that PMDs may still refuse such combinations.
3912 This section lists supported actions and their attributes, if any.
3914 - ``end``: end list of actions.
3916 - ``void``: no-op action.
3918 - ``passthru``: let subsequent rule process matched packets.
3920 - ``jump``: redirect traffic to group on device.
3922 - ``group {unsigned}``: group to redirect to.
3924 - ``mark``: attach 32 bit value to packets.
3926 - ``id {unsigned}``: 32 bit value to return with packets.
3928 - ``flag``: flag packets.
3930 - ``queue``: assign packets to a given queue index.
3932 - ``index {unsigned}``: queue index to use.
3934 - ``drop``: drop packets (note: passthru has priority).
3936 - ``count``: enable counters for this rule.
3938 - ``rss``: spread packets among several queues.
3940 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
3941 ``toeplitz``, ``simple_xor``, ``symmetric_toeplitz`` and ``default``.
3943 - ``level {unsigned}``: encapsulation level for ``types``.
3945 - ``types [{RSS hash type} [...]] end``: specific RSS hash types.
3946 Note that an empty list does not disable RSS but instead requests
3947 unspecified "best-effort" settings.
3949 - ``key {string}``: RSS hash key, overrides ``key_len``.
3951 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
3952 conjunction with ``key`` to pad or truncate it.
3954 - ``queues [{unsigned} [...]] end``: queue indices to use.
3956 - ``pf``: direct traffic to physical function.
3958 - ``vf``: direct traffic to a virtual function ID.
3960 - ``original {boolean}``: use original VF ID if possible.
3961 - ``id {unsigned}``: VF ID.
3963 - ``phy_port``: direct packets to physical port index.
3965 - ``original {boolean}``: use original port index if possible.
3966 - ``index {unsigned}``: physical port index.
3968 - ``port_id``: direct matching traffic to a given DPDK port ID.
3970 - ``original {boolean}``: use original DPDK port ID if possible.
3971 - ``id {unsigned}``: DPDK port ID.
3973 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
3975 - ``mpls_ttl``: MPLS TTL.
3977 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
3979 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
3981 - ``nw_ttl``: IP TTL.
3983 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
3985 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
3987 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
3989 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
3991 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
3993 - ``ethertype``: Ethertype.
3995 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
3997 - ``vlan_vid``: VLAN id.
3999 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4001 - ``vlan_pcp``: VLAN priority.
4003 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4005 - ``ethertype``: Ethertype.
4007 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4009 - ``ethertype``: Ethertype.
4011 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4012 is done through `Config VXLAN Encap outer layers`_.
4014 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4015 the VXLAN tunnel network overlay from the matched flow.
4017 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4018 is done through `Config NVGRE Encap outer layers`_.
4020 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4021 the NVGRE tunnel network overlay from the matched flow.
4023 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4024 is done through `Config L2 Encap`_.
4026 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4027 is done through `Config L2 Decap`_.
4029 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4030 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4032 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4033 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4035 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4036 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4038 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4039 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4041 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4043 - ``ipv4_addr``: New IPv4 source address.
4045 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4048 - ``ipv4_addr``: New IPv4 destination address.
4050 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4052 - ``ipv6_addr``: New IPv6 source address.
4054 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4057 - ``ipv6_addr``: New IPv6 destination address.
4059 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4062 - ``port``: New TCP/UDP source port number.
4064 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4067 - ``port``: New TCP/UDP destination port number.
4069 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4072 - ``dec_ttl``: Performs a decrease TTL value action
4074 - ``set_ttl``: Set TTL value with specified value
4075 - ``ttl_value {unsigned}``: The new TTL value to be set
4077 - ``set_mac_src``: set source MAC address
4079 - ``mac_addr {MAC-48}``: new source MAC address
4081 - ``set_mac_dst``: set destination MAC address
4083 - ``mac_addr {MAC-48}``: new destination MAC address
4085 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4087 - ``value {unsigned}``: Value to increase TCP sequence number by.
4089 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4091 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4093 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4095 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4097 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4099 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4101 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4103 - ``dscp_value {unsigned}``: The new DSCP value to be set
4105 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4107 - ``dscp_value {unsigned}``: The new DSCP value to be set
4109 - ``indirect``: Use indirect action created via
4110 ``flow indirect_action {port_id} create``
4112 - ``indirect_action_id {unsigned}``: Indirect action ID to use
4114 - ``color``: Color the packet to reflect the meter color result
4116 - ``type {value}``: Set color type with specified value(green/yellow/red)
4118 - ``port_representor``: at embedded switch level, send matching traffic to
4121 - ``port_id {unsigned}``: ethdev port ID
4123 - ``represented_port``: at embedded switch level, send matching traffic to
4124 the entity represented by the given ethdev
4126 - ``ethdev_port_id {unsigned}``: ethdev port ID
4128 Destroying flow rules
4129 ~~~~~~~~~~~~~~~~~~~~~
4131 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4132 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4133 times as necessary::
4135 flow destroy {port_id} rule {rule_id} [...]
4137 If successful, it will show::
4139 Flow rule #[...] destroyed
4141 It does not report anything for rule IDs that do not exist. The usual error
4142 message is shown when a rule cannot be destroyed::
4144 Caught error type [...] ([...]): [...]
4146 ``flow flush`` destroys all rules on a device and does not take extra
4147 arguments. It is bound to ``rte_flow_flush()``::
4149 flow flush {port_id}
4151 Any errors are reported as above.
4153 Creating several rules and destroying them::
4155 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4156 actions queue index 2 / end
4157 Flow rule #0 created
4158 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4159 actions queue index 3 / end
4160 Flow rule #1 created
4161 testpmd> flow destroy 0 rule 0 rule 1
4162 Flow rule #1 destroyed
4163 Flow rule #0 destroyed
4166 The same result can be achieved using ``flow flush``::
4168 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4169 actions queue index 2 / end
4170 Flow rule #0 created
4171 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4172 actions queue index 3 / end
4173 Flow rule #1 created
4174 testpmd> flow flush 0
4177 Non-existent rule IDs are ignored::
4179 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4180 actions queue index 2 / end
4181 Flow rule #0 created
4182 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4183 actions queue index 3 / end
4184 Flow rule #1 created
4185 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4187 testpmd> flow destroy 0 rule 0
4188 Flow rule #0 destroyed
4194 ``flow query`` queries a specific action of a flow rule having that
4195 ability. Such actions collect information that can be reported using this
4196 command. It is bound to ``rte_flow_query()``::
4198 flow query {port_id} {rule_id} {action}
4200 If successful, it will display either the retrieved data for known actions
4201 or the following message::
4203 Cannot display result for action type [...] ([...])
4205 Otherwise, it will complain either that the rule does not exist or that some
4208 Flow rule #[...] not found
4212 Caught error type [...] ([...]): [...]
4214 Currently only the ``count`` action is supported. This action reports the
4215 number of packets that hit the flow rule and the total number of bytes. Its
4216 output has the following format::
4219 hits_set: [...] # whether "hits" contains a valid value
4220 bytes_set: [...] # whether "bytes" contains a valid value
4221 hits: [...] # number of packets
4222 bytes: [...] # number of bytes
4224 Querying counters for TCPv6 packets redirected to queue 6::
4226 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4227 actions queue index 6 / count / end
4228 Flow rule #4 created
4229 testpmd> flow query 0 4 count
4240 ``flow list`` lists existing flow rules sorted by priority and optionally
4241 filtered by group identifiers::
4243 flow list {port_id} [group {group_id}] [...]
4245 This command only fails with the following message if the device does not
4250 Output consists of a header line followed by a short description of each
4251 flow rule, one per line. There is no output at all when no flow rules are
4252 configured on the device::
4254 ID Group Prio Attr Rule
4255 [...] [...] [...] [...] [...]
4257 ``Attr`` column flags:
4259 - ``i`` for ``ingress``.
4260 - ``e`` for ``egress``.
4262 Creating several flow rules and listing them::
4264 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4265 actions queue index 6 / end
4266 Flow rule #0 created
4267 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4268 actions queue index 2 / end
4269 Flow rule #1 created
4270 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4271 actions rss queues 6 7 8 end / end
4272 Flow rule #2 created
4273 testpmd> flow list 0
4274 ID Group Prio Attr Rule
4275 0 0 0 i- ETH IPV4 => QUEUE
4276 1 0 0 i- ETH IPV6 => QUEUE
4277 2 0 5 i- ETH IPV4 UDP => RSS
4280 Rules are sorted by priority (i.e. group ID first, then priority level)::
4282 testpmd> flow list 1
4283 ID Group Prio Attr Rule
4284 0 0 0 i- ETH => COUNT
4285 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4286 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4287 1 24 0 i- ETH IPV4 UDP => QUEUE
4288 4 24 10 i- ETH IPV4 TCP => DROP
4289 3 24 20 i- ETH IPV4 => DROP
4290 2 24 42 i- ETH IPV4 UDP => QUEUE
4291 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4294 Output can be limited to specific groups::
4296 testpmd> flow list 1 group 0 group 63
4297 ID Group Prio Attr Rule
4298 0 0 0 i- ETH => COUNT
4299 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4300 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4301 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4304 Toggling isolated mode
4305 ~~~~~~~~~~~~~~~~~~~~~~
4307 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4308 must only be injected from the defined flow rules; that no default traffic
4309 is expected outside those rules and the driver is free to assign more
4310 resources to handle them. It is bound to ``rte_flow_isolate()``::
4312 flow isolate {port_id} {boolean}
4314 If successful, enabling or disabling isolated mode shows either::
4316 Ingress traffic on port [...]
4317 is now restricted to the defined flow rules
4321 Ingress traffic on port [...]
4322 is not restricted anymore to the defined flow rules
4324 Otherwise, in case of error::
4326 Caught error type [...] ([...]): [...]
4328 Mainly due to its side effects, PMDs supporting this mode may not have the
4329 ability to toggle it more than once without reinitializing affected ports
4330 first (e.g. by exiting testpmd).
4332 Enabling isolated mode::
4334 testpmd> flow isolate 0 true
4335 Ingress traffic on port 0 is now restricted to the defined flow rules
4338 Disabling isolated mode::
4340 testpmd> flow isolate 0 false
4341 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4344 Dumping HW internal information
4345 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4347 ``flow dump`` dumps the hardware's internal representation information of
4348 all flows. It is bound to ``rte_flow_dev_dump()``::
4350 flow dump {port_id} {output_file}
4352 If successful, it will show::
4356 Otherwise, it will complain error occurred::
4358 Caught error type [...] ([...]): [...]
4360 Listing and destroying aged flow rules
4361 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4363 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4364 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4366 flow aged {port_id} [destroy]
4368 Listing current aged flow rules::
4370 testpmd> flow aged 0
4371 Port 0 total aged flows: 0
4372 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4373 actions age timeout 5 / queue index 0 / end
4374 Flow rule #0 created
4375 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4376 actions age timeout 4 / queue index 0 / end
4377 Flow rule #1 created
4378 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4379 actions age timeout 2 / queue index 0 / end
4380 Flow rule #2 created
4381 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4382 actions age timeout 3 / queue index 0 / end
4383 Flow rule #3 created
4386 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4387 information, all the aged flows are sorted by the longest timeout time. For example, if
4388 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4389 will be ID 3, ID 1, ID 0::
4391 testpmd> flow aged 0
4392 Port 0 total aged flows: 4
4399 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4401 testpmd> flow aged 0 destroy
4402 Port 0 total aged flows: 4
4409 Flow rule #2 destroyed
4410 Flow rule #3 destroyed
4411 Flow rule #1 destroyed
4412 Flow rule #0 destroyed
4413 4 flows be destroyed
4414 testpmd> flow aged 0
4415 Port 0 total aged flows: 0
4417 Creating indirect actions
4418 ~~~~~~~~~~~~~~~~~~~~~~~~~
4420 ``flow indirect_action {port_id} create`` creates indirect action with optional
4421 indirect action ID. It is bound to ``rte_flow_action_handle_create()``::
4423 flow indirect_action {port_id} create [action_id {indirect_action_id}]
4424 [ingress] [egress] [transfer] action {action} / end
4426 If successful, it will show::
4428 Indirect action #[...] created
4430 Otherwise, it will complain either that indirect action already exists or that
4431 some error occurred::
4433 Indirect action #[...] is already assigned, delete it first
4437 Caught error type [...] ([...]): [...]
4439 Create indirect rss action with id 100 to queues 1 and 2 on port 0::
4441 testpmd> flow indirect_action 0 create action_id 100 \
4442 ingress action rss queues 1 2 end / end
4444 Create indirect rss action with id assigned by testpmd to queues 1 and 2 on
4447 testpmd> flow indirect_action 0 create action_id \
4448 ingress action rss queues 0 1 end / end
4450 Updating indirect actions
4451 ~~~~~~~~~~~~~~~~~~~~~~~~~
4453 ``flow indirect_action {port_id} update`` updates configuration of the indirect
4454 action from its indirect action ID (as returned by
4455 ``flow indirect_action {port_id} create``). It is bound to
4456 ``rte_flow_action_handle_update()``::
4458 flow indirect_action {port_id} update {indirect_action_id}
4459 action {action} / end
4461 If successful, it will show::
4463 Indirect action #[...] updated
4465 Otherwise, it will complain either that indirect action not found or that some
4468 Failed to find indirect action #[...] on port [...]
4472 Caught error type [...] ([...]): [...]
4474 Update indirect rss action having id 100 on port 0 with rss to queues 0 and 3
4475 (in create example above rss queues were 1 and 2)::
4477 testpmd> flow indirect_action 0 update 100 action rss queues 0 3 end / end
4479 Destroying indirect actions
4480 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
4482 ``flow indirect_action {port_id} destroy`` destroys one or more indirect actions
4483 from their indirect action IDs (as returned by
4484 ``flow indirect_action {port_id} create``). It is bound to
4485 ``rte_flow_action_handle_destroy()``::
4487 flow indirect_action {port_id} destroy action_id {indirect_action_id} [...]
4489 If successful, it will show::
4491 Indirect action #[...] destroyed
4493 It does not report anything for indirect action IDs that do not exist.
4494 The usual error message is shown when a indirect action cannot be destroyed::
4496 Caught error type [...] ([...]): [...]
4498 Destroy indirect actions having id 100 & 101::
4500 testpmd> flow indirect_action 0 destroy action_id 100 action_id 101
4502 Query indirect actions
4503 ~~~~~~~~~~~~~~~~~~~~~~
4505 ``flow indirect_action {port_id} query`` queries the indirect action from its
4506 indirect action ID (as returned by ``flow indirect_action {port_id} create``).
4507 It is bound to ``rte_flow_action_handle_query()``::
4509 flow indirect_action {port_id} query {indirect_action_id}
4511 Currently only rss indirect action supported. If successful, it will show::
4513 Indirect RSS action:
4516 Otherwise, it will complain either that indirect action not found or that some
4519 Failed to find indirect action #[...] on port [...]
4523 Caught error type [...] ([...]): [...]
4525 Query indirect action having id 100::
4527 testpmd> flow indirect_action 0 query 100
4529 Sample QinQ flow rules
4530 ~~~~~~~~~~~~~~~~~~~~~~
4532 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4534 testpmd> port stop 0
4535 testpmd> vlan set extend on 0
4537 The above command sets the inner and outer TPID's to 0x8100.
4539 To change the TPID's the following commands should be used::
4541 testpmd> vlan set outer tpid 0x88A8 0
4542 testpmd> vlan set inner tpid 0x8100 0
4543 testpmd> port start 0
4545 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4549 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4550 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4551 Flow rule #0 validated
4553 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4554 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4555 Flow rule #0 created
4557 testpmd> flow list 0
4558 ID Group Prio Attr Rule
4559 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4561 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4565 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4566 vlan tci is 654 / end actions pf / queue index 0 / end
4567 Flow rule #1 validated
4569 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4570 vlan tci is 654 / end actions pf / queue index 1 / end
4571 Flow rule #1 created
4573 testpmd> flow list 0
4574 ID Group Prio Attr Rule
4575 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4576 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4578 Sample VXLAN flow rules
4579 ~~~~~~~~~~~~~~~~~~~~~~~
4581 Before creating VXLAN rule(s), the UDP port should be added for VXLAN packet
4584 testpmd> rx_vxlan_port add 4789 0
4586 Create VXLAN rules on port 0 to steer traffic to PF queues.
4590 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
4591 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 1 / end
4592 Flow rule #0 created
4594 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 3 /
4595 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 2 / end
4596 Flow rule #1 created
4598 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
4599 eth dst is 00:11:22:33:44:55 / vlan tci is 10 / end actions pf /
4601 Flow rule #2 created
4603 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 5 /
4604 eth dst is 00:11:22:33:44:55 / vlan tci is 20 / end actions pf /
4606 Flow rule #3 created
4608 testpmd> flow create 0 ingress pattern eth dst is 00:00:00:00:01:00 / ipv4 /
4609 udp / vxlan vni is 6 / eth dst is 00:11:22:33:44:55 / end actions pf /
4611 Flow rule #4 created
4613 testpmd> flow list 0
4614 ID Group Prio Attr Rule
4615 0 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4616 1 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4617 2 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
4618 3 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
4619 4 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4621 Sample VXLAN encapsulation rule
4622 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4624 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4625 source code, those can be changed by using the following commands
4627 IPv4 VXLAN outer header::
4629 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4630 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4631 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4634 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4635 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4636 eth-dst 22:22:22:22:22:22
4637 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4640 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4641 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4642 eth-dst 22:22:22:22:22:22
4643 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4646 IPv6 VXLAN outer header::
4648 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4649 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4650 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4653 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4654 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4655 eth-dst 22:22:22:22:22:22
4656 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4659 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4660 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4661 eth-dst 22:22:22:22:22:22
4662 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4665 Sample NVGRE encapsulation rule
4666 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4668 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4669 source code, those can be changed by using the following commands
4671 IPv4 NVGRE outer header::
4673 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4674 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4675 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4678 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4679 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4680 eth-dst 22:22:22:22:22:22
4681 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4684 IPv6 NVGRE outer header::
4686 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4687 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4688 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4691 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
4692 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4693 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4696 Sample L2 encapsulation rule
4697 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4699 L2 encapsulation has default value pre-configured in testpmd
4700 source code, those can be changed by using the following commands
4704 testpmd> set l2_encap ip-version ipv4
4705 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4706 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4707 mplsoudp_decap / l2_encap / end
4709 L2 with VXLAN header::
4711 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4712 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4713 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4714 mplsoudp_decap / l2_encap / end
4716 Sample L2 decapsulation rule
4717 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4719 L2 decapsulation has default value pre-configured in testpmd
4720 source code, those can be changed by using the following commands
4724 testpmd> set l2_decap
4725 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4728 L2 with VXLAN header::
4730 testpmd> set l2_encap-with-vlan
4731 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4734 Sample MPLSoGRE encapsulation rule
4735 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4737 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4738 source code, those can be changed by using the following commands
4740 IPv4 MPLSoGRE outer header::
4742 testpmd> set mplsogre_encap ip-version ipv4 label 4
4743 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4744 eth-dst 22:22:22:22:22:22
4745 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4746 mplsogre_encap / end
4748 IPv4 MPLSoGRE with VLAN outer header::
4750 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4751 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4752 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4753 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4754 mplsogre_encap / end
4756 IPv6 MPLSoGRE outer header::
4758 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4759 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4760 eth-dst 22:22:22:22:22:22
4761 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4762 mplsogre_encap / end
4764 IPv6 MPLSoGRE with VLAN outer header::
4766 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4767 ip-src ::1 ip-dst ::2222 vlan-tci 34
4768 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4769 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4770 mplsogre_encap / end
4772 Sample MPLSoGRE decapsulation rule
4773 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4775 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4776 source code, those can be changed by using the following commands
4778 IPv4 MPLSoGRE outer header::
4780 testpmd> set mplsogre_decap ip-version ipv4
4781 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4782 mplsogre_decap / l2_encap / end
4784 IPv4 MPLSoGRE with VLAN outer header::
4786 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4787 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4788 actions mplsogre_decap / l2_encap / end
4790 IPv6 MPLSoGRE outer header::
4792 testpmd> set mplsogre_decap ip-version ipv6
4793 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4794 actions mplsogre_decap / l2_encap / end
4796 IPv6 MPLSoGRE with VLAN outer header::
4798 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4799 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4800 actions mplsogre_decap / l2_encap / end
4802 Sample MPLSoUDP encapsulation rule
4803 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4805 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4806 source code, those can be changed by using the following commands
4808 IPv4 MPLSoUDP outer header::
4810 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4811 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4812 eth-dst 22:22:22:22:22:22
4813 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4814 mplsoudp_encap / end
4816 IPv4 MPLSoUDP with VLAN outer header::
4818 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4819 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4820 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4821 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4822 mplsoudp_encap / end
4824 IPv6 MPLSoUDP outer header::
4826 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4827 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4828 eth-dst 22:22:22:22:22:22
4829 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4830 mplsoudp_encap / end
4832 IPv6 MPLSoUDP with VLAN outer header::
4834 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4835 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4836 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4837 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4838 mplsoudp_encap / end
4840 Sample MPLSoUDP decapsulation rule
4841 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4843 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4844 source code, those can be changed by using the following commands
4846 IPv4 MPLSoUDP outer header::
4848 testpmd> set mplsoudp_decap ip-version ipv4
4849 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4850 mplsoudp_decap / l2_encap / end
4852 IPv4 MPLSoUDP with VLAN outer header::
4854 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4855 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4856 actions mplsoudp_decap / l2_encap / end
4858 IPv6 MPLSoUDP outer header::
4860 testpmd> set mplsoudp_decap ip-version ipv6
4861 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4862 actions mplsoudp_decap / l2_encap / end
4864 IPv6 MPLSoUDP with VLAN outer header::
4866 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4867 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4868 actions mplsoudp_decap / l2_encap / end
4870 Sample Raw encapsulation rule
4871 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4873 Raw encapsulation configuration can be set by the following commands
4875 Encapsulating VxLAN::
4877 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4878 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4880 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4881 raw_encap index 4 / end
4883 Sample Raw decapsulation rule
4884 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4886 Raw decapsulation configuration can be set by the following commands
4888 Decapsulating VxLAN::
4890 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4891 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4892 end actions raw_decap / queue index 0 / end
4897 ESP rules can be created by the following commands::
4899 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
4901 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
4902 actions queue index 3 / end
4903 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
4905 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
4906 actions queue index 3 / end
4911 AH rules can be created by the following commands::
4913 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
4915 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
4916 actions queue index 3 / end
4917 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
4919 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
4920 actions queue index 3 / end
4925 PFCP rules can be created by the following commands(s_field need to be 1
4928 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
4929 actions queue index 3 / end
4930 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
4931 seid is 1 / end actions queue index 3 / end
4932 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
4933 actions queue index 3 / end
4934 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
4935 seid is 1 / end actions queue index 3 / end
4937 Sample Sampling/Mirroring rules
4938 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4940 Sample/Mirroring rules can be set by the following commands
4942 NIC-RX Sampling rule, the matched ingress packets and sent to the queue 1,
4943 and 50% packets are duplicated and marked with 0x1234 and sent to queue 0.
4947 testpmd> set sample_actions 0 mark id 0x1234 / queue index 0 / end
4948 testpmd> flow create 0 ingress group 1 pattern eth / end actions
4949 sample ratio 2 index 0 / queue index 1 / end
4951 Mirroring rule with port representors (with "transfer" attribute), the matched
4952 ingress packets with encapsulation header are sent to port id 0, and also
4953 mirrored the packets and sent to port id 2.
4957 testpmd> set sample_actions 0 port_id id 2 / end
4958 testpmd> flow create 1 ingress transfer pattern eth / end actions
4959 sample ratio 1 index 0 / raw_encap / port_id id 0 / end
4961 Mirroring rule with port representors (with "transfer" attribute), the matched
4962 ingress packets are sent to port id 2, and also mirrored the packets with
4963 encapsulation header and sent to port id 0.
4967 testpmd> set sample_actions 0 raw_encap / port_id id 0 / end
4968 testpmd> flow create 0 ingress transfer pattern eth / end actions
4969 sample ratio 1 index 0 / port_id id 2 / end
4971 Mirroring rule with port representors (with "transfer" attribute), the matched
4972 ingress packets are sent to port id 2, and also mirrored the packets with
4973 VXLAN encapsulation header and sent to port id 0.
4977 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4978 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4979 testpmd> set sample_actions 0 vxlan_encap / port_id id 0 / end
4980 testpmd> flow create 0 ingress transfer pattern eth / end actions
4981 sample ratio 1 index 0 / port_id id 2 / end
4983 Mirroring rule with port representors (with "transfer" attribute), the matched
4984 ingress packets are sent to port id 2, and also mirrored the packets with
4985 NVGRE encapsulation header and sent to port id 0.
4989 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4990 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4991 testpmd> set sample_actions 0 nvgre_encap / port_id id 0 / end
4992 testpmd> flow create 0 ingress transfer pattern eth / end actions
4993 sample ratio 1 index 0 / port_id id 2 / end
4995 Sample integrity rules
4996 ~~~~~~~~~~~~~~~~~~~~~~
4998 Integrity rules can be created by the following commands:
5000 Integrity rule that forwards valid TCP packets to group 1.
5001 TCP packet integrity is matched with the ``l4_ok`` bit 3.
5005 testpmd> flow create 0 ingress
5006 pattern eth / ipv4 / tcp / integrity value mask 8 value spec 8 / end
5007 actions jump group 1 / end
5009 Integrity rule that forwards invalid packets to application.
5010 General packet integrity is matched with the ``packet_ok`` bit 0.
5014 testpmd> flow create 0 ingress pattern integrity value mask 1 value spec 0 / end actions queue index 0 / end
5016 Sample conntrack rules
5017 ~~~~~~~~~~~~~~~~~~~~~~
5019 Conntrack rules can be set by the following commands
5021 Need to construct the connection context with provided information.
5022 In the first table, create a flow rule by using conntrack action and jump to
5023 the next table. In the next table, create a rule to check the state.
5027 testpmd> set conntrack com peer 1 is_orig 1 enable 1 live 1 sack 1 cack 0
5028 last_dir 0 liberal 0 state 1 max_ack_win 7 r_lim 5 last_win 510
5029 last_seq 2632987379 last_ack 2532480967 last_end 2632987379
5031 testpmd> set conntrack orig scale 7 fin 0 acked 1 unack_data 0
5032 sent_end 2632987379 reply_end 2633016339 max_win 28960
5034 testpmd> set conntrack rply scale 7 fin 0 acked 1 unack_data 0
5035 sent_end 2532480967 reply_end 2532546247 max_win 65280
5037 testpmd> flow indirect_action 0 create ingress action conntrack / end
5038 testpmd> flow create 0 group 3 ingress pattern eth / ipv4 / tcp / end actions indirect 0 / jump group 5 / end
5039 testpmd> flow create 0 group 5 ingress pattern eth / ipv4 / tcp / conntrack is 1 / end actions queue index 5 / end
5041 Construct the conntrack again with only "is_orig" set to 0 (other fields are
5042 ignored), then use "update" interface to update the direction. Create flow
5043 rules like above for the peer port.
5047 testpmd> flow indirect_action 0 update 0 action conntrack_update dir / end
5049 Sample meter with policy rules
5050 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5052 Meter with policy rules can be created by the following commands:
5054 Need to create policy first and actions are set for green/yellow/red colors.
5055 Create meter with policy id. Create flow with meter id.
5057 Example for policy with meter color action. The purpose is to color the packet
5058 to reflect the meter color result.
5059 The meter policy action list: ``green -> green, yellow -> yellow, red -> red``.
5063 testpmd> add port meter profile srtcm_rfc2697 0 13 21504 2688 0 0
5064 testpmd> add port meter policy 0 1 g_actions color type green / end y_actions color type yellow / end
5065 r_actions color type red / end
5066 testpmd> create port meter 0 1 13 1 yes 0xffff 0 0
5067 testpmd> flow create 0 priority 0 ingress group 1 pattern eth / end actions meter mtr_id 1 / end
5069 Sample PPPoL2TPv2oUDP RSS rules
5070 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5072 PPPoL2TPv2oUDP RSS rules can be created by the following commands::
5074 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4
5075 / end actions rss types ipv4 end queues end / end
5076 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv6
5077 / udp / end actions rss types ipv6-udp end queues end / end
5078 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv4
5079 / tcp / end actions rss types ipv4-tcp end queues end / end
5080 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv6
5081 / end actions rss types ipv6 end queues end / end
5086 The following sections show functions to load/unload eBPF based filters.
5091 Load an eBPF program as a callback for particular RX/TX queue::
5093 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
5095 The available load-flags are:
5097 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
5099 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
5105 You'll need clang v3.7 or above to build bpf program you'd like to load
5109 .. code-block:: console
5112 clang -O2 -target bpf -c t1.c
5114 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
5116 .. code-block:: console
5118 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
5120 To load (not JITed) t1.o at TX queue 0, port 0:
5122 .. code-block:: console
5124 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
5129 Unload previously loaded eBPF program for particular RX/TX queue::
5131 testpmd> bpf-unload rx|tx (portid) (queueid)
5133 For example to unload BPF filter from TX queue 0, port 0:
5135 .. code-block:: console
5137 testpmd> bpf-unload tx 0 0
5142 The following sections show functions that configure and create flex item object,
5143 create flex pattern and use it in a flow rule.
5144 The commands will use 20 bytes IPv4 header for examples:
5149 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
5150 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5151 | ver | IHL | TOS | length | +0
5152 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5153 | identification | flg | frag. offset | +4
5154 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5155 | TTL | protocol | checksum | +8
5156 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5157 | source IP address | +12
5158 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5159 | destination IP address | +16
5160 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5166 Flex item object is created by PMD according to a new header configuration. The
5167 header configuration is compiled by the testpmd and stored in
5168 ``rte_flow_item_flex_conf`` type variable.
5172 # flow flex_item create <port> <flex id> <configuration file>
5173 testpmd> flow flex_item init 0 3 ipv4_flex_config.json
5174 port-0: created flex item #3
5176 Flex item configuration is kept in external JSON file.
5177 It describes the following header elements:
5179 **New header length.**
5181 Specify whether the new header has fixed or variable length and the basic/minimal
5182 header length value.
5184 If header length is not fixed, header location with a value that completes header
5185 length calculation and scale/offset function must be added.
5187 Scale function depends on port hardware.
5191 Describes location in the new header that specify following network header type.
5193 **Flow match samples.**
5195 Describes locations in the new header that will be used in flow rules.
5197 Number of flow samples and sample maximal length depend of port hardware.
5201 Describes preceding network header configuration.
5205 Describes conditions that trigger transfer to following network header
5207 .. code-block:: json
5210 "next_header": { "field_mode": "FIELD_MODE_FIXED", "field_size": 20},
5211 "next_protocol": {"field_size": 8, "field_base": 72},
5213 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 0},
5214 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 32},
5215 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 64},
5216 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 96}
5219 {"item": "eth type is 0x0800"},
5220 {"item": "vlan inner_type is 0x0800"}
5223 {"item": "udp", "next": 17},
5224 {"item": "tcp", "next": 6},
5225 {"item": "icmp", "next": 1}
5230 Flex pattern and flow rules
5231 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
5233 Flex pattern describe parts of network header that will trigger flex flow item hit in a flow rule.
5234 Flex pattern directly related to flex item samples configuration.
5235 Flex pattern can be shared between ports.
5237 **Flex pattern and flow rule to match IPv4 version and 20 bytes length**
5241 # set flex_pattern <pattern_id> is <hex bytes sequence>
5242 testpmd> flow flex_item pattern 5 is 45FF
5245 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
5246 Flow rule #0 created
5248 **Flex pattern and flow rule to match packets with source address 1.2.3.4**
5252 testpmd> flow flex_item pattern 2 spec 45000000000000000000000001020304 mask FF0000000000000000000000FFFFFFFF
5255 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
5256 Flow rule #0 created