1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2010-2016 Intel Corporation.
6 Testpmd Runtime Functions
7 =========================
9 Where the testpmd application is started in interactive mode, (``-i|--interactive``),
10 it displays a prompt that can be used to start and stop forwarding,
11 configure the application, display statistics (including the extended NIC
12 statistics aka xstats) , set the Flow Director and other tasks::
16 The testpmd prompt has some, limited, readline support.
17 Common bash command-line functions such as ``Ctrl+a`` and ``Ctrl+e`` to go to the start and end of the prompt line are supported
18 as well as access to the command history via the up-arrow.
20 There is also support for tab completion.
21 If you type a partial command and hit ``<TAB>`` you get a list of the available completions:
23 .. code-block:: console
25 testpmd> show port <TAB>
27 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X
28 info [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all
29 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap X
30 stats [Mul-choice STRING]: show|clear port info|stats|xstats|fdir|stat_qmap|dcb_tc|cap all
36 Some examples in this document are too long to fit on one line are shown wrapped at `"\\"` for display purposes::
38 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
39 (pause_time) (send_xon) (port_id)
41 In the real ``testpmd>`` prompt these commands should be on a single line.
46 The testpmd has on-line help for the functions that are available at runtime.
47 These are divided into sections and can be accessed using help, help section or help all:
49 .. code-block:: console
53 help control : Start and stop forwarding.
54 help display : Displaying port, stats and config information.
55 help config : Configuration information.
56 help ports : Configuring ports.
57 help registers : Reading and setting port registers.
58 help filters : Filters configuration help.
59 help all : All of the above sections.
62 Command File Functions
63 ----------------------
65 To facilitate loading large number of commands or to avoid cutting and pasting where not
66 practical or possible testpmd supports alternative methods for executing commands.
68 * If started with the ``--cmdline-file=FILENAME`` command line argument testpmd
69 will execute all CLI commands contained within the file immediately before
70 starting packet forwarding or entering interactive mode.
72 .. code-block:: console
74 ./testpmd -n4 -r2 ... -- -i --cmdline-file=/home/ubuntu/flow-create-commands.txt
75 Interactive-mode selected
76 CLI commands to be read from /home/ubuntu/flow-create-commands.txt
77 Configuring Port 0 (socket 0)
78 Port 0: 7C:FE:90:CB:74:CE
79 Configuring Port 1 (socket 0)
80 Port 1: 7C:FE:90:CB:74:CA
81 Checking link statuses...
82 Port 0 Link Up - speed 10000 Mbps - full-duplex
83 Port 1 Link Up - speed 10000 Mbps - full-duplex
89 Flow rule #498 created
90 Flow rule #499 created
91 Read all CLI commands from /home/ubuntu/flow-create-commands.txt
95 * At run-time additional commands can be loaded in bulk by invoking the ``load FILENAME``
98 .. code-block:: console
100 testpmd> load /home/ubuntu/flow-create-commands.txt
105 Flow rule #498 created
106 Flow rule #499 created
107 Read all CLI commands from /home/ubuntu/flow-create-commands.txt
111 In all cases output from any included command will be displayed as standard output.
112 Execution will continue until the end of the file is reached regardless of
113 whether any errors occur. The end user must examine the output to determine if
114 any failures occurred.
123 Start packet forwarding with current configuration::
130 Start packet forwarding with current configuration after sending specified number of bursts of packets::
132 testpmd> start tx_first (""|burst_num)
134 The default burst number is 1 when ``burst_num`` not presented.
139 Stop packet forwarding, and display accumulated statistics::
154 The functions in the following sections are used to display information about the
155 testpmd configuration or the NIC status.
160 Display information for a given port or all ports::
162 testpmd> show port (info|summary|stats|xstats|fdir|stat_qmap|dcb_tc|cap) (port_id|all)
164 The available information categories are:
166 * ``info``: General port information such as MAC address.
168 * ``summary``: Brief port summary such as Device Name, Driver Name etc.
170 * ``stats``: RX/TX statistics.
172 * ``xstats``: RX/TX extended NIC statistics.
174 * ``fdir``: Flow Director information and statistics.
176 * ``stat_qmap``: Queue statistics mapping.
178 * ``dcb_tc``: DCB information such as TC mapping.
180 * ``cap``: Supported offload capabilities.
184 .. code-block:: console
186 testpmd> show port info 0
188 ********************* Infos for port 0 *********************
190 MAC address: XX:XX:XX:XX:XX:XX
192 memory allocation on the socket: 0
194 Link speed: 40000 Mbps
195 Link duplex: full-duplex
196 Promiscuous mode: enabled
197 Allmulticast mode: disabled
198 Maximum number of MAC addresses: 64
199 Maximum number of MAC addresses of hash filtering: 0
201 strip on, filter on, extend off, qinq strip off
202 Redirection table size: 512
203 Supported flow types:
221 show port (module_eeprom|eeprom)
222 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
224 Display the EEPROM information of a port::
226 testpmd> show port (port_id) (module_eeprom|eeprom)
231 Display the rss redirection table entry indicated by masks on port X::
233 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
235 size is used to indicate the hardware supported reta size
240 Display the RSS hash functions and RSS hash key of a port::
242 testpmd> show port (port_id) rss-hash [key]
247 Clear the port statistics and forward engine statistics for a given port or for all ports::
249 testpmd> clear port (info|stats|xstats|fdir|stat_qmap) (port_id|all)
253 testpmd> clear port stats all
258 Display information for a given port's RX/TX queue::
260 testpmd> show (rxq|txq) info (port_id) (queue_id)
262 show desc status(rxq|txq)
263 ~~~~~~~~~~~~~~~~~~~~~~~~~
265 Display information for a given port's RX/TX descriptor status::
267 testpmd> show port (port_id) (rxq|txq) (queue_id) desc (desc_id) status
273 Displays the configuration of the application.
274 The configuration comes from the command-line, the runtime or the application defaults::
276 testpmd> show config (rxtx|cores|fwd|rxoffs|rxpkts|txpkts|txtimes)
278 The available information categories are:
280 * ``rxtx``: RX/TX configuration items.
282 * ``cores``: List of forwarding cores.
284 * ``fwd``: Packet forwarding configuration.
286 * ``rxoffs``: Packet offsets for RX split.
288 * ``rxpkts``: Packets to RX split configuration.
290 * ``txpkts``: Packets to TX configuration.
292 * ``txtimes``: Burst time pattern for Tx only mode.
296 .. code-block:: console
298 testpmd> show config rxtx
300 io packet forwarding - CRC stripping disabled - packets/burst=16
301 nb forwarding cores=2 - nb forwarding ports=1
302 RX queues=1 - RX desc=128 - RX free threshold=0
303 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
304 TX queues=1 - TX desc=512 - TX free threshold=0
305 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
306 TX RS bit threshold=0 - TXQ flags=0x0
311 Set the packet forwarding mode::
313 testpmd> set fwd (io|mac|macswap|flowgen| \
314 rxonly|txonly|csum|icmpecho|noisy|5tswap) (""|retry)
316 ``retry`` can be specified for forwarding engines except ``rx_only``.
318 The available information categories are:
320 * ``io``: Forwards packets "as-is" in I/O mode.
321 This is the fastest possible forwarding operation as it does not access packets data.
322 This is the default mode.
324 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
325 Default application behavior is to set source Ethernet address to that of the transmitting interface, and destination
326 address to a dummy value (set during init). The user may specify a target destination Ethernet address via the 'eth-peer' or
327 'eth-peers-configfile' command-line options. It is not currently possible to specify a specific source Ethernet address.
329 * ``macswap``: MAC swap forwarding mode.
330 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
332 * ``flowgen``: Multi-flow generation mode.
333 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
335 * ``rxonly``: Receives packets but doesn't transmit them.
337 * ``txonly``: Generates and transmits packets without receiving any.
339 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
341 * ``icmpecho``: Receives a burst of packets, lookup for ICMP echo requests and, if any, send back ICMP echo replies.
343 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
345 * ``noisy``: Noisy neighbor simulation.
346 Simulate more realistic behavior of a guest machine engaged in receiving
347 and sending packets performing Virtual Network Function (VNF).
349 * ``5tswap``: Swap the source and destination of L2,L3,L4 if they exist.
351 L2 swaps the source address and destination address of Ethernet, as same as ``macswap``.
353 L3 swaps the source address and destination address of IP (v4 and v6).
355 L4 swaps the source port and destination port of transport layer (TCP and UDP).
359 testpmd> set fwd rxonly
361 Set rxonly packet forwarding mode
367 When running, forwarding engines maintain statistics from the time they have been started.
368 Example for the io forwarding engine, with some packet drops on the tx side::
370 testpmd> show fwd stats all
372 ------- Forward Stats for RX Port= 0/Queue= 0 -> TX Port= 1/Queue= 0 -------
373 RX-packets: 274293770 TX-packets: 274293642 TX-dropped: 128
375 ------- Forward Stats for RX Port= 1/Queue= 0 -> TX Port= 0/Queue= 0 -------
376 RX-packets: 274301850 TX-packets: 274301850 TX-dropped: 0
378 ---------------------- Forward statistics for port 0 ----------------------
379 RX-packets: 274293802 RX-dropped: 0 RX-total: 274293802
380 TX-packets: 274301862 TX-dropped: 0 TX-total: 274301862
381 ----------------------------------------------------------------------------
383 ---------------------- Forward statistics for port 1 ----------------------
384 RX-packets: 274301894 RX-dropped: 0 RX-total: 274301894
385 TX-packets: 274293706 TX-dropped: 128 TX-total: 274293834
386 ----------------------------------------------------------------------------
388 +++++++++++++++ Accumulated forward statistics for all ports+++++++++++++++
389 RX-packets: 548595696 RX-dropped: 0 RX-total: 548595696
390 TX-packets: 548595568 TX-dropped: 128 TX-total: 548595696
391 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
395 Enabling CONFIG_RTE_TEST_PMD_RECORD_CORE_CYCLES appends "CPU cycles/packet" stats, like:
397 CPU cycles/packet=xx.dd (total cycles=xxxx / total RX packets=xxxx) at xxx MHz clock
402 Clear the forwarding engines statistics::
404 testpmd> clear fwd stats all
409 Display an RX descriptor for a port RX queue::
411 testpmd> read rxd (port_id) (queue_id) (rxd_id)
415 testpmd> read rxd 0 0 4
416 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
421 Display a TX descriptor for a port TX queue::
423 testpmd> read txd (port_id) (queue_id) (txd_id)
427 testpmd> read txd 0 0 4
428 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
433 Get loaded dynamic device personalization (DDP) package info list::
435 testpmd> ddp get list (port_id)
440 Display information about dynamic device personalization (DDP) profile::
442 testpmd> ddp get info (profile_path)
447 Display VF statistics::
449 testpmd> show vf stats (port_id) (vf_id)
454 Reset VF statistics::
456 testpmd> clear vf stats (port_id) (vf_id)
458 show port pctype mapping
459 ~~~~~~~~~~~~~~~~~~~~~~~~
461 List all items from the pctype mapping table::
463 testpmd> show port (port_id) pctype mapping
465 show rx offloading capabilities
466 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
468 List all per queue and per port Rx offloading capabilities of a port::
470 testpmd> show port (port_id) rx_offload capabilities
472 show rx offloading configuration
473 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
475 List port level and all queue level Rx offloading configuration::
477 testpmd> show port (port_id) rx_offload configuration
479 show tx offloading capabilities
480 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
482 List all per queue and per port Tx offloading capabilities of a port::
484 testpmd> show port (port_id) tx_offload capabilities
486 show tx offloading configuration
487 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
489 List port level and all queue level Tx offloading configuration::
491 testpmd> show port (port_id) tx_offload configuration
493 show tx metadata setting
494 ~~~~~~~~~~~~~~~~~~~~~~~~
496 Show Tx metadata value set for a specific port::
498 testpmd> show port (port_id) tx_metadata
500 show port supported ptypes
501 ~~~~~~~~~~~~~~~~~~~~~~~~~~
503 Show ptypes supported for a specific port::
505 testpmd> show port (port_id) ptypes
507 set port supported ptypes
508 ~~~~~~~~~~~~~~~~~~~~~~~~~
510 set packet types classification for a specific port::
512 testpmd> set port (port_id) ptypes_mask (mask)
514 show port mac addresses info
515 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
517 Show mac addresses added for a specific port::
519 testpmd> show port (port_id) macs
522 show port multicast mac addresses info
523 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
525 Show multicast mac addresses added for a specific port::
527 testpmd> show port (port_id) mcast_macs
532 Show general information about devices probed::
534 testpmd> show device info (<identifier>|all)
538 .. code-block:: console
540 testpmd> show device info net_pcap0
542 ********************* Infos for device net_pcap0 *********************
544 Driver name: net_pcap
545 Devargs: iface=enP2p6s0,phy_mac=1
546 Connect to socket: -1
549 MAC address: 1E:37:93:28:04:B8
550 Device name: net_pcap0
555 Dumps all physical memory segment layouts::
557 testpmd> dump_physmem
562 Dumps the layout of all memory zones::
564 testpmd> dump_memzone
569 Dumps the memory usage of all sockets::
571 testpmd> dump_socket_mem
576 Dumps the size of all memory structures::
578 testpmd> dump_struct_sizes
583 Dumps the status of all or specific element in DPDK rings::
585 testpmd> dump_ring [ring_name]
590 Dumps the statistics of all or specific memory pool::
592 testpmd> dump_mempool [mempool_name]
597 Dumps the user device list::
599 testpmd> dump_devargs
604 Dumps the log level for all the dpdk modules::
606 testpmd> dump_log_types
608 show (raw_encap|raw_decap)
609 ~~~~~~~~~~~~~~~~~~~~~~~~~~
611 Display content of raw_encap/raw_decap buffers in hex::
613 testpmd> show <raw_encap|raw_decap> <index>
614 testpmd> show <raw_encap|raw_decap> all
618 testpmd> show raw_encap 6
620 index: 6 at [0x1c565b0], len=50
621 00000000: 00 00 00 00 00 00 16 26 36 46 56 66 08 00 45 00 | .......&6FVf..E.
622 00000010: 00 00 00 00 00 00 00 11 00 00 C0 A8 01 06 C0 A8 | ................
623 00000020: 03 06 00 00 00 FA 00 00 00 00 08 00 00 00 00 00 | ................
626 show fec capabilities
627 ~~~~~~~~~~~~~~~~~~~~~
629 Show fec capabilities of a port::
631 testpmd> show port (port_id) fec capabilities
636 Show fec mode of a port::
638 testpmd> show port (port_id) fec_mode
641 Configuration Functions
642 -----------------------
644 The testpmd application can be configured from the runtime as well as from the command-line.
646 This section details the available configuration functions that are available.
650 Configuration changes only become active when forwarding is started/restarted.
655 Reset forwarding to the default configuration::
662 Set the debug verbosity level::
664 testpmd> set verbose (level)
666 Available levels are as following:
668 * ``0`` silent except for error.
669 * ``1`` fully verbose except for Tx packets.
670 * ``2`` fully verbose except for Rx packets.
671 * ``> 2`` fully verbose.
676 Set the log level for a log type::
678 testpmd> set log global|(type) (level)
682 * ``type`` is the log name.
684 * ``level`` is the log level.
686 For example, to change the global log level::
688 testpmd> set log global (level)
690 Regexes can also be used for type. To change log level of user1, user2 and user3::
692 testpmd> set log user[1-3] (level)
697 Set the number of ports used by the application:
701 This is equivalent to the ``--nb-ports`` command-line option.
706 Set the number of cores used by the application::
708 testpmd> set nbcore (num)
710 This is equivalent to the ``--nb-cores`` command-line option.
714 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
719 Set the forwarding cores hexadecimal mask::
721 testpmd> set coremask (mask)
723 This is equivalent to the ``--coremask`` command-line option.
727 The main lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
732 Set the forwarding ports hexadecimal mask::
734 testpmd> set portmask (mask)
736 This is equivalent to the ``--portmask`` command-line option.
738 set record-core-cycles
739 ~~~~~~~~~~~~~~~~~~~~~~
741 Set the recording of CPU cycles::
743 testpmd> set record-core-cycles (on|off)
747 * ``on`` enables measurement of CPU cycles per packet.
749 * ``off`` disables measurement of CPU cycles per packet.
751 This is equivalent to the ``--record-core-cycles command-line`` option.
753 set record-burst-stats
754 ~~~~~~~~~~~~~~~~~~~~~~
756 Set the displaying of RX and TX bursts::
758 testpmd> set record-burst-stats (on|off)
762 * ``on`` enables display of RX and TX bursts.
764 * ``off`` disables display of RX and TX bursts.
766 This is equivalent to the ``--record-burst-stats command-line`` option.
771 Set number of packets per burst::
773 testpmd> set burst (num)
775 This is equivalent to the ``--burst command-line`` option.
777 When retry is enabled, the transmit delay time and number of retries can also be set::
779 testpmd> set burst tx delay (microseconds) retry (num)
784 Set the offsets of segments relating to the data buffer beginning on receiving
785 if split feature is engaged. Affects only the queues configured with split
786 offloads (currently BUFFER_SPLIT is supported only).
788 testpmd> set rxoffs (x[,y]*)
790 Where x[,y]* represents a CSV list of values, without white space. If the list
791 of offsets is shorter than the list of segments the zero offsets will be used
792 for the remaining segments.
797 Set the length of segments to scatter packets on receiving if split
798 feature is engaged. Affects only the queues configured with split offloads
799 (currently BUFFER_SPLIT is supported only). Optionally the multiple memory
800 pools can be specified with --mbuf-size command line parameter and the mbufs
801 to receive will be allocated sequentially from these extra memory pools (the
802 mbuf for the first segment is allocated from the first pool, the second one
803 from the second pool, and so on, if segment number is greater then pool's the
804 mbuf for remaining segments will be allocated from the last valid pool).
806 testpmd> set rxpkts (x[,y]*)
808 Where x[,y]* represents a CSV list of values, without white space. Zero value
809 means to use the corresponding memory pool data buffer size.
814 Set the length of each segment of the TX-ONLY packets or length of packet for FLOWGEN mode::
816 testpmd> set txpkts (x[,y]*)
818 Where x[,y]* represents a CSV list of values, without white space.
823 Configure the timing burst pattern for Tx only mode. This command enables
824 the packet send scheduling on dynamic timestamp mbuf field and configures
825 timing pattern in Tx only mode. In this mode, if scheduling is enabled
826 application provides timestamps in the packets being sent. It is possible
827 to configure delay (in unspecified device clock units) between bursts
828 and between the packets within the burst::
830 testpmd> set txtimes (inter),(intra)
834 * ``inter`` is the delay between the bursts in the device clock units.
835 If ``intra`` is zero, this is the time between the beginnings of the
836 first packets in the neighbour bursts, if ``intra`` is not zero,
837 ``inter`` specifies the time between the beginning of the first packet
838 of the current burst and the beginning of the last packet of the
839 previous burst. If ``inter`` parameter is zero the send scheduling
840 on timestamps is disabled (default).
842 * ``intra`` is the delay between the packets within the burst specified
843 in the device clock units. The number of packets in the burst is defined
844 by regular burst setting. If ``intra`` parameter is zero no timestamps
845 provided in the packets excepting the first one in the burst.
847 As the result the bursts of packet will be transmitted with specific
848 delays between the packets within the burst and specific delay between
849 the bursts. The rte_eth_read_clock() must be supported by the device(s)
850 and is supposed to be engaged to get the current device clock value
851 and provide the reference for the timestamps. If there is no supported
852 rte_eth_read_clock() there will be no send scheduling provided on the port.
857 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
859 testpmd> set txsplit (off|on|rand)
863 * ``off`` disable packet copy & split for CSUM mode.
865 * ``on`` split outgoing packet into multiple segments. Size of each segment
866 and number of segments per packet is determined by ``set txpkts`` command
869 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
874 Set the list of forwarding cores::
876 testpmd> set corelist (x[,y]*)
878 For example, to change the forwarding cores:
880 .. code-block:: console
882 testpmd> set corelist 3,1
883 testpmd> show config fwd
885 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
886 Logical Core 3 (socket 0) forwards packets on 1 streams:
887 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
888 Logical Core 1 (socket 0) forwards packets on 1 streams:
889 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
893 The cores are used in the same order as specified on the command line.
898 Set the list of forwarding ports::
900 testpmd> set portlist (x[,y]*)
902 For example, to change the port forwarding:
904 .. code-block:: console
906 testpmd> set portlist 0,2,1,3
907 testpmd> show config fwd
909 io packet forwarding - ports=4 - cores=1 - streams=4
910 Logical Core 3 (socket 0) forwards packets on 4 streams:
911 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
912 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
913 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
914 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
919 Select how to retrieve new ports created after "port attach" command::
921 testpmd> set port setup on (iterator|event)
923 For each new port, a setup is done.
924 It will find the probed ports via RTE_ETH_FOREACH_MATCHING_DEV loop
925 in iterator mode, or via RTE_ETH_EVENT_NEW in event mode.
930 Enable/disable tx loopback::
932 testpmd> set tx loopback (port_id) (on|off)
937 set drop enable bit for all queues::
939 testpmd> set all queues drop (port_id) (on|off)
941 set split drop enable (for VF)
942 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
944 set split drop enable bit for VF from PF::
946 testpmd> set vf split drop (port_id) (vf_id) (on|off)
948 set mac antispoof (for VF)
949 ~~~~~~~~~~~~~~~~~~~~~~~~~~
951 Set mac antispoof for a VF from the PF::
953 testpmd> set vf mac antispoof (port_id) (vf_id) (on|off)
958 Enable/disable MACsec offload::
960 testpmd> set macsec offload (port_id) on encrypt (on|off) replay-protect (on|off)
961 testpmd> set macsec offload (port_id) off
966 Configure MACsec secure connection (SC)::
968 testpmd> set macsec sc (tx|rx) (port_id) (mac) (pi)
972 The pi argument is ignored for tx.
973 Check the NIC Datasheet for hardware limits.
978 Configure MACsec secure association (SA)::
980 testpmd> set macsec sa (tx|rx) (port_id) (idx) (an) (pn) (key)
984 The IDX value must be 0 or 1.
985 Check the NIC Datasheet for hardware limits.
987 set broadcast mode (for VF)
988 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
990 Set broadcast mode for a VF from the PF::
992 testpmd> set vf broadcast (port_id) (vf_id) (on|off)
997 Set the VLAN strip for a queue on a port::
999 testpmd> vlan set stripq (on|off) (port_id,queue_id)
1001 vlan set stripq (for VF)
1002 ~~~~~~~~~~~~~~~~~~~~~~~~
1004 Set VLAN strip for all queues in a pool for a VF from the PF::
1006 testpmd> set vf vlan stripq (port_id) (vf_id) (on|off)
1008 vlan set insert (for VF)
1009 ~~~~~~~~~~~~~~~~~~~~~~~~
1011 Set VLAN insert for a VF from the PF::
1013 testpmd> set vf vlan insert (port_id) (vf_id) (vlan_id)
1015 vlan set tag (for VF)
1016 ~~~~~~~~~~~~~~~~~~~~~
1018 Set VLAN tag for a VF from the PF::
1020 testpmd> set vf vlan tag (port_id) (vf_id) (on|off)
1022 vlan set antispoof (for VF)
1023 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1025 Set VLAN antispoof for a VF from the PF::
1027 testpmd> set vf vlan antispoof (port_id) (vf_id) (on|off)
1029 vlan set (strip|filter|qinq_strip|extend)
1030 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1031 Set the VLAN strip/filter/QinQ strip/extend on for a port::
1033 testpmd> vlan set (strip|filter|qinq_strip|extend) (on|off) (port_id)
1038 Set the inner or outer VLAN TPID for packet filtering on a port::
1040 testpmd> vlan set (inner|outer) tpid (value) (port_id)
1044 TPID value must be a 16-bit number (value <= 65536).
1049 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
1051 testpmd> rx_vlan add (vlan_id|all) (port_id)
1055 VLAN filter must be set on that port. VLAN ID < 4096.
1056 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
1057 in VFTA table. This is important if enabling all vlan_ids.
1062 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
1064 testpmd> rx_vlan rm (vlan_id|all) (port_id)
1066 rx_vlan add (for VF)
1067 ~~~~~~~~~~~~~~~~~~~~
1069 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
1071 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
1076 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
1078 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
1083 Add a tunnel filter on a port::
1085 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
1086 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
1087 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1089 The available information categories are:
1091 * ``vxlan``: Set tunnel type as VXLAN.
1093 * ``nvgre``: Set tunnel type as NVGRE.
1095 * ``ipingre``: Set tunnel type as IP-in-GRE.
1097 * ``vxlan-gpe``: Set tunnel type as VXLAN-GPE
1099 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
1101 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
1103 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
1105 * ``imac``: Set filter type as Inner MAC.
1107 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
1109 * ``oip``: Set filter type as Outer IP.
1111 * ``iip``: Set filter type as Inner IP.
1115 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
1116 192.168.2.2 0 ipingre oip 1 1
1118 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
1120 tunnel_filter remove
1121 ~~~~~~~~~~~~~~~~~~~~
1123 Remove a tunnel filter on a port::
1125 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
1126 (inner_vlan) (vxlan|nvgre|ipingre|vxlan-gpe) (imac-ivlan|imac-ivlan-tenid|\
1127 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
1132 Add an UDP port for VXLAN packet filter on a port::
1134 testpmd> rx_vxlan_port add (udp_port) (port_id)
1136 rx_vxlan_port remove
1137 ~~~~~~~~~~~~~~~~~~~~
1139 Remove an UDP port for VXLAN packet filter on a port::
1141 testpmd> rx_vxlan_port rm (udp_port) (port_id)
1146 Set hardware insertion of VLAN IDs in packets sent on a port::
1148 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
1150 For example, set a single VLAN ID (5) insertion on port 0::
1154 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
1162 Set port based hardware insertion of VLAN ID in packets sent on a port::
1164 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
1169 Disable hardware insertion of a VLAN header in packets sent on a port::
1171 testpmd> tx_vlan reset (port_id)
1176 Select hardware or software calculation of the checksum when
1177 transmitting a packet using the ``csum`` forwarding engine::
1179 testpmd> csum set (ip|udp|tcp|sctp|outer-ip|outer-udp) (hw|sw) (port_id)
1183 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
1185 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
1186 as a tunnel packet by the forwarding engine (geneve, gre, gtp, ipip, vxlan and vxlan-gpe are
1187 supported). See also the ``csum parse-tunnel`` command.
1189 * ``outer-udp`` relates to the outer UDP layer in the case where the packet is recognized
1190 as a tunnel packet by the forwarding engine (geneve, gtp, vxlan and vxlan-gpe are
1191 supported). See also the ``csum parse-tunnel`` command.
1195 Check the NIC Datasheet for hardware limits.
1200 Set RSS queue region span on a port::
1202 testpmd> set port (port_id) queue-region region_id (value) \
1203 queue_start_index (value) queue_num (value)
1205 Set flowtype mapping on a RSS queue region on a port::
1207 testpmd> set port (port_id) queue-region region_id (value) flowtype (value)
1211 * For the flowtype(pctype) of packet,the specific index for each type has
1212 been defined in file i40e_type.h as enum i40e_filter_pctype.
1214 Set user priority mapping on a RSS queue region on a port::
1216 testpmd> set port (port_id) queue-region UP (value) region_id (value)
1218 Flush all queue region related configuration on a port::
1220 testpmd> set port (port_id) queue-region flush (on|off)
1224 * ``on``: is just an enable function which server for other configuration,
1225 it is for all configuration about queue region from up layer,
1226 at first will only keep in DPDK software stored in driver,
1227 only after "flush on", it commit all configuration to HW.
1229 * ``"off``: is just clean all configuration about queue region just now,
1230 and restore all to DPDK i40e driver default config when start up.
1232 Show all queue region related configuration info on a port::
1234 testpmd> show port (port_id) queue-region
1238 Queue region only support on PF by now, so these command is
1239 only for configuration of queue region on PF port.
1244 Define how tunneled packets should be handled by the csum forward
1247 testpmd> csum parse-tunnel (on|off) (tx_port_id)
1249 If enabled, the csum forward engine will try to recognize supported
1250 tunnel headers (geneve, gtp, gre, ipip, vxlan, vxlan-gpe).
1252 If disabled, treat tunnel packets as non-tunneled packets (a inner
1253 header is handled as a packet payload).
1257 The port argument is the TX port like in the ``csum set`` command.
1261 Consider a packet in packet like the following::
1263 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
1265 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1266 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
1267 ``outer-ip|outer-udp`` parameter relates to the outer headers (here ``ipv4_out`` and ``udp_out``).
1269 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
1270 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
1275 Display tx checksum offload configuration::
1277 testpmd> csum show (port_id)
1282 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
1284 testpmd> tso set (segsize) (port_id)
1288 Check the NIC datasheet for hardware limits.
1293 Display the status of TCP Segmentation Offload::
1295 testpmd> tso show (port_id)
1300 Set tso segment size of tunneled packets for a port in csum engine::
1302 testpmd> tunnel_tso set (tso_segsz) (port_id)
1307 Display the status of tunneled TCP Segmentation Offload for a port::
1309 testpmd> tunnel_tso show (port_id)
1314 Enable or disable GRO in ``csum`` forwarding engine::
1316 testpmd> set port <port_id> gro on|off
1318 If enabled, the csum forwarding engine will perform GRO on the TCP/IPv4
1319 packets received from the given port.
1321 If disabled, packets received from the given port won't be performed
1322 GRO. By default, GRO is disabled for all ports.
1326 When enable GRO for a port, TCP/IPv4 packets received from the port
1327 will be performed GRO. After GRO, all merged packets have bad
1328 checksums, since the GRO library doesn't re-calculate checksums for
1329 the merged packets. Therefore, if users want the merged packets to
1330 have correct checksums, please select HW IP checksum calculation and
1331 HW TCP checksum calculation for the port which the merged packets are
1337 Display GRO configuration for a given port::
1339 testpmd> show port <port_id> gro
1344 Set the cycle to flush the GROed packets from reassembly tables::
1346 testpmd> set gro flush <cycles>
1348 When enable GRO, the csum forwarding engine performs GRO on received
1349 packets, and the GROed packets are stored in reassembly tables. Users
1350 can use this command to determine when the GROed packets are flushed
1351 from the reassembly tables.
1353 The ``cycles`` is measured in GRO operation times. The csum forwarding
1354 engine flushes the GROed packets from the tables every ``cycles`` GRO
1357 By default, the value of ``cycles`` is 1, which means flush GROed packets
1358 from the reassembly tables as soon as one GRO operation finishes. The value
1359 of ``cycles`` should be in the range of 1 to ``GRO_MAX_FLUSH_CYCLES``.
1361 Please note that the large value of ``cycles`` may cause the poor TCP/IP
1362 stack performance. Because the GROed packets are delayed to arrive the
1363 stack, thus causing more duplicated ACKs and TCP retransmissions.
1368 Toggle per-port GSO support in ``csum`` forwarding engine::
1370 testpmd> set port <port_id> gso on|off
1372 If enabled, the csum forwarding engine will perform GSO on supported IPv4
1373 packets, transmitted on the given port.
1375 If disabled, packets transmitted on the given port will not undergo GSO.
1376 By default, GSO is disabled for all ports.
1380 When GSO is enabled on a port, supported IPv4 packets transmitted on that
1381 port undergo GSO. Afterwards, the segmented packets are represented by
1382 multi-segment mbufs; however, the csum forwarding engine doesn't calculation
1383 of checksums for GSO'd segments in SW. As a result, if users want correct
1384 checksums in GSO segments, they should enable HW checksum calculation for
1387 For example, HW checksum calculation for VxLAN GSO'd packets may be enabled
1388 by setting the following options in the csum forwarding engine:
1390 testpmd> csum set outer_ip hw <port_id>
1392 testpmd> csum set ip hw <port_id>
1394 testpmd> csum set tcp hw <port_id>
1396 UDP GSO is the same as IP fragmentation, which treats the UDP header
1397 as the payload and does not modify it during segmentation. That is,
1398 after UDP GSO, only the first output fragment has the original UDP
1399 header. Therefore, users need to enable HW IP checksum calculation
1400 and SW UDP checksum calculation for GSO-enabled ports, if they want
1401 correct checksums for UDP/IPv4 packets.
1406 Set the maximum GSO segment size (measured in bytes), which includes the
1407 packet header and the packet payload for GSO-enabled ports (global)::
1409 testpmd> set gso segsz <length>
1414 Display the status of Generic Segmentation Offload for a given port::
1416 testpmd> show port <port_id> gso
1421 Add an alternative MAC address to a port::
1423 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
1428 Remove a MAC address from a port::
1430 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
1435 To add the multicast MAC address to/from the set of multicast addresses
1438 testpmd> mcast_addr add (port_id) (mcast_addr)
1443 To remove the multicast MAC address to/from the set of multicast addresses
1446 testpmd> mcast_addr remove (port_id) (mcast_addr)
1448 mac_addr add (for VF)
1449 ~~~~~~~~~~~~~~~~~~~~~
1451 Add an alternative MAC address for a VF to a port::
1453 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
1458 Set the default MAC address for a port::
1460 testpmd> mac_addr set (port_id) (XX:XX:XX:XX:XX:XX)
1462 mac_addr set (for VF)
1463 ~~~~~~~~~~~~~~~~~~~~~
1465 Set the MAC address for a VF from the PF::
1467 testpmd> set vf mac addr (port_id) (vf_id) (XX:XX:XX:XX:XX:XX)
1472 Set the forwarding peer address for certain port::
1474 testpmd> set eth-peer (port_id) (peer_addr)
1476 This is equivalent to the ``--eth-peer`` command-line option.
1481 Set the unicast hash filter(s) on/off for a port::
1483 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
1488 Set the promiscuous mode on for a port or for all ports.
1489 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1491 testpmd> set promisc (port_id|all) (on|off)
1496 Set the allmulti mode for a port or for all ports::
1498 testpmd> set allmulti (port_id|all) (on|off)
1500 Same as the ifconfig (8) option. Controls how multicast packets are handled.
1502 set promisc (for VF)
1503 ~~~~~~~~~~~~~~~~~~~~
1505 Set the unicast promiscuous mode for a VF from PF.
1506 It's supported by Intel i40e NICs now.
1507 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1509 testpmd> set vf promisc (port_id) (vf_id) (on|off)
1511 set allmulticast (for VF)
1512 ~~~~~~~~~~~~~~~~~~~~~~~~~
1514 Set the multicast promiscuous mode for a VF from PF.
1515 It's supported by Intel i40e NICs now.
1516 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
1518 testpmd> set vf allmulti (port_id) (vf_id) (on|off)
1520 set tx max bandwidth (for VF)
1521 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1523 Set TX max absolute bandwidth (Mbps) for a VF from PF::
1525 testpmd> set vf tx max-bandwidth (port_id) (vf_id) (max_bandwidth)
1527 set tc tx min bandwidth (for VF)
1528 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1530 Set all TCs' TX min relative bandwidth (%) for a VF from PF::
1532 testpmd> set vf tc tx min-bandwidth (port_id) (vf_id) (bw1, bw2, ...)
1534 set tc tx max bandwidth (for VF)
1535 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1537 Set a TC's TX max absolute bandwidth (Mbps) for a VF from PF::
1539 testpmd> set vf tc tx max-bandwidth (port_id) (vf_id) (tc_no) (max_bandwidth)
1541 set tc strict link priority mode
1542 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1544 Set some TCs' strict link priority mode on a physical port::
1546 testpmd> set tx strict-link-priority (port_id) (tc_bitmap)
1548 set tc tx min bandwidth
1549 ~~~~~~~~~~~~~~~~~~~~~~~
1551 Set all TCs' TX min relative bandwidth (%) globally for all PF and VFs::
1553 testpmd> set tc tx min-bandwidth (port_id) (bw1, bw2, ...)
1558 Set the link flow control parameter on a port::
1560 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1561 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
1562 autoneg (on|off) (port_id)
1566 * ``high_water`` (integer): High threshold value to trigger XOFF.
1568 * ``low_water`` (integer): Low threshold value to trigger XON.
1570 * ``pause_time`` (integer): Pause quota in the Pause frame.
1572 * ``send_xon`` (0/1): Send XON frame.
1574 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
1576 * ``autoneg``: Change the auto-negotiation parameter.
1581 Set the priority flow control parameter on a port::
1583 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
1584 (pause_time) (priority) (port_id)
1588 * ``high_water`` (integer): High threshold value.
1590 * ``low_water`` (integer): Low threshold value.
1592 * ``pause_time`` (integer): Pause quota in the Pause frame.
1594 * ``priority`` (0-7): VLAN User Priority.
1599 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
1601 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
1603 For example, to set rx queue 2 on port 0 to mapping 5::
1605 testpmd>set stat_qmap rx 0 2 5
1607 set xstats-hide-zero
1608 ~~~~~~~~~~~~~~~~~~~~
1610 Set the option to hide zero values for xstats display::
1612 testpmd> set xstats-hide-zero on|off
1616 By default, the zero values are displayed for xstats.
1618 set port - rx/tx (for VF)
1619 ~~~~~~~~~~~~~~~~~~~~~~~~~
1621 Set VF receive/transmit from a port::
1623 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
1625 set port - mac address filter (for VF)
1626 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1628 Add/Remove unicast or multicast MAC addr filter for a VF::
1630 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
1631 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
1633 set port - rx mode(for VF)
1634 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1636 Set the VF receive mode of a port::
1638 testpmd> set port (port_id) vf (vf_id) \
1639 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
1641 The available receive modes are:
1643 * ``AUPE``: Accepts untagged VLAN.
1645 * ``ROPE``: Accepts unicast hash.
1647 * ``BAM``: Accepts broadcast packets.
1649 * ``MPE``: Accepts all multicast packets.
1651 set port - tx_rate (for Queue)
1652 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1654 Set TX rate limitation for a queue on a port::
1656 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
1658 set port - tx_rate (for VF)
1659 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
1661 Set TX rate limitation for queues in VF on a port::
1663 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
1665 set port - mirror rule
1666 ~~~~~~~~~~~~~~~~~~~~~~
1668 Set pool or vlan type mirror rule for a port::
1670 testpmd> set port (port_id) mirror-rule (rule_id) \
1671 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
1672 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
1674 Set link mirror rule for a port::
1676 testpmd> set port (port_id) mirror-rule (rule_id) \
1677 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
1679 For example to enable mirror traffic with vlan 0,1 to pool 0::
1681 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
1683 reset port - mirror rule
1684 ~~~~~~~~~~~~~~~~~~~~~~~~
1686 Reset a mirror rule for a port::
1688 testpmd> reset port (port_id) mirror-rule (rule_id)
1693 Set the flush on RX streams before forwarding.
1694 The default is flush ``on``.
1695 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
1697 testpmd> set flush_rx off
1702 Set the bypass mode for the lowest port on bypass enabled NIC::
1704 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
1709 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
1711 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
1712 mode (normal|bypass|isolate) (port_id)
1716 * ``timeout``: Enable bypass after watchdog timeout.
1718 * ``os_on``: Enable bypass when OS/board is powered on.
1720 * ``os_off``: Enable bypass when OS/board is powered off.
1722 * ``power_on``: Enable bypass when power supply is turned on.
1724 * ``power_off``: Enable bypass when power supply is turned off.
1730 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
1732 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
1737 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
1739 testpmd> show bypass config (port_id)
1744 Set link up for a port::
1746 testpmd> set link-up port (port id)
1751 Set link down for a port::
1753 testpmd> set link-down port (port id)
1758 Enable E-tag insertion for a VF on a port::
1760 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
1762 Disable E-tag insertion for a VF on a port::
1764 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
1766 Enable/disable E-tag stripping on a port::
1768 testpmd> E-tag set stripping (on|off) port (port_id)
1770 Enable/disable E-tag based forwarding on a port::
1772 testpmd> E-tag set forwarding (on|off) port (port_id)
1774 Add an E-tag forwarding filter on a port::
1776 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
1778 Delete an E-tag forwarding filter on a port::
1779 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
1784 Load a dynamic device personalization (DDP) profile and store backup profile::
1786 testpmd> ddp add (port_id) (profile_path[,backup_profile_path])
1791 Delete a dynamic device personalization profile and restore backup profile::
1793 testpmd> ddp del (port_id) (backup_profile_path)
1798 List all items from the ptype mapping table::
1800 testpmd> ptype mapping get (port_id) (valid_only)
1804 * ``valid_only``: A flag indicates if only list valid items(=1) or all itemss(=0).
1806 Replace a specific or a group of software defined ptype with a new one::
1808 testpmd> ptype mapping replace (port_id) (target) (mask) (pkt_type)
1812 * ``target``: A specific software ptype or a mask to represent a group of software ptypes.
1814 * ``mask``: A flag indicate if "target" is a specific software ptype(=0) or a ptype mask(=1).
1816 * ``pkt_type``: The new software ptype to replace the old ones.
1818 Update hardware defined ptype to software defined packet type mapping table::
1820 testpmd> ptype mapping update (port_id) (hw_ptype) (sw_ptype)
1824 * ``hw_ptype``: hardware ptype as the index of the ptype mapping table.
1826 * ``sw_ptype``: software ptype as the value of the ptype mapping table.
1828 Reset ptype mapping table::
1830 testpmd> ptype mapping reset (port_id)
1832 config per port Rx offloading
1833 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1835 Enable or disable a per port Rx offloading on all Rx queues of a port::
1837 testpmd> port config (port_id) rx_offload (offloading) on|off
1839 * ``offloading``: can be any of these offloading capability:
1840 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1841 qinq_strip, outer_ipv4_cksum, macsec_strip,
1842 header_split, vlan_filter, vlan_extend, jumbo_frame,
1843 scatter, timestamp, security, keep_crc, rss_hash
1845 This command should be run when the port is stopped, or else it will fail.
1847 config per queue Rx offloading
1848 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1850 Enable or disable a per queue Rx offloading only on a specific Rx queue::
1852 testpmd> port (port_id) rxq (queue_id) rx_offload (offloading) on|off
1854 * ``offloading``: can be any of these offloading capability:
1855 vlan_strip, ipv4_cksum, udp_cksum, tcp_cksum, tcp_lro,
1856 qinq_strip, outer_ipv4_cksum, macsec_strip,
1857 header_split, vlan_filter, vlan_extend, jumbo_frame,
1858 scatter, timestamp, security, keep_crc
1860 This command should be run when the port is stopped, or else it will fail.
1862 config per port Tx offloading
1863 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1865 Enable or disable a per port Tx offloading on all Tx queues of a port::
1867 testpmd> port config (port_id) tx_offload (offloading) on|off
1869 * ``offloading``: can be any of these offloading capability:
1870 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1871 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1872 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1873 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1874 mt_lockfree, multi_segs, mbuf_fast_free, security
1876 This command should be run when the port is stopped, or else it will fail.
1878 config per queue Tx offloading
1879 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1881 Enable or disable a per queue Tx offloading only on a specific Tx queue::
1883 testpmd> port (port_id) txq (queue_id) tx_offload (offloading) on|off
1885 * ``offloading``: can be any of these offloading capability:
1886 vlan_insert, ipv4_cksum, udp_cksum, tcp_cksum,
1887 sctp_cksum, tcp_tso, udp_tso, outer_ipv4_cksum,
1888 qinq_insert, vxlan_tnl_tso, gre_tnl_tso,
1889 ipip_tnl_tso, geneve_tnl_tso, macsec_insert,
1890 mt_lockfree, multi_segs, mbuf_fast_free, security
1892 This command should be run when the port is stopped, or else it will fail.
1894 Config VXLAN Encap outer layers
1895 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1897 Configure the outer layer to encapsulate a packet inside a VXLAN tunnel::
1899 set vxlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1900 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) \
1903 set vxlan-with-vlan ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1904 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1905 eth-src (eth-src) eth-dst (eth-dst)
1907 set vxlan-tos-ttl ip-version (ipv4|ipv6) vni (vni) udp-src (udp-src) \
1908 udp-dst (udp-dst) ip-tos (ip-tos) ip-ttl (ip-ttl) ip-src (ip-src) \
1909 ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1911 These commands will set an internal configuration inside testpmd, any following
1912 flow rule using the action vxlan_encap will use the last configuration set.
1913 To have a different encapsulation header, one of those commands must be called
1914 before the flow rule creation.
1916 Config NVGRE Encap outer layers
1917 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1919 Configure the outer layer to encapsulate a packet inside a NVGRE tunnel::
1921 set nvgre ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) ip-dst (ip-dst) \
1922 eth-src (eth-src) eth-dst (eth-dst)
1923 set nvgre-with-vlan ip-version (ipv4|ipv6) tni (tni) ip-src (ip-src) \
1924 ip-dst (ip-dst) vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1926 These commands will set an internal configuration inside testpmd, any following
1927 flow rule using the action nvgre_encap will use the last configuration set.
1928 To have a different encapsulation header, one of those commands must be called
1929 before the flow rule creation.
1934 Configure the l2 to be used when encapsulating a packet with L2::
1936 set l2_encap ip-version (ipv4|ipv6) eth-src (eth-src) eth-dst (eth-dst)
1937 set l2_encap-with-vlan ip-version (ipv4|ipv6) vlan-tci (vlan-tci) \
1938 eth-src (eth-src) eth-dst (eth-dst)
1940 Those commands will set an internal configuration inside testpmd, any following
1941 flow rule using the action l2_encap will use the last configuration set.
1942 To have a different encapsulation header, one of those commands must be called
1943 before the flow rule creation.
1948 Configure the l2 to be removed when decapsulating a packet with L2::
1950 set l2_decap ip-version (ipv4|ipv6)
1951 set l2_decap-with-vlan ip-version (ipv4|ipv6)
1953 Those commands will set an internal configuration inside testpmd, any following
1954 flow rule using the action l2_decap will use the last configuration set.
1955 To have a different encapsulation header, one of those commands must be called
1956 before the flow rule creation.
1958 Config MPLSoGRE Encap outer layers
1959 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1961 Configure the outer layer to encapsulate a packet inside a MPLSoGRE tunnel::
1963 set mplsogre_encap ip-version (ipv4|ipv6) label (label) \
1964 ip-src (ip-src) ip-dst (ip-dst) eth-src (eth-src) eth-dst (eth-dst)
1965 set mplsogre_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1966 ip-src (ip-src) ip-dst (ip-dst) vlan-tci (vlan-tci) \
1967 eth-src (eth-src) eth-dst (eth-dst)
1969 These commands will set an internal configuration inside testpmd, any following
1970 flow rule using the action mplsogre_encap will use the last configuration set.
1971 To have a different encapsulation header, one of those commands must be called
1972 before the flow rule creation.
1974 Config MPLSoGRE Decap outer layers
1975 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1977 Configure the outer layer to decapsulate MPLSoGRE packet::
1979 set mplsogre_decap ip-version (ipv4|ipv6)
1980 set mplsogre_decap-with-vlan ip-version (ipv4|ipv6)
1982 These commands will set an internal configuration inside testpmd, any following
1983 flow rule using the action mplsogre_decap will use the last configuration set.
1984 To have a different decapsulation header, one of those commands must be called
1985 before the flow rule creation.
1987 Config MPLSoUDP Encap outer layers
1988 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1990 Configure the outer layer to encapsulate a packet inside a MPLSoUDP tunnel::
1992 set mplsoudp_encap ip-version (ipv4|ipv6) label (label) udp-src (udp-src) \
1993 udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1994 eth-src (eth-src) eth-dst (eth-dst)
1995 set mplsoudp_encap-with-vlan ip-version (ipv4|ipv6) label (label) \
1996 udp-src (udp-src) udp-dst (udp-dst) ip-src (ip-src) ip-dst (ip-dst) \
1997 vlan-tci (vlan-tci) eth-src (eth-src) eth-dst (eth-dst)
1999 These commands will set an internal configuration inside testpmd, any following
2000 flow rule using the action mplsoudp_encap will use the last configuration set.
2001 To have a different encapsulation header, one of those commands must be called
2002 before the flow rule creation.
2004 Config MPLSoUDP Decap outer layers
2005 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2007 Configure the outer layer to decapsulate MPLSoUDP packet::
2009 set mplsoudp_decap ip-version (ipv4|ipv6)
2010 set mplsoudp_decap-with-vlan ip-version (ipv4|ipv6)
2012 These commands will set an internal configuration inside testpmd, any following
2013 flow rule using the action mplsoudp_decap will use the last configuration set.
2014 To have a different decapsulation header, one of those commands must be called
2015 before the flow rule creation.
2017 Config Raw Encapsulation
2018 ~~~~~~~~~~~~~~~~~~~~~~~~~
2020 Configure the raw data to be used when encapsulating a packet by
2021 rte_flow_action_raw_encap::
2023 set raw_encap {index} {item} [/ {item} [...]] / end_set
2025 There are multiple global buffers for ``raw_encap``, this command will set one
2026 internal buffer index by ``{index}``.
2027 If there is no ``{index}`` specified::
2029 set raw_encap {item} [/ {item} [...]] / end_set
2031 the default index ``0`` is used.
2032 In order to use different encapsulating header, ``index`` must be specified
2033 during the flow rule creation::
2035 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
2036 raw_encap index 2 / end
2038 Otherwise the default index ``0`` is used.
2040 Config Raw Decapsulation
2041 ~~~~~~~~~~~~~~~~~~~~~~~~
2043 Configure the raw data to be used when decapsulating a packet by
2044 rte_flow_action_raw_decap::
2046 set raw_decap {index} {item} [/ {item} [...]] / end_set
2048 There are multiple global buffers for ``raw_decap``, this command will set
2049 one internal buffer index by ``{index}``.
2050 If there is no ``{index}`` specified::
2052 set raw_decap {item} [/ {item} [...]] / end_set
2054 the default index ``0`` is used.
2055 In order to use different decapsulating header, ``index`` must be specified
2056 during the flow rule creation::
2058 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
2059 raw_encap index 3 / end
2061 Otherwise the default index ``0`` is used.
2066 Set fec mode for a specific port::
2068 testpmd> set port (port_id) fec_mode auto|off|rs|baser
2074 The following sections show functions for configuring ports.
2078 Port configuration changes only become active when forwarding is started/restarted.
2083 Attach a port specified by pci address or virtual device args::
2085 testpmd> port attach (identifier)
2087 To attach a new pci device, the device should be recognized by kernel first.
2088 Then it should be moved under DPDK management.
2089 Finally the port can be attached to testpmd.
2091 For example, to move a pci device using ixgbe under DPDK management:
2093 .. code-block:: console
2095 # Check the status of the available devices.
2096 ./usertools/dpdk-devbind.py --status
2098 Network devices using DPDK-compatible driver
2099 ============================================
2102 Network devices using kernel driver
2103 ===================================
2104 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
2107 # Bind the device to igb_uio.
2108 sudo ./usertools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
2111 # Recheck the status of the devices.
2112 ./usertools/dpdk-devbind.py --status
2113 Network devices using DPDK-compatible driver
2114 ============================================
2115 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
2117 To attach a port created by virtual device, above steps are not needed.
2119 For example, to attach a port whose pci address is 0000:0a:00.0.
2121 .. code-block:: console
2123 testpmd> port attach 0000:0a:00.0
2124 Attaching a new port...
2125 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2126 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
2127 EAL: PCI memory mapped at 0x7f83bfa00000
2128 EAL: PCI memory mapped at 0x7f83bfa80000
2129 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
2130 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
2131 Port 0 is attached. Now total ports is 1
2134 For example, to attach a port created by pcap PMD.
2136 .. code-block:: console
2138 testpmd> port attach net_pcap0
2139 Attaching a new port...
2140 PMD: Initializing pmd_pcap for net_pcap0
2141 PMD: Creating pcap-backed ethdev on numa socket 0
2142 Port 0 is attached. Now total ports is 1
2145 In this case, identifier is ``net_pcap0``.
2146 This identifier format is the same as ``--vdev`` format of DPDK applications.
2148 For example, to re-attach a bonded port which has been previously detached,
2149 the mode and slave parameters must be given.
2151 .. code-block:: console
2153 testpmd> port attach net_bond_0,mode=0,slave=1
2154 Attaching a new port...
2155 EAL: Initializing pmd_bond for net_bond_0
2156 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
2157 Port 0 is attached. Now total ports is 1
2164 Detach a specific port::
2166 testpmd> port detach (port_id)
2168 Before detaching a port, the port should be stopped and closed.
2170 For example, to detach a pci device port 0.
2172 .. code-block:: console
2174 testpmd> port stop 0
2177 testpmd> port close 0
2181 testpmd> port detach 0
2183 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
2184 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
2185 EAL: PCI memory unmapped at 0x7f83bfa00000
2186 EAL: PCI memory unmapped at 0x7f83bfa80000
2190 For example, to detach a virtual device port 0.
2192 .. code-block:: console
2194 testpmd> port stop 0
2197 testpmd> port close 0
2201 testpmd> port detach 0
2203 PMD: Closing pcap ethdev on numa socket 0
2204 Port 'net_pcap0' is detached. Now total ports is 0
2207 To remove a pci device completely from the system, first detach the port from testpmd.
2208 Then the device should be moved under kernel management.
2209 Finally the device can be removed using kernel pci hotplug functionality.
2211 For example, to move a pci device under kernel management:
2213 .. code-block:: console
2215 sudo ./usertools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
2217 ./usertools/dpdk-devbind.py --status
2219 Network devices using DPDK-compatible driver
2220 ============================================
2223 Network devices using kernel driver
2224 ===================================
2225 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
2227 To remove a port created by a virtual device, above steps are not needed.
2232 Start all ports or a specific port::
2234 testpmd> port start (port_id|all)
2239 Stop all ports or a specific port::
2241 testpmd> port stop (port_id|all)
2246 Close all ports or a specific port::
2248 testpmd> port close (port_id|all)
2253 Reset all ports or a specific port::
2255 testpmd> port reset (port_id|all)
2257 User should stop port(s) before resetting and (re-)start after reset.
2259 port config - queue ring size
2260 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2262 Configure a rx/tx queue ring size::
2264 testpmd> port (port_id) (rxq|txq) (queue_id) ring_size (value)
2266 Only take effect after command that (re-)start the port or command that setup specific queue.
2268 port start/stop queue
2269 ~~~~~~~~~~~~~~~~~~~~~
2271 Start/stop a rx/tx queue on a specific port::
2273 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
2275 port config - queue deferred start
2276 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2278 Switch on/off deferred start of a specific port queue::
2280 testpmd> port (port_id) (rxq|txq) (queue_id) deferred_start (on|off)
2283 ~~~~~~~~~~~~~~~~~~~~~
2285 Setup a rx/tx queue on a specific port::
2287 testpmd> port (port_id) (rxq|txq) (queue_id) setup
2289 Only take effect when port is started.
2294 Set the speed and duplex mode for all ports or a specific port::
2296 testpmd> port config (port_id|all) speed (10|100|1000|10000|25000|40000|50000|100000|200000|auto) \
2297 duplex (half|full|auto)
2299 port config - queues/descriptors
2300 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2302 Set number of queues/descriptors for rxq, txq, rxd and txd::
2304 testpmd> port config all (rxq|txq|rxd|txd) (value)
2306 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
2308 port config - max-pkt-len
2309 ~~~~~~~~~~~~~~~~~~~~~~~~~
2311 Set the maximum packet length::
2313 testpmd> port config all max-pkt-len (value)
2315 This is equivalent to the ``--max-pkt-len`` command-line option.
2317 port config - max-lro-pkt-size
2318 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2320 Set the maximum LRO aggregated packet size::
2322 testpmd> port config all max-lro-pkt-size (value)
2324 This is equivalent to the ``--max-lro-pkt-size`` command-line option.
2326 port config - Drop Packets
2327 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2329 Enable or disable packet drop on all RX queues of all ports when no receive buffers available::
2331 testpmd> port config all drop-en (on|off)
2333 Packet dropping when no receive buffers available is off by default.
2335 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
2340 Set the RSS (Receive Side Scaling) mode on or off::
2342 testpmd> port config all rss (all|default|eth|vlan|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|vxlan-gpe|l2tpv3|esp|ah|pfcp|none)
2344 RSS is on by default.
2346 The ``all`` option is equivalent to eth|vlan|ip|tcp|udp|sctp|ether|l2tpv3|esp|ah|pfcp.
2348 The ``default`` option enables all supported RSS types reported by device info.
2350 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
2352 port config - RSS Reta
2353 ~~~~~~~~~~~~~~~~~~~~~~
2355 Set the RSS (Receive Side Scaling) redirection table::
2357 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
2362 Set the DCB mode for an individual port::
2364 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
2366 The traffic class should be 4 or 8.
2371 Set the number of packets per burst::
2373 testpmd> port config all burst (value)
2375 This is equivalent to the ``--burst`` command-line option.
2377 port config - Threshold
2378 ~~~~~~~~~~~~~~~~~~~~~~~
2380 Set thresholds for TX/RX queues::
2382 testpmd> port config all (threshold) (value)
2384 Where the threshold type can be:
2386 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
2388 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
2390 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
2392 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
2394 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
2396 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
2398 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
2400 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
2402 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
2404 These threshold options are also available from the command-line.
2409 Set the value of ether-type for E-tag::
2411 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
2413 Enable/disable the E-tag support::
2415 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
2417 port config pctype mapping
2418 ~~~~~~~~~~~~~~~~~~~~~~~~~~
2420 Reset pctype mapping table::
2422 testpmd> port config (port_id) pctype mapping reset
2424 Update hardware defined pctype to software defined flow type mapping table::
2426 testpmd> port config (port_id) pctype mapping update (pctype_id_0[,pctype_id_1]*) (flow_type_id)
2430 * ``pctype_id_x``: hardware pctype id as index of bit in bitmask value of the pctype mapping table.
2432 * ``flow_type_id``: software flow type id as the index of the pctype mapping table.
2434 port config input set
2435 ~~~~~~~~~~~~~~~~~~~~~
2437 Config RSS/FDIR/FDIR flexible payload input set for some pctype::
2439 testpmd> port config (port_id) pctype (pctype_id) \
2440 (hash_inset|fdir_inset|fdir_flx_inset) \
2441 (get|set|clear) field (field_idx)
2443 Clear RSS/FDIR/FDIR flexible payload input set for some pctype::
2445 testpmd> port config (port_id) pctype (pctype_id) \
2446 (hash_inset|fdir_inset|fdir_flx_inset) clear all
2450 * ``pctype_id``: hardware packet classification types.
2451 * ``field_idx``: hardware field index.
2453 port config udp_tunnel_port
2454 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
2456 Add/remove UDP tunnel port for VXLAN/GENEVE tunneling protocols::
2458 testpmd> port config (port_id) udp_tunnel_port add|rm vxlan|geneve|vxlan-gpe (udp_port)
2460 port config tx_metadata
2461 ~~~~~~~~~~~~~~~~~~~~~~~
2463 Set Tx metadata value per port.
2464 testpmd will add this value to any Tx packet sent from this port::
2466 testpmd> port config (port_id) tx_metadata (value)
2471 Set/clear dynamic flag per port.
2472 testpmd will register this flag in the mbuf (same registration
2473 for both Tx and Rx). Then set/clear this flag for each Tx
2474 packet sent from this port. The set bit only works for Tx packet::
2476 testpmd> port config (port_id) dynf (name) (set|clear)
2481 To configure MTU(Maximum Transmission Unit) on devices using testpmd::
2483 testpmd> port config mtu (port_id) (value)
2485 port config rss hash key
2486 ~~~~~~~~~~~~~~~~~~~~~~~~
2488 To configure the RSS hash key used to compute the RSS
2489 hash of input [IP] packets received on port::
2491 testpmd> port config <port_id> rss-hash-key (ipv4|ipv4-frag|\
2492 ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|\
2493 ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|\
2494 ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|\
2495 ipv6-udp-ex <string of hex digits \
2496 (variable length, NIC dependent)>)
2501 The following sections show functions for device operations.
2506 Detach a device specified by pci address or virtual device args::
2508 testpmd> device detach (identifier)
2510 Before detaching a device associated with ports, the ports should be stopped and closed.
2512 For example, to detach a pci device whose address is 0002:03:00.0.
2514 .. code-block:: console
2516 testpmd> device detach 0002:03:00.0
2517 Removing a device...
2518 Port 1 is now closed
2519 EAL: Releasing pci mapped resource for 0002:03:00.0
2520 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218a050000
2521 EAL: Calling pci_unmap_resource for 0002:03:00.0 at 0x218c050000
2522 Device 0002:03:00.0 is detached
2523 Now total ports is 1
2525 For example, to detach a port created by pcap PMD.
2527 .. code-block:: console
2529 testpmd> device detach net_pcap0
2530 Removing a device...
2531 Port 0 is now closed
2532 Device net_pcap0 is detached
2533 Now total ports is 0
2536 In this case, identifier is ``net_pcap0``.
2537 This identifier format is the same as ``--vdev`` format of DPDK applications.
2539 Link Bonding Functions
2540 ----------------------
2542 The Link Bonding functions make it possible to dynamically create and
2543 manage link bonding devices from within testpmd interactive prompt.
2545 create bonded device
2546 ~~~~~~~~~~~~~~~~~~~~
2548 Create a new bonding device::
2550 testpmd> create bonded device (mode) (socket)
2552 For example, to create a bonded device in mode 1 on socket 0::
2554 testpmd> create bonded device 1 0
2555 created new bonded device (port X)
2560 Adds Ethernet device to a Link Bonding device::
2562 testpmd> add bonding slave (slave id) (port id)
2564 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
2566 testpmd> add bonding slave 6 10
2569 remove bonding slave
2570 ~~~~~~~~~~~~~~~~~~~~
2572 Removes an Ethernet slave device from a Link Bonding device::
2574 testpmd> remove bonding slave (slave id) (port id)
2576 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
2578 testpmd> remove bonding slave 6 10
2583 Set the Link Bonding mode of a Link Bonding device::
2585 testpmd> set bonding mode (value) (port id)
2587 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
2589 testpmd> set bonding mode 3 10
2594 Set an Ethernet slave device as the primary device on a Link Bonding device::
2596 testpmd> set bonding primary (slave id) (port id)
2598 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
2600 testpmd> set bonding primary 6 10
2605 Set the MAC address of a Link Bonding device::
2607 testpmd> set bonding mac (port id) (mac)
2609 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
2611 testpmd> set bonding mac 10 00:00:00:00:00:01
2613 set bonding xmit_balance_policy
2614 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2616 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
2618 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
2620 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
2622 testpmd> set bonding xmit_balance_policy 10 l34
2625 set bonding mon_period
2626 ~~~~~~~~~~~~~~~~~~~~~~
2628 Set the link status monitoring polling period in milliseconds for a bonding device.
2630 This adds support for PMD slave devices which do not support link status interrupts.
2631 When the mon_period is set to a value greater than 0 then all PMD's which do not support
2632 link status ISR will be queried every polling interval to check if their link status has changed::
2634 testpmd> set bonding mon_period (port_id) (value)
2636 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
2638 testpmd> set bonding mon_period 5 150
2641 set bonding lacp dedicated_queue
2642 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2644 Enable dedicated tx/rx queues on bonding devices slaves to handle LACP control plane traffic
2645 when in mode 4 (link-aggregation-802.3ad)::
2647 testpmd> set bonding lacp dedicated_queues (port_id) (enable|disable)
2650 set bonding agg_mode
2651 ~~~~~~~~~~~~~~~~~~~~
2653 Enable one of the specific aggregators mode when in mode 4 (link-aggregation-802.3ad)::
2655 testpmd> set bonding agg_mode (port_id) (bandwidth|count|stable)
2661 Show the current configuration of a Link Bonding device::
2663 testpmd> show bonding config (port id)
2666 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
2667 in balance mode with a transmission policy of layer 2+3::
2669 testpmd> show bonding config 9
2671 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
2673 Active Slaves (3): [1 3 4]
2680 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
2681 This is mainly useful for debugging purposes.
2682 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
2683 and fields that can be accessed.
2688 Display the value of a port register::
2690 testpmd> read reg (port_id) (address)
2692 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
2694 testpmd> read reg 0 0xEE00
2695 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
2700 Display a port register bit field::
2702 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
2704 For example, reading the lowest two bits from the register in the example above::
2706 testpmd> read regfield 0 0xEE00 0 1
2707 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
2712 Display a single port register bit::
2714 testpmd> read regbit (port_id) (address) (bit_x)
2716 For example, reading the lowest bit from the register in the example above::
2718 testpmd> read regbit 0 0xEE00 0
2719 port 0 PCI register at offset 0xEE00: bit 0=1
2724 Set the value of a port register::
2726 testpmd> write reg (port_id) (address) (value)
2728 For example, to clear a register::
2730 testpmd> write reg 0 0xEE00 0x0
2731 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
2736 Set bit field of a port register::
2738 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
2740 For example, writing to the register cleared in the example above::
2742 testpmd> write regfield 0 0xEE00 0 1 2
2743 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
2748 Set single bit value of a port register::
2750 testpmd> write regbit (port_id) (address) (bit_x) (value)
2752 For example, to set the high bit in the register from the example above::
2754 testpmd> write regbit 0 0xEE00 31 1
2755 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
2757 Traffic Metering and Policing
2758 -----------------------------
2760 The following section shows functions for configuring traffic metering and
2761 policing on the ethernet device through the use of generic ethdev API.
2763 show port traffic management capability
2764 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2766 Show traffic metering and policing capability of the port::
2768 testpmd> show port meter cap (port_id)
2770 add port meter profile (srTCM rfc2967)
2771 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2773 Add meter profile (srTCM rfc2697) to the ethernet device::
2775 testpmd> add port meter profile srtcm_rfc2697 (port_id) (profile_id) \
2780 * ``profile_id``: ID for the meter profile.
2781 * ``cir``: Committed Information Rate (CIR) (bytes/second).
2782 * ``cbs``: Committed Burst Size (CBS) (bytes).
2783 * ``ebs``: Excess Burst Size (EBS) (bytes).
2785 add port meter profile (trTCM rfc2968)
2786 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2788 Add meter profile (srTCM rfc2698) to the ethernet device::
2790 testpmd> add port meter profile trtcm_rfc2698 (port_id) (profile_id) \
2791 (cir) (pir) (cbs) (pbs)
2795 * ``profile_id``: ID for the meter profile.
2796 * ``cir``: Committed information rate (bytes/second).
2797 * ``pir``: Peak information rate (bytes/second).
2798 * ``cbs``: Committed burst size (bytes).
2799 * ``pbs``: Peak burst size (bytes).
2801 add port meter profile (trTCM rfc4115)
2802 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2804 Add meter profile (trTCM rfc4115) to the ethernet device::
2806 testpmd> add port meter profile trtcm_rfc4115 (port_id) (profile_id) \
2807 (cir) (eir) (cbs) (ebs)
2811 * ``profile_id``: ID for the meter profile.
2812 * ``cir``: Committed information rate (bytes/second).
2813 * ``eir``: Excess information rate (bytes/second).
2814 * ``cbs``: Committed burst size (bytes).
2815 * ``ebs``: Excess burst size (bytes).
2817 delete port meter profile
2818 ~~~~~~~~~~~~~~~~~~~~~~~~~
2820 Delete meter profile from the ethernet device::
2822 testpmd> del port meter profile (port_id) (profile_id)
2827 Create new meter object for the ethernet device::
2829 testpmd> create port meter (port_id) (mtr_id) (profile_id) \
2830 (meter_enable) (g_action) (y_action) (r_action) (stats_mask) (shared) \
2831 (use_pre_meter_color) [(dscp_tbl_entry0) (dscp_tbl_entry1)...\
2836 * ``mtr_id``: meter object ID.
2837 * ``profile_id``: ID for the meter profile.
2838 * ``meter_enable``: When this parameter has a non-zero value, the meter object
2839 gets enabled at the time of creation, otherwise remains disabled.
2840 * ``g_action``: Policer action for the packet with green color.
2841 * ``y_action``: Policer action for the packet with yellow color.
2842 * ``r_action``: Policer action for the packet with red color.
2843 * ``stats_mask``: Mask of statistics counter types to be enabled for the
2845 * ``shared``: When this parameter has a non-zero value, the meter object is
2846 shared by multiple flows. Otherwise, meter object is used by single flow.
2847 * ``use_pre_meter_color``: When this parameter has a non-zero value, the
2848 input color for the current meter object is determined by the latest meter
2849 object in the same flow. Otherwise, the current meter object uses the
2850 *dscp_table* to determine the input color.
2851 * ``dscp_tbl_entryx``: DSCP table entry x providing meter providing input
2852 color, 0 <= x <= 63.
2857 Enable meter for the ethernet device::
2859 testpmd> enable port meter (port_id) (mtr_id)
2864 Disable meter for the ethernet device::
2866 testpmd> disable port meter (port_id) (mtr_id)
2871 Delete meter for the ethernet device::
2873 testpmd> del port meter (port_id) (mtr_id)
2875 Set port meter profile
2876 ~~~~~~~~~~~~~~~~~~~~~~
2878 Set meter profile for the ethernet device::
2880 testpmd> set port meter profile (port_id) (mtr_id) (profile_id)
2882 set port meter dscp table
2883 ~~~~~~~~~~~~~~~~~~~~~~~~~
2885 Set meter dscp table for the ethernet device::
2887 testpmd> set port meter dscp table (port_id) (mtr_id) [(dscp_tbl_entry0) \
2888 (dscp_tbl_entry1)...(dscp_tbl_entry63)]
2890 set port meter policer action
2891 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2893 Set meter policer action for the ethernet device::
2895 testpmd> set port meter policer action (port_id) (mtr_id) (action_mask) \
2896 (action0) [(action1) (action1)]
2900 * ``action_mask``: Bit mask indicating which policer actions need to be
2901 updated. One or more policer actions can be updated in a single function
2902 invocation. To update the policer action associated with color C, bit
2903 (1 << C) needs to be set in *action_mask* and element at position C
2904 in the *actions* array needs to be valid.
2905 * ``actionx``: Policer action for the color x,
2906 RTE_MTR_GREEN <= x < RTE_MTR_COLORS
2908 set port meter stats mask
2909 ~~~~~~~~~~~~~~~~~~~~~~~~~
2911 Set meter stats mask for the ethernet device::
2913 testpmd> set port meter stats mask (port_id) (mtr_id) (stats_mask)
2917 * ``stats_mask``: Bit mask indicating statistics counter types to be enabled.
2919 show port meter stats
2920 ~~~~~~~~~~~~~~~~~~~~~
2922 Show meter stats of the ethernet device::
2924 testpmd> show port meter stats (port_id) (mtr_id) (clear)
2928 * ``clear``: Flag that indicates whether the statistics counters should
2929 be cleared (i.e. set to zero) immediately after they have been read or not.
2934 The following section shows functions for configuring traffic management on
2935 the ethernet device through the use of generic TM API.
2937 show port traffic management capability
2938 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2940 Show traffic management capability of the port::
2942 testpmd> show port tm cap (port_id)
2944 show port traffic management capability (hierarchy level)
2945 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2947 Show traffic management hierarchy level capability of the port::
2949 testpmd> show port tm level cap (port_id) (level_id)
2951 show port traffic management capability (hierarchy node level)
2952 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2954 Show the traffic management hierarchy node capability of the port::
2956 testpmd> show port tm node cap (port_id) (node_id)
2958 show port traffic management hierarchy node type
2959 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2961 Show the port traffic management hierarchy node type::
2963 testpmd> show port tm node type (port_id) (node_id)
2965 show port traffic management hierarchy node stats
2966 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2968 Show the port traffic management hierarchy node statistics::
2970 testpmd> show port tm node stats (port_id) (node_id) (clear)
2974 * ``clear``: When this parameter has a non-zero value, the statistics counters
2975 are cleared (i.e. set to zero) immediately after they have been read,
2976 otherwise the statistics counters are left untouched.
2978 Add port traffic management private shaper profile
2979 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2981 Add the port traffic management private shaper profile::
2983 testpmd> add port tm node shaper profile (port_id) (shaper_profile_id) \
2984 (cmit_tb_rate) (cmit_tb_size) (peak_tb_rate) (peak_tb_size) \
2985 (packet_length_adjust) (packet_mode)
2989 * ``shaper_profile id``: Shaper profile ID for the new profile.
2990 * ``cmit_tb_rate``: Committed token bucket rate (bytes per second or packets per second).
2991 * ``cmit_tb_size``: Committed token bucket size (bytes or packets).
2992 * ``peak_tb_rate``: Peak token bucket rate (bytes per second or packets per second).
2993 * ``peak_tb_size``: Peak token bucket size (bytes or packets).
2994 * ``packet_length_adjust``: The value (bytes) to be added to the length of
2995 each packet for the purpose of shaping. This parameter value can be used to
2996 correct the packet length with the framing overhead bytes that are consumed
2998 * ``packet_mode``: Shaper configured in packet mode. This parameter value if
2999 zero, configures shaper in byte mode and if non-zero configures it in packet
3002 Delete port traffic management private shaper profile
3003 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3005 Delete the port traffic management private shaper::
3007 testpmd> del port tm node shaper profile (port_id) (shaper_profile_id)
3011 * ``shaper_profile id``: Shaper profile ID that needs to be deleted.
3013 Add port traffic management shared shaper
3014 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3016 Create the port traffic management shared shaper::
3018 testpmd> add port tm node shared shaper (port_id) (shared_shaper_id) \
3023 * ``shared_shaper_id``: Shared shaper ID to be created.
3024 * ``shaper_profile id``: Shaper profile ID for shared shaper.
3026 Set port traffic management shared shaper
3027 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3029 Update the port traffic management shared shaper::
3031 testpmd> set port tm node shared shaper (port_id) (shared_shaper_id) \
3036 * ``shared_shaper_id``: Shared shaper ID to be update.
3037 * ``shaper_profile id``: Shaper profile ID for shared shaper.
3039 Delete port traffic management shared shaper
3040 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3042 Delete the port traffic management shared shaper::
3044 testpmd> del port tm node shared shaper (port_id) (shared_shaper_id)
3048 * ``shared_shaper_id``: Shared shaper ID to be deleted.
3050 Set port traffic management hierarchy node private shaper
3051 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3053 set the port traffic management hierarchy node private shaper::
3055 testpmd> set port tm node shaper profile (port_id) (node_id) \
3060 * ``shaper_profile id``: Private shaper profile ID to be enabled on the
3063 Add port traffic management WRED profile
3064 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3066 Create a new WRED profile::
3068 testpmd> add port tm node wred profile (port_id) (wred_profile_id) \
3069 (color_g) (min_th_g) (max_th_g) (maxp_inv_g) (wq_log2_g) \
3070 (color_y) (min_th_y) (max_th_y) (maxp_inv_y) (wq_log2_y) \
3071 (color_r) (min_th_r) (max_th_r) (maxp_inv_r) (wq_log2_r)
3075 * ``wred_profile id``: Identifier for the newly create WRED profile
3076 * ``color_g``: Packet color (green)
3077 * ``min_th_g``: Minimum queue threshold for packet with green color
3078 * ``max_th_g``: Minimum queue threshold for packet with green color
3079 * ``maxp_inv_g``: Inverse of packet marking probability maximum value (maxp)
3080 * ``wq_log2_g``: Negated log2 of queue weight (wq)
3081 * ``color_y``: Packet color (yellow)
3082 * ``min_th_y``: Minimum queue threshold for packet with yellow color
3083 * ``max_th_y``: Minimum queue threshold for packet with yellow color
3084 * ``maxp_inv_y``: Inverse of packet marking probability maximum value (maxp)
3085 * ``wq_log2_y``: Negated log2 of queue weight (wq)
3086 * ``color_r``: Packet color (red)
3087 * ``min_th_r``: Minimum queue threshold for packet with yellow color
3088 * ``max_th_r``: Minimum queue threshold for packet with yellow color
3089 * ``maxp_inv_r``: Inverse of packet marking probability maximum value (maxp)
3090 * ``wq_log2_r``: Negated log2 of queue weight (wq)
3092 Delete port traffic management WRED profile
3093 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3095 Delete the WRED profile::
3097 testpmd> del port tm node wred profile (port_id) (wred_profile_id)
3099 Add port traffic management hierarchy nonleaf node
3100 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3102 Add nonleaf node to port traffic management hierarchy::
3104 testpmd> add port tm nonleaf node (port_id) (node_id) (parent_node_id) \
3105 (priority) (weight) (level_id) (shaper_profile_id) \
3106 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3107 [(shared_shaper_0) (shared_shaper_1) ...] \
3111 * ``parent_node_id``: Node ID of the parent.
3112 * ``priority``: Node priority (highest node priority is zero). This is used by
3113 the SP algorithm running on the parent node for scheduling this node.
3114 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3115 to the weight sum of all siblings that have the same priority. It is used by
3116 the WFQ algorithm running on the parent node for scheduling this node.
3117 * ``level_id``: Hierarchy level of the node.
3118 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3120 * ``n_sp_priorities``: Number of strict priorities.
3121 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3122 * ``n_shared_shapers``: Number of shared shapers.
3123 * ``shared_shaper_id``: Shared shaper id.
3125 Add port traffic management hierarchy nonleaf node with packet mode
3126 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3128 Add nonleaf node with packet mode to port traffic management hierarchy::
3130 testpmd> add port tm nonleaf node pktmode (port_id) (node_id) (parent_node_id) \
3131 (priority) (weight) (level_id) (shaper_profile_id) \
3132 (n_sp_priorities) (stats_mask) (n_shared_shapers) \
3133 [(shared_shaper_0) (shared_shaper_1) ...] \
3137 * ``parent_node_id``: Node ID of the parent.
3138 * ``priority``: Node priority (highest node priority is zero). This is used by
3139 the SP algorithm running on the parent node for scheduling this node.
3140 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3141 to the weight sum of all siblings that have the same priority. It is used by
3142 the WFQ algorithm running on the parent node for scheduling this node.
3143 * ``level_id``: Hierarchy level of the node.
3144 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3146 * ``n_sp_priorities``: Number of strict priorities. Packet mode is enabled on
3148 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3149 * ``n_shared_shapers``: Number of shared shapers.
3150 * ``shared_shaper_id``: Shared shaper id.
3152 Add port traffic management hierarchy leaf node
3153 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3155 Add leaf node to port traffic management hierarchy::
3157 testpmd> add port tm leaf node (port_id) (node_id) (parent_node_id) \
3158 (priority) (weight) (level_id) (shaper_profile_id) \
3159 (cman_mode) (wred_profile_id) (stats_mask) (n_shared_shapers) \
3160 [(shared_shaper_id) (shared_shaper_id) ...] \
3164 * ``parent_node_id``: Node ID of the parent.
3165 * ``priority``: Node priority (highest node priority is zero). This is used by
3166 the SP algorithm running on the parent node for scheduling this node.
3167 * ``weight``: Node weight (lowest weight is one). The node weight is relative
3168 to the weight sum of all siblings that have the same priority. It is used by
3169 the WFQ algorithm running on the parent node for scheduling this node.
3170 * ``level_id``: Hierarchy level of the node.
3171 * ``shaper_profile_id``: Shaper profile ID of the private shaper to be used by
3173 * ``cman_mode``: Congestion management mode to be enabled for this node.
3174 * ``wred_profile_id``: WRED profile id to be enabled for this node.
3175 * ``stats_mask``: Mask of statistics counter types to be enabled for this node.
3176 * ``n_shared_shapers``: Number of shared shapers.
3177 * ``shared_shaper_id``: Shared shaper id.
3179 Delete port traffic management hierarchy node
3180 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3182 Delete node from port traffic management hierarchy::
3184 testpmd> del port tm node (port_id) (node_id)
3186 Update port traffic management hierarchy parent node
3187 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3189 Update port traffic management hierarchy parent node::
3191 testpmd> set port tm node parent (port_id) (node_id) (parent_node_id) \
3194 This function can only be called after the hierarchy commit invocation. Its
3195 success depends on the port support for this operation, as advertised through
3196 the port capability set. This function is valid for all nodes of the traffic
3197 management hierarchy except root node.
3199 Suspend port traffic management hierarchy node
3200 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3202 testpmd> suspend port tm node (port_id) (node_id)
3204 Resume port traffic management hierarchy node
3205 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3207 testpmd> resume port tm node (port_id) (node_id)
3209 Commit port traffic management hierarchy
3210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3212 Commit the traffic management hierarchy on the port::
3214 testpmd> port tm hierarchy commit (port_id) (clean_on_fail)
3218 * ``clean_on_fail``: When set to non-zero, hierarchy is cleared on function
3219 call failure. On the other hand, hierarchy is preserved when this parameter
3222 Set port traffic management mark VLAN dei
3223 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3225 Enables/Disables the traffic management marking on the port for VLAN packets::
3227 testpmd> set port tm mark vlan_dei <port_id> <green> <yellow> <red>
3231 * ``port_id``: The port which on which VLAN packets marked as ``green`` or
3232 ``yellow`` or ``red`` will have dei bit enabled
3234 * ``green`` enable 1, disable 0 marking for dei bit of VLAN packets marked as green
3236 * ``yellow`` enable 1, disable 0 marking for dei bit of VLAN packets marked as yellow
3238 * ``red`` enable 1, disable 0 marking for dei bit of VLAN packets marked as red
3240 Set port traffic management mark IP dscp
3241 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3243 Enables/Disables the traffic management marking on the port for IP dscp packets::
3245 testpmd> set port tm mark ip_dscp <port_id> <green> <yellow> <red>
3249 * ``port_id``: The port which on which IP packets marked as ``green`` or
3250 ``yellow`` or ``red`` will have IP dscp bits updated
3252 * ``green`` enable 1, disable 0 marking IP dscp to low drop precedence for green packets
3254 * ``yellow`` enable 1, disable 0 marking IP dscp to medium drop precedence for yellow packets
3256 * ``red`` enable 1, disable 0 marking IP dscp to high drop precedence for red packets
3258 Set port traffic management mark IP ecn
3259 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3261 Enables/Disables the traffic management marking on the port for IP ecn packets::
3263 testpmd> set port tm mark ip_ecn <port_id> <green> <yellow> <red>
3267 * ``port_id``: The port which on which IP packets marked as ``green`` or
3268 ``yellow`` or ``red`` will have IP ecn bits updated
3270 * ``green`` enable 1, disable 0 marking IP ecn for green marked packets with ecn of 2'b01 or 2'b10
3271 to ecn of 2'b11 when IP is caring TCP or SCTP
3273 * ``yellow`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3274 to ecn of 2'b11 when IP is caring TCP or SCTP
3276 * ``red`` enable 1, disable 0 marking IP ecn for yellow marked packets with ecn of 2'b01 or 2'b10
3277 to ecn of 2'b11 when IP is caring TCP or SCTP
3282 This section details the available filter functions that are available.
3284 Note these functions interface the deprecated legacy filtering framework,
3285 superseded by *rte_flow*. See `Flow rules management`_.
3288 ~~~~~~~~~~~~~~~~~~~~
3290 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
3292 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
3293 ethertype (ether_type) (drop|fwd) queue (queue_id)
3295 The available information parameters are:
3297 * ``port_id``: The port which the Ethertype filter assigned on.
3299 * ``mac_addr``: Compare destination mac address.
3301 * ``mac_ignr``: Ignore destination mac address match.
3303 * ``mac_address``: Destination mac address to match.
3305 * ``ether_type``: The EtherType value want to match,
3306 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
3308 * ``queue_id``: The receive queue associated with this EtherType filter.
3309 It is meaningless when deleting or dropping.
3311 Example, to add/remove an ethertype filter rule::
3313 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
3314 ethertype 0x0806 fwd queue 3
3316 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
3317 ethertype 0x0806 fwd queue 3
3322 Add or delete a 2-tuple filter,
3323 which identifies packets by specific protocol and destination TCP/UDP port
3324 and forwards packets into one of the receive queues::
3326 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
3327 protocol (protocol_value) mask (mask_value) \
3328 tcp_flags (tcp_flags_value) priority (prio_value) \
3331 The available information parameters are:
3333 * ``port_id``: The port which the 2-tuple filter assigned on.
3335 * ``dst_port_value``: Destination port in L4.
3337 * ``protocol_value``: IP L4 protocol.
3339 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
3341 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
3343 * ``prio_value``: Priority of this filter.
3345 * ``queue_id``: The receive queue associated with this 2-tuple filter.
3347 Example, to add/remove an 2tuple filter rule::
3349 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
3350 tcp_flags 0x02 priority 3 queue 3
3352 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
3353 tcp_flags 0x02 priority 3 queue 3
3358 Add or delete a 5-tuple filter,
3359 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
3360 and routes packets into one of the receive queues::
3362 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
3363 (src_address) dst_port (dst_port_value) \
3364 src_port (src_port_value) protocol (protocol_value) \
3365 mask (mask_value) tcp_flags (tcp_flags_value) \
3366 priority (prio_value) queue (queue_id)
3368 The available information parameters are:
3370 * ``port_id``: The port which the 5-tuple filter assigned on.
3372 * ``dst_address``: Destination IP address.
3374 * ``src_address``: Source IP address.
3376 * ``dst_port_value``: TCP/UDP destination port.
3378 * ``src_port_value``: TCP/UDP source port.
3380 * ``protocol_value``: L4 protocol.
3382 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
3384 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
3386 * ``prio_value``: The priority of this filter.
3388 * ``queue_id``: The receive queue associated with this 5-tuple filter.
3390 Example, to add/remove an 5tuple filter rule::
3392 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3393 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3394 flags 0x0 priority 3 queue 3
3396 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
3397 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
3398 flags 0x0 priority 3 queue 3
3403 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
3405 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
3407 The available information parameters are:
3409 * ``port_id``: The port which the SYN filter assigned on.
3411 * ``high``: This SYN filter has higher priority than other filters.
3413 * ``low``: This SYN filter has lower priority than other filters.
3415 * ``queue_id``: The receive queue associated with this SYN filter
3419 testpmd> syn_filter 0 add priority high queue 3
3424 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
3425 and routed into one of the receive queues::
3427 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
3428 mask (mask_value) priority (prio_value) queue (queue_id)
3430 The available information parameters are:
3432 * ``port_id``: The port which the Flex filter is assigned on.
3434 * ``len_value``: Filter length in bytes, no greater than 128.
3436 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
3438 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
3440 * ``prio_value``: The priority of this filter.
3442 * ``queue_id``: The receive queue associated with this Flex filter.
3446 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
3447 mask 000C priority 3 queue 3
3449 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
3450 mask 000C priority 3 queue 3
3453 .. _testpmd_flow_director:
3455 flow_director_filter
3456 ~~~~~~~~~~~~~~~~~~~~
3458 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
3460 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
3461 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
3463 * Perfect match filters.
3464 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3465 The masked fields are for IP flow.
3467 * Signature filters.
3468 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
3470 * Perfect-mac-vlan match filters.
3471 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3472 The masked fields are for MAC VLAN flow.
3474 * Perfect-tunnel match filters.
3475 The hardware checks a match between the masked fields of the received packets and the programmed filters.
3476 The masked fields are for tunnel flow.
3478 * Perfect-raw-flow-type match filters.
3479 The hardware checks a match between the masked fields of the received packets and pre-loaded raw (template) packet.
3480 The masked fields are specified by input sets.
3482 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
3483 per flow type and the flexible payload.
3485 The Flow Director can also mask out parts of all of these fields so that filters
3486 are only applied to certain fields or parts of the fields.
3488 Note that for raw flow type mode the source and destination fields in the
3489 raw packet buffer need to be presented in a reversed order with respect
3490 to the expected received packets.
3491 For example: IP source and destination addresses or TCP/UDP/SCTP
3492 source and destination ports
3494 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
3496 # Commands to add flow director filters of different flow types::
3498 flow_director_filter (port_id) mode IP (add|del|update) \
3499 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
3500 src (src_ip_address) dst (dst_ip_address) \
3501 tos (tos_value) proto (proto_value) ttl (ttl_value) \
3502 vlan (vlan_value) flexbytes (flexbytes_value) \
3503 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
3506 flow_director_filter (port_id) mode IP (add|del|update) \
3507 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
3508 src (src_ip_address) (src_port) \
3509 dst (dst_ip_address) (dst_port) \
3510 tos (tos_value) ttl (ttl_value) \
3511 vlan (vlan_value) flexbytes (flexbytes_value) \
3512 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
3515 flow_director_filter (port_id) mode IP (add|del|update) \
3516 flow (ipv4-sctp|ipv6-sctp) \
3517 src (src_ip_address) (src_port) \
3518 dst (dst_ip_address) (dst_port) \
3519 tos (tos_value) ttl (ttl_value) \
3520 tag (verification_tag) vlan (vlan_value) \
3521 flexbytes (flexbytes_value) (drop|fwd) \
3522 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
3524 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
3525 ether (ethertype) flexbytes (flexbytes_value) \
3526 (drop|fwd) pf|vf(vf_id) queue (queue_id)
3529 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
3530 mac (mac_address) vlan (vlan_value) \
3531 flexbytes (flexbytes_value) (drop|fwd) \
3532 queue (queue_id) fd_id (fd_id_value)
3534 flow_director_filter (port_id) mode Tunnel (add|del|update) \
3535 mac (mac_address) vlan (vlan_value) \
3536 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
3537 flexbytes (flexbytes_value) (drop|fwd) \
3538 queue (queue_id) fd_id (fd_id_value)
3540 flow_director_filter (port_id) mode raw (add|del|update) flow (flow_id) \
3541 (drop|fwd) queue (queue_id) fd_id (fd_id_value) \
3542 packet (packet file name)
3544 For example, to add an ipv4-udp flow type filter::
3546 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
3547 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
3548 fwd pf queue 1 fd_id 1
3550 For example, add an ipv4-other flow type filter::
3552 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
3553 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
3554 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
3559 Flush all flow director filters on a device::
3561 testpmd> flush_flow_director (port_id)
3563 Example, to flush all flow director filter on port 0::
3565 testpmd> flush_flow_director 0
3570 Set flow director's input masks::
3572 flow_director_mask (port_id) mode IP vlan (vlan_value) \
3573 src_mask (ipv4_src) (ipv6_src) (src_port) \
3574 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
3576 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value)
3578 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
3579 mac (mac_value) tunnel-type (tunnel_type_value) \
3580 tunnel-id (tunnel_id_value)
3582 Example, to set flow director mask on port 0::
3584 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
3585 src_mask 255.255.255.255 \
3586 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
3587 dst_mask 255.255.255.255 \
3588 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
3590 flow_director_flex_mask
3591 ~~~~~~~~~~~~~~~~~~~~~~~
3593 set masks of flow director's flexible payload based on certain flow type::
3595 testpmd> flow_director_flex_mask (port_id) \
3596 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3597 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
3598 l2_payload|all) (mask)
3600 Example, to set flow director's flex mask for all flow type on port 0::
3602 testpmd> flow_director_flex_mask 0 flow all \
3603 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
3606 flow_director_flex_payload
3607 ~~~~~~~~~~~~~~~~~~~~~~~~~~
3609 Configure flexible payload selection::
3611 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
3613 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
3615 testpmd> flow_director_flex_payload 0 l4 \
3616 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
3618 get_sym_hash_ena_per_port
3619 ~~~~~~~~~~~~~~~~~~~~~~~~~
3621 Get symmetric hash enable configuration per port::
3623 get_sym_hash_ena_per_port (port_id)
3625 For example, to get symmetric hash enable configuration of port 1::
3627 testpmd> get_sym_hash_ena_per_port 1
3629 set_sym_hash_ena_per_port
3630 ~~~~~~~~~~~~~~~~~~~~~~~~~
3632 Set symmetric hash enable configuration per port to enable or disable::
3634 set_sym_hash_ena_per_port (port_id) (enable|disable)
3636 For example, to set symmetric hash enable configuration of port 1 to enable::
3638 testpmd> set_sym_hash_ena_per_port 1 enable
3640 get_hash_global_config
3641 ~~~~~~~~~~~~~~~~~~~~~~
3643 Get the global configurations of hash filters::
3645 get_hash_global_config (port_id)
3647 For example, to get the global configurations of hash filters of port 1::
3649 testpmd> get_hash_global_config 1
3651 set_hash_global_config
3652 ~~~~~~~~~~~~~~~~~~~~~~
3654 Set the global configurations of hash filters::
3656 set_hash_global_config (port_id) (toeplitz|simple_xor|symmetric_toeplitz|default) \
3657 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
3658 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload|<flow_id>) \
3661 For example, to enable simple_xor for flow type of ipv6 on port 2::
3663 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
3668 Set the input set for hash::
3670 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3671 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3672 l2_payload|<flow_id>) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3673 ipv4-tos|ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
3674 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
3675 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
3676 fld-8th|none) (select|add)
3678 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
3680 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
3685 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
3686 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
3688 Set the input set for flow director::
3690 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
3691 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
3692 l2_payload|<flow_id>) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6| \
3693 ipv4-tos|ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
3694 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
3695 sctp-dst-port|sctp-veri-tag|none) (select|add)
3697 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
3699 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
3704 Set different GRE key length for input set::
3706 global_config (port_id) gre-key-len (number in bytes)
3708 For example to set GRE key length for input set to 4 bytes on port 0::
3710 testpmd> global_config 0 gre-key-len 4
3713 .. _testpmd_rte_flow:
3715 Flow rules management
3716 ---------------------
3718 Control of the generic flow API (*rte_flow*) is fully exposed through the
3719 ``flow`` command (validation, creation, destruction, queries and operation
3722 Considering *rte_flow* overlaps with all `Filter Functions`_, using both
3723 features simultaneously may cause undefined side-effects and is therefore
3729 Because the ``flow`` command uses dynamic tokens to handle the large number
3730 of possible flow rules combinations, its behavior differs slightly from
3731 other commands, in particular:
3733 - Pressing *?* or the *<tab>* key displays contextual help for the current
3734 token, not that of the entire command.
3736 - Optional and repeated parameters are supported (provided they are listed
3737 in the contextual help).
3739 The first parameter stands for the operation mode. Possible operations and
3740 their general syntax are described below. They are covered in detail in the
3743 - Check whether a flow rule can be created::
3745 flow validate {port_id}
3746 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3747 pattern {item} [/ {item} [...]] / end
3748 actions {action} [/ {action} [...]] / end
3750 - Create a flow rule::
3752 flow create {port_id}
3753 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3754 pattern {item} [/ {item} [...]] / end
3755 actions {action} [/ {action} [...]] / end
3757 - Destroy specific flow rules::
3759 flow destroy {port_id} rule {rule_id} [...]
3761 - Destroy all flow rules::
3763 flow flush {port_id}
3765 - Query an existing flow rule::
3767 flow query {port_id} {rule_id} {action}
3769 - List existing flow rules sorted by priority, filtered by group
3772 flow list {port_id} [group {group_id}] [...]
3774 - Restrict ingress traffic to the defined flow rules::
3776 flow isolate {port_id} {boolean}
3778 - Dump internal representation information of all flows in hardware::
3780 flow dump {port_id} {output_file}
3782 - List and destroy aged flow rules::
3784 flow aged {port_id} [destroy]
3786 - Tunnel offload - create a tunnel stub::
3788 flow tunnel create {port_id} type {tunnel_type}
3790 - Tunnel offload - destroy a tunnel stub::
3792 flow tunnel destroy {port_id} id {tunnel_id}
3794 - Tunnel offload - list port tunnel stubs::
3796 flow tunnel list {port_id}
3798 Creating a tunnel stub for offload
3799 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3801 ``flow tunnel create`` setup a tunnel stub for tunnel offload flow rules::
3803 flow tunnel create {port_id} type {tunnel_type}
3805 If successful, it will return a tunnel stub ID usable with other commands::
3807 port [...]: flow tunnel #[...] type [...]
3809 Tunnel stub ID is relative to a port.
3811 Destroying tunnel offload stub
3812 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3814 ``flow tunnel destroy`` destroy port tunnel stub::
3816 flow tunnel destroy {port_id} id {tunnel_id}
3818 Listing tunnel offload stubs
3819 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3821 ``flow tunnel list`` list port tunnel offload stubs::
3823 flow tunnel list {port_id}
3825 Validating flow rules
3826 ~~~~~~~~~~~~~~~~~~~~~
3828 ``flow validate`` reports whether a flow rule would be accepted by the
3829 underlying device in its current state but stops short of creating it. It is
3830 bound to ``rte_flow_validate()``::
3832 flow validate {port_id}
3833 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3834 pattern {item} [/ {item} [...]] / end
3835 actions {action} [/ {action} [...]] / end
3837 If successful, it will show::
3841 Otherwise it will show an error message of the form::
3843 Caught error type [...] ([...]): [...]
3845 This command uses the same parameters as ``flow create``, their format is
3846 described in `Creating flow rules`_.
3848 Check whether redirecting any Ethernet packet received on port 0 to RX queue
3849 index 6 is supported::
3851 testpmd> flow validate 0 ingress pattern eth / end
3852 actions queue index 6 / end
3856 Port 0 does not support TCPv6 rules::
3858 testpmd> flow validate 0 ingress pattern eth / ipv6 / tcp / end
3860 Caught error type 9 (specific pattern item): Invalid argument
3866 ``flow create`` validates and creates the specified flow rule. It is bound
3867 to ``rte_flow_create()``::
3869 flow create {port_id}
3870 [group {group_id}] [priority {level}] [ingress] [egress] [transfer]
3871 [tunnel_set {tunnel_id}] [tunnel_match {tunnel_id}]
3872 pattern {item} [/ {item} [...]] / end
3873 actions {action} [/ {action} [...]] / end
3875 If successful, it will return a flow rule ID usable with other commands::
3877 Flow rule #[...] created
3879 Otherwise it will show an error message of the form::
3881 Caught error type [...] ([...]): [...]
3883 Parameters describe in the following order:
3885 - Attributes (*group*, *priority*, *ingress*, *egress*, *transfer* tokens).
3886 - Tunnel offload specification (tunnel_set, tunnel_match)
3887 - A matching pattern, starting with the *pattern* token and terminated by an
3889 - Actions, starting with the *actions* token and terminated by an *end*
3892 These translate directly to *rte_flow* objects provided as-is to the
3893 underlying functions.
3895 The shortest valid definition only comprises mandatory tokens::
3897 testpmd> flow create 0 pattern end actions end
3899 Note that PMDs may refuse rules that essentially do nothing such as this
3902 **All unspecified object values are automatically initialized to 0.**
3907 These tokens affect flow rule attributes (``struct rte_flow_attr``) and are
3908 specified before the ``pattern`` token.
3910 - ``group {group id}``: priority group.
3911 - ``priority {level}``: priority level within group.
3912 - ``ingress``: rule applies to ingress traffic.
3913 - ``egress``: rule applies to egress traffic.
3914 - ``transfer``: apply rule directly to endpoints found in pattern.
3916 Each instance of an attribute specified several times overrides the previous
3917 value as shown below (group 4 is used)::
3919 testpmd> flow create 0 group 42 group 24 group 4 [...]
3921 Note that once enabled, ``ingress`` and ``egress`` cannot be disabled.
3923 While not specifying a direction is an error, some rules may allow both
3926 Most rules affect RX therefore contain the ``ingress`` token::
3928 testpmd> flow create 0 ingress pattern [...]
3933 Indicate tunnel offload rule type
3935 - ``tunnel_set {tunnel_id}``: mark rule as tunnel offload decap_set type.
3936 - ``tunnel_match {tunnel_id}``: mark rule as tunel offload match type.
3941 A matching pattern starts after the ``pattern`` token. It is made of pattern
3942 items and is terminated by a mandatory ``end`` item.
3944 Items are named after their type (*RTE_FLOW_ITEM_TYPE_* from ``enum
3945 rte_flow_item_type``).
3947 The ``/`` token is used as a separator between pattern items as shown
3950 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end [...]
3952 Note that protocol items like these must be stacked from lowest to highest
3953 layer to make sense. For instance, the following rule is either invalid or
3954 unlikely to match any packet::
3956 testpmd> flow create 0 ingress pattern eth / udp / ipv4 / end [...]
3958 More information on these restrictions can be found in the *rte_flow*
3961 Several items support additional specification structures, for example
3962 ``ipv4`` allows specifying source and destination addresses as follows::
3964 testpmd> flow create 0 ingress pattern eth / ipv4 src is 10.1.1.1
3965 dst is 10.2.0.0 / end [...]
3967 This rule matches all IPv4 traffic with the specified properties.
3969 In this example, ``src`` and ``dst`` are field names of the underlying
3970 ``struct rte_flow_item_ipv4`` object. All item properties can be specified
3971 in a similar fashion.
3973 The ``is`` token means that the subsequent value must be matched exactly,
3974 and assigns ``spec`` and ``mask`` fields in ``struct rte_flow_item``
3975 accordingly. Possible assignment tokens are:
3977 - ``is``: match value perfectly (with full bit-mask).
3978 - ``spec``: match value according to configured bit-mask.
3979 - ``last``: specify upper bound to establish a range.
3980 - ``mask``: specify bit-mask with relevant bits set to one.
3981 - ``prefix``: generate bit-mask with <prefix-length> most-significant bits set to one.
3983 These yield identical results::
3985 ipv4 src is 10.1.1.1
3989 ipv4 src spec 10.1.1.1 src mask 255.255.255.255
3993 ipv4 src spec 10.1.1.1 src prefix 32
3997 ipv4 src is 10.1.1.1 src last 10.1.1.1 # range with a single value
4001 ipv4 src is 10.1.1.1 src last 0 # 0 disables range
4003 Inclusive ranges can be defined with ``last``::
4005 ipv4 src is 10.1.1.1 src last 10.2.3.4 # 10.1.1.1 to 10.2.3.4
4007 Note that ``mask`` affects both ``spec`` and ``last``::
4009 ipv4 src is 10.1.1.1 src last 10.2.3.4 src mask 255.255.0.0
4010 # matches 10.1.0.0 to 10.2.255.255
4012 Properties can be modified multiple times::
4014 ipv4 src is 10.1.1.1 src is 10.1.2.3 src is 10.2.3.4 # matches 10.2.3.4
4018 ipv4 src is 10.1.1.1 src prefix 24 src prefix 16 # matches 10.1.0.0/16
4023 This section lists supported pattern items and their attributes, if any.
4025 - ``end``: end list of pattern items.
4027 - ``void``: no-op pattern item.
4029 - ``invert``: perform actions when pattern does not match.
4031 - ``any``: match any protocol for the current layer.
4033 - ``num {unsigned}``: number of layers covered.
4035 - ``pf``: match traffic from/to the physical function.
4037 - ``vf``: match traffic from/to a virtual function ID.
4039 - ``id {unsigned}``: VF ID.
4041 - ``phy_port``: match traffic from/to a specific physical port.
4043 - ``index {unsigned}``: physical port index.
4045 - ``port_id``: match traffic from/to a given DPDK port ID.
4047 - ``id {unsigned}``: DPDK port ID.
4049 - ``mark``: match value set in previously matched flow rule using the mark action.
4051 - ``id {unsigned}``: arbitrary integer value.
4053 - ``raw``: match an arbitrary byte string.
4055 - ``relative {boolean}``: look for pattern after the previous item.
4056 - ``search {boolean}``: search pattern from offset (see also limit).
4057 - ``offset {integer}``: absolute or relative offset for pattern.
4058 - ``limit {unsigned}``: search area limit for start of pattern.
4059 - ``pattern {string}``: byte string to look for.
4061 - ``eth``: match Ethernet header.
4063 - ``dst {MAC-48}``: destination MAC.
4064 - ``src {MAC-48}``: source MAC.
4065 - ``type {unsigned}``: EtherType or TPID.
4067 - ``vlan``: match 802.1Q/ad VLAN tag.
4069 - ``tci {unsigned}``: tag control information.
4070 - ``pcp {unsigned}``: priority code point.
4071 - ``dei {unsigned}``: drop eligible indicator.
4072 - ``vid {unsigned}``: VLAN identifier.
4073 - ``inner_type {unsigned}``: inner EtherType or TPID.
4075 - ``ipv4``: match IPv4 header.
4077 - ``tos {unsigned}``: type of service.
4078 - ``ttl {unsigned}``: time to live.
4079 - ``proto {unsigned}``: next protocol ID.
4080 - ``src {ipv4 address}``: source address.
4081 - ``dst {ipv4 address}``: destination address.
4083 - ``ipv6``: match IPv6 header.
4085 - ``tc {unsigned}``: traffic class.
4086 - ``flow {unsigned}``: flow label.
4087 - ``proto {unsigned}``: protocol (next header).
4088 - ``hop {unsigned}``: hop limit.
4089 - ``src {ipv6 address}``: source address.
4090 - ``dst {ipv6 address}``: destination address.
4092 - ``icmp``: match ICMP header.
4094 - ``type {unsigned}``: ICMP packet type.
4095 - ``code {unsigned}``: ICMP packet code.
4097 - ``udp``: match UDP header.
4099 - ``src {unsigned}``: UDP source port.
4100 - ``dst {unsigned}``: UDP destination port.
4102 - ``tcp``: match TCP header.
4104 - ``src {unsigned}``: TCP source port.
4105 - ``dst {unsigned}``: TCP destination port.
4107 - ``sctp``: match SCTP header.
4109 - ``src {unsigned}``: SCTP source port.
4110 - ``dst {unsigned}``: SCTP destination port.
4111 - ``tag {unsigned}``: validation tag.
4112 - ``cksum {unsigned}``: checksum.
4114 - ``vxlan``: match VXLAN header.
4116 - ``vni {unsigned}``: VXLAN identifier.
4118 - ``e_tag``: match IEEE 802.1BR E-Tag header.
4120 - ``grp_ecid_b {unsigned}``: GRP and E-CID base.
4122 - ``nvgre``: match NVGRE header.
4124 - ``tni {unsigned}``: virtual subnet ID.
4126 - ``mpls``: match MPLS header.
4128 - ``label {unsigned}``: MPLS label.
4130 - ``gre``: match GRE header.
4132 - ``protocol {unsigned}``: protocol type.
4134 - ``gre_key``: match GRE optional key field.
4136 - ``value {unsigned}``: key value.
4138 - ``fuzzy``: fuzzy pattern match, expect faster than default.
4140 - ``thresh {unsigned}``: accuracy threshold.
4142 - ``gtp``, ``gtpc``, ``gtpu``: match GTPv1 header.
4144 - ``teid {unsigned}``: tunnel endpoint identifier.
4146 - ``geneve``: match GENEVE header.
4148 - ``vni {unsigned}``: virtual network identifier.
4149 - ``protocol {unsigned}``: protocol type.
4151 - ``vxlan-gpe``: match VXLAN-GPE header.
4153 - ``vni {unsigned}``: VXLAN-GPE identifier.
4155 - ``arp_eth_ipv4``: match ARP header for Ethernet/IPv4.
4157 - ``sha {MAC-48}``: sender hardware address.
4158 - ``spa {ipv4 address}``: sender IPv4 address.
4159 - ``tha {MAC-48}``: target hardware address.
4160 - ``tpa {ipv4 address}``: target IPv4 address.
4162 - ``ipv6_ext``: match presence of any IPv6 extension header.
4164 - ``next_hdr {unsigned}``: next header.
4166 - ``icmp6``: match any ICMPv6 header.
4168 - ``type {unsigned}``: ICMPv6 type.
4169 - ``code {unsigned}``: ICMPv6 code.
4171 - ``icmp6_nd_ns``: match ICMPv6 neighbor discovery solicitation.
4173 - ``target_addr {ipv6 address}``: target address.
4175 - ``icmp6_nd_na``: match ICMPv6 neighbor discovery advertisement.
4177 - ``target_addr {ipv6 address}``: target address.
4179 - ``icmp6_nd_opt``: match presence of any ICMPv6 neighbor discovery option.
4181 - ``type {unsigned}``: ND option type.
4183 - ``icmp6_nd_opt_sla_eth``: match ICMPv6 neighbor discovery source Ethernet
4184 link-layer address option.
4186 - ``sla {MAC-48}``: source Ethernet LLA.
4188 - ``icmp6_nd_opt_tla_eth``: match ICMPv6 neighbor discovery target Ethernet
4189 link-layer address option.
4191 - ``tla {MAC-48}``: target Ethernet LLA.
4193 - ``meta``: match application specific metadata.
4195 - ``data {unsigned}``: metadata value.
4197 - ``gtp_psc``: match GTP PDU extension header with type 0x85.
4199 - ``pdu_type {unsigned}``: PDU type.
4200 - ``qfi {unsigned}``: QoS flow identifier.
4202 - ``pppoes``, ``pppoed``: match PPPoE header.
4204 - ``session_id {unsigned}``: session identifier.
4206 - ``pppoe_proto_id``: match PPPoE session protocol identifier.
4208 - ``proto_id {unsigned}``: PPP protocol identifier.
4210 - ``l2tpv3oip``: match L2TPv3 over IP header.
4212 - ``session_id {unsigned}``: L2TPv3 over IP session identifier.
4214 - ``ah``: match AH header.
4216 - ``spi {unsigned}``: security parameters index.
4218 - ``pfcp``: match PFCP header.
4220 - ``s_field {unsigned}``: S field.
4221 - ``seid {unsigned}``: session endpoint identifier.
4226 A list of actions starts after the ``actions`` token in the same fashion as
4227 `Matching pattern`_; actions are separated by ``/`` tokens and the list is
4228 terminated by a mandatory ``end`` action.
4230 Actions are named after their type (*RTE_FLOW_ACTION_TYPE_* from ``enum
4231 rte_flow_action_type``).
4233 Dropping all incoming UDPv4 packets can be expressed as follows::
4235 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4238 Several actions have configurable properties which must be specified when
4239 there is no valid default value. For example, ``queue`` requires a target
4242 This rule redirects incoming UDPv4 traffic to queue index 6::
4244 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4245 actions queue index 6 / end
4247 While this one could be rejected by PMDs (unspecified queue index)::
4249 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / end
4252 As defined by *rte_flow*, the list is not ordered, all actions of a given
4253 rule are performed simultaneously. These are equivalent::
4255 queue index 6 / void / mark id 42 / end
4259 void / mark id 42 / queue index 6 / end
4261 All actions in a list should have different types, otherwise only the last
4262 action of a given type is taken into account::
4264 queue index 4 / queue index 5 / queue index 6 / end # will use queue 6
4268 drop / drop / drop / end # drop is performed only once
4272 mark id 42 / queue index 3 / mark id 24 / end # mark will be 24
4274 Considering they are performed simultaneously, opposite and overlapping
4275 actions can sometimes be combined when the end result is unambiguous::
4277 drop / queue index 6 / end # drop has no effect
4281 queue index 6 / rss queues 6 7 8 / end # queue has no effect
4285 drop / passthru / end # drop has no effect
4287 Note that PMDs may still refuse such combinations.
4292 This section lists supported actions and their attributes, if any.
4294 - ``end``: end list of actions.
4296 - ``void``: no-op action.
4298 - ``passthru``: let subsequent rule process matched packets.
4300 - ``jump``: redirect traffic to group on device.
4302 - ``group {unsigned}``: group to redirect to.
4304 - ``mark``: attach 32 bit value to packets.
4306 - ``id {unsigned}``: 32 bit value to return with packets.
4308 - ``flag``: flag packets.
4310 - ``queue``: assign packets to a given queue index.
4312 - ``index {unsigned}``: queue index to use.
4314 - ``drop``: drop packets (note: passthru has priority).
4316 - ``count``: enable counters for this rule.
4318 - ``rss``: spread packets among several queues.
4320 - ``func {hash function}``: RSS hash function to apply, allowed tokens are
4321 the same as `set_hash_global_config`_.
4323 - ``level {unsigned}``: encapsulation level for ``types``.
4325 - ``types [{RSS hash type} [...]] end``: specific RSS hash types, allowed
4326 tokens are the same as `set_hash_input_set`_, except that an empty list
4327 does not disable RSS but instead requests unspecified "best-effort"
4330 - ``key {string}``: RSS hash key, overrides ``key_len``.
4332 - ``key_len {unsigned}``: RSS hash key length in bytes, can be used in
4333 conjunction with ``key`` to pad or truncate it.
4335 - ``queues [{unsigned} [...]] end``: queue indices to use.
4337 - ``pf``: direct traffic to physical function.
4339 - ``vf``: direct traffic to a virtual function ID.
4341 - ``original {boolean}``: use original VF ID if possible.
4342 - ``id {unsigned}``: VF ID.
4344 - ``phy_port``: direct packets to physical port index.
4346 - ``original {boolean}``: use original port index if possible.
4347 - ``index {unsigned}``: physical port index.
4349 - ``port_id``: direct matching traffic to a given DPDK port ID.
4351 - ``original {boolean}``: use original DPDK port ID if possible.
4352 - ``id {unsigned}``: DPDK port ID.
4354 - ``of_set_mpls_ttl``: OpenFlow's ``OFPAT_SET_MPLS_TTL``.
4356 - ``mpls_ttl``: MPLS TTL.
4358 - ``of_dec_mpls_ttl``: OpenFlow's ``OFPAT_DEC_MPLS_TTL``.
4360 - ``of_set_nw_ttl``: OpenFlow's ``OFPAT_SET_NW_TTL``.
4362 - ``nw_ttl``: IP TTL.
4364 - ``of_dec_nw_ttl``: OpenFlow's ``OFPAT_DEC_NW_TTL``.
4366 - ``of_copy_ttl_out``: OpenFlow's ``OFPAT_COPY_TTL_OUT``.
4368 - ``of_copy_ttl_in``: OpenFlow's ``OFPAT_COPY_TTL_IN``.
4370 - ``of_pop_vlan``: OpenFlow's ``OFPAT_POP_VLAN``.
4372 - ``of_push_vlan``: OpenFlow's ``OFPAT_PUSH_VLAN``.
4374 - ``ethertype``: Ethertype.
4376 - ``of_set_vlan_vid``: OpenFlow's ``OFPAT_SET_VLAN_VID``.
4378 - ``vlan_vid``: VLAN id.
4380 - ``of_set_vlan_pcp``: OpenFlow's ``OFPAT_SET_VLAN_PCP``.
4382 - ``vlan_pcp``: VLAN priority.
4384 - ``of_pop_mpls``: OpenFlow's ``OFPAT_POP_MPLS``.
4386 - ``ethertype``: Ethertype.
4388 - ``of_push_mpls``: OpenFlow's ``OFPAT_PUSH_MPLS``.
4390 - ``ethertype``: Ethertype.
4392 - ``vxlan_encap``: Performs a VXLAN encapsulation, outer layer configuration
4393 is done through `Config VXLAN Encap outer layers`_.
4395 - ``vxlan_decap``: Performs a decapsulation action by stripping all headers of
4396 the VXLAN tunnel network overlay from the matched flow.
4398 - ``nvgre_encap``: Performs a NVGRE encapsulation, outer layer configuration
4399 is done through `Config NVGRE Encap outer layers`_.
4401 - ``nvgre_decap``: Performs a decapsulation action by stripping all headers of
4402 the NVGRE tunnel network overlay from the matched flow.
4404 - ``l2_encap``: Performs a L2 encapsulation, L2 configuration
4405 is done through `Config L2 Encap`_.
4407 - ``l2_decap``: Performs a L2 decapsulation, L2 configuration
4408 is done through `Config L2 Decap`_.
4410 - ``mplsogre_encap``: Performs a MPLSoGRE encapsulation, outer layer
4411 configuration is done through `Config MPLSoGRE Encap outer layers`_.
4413 - ``mplsogre_decap``: Performs a MPLSoGRE decapsulation, outer layer
4414 configuration is done through `Config MPLSoGRE Decap outer layers`_.
4416 - ``mplsoudp_encap``: Performs a MPLSoUDP encapsulation, outer layer
4417 configuration is done through `Config MPLSoUDP Encap outer layers`_.
4419 - ``mplsoudp_decap``: Performs a MPLSoUDP decapsulation, outer layer
4420 configuration is done through `Config MPLSoUDP Decap outer layers`_.
4422 - ``set_ipv4_src``: Set a new IPv4 source address in the outermost IPv4 header.
4424 - ``ipv4_addr``: New IPv4 source address.
4426 - ``set_ipv4_dst``: Set a new IPv4 destination address in the outermost IPv4
4429 - ``ipv4_addr``: New IPv4 destination address.
4431 - ``set_ipv6_src``: Set a new IPv6 source address in the outermost IPv6 header.
4433 - ``ipv6_addr``: New IPv6 source address.
4435 - ``set_ipv6_dst``: Set a new IPv6 destination address in the outermost IPv6
4438 - ``ipv6_addr``: New IPv6 destination address.
4440 - ``set_tp_src``: Set a new source port number in the outermost TCP/UDP
4443 - ``port``: New TCP/UDP source port number.
4445 - ``set_tp_dst``: Set a new destination port number in the outermost TCP/UDP
4448 - ``port``: New TCP/UDP destination port number.
4450 - ``mac_swap``: Swap the source and destination MAC addresses in the outermost
4453 - ``dec_ttl``: Performs a decrease TTL value action
4455 - ``set_ttl``: Set TTL value with specified value
4456 - ``ttl_value {unsigned}``: The new TTL value to be set
4458 - ``set_mac_src``: set source MAC address
4460 - ``mac_addr {MAC-48}``: new source MAC address
4462 - ``set_mac_dst``: set destination MAC address
4464 - ``mac_addr {MAC-48}``: new destination MAC address
4466 - ``inc_tcp_seq``: Increase sequence number in the outermost TCP header.
4468 - ``value {unsigned}``: Value to increase TCP sequence number by.
4470 - ``dec_tcp_seq``: Decrease sequence number in the outermost TCP header.
4472 - ``value {unsigned}``: Value to decrease TCP sequence number by.
4474 - ``inc_tcp_ack``: Increase acknowledgment number in the outermost TCP header.
4476 - ``value {unsigned}``: Value to increase TCP acknowledgment number by.
4478 - ``dec_tcp_ack``: Decrease acknowledgment number in the outermost TCP header.
4480 - ``value {unsigned}``: Value to decrease TCP acknowledgment number by.
4482 - ``set_ipv4_dscp``: Set IPv4 DSCP value with specified value
4484 - ``dscp_value {unsigned}``: The new DSCP value to be set
4486 - ``set_ipv6_dscp``: Set IPv6 DSCP value with specified value
4488 - ``dscp_value {unsigned}``: The new DSCP value to be set
4490 - ``shared``: Use shared action created via
4491 ``flow shared_action {port_id} create``
4493 - ``shared_action_id {unsigned}``: Shared action ID to use
4495 Destroying flow rules
4496 ~~~~~~~~~~~~~~~~~~~~~
4498 ``flow destroy`` destroys one or more rules from their rule ID (as returned
4499 by ``flow create``), this command calls ``rte_flow_destroy()`` as many
4500 times as necessary::
4502 flow destroy {port_id} rule {rule_id} [...]
4504 If successful, it will show::
4506 Flow rule #[...] destroyed
4508 It does not report anything for rule IDs that do not exist. The usual error
4509 message is shown when a rule cannot be destroyed::
4511 Caught error type [...] ([...]): [...]
4513 ``flow flush`` destroys all rules on a device and does not take extra
4514 arguments. It is bound to ``rte_flow_flush()``::
4516 flow flush {port_id}
4518 Any errors are reported as above.
4520 Creating several rules and destroying them::
4522 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4523 actions queue index 2 / end
4524 Flow rule #0 created
4525 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4526 actions queue index 3 / end
4527 Flow rule #1 created
4528 testpmd> flow destroy 0 rule 0 rule 1
4529 Flow rule #1 destroyed
4530 Flow rule #0 destroyed
4533 The same result can be achieved using ``flow flush``::
4535 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4536 actions queue index 2 / end
4537 Flow rule #0 created
4538 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4539 actions queue index 3 / end
4540 Flow rule #1 created
4541 testpmd> flow flush 0
4544 Non-existent rule IDs are ignored::
4546 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4547 actions queue index 2 / end
4548 Flow rule #0 created
4549 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4550 actions queue index 3 / end
4551 Flow rule #1 created
4552 testpmd> flow destroy 0 rule 42 rule 10 rule 2
4554 testpmd> flow destroy 0 rule 0
4555 Flow rule #0 destroyed
4561 ``flow query`` queries a specific action of a flow rule having that
4562 ability. Such actions collect information that can be reported using this
4563 command. It is bound to ``rte_flow_query()``::
4565 flow query {port_id} {rule_id} {action}
4567 If successful, it will display either the retrieved data for known actions
4568 or the following message::
4570 Cannot display result for action type [...] ([...])
4572 Otherwise, it will complain either that the rule does not exist or that some
4575 Flow rule #[...] not found
4579 Caught error type [...] ([...]): [...]
4581 Currently only the ``count`` action is supported. This action reports the
4582 number of packets that hit the flow rule and the total number of bytes. Its
4583 output has the following format::
4586 hits_set: [...] # whether "hits" contains a valid value
4587 bytes_set: [...] # whether "bytes" contains a valid value
4588 hits: [...] # number of packets
4589 bytes: [...] # number of bytes
4591 Querying counters for TCPv6 packets redirected to queue 6::
4593 testpmd> flow create 0 ingress pattern eth / ipv6 / tcp / end
4594 actions queue index 6 / count / end
4595 Flow rule #4 created
4596 testpmd> flow query 0 4 count
4607 ``flow list`` lists existing flow rules sorted by priority and optionally
4608 filtered by group identifiers::
4610 flow list {port_id} [group {group_id}] [...]
4612 This command only fails with the following message if the device does not
4617 Output consists of a header line followed by a short description of each
4618 flow rule, one per line. There is no output at all when no flow rules are
4619 configured on the device::
4621 ID Group Prio Attr Rule
4622 [...] [...] [...] [...] [...]
4624 ``Attr`` column flags:
4626 - ``i`` for ``ingress``.
4627 - ``e`` for ``egress``.
4629 Creating several flow rules and listing them::
4631 testpmd> flow create 0 ingress pattern eth / ipv4 / end
4632 actions queue index 6 / end
4633 Flow rule #0 created
4634 testpmd> flow create 0 ingress pattern eth / ipv6 / end
4635 actions queue index 2 / end
4636 Flow rule #1 created
4637 testpmd> flow create 0 priority 5 ingress pattern eth / ipv4 / udp / end
4638 actions rss queues 6 7 8 end / end
4639 Flow rule #2 created
4640 testpmd> flow list 0
4641 ID Group Prio Attr Rule
4642 0 0 0 i- ETH IPV4 => QUEUE
4643 1 0 0 i- ETH IPV6 => QUEUE
4644 2 0 5 i- ETH IPV4 UDP => RSS
4647 Rules are sorted by priority (i.e. group ID first, then priority level)::
4649 testpmd> flow list 1
4650 ID Group Prio Attr Rule
4651 0 0 0 i- ETH => COUNT
4652 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4653 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4654 1 24 0 i- ETH IPV4 UDP => QUEUE
4655 4 24 10 i- ETH IPV4 TCP => DROP
4656 3 24 20 i- ETH IPV4 => DROP
4657 2 24 42 i- ETH IPV4 UDP => QUEUE
4658 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4661 Output can be limited to specific groups::
4663 testpmd> flow list 1 group 0 group 63
4664 ID Group Prio Attr Rule
4665 0 0 0 i- ETH => COUNT
4666 6 0 500 i- ETH IPV6 TCP => DROP COUNT
4667 5 0 1000 i- ETH IPV6 ICMP => QUEUE
4668 7 63 0 i- ETH IPV6 UDP VXLAN => MARK QUEUE
4671 Toggling isolated mode
4672 ~~~~~~~~~~~~~~~~~~~~~~
4674 ``flow isolate`` can be used to tell the underlying PMD that ingress traffic
4675 must only be injected from the defined flow rules; that no default traffic
4676 is expected outside those rules and the driver is free to assign more
4677 resources to handle them. It is bound to ``rte_flow_isolate()``::
4679 flow isolate {port_id} {boolean}
4681 If successful, enabling or disabling isolated mode shows either::
4683 Ingress traffic on port [...]
4684 is now restricted to the defined flow rules
4688 Ingress traffic on port [...]
4689 is not restricted anymore to the defined flow rules
4691 Otherwise, in case of error::
4693 Caught error type [...] ([...]): [...]
4695 Mainly due to its side effects, PMDs supporting this mode may not have the
4696 ability to toggle it more than once without reinitializing affected ports
4697 first (e.g. by exiting testpmd).
4699 Enabling isolated mode::
4701 testpmd> flow isolate 0 true
4702 Ingress traffic on port 0 is now restricted to the defined flow rules
4705 Disabling isolated mode::
4707 testpmd> flow isolate 0 false
4708 Ingress traffic on port 0 is not restricted anymore to the defined flow rules
4711 Dumping HW internal information
4712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4714 ``flow dump`` dumps the hardware's internal representation information of
4715 all flows. It is bound to ``rte_flow_dev_dump()``::
4717 flow dump {port_id} {output_file}
4719 If successful, it will show::
4723 Otherwise, it will complain error occurred::
4725 Caught error type [...] ([...]): [...]
4727 Listing and destroying aged flow rules
4728 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4730 ``flow aged`` simply lists aged flow rules be get from api ``rte_flow_get_aged_flows``,
4731 and ``destroy`` parameter can be used to destroy those flow rules in PMD.
4733 flow aged {port_id} [destroy]
4735 Listing current aged flow rules::
4737 testpmd> flow aged 0
4738 Port 0 total aged flows: 0
4739 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.14 / end
4740 actions age timeout 5 / queue index 0 / end
4741 Flow rule #0 created
4742 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.15 / end
4743 actions age timeout 4 / queue index 0 / end
4744 Flow rule #1 created
4745 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.16 / end
4746 actions age timeout 2 / queue index 0 / end
4747 Flow rule #2 created
4748 testpmd> flow create 0 ingress pattern eth / ipv4 src is 2.2.2.17 / end
4749 actions age timeout 3 / queue index 0 / end
4750 Flow rule #3 created
4753 Aged Rules are simply list as command ``flow list {port_id}``, but strip the detail rule
4754 information, all the aged flows are sorted by the longest timeout time. For example, if
4755 those rules be configured in the same time, ID 2 will be the first aged out rule, the next
4756 will be ID 3, ID 1, ID 0::
4758 testpmd> flow aged 0
4759 Port 0 total aged flows: 4
4766 If attach ``destroy`` parameter, the command will destroy all the list aged flow rules.
4768 testpmd> flow aged 0 destroy
4769 Port 0 total aged flows: 4
4776 Flow rule #2 destroyed
4777 Flow rule #3 destroyed
4778 Flow rule #1 destroyed
4779 Flow rule #0 destroyed
4780 4 flows be destroyed
4781 testpmd> flow aged 0
4782 Port 0 total aged flows: 0
4784 Creating shared actions
4785 ~~~~~~~~~~~~~~~~~~~~~~~
4786 ``flow shared_action {port_id} create`` creates shared action with optional
4787 shared action ID. It is bound to ``rte_flow_shared_action_create()``::
4789 flow shared_action {port_id} create [action_id {shared_action_id}]
4790 [ingress] [egress] action {action} / end
4792 If successful, it will show::
4794 Shared action #[...] created
4796 Otherwise, it will complain either that shared action already exists or that
4797 some error occurred::
4799 Shared action #[...] is already assigned, delete it first
4803 Caught error type [...] ([...]): [...]
4805 Create shared rss action with id 100 to queues 1 and 2 on port 0::
4807 testpmd> flow shared_action 0 create action_id 100 \
4808 ingress action rss queues 1 2 end / end
4810 Create shared rss action with id assigned by testpmd to queues 1 and 2 on
4813 testpmd> flow shared_action 0 create action_id \
4814 ingress action rss queues 0 1 end / end
4816 Updating shared actions
4817 ~~~~~~~~~~~~~~~~~~~~~~~
4818 ``flow shared_action {port_id} update`` updates configuration of the shared
4819 action from its shared action ID (as returned by
4820 ``flow shared_action {port_id} create``). It is bound to
4821 ``rte_flow_shared_action_update()``::
4823 flow shared_action {port_id} update {shared_action_id}
4824 action {action} / end
4826 If successful, it will show::
4828 Shared action #[...] updated
4830 Otherwise, it will complain either that shared action not found or that some
4833 Failed to find shared action #[...] on port [...]
4837 Caught error type [...] ([...]): [...]
4839 Update shared rss action having id 100 on port 0 with rss to queues 0 and 3
4840 (in create example above rss queues were 1 and 2)::
4842 testpmd> flow shared_action 0 update 100 action rss queues 0 3 end / end
4844 Destroying shared actions
4845 ~~~~~~~~~~~~~~~~~~~~~~~~~
4846 ``flow shared_action {port_id} update`` destroys one or more shared actions
4847 from their shared action IDs (as returned by
4848 ``flow shared_action {port_id} create``). It is bound to
4849 ``rte_flow_shared_action_destroy()``::
4851 flow shared_action {port_id} destroy action_id {shared_action_id} [...]
4853 If successful, it will show::
4855 Shared action #[...] destroyed
4857 It does not report anything for shared action IDs that do not exist.
4858 The usual error message is shown when a shared action cannot be destroyed::
4860 Caught error type [...] ([...]): [...]
4862 Destroy shared actions having id 100 & 101::
4864 testpmd> flow shared_action 0 destroy action_id 100 action_id 101
4866 Query shared actions
4867 ~~~~~~~~~~~~~~~~~~~~
4868 ``flow shared_action {port_id} query`` queries the shared action from its
4869 shared action ID (as returned by ``flow shared_action {port_id} create``).
4870 It is bound to ``rte_flow_shared_action_query()``::
4872 flow shared_action {port_id} query {shared_action_id}
4874 Currently only rss shared action supported. If successful, it will show::
4879 Otherwise, it will complain either that shared action not found or that some
4882 Failed to find shared action #[...] on port [...]
4886 Caught error type [...] ([...]): [...]
4888 Query shared action having id 100::
4890 testpmd> flow shared_action 0 query 100
4892 Sample QinQ flow rules
4893 ~~~~~~~~~~~~~~~~~~~~~~
4895 Before creating QinQ rule(s) the following commands should be issued to enable QinQ::
4897 testpmd> port stop 0
4898 testpmd> vlan set qinq_strip on 0
4900 The above command sets the inner and outer TPID's to 0x8100.
4902 To change the TPID's the following commands should be used::
4904 testpmd> vlan set outer tpid 0xa100 0
4905 testpmd> vlan set inner tpid 0x9100 0
4906 testpmd> port start 0
4908 Validate and create a QinQ rule on port 0 to steer traffic to a VF queue in a VM.
4912 testpmd> flow validate 0 ingress pattern eth / vlan tci is 123 /
4913 vlan tci is 456 / end actions vf id 1 / queue index 0 / end
4914 Flow rule #0 validated
4916 testpmd> flow create 0 ingress pattern eth / vlan tci is 4 /
4917 vlan tci is 456 / end actions vf id 123 / queue index 0 / end
4918 Flow rule #0 created
4920 testpmd> flow list 0
4921 ID Group Prio Attr Rule
4922 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4924 Validate and create a QinQ rule on port 0 to steer traffic to a queue on the host.
4928 testpmd> flow validate 0 ingress pattern eth / vlan tci is 321 /
4929 vlan tci is 654 / end actions pf / queue index 0 / end
4930 Flow rule #1 validated
4932 testpmd> flow create 0 ingress pattern eth / vlan tci is 321 /
4933 vlan tci is 654 / end actions pf / queue index 1 / end
4934 Flow rule #1 created
4936 testpmd> flow list 0
4937 ID Group Prio Attr Rule
4938 0 0 0 i- ETH VLAN VLAN=>VF QUEUE
4939 1 0 0 i- ETH VLAN VLAN=>PF QUEUE
4941 Sample VXLAN encapsulation rule
4942 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4944 VXLAN encapsulation outer layer has default value pre-configured in testpmd
4945 source code, those can be changed by using the following commands
4947 IPv4 VXLAN outer header::
4949 testpmd> set vxlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src 127.0.0.1
4950 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4951 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4954 testpmd> set vxlan-with-vlan ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-src
4955 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
4956 eth-dst 22:22:22:22:22:22
4957 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4960 testpmd> set vxlan-tos-ttl ip-version ipv4 vni 4 udp-src 4 udp-dst 4 ip-tos 0
4961 ip-ttl 255 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
4962 eth-dst 22:22:22:22:22:22
4963 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4966 IPv6 VXLAN outer header::
4968 testpmd> set vxlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4 ip-src ::1
4969 ip-dst ::2222 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4970 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4973 testpmd> set vxlan-with-vlan ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4974 ip-src ::1 ip-dst ::2222 vlan-tci 34 eth-src 11:11:11:11:11:11
4975 eth-dst 22:22:22:22:22:22
4976 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4979 testpmd> set vxlan-tos-ttl ip-version ipv6 vni 4 udp-src 4 udp-dst 4
4980 ip-tos 0 ip-ttl 255 ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
4981 eth-dst 22:22:22:22:22:22
4982 testpmd> flow create 0 ingress pattern end actions vxlan_encap /
4985 Sample NVGRE encapsulation rule
4986 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4988 NVGRE encapsulation outer layer has default value pre-configured in testpmd
4989 source code, those can be changed by using the following commands
4991 IPv4 NVGRE outer header::
4993 testpmd> set nvgre ip-version ipv4 tni 4 ip-src 127.0.0.1 ip-dst 128.0.0.1
4994 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
4995 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
4998 testpmd> set nvgre-with-vlan ip-version ipv4 tni 4 ip-src 127.0.0.1
4999 ip-dst 128.0.0.1 vlan-tci 34 eth-src 11:11:11:11:11:11
5000 eth-dst 22:22:22:22:22:22
5001 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5004 IPv6 NVGRE outer header::
5006 testpmd> set nvgre ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
5007 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5008 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5011 testpmd> set nvgre-with-vlan ip-version ipv6 tni 4 ip-src ::1 ip-dst ::2222
5012 vlan-tci 34 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5013 testpmd> flow create 0 ingress pattern end actions nvgre_encap /
5016 Sample L2 encapsulation rule
5017 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5019 L2 encapsulation has default value pre-configured in testpmd
5020 source code, those can be changed by using the following commands
5024 testpmd> set l2_encap ip-version ipv4
5025 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5026 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5027 mplsoudp_decap / l2_encap / end
5029 L2 with VXLAN header::
5031 testpmd> set l2_encap-with-vlan ip-version ipv4 vlan-tci 34
5032 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5033 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5034 mplsoudp_decap / l2_encap / end
5036 Sample L2 decapsulation rule
5037 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5039 L2 decapsulation has default value pre-configured in testpmd
5040 source code, those can be changed by using the following commands
5044 testpmd> set l2_decap
5045 testpmd> flow create 0 egress pattern eth / end actions l2_decap / mplsoudp_encap /
5048 L2 with VXLAN header::
5050 testpmd> set l2_encap-with-vlan
5051 testpmd> flow create 0 egress pattern eth / end actions l2_encap / mplsoudp_encap /
5054 Sample MPLSoGRE encapsulation rule
5055 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5057 MPLSoGRE encapsulation outer layer has default value pre-configured in testpmd
5058 source code, those can be changed by using the following commands
5060 IPv4 MPLSoGRE outer header::
5062 testpmd> set mplsogre_encap ip-version ipv4 label 4
5063 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
5064 eth-dst 22:22:22:22:22:22
5065 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5066 mplsogre_encap / end
5068 IPv4 MPLSoGRE with VLAN outer header::
5070 testpmd> set mplsogre_encap-with-vlan ip-version ipv4 label 4
5071 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
5072 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5073 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5074 mplsogre_encap / end
5076 IPv6 MPLSoGRE outer header::
5078 testpmd> set mplsogre_encap ip-version ipv6 mask 4
5079 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
5080 eth-dst 22:22:22:22:22:22
5081 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5082 mplsogre_encap / end
5084 IPv6 MPLSoGRE with VLAN outer header::
5086 testpmd> set mplsogre_encap-with-vlan ip-version ipv6 mask 4
5087 ip-src ::1 ip-dst ::2222 vlan-tci 34
5088 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5089 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5090 mplsogre_encap / end
5092 Sample MPLSoGRE decapsulation rule
5093 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5095 MPLSoGRE decapsulation outer layer has default value pre-configured in testpmd
5096 source code, those can be changed by using the following commands
5098 IPv4 MPLSoGRE outer header::
5100 testpmd> set mplsogre_decap ip-version ipv4
5101 testpmd> flow create 0 ingress pattern eth / ipv4 / gre / mpls / end actions
5102 mplsogre_decap / l2_encap / end
5104 IPv4 MPLSoGRE with VLAN outer header::
5106 testpmd> set mplsogre_decap-with-vlan ip-version ipv4
5107 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / gre / mpls / end
5108 actions mplsogre_decap / l2_encap / end
5110 IPv6 MPLSoGRE outer header::
5112 testpmd> set mplsogre_decap ip-version ipv6
5113 testpmd> flow create 0 ingress pattern eth / ipv6 / gre / mpls / end
5114 actions mplsogre_decap / l2_encap / end
5116 IPv6 MPLSoGRE with VLAN outer header::
5118 testpmd> set mplsogre_decap-with-vlan ip-version ipv6
5119 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / gre / mpls / end
5120 actions mplsogre_decap / l2_encap / end
5122 Sample MPLSoUDP encapsulation rule
5123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5125 MPLSoUDP encapsulation outer layer has default value pre-configured in testpmd
5126 source code, those can be changed by using the following commands
5128 IPv4 MPLSoUDP outer header::
5130 testpmd> set mplsoudp_encap ip-version ipv4 label 4 udp-src 5 udp-dst 10
5131 ip-src 127.0.0.1 ip-dst 128.0.0.1 eth-src 11:11:11:11:11:11
5132 eth-dst 22:22:22:22:22:22
5133 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5134 mplsoudp_encap / end
5136 IPv4 MPLSoUDP with VLAN outer header::
5138 testpmd> set mplsoudp_encap-with-vlan ip-version ipv4 label 4 udp-src 5
5139 udp-dst 10 ip-src 127.0.0.1 ip-dst 128.0.0.1 vlan-tci 34
5140 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5141 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5142 mplsoudp_encap / end
5144 IPv6 MPLSoUDP outer header::
5146 testpmd> set mplsoudp_encap ip-version ipv6 mask 4 udp-src 5 udp-dst 10
5147 ip-src ::1 ip-dst ::2222 eth-src 11:11:11:11:11:11
5148 eth-dst 22:22:22:22:22:22
5149 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5150 mplsoudp_encap / end
5152 IPv6 MPLSoUDP with VLAN outer header::
5154 testpmd> set mplsoudp_encap-with-vlan ip-version ipv6 mask 4 udp-src 5
5155 udp-dst 10 ip-src ::1 ip-dst ::2222 vlan-tci 34
5156 eth-src 11:11:11:11:11:11 eth-dst 22:22:22:22:22:22
5157 testpmd> flow create 0 egress pattern eth / end actions l2_decap /
5158 mplsoudp_encap / end
5160 Sample MPLSoUDP decapsulation rule
5161 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5163 MPLSoUDP decapsulation outer layer has default value pre-configured in testpmd
5164 source code, those can be changed by using the following commands
5166 IPv4 MPLSoUDP outer header::
5168 testpmd> set mplsoudp_decap ip-version ipv4
5169 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / mpls / end actions
5170 mplsoudp_decap / l2_encap / end
5172 IPv4 MPLSoUDP with VLAN outer header::
5174 testpmd> set mplsoudp_decap-with-vlan ip-version ipv4
5175 testpmd> flow create 0 ingress pattern eth / vlan / ipv4 / udp / mpls / end
5176 actions mplsoudp_decap / l2_encap / end
5178 IPv6 MPLSoUDP outer header::
5180 testpmd> set mplsoudp_decap ip-version ipv6
5181 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / mpls / end
5182 actions mplsoudp_decap / l2_encap / end
5184 IPv6 MPLSoUDP with VLAN outer header::
5186 testpmd> set mplsoudp_decap-with-vlan ip-version ipv6
5187 testpmd> flow create 0 ingress pattern eth / vlan / ipv6 / udp / mpls / end
5188 actions mplsoudp_decap / l2_encap / end
5190 Sample Raw encapsulation rule
5191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5193 Raw encapsulation configuration can be set by the following commands
5195 Eecapsulating VxLAN::
5197 testpmd> set raw_encap 4 eth src is 10:11:22:33:44:55 / vlan tci is 1
5198 inner_type is 0x0800 / ipv4 / udp dst is 4789 / vxlan vni
5200 testpmd> flow create 0 egress pattern eth / ipv4 / end actions
5201 raw_encap index 4 / end
5203 Sample Raw decapsulation rule
5204 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5206 Raw decapsulation configuration can be set by the following commands
5208 Decapsulating VxLAN::
5210 testpmd> set raw_decap eth / ipv4 / udp / vxlan / end_set
5211 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan / eth / ipv4 /
5212 end actions raw_decap / queue index 0 / end
5217 ESP rules can be created by the following commands::
5219 testpmd> flow create 0 ingress pattern eth / ipv4 / esp spi is 1 / end actions
5221 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / esp spi is 1 / end
5222 actions queue index 3 / end
5223 testpmd> flow create 0 ingress pattern eth / ipv6 / esp spi is 1 / end actions
5225 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / esp spi is 1 / end
5226 actions queue index 3 / end
5231 AH rules can be created by the following commands::
5233 testpmd> flow create 0 ingress pattern eth / ipv4 / ah spi is 1 / end actions
5235 testpmd> flow create 0 ingress pattern eth / ipv4 / udp / ah spi is 1 / end
5236 actions queue index 3 / end
5237 testpmd> flow create 0 ingress pattern eth / ipv6 / ah spi is 1 / end actions
5239 testpmd> flow create 0 ingress pattern eth / ipv6 / udp / ah spi is 1 / end
5240 actions queue index 3 / end
5245 PFCP rules can be created by the following commands(s_field need to be 1
5248 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 0 / end
5249 actions queue index 3 / end
5250 testpmd> flow create 0 ingress pattern eth / ipv4 / pfcp s_field is 1
5251 seid is 1 / end actions queue index 3 / end
5252 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 0 / end
5253 actions queue index 3 / end
5254 testpmd> flow create 0 ingress pattern eth / ipv6 / pfcp s_field is 1
5255 seid is 1 / end actions queue index 3 / end
5260 The following sections show functions to load/unload eBPF based filters.
5265 Load an eBPF program as a callback for particular RX/TX queue::
5267 testpmd> bpf-load rx|tx (portid) (queueid) (load-flags) (bpf-prog-filename)
5269 The available load-flags are:
5271 * ``J``: use JIT generated native code, otherwise BPF interpreter will be used.
5273 * ``M``: assume input parameter is a pointer to rte_mbuf, otherwise assume it is a pointer to first segment's data.
5279 You'll need clang v3.7 or above to build bpf program you'd like to load
5283 .. code-block:: console
5286 clang -O2 -target bpf -c t1.c
5288 Then to load (and JIT compile) t1.o at RX queue 0, port 1:
5290 .. code-block:: console
5292 testpmd> bpf-load rx 1 0 J ./dpdk.org/examples/bpf/t1.o
5294 To load (not JITed) t1.o at TX queue 0, port 0:
5296 .. code-block:: console
5298 testpmd> bpf-load tx 0 0 - ./dpdk.org/examples/bpf/t1.o
5303 Unload previously loaded eBPF program for particular RX/TX queue::
5305 testpmd> bpf-unload rx|tx (portid) (queueid)
5307 For example to unload BPF filter from TX queue 0, port 0:
5309 .. code-block:: console
5311 testpmd> bpf-unload tx 0 0