2 Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 Testpmd Runtime Functions
34 =========================
36 Where the testpmd application is started in interactive mode, (``-i|--interactive``),
37 it displays a prompt that can be used to start and stop forwarding,
38 configure the application, display statistics, set the Flow Director and other tasks::
42 The testpmd prompt has some, limited, readline support.
43 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
44 as well as access to the command history via the up-arrow.
46 There is also support for tab completion.
47 If you type a partial command and hit ``<TAB>`` you get a list of the available completions:
49 .. code-block:: console
51 testpmd> show port <TAB>
53 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
54 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
55 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
56 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
62 Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes::
64 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
65 (pause_time) (send_xon) (port_id)
67 In the real ``testpmd>`` prompt these commands should be on a single line.
72 The testpmd has on-line help for the functions that are available at runtime.
73 These are divided into sections and can be accessed using help, help section or help all:
75 .. code-block:: console
79 help control : Start and stop forwarding.
80 help display : Displaying port, stats and config information.
81 help config : Configuration information.
82 help ports : Configuring ports.
83 help registers : Reading and setting port registers.
84 help filters : Filters configuration help.
85 help all : All of the above sections.
94 Start packet forwarding with current configuration::
101 Start packet forwarding with current configuration after sending one burst of packets::
103 testpmd> start tx_first
108 Stop packet forwarding, and display accumulated statistics::
123 The functions in the following sections are used to display information about the
124 testpmd configuration or the NIC status.
129 Display information for a given port or all ports::
131 testpmd> show port (info|stats|fdir|stat_qmap|dcb_tc) (port_id|all)
133 The available information categories are:
135 * ``info``: General port information such as MAC address.
137 * ``stats``: RX/TX statistics.
139 * ``fdir``: Flow Director information and statistics.
141 * ``stat_qmap``: Queue statistics mapping.
143 * ``dcb_tc``: DCB information such as TC mapping.
147 .. code-block:: console
149 testpmd> show port info 0
151 ********************* Infos for port 0 *********************
153 MAC address: XX:XX:XX:XX:XX:XX
155 memory allocation on the socket: 0
157 Link speed: 40000 Mbps
158 Link duplex: full-duplex
159 Promiscuous mode: enabled
160 Allmulticast mode: disabled
161 Maximum number of MAC addresses: 64
162 Maximum number of MAC addresses of hash filtering: 0
167 Redirection table size: 512
168 Supported flow types:
184 Display the rss redirection table entry indicated by masks on port X::
186 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
188 size is used to indicate the hardware supported reta size
193 Display the RSS hash functions and RSS hash key of a port::
195 testpmd> show port (port_id) rss-hash ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|ipv6-udp-ex [key]
200 Clear the port statistics for a given port or for all ports::
202 testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all)
206 testpmd> clear port stats all
211 Display information for a given port's RX/TX queue::
213 testpmd> show (rxq|txq) info (port_id) (queue_id)
218 Displays the configuration of the application.
219 The configuration comes from the command-line, the runtime or the application defaults::
221 testpmd> show config (rxtx|cores|fwd|txpkts)
223 The available information categories are:
225 * ``rxtx``: RX/TX configuration items.
227 * ``cores``: List of forwarding cores.
229 * ``fwd``: Packet forwarding configuration.
231 * ``txpkts``: Packets to TX configuration.
235 .. code-block:: console
237 testpmd> show config rxtx
239 io packet forwarding - CRC stripping disabled - packets/burst=16
240 nb forwarding cores=2 - nb forwarding ports=1
241 RX queues=1 - RX desc=128 - RX free threshold=0
242 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
243 TX queues=1 - TX desc=512 - TX free threshold=0
244 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
245 TX RS bit threshold=0 - TXQ flags=0x0
250 Set the packet forwarding mode::
252 testpmd> set fwd (io|mac|mac_retry|macswap|flowgen| \
253 rxonly|txonly|csum|icmpecho)
255 The available information categories are:
257 * ``io``: Forwards packets "as-is" in I/O mode.
258 This is the fastest possible forwarding operation as it does not access packets data.
259 This is the default mode.
261 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
263 * ``mac_retry``: Same as "mac" forwarding mode, but includes retries if the destination queue is full.
265 * ``macswap``: MAC swap forwarding mode.
266 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
268 * ``flowgen``: Multi-flow generation mode.
269 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
271 * ``rxonly``: Receives packets but doesn't transmit them.
273 * ``txonly``: Generates and transmits packets without receiving any.
275 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
277 * ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
279 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
281 Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``.
285 testpmd> set fwd rxonly
287 Set rxonly packet forwarding mode
293 Display an RX descriptor for a port RX queue::
295 testpmd> read rxd (port_id) (queue_id) (rxd_id)
299 testpmd> read rxd 0 0 4
300 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
305 Display a TX descriptor for a port TX queue::
307 testpmd> read txd (port_id) (queue_id) (txd_id)
311 testpmd> read txd 0 0 4
312 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
315 Configuration Functions
316 -----------------------
318 The testpmd application can be configured from the runtime as well as from the command-line.
320 This section details the available configuration functions that are available.
324 Configuration changes only become active when forwarding is started/restarted.
329 Reset forwarding to the default configuration::
336 Set the debug verbosity level::
338 testpmd> set verbose (level)
340 Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
345 Set the number of ports used by the application:
349 This is equivalent to the ``--nb-ports`` command-line option.
354 Set the number of cores used by the application::
356 testpmd> set nbcore (num)
358 This is equivalent to the ``--nb-cores`` command-line option.
362 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
367 Set the forwarding cores hexadecimal mask::
369 testpmd> set coremask (mask)
371 This is equivalent to the ``--coremask`` command-line option.
375 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
380 Set the forwarding ports hexadecimal mask::
382 testpmd> set portmask (mask)
384 This is equivalent to the ``--portmask`` command-line option.
389 Set number of packets per burst::
391 testpmd> set burst (num)
393 This is equivalent to the ``--burst command-line`` option.
395 In ``mac_retry`` forwarding mode, the transmit delay time and number of retries can also be set::
397 testpmd> set burst tx delay (micrseconds) retry (num)
402 Set the length of each segment of the TX-ONLY packets::
404 testpmd> set txpkts (x[,y]*)
406 Where x[,y]* represents a CSV list of values, without white space.
411 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
413 testpmd> set txsplit (off|on|rand)
417 * ``off`` disable packet copy & split for CSUM mode.
419 * ``on`` split outgoing packet into multiple segments. Size of each segment
420 and number of segments per packet is determined by ``set txpkts`` command
423 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
428 Set the list of forwarding cores::
430 testpmd> set corelist (x[,y]*)
432 For example, to change the forwarding cores:
434 .. code-block:: console
436 testpmd> set corelist 3,1
437 testpmd> show config fwd
439 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
440 Logical Core 3 (socket 0) forwards packets on 1 streams:
441 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
442 Logical Core 1 (socket 0) forwards packets on 1 streams:
443 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
447 The cores are used in the same order as specified on the command line.
452 Set the list of forwarding ports::
454 testpmd> set portlist (x[,y]*)
456 For example, to change the port forwarding:
458 .. code-block:: console
460 testpmd> set portlist 0,2,1,3
461 testpmd> show config fwd
463 io packet forwarding - ports=4 - cores=1 - streams=4
464 Logical Core 3 (socket 0) forwards packets on 4 streams:
465 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
466 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
467 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
468 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
473 Set the VLAN strip on a port::
475 testpmd> vlan set strip (on|off) (port_id)
480 Set the VLAN strip for a queue on a port::
482 testpmd> vlan set stripq (on|off) (port_id,queue_id)
487 Set the VLAN filter on a port::
489 testpmd> vlan set filter (on|off) (port_id)
494 Set the VLAN QinQ (extended queue in queue) on for a port::
496 testpmd> vlan set qinq (on|off) (port_id)
501 Set the inner or outer VLAN TPID for packet filtering on a port::
503 testpmd> vlan set (inner|outer) tpid (value) (port_id)
507 TPID value must be a 16-bit number (value <= 65536).
512 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
514 testpmd> rx_vlan add (vlan_id|all) (port_id)
518 VLAN filter must be set on that port. VLAN ID < 4096.
519 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
520 in VFTA table. This is important if enabling all vlan_ids.
525 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
527 testpmd> rx_vlan rm (vlan_id|all) (port_id)
532 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
534 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
539 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
541 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
546 Add a tunnel filter on a port::
548 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
549 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
550 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
552 The available information categories are:
554 * ``vxlan``: Set tunnel type as VXLAN.
556 * ``nvgre``: Set tunnel type as NVGRE.
558 * ``ipingre``: Set tunnel type as IP-in-GRE.
560 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
562 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
564 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
566 * ``imac``: Set filter type as Inner MAC.
568 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
570 * ``oip``: Set filter type as Outer IP.
572 * ``iip``: Set filter type as Inner IP.
576 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
577 192.168.2.2 0 ipingre oip 1 1
579 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
584 Remove a tunnel filter on a port::
586 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
587 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
588 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
593 Add an UDP port for VXLAN packet filter on a port::
595 testpmd> rx_vxlan_port add (udp_port) (port_id)
600 Remove an UDP port for VXLAN packet filter on a port::
602 testpmd> rx_vxlan_port rm (udp_port) (port_id)
607 Set hardware insertion of VLAN IDs in packets sent on a port::
609 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
611 For example, set a single VLAN ID (5) insertion on port 0::
615 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
623 Set port based hardware insertion of VLAN ID in packets sent on a port::
625 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
630 Disable hardware insertion of a VLAN header in packets sent on a port::
632 testpmd> tx_vlan reset (port_id)
637 Select hardware or software calculation of the checksum when
638 transmitting a packet using the ``csum`` forwarding engine::
640 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
644 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
646 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
647 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
648 supported). See also the ``csum parse-tunnel`` command.
652 Check the NIC Datasheet for hardware limits.
657 Define how tunneled packets should be handled by the csum forward
660 testpmd> csum parse-tunnel (on|off) (tx_port_id)
662 If enabled, the csum forward engine will try to recognize supported
663 tunnel headers (vxlan, gre, ipip).
665 If disabled, treat tunnel packets as non-tunneled packets (a inner
666 header is handled as a packet payload).
670 The port argument is the TX port like in the ``csum set`` command.
674 Consider a packet in packet like the following::
676 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
678 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
679 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
680 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``).
682 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
683 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
688 Display tx checksum offload configuration::
690 testpmd> csum show (port_id)
695 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
697 testpmd> tso set (segsize) (port_id)
701 Check the NIC datasheet for hardware limits.
706 Display the status of TCP Segmentation Offload::
708 testpmd> tso show (port_id)
713 Add an alternative MAC address to a port::
715 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
720 Remove a MAC address from a port::
722 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
727 Add an alternative MAC address for a VF to a port::
729 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
734 Set the unicast hash filter(s) on/off for a port::
736 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
741 Set the promiscuous mode on for a port or for all ports.
742 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
744 testpmd> set promisc (port_id|all) (on|off)
749 Set the allmulti mode for a port or for all ports::
751 testpmd> set allmulti (port_id|all) (on|off)
753 Same as the ifconfig (8) option. Controls how multicast packets are handled.
758 Set the link flow control parameter on a port::
760 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
761 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
762 autoneg (on|off) (port_id)
766 * ``high_water`` (integer): High threshold value to trigger XOFF.
768 * ``low_water`` (integer): Low threshold value to trigger XON.
770 * ``pause_time`` (integer): Pause quota in the Pause frame.
772 * ``send_xon`` (0/1): Send XON frame.
774 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
776 * ``autoneg``: Change the auto-negotiation para mete.
781 Set the priority flow control parameter on a port::
783 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
784 (pause_time) (priority) (port_id)
788 * ``high_water`` (integer): High threshold value.
790 * ``low_water`` (integer): Low threshold value.
792 * ``pause_time`` (integer): Pause quota in the Pause frame.
794 * ``priority`` (0-7): VLAN User Priority.
799 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
801 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
803 For example, to set rx queue 2 on port 0 to mapping 5::
805 testpmd>set stat_qmap rx 0 2 5
807 set port - rx/tx (for VF)
808 ~~~~~~~~~~~~~~~~~~~~~~~~~
810 Set VF receive/transmit from a port::
812 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
814 set port - mac address filter (for VF)
815 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
817 Add/Remove unicast or multicast MAC addr filter for a VF::
819 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
820 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
822 set port - rx mode(for VF)
823 ~~~~~~~~~~~~~~~~~~~~~~~~~~
825 Set the VF receive mode of a port::
827 testpmd> set port (port_id) vf (vf_id) \
828 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
830 The available receive modes are:
832 * ``AUPE``: Accepts untagged VLAN.
834 * ``ROPE``: Accepts unicast hash.
836 * ``BAM``: Accepts broadcast packets.
838 * ``MPE``: Accepts all multicast packets.
840 set port - tx_rate (for Queue)
841 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
843 Set TX rate limitation for a queue on a port::
845 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
847 set port - tx_rate (for VF)
848 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
850 Set TX rate limitation for queues in VF on a port::
852 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
854 set port - mirror rule
855 ~~~~~~~~~~~~~~~~~~~~~~
857 Set pool or vlan type mirror rule for a port::
859 testpmd> set port (port_id) mirror-rule (rule_id) \
860 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
861 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
863 Set link mirror rule for a port::
865 testpmd> set port (port_id) mirror-rule (rule_id) \
866 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
868 For example to enable mirror traffic with vlan 0,1 to pool 0::
870 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
872 reset port - mirror rule
873 ~~~~~~~~~~~~~~~~~~~~~~~~
875 Reset a mirror rule for a port::
877 testpmd> reset port (port_id) mirror-rule (rule_id)
882 Set the flush on RX streams before forwarding.
883 The default is flush ``on``.
884 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
886 testpmd> set flush_rx off
891 Set the bypass mode for the lowest port on bypass enabled NIC::
893 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
898 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
900 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
901 mode (normal|bypass|isolate) (port_id)
905 * ``timeout``: Enable bypass after watchdog timeout.
907 * ``os_on``: Enable bypass when OS/board is powered on.
909 * ``os_off``: Enable bypass when OS/board is powered off.
911 * ``power_on``: Enable bypass when power supply is turned on.
913 * ``power_off``: Enable bypass when power supply is turned off.
919 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
921 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
926 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
928 testpmd> show bypass config (port_id)
933 Set link up for a port::
935 testpmd> set link-up port (port id)
940 Set link down for a port::
942 testpmd> set link-down port (port id)
947 Enable E-tag insertion for a VF on a port::
949 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
951 Disable E-tag insertion for a VF on a port::
953 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
955 Enable/disable E-tag stripping on a port::
957 testpmd> E-tag set stripping (on|off) port (port_id)
959 Enable/disable E-tag based forwarding on a port::
961 testpmd> E-tag set forwarding (on|off) port (port_id)
963 Add an E-tag forwarding filter on a port::
965 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
967 Delete an E-tag forwarding filter on a port::
968 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
974 The following sections show functions for configuring ports.
978 Port configuration changes only become active when forwarding is started/restarted.
983 Attach a port specified by pci address or virtual device args.
985 To attach a new pci device, the device should be recognized by kernel first.
986 Then it should be moved under DPDK management.
987 Finally the port can be attached to testpmd.
989 For example, to move a pci device using ixgbe under DPDK management:
991 .. code-block:: console
993 # Check the status of the available devices.
994 ./tools/dpdk_nic_bind.py --status
996 Network devices using DPDK-compatible driver
997 ============================================
1000 Network devices using kernel driver
1001 ===================================
1002 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1005 # Bind the device to igb_uio.
1006 sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0
1009 # Recheck the status of the devices.
1010 ./tools/dpdk_nic_bind.py --status
1011 Network devices using DPDK-compatible driver
1012 ============================================
1013 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1015 To attach a port created by virtual device, above steps are not needed.
1017 port attach (identifier)
1019 For example, to attach a port whose pci address is 0000:0a:00.0.
1021 .. code-block:: console
1023 testpmd> port attach 0000:0a:00.0
1024 Attaching a new port...
1025 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1026 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1027 EAL: PCI memory mapped at 0x7f83bfa00000
1028 EAL: PCI memory mapped at 0x7f83bfa80000
1029 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1030 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1031 Port 0 is attached. Now total ports is 1
1034 For example, to attach a port created by pcap PMD.
1036 .. code-block:: console
1038 testpmd> port attach eth_pcap0
1039 Attaching a new port...
1040 PMD: Initializing pmd_pcap for eth_pcap0
1041 PMD: Creating pcap-backed ethdev on numa socket 0
1042 Port 0 is attached. Now total ports is 1
1045 In this case, identifier is ``eth_pcap0``.
1046 This identifier format is the same as ``--vdev`` format of DPDK applications.
1048 For example, to re-attach a bonded port which has been previously detached,
1049 the mode and slave parameters must be given.
1051 .. code-block:: console
1053 testpmd> port attach eth_bond_0,mode=0,slave=1
1054 Attaching a new port...
1055 EAL: Initializing pmd_bond for eth_bond_0
1056 EAL: Create bonded device eth_bond_0 on port 0 in mode 0 on socket 0.
1057 Port 0 is attached. Now total ports is 1
1064 Detach a specific port.
1066 Before detaching a port, the port should be closed::
1068 testpmd> port detach (port_id)
1070 For example, to detach a pci device port 0.
1072 .. code-block:: console
1074 testpmd> port close 0
1078 testpmd> port detach 0
1080 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1081 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1082 EAL: PCI memory unmapped at 0x7f83bfa00000
1083 EAL: PCI memory unmapped at 0x7f83bfa80000
1087 For example, to detach a virtual device port 0.
1089 .. code-block:: console
1091 testpmd> port close 0
1095 testpmd> port detach 0
1097 PMD: Closing pcap ethdev on numa socket 0
1098 Port 'eth_pcap0' is detached. Now total ports is 0
1101 To remove a pci device completely from the system, first detach the port from testpmd.
1102 Then the device should be moved under kernel management.
1103 Finally the device can be removed using kernel pci hotplug functionality.
1105 For example, to move a pci device under kernel management:
1107 .. code-block:: console
1109 sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0
1111 ./tools/dpdk_nic_bind.py --status
1113 Network devices using DPDK-compatible driver
1114 ============================================
1117 Network devices using kernel driver
1118 ===================================
1119 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
1121 To remove a port created by a virtual device, above steps are not needed.
1126 Start all ports or a specific port::
1128 testpmd> port start (port_id|all)
1133 Stop all ports or a specific port::
1135 testpmd> port stop (port_id|all)
1140 Close all ports or a specific port::
1142 testpmd> port close (port_id|all)
1144 port start/stop queue
1145 ~~~~~~~~~~~~~~~~~~~~~
1147 Start/stop a rx/tx queue on a specific port::
1149 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
1151 Only take effect when port is started.
1156 Set the speed and duplex mode for all ports or a specific port::
1158 testpmd> port config (port_id|all) speed (10|100|1000|10000|40000|100000|auto) \
1159 duplex (half|full|auto)
1161 port config - queues/descriptors
1162 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1164 Set number of queues/descriptors for rxq, txq, rxd and txd::
1166 testpmd> port config all (rxq|txq|rxd|txd) (value)
1168 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
1170 port config - max-pkt-len
1171 ~~~~~~~~~~~~~~~~~~~~~~~~~
1173 Set the maximum packet length::
1175 testpmd> port config all max-pkt-len (value)
1177 This is equivalent to the ``--max-pkt-len`` command-line option.
1179 port config - CRC Strip
1180 ~~~~~~~~~~~~~~~~~~~~~~~
1182 Set hardware CRC stripping on or off for all ports::
1184 testpmd> port config all crc-strip (on|off)
1186 CRC stripping is off by default.
1188 The ``on`` option is equivalent to the ``--crc-strip`` command-line option.
1190 port config - scatter
1191 ~~~~~~~~~~~~~~~~~~~~~~~
1193 Set RX scatter mode on or off for all ports::
1195 testpmd> port config all scatter (on|off)
1197 RX scatter mode is off by default.
1199 The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
1201 port config - TX queue flags
1202 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1204 Set a hexadecimal bitmap of TX queue flags for all ports::
1206 testpmd> port config all txqflags value
1208 This command is equivalent to the ``--txqflags`` command-line option.
1210 port config - RX Checksum
1211 ~~~~~~~~~~~~~~~~~~~~~~~~~
1213 Set hardware RX checksum offload to on or off for all ports::
1215 testpmd> port config all rx-cksum (on|off)
1217 Checksum offload is off by default.
1219 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
1224 Set hardware VLAN on or off for all ports::
1226 testpmd> port config all hw-vlan (on|off)
1228 Hardware VLAN is on by default.
1230 The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option.
1232 port config - VLAN filter
1233 ~~~~~~~~~~~~~~~~~~~~~~~~~
1235 Set hardware VLAN filter on or off for all ports::
1237 testpmd> port config all hw-vlan-filter (on|off)
1239 Hardware VLAN filter is on by default.
1241 The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option.
1243 port config - VLAN strip
1244 ~~~~~~~~~~~~~~~~~~~~~~~~
1246 Set hardware VLAN strip on or off for all ports::
1248 testpmd> port config all hw-vlan-strip (on|off)
1250 Hardware VLAN strip is on by default.
1252 The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option.
1254 port config - VLAN extend
1255 ~~~~~~~~~~~~~~~~~~~~~~~~~
1257 Set hardware VLAN extend on or off for all ports::
1259 testpmd> port config all hw-vlan-extend (on|off)
1261 Hardware VLAN extend is off by default.
1263 The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option.
1265 port config - Drop Packets
1266 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1268 Set packet drop for packets with no descriptors on or off for all ports::
1270 testpmd> port config all drop-en (on|off)
1272 Packet dropping for packets with no descriptors is off by default.
1274 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
1279 Set the RSS (Receive Side Scaling) mode on or off::
1281 testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|none)
1283 RSS is on by default.
1285 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
1287 port config - RSS Reta
1288 ~~~~~~~~~~~~~~~~~~~~~~
1290 Set the RSS (Receive Side Scaling) redirection table::
1292 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
1297 Set the DCB mode for an individual port::
1299 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1301 The traffic class should be 4 or 8.
1306 Set the number of packets per burst::
1308 testpmd> port config all burst (value)
1310 This is equivalent to the ``--burst`` command-line option.
1312 port config - Threshold
1313 ~~~~~~~~~~~~~~~~~~~~~~~
1315 Set thresholds for TX/RX queues::
1317 testpmd> port config all (threshold) (value)
1319 Where the threshold type can be:
1321 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1323 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
1325 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1327 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1329 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
1331 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1333 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1335 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1337 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1339 These threshold options are also available from the command-line.
1344 Set the value of ether-type for E-tag::
1346 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
1348 Enable/disable the E-tag support::
1350 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
1353 Link Bonding Functions
1354 ----------------------
1356 The Link Bonding functions make it possible to dynamically create and
1357 manage link bonding devices from within testpmd interactive prompt.
1359 create bonded device
1360 ~~~~~~~~~~~~~~~~~~~~
1362 Create a new bonding device::
1364 testpmd> create bonded device (mode) (socket)
1366 For example, to create a bonded device in mode 1 on socket 0::
1368 testpmd> create bonded 1 0
1369 created new bonded device (port X)
1374 Adds Ethernet device to a Link Bonding device::
1376 testpmd> add bonding slave (slave id) (port id)
1378 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
1380 testpmd> add bonding slave 6 10
1383 remove bonding slave
1384 ~~~~~~~~~~~~~~~~~~~~
1386 Removes an Ethernet slave device from a Link Bonding device::
1388 testpmd> remove bonding slave (slave id) (port id)
1390 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
1392 testpmd> remove bonding slave 6 10
1397 Set the Link Bonding mode of a Link Bonding device::
1399 testpmd> set bonding mode (value) (port id)
1401 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
1403 testpmd> set bonding mode 3 10
1408 Set an Ethernet slave device as the primary device on a Link Bonding device::
1410 testpmd> set bonding primary (slave id) (port id)
1412 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
1414 testpmd> set bonding primary 6 10
1419 Set the MAC address of a Link Bonding device::
1421 testpmd> set bonding mac (port id) (mac)
1423 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
1425 testpmd> set bonding mac 10 00:00:00:00:00:01
1427 set bonding xmit_balance_policy
1428 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1430 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
1432 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1434 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
1436 testpmd> set bonding xmit_balance_policy 10 l34
1439 set bonding mon_period
1440 ~~~~~~~~~~~~~~~~~~~~~~
1442 Set the link status monitoring polling period in milliseconds for a bonding device.
1444 This adds support for PMD slave devices which do not support link status interrupts.
1445 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1446 link status ISR will be queried every polling interval to check if their link status has changed::
1448 testpmd> set bonding mon_period (port_id) (value)
1450 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
1452 testpmd> set bonding mon_period 5 150
1458 Show the current configuration of a Link Bonding device::
1460 testpmd> show bonding config (port id)
1463 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1464 in balance mode with a transmission policy of layer 2+3::
1466 testpmd> show bonding config 9
1468 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1470 Active Slaves (3): [1 3 4]
1477 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
1478 This is mainly useful for debugging purposes.
1479 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1480 and fields that can be accessed.
1485 Display the value of a port register::
1487 testpmd> read reg (port_id) (address)
1489 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
1491 testpmd> read reg 0 0xEE00
1492 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1497 Display a port register bit field::
1499 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
1501 For example, reading the lowest two bits from the register in the example above::
1503 testpmd> read regfield 0 0xEE00 0 1
1504 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1509 Display a single port register bit::
1511 testpmd> read regbit (port_id) (address) (bit_x)
1513 For example, reading the lowest bit from the register in the example above::
1515 testpmd> read regbit 0 0xEE00 0
1516 port 0 PCI register at offset 0xEE00: bit 0=1
1521 Set the value of a port register::
1523 testpmd> write reg (port_id) (address) (value)
1525 For example, to clear a register::
1527 testpmd> write reg 0 0xEE00 0x0
1528 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1533 Set bit field of a port register::
1535 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
1537 For example, writing to the register cleared in the example above::
1539 testpmd> write regfield 0 0xEE00 0 1 2
1540 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1545 Set single bit value of a port register::
1547 testpmd> write regbit (port_id) (address) (bit_x) (value)
1549 For example, to set the high bit in the register from the example above::
1551 testpmd> write regbit 0 0xEE00 31 1
1552 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
1558 This section details the available filter functions that are available.
1561 ~~~~~~~~~~~~~~~~~~~~
1563 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
1565 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
1566 ethertype (ether_type) (drop|fwd) queue (queue_id)
1568 The available information parameters are:
1570 * ``port_id``: The port which the Ethertype filter assigned on.
1572 * ``mac_addr``: Compare destination mac address.
1574 * ``mac_ignr``: Ignore destination mac address match.
1576 * ``mac_address``: Destination mac address to match.
1578 * ``ether_type``: The EtherType value want to match,
1579 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
1581 * ``queue_id``: The receive queue associated with this EtherType filter.
1582 It is meaningless when deleting or dropping.
1584 Example, to add/remove an ethertype filter rule::
1586 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
1587 ethertype 0x0806 fwd queue 3
1589 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
1590 ethertype 0x0806 fwd queue 3
1595 Add or delete a 2-tuple filter,
1596 which identifies packets by specific protocol and destination TCP/UDP port
1597 and forwards packets into one of the receive queues::
1599 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
1600 protocol (protocol_value) mask (mask_value) \
1601 tcp_flags (tcp_flags_value) priority (prio_value) \
1604 The available information parameters are:
1606 * ``port_id``: The port which the 2-tuple filter assigned on.
1608 * ``dst_port_value``: Destination port in L4.
1610 * ``protocol_value``: IP L4 protocol.
1612 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
1614 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
1616 * ``prio_value``: Priority of this filter.
1618 * ``queue_id``: The receive queue associated with this 2-tuple filter.
1620 Example, to add/remove an 2tuple filter rule::
1622 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
1623 tcp_flags 0x02 priority 3 queue 3
1625 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
1626 tcp_flags 0x02 priority 3 queue 3
1631 Add or delete a 5-tuple filter,
1632 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
1633 and routes packets into one of the receive queues::
1635 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
1636 (src_address) dst_port (dst_port_value) \
1637 src_port (src_port_value) protocol (protocol_value) \
1638 mask (mask_value) tcp_flags (tcp_flags_value) \
1639 priority (prio_value) queue (queue_id)
1641 The available information parameters are:
1643 * ``port_id``: The port which the 5-tuple filter assigned on.
1645 * ``dst_address``: Destination IP address.
1647 * ``src_address``: Source IP address.
1649 * ``dst_port_value``: TCP/UDP destination port.
1651 * ``src_port_value``: TCP/UDP source port.
1653 * ``protocol_value``: L4 protocol.
1655 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
1657 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
1659 * ``prio_value``: The priority of this filter.
1661 * ``queue_id``: The receive queue associated with this 5-tuple filter.
1663 Example, to add/remove an 5tuple filter rule::
1665 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1666 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1667 flags 0x0 priority 3 queue 3
1669 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1670 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1671 flags 0x0 priority 3 queue 3
1676 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
1678 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
1680 The available information parameters are:
1682 * ``port_id``: The port which the SYN filter assigned on.
1684 * ``high``: This SYN filter has higher priority than other filters.
1686 * ``low``: This SYN filter has lower priority than other filters.
1688 * ``queue_id``: The receive queue associated with this SYN filter
1692 testpmd> syn_filter 0 add priority high queue 3
1697 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
1698 and routed into one of the receive queues::
1700 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
1701 mask (mask_value) priority (prio_value) queue (queue_id)
1703 The available information parameters are:
1705 * ``port_id``: The port which the Flex filter is assigned on.
1707 * ``len_value``: Filter length in bytes, no greater than 128.
1709 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
1711 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
1713 * ``prio_value``: The priority of this filter.
1715 * ``queue_id``: The receive queue associated with this Flex filter.
1719 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
1720 mask 000C priority 3 queue 3
1722 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
1723 mask 000C priority 3 queue 3
1726 .. _testpmd_flow_director:
1728 flow_director_filter
1729 ~~~~~~~~~~~~~~~~~~~~
1731 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
1733 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
1734 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
1736 * Perfect match filters.
1737 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1738 The masked fields are for IP flow.
1740 * Signature filters.
1741 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
1743 * Perfect-mac-vlan match filters.
1744 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1745 The masked fields are for MAC VLAN flow.
1747 * Perfect-tunnel match filters.
1748 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1749 The masked fields are for tunnel flow.
1751 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
1752 per flow type and the flexible payload.
1754 The Flow Director can also mask out parts of all of these fields so that filters
1755 are only applied to certain fields or parts of the fields.
1757 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
1759 # Commands to add flow director filters of different flow types::
1761 flow_director_filter (port_id) mode IP (add|del|update) \
1762 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
1763 src (src_ip_address) dst (dst_ip_address) \
1764 tos (tos_value) proto (proto_value) ttl (ttl_value) \
1765 vlan (vlan_value) flexbytes (flexbytes_value) \
1766 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
1769 flow_director_filter (port_id) mode IP (add|del|update) \
1770 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
1771 src (src_ip_address) (src_port) \
1772 dst (dst_ip_address) (dst_port) \
1773 tos (tos_value) ttl (ttl_value) \
1774 vlan (vlan_value) flexbytes (flexbytes_value) \
1775 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
1778 flow_director_filter (port_id) mode IP (add|del|update) \
1779 flow (ipv4-sctp|ipv6-sctp) \
1780 src (src_ip_address) (src_port) \
1781 dst (dst_ip_address) (dst_port) \
1782 tos (tos_value) ttl (ttl_value) \
1783 tag (verification_tag) vlan (vlan_value) \
1784 flexbytes (flexbytes_value) (drop|fwd) \
1785 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
1787 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
1788 ether (ethertype) flexbytes (flexbytes_value) \
1789 (drop|fwd) pf|vf(vf_id) queue (queue_id)
1792 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
1793 mac (mac_address) vlan (vlan_value) \
1794 flexbytes (flexbytes_value) (drop|fwd) \
1795 queue (queue_id) fd_id (fd_id_value)
1797 flow_director_filter (port_id) mode Tunnel (add|del|update) \
1798 mac (mac_address) vlan (vlan_value) \
1799 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
1800 flexbytes (flexbytes_value) (drop|fwd) \
1801 queue (queue_id) fd_id (fd_id_value)
1803 For example, to add an ipv4-udp flow type filter::
1805 testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 \
1806 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
1807 fwd pf queue 1 fd_id 1
1809 For example, add an ipv4-other flow type filter::
1811 testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 \
1812 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
1813 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
1818 Flush all flow director filters on a device::
1820 testpmd> flush_flow_director (port_id)
1822 Example, to flush all flow director filter on port 0::
1824 testpmd> flush_flow_director 0
1829 Set flow director's input masks::
1831 flow_director_mask (port_id) mode IP vlan (vlan_value) \
1832 src_mask (ipv4_src) (ipv6_src) (src_port) \
1833 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
1835 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) \
1838 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
1839 mac (mac_value) tunnel-type (tunnel_type_value) \
1840 tunnel-id (tunnel_id_value)
1842 Example, to set flow director mask on port 0::
1844 testpmd> flow_director_mask 0 vlan 0xefff \
1845 src_mask 255.255.255.255 \
1846 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
1847 dst_mask 255.255.255.255 \
1848 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
1850 flow_director_flex_mask
1851 ~~~~~~~~~~~~~~~~~~~~~~~
1853 set masks of flow director's flexible payload based on certain flow type::
1855 testpmd> flow_director_flex_mask (port_id) \
1856 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1857 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
1858 l2_payload|all) (mask)
1860 Example, to set flow director's flex mask for all flow type on port 0::
1862 testpmd> flow_director_flex_mask 0 flow all \
1863 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
1866 flow_director_flex_payload
1867 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1869 Configure flexible payload selection::
1871 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
1873 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
1875 testpmd> flow_director_flex_payload 0 l4 \
1876 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
1878 get_sym_hash_ena_per_port
1879 ~~~~~~~~~~~~~~~~~~~~~~~~~
1881 Get symmetric hash enable configuration per port::
1883 get_sym_hash_ena_per_port (port_id)
1885 For example, to get symmetric hash enable configuration of port 1::
1887 testpmd> get_sym_hash_ena_per_port 1
1889 set_sym_hash_ena_per_port
1890 ~~~~~~~~~~~~~~~~~~~~~~~~~
1892 Set symmetric hash enable configuration per port to enable or disable::
1894 set_sym_hash_ena_per_port (port_id) (enable|disable)
1896 For example, to set symmetric hash enable configuration of port 1 to enable::
1898 testpmd> set_sym_hash_ena_per_port 1 enable
1900 get_hash_global_config
1901 ~~~~~~~~~~~~~~~~~~~~~~
1903 Get the global configurations of hash filters::
1905 get_hash_global_config (port_id)
1907 For example, to get the global configurations of hash filters of port 1::
1909 testpmd> get_hash_global_config 1
1911 set_hash_global_config
1912 ~~~~~~~~~~~~~~~~~~~~~~
1914 Set the global configurations of hash filters::
1916 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
1917 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
1918 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \
1921 For example, to enable simple_xor for flow type of ipv6 on port 2::
1923 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
1928 Set the input set for hash::
1930 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1931 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
1932 l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
1933 ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
1934 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
1935 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
1936 fld-8th|none) (select|add)
1938 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
1940 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
1945 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
1946 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
1948 Set the input set for flow director::
1950 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1951 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
1952 l2_payload) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
1953 ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
1954 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
1955 sctp-dst-port|sctp-veri-tag|none) (select|add)
1957 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
1959 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
1964 Set different GRE key length for input set::
1966 global_config (port_id) gre-key-len (number in bytes)
1968 For example to set GRE key length for input set to 4 bytes on port 0::
1970 testpmd> global_config 0 gre-key-len 4