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
533 Show general information about devices probed::
535 testpmd> show device info (<identifier>|all)
539 .. code-block:: console
541 testpmd> show device info net_pcap0
543 ********************* Infos for device net_pcap0 *********************
545 Driver name: net_pcap
546 Devargs: iface=enP2p6s0,phy_mac=1
547 Connect to socket: -1
550 MAC address: 1E:37:93:28:04:B8
551 Device name: net_pcap0
556 Dumps all physical memory segment layouts::
558 testpmd> dump_physmem
563 Dumps the layout of all memory zones::
565 testpmd> dump_memzone
570 Dumps the memory usage of all sockets::
572 testpmd> dump_socket_mem
577 Dumps the size of all memory structures::
579 testpmd> dump_struct_sizes
584 Dumps the status of all or specific element in DPDK rings::
586 testpmd> dump_ring [ring_name]
591 Dumps the statistics of all or specific memory pool::
593 testpmd> dump_mempool [mempool_name]
598 Dumps the user device list::
600 testpmd> dump_devargs
605 Dumps the log level for all the dpdk modules::
607 testpmd> dump_log_types
609 show (raw_encap|raw_decap)
610 ~~~~~~~~~~~~~~~~~~~~~~~~~~
612 Display content of raw_encap/raw_decap buffers in hex::
614 testpmd> show <raw_encap|raw_decap> <index>
615 testpmd> show <raw_encap|raw_decap> all
619 testpmd> show raw_encap 6
621 index: 6 at [0x1c565b0], len=50
622 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
623 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
624 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
627 show fec capabilities
628 ~~~~~~~~~~~~~~~~~~~~~
630 Show fec capabilities of a port::
632 testpmd> show port (port_id) fec capabilities
637 Show fec mode of a port::
639 testpmd> show port (port_id) fec_mode
642 Configuration Functions
643 -----------------------
645 The testpmd application can be configured from the runtime as well as from the command-line.
647 This section details the available configuration functions that are available.
651 Configuration changes only become active when forwarding is started/restarted.
656 Reset forwarding to the default configuration::
663 Set the debug verbosity level::
665 testpmd> set verbose (level)
667 Available levels are as following:
669 * ``0`` silent except for error.
670 * ``1`` fully verbose except for Tx packets.
671 * ``2`` fully verbose except for Rx packets.
672 * ``> 2`` fully verbose.
677 Set the log level for a log type::
679 testpmd> set log global|(type) (level)
683 * ``type`` is the log name.
685 * ``level`` is the log level.
687 For example, to change the global log level::
689 testpmd> set log global (level)
691 Regexes can also be used for type. To change log level of user1, user2 and user3::
693 testpmd> set log user[1-3] (level)
698 Set the number of ports used by the application:
702 This is equivalent to the ``--nb-ports`` command-line option.
707 Set the number of cores used by the application::
709 testpmd> set nbcore (num)
711 This is equivalent to the ``--nb-cores`` command-line option.
715 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
720 Set the forwarding cores hexadecimal mask::
722 testpmd> set coremask (mask)
724 This is equivalent to the ``--coremask`` command-line option.
728 The main lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
733 Set the forwarding ports hexadecimal mask::
735 testpmd> set portmask (mask)
737 This is equivalent to the ``--portmask`` command-line option.
739 set record-core-cycles
740 ~~~~~~~~~~~~~~~~~~~~~~
742 Set the recording of CPU cycles::
744 testpmd> set record-core-cycles (on|off)
748 * ``on`` enables measurement of CPU cycles per packet.
750 * ``off`` disables measurement of CPU cycles per packet.
752 This is equivalent to the ``--record-core-cycles command-line`` option.
754 set record-burst-stats
755 ~~~~~~~~~~~~~~~~~~~~~~
757 Set the displaying of RX and TX bursts::
759 testpmd> set record-burst-stats (on|off)
763 * ``on`` enables display of RX and TX bursts.
765 * ``off`` disables display of RX and TX bursts.
767 This is equivalent to the ``--record-burst-stats command-line`` option.
772 Set number of packets per burst::
774 testpmd> set burst (num)
776 This is equivalent to the ``--burst command-line`` option.
778 When retry is enabled, the transmit delay time and number of retries can also be set::
780 testpmd> set burst tx delay (microseconds) retry (num)
785 Set the offsets of segments relating to the data buffer beginning on receiving
786 if split feature is engaged. Affects only the queues configured with split
787 offloads (currently BUFFER_SPLIT is supported only).
789 testpmd> set rxoffs (x[,y]*)
791 Where x[,y]* represents a CSV list of values, without white space. If the list
792 of offsets is shorter than the list of segments the zero offsets will be used
793 for the remaining segments.
798 Set the length of segments to scatter packets on receiving if split
799 feature is engaged. Affects only the queues configured with split offloads
800 (currently BUFFER_SPLIT is supported only). Optionally the multiple memory
801 pools can be specified with --mbuf-size command line parameter and the mbufs
802 to receive will be allocated sequentially from these extra memory pools (the
803 mbuf for the first segment is allocated from the first pool, the second one
804 from the second pool, and so on, if segment number is greater then pool's the
805 mbuf for remaining segments will be allocated from the last valid pool).
807 testpmd> set rxpkts (x[,y]*)
809 Where x[,y]* represents a CSV list of values, without white space. Zero value
810 means to use the corresponding memory pool data buffer size.
815 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
817 testpmd> set txpkts (x[,y]*)
819 Where x[,y]* represents a CSV list of values, without white space.
824 Configure the timing burst pattern for Tx only mode. This command enables
825 the packet send scheduling on dynamic timestamp mbuf field and configures
826 timing pattern in Tx only mode. In this mode, if scheduling is enabled
827 application provides timestamps in the packets being sent. It is possible
828 to configure delay (in unspecified device clock units) between bursts
829 and between the packets within the burst::
831 testpmd> set txtimes (inter),(intra)
835 * ``inter`` is the delay between the bursts in the device clock units.
836 If ``intra`` is zero, this is the time between the beginnings of the
837 first packets in the neighbour bursts, if ``intra`` is not zero,
838 ``inter`` specifies the time between the beginning of the first packet
839 of the current burst and the beginning of the last packet of the
840 previous burst. If ``inter`` parameter is zero the send scheduling
841 on timestamps is disabled (default).
843 * ``intra`` is the delay between the packets within the burst specified
844 in the device clock units. The number of packets in the burst is defined
845 by regular burst setting. If ``intra`` parameter is zero no timestamps
846 provided in the packets excepting the first one in the burst.
848 As the result the bursts of packet will be transmitted with specific
849 delays between the packets within the burst and specific delay between
850 the bursts. The rte_eth_read_clock() must be supported by the device(s)
851 and is supposed to be engaged to get the current device clock value
852 and provide the reference for the timestamps. If there is no supported
853 rte_eth_read_clock() there will be no send scheduling provided on the port.
858 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
860 testpmd> set txsplit (off|on|rand)
864 * ``off`` disable packet copy & split for CSUM mode.
866 * ``on`` split outgoing packet into multiple segments. Size of each segment
867 and number of segments per packet is determined by ``set txpkts`` command
870 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
875 Set the list of forwarding cores::
877 testpmd> set corelist (x[,y]*)
879 For example, to change the forwarding cores:
881 .. code-block:: console
883 testpmd> set corelist 3,1
884 testpmd> show config fwd
886 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
887 Logical Core 3 (socket 0) forwards packets on 1 streams:
888 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
889 Logical Core 1 (socket 0) forwards packets on 1 streams:
890 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
894 The cores are used in the same order as specified on the command line.
899 Set the list of forwarding ports::
901 testpmd> set portlist (x[,y]*)
903 For example, to change the port forwarding:
905 .. code-block:: console
907 testpmd> set portlist 0,2,1,3
908 testpmd> show config fwd
910 io packet forwarding - ports=4 - cores=1 - streams=4
911 Logical Core 3 (socket 0) forwards packets on 4 streams:
912 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
913 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
914 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
915 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
920 Select how to retrieve new ports created after "port attach" command::
922 testpmd> set port setup on (iterator|event)
924 For each new port, a setup is done.
925 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
926 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
931 Enable/disable tx loopback::
933 testpmd> set tx loopback (port_id) (on|off)
938 set drop enable bit for all queues::
940 testpmd> set all queues drop (port_id) (on|off)
942 set split drop enable (for VF)
943 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
945 set split drop enable bit for VF from PF::
947 testpmd> set vf split drop (port_id) (vf_id) (on|off)
949 set mac antispoof (for VF)
950 ~~~~~~~~~~~~~~~~~~~~~~~~~~
952 Set mac antispoof for a VF from the PF::
954 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
959 Enable/disable MACsec offload::
961 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
962 testpmd> set macsec offload (port_id) off
967 Configure MACsec secure connection (SC)::
969 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
973 The pi argument is ignored for tx.
974 Check the NIC Datasheet for hardware limits.
979 Configure MACsec secure association (SA)::
981 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
985 The IDX value must be 0 or 1.
986 Check the NIC Datasheet for hardware limits.
988 set broadcast mode (for VF)
989 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
991 Set broadcast mode for a VF from the PF::
993 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
998 Set the VLAN strip for a queue on a port::
1000 testpmd> vlan set stripq (on|off) (port_id,queue_id)
1002 vlan set stripq (for VF)
1003 ~~~~~~~~~~~~~~~~~~~~~~~~
1005 Set VLAN strip for all queues in a pool for a VF from the PF::
1007 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
1009 vlan set insert (for VF)
1010 ~~~~~~~~~~~~~~~~~~~~~~~~
1012 Set VLAN insert for a VF from the PF::
1014 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
1016 vlan set tag (for VF)
1017 ~~~~~~~~~~~~~~~~~~~~~
1019 Set VLAN tag for a VF from the PF::
1021 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
1023 vlan set antispoof (for VF)
1024 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1026 Set VLAN antispoof for a VF from the PF::
1028 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
1030 vlan set (strip|filter|qinq_strip|extend)
1031 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1032 Set the VLAN strip/filter/QinQ strip/extend on for a port::
1034 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
1039 Set the inner or outer VLAN TPID for packet filtering on a port::
1041 testpmd> vlan set (inner|outer) tpid (value) (port_id)
1045 TPID value must be a 16-bit number (value <= 65536).
1050 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
1052 testpmd> rx_vlan add (vlan_id|all) (port_id)
1056 VLAN filter must be set on that port. VLAN ID < 4096.
1057 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
1058 in VFTA table. This is important if enabling all vlan_ids.
1063 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
1065 testpmd> rx_vlan rm (vlan_id|all) (port_id)
1067 rx_vlan add (for VF)
1068 ~~~~~~~~~~~~~~~~~~~~
1070 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
1072 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
1077 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
1079 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
1084 Add an UDP port for VXLAN packet filter on a port::
1086 testpmd> rx_vxlan_port add (udp_port) (port_id)
1088 rx_vxlan_port remove
1089 ~~~~~~~~~~~~~~~~~~~~
1091 Remove an UDP port for VXLAN packet filter on a port::
1093 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1098 Set hardware insertion of VLAN IDs in packets sent on a port::
1100 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1102 For example, set a single VLAN ID (5) insertion on port 0::
1106 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1114 Set port based hardware insertion of VLAN ID in packets sent on a port::
1116 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1121 Disable hardware insertion of a VLAN header in packets sent on a port::
1123 testpmd> tx_vlan reset (port_id)
1128 Select hardware or software calculation of the checksum when
1129 transmitting a packet using the ``csum`` forwarding engine::
1131 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1135 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1137 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1138 as a tunnel packet by the forwarding engine (geneve, gre, gtp, ipip, vxlan and vxlan-gpe are
1139 supported). See also the ``csum parse-tunnel`` command.
1141 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1142 as a tunnel packet by the forwarding engine (geneve, gtp, vxlan and vxlan-gpe are
1143 supported). See also the ``csum parse-tunnel`` command.
1147 Check the NIC Datasheet for hardware limits.
1152 Set RSS queue region span on a port::
1154 testpmd> set port (port_id) queue-region region_id (value) \
1155 queue_start_index (value) queue_num (value)
1157 Set flowtype mapping on a RSS queue region on a port::
1159 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1163 * For the flowtype(pctype) of packet,the specific index for each type has
1164 been defined in file i40e_type.h as enum i40e_filter_pctype.
1166 Set user priority mapping on a RSS queue region on a port::
1168 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1170 Flush all queue region related configuration on a port::
1172 testpmd> set port (port_id) queue-region flush (on|off)
1176 * ``on``: is just an enable function which server for other configuration,
1177 it is for all configuration about queue region from up layer,
1178 at first will only keep in DPDK software stored in driver,
1179 only after "flush on", it commit all configuration to HW.
1181 * ``"off``: is just clean all configuration about queue region just now,
1182 and restore all to DPDK i40e driver default config when start up.
1184 Show all queue region related configuration info on a port::
1186 testpmd> show port (port_id) queue-region
1190 Queue region only support on PF by now, so these command is
1191 only for configuration of queue region on PF port.
1196 Define how tunneled packets should be handled by the csum forward
1199 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1201 If enabled, the csum forward engine will try to recognize supported
1202 tunnel headers (geneve, gtp, gre, ipip, vxlan, vxlan-gpe).
1204 If disabled, treat tunnel packets as non-tunneled packets (a inner
1205 header is handled as a packet payload).
1209 The port argument is the TX port like in the ``csum set`` command.
1213 Consider a packet in packet like the following::
1215 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1217 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1218 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1219 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1221 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1222 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1227 Display tx checksum offload configuration::
1229 testpmd> csum show (port_id)
1234 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1236 testpmd> tso set (segsize) (port_id)
1240 Check the NIC datasheet for hardware limits.
1245 Display the status of TCP Segmentation Offload::
1247 testpmd> tso show (port_id)
1252 Set tso segment size of tunneled packets for a port in csum engine::
1254 testpmd> tunnel_tso set (tso_segsz) (port_id)
1259 Display the status of tunneled TCP Segmentation Offload for a port::
1261 testpmd> tunnel_tso show (port_id)
1266 Enable or disable GRO in ``csum`` forwarding engine::
1268 testpmd> set port <port_id> gro on|off
1270 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1271 packets received from the given port.
1273 If disabled, packets received from the given port won't be performed
1274 GRO. By default, GRO is disabled for all ports.
1278 When enable GRO for a port, TCP/IPv4 packets received from the port
1279 will be performed GRO. After GRO, all merged packets have bad
1280 checksums, since the GRO library doesn't re-calculate checksums for
1281 the merged packets. Therefore, if users want the merged packets to
1282 have correct checksums, please select HW IP checksum calculation and
1283 HW TCP checksum calculation for the port which the merged packets are
1289 Display GRO configuration for a given port::
1291 testpmd> show port <port_id> gro
1296 Set the cycle to flush the GROed packets from reassembly tables::
1298 testpmd> set gro flush <cycles>
1300 When enable GRO, the csum forwarding engine performs GRO on received
1301 packets, and the GROed packets are stored in reassembly tables. Users
1302 can use this command to determine when the GROed packets are flushed
1303 from the reassembly tables.
1305 The ``cycles`` is measured in GRO operation times. The csum forwarding
1306 engine flushes the GROed packets from the tables every ``cycles`` GRO
1309 By default, the value of ``cycles`` is 1, which means flush GROed packets
1310 from the reassembly tables as soon as one GRO operation finishes. The value
1311 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1313 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1314 stack performance. Because the GROed packets are delayed to arrive the
1315 stack, thus causing more duplicated ACKs and TCP retransmissions.
1320 Toggle per-port GSO support in ``csum`` forwarding engine::
1322 testpmd> set port <port_id> gso on|off
1324 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1325 packets, transmitted on the given port.
1327 If disabled, packets transmitted on the given port will not undergo GSO.
1328 By default, GSO is disabled for all ports.
1332 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1333 port undergo GSO. Afterwards, the segmented packets are represented by
1334 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1335 of checksums for GSO'd segments in SW. As a result, if users want correct
1336 checksums in GSO segments, they should enable HW checksum calculation for
1339 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1340 by setting the following options in the csum forwarding engine:
1342 testpmd> csum set outer_ip hw <port_id>
1344 testpmd> csum set ip hw <port_id>
1346 testpmd> csum set tcp hw <port_id>
1348 UDP GSO is the same as IP fragmentation, which treats the UDP header
1349 as the payload and does not modify it during segmentation. That is,
1350 after UDP GSO, only the first output fragment has the original UDP
1351 header. Therefore, users need to enable HW IP checksum calculation
1352 and SW UDP checksum calculation for GSO-enabled ports, if they want
1353 correct checksums for UDP/IPv4 packets.
1358 Set the maximum GSO segment size (measured in bytes), which includes the
1359 packet header and the packet payload for GSO-enabled ports (global)::
1361 testpmd> set gso segsz <length>
1366 Display the status of Generic Segmentation Offload for a given port::
1368 testpmd> show port <port_id> gso
1373 Add an alternative MAC address to a port::
1375 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1380 Remove a MAC address from a port::
1382 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1387 To add the multicast MAC address to/from the set of multicast addresses
1390 testpmd> mcast_addr add (port_id) (mcast_addr)
1395 To remove the multicast MAC address to/from the set of multicast addresses
1398 testpmd> mcast_addr remove (port_id) (mcast_addr)
1400 mac_addr add (for VF)
1401 ~~~~~~~~~~~~~~~~~~~~~
1403 Add an alternative MAC address for a VF to a port::
1405 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1410 Set the default MAC address for a port::
1412 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1414 mac_addr set (for VF)
1415 ~~~~~~~~~~~~~~~~~~~~~
1417 Set the MAC address for a VF from the PF::
1419 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1424 Set the forwarding peer address for certain port::
1426 testpmd> set eth-peer (port_id) (peer_addr)
1428 This is equivalent to the ``--eth-peer`` command-line option.
1433 Set the unicast hash filter(s) on/off for a port::
1435 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1440 Set the promiscuous mode on for a port or for all ports.
1441 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1443 testpmd> set promisc (port_id|all) (on|off)
1448 Set the allmulti mode for a port or for all ports::
1450 testpmd> set allmulti (port_id|all) (on|off)
1452 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1454 set promisc (for VF)
1455 ~~~~~~~~~~~~~~~~~~~~
1457 Set the unicast promiscuous mode for a VF from PF.
1458 It's supported by Intel i40e NICs now.
1459 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1461 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1463 set allmulticast (for VF)
1464 ~~~~~~~~~~~~~~~~~~~~~~~~~
1466 Set the multicast 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 allmulti (port_id) (vf_id) (on|off)
1472 set tx max bandwidth (for VF)
1473 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1475 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1477 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1479 set tc tx min bandwidth (for VF)
1480 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1482 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1484 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1486 set tc tx max bandwidth (for VF)
1487 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1489 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1491 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1493 set tc strict link priority mode
1494 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1496 Set some TCs' strict link priority mode on a physical port::
1498 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1500 set tc tx min bandwidth
1501 ~~~~~~~~~~~~~~~~~~~~~~~
1503 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1505 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1510 Set the link flow control parameter on a port::
1512 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1513 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1514 autoneg (on|off) (port_id)
1518 * ``high_water`` (integer): High threshold value to trigger XOFF.
1520 * ``low_water`` (integer): Low threshold value to trigger XON.
1522 * ``pause_time`` (integer): Pause quota in the Pause frame.
1524 * ``send_xon`` (0/1): Send XON frame.
1526 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1528 * ``autoneg``: Change the auto-negotiation parameter.
1533 show the link flow control parameter on a port::
1535 testpmd> show port <port_id> flow_ctrl
1540 Set the priority flow control parameter on a port::
1542 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1543 (pause_time) (priority) (port_id)
1547 * ``high_water`` (integer): High threshold value.
1549 * ``low_water`` (integer): Low threshold value.
1551 * ``pause_time`` (integer): Pause quota in the Pause frame.
1553 * ``priority`` (0-7): VLAN User Priority.
1558 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1560 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1562 For example, to set rx queue 2 on port 0 to mapping 5::
1564 testpmd>set stat_qmap rx 0 2 5
1566 set xstats-hide-zero
1567 ~~~~~~~~~~~~~~~~~~~~
1569 Set the option to hide zero values for xstats display::
1571 testpmd> set xstats-hide-zero on|off
1575 By default, the zero values are displayed for xstats.
1577 set port - rx/tx (for VF)
1578 ~~~~~~~~~~~~~~~~~~~~~~~~~
1580 Set VF receive/transmit from a port::
1582 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1584 set port - rx mode(for VF)
1585 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1587 Set the VF receive mode of a port::
1589 testpmd> set port (port_id) vf (vf_id) \
1590 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1592 The available receive modes are:
1594 * ``AUPE``: Accepts untagged VLAN.
1596 * ``ROPE``: Accepts unicast hash.
1598 * ``BAM``: Accepts broadcast packets.
1600 * ``MPE``: Accepts all multicast packets.
1602 set port - tx_rate (for Queue)
1603 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1605 Set TX rate limitation for a queue on a port::
1607 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1609 set port - tx_rate (for VF)
1610 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1612 Set TX rate limitation for queues in VF on a port::
1614 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1619 Set the flush on RX streams before forwarding.
1620 The default is flush ``on``.
1621 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1623 testpmd> set flush_rx off
1628 Set the bypass mode for the lowest port on bypass enabled NIC::
1630 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1635 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1637 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1638 mode (normal|bypass|isolate) (port_id)
1642 * ``timeout``: Enable bypass after watchdog timeout.
1644 * ``os_on``: Enable bypass when OS/board is powered on.
1646 * ``os_off``: Enable bypass when OS/board is powered off.
1648 * ``power_on``: Enable bypass when power supply is turned on.
1650 * ``power_off``: Enable bypass when power supply is turned off.
1656 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1658 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1663 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1665 testpmd> show bypass config (port_id)
1670 Set link up for a port::
1672 testpmd> set link-up port (port id)
1677 Set link down for a port::
1679 testpmd> set link-down port (port id)
1684 Enable E-tag insertion for a VF on a port::
1686 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1688 Disable E-tag insertion for a VF on a port::
1690 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1692 Enable/disable E-tag stripping on a port::
1694 testpmd> E-tag set stripping (on|off) port (port_id)
1696 Enable/disable E-tag based forwarding on a port::
1698 testpmd> E-tag set forwarding (on|off) port (port_id)
1703 Load a dynamic device personalization (DDP) profile and store backup profile::
1705 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1710 Delete a dynamic device personalization profile and restore backup profile::
1712 testpmd> ddp del (port_id) (backup_profile_path)
1717 List all items from the ptype mapping table::
1719 testpmd> ptype mapping get (port_id) (valid_only)
1723 * ``valid_only``: A flag indicates if only list valid items(=1) or all items(=0).
1725 Replace a specific or a group of software defined ptype with a new one::
1727 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1731 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1733 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1735 * ``pkt_type``: The new software ptype to replace the old ones.
1737 Update hardware defined ptype to software defined packet type mapping table::
1739 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1743 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1745 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1747 Reset ptype mapping table::
1749 testpmd> ptype mapping reset (port_id)
1751 config per port Rx offloading
1752 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1754 Enable or disable a per port Rx offloading on all Rx queues of a port::
1756 testpmd> port config (port_id) rx_offload (offloading) on|off
1758 * ``offloading``: can be any of these offloading capability:
1759 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1760 qinq_strip, outer_ipv4_cksum, macsec_strip,
1761 header_split, vlan_filter, vlan_extend, jumbo_frame,
1762 scatter, timestamp, security, keep_crc, rss_hash
1764 This command should be run when the port is stopped, or else it will fail.
1766 config per queue Rx offloading
1767 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1769 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1771 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1773 * ``offloading``: can be any of these offloading capability:
1774 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1775 qinq_strip, outer_ipv4_cksum, macsec_strip,
1776 header_split, vlan_filter, vlan_extend, jumbo_frame,
1777 scatter, timestamp, security, keep_crc
1779 This command should be run when the port is stopped, or else it will fail.
1781 config per port Tx offloading
1782 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1784 Enable or disable a per port Tx offloading on all Tx queues of a port::
1786 testpmd> port config (port_id) tx_offload (offloading) on|off
1788 * ``offloading``: can be any of these offloading capability:
1789 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1790 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1791 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1792 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1793 mt_lockfree, multi_segs, mbuf_fast_free, security
1795 This command should be run when the port is stopped, or else it will fail.
1797 config per queue Tx offloading
1798 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1800 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1802 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1804 * ``offloading``: can be any of these offloading capability:
1805 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1806 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1807 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1808 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1809 mt_lockfree, multi_segs, mbuf_fast_free, security
1811 This command should be run when the port is stopped, or else it will fail.
1813 Config VXLAN Encap outer layers
1814 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1816 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1818 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1819 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1822 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1823 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1824 eth-src (eth-src) eth-dst (eth-dst)
1826 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1827 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1828 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1830 These commands will set an internal configuration inside testpmd, any following
1831 flow rule using the action vxlan_encap will use the last configuration set.
1832 To have a different encapsulation header, one of those commands must be called
1833 before the flow rule creation.
1835 Config NVGRE Encap outer layers
1836 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1838 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1840 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1841 eth-src (eth-src) eth-dst (eth-dst)
1842 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1843 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1845 These commands will set an internal configuration inside testpmd, any following
1846 flow rule using the action nvgre_encap will use the last configuration set.
1847 To have a different encapsulation header, one of those commands must be called
1848 before the flow rule creation.
1853 Configure the l2 to be used when encapsulating a packet with L2::
1855 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1856 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1857 eth-src (eth-src) eth-dst (eth-dst)
1859 Those commands will set an internal configuration inside testpmd, any following
1860 flow rule using the action l2_encap will use the last configuration set.
1861 To have a different encapsulation header, one of those commands must be called
1862 before the flow rule creation.
1867 Configure the l2 to be removed when decapsulating a packet with L2::
1869 set l2_decap ip-version (ipv4|ipv6)
1870 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1872 Those commands will set an internal configuration inside testpmd, any following
1873 flow rule using the action l2_decap will use the last configuration set.
1874 To have a different encapsulation header, one of those commands must be called
1875 before the flow rule creation.
1877 Config MPLSoGRE Encap outer layers
1878 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1880 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1882 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1883 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1884 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1885 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1886 eth-src (eth-src) eth-dst (eth-dst)
1888 These commands will set an internal configuration inside testpmd, any following
1889 flow rule using the action mplsogre_encap will use the last configuration set.
1890 To have a different encapsulation header, one of those commands must be called
1891 before the flow rule creation.
1893 Config MPLSoGRE Decap outer layers
1894 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1896 Configure the outer layer to decapsulate MPLSoGRE packet::
1898 set mplsogre_decap ip-version (ipv4|ipv6)
1899 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1901 These commands will set an internal configuration inside testpmd, any following
1902 flow rule using the action mplsogre_decap will use the last configuration set.
1903 To have a different decapsulation header, one of those commands must be called
1904 before the flow rule creation.
1906 Config MPLSoUDP Encap outer layers
1907 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1909 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1911 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1912 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1913 eth-src (eth-src) eth-dst (eth-dst)
1914 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1915 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1916 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1918 These commands will set an internal configuration inside testpmd, any following
1919 flow rule using the action mplsoudp_encap will use the last configuration set.
1920 To have a different encapsulation header, one of those commands must be called
1921 before the flow rule creation.
1923 Config MPLSoUDP Decap outer layers
1924 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1926 Configure the outer layer to decapsulate MPLSoUDP packet::
1928 set mplsoudp_decap ip-version (ipv4|ipv6)
1929 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
1931 These commands will set an internal configuration inside testpmd, any following
1932 flow rule using the action mplsoudp_decap will use the last configuration set.
1933 To have a different decapsulation header, one of those commands must be called
1934 before the flow rule creation.
1936 Config Raw Encapsulation
1937 ~~~~~~~~~~~~~~~~~~~~~~~~~
1939 Configure the raw data to be used when encapsulating a packet by
1940 rte_flow_action_raw_encap::
1942 set raw_encap {index} {item} [/ {item} [...]] / end_set
1944 There are multiple global buffers for ``raw_encap``, this command will set one
1945 internal buffer index by ``{index}``.
1946 If there is no ``{index}`` specified::
1948 set raw_encap {item} [/ {item} [...]] / end_set
1950 the default index ``0`` is used.
1951 In order to use different encapsulating header, ``index`` must be specified
1952 during the flow rule creation::
1954 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1955 raw_encap index 2 / end
1957 Otherwise the default index ``0`` is used.
1959 Config Raw Decapsulation
1960 ~~~~~~~~~~~~~~~~~~~~~~~~
1962 Configure the raw data to be used when decapsulating a packet by
1963 rte_flow_action_raw_decap::
1965 set raw_decap {index} {item} [/ {item} [...]] / end_set
1967 There are multiple global buffers for ``raw_decap``, this command will set
1968 one internal buffer index by ``{index}``.
1969 If there is no ``{index}`` specified::
1971 set raw_decap {item} [/ {item} [...]] / end_set
1973 the default index ``0`` is used.
1974 In order to use different decapsulating header, ``index`` must be specified
1975 during the flow rule creation::
1977 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
1978 raw_encap index 3 / end
1980 Otherwise the default index ``0`` is used.
1985 Set fec mode for a specific port::
1987 testpmd> set port (port_id) fec_mode auto|off|rs|baser
1989 Config Sample actions list
1990 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1992 Configure the sample actions list to be used when sampling a packet by
1993 rte_flow_action_sample::
1995 set sample_actions {index} {action} [/ {action} [...]] / end
1997 There are multiple global buffers for ``sample_actions``, this command will set
1998 one internal buffer index by ``{index}``.
2000 In order to use different sample actions list, ``index`` must be specified
2001 during the flow rule creation::
2003 testpmd> flow create 0 ingress pattern eth / ipv4 / end actions
2004 sample ratio 2 index 2 / end
2006 Otherwise the default index ``0`` is used.
2011 The following sections show functions for configuring ports.
2015 Port configuration changes only become active when forwarding is started/restarted.
2020 Attach a port specified by pci address or virtual device args::
2022 testpmd> port attach (identifier)
2024 To attach a new pci device, the device should be recognized by kernel first.
2025 Then it should be moved under DPDK management.
2026 Finally the port can be attached to testpmd.
2028 For example, to move a pci device using ixgbe under DPDK management:
2030 .. code-block:: console
2032 # Check the status of the available devices.
2033 ./usertools/dpdk-devbind.py --status
2035 Network devices using DPDK-compatible driver
2036 ============================================
2039 Network devices using kernel driver
2040 ===================================
2041 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
2044 # Bind the device to igb_uio.
2045 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
2048 # Recheck the status of the devices.
2049 ./usertools/dpdk-devbind.py --status
2050 Network devices using DPDK-compatible driver
2051 ============================================
2052 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
2054 To attach a port created by virtual device, above steps are not needed.
2056 For example, to attach a port whose pci address is 0000:0a:00.0.
2058 .. code-block:: console
2060 testpmd> port attach 0000:0a:00.0
2061 Attaching a new port...
2062 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2063 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
2064 EAL: PCI memory mapped at 0x7f83bfa00000
2065 EAL: PCI memory mapped at 0x7f83bfa80000
2066 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
2067 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
2068 Port 0 is attached. Now total ports is 1
2071 For example, to attach a port created by pcap PMD.
2073 .. code-block:: console
2075 testpmd> port attach net_pcap0
2076 Attaching a new port...
2077 PMD: Initializing pmd_pcap for net_pcap0
2078 PMD: Creating pcap-backed ethdev on numa socket 0
2079 Port 0 is attached. Now total ports is 1
2082 In this case, identifier is ``net_pcap0``.
2083 This identifier format is the same as ``--vdev`` format of DPDK applications.
2085 For example, to re-attach a bonded port which has been previously detached,
2086 the mode and slave parameters must be given.
2088 .. code-block:: console
2090 testpmd> port attach net_bond_0,mode=0,slave=1
2091 Attaching a new port...
2092 EAL: Initializing pmd_bond for net_bond_0
2093 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2094 Port 0 is attached. Now total ports is 1
2101 Detach a specific port::
2103 testpmd> port detach (port_id)
2105 Before detaching a port, the port should be stopped and closed.
2107 For example, to detach a pci device port 0.
2109 .. code-block:: console
2111 testpmd> port stop 0
2114 testpmd> port close 0
2118 testpmd> port detach 0
2120 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2121 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2122 EAL: PCI memory unmapped at 0x7f83bfa00000
2123 EAL: PCI memory unmapped at 0x7f83bfa80000
2127 For example, to detach a virtual device port 0.
2129 .. code-block:: console
2131 testpmd> port stop 0
2134 testpmd> port close 0
2138 testpmd> port detach 0
2140 PMD: Closing pcap ethdev on numa socket 0
2141 Port 'net_pcap0' is detached. Now total ports is 0
2144 To remove a pci device completely from the system, first detach the port from testpmd.
2145 Then the device should be moved under kernel management.
2146 Finally the device can be removed using kernel pci hotplug functionality.
2148 For example, to move a pci device under kernel management:
2150 .. code-block:: console
2152 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2154 ./usertools/dpdk-devbind.py --status
2156 Network devices using DPDK-compatible driver
2157 ============================================
2160 Network devices using kernel driver
2161 ===================================
2162 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2164 To remove a port created by a virtual device, above steps are not needed.
2169 Start all ports or a specific port::
2171 testpmd> port start (port_id|all)
2176 Stop all ports or a specific port::
2178 testpmd> port stop (port_id|all)
2183 Close all ports or a specific port::
2185 testpmd> port close (port_id|all)
2190 Reset all ports or a specific port::
2192 testpmd> port reset (port_id|all)
2194 User should stop port(s) before resetting and (re-)start after reset.
2196 port config - queue ring size
2197 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2199 Configure a rx/tx queue ring size::
2201 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2203 Only take effect after command that (re-)start the port or command that setup specific queue.
2205 port start/stop queue
2206 ~~~~~~~~~~~~~~~~~~~~~
2208 Start/stop a rx/tx queue on a specific port::
2210 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2212 port config - queue deferred start
2213 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2215 Switch on/off deferred start of a specific port queue::
2217 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2220 ~~~~~~~~~~~~~~~~~~~~~
2222 Setup a rx/tx queue on a specific port::
2224 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2226 Only take effect when port is started.
2231 Set the speed and duplex mode for all ports or a specific port::
2233 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \
2234 duplex (half|full|auto)
2236 port config - queues/descriptors
2237 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2239 Set number of queues/descriptors for rxq, txq, rxd and txd::
2241 testpmd> port config all (rxq|txq|rxd|txd) (value)
2243 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2245 port config - max-pkt-len
2246 ~~~~~~~~~~~~~~~~~~~~~~~~~
2248 Set the maximum packet length::
2250 testpmd> port config all max-pkt-len (value)
2252 This is equivalent to the ``--max-pkt-len`` command-line option.
2254 port config - max-lro-pkt-size
2255 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2257 Set the maximum LRO aggregated packet size::
2259 testpmd> port config all max-lro-pkt-size (value)
2261 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2263 port config - Drop Packets
2264 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2266 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2268 testpmd> port config all drop-en (on|off)
2270 Packet dropping when no receive buffers available is off by default.
2272 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2277 Set the RSS (Receive Side Scaling) mode on or off::
2279 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)
2281 RSS is on by default.
2283 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp.
2285 The ``default`` option enables all supported RSS types reported by device info.
2287 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2289 port config - RSS Reta
2290 ~~~~~~~~~~~~~~~~~~~~~~
2292 Set the RSS (Receive Side Scaling) redirection table::
2294 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2299 Set the DCB mode for an individual port::
2301 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2303 The traffic class should be 4 or 8.
2308 Set the number of packets per burst::
2310 testpmd> port config all burst (value)
2312 This is equivalent to the ``--burst`` command-line option.
2314 port config - Threshold
2315 ~~~~~~~~~~~~~~~~~~~~~~~
2317 Set thresholds for TX/RX queues::
2319 testpmd> port config all (threshold) (value)
2321 Where the threshold type can be:
2323 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2325 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2327 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2329 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2331 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2333 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2335 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2337 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2339 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2341 These threshold options are also available from the command-line.
2343 port config pctype mapping
2344 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2346 Reset pctype mapping table::
2348 testpmd> port config (port_id) pctype mapping reset
2350 Update hardware defined pctype to software defined flow type mapping table::
2352 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2356 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2358 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2360 port config input set
2361 ~~~~~~~~~~~~~~~~~~~~~
2363 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2365 testpmd> port config (port_id) pctype (pctype_id) \
2366 (hash_inset|fdir_inset|fdir_flx_inset) \
2367 (get|set|clear) field (field_idx)
2369 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2371 testpmd> port config (port_id) pctype (pctype_id) \
2372 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2376 * ``pctype_id``: hardware packet classification types.
2377 * ``field_idx``: hardware field index.
2379 port config udp_tunnel_port
2380 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2382 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2384 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe|ecpri (udp_port)
2386 port config tx_metadata
2387 ~~~~~~~~~~~~~~~~~~~~~~~
2389 Set Tx metadata value per port.
2390 testpmd will add this value to any Tx packet sent from this port::
2392 testpmd> port config (port_id) tx_metadata (value)
2397 Set/clear dynamic flag per port.
2398 testpmd will register this flag in the mbuf (same registration
2399 for both Tx and Rx). Then set/clear this flag for each Tx
2400 packet sent from this port. The set bit only works for Tx packet::
2402 testpmd> port config (port_id) dynf (name) (set|clear)
2407 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2409 testpmd> port config mtu (port_id) (value)
2411 port config rss hash key
2412 ~~~~~~~~~~~~~~~~~~~~~~~~
2414 To configure the RSS hash key used to compute the RSS
2415 hash of input [IP] packets received on port::
2417 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2418 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2419 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2420 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2421 ipv6-udp-ex <string of hex digits \
2422 (variable length, NIC dependent)>)
2424 port cleanup txq mbufs
2425 ~~~~~~~~~~~~~~~~~~~~~~
2427 To cleanup txq mbufs currently cached by driver::
2429 testpmd> port cleanup (port_id) txq (queue_id) (free_cnt)
2431 If the value of ``free_cnt`` is 0, driver should free all cached mbufs.
2436 The following sections show functions for device operations.
2441 Detach a device specified by pci address or virtual device args::
2443 testpmd> device detach (identifier)
2445 Before detaching a device associated with ports, the ports should be stopped and closed.
2447 For example, to detach a pci device whose address is 0002:03:00.0.
2449 .. code-block:: console
2451 testpmd> device detach 0002:03:00.0
2452 Removing a device...
2453 Port 1 is now closed
2454 EAL: Releasing pci mapped resource for 0002:03:00.0
2455 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2456 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2457 Device 0002:03:00.0 is detached
2458 Now total ports is 1
2460 For example, to detach a port created by pcap PMD.
2462 .. code-block:: console
2464 testpmd> device detach net_pcap0
2465 Removing a device...
2466 Port 0 is now closed
2467 Device net_pcap0 is detached
2468 Now total ports is 0
2471 In this case, identifier is ``net_pcap0``.
2472 This identifier format is the same as ``--vdev`` format of DPDK applications.
2474 Link Bonding Functions
2475 ----------------------
2477 The Link Bonding functions make it possible to dynamically create and
2478 manage link bonding devices from within testpmd interactive prompt.
2480 create bonded device
2481 ~~~~~~~~~~~~~~~~~~~~
2483 Create a new bonding device::
2485 testpmd> create bonded device (mode) (socket)
2487 For example, to create a bonded device in mode 1 on socket 0::
2489 testpmd> create bonded device 1 0
2490 created new bonded device (port X)
2495 Adds Ethernet device to a Link Bonding device::
2497 testpmd> add bonding slave (slave id) (port id)
2499 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2501 testpmd> add bonding slave 6 10
2504 remove bonding slave
2505 ~~~~~~~~~~~~~~~~~~~~
2507 Removes an Ethernet slave device from a Link Bonding device::
2509 testpmd> remove bonding slave (slave id) (port id)
2511 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2513 testpmd> remove bonding slave 6 10
2518 Set the Link Bonding mode of a Link Bonding device::
2520 testpmd> set bonding mode (value) (port id)
2522 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2524 testpmd> set bonding mode 3 10
2529 Set an Ethernet slave device as the primary device on a Link Bonding device::
2531 testpmd> set bonding primary (slave id) (port id)
2533 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2535 testpmd> set bonding primary 6 10
2540 Set the MAC address of a Link Bonding device::
2542 testpmd> set bonding mac (port id) (mac)
2544 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2546 testpmd> set bonding mac 10 00:00:00:00:00:01
2548 set bonding balance_xmit_policy
2549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2551 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2553 testpmd> set bonding balance_xmit_policy (port_id) (l2|l23|l34)
2555 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2557 testpmd> set bonding balance_xmit_policy 10 l34
2560 set bonding mon_period
2561 ~~~~~~~~~~~~~~~~~~~~~~
2563 Set the link status monitoring polling period in milliseconds for a bonding device.
2565 This adds support for PMD slave devices which do not support link status interrupts.
2566 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2567 link status ISR will be queried every polling interval to check if their link status has changed::
2569 testpmd> set bonding mon_period (port_id) (value)
2571 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2573 testpmd> set bonding mon_period 5 150
2576 set bonding lacp dedicated_queue
2577 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2579 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2580 when in mode 4 (link-aggregation-802.3ad)::
2582 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2585 set bonding agg_mode
2586 ~~~~~~~~~~~~~~~~~~~~
2588 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2590 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2596 Show the current configuration of a Link Bonding device::
2598 testpmd> show bonding config (port id)
2601 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2602 in balance mode with a transmission policy of layer 2+3::
2604 testpmd> show bonding config 9
2606 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2608 Active Slaves (3): [1 3 4]
2611 show bonding lacp info
2612 ~~~~~~~~~~~~~~~~~~~~~~
2614 Show information about the Link Bonding device in mode 4 (link-aggregation-802.3ad)::
2616 testpmd> show bonding lacp info (port_id)
2621 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2622 This is mainly useful for debugging purposes.
2623 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2624 and fields that can be accessed.
2629 Display the value of a port register::
2631 testpmd> read reg (port_id) (address)
2633 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2635 testpmd> read reg 0 0xEE00
2636 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2641 Display a port register bit field::
2643 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2645 For example, reading the lowest two bits from the register in the example above::
2647 testpmd> read regfield 0 0xEE00 0 1
2648 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2653 Display a single port register bit::
2655 testpmd> read regbit (port_id) (address) (bit_x)
2657 For example, reading the lowest bit from the register in the example above::
2659 testpmd> read regbit 0 0xEE00 0
2660 port 0 PCI register at offset 0xEE00: bit 0=1
2665 Set the value of a port register::
2667 testpmd> write reg (port_id) (address) (value)
2669 For example, to clear a register::
2671 testpmd> write reg 0 0xEE00 0x0
2672 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2677 Set bit field of a port register::
2679 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2681 For example, writing to the register cleared in the example above::
2683 testpmd> write regfield 0 0xEE00 0 1 2
2684 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2689 Set single bit value of a port register::
2691 testpmd> write regbit (port_id) (address) (bit_x) (value)
2693 For example, to set the high bit in the register from the example above::
2695 testpmd> write regbit 0 0xEE00 31 1
2696 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2698 Traffic Metering and Policing
2699 -----------------------------
2701 The following section shows functions for configuring traffic metering and
2702 policing on the ethernet device through the use of generic ethdev API.
2704 show port traffic management capability
2705 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2707 Show traffic metering and policing capability of the port::
2709 testpmd> show port meter cap (port_id)
2711 add port meter profile (srTCM rfc2967)
2712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2714 Add meter profile (srTCM rfc2697) to the ethernet device::
2716 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2717 (cir) (cbs) (ebs) (packet_mode)
2721 * ``profile_id``: ID for the meter profile.
2722 * ``cir``: Committed Information Rate (CIR) (bytes per second or packets per second).
2723 * ``cbs``: Committed Burst Size (CBS) (bytes or packets).
2724 * ``ebs``: Excess Burst Size (EBS) (bytes or packets).
2725 * ``packet_mode``: Packets mode for meter profile.
2727 add port meter profile (trTCM rfc2968)
2728 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2730 Add meter profile (srTCM rfc2698) to the ethernet device::
2732 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2733 (cir) (pir) (cbs) (pbs) (packet_mode)
2737 * ``profile_id``: ID for the meter profile.
2738 * ``cir``: Committed information rate (bytes per second or packets per second).
2739 * ``pir``: Peak information rate (bytes per second or packets per second).
2740 * ``cbs``: Committed burst size (bytes or packets).
2741 * ``pbs``: Peak burst size (bytes or packets).
2742 * ``packet_mode``: Packets mode for meter profile.
2744 add port meter profile (trTCM rfc4115)
2745 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2747 Add meter profile (trTCM rfc4115) to the ethernet device::
2749 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2750 (cir) (eir) (cbs) (ebs) (packet_mode)
2754 * ``profile_id``: ID for the meter profile.
2755 * ``cir``: Committed information rate (bytes per second or packets per second).
2756 * ``eir``: Excess information rate (bytes per second or packets per second).
2757 * ``cbs``: Committed burst size (bytes or packets).
2758 * ``ebs``: Excess burst size (bytes or packets).
2759 * ``packet_mode``: Packets mode for meter profile.
2761 delete port meter profile
2762 ~~~~~~~~~~~~~~~~~~~~~~~~~
2764 Delete meter profile from the ethernet device::
2766 testpmd> del port meter profile (port_id) (profile_id)
2771 Create new policy object for the ethernet device::
2773 testpmd> add port meter policy (port_id) (policy_id) g_actions \
2774 {action} y_actions {action} r_actions {action}
2778 * ``policy_id``: policy ID.
2779 * ``action``: action lists for green/yellow/red colors.
2784 Delete policy object for the ethernet device::
2786 testpmd> del port meter policy (port_id) (policy_id)
2790 * ``policy_id``: policy ID.
2795 Create new meter object for the ethernet device::
2797 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2798 (policy_id) (meter_enable) (stats_mask) (shared) \
2799 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2804 * ``mtr_id``: meter object ID.
2805 * ``profile_id``: ID for the meter profile.
2806 * ``policy_id``: ID for the policy.
2807 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2808 gets enabled at the time of creation, otherwise remains disabled.
2809 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2811 * ``shared``: When this parameter has a non-zero value, the meter object is
2812 shared by multiple flows. Otherwise, meter object is used by single flow.
2813 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2814 input color for the current meter object is determined by the latest meter
2815 object in the same flow. Otherwise, the current meter object uses the
2816 *dscp_table* to determine the input color.
2817 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2818 color, 0 <= x <= 63.
2823 Enable meter for the ethernet device::
2825 testpmd> enable port meter (port_id) (mtr_id)
2830 Disable meter for the ethernet device::
2832 testpmd> disable port meter (port_id) (mtr_id)
2837 Delete meter for the ethernet device::
2839 testpmd> del port meter (port_id) (mtr_id)
2841 Set port meter profile
2842 ~~~~~~~~~~~~~~~~~~~~~~
2844 Set meter profile for the ethernet device::
2846 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2848 set port meter dscp table
2849 ~~~~~~~~~~~~~~~~~~~~~~~~~
2851 Set meter dscp table for the ethernet device::
2853 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2854 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2856 set port meter stats mask
2857 ~~~~~~~~~~~~~~~~~~~~~~~~~
2859 Set meter stats mask for the ethernet device::
2861 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2865 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2867 show port meter stats
2868 ~~~~~~~~~~~~~~~~~~~~~
2870 Show meter stats of the ethernet device::
2872 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2876 * ``clear``: Flag that indicates whether the statistics counters should
2877 be cleared (i.e. set to zero) immediately after they have been read or not.
2882 The following section shows functions for configuring traffic management on
2883 the ethernet device through the use of generic TM API.
2885 show port traffic management capability
2886 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2888 Show traffic management capability of the port::
2890 testpmd> show port tm cap (port_id)
2892 show port traffic management capability (hierarchy level)
2893 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2895 Show traffic management hierarchy level capability of the port::
2897 testpmd> show port tm level cap (port_id) (level_id)
2899 show port traffic management capability (hierarchy node level)
2900 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2902 Show the traffic management hierarchy node capability of the port::
2904 testpmd> show port tm node cap (port_id) (node_id)
2906 show port traffic management hierarchy node type
2907 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2909 Show the port traffic management hierarchy node type::
2911 testpmd> show port tm node type (port_id) (node_id)
2913 show port traffic management hierarchy node stats
2914 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2916 Show the port traffic management hierarchy node statistics::
2918 testpmd> show port tm node stats (port_id) (node_id) (clear)
2922 * ``clear``: When this parameter has a non-zero value, the statistics counters
2923 are cleared (i.e. set to zero) immediately after they have been read,
2924 otherwise the statistics counters are left untouched.
2926 Add port traffic management private shaper profile
2927 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2929 Add the port traffic management private shaper profile::
2931 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2932 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2933 (packet_length_adjust) (packet_mode)
2937 * ``shaper_profile id``: Shaper profile ID for the new profile.
2938 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second or packets per second).
2939 * ``cmit_tb_size``: Committed token bucket size (bytes or packets).
2940 * ``peak_tb_rate``: Peak token bucket rate (bytes per second or packets per second).
2941 * ``peak_tb_size``: Peak token bucket size (bytes or packets).
2942 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2943 each packet for the purpose of shaping. This parameter value can be used to
2944 correct the packet length with the framing overhead bytes that are consumed
2946 * ``packet_mode``: Shaper configured in packet mode. This parameter value if
2947 zero, configures shaper in byte mode and if non-zero configures it in packet
2950 Delete port traffic management private shaper profile
2951 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2953 Delete the port traffic management private shaper::
2955 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
2959 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
2961 Add port traffic management shared shaper
2962 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2964 Create the port traffic management shared shaper::
2966 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
2971 * ``shared_shaper_id``: Shared shaper ID to be created.
2972 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2974 Set port traffic management shared shaper
2975 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2977 Update the port traffic management shared shaper::
2979 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
2984 * ``shared_shaper_id``: Shared shaper ID to be update.
2985 * ``shaper_profile id``: Shaper profile ID for shared shaper.
2987 Delete port traffic management shared shaper
2988 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2990 Delete the port traffic management shared shaper::
2992 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
2996 * ``shared_shaper_id``: Shared shaper ID to be deleted.
2998 Set port traffic management hierarchy node private shaper
2999 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3001 set the port traffic management hierarchy node private shaper::
3003 testpmd> set port tm node shaper profile (port_id) (node_id) \
3008 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
3011 Add port traffic management WRED profile
3012 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3014 Create a new WRED profile::
3016 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
3017 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
3018 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
3019 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
3023 * ``wred_profile id``: Identifier for the newly create WRED profile
3024 * ``color_g``: Packet color (green)
3025 * ``min_th_g``: Minimum queue threshold for packet with green color
3026 * ``max_th_g``: Minimum queue threshold for packet with green color
3027 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
3028 * ``wq_log2_g``: Negated log2 of queue weight (wq)
3029 * ``color_y``: Packet color (yellow)
3030 * ``min_th_y``: Minimum queue threshold for packet with yellow color
3031 * ``max_th_y``: Minimum queue threshold for packet with yellow color
3032 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
3033 * ``wq_log2_y``: Negated log2 of queue weight (wq)
3034 * ``color_r``: Packet color (red)
3035 * ``min_th_r``: Minimum queue threshold for packet with yellow color
3036 * ``max_th_r``: Minimum queue threshold for packet with yellow color
3037 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
3038 * ``wq_log2_r``: Negated log2 of queue weight (wq)
3040 Delete port traffic management WRED profile
3041 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3043 Delete the WRED profile::
3045 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
3047 Add port traffic management hierarchy nonleaf node
3048 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3050 Add nonleaf node to port traffic management hierarchy::
3052 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
3053 (priority) (weight) (level_id) (shaper_profile_id) \
3054 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3055 [(shared_shaper_0) (shared_shaper_1) ...] \
3059 * ``parent_node_id``: Node ID of the parent.
3060 * ``priority``: Node priority (highest node priority is zero). This is used by
3061 the SP algorithm running on the parent node for scheduling this node.
3062 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3063 to the weight sum of all siblings that have the same priority. It is used by
3064 the WFQ algorithm running on the parent node for scheduling this node.
3065 * ``level_id``: Hierarchy level of the node.
3066 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3068 * ``n_sp_priorities``: Number of strict priorities.
3069 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3070 * ``n_shared_shapers``: Number of shared shapers.
3071 * ``shared_shaper_id``: Shared shaper id.
3073 Add port traffic management hierarchy nonleaf node with packet mode
3074 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3076 Add nonleaf node with packet mode to port traffic management hierarchy::
3078 testpmd> add port tm nonleaf node pktmode (port_id) (node_id) (parent_node_id) \
3079 (priority) (weight) (level_id) (shaper_profile_id) \
3080 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3081 [(shared_shaper_0) (shared_shaper_1) ...] \
3085 * ``parent_node_id``: Node ID of the parent.
3086 * ``priority``: Node priority (highest node priority is zero). This is used by
3087 the SP algorithm running on the parent node for scheduling this node.
3088 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3089 to the weight sum of all siblings that have the same priority. It is used by
3090 the WFQ algorithm running on the parent node for scheduling this node.
3091 * ``level_id``: Hierarchy level of the node.
3092 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3094 * ``n_sp_priorities``: Number of strict priorities. Packet mode is enabled on
3096 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3097 * ``n_shared_shapers``: Number of shared shapers.
3098 * ``shared_shaper_id``: Shared shaper id.
3100 Add port traffic management hierarchy leaf node
3101 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3103 Add leaf node to port traffic management hierarchy::
3105 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
3106 (priority) (weight) (level_id) (shaper_profile_id) \
3107 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
3108 [(shared_shaper_id) (shared_shaper_id) ...] \
3112 * ``parent_node_id``: Node ID of the parent.
3113 * ``priority``: Node priority (highest node priority is zero). This is used by
3114 the SP algorithm running on the parent node for scheduling this node.
3115 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3116 to the weight sum of all siblings that have the same priority. It is used by
3117 the WFQ algorithm running on the parent node for scheduling this node.
3118 * ``level_id``: Hierarchy level of the node.
3119 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3121 * ``cman_mode``: Congestion management mode to be enabled for this node.
3122 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3123 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3124 * ``n_shared_shapers``: Number of shared shapers.
3125 * ``shared_shaper_id``: Shared shaper id.
3127 Delete port traffic management hierarchy node
3128 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3130 Delete node from port traffic management hierarchy::
3132 testpmd> del port tm node (port_id) (node_id)
3134 Update port traffic management hierarchy parent node
3135 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3137 Update port traffic management hierarchy parent node::
3139 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3142 This function can only be called after the hierarchy commit invocation. Its
3143 success depends on the port support for this operation, as advertised through
3144 the port capability set. This function is valid for all nodes of the traffic
3145 management hierarchy except root node.
3147 Suspend port traffic management hierarchy node
3148 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3150 testpmd> suspend port tm node (port_id) (node_id)
3152 Resume port traffic management hierarchy node
3153 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3155 testpmd> resume port tm node (port_id) (node_id)
3157 Commit port traffic management hierarchy
3158 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3160 Commit the traffic management hierarchy on the port::
3162 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3166 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3167 call failure. On the other hand, hierarchy is preserved when this parameter
3170 Set port traffic management mark VLAN dei
3171 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3173 Enables/Disables the traffic management marking on the port for VLAN packets::
3175 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3179 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3180 ``yellow`` or ``red`` will have dei bit enabled
3182 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3184 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3186 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3188 Set port traffic management mark IP dscp
3189 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3191 Enables/Disables the traffic management marking on the port for IP dscp packets::
3193 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3197 * ``port_id``: The port which on which IP packets marked as ``green`` or
3198 ``yellow`` or ``red`` will have IP dscp bits updated
3200 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3202 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3204 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3206 Set port traffic management mark IP ecn
3207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3209 Enables/Disables the traffic management marking on the port for IP ecn packets::
3211 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3215 * ``port_id``: The port which on which IP packets marked as ``green`` or
3216 ``yellow`` or ``red`` will have IP ecn bits updated
3218 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3219 to ecn of 2'b11 when IP is caring TCP or SCTP
3221 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3222 to ecn of 2'b11 when IP is caring TCP or SCTP
3224 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3225 to ecn of 2'b11 when IP is caring TCP or SCTP
3230 This section details the available filter functions that are available.
3232 Note these functions interface the deprecated legacy filtering framework,
3233 superseded by *rte_flow*. See `Flow rules management`_.
3235 .. _testpmd_flow_director:
3240 Set flow director's input masks::
3242 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3243 src_mask (ipv4_src) (ipv6_src) (src_port) \
3244 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3246 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3248 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3249 mac (mac_value) tunnel-type (tunnel_type_value) \
3250 tunnel-id (tunnel_id_value)
3252 Example, to set flow director mask on port 0::
3254 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3255 src_mask 255.255.255.255 \
3256 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3257 dst_mask 255.255.255.255 \
3258 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3260 flow_director_flex_payload
3261 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3263 Configure flexible payload selection::
3265 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3267 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3269 testpmd> flow_director_flex_payload 0 l4 \
3270 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3273 .. _testpmd_rte_flow:
3275 Flow rules management
3276 ---------------------
3278 Control of the generic flow API (*rte_flow*) is fully exposed through the
3279 ``flow`` command (validation, creation, destruction, queries and operation
3282 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3283 features simultaneously may cause undefined side-effects and is therefore
3289 Because the ``flow`` command uses dynamic tokens to handle the large number
3290 of possible flow rules combinations, its behavior differs slightly from
3291 other commands, in particular:
3293 - Pressing *?* or the *<tab>* key displays contextual help for the current
3294 token, not that of the entire command.
3296 - Optional and repeated parameters are supported (provided they are listed
3297 in the contextual help).
3299 The first parameter stands for the operation mode. Possible operations and
3300 their general syntax are described below. They are covered in detail in the
3303 - Check whether a flow rule can be created::
3305 flow validate {port_id}
3306 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3307 pattern {item} [/ {item} [...]] / end
3308 actions {action} [/ {action} [...]] / end
3310 - Create a flow rule::
3312 flow create {port_id}
3313 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3314 pattern {item} [/ {item} [...]] / end
3315 actions {action} [/ {action} [...]] / end
3317 - Destroy specific flow rules::
3319 flow destroy {port_id} rule {rule_id} [...]
3321 - Destroy all flow rules::
3323 flow flush {port_id}
3325 - Query an existing flow rule::
3327 flow query {port_id} {rule_id} {action}
3329 - List existing flow rules sorted by priority, filtered by group
3332 flow list {port_id} [group {group_id}] [...]
3334 - Restrict ingress traffic to the defined flow rules::
3336 flow isolate {port_id} {boolean}
3338 - Dump internal representation information of all flows in hardware::
3340 flow dump {port_id} all {output_file}
3344 flow dump {port_id} rule {rule_id} {output_file}
3346 - List and destroy aged flow rules::
3348 flow aged {port_id} [destroy]
3350 - Tunnel offload - create a tunnel stub::
3352 flow tunnel create {port_id} type {tunnel_type}
3354 - Tunnel offload - destroy a tunnel stub::
3356 flow tunnel destroy {port_id} id {tunnel_id}
3358 - Tunnel offload - list port tunnel stubs::
3360 flow tunnel list {port_id}
3362 Creating a tunnel stub for offload
3363 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3365 ``flow tunnel create`` setup a tunnel stub for tunnel offload flow rules::
3367 flow tunnel create {port_id} type {tunnel_type}
3369 If successful, it will return a tunnel stub ID usable with other commands::
3371 port [...]: flow tunnel #[...] type [...]
3373 Tunnel stub ID is relative to a port.
3375 Destroying tunnel offload stub
3376 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3378 ``flow tunnel destroy`` destroy port tunnel stub::
3380 flow tunnel destroy {port_id} id {tunnel_id}
3382 Listing tunnel offload stubs
3383 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3385 ``flow tunnel list`` list port tunnel offload stubs::
3387 flow tunnel list {port_id}
3389 Validating flow rules
3390 ~~~~~~~~~~~~~~~~~~~~~
3392 ``flow validate`` reports whether a flow rule would be accepted by the
3393 underlying device in its current state but stops short of creating it. It is
3394 bound to ``rte_flow_validate()``::
3396 flow validate {port_id}
3397 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3398 pattern {item} [/ {item} [...]] / end
3399 actions {action} [/ {action} [...]] / end
3401 If successful, it will show::
3405 Otherwise it will show an error message of the form::
3407 Caught error type [...] ([...]): [...]
3409 This command uses the same parameters as ``flow create``, their format is
3410 described in `Creating flow rules`_.
3412 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3413 index 6 is supported::
3415 testpmd> flow validate 0 ingress pattern eth / end
3416 actions queue index 6 / end
3420 Port 0 does not support TCPv6 rules::
3422 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3424 Caught error type 9 (specific pattern item): Invalid argument
3430 ``flow create`` validates and creates the specified flow rule. It is bound
3431 to ``rte_flow_create()``::
3433 flow create {port_id}
3434 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3435 [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}]
3436 pattern {item} [/ {item} [...]] / end
3437 actions {action} [/ {action} [...]] / end
3439 If successful, it will return a flow rule ID usable with other commands::
3441 Flow rule #[...] created
3443 Otherwise it will show an error message of the form::
3445 Caught error type [...] ([...]): [...]
3447 Parameters describe in the following order:
3449 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3450 - Tunnel offload specification (tunnel_set, tunnel_match)
3451 - A matching pattern, starting with the *pattern* token and terminated by an
3453 - Actions, starting with the *actions* token and terminated by an *end*
3456 These translate directly to *rte_flow* objects provided as-is to the
3457 underlying functions.
3459 The shortest valid definition only comprises mandatory tokens::
3461 testpmd> flow create 0 pattern end actions end
3463 Note that PMDs may refuse rules that essentially do nothing such as this
3466 **All unspecified object values are automatically initialized to 0.**
3471 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3472 specified before the ``pattern`` token.
3474 - ``group {group id}``: priority group.
3475 - ``priority {level}``: priority level within group.
3476 - ``ingress``: rule applies to ingress traffic.
3477 - ``egress``: rule applies to egress traffic.
3478 - ``transfer``: apply rule directly to endpoints found in pattern.
3480 Each instance of an attribute specified several times overrides the previous
3481 value as shown below (group 4 is used)::
3483 testpmd> flow create 0 group 42 group 24 group 4 [...]
3485 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3487 While not specifying a direction is an error, some rules may allow both
3490 Most rules affect RX therefore contain the ``ingress`` token::
3492 testpmd> flow create 0 ingress pattern [...]
3497 Indicate tunnel offload rule type
3499 - ``tunnel_set {tunnel_id}``: mark rule as tunnel offload decap_set type.
3500 - ``tunnel_match {tunnel_id}``: mark rule as tunel offload match type.
3505 A matching pattern starts after the ``pattern`` token. It is made of pattern
3506 items and is terminated by a mandatory ``end`` item.
3508 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3509 rte_flow_item_type``).
3511 The ``/`` token is used as a separator between pattern items as shown
3514 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3516 Note that protocol items like these must be stacked from lowest to highest
3517 layer to make sense. For instance, the following rule is either invalid or
3518 unlikely to match any packet::
3520 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3522 More information on these restrictions can be found in the *rte_flow*
3525 Several items support additional specification structures, for example
3526 ``ipv4`` allows specifying source and destination addresses as follows::
3528 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3529 dst is 10.2.0.0 / end [...]
3531 This rule matches all IPv4 traffic with the specified properties.
3533 In this example, ``src`` and ``dst`` are field names of the underlying
3534 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3535 in a similar fashion.
3537 The ``is`` token means that the subsequent value must be matched exactly,
3538 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3539 accordingly. Possible assignment tokens are:
3541 - ``is``: match value perfectly (with full bit-mask).
3542 - ``spec``: match value according to configured bit-mask.
3543 - ``last``: specify upper bound to establish a range.
3544 - ``mask``: specify bit-mask with relevant bits set to one.
3545 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3547 These yield identical results::
3549 ipv4 src is 10.1.1.1
3553 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3557 ipv4 src spec 10.1.1.1 src prefix 32
3561 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
3565 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
3567 Inclusive ranges can be defined with ``last``::
3569 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
3571 Note that ``mask`` affects both ``spec`` and ``last``::
3573 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
3574 # matches 10.1.0.0 to 10.2.255.255
3576 Properties can be modified multiple times::
3578 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
3582 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
3587 This section lists supported pattern items and their attributes, if any.
3589 - ``end``: end list of pattern items.
3591 - ``void``: no-op pattern item.
3593 - ``invert``: perform actions when pattern does not match.
3595 - ``any``: match any protocol for the current layer.
3597 - ``num {unsigned}``: number of layers covered.
3599 - ``pf``: match traffic from/to the physical function.
3601 - ``vf``: match traffic from/to a virtual function ID.
3603 - ``id {unsigned}``: VF ID.
3605 - ``phy_port``: match traffic from/to a specific physical port.
3607 - ``index {unsigned}``: physical port index.
3609 - ``port_id``: match traffic from/to a given DPDK port ID.
3611 - ``id {unsigned}``: DPDK port ID.
3613 - ``mark``: match value set in previously matched flow rule using the mark action.
3615 - ``id {unsigned}``: arbitrary integer value.
3617 - ``raw``: match an arbitrary byte string.
3619 - ``relative {boolean}``: look for pattern after the previous item.
3620 - ``search {boolean}``: search pattern from offset (see also limit).
3621 - ``offset {integer}``: absolute or relative offset for pattern.
3622 - ``limit {unsigned}``: search area limit for start of pattern.
3623 - ``pattern {string}``: byte string to look for.
3625 - ``eth``: match Ethernet header.
3627 - ``dst {MAC-48}``: destination MAC.
3628 - ``src {MAC-48}``: source MAC.
3629 - ``type {unsigned}``: EtherType or TPID.
3631 - ``vlan``: match 802.1Q/ad VLAN tag.
3633 - ``tci {unsigned}``: tag control information.
3634 - ``pcp {unsigned}``: priority code point.
3635 - ``dei {unsigned}``: drop eligible indicator.
3636 - ``vid {unsigned}``: VLAN identifier.
3637 - ``inner_type {unsigned}``: inner EtherType or TPID.
3639 - ``ipv4``: match IPv4 header.
3641 - ``version_ihl {unsigned}``: IPv4 version and IP header length.
3642 - ``tos {unsigned}``: type of service.
3643 - ``ttl {unsigned}``: time to live.
3644 - ``proto {unsigned}``: next protocol ID.
3645 - ``src {ipv4 address}``: source address.
3646 - ``dst {ipv4 address}``: destination address.
3648 - ``ipv6``: match IPv6 header.
3650 - ``tc {unsigned}``: traffic class.
3651 - ``flow {unsigned}``: flow label.
3652 - ``proto {unsigned}``: protocol (next header).
3653 - ``hop {unsigned}``: hop limit.
3654 - ``src {ipv6 address}``: source address.
3655 - ``dst {ipv6 address}``: destination address.
3657 - ``icmp``: match ICMP header.
3659 - ``type {unsigned}``: ICMP packet type.
3660 - ``code {unsigned}``: ICMP packet code.
3662 - ``udp``: match UDP header.
3664 - ``src {unsigned}``: UDP source port.
3665 - ``dst {unsigned}``: UDP destination port.
3667 - ``tcp``: match TCP header.
3669 - ``src {unsigned}``: TCP source port.
3670 - ``dst {unsigned}``: TCP destination port.
3672 - ``sctp``: match SCTP header.
3674 - ``src {unsigned}``: SCTP source port.
3675 - ``dst {unsigned}``: SCTP destination port.
3676 - ``tag {unsigned}``: validation tag.
3677 - ``cksum {unsigned}``: checksum.
3679 - ``vxlan``: match VXLAN header.
3681 - ``vni {unsigned}``: VXLAN identifier.
3682 - ``last_rsvd {unsigned}``: VXLAN last reserved 8-bits.
3684 - ``e_tag``: match IEEE 802.1BR E-Tag header.
3686 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
3688 - ``nvgre``: match NVGRE header.
3690 - ``tni {unsigned}``: virtual subnet ID.
3692 - ``mpls``: match MPLS header.
3694 - ``label {unsigned}``: MPLS label.
3696 - ``gre``: match GRE header.
3698 - ``protocol {unsigned}``: protocol type.
3700 - ``gre_key``: match GRE optional key field.
3702 - ``value {unsigned}``: key value.
3704 - ``fuzzy``: fuzzy pattern match, expect faster than default.
3706 - ``thresh {unsigned}``: accuracy threshold.
3708 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
3710 - ``teid {unsigned}``: tunnel endpoint identifier.
3712 - ``geneve``: match GENEVE header.
3714 - ``vni {unsigned}``: virtual network identifier.
3715 - ``protocol {unsigned}``: protocol type.
3717 - ``geneve-opt``: match GENEVE header option.
3719 - ``class {unsigned}``: GENEVE option class.
3720 - ``type {unsigned}``: GENEVE option type.
3721 - ``length {unsigned}``: GENEVE option length in 32-bit words.
3722 - ``data {hex string}``: GENEVE option data, the length is defined by
3725 - ``vxlan-gpe``: match VXLAN-GPE header.
3727 - ``vni {unsigned}``: VXLAN-GPE identifier.
3729 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
3731 - ``sha {MAC-48}``: sender hardware address.
3732 - ``spa {ipv4 address}``: sender IPv4 address.
3733 - ``tha {MAC-48}``: target hardware address.
3734 - ``tpa {ipv4 address}``: target IPv4 address.
3736 - ``ipv6_ext``: match presence of any IPv6 extension header.
3738 - ``next_hdr {unsigned}``: next header.
3740 - ``icmp6``: match any ICMPv6 header.
3742 - ``type {unsigned}``: ICMPv6 type.
3743 - ``code {unsigned}``: ICMPv6 code.
3745 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
3747 - ``target_addr {ipv6 address}``: target address.
3749 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
3751 - ``target_addr {ipv6 address}``: target address.
3753 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
3755 - ``type {unsigned}``: ND option type.
3757 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
3758 link-layer address option.
3760 - ``sla {MAC-48}``: source Ethernet LLA.
3762 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
3763 link-layer address option.
3765 - ``tla {MAC-48}``: target Ethernet LLA.
3767 - ``meta``: match application specific metadata.
3769 - ``data {unsigned}``: metadata value.
3771 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
3773 - ``pdu_type {unsigned}``: PDU type.
3775 - ``qfi {unsigned}``: QoS flow identifier.
3777 - ``pppoes``, ``pppoed``: match PPPoE header.
3779 - ``session_id {unsigned}``: session identifier.
3781 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
3783 - ``proto_id {unsigned}``: PPP protocol identifier.
3785 - ``l2tpv3oip``: match L2TPv3 over IP header.
3787 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
3789 - ``ah``: match AH header.
3791 - ``spi {unsigned}``: security parameters index.
3793 - ``pfcp``: match PFCP header.
3795 - ``s_field {unsigned}``: S field.
3796 - ``seid {unsigned}``: session endpoint identifier.
3798 - ``integrity``: match packet integrity.
3800 - ``level {unsigned}``: Packet encapsulation level the item should
3801 apply to. See rte_flow_action_rss for details.
3802 - ``value {unsigned}``: A bitmask that specify what packet elements
3803 must be matched for integrity.
3805 - ``conntrack``: match conntrack state.
3807 - ``port_representor``: match traffic entering the embedded switch from the given ethdev
3809 - ``port_id {unsigned}``: ethdev port ID
3811 - ``represented_port``: match traffic entering the embedded switch from
3812 the entity represented by the given ethdev
3814 - ``ethdev_port_id {unsigned}``: ethdev port ID
3816 - ``l2tpv2``: match L2TPv2 header.
3818 - ``length {unsigned}``: L2TPv2 option length.
3819 - ``tunnel_id {unsigned}``: L2TPv2 tunnel identifier.
3820 - ``session_id {unsigned}``: L2TPv2 session identifier.
3821 - ``ns {unsigned}``: L2TPv2 option ns.
3822 - ``nr {unsigned}``: L2TPv2 option nr.
3824 - ``ppp``: match PPP header.
3826 - ``addr {unsigned}``: PPP address.
3827 - ``ctrl {unsigned}``: PPP control.
3828 - ``proto_id {unsigned}``: PPP protocol identifier.
3833 A list of actions starts after the ``actions`` token in the same fashion as
3834 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
3835 terminated by a mandatory ``end`` action.
3837 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
3838 rte_flow_action_type``).
3840 Dropping all incoming UDPv4 packets can be expressed as follows::
3842 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3845 Several actions have configurable properties which must be specified when
3846 there is no valid default value. For example, ``queue`` requires a target
3849 This rule redirects incoming UDPv4 traffic to queue index 6::
3851 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3852 actions queue index 6 / end
3854 While this one could be rejected by PMDs (unspecified queue index)::
3856 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
3859 As defined by *rte_flow*, the list is not ordered, all actions of a given
3860 rule are performed simultaneously. These are equivalent::
3862 queue index 6 / void / mark id 42 / end
3866 void / mark id 42 / queue index 6 / end
3868 All actions in a list should have different types, otherwise only the last
3869 action of a given type is taken into account::
3871 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
3875 drop / drop / drop / end # drop is performed only once
3879 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
3881 Considering they are performed simultaneously, opposite and overlapping
3882 actions can sometimes be combined when the end result is unambiguous::
3884 drop / queue index 6 / end # drop has no effect
3888 queue index 6 / rss queues 6 7 8 / end # queue has no effect
3892 drop / passthru / end # drop has no effect
3894 Note that PMDs may still refuse such combinations.
3899 This section lists supported actions and their attributes, if any.
3901 - ``end``: end list of actions.
3903 - ``void``: no-op action.
3905 - ``passthru``: let subsequent rule process matched packets.
3907 - ``jump``: redirect traffic to group on device.
3909 - ``group {unsigned}``: group to redirect to.
3911 - ``mark``: attach 32 bit value to packets.
3913 - ``id {unsigned}``: 32 bit value to return with packets.
3915 - ``flag``: flag packets.
3917 - ``queue``: assign packets to a given queue index.
3919 - ``index {unsigned}``: queue index to use.
3921 - ``drop``: drop packets (note: passthru has priority).
3923 - ``count``: enable counters for this rule.
3925 - ``rss``: spread packets among several queues.
3927 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
3928 ``toeplitz``, ``simple_xor``, ``symmetric_toeplitz`` and ``default``.
3930 - ``level {unsigned}``: encapsulation level for ``types``.
3932 - ``types [{RSS hash type} [...]] end``: specific RSS hash types.
3933 Note that an empty list does not disable RSS but instead requests
3934 unspecified "best-effort" settings.
3936 - ``key {string}``: RSS hash key, overrides ``key_len``.
3938 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
3939 conjunction with ``key`` to pad or truncate it.
3941 - ``queues [{unsigned} [...]] end``: queue indices to use.
3943 - ``pf``: direct traffic to physical function.
3945 - ``vf``: direct traffic to a virtual function ID.
3947 - ``original {boolean}``: use original VF ID if possible.
3948 - ``id {unsigned}``: VF ID.
3950 - ``phy_port``: direct packets to physical port index.
3952 - ``original {boolean}``: use original port index if possible.
3953 - ``index {unsigned}``: physical port index.
3955 - ``port_id``: direct matching traffic to a given DPDK port ID.
3957 - ``original {boolean}``: use original DPDK port ID if possible.
3958 - ``id {unsigned}``: DPDK port ID.
3960 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
3962 - ``mpls_ttl``: MPLS TTL.
3964 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
3966 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
3968 - ``nw_ttl``: IP TTL.
3970 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
3972 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
3974 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
3976 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
3978 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
3980 - ``ethertype``: Ethertype.
3982 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
3984 - ``vlan_vid``: VLAN id.
3986 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
3988 - ``vlan_pcp``: VLAN priority.
3990 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
3992 - ``ethertype``: Ethertype.
3994 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
3996 - ``ethertype``: Ethertype.
3998 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
3999 is done through `Config VXLAN Encap outer layers`_.
4001 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4002 the VXLAN tunnel network overlay from the matched flow.
4004 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4005 is done through `Config NVGRE Encap outer layers`_.
4007 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4008 the NVGRE tunnel network overlay from the matched flow.
4010 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4011 is done through `Config L2 Encap`_.
4013 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4014 is done through `Config L2 Decap`_.
4016 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4017 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4019 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4020 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4022 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4023 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4025 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4026 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4028 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4030 - ``ipv4_addr``: New IPv4 source address.
4032 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4035 - ``ipv4_addr``: New IPv4 destination address.
4037 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4039 - ``ipv6_addr``: New IPv6 source address.
4041 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4044 - ``ipv6_addr``: New IPv6 destination address.
4046 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4049 - ``port``: New TCP/UDP source port number.
4051 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4054 - ``port``: New TCP/UDP destination port number.
4056 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4059 - ``dec_ttl``: Performs a decrease TTL value action
4061 - ``set_ttl``: Set TTL value with specified value
4062 - ``ttl_value {unsigned}``: The new TTL value to be set
4064 - ``set_mac_src``: set source MAC address
4066 - ``mac_addr {MAC-48}``: new source MAC address
4068 - ``set_mac_dst``: set destination MAC address
4070 - ``mac_addr {MAC-48}``: new destination MAC address
4072 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4074 - ``value {unsigned}``: Value to increase TCP sequence number by.
4076 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4078 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4080 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4082 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4084 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4086 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4088 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4090 - ``dscp_value {unsigned}``: The new DSCP value to be set
4092 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4094 - ``dscp_value {unsigned}``: The new DSCP value to be set
4096 - ``indirect``: Use indirect action created via
4097 ``flow indirect_action {port_id} create``
4099 - ``indirect_action_id {unsigned}``: Indirect action ID to use
4101 - ``color``: Color the packet to reflect the meter color result
4103 - ``type {value}``: Set color type with specified value(green/yellow/red)
4105 - ``port_representor``: at embedded switch level, send matching traffic to
4108 - ``port_id {unsigned}``: ethdev port ID
4110 - ``represented_port``: at embedded switch level, send matching traffic to
4111 the entity represented by the given ethdev
4113 - ``ethdev_port_id {unsigned}``: ethdev port ID
4115 Destroying flow rules
4116 ~~~~~~~~~~~~~~~~~~~~~
4118 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4119 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4120 times as necessary::
4122 flow destroy {port_id} rule {rule_id} [...]
4124 If successful, it will show::
4126 Flow rule #[...] destroyed
4128 It does not report anything for rule IDs that do not exist. The usual error
4129 message is shown when a rule cannot be destroyed::
4131 Caught error type [...] ([...]): [...]
4133 ``flow flush`` destroys all rules on a device and does not take extra
4134 arguments. It is bound to ``rte_flow_flush()``::
4136 flow flush {port_id}
4138 Any errors are reported as above.
4140 Creating several rules and destroying them::
4142 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4143 actions queue index 2 / end
4144 Flow rule #0 created
4145 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4146 actions queue index 3 / end
4147 Flow rule #1 created
4148 testpmd> flow destroy 0 rule 0 rule 1
4149 Flow rule #1 destroyed
4150 Flow rule #0 destroyed
4153 The same result can be achieved using ``flow flush``::
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 flush 0
4164 Non-existent rule IDs are ignored::
4166 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4167 actions queue index 2 / end
4168 Flow rule #0 created
4169 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4170 actions queue index 3 / end
4171 Flow rule #1 created
4172 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4174 testpmd> flow destroy 0 rule 0
4175 Flow rule #0 destroyed
4181 ``flow query`` queries a specific action of a flow rule having that
4182 ability. Such actions collect information that can be reported using this
4183 command. It is bound to ``rte_flow_query()``::
4185 flow query {port_id} {rule_id} {action}
4187 If successful, it will display either the retrieved data for known actions
4188 or the following message::
4190 Cannot display result for action type [...] ([...])
4192 Otherwise, it will complain either that the rule does not exist or that some
4195 Flow rule #[...] not found
4199 Caught error type [...] ([...]): [...]
4201 Currently only the ``count`` action is supported. This action reports the
4202 number of packets that hit the flow rule and the total number of bytes. Its
4203 output has the following format::
4206 hits_set: [...] # whether "hits" contains a valid value
4207 bytes_set: [...] # whether "bytes" contains a valid value
4208 hits: [...] # number of packets
4209 bytes: [...] # number of bytes
4211 Querying counters for TCPv6 packets redirected to queue 6::
4213 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4214 actions queue index 6 / count / end
4215 Flow rule #4 created
4216 testpmd> flow query 0 4 count
4227 ``flow list`` lists existing flow rules sorted by priority and optionally
4228 filtered by group identifiers::
4230 flow list {port_id} [group {group_id}] [...]
4232 This command only fails with the following message if the device does not
4237 Output consists of a header line followed by a short description of each
4238 flow rule, one per line. There is no output at all when no flow rules are
4239 configured on the device::
4241 ID Group Prio Attr Rule
4242 [...] [...] [...] [...] [...]
4244 ``Attr`` column flags:
4246 - ``i`` for ``ingress``.
4247 - ``e`` for ``egress``.
4249 Creating several flow rules and listing them::
4251 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4252 actions queue index 6 / end
4253 Flow rule #0 created
4254 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4255 actions queue index 2 / end
4256 Flow rule #1 created
4257 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4258 actions rss queues 6 7 8 end / end
4259 Flow rule #2 created
4260 testpmd> flow list 0
4261 ID Group Prio Attr Rule
4262 0 0 0 i- ETH IPV4 => QUEUE
4263 1 0 0 i- ETH IPV6 => QUEUE
4264 2 0 5 i- ETH IPV4 UDP => RSS
4267 Rules are sorted by priority (i.e. group ID first, then priority level)::
4269 testpmd> flow list 1
4270 ID Group Prio Attr Rule
4271 0 0 0 i- ETH => COUNT
4272 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4273 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4274 1 24 0 i- ETH IPV4 UDP => QUEUE
4275 4 24 10 i- ETH IPV4 TCP => DROP
4276 3 24 20 i- ETH IPV4 => DROP
4277 2 24 42 i- ETH IPV4 UDP => QUEUE
4278 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4281 Output can be limited to specific groups::
4283 testpmd> flow list 1 group 0 group 63
4284 ID Group Prio Attr Rule
4285 0 0 0 i- ETH => COUNT
4286 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4287 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4288 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4291 Toggling isolated mode
4292 ~~~~~~~~~~~~~~~~~~~~~~
4294 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4295 must only be injected from the defined flow rules; that no default traffic
4296 is expected outside those rules and the driver is free to assign more
4297 resources to handle them. It is bound to ``rte_flow_isolate()``::
4299 flow isolate {port_id} {boolean}
4301 If successful, enabling or disabling isolated mode shows either::
4303 Ingress traffic on port [...]
4304 is now restricted to the defined flow rules
4308 Ingress traffic on port [...]
4309 is not restricted anymore to the defined flow rules
4311 Otherwise, in case of error::
4313 Caught error type [...] ([...]): [...]
4315 Mainly due to its side effects, PMDs supporting this mode may not have the
4316 ability to toggle it more than once without reinitializing affected ports
4317 first (e.g. by exiting testpmd).
4319 Enabling isolated mode::
4321 testpmd> flow isolate 0 true
4322 Ingress traffic on port 0 is now restricted to the defined flow rules
4325 Disabling isolated mode::
4327 testpmd> flow isolate 0 false
4328 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4331 Dumping HW internal information
4332 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4334 ``flow dump`` dumps the hardware's internal representation information of
4335 all flows. It is bound to ``rte_flow_dev_dump()``::
4337 flow dump {port_id} {output_file}
4339 If successful, it will show::
4343 Otherwise, it will complain error occurred::
4345 Caught error type [...] ([...]): [...]
4347 Listing and destroying aged flow rules
4348 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4350 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4351 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4353 flow aged {port_id} [destroy]
4355 Listing current aged flow rules::
4357 testpmd> flow aged 0
4358 Port 0 total aged flows: 0
4359 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4360 actions age timeout 5 / queue index 0 / end
4361 Flow rule #0 created
4362 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4363 actions age timeout 4 / queue index 0 / end
4364 Flow rule #1 created
4365 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4366 actions age timeout 2 / queue index 0 / end
4367 Flow rule #2 created
4368 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4369 actions age timeout 3 / queue index 0 / end
4370 Flow rule #3 created
4373 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4374 information, all the aged flows are sorted by the longest timeout time. For example, if
4375 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4376 will be ID 3, ID 1, ID 0::
4378 testpmd> flow aged 0
4379 Port 0 total aged flows: 4
4386 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4388 testpmd> flow aged 0 destroy
4389 Port 0 total aged flows: 4
4396 Flow rule #2 destroyed
4397 Flow rule #3 destroyed
4398 Flow rule #1 destroyed
4399 Flow rule #0 destroyed
4400 4 flows be destroyed
4401 testpmd> flow aged 0
4402 Port 0 total aged flows: 0
4404 Creating indirect actions
4405 ~~~~~~~~~~~~~~~~~~~~~~~~~
4407 ``flow indirect_action {port_id} create`` creates indirect action with optional
4408 indirect action ID. It is bound to ``rte_flow_action_handle_create()``::
4410 flow indirect_action {port_id} create [action_id {indirect_action_id}]
4411 [ingress] [egress] [transfer] action {action} / end
4413 If successful, it will show::
4415 Indirect action #[...] created
4417 Otherwise, it will complain either that indirect action already exists or that
4418 some error occurred::
4420 Indirect action #[...] is already assigned, delete it first
4424 Caught error type [...] ([...]): [...]
4426 Create indirect rss action with id 100 to queues 1 and 2 on port 0::
4428 testpmd> flow indirect_action 0 create action_id 100 \
4429 ingress action rss queues 1 2 end / end
4431 Create indirect rss action with id assigned by testpmd to queues 1 and 2 on
4434 testpmd> flow indirect_action 0 create action_id \
4435 ingress action rss queues 0 1 end / end
4437 Updating indirect actions
4438 ~~~~~~~~~~~~~~~~~~~~~~~~~
4440 ``flow indirect_action {port_id} update`` updates configuration of the indirect
4441 action from its indirect action ID (as returned by
4442 ``flow indirect_action {port_id} create``). It is bound to
4443 ``rte_flow_action_handle_update()``::
4445 flow indirect_action {port_id} update {indirect_action_id}
4446 action {action} / end
4448 If successful, it will show::
4450 Indirect action #[...] updated
4452 Otherwise, it will complain either that indirect action not found or that some
4455 Failed to find indirect action #[...] on port [...]
4459 Caught error type [...] ([...]): [...]
4461 Update indirect rss action having id 100 on port 0 with rss to queues 0 and 3
4462 (in create example above rss queues were 1 and 2)::
4464 testpmd> flow indirect_action 0 update 100 action rss queues 0 3 end / end
4466 Destroying indirect actions
4467 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
4469 ``flow indirect_action {port_id} destroy`` destroys one or more indirect actions
4470 from their indirect action IDs (as returned by
4471 ``flow indirect_action {port_id} create``). It is bound to
4472 ``rte_flow_action_handle_destroy()``::
4474 flow indirect_action {port_id} destroy action_id {indirect_action_id} [...]
4476 If successful, it will show::
4478 Indirect action #[...] destroyed
4480 It does not report anything for indirect action IDs that do not exist.
4481 The usual error message is shown when a indirect action cannot be destroyed::
4483 Caught error type [...] ([...]): [...]
4485 Destroy indirect actions having id 100 & 101::
4487 testpmd> flow indirect_action 0 destroy action_id 100 action_id 101
4489 Query indirect actions
4490 ~~~~~~~~~~~~~~~~~~~~~~
4492 ``flow indirect_action {port_id} query`` queries the indirect action from its
4493 indirect action ID (as returned by ``flow indirect_action {port_id} create``).
4494 It is bound to ``rte_flow_action_handle_query()``::
4496 flow indirect_action {port_id} query {indirect_action_id}
4498 Currently only rss indirect action supported. If successful, it will show::
4500 Indirect RSS action:
4503 Otherwise, it will complain either that indirect action not found or that some
4506 Failed to find indirect action #[...] on port [...]
4510 Caught error type [...] ([...]): [...]
4512 Query indirect action having id 100::
4514 testpmd> flow indirect_action 0 query 100
4516 Sample QinQ flow rules
4517 ~~~~~~~~~~~~~~~~~~~~~~
4519 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4521 testpmd> port stop 0
4522 testpmd> vlan set extend on 0
4524 The above command sets the inner and outer TPID's to 0x8100.
4526 To change the TPID's the following commands should be used::
4528 testpmd> vlan set outer tpid 0x88A8 0
4529 testpmd> vlan set inner tpid 0x8100 0
4530 testpmd> port start 0
4532 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4536 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4537 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4538 Flow rule #0 validated
4540 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4541 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4542 Flow rule #0 created
4544 testpmd> flow list 0
4545 ID Group Prio Attr Rule
4546 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4548 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4552 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4553 vlan tci is 654 / end actions pf / queue index 0 / end
4554 Flow rule #1 validated
4556 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4557 vlan tci is 654 / end actions pf / queue index 1 / end
4558 Flow rule #1 created
4560 testpmd> flow list 0
4561 ID Group Prio Attr Rule
4562 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4563 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4565 Sample VXLAN flow rules
4566 ~~~~~~~~~~~~~~~~~~~~~~~
4568 Before creating VXLAN rule(s), the UDP port should be added for VXLAN packet
4571 testpmd> rx_vxlan_port add 4789 0
4573 Create VXLAN rules on port 0 to steer traffic to PF queues.
4577 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
4578 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 1 / end
4579 Flow rule #0 created
4581 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 3 /
4582 eth dst is 00:11:22:33:44:55 / end actions pf / queue index 2 / end
4583 Flow rule #1 created
4585 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan /
4586 eth dst is 00:11:22:33:44:55 / vlan tci is 10 / end actions pf /
4588 Flow rule #2 created
4590 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 5 /
4591 eth dst is 00:11:22:33:44:55 / vlan tci is 20 / end actions pf /
4593 Flow rule #3 created
4595 testpmd> flow create 0 ingress pattern eth dst is 00:00:00:00:01:00 / ipv4 /
4596 udp / vxlan vni is 6 / eth dst is 00:11:22:33:44:55 / end actions pf /
4598 Flow rule #4 created
4600 testpmd> flow list 0
4601 ID Group Prio Attr Rule
4602 0 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4603 1 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4604 2 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
4605 3 0 0 i- ETH IPV4 UDP VXLAN ETH VLAN => QUEUE
4606 4 0 0 i- ETH IPV4 UDP VXLAN ETH => QUEUE
4608 Sample VXLAN encapsulation rule
4609 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4611 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4612 source code, those can be changed by using the following commands
4614 IPv4 VXLAN outer header::
4616 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4617 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4618 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4621 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4622 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4623 eth-dst 22:22:22:22:22:22
4624 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4627 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4628 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4629 eth-dst 22:22:22:22:22:22
4630 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4633 IPv6 VXLAN outer header::
4635 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4636 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4637 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4640 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4641 ip-src ::1 ip-dst ::2222 vlan-tci 34 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 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4647 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4648 eth-dst 22:22:22:22:22:22
4649 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4652 Sample NVGRE encapsulation rule
4653 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4655 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4656 source code, those can be changed by using the following commands
4658 IPv4 NVGRE outer header::
4660 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4661 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4662 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4665 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4666 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4667 eth-dst 22:22:22:22:22:22
4668 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4671 IPv6 NVGRE outer header::
4673 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
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 ipv6 tni 4 ip-src ::1 ip-dst ::2222
4679 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4680 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4683 Sample L2 encapsulation rule
4684 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4686 L2 encapsulation has default value pre-configured in testpmd
4687 source code, those can be changed by using the following commands
4691 testpmd> set l2_encap ip-version ipv4
4692 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4693 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4694 mplsoudp_decap / l2_encap / end
4696 L2 with VXLAN header::
4698 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
4699 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4700 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4701 mplsoudp_decap / l2_encap / end
4703 Sample L2 decapsulation rule
4704 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4706 L2 decapsulation has default value pre-configured in testpmd
4707 source code, those can be changed by using the following commands
4711 testpmd> set l2_decap
4712 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
4715 L2 with VXLAN header::
4717 testpmd> set l2_encap-with-vlan
4718 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
4721 Sample MPLSoGRE encapsulation rule
4722 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4724 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
4725 source code, those can be changed by using the following commands
4727 IPv4 MPLSoGRE outer header::
4729 testpmd> set mplsogre_encap ip-version ipv4 label 4
4730 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4731 eth-dst 22:22:22:22:22:22
4732 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4733 mplsogre_encap / end
4735 IPv4 MPLSoGRE with VLAN outer header::
4737 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
4738 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4739 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4740 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4741 mplsogre_encap / end
4743 IPv6 MPLSoGRE outer header::
4745 testpmd> set mplsogre_encap ip-version ipv6 mask 4
4746 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4747 eth-dst 22:22:22:22:22:22
4748 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4749 mplsogre_encap / end
4751 IPv6 MPLSoGRE with VLAN outer header::
4753 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
4754 ip-src ::1 ip-dst ::2222 vlan-tci 34
4755 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4756 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4757 mplsogre_encap / end
4759 Sample MPLSoGRE decapsulation rule
4760 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4762 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
4763 source code, those can be changed by using the following commands
4765 IPv4 MPLSoGRE outer header::
4767 testpmd> set mplsogre_decap ip-version ipv4
4768 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
4769 mplsogre_decap / l2_encap / end
4771 IPv4 MPLSoGRE with VLAN outer header::
4773 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
4774 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
4775 actions mplsogre_decap / l2_encap / end
4777 IPv6 MPLSoGRE outer header::
4779 testpmd> set mplsogre_decap ip-version ipv6
4780 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
4781 actions mplsogre_decap / l2_encap / end
4783 IPv6 MPLSoGRE with VLAN outer header::
4785 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
4786 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
4787 actions mplsogre_decap / l2_encap / end
4789 Sample MPLSoUDP encapsulation rule
4790 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4792 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
4793 source code, those can be changed by using the following commands
4795 IPv4 MPLSoUDP outer header::
4797 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
4798 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4799 eth-dst 22:22:22:22:22:22
4800 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4801 mplsoudp_encap / end
4803 IPv4 MPLSoUDP with VLAN outer header::
4805 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
4806 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
4807 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4808 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4809 mplsoudp_encap / end
4811 IPv6 MPLSoUDP outer header::
4813 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
4814 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4815 eth-dst 22:22:22:22:22:22
4816 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4817 mplsoudp_encap / end
4819 IPv6 MPLSoUDP with VLAN outer header::
4821 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
4822 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
4823 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4824 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
4825 mplsoudp_encap / end
4827 Sample MPLSoUDP decapsulation rule
4828 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4830 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
4831 source code, those can be changed by using the following commands
4833 IPv4 MPLSoUDP outer header::
4835 testpmd> set mplsoudp_decap ip-version ipv4
4836 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
4837 mplsoudp_decap / l2_encap / end
4839 IPv4 MPLSoUDP with VLAN outer header::
4841 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
4842 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
4843 actions mplsoudp_decap / l2_encap / end
4845 IPv6 MPLSoUDP outer header::
4847 testpmd> set mplsoudp_decap ip-version ipv6
4848 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
4849 actions mplsoudp_decap / l2_encap / end
4851 IPv6 MPLSoUDP with VLAN outer header::
4853 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
4854 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
4855 actions mplsoudp_decap / l2_encap / end
4857 Sample Raw encapsulation rule
4858 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4860 Raw encapsulation configuration can be set by the following commands
4862 Encapsulating VxLAN::
4864 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
4865 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
4867 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
4868 raw_encap index 4 / end
4870 Sample Raw decapsulation rule
4871 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4873 Raw decapsulation configuration can be set by the following commands
4875 Decapsulating VxLAN::
4877 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
4878 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
4879 end actions raw_decap / queue index 0 / end
4884 ESP rules can be created by the following commands::
4886 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
4888 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
4889 actions queue index 3 / end
4890 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
4892 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
4893 actions queue index 3 / end
4898 AH rules can be created by the following commands::
4900 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
4902 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
4903 actions queue index 3 / end
4904 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
4906 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
4907 actions queue index 3 / end
4912 PFCP rules can be created by the following commands(s_field need to be 1
4915 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
4916 actions queue index 3 / end
4917 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
4918 seid is 1 / end actions queue index 3 / end
4919 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
4920 actions queue index 3 / end
4921 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
4922 seid is 1 / end actions queue index 3 / end
4924 Sample Sampling/Mirroring rules
4925 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4927 Sample/Mirroring rules can be set by the following commands
4929 NIC-RX Sampling rule, the matched ingress packets and sent to the queue 1,
4930 and 50% packets are duplicated and marked with 0x1234 and sent to queue 0.
4934 testpmd> set sample_actions 0 mark id 0x1234 / queue index 0 / end
4935 testpmd> flow create 0 ingress group 1 pattern eth / end actions
4936 sample ratio 2 index 0 / queue index 1 / end
4938 Mirroring rule with port representors (with "transfer" attribute), the matched
4939 ingress packets with encapsulation header are sent to port id 0, and also
4940 mirrored the packets and sent to port id 2.
4944 testpmd> set sample_actions 0 port_id id 2 / end
4945 testpmd> flow create 1 ingress transfer pattern eth / end actions
4946 sample ratio 1 index 0 / raw_encap / port_id id 0 / end
4948 Mirroring rule with port representors (with "transfer" attribute), the matched
4949 ingress packets are sent to port id 2, and also mirrored the packets with
4950 encapsulation header and sent to port id 0.
4954 testpmd> set sample_actions 0 raw_encap / port_id id 0 / end
4955 testpmd> flow create 0 ingress transfer pattern eth / end actions
4956 sample ratio 1 index 0 / port_id id 2 / end
4958 Mirroring rule with port representors (with "transfer" attribute), the matched
4959 ingress packets are sent to port id 2, and also mirrored the packets with
4960 VXLAN encapsulation header and sent to port id 0.
4964 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4965 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4966 testpmd> set sample_actions 0 vxlan_encap / port_id id 0 / end
4967 testpmd> flow create 0 ingress transfer pattern eth / end actions
4968 sample ratio 1 index 0 / port_id id 2 / end
4970 Mirroring rule with port representors (with "transfer" attribute), the matched
4971 ingress packets are sent to port id 2, and also mirrored the packets with
4972 NVGRE encapsulation header and sent to port id 0.
4976 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4977 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4978 testpmd> set sample_actions 0 nvgre_encap / port_id id 0 / end
4979 testpmd> flow create 0 ingress transfer pattern eth / end actions
4980 sample ratio 1 index 0 / port_id id 2 / end
4982 Sample integrity rules
4983 ~~~~~~~~~~~~~~~~~~~~~~
4985 Integrity rules can be created by the following commands:
4987 Integrity rule that forwards valid TCP packets to group 1.
4988 TCP packet integrity is matched with the ``l4_ok`` bit 3.
4992 testpmd> flow create 0 ingress
4993 pattern eth / ipv4 / tcp / integrity value mask 8 value spec 8 / end
4994 actions jump group 1 / end
4996 Integrity rule that forwards invalid packets to application.
4997 General packet integrity is matched with the ``packet_ok`` bit 0.
5001 testpmd> flow create 0 ingress pattern integrity value mask 1 value spec 0 / end actions queue index 0 / end
5003 Sample conntrack rules
5004 ~~~~~~~~~~~~~~~~~~~~~~
5006 Conntrack rules can be set by the following commands
5008 Need to construct the connection context with provided information.
5009 In the first table, create a flow rule by using conntrack action and jump to
5010 the next table. In the next table, create a rule to check the state.
5014 testpmd> set conntrack com peer 1 is_orig 1 enable 1 live 1 sack 1 cack 0
5015 last_dir 0 liberal 0 state 1 max_ack_win 7 r_lim 5 last_win 510
5016 last_seq 2632987379 last_ack 2532480967 last_end 2632987379
5018 testpmd> set conntrack orig scale 7 fin 0 acked 1 unack_data 0
5019 sent_end 2632987379 reply_end 2633016339 max_win 28960
5021 testpmd> set conntrack rply scale 7 fin 0 acked 1 unack_data 0
5022 sent_end 2532480967 reply_end 2532546247 max_win 65280
5024 testpmd> flow indirect_action 0 create ingress action conntrack / end
5025 testpmd> flow create 0 group 3 ingress pattern eth / ipv4 / tcp / end actions indirect 0 / jump group 5 / end
5026 testpmd> flow create 0 group 5 ingress pattern eth / ipv4 / tcp / conntrack is 1 / end actions queue index 5 / end
5028 Construct the conntrack again with only "is_orig" set to 0 (other fields are
5029 ignored), then use "update" interface to update the direction. Create flow
5030 rules like above for the peer port.
5034 testpmd> flow indirect_action 0 update 0 action conntrack_update dir / end
5036 Sample meter with policy rules
5037 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5039 Meter with policy rules can be created by the following commands:
5041 Need to create policy first and actions are set for green/yellow/red colors.
5042 Create meter with policy id. Create flow with meter id.
5044 Example for policy with meter color action. The purpose is to color the packet
5045 to reflect the meter color result.
5046 The meter policy action list: ``green -> green, yellow -> yellow, red -> red``.
5050 testpmd> add port meter profile srtcm_rfc2697 0 13 21504 2688 0 0
5051 testpmd> add port meter policy 0 1 g_actions color type green / end y_actions color type yellow / end
5052 r_actions color type red / end
5053 testpmd> create port meter 0 1 13 1 yes 0xffff 0 0
5054 testpmd> flow create 0 priority 0 ingress group 1 pattern eth / end actions meter mtr_id 1 / end
5056 Sample PPPoL2TPv2oUDP RSS rules
5057 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5059 PPPoL2TPv2oUDP RSS rules can be created by the following commands::
5061 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv4
5062 / end actions rss types ipv4 end queues end / end
5063 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / l2tpv2 / ppp / ipv6
5064 / udp / end actions rss types ipv6-udp end queues end / end
5065 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv4
5066 / tcp / end actions rss types ipv4-tcp end queues end / end
5067 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / l2tpv2 / ppp / ipv6
5068 / end actions rss types ipv6 end queues end / end
5073 The following sections show functions to load/unload eBPF based filters.
5078 Load an eBPF program as a callback for particular RX/TX queue::
5080 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
5082 The available load-flags are:
5084 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
5086 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
5092 You'll need clang v3.7 or above to build bpf program you'd like to load
5096 .. code-block:: console
5099 clang -O2 -target bpf -c t1.c
5101 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
5103 .. code-block:: console
5105 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
5107 To load (not JITed) t1.o at TX queue 0, port 0:
5109 .. code-block:: console
5111 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
5116 Unload previously loaded eBPF program for particular RX/TX queue::
5118 testpmd> bpf-unload rx|tx (portid) (queueid)
5120 For example to unload BPF filter from TX queue 0, port 0:
5122 .. code-block:: console
5124 testpmd> bpf-unload tx 0 0
5129 The following sections show functions that configure and create flex item object,
5130 create flex pattern and use it in a flow rule.
5131 The commands will use 20 bytes IPv4 header for examples:
5136 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
5137 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5138 | ver | IHL | TOS | length | +0
5139 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5140 | identification | flg | frag. offset | +4
5141 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5142 | TTL | protocol | checksum | +8
5143 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5144 | source IP address | +12
5145 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5146 | destination IP address | +16
5147 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5153 Flex item object is created by PMD according to a new header configuration. The
5154 header configuration is compiled by the testpmd and stored in
5155 ``rte_flow_item_flex_conf`` type variable.
5159 # flow flex_item create <port> <flex id> <configuration file>
5160 testpmd> flow flex_item init 0 3 ipv4_flex_config.json
5161 port-0: created flex item #3
5163 Flex item configuration is kept in external JSON file.
5164 It describes the following header elements:
5166 **New header length.**
5168 Specify whether the new header has fixed or variable length and the basic/minimal
5169 header length value.
5171 If header length is not fixed, header location with a value that completes header
5172 length calculation and scale/offset function must be added.
5174 Scale function depends on port hardware.
5178 Describes location in the new header that specify following network header type.
5180 **Flow match samples.**
5182 Describes locations in the new header that will be used in flow rules.
5184 Number of flow samples and sample maximal length depend of port hardware.
5188 Describes preceding network header configuration.
5192 Describes conditions that trigger transfer to following network header
5194 .. code-block:: json
5197 "next_header": { "field_mode": "FIELD_MODE_FIXED", "field_size": 20},
5198 "next_protocol": {"field_size": 8, "field_base": 72},
5200 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 0},
5201 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 32},
5202 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 64},
5203 { "field_mode": "FIELD_MODE_FIXED", "field_size": 32, "field_base": 96}
5206 {"item": "eth type is 0x0800"},
5207 {"item": "vlan inner_type is 0x0800"}
5210 {"item": "udp", "next": 17},
5211 {"item": "tcp", "next": 6},
5212 {"item": "icmp", "next": 1}
5217 Flex pattern and flow rules
5218 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
5220 Flex pattern describe parts of network header that will trigger flex flow item hit in a flow rule.
5221 Flex pattern directly related to flex item samples configuration.
5222 Flex pattern can be shared between ports.
5224 **Flex pattern and flow rule to match IPv4 version and 20 bytes length**
5228 # set flex_pattern <pattern_id> is <hex bytes sequence>
5229 testpmd> flow flex_item pattern 5 is 45FF
5232 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
5233 Flow rule #0 created
5235 **Flex pattern and flow rule to match packets with source address 1.2.3.4**
5239 testpmd> flow flex_item pattern 2 spec 45000000000000000000000001020304 mask FF0000000000000000000000FFFFFFFF
5242 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
5243 Flow rule #0 created