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 specified number of bursts of packets::
103 testpmd> start tx_first (""|burst_num)
105 The default burst number is 1 when ``burst_num`` not presented.
110 Stop packet forwarding, and display accumulated statistics::
125 The functions in the following sections are used to display information about the
126 testpmd configuration or the NIC status.
131 Display information for a given port or all ports::
133 testpmd> show port (info|stats|fdir|stat_qmap|dcb_tc) (port_id|all)
135 The available information categories are:
137 * ``info``: General port information such as MAC address.
139 * ``stats``: RX/TX statistics.
141 * ``fdir``: Flow Director information and statistics.
143 * ``stat_qmap``: Queue statistics mapping.
145 * ``dcb_tc``: DCB information such as TC mapping.
149 .. code-block:: console
151 testpmd> show port info 0
153 ********************* Infos for port 0 *********************
155 MAC address: XX:XX:XX:XX:XX:XX
157 memory allocation on the socket: 0
159 Link speed: 40000 Mbps
160 Link duplex: full-duplex
161 Promiscuous mode: enabled
162 Allmulticast mode: disabled
163 Maximum number of MAC addresses: 64
164 Maximum number of MAC addresses of hash filtering: 0
169 Redirection table size: 512
170 Supported flow types:
186 Display the rss redirection table entry indicated by masks on port X::
188 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
190 size is used to indicate the hardware supported reta size
195 Display the RSS hash functions and RSS hash key of a port::
197 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]
202 Clear the port statistics for a given port or for all ports::
204 testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all)
208 testpmd> clear port stats all
213 Display information for a given port's RX/TX queue::
215 testpmd> show (rxq|txq) info (port_id) (queue_id)
220 Displays the configuration of the application.
221 The configuration comes from the command-line, the runtime or the application defaults::
223 testpmd> show config (rxtx|cores|fwd|txpkts)
225 The available information categories are:
227 * ``rxtx``: RX/TX configuration items.
229 * ``cores``: List of forwarding cores.
231 * ``fwd``: Packet forwarding configuration.
233 * ``txpkts``: Packets to TX configuration.
237 .. code-block:: console
239 testpmd> show config rxtx
241 io packet forwarding - CRC stripping disabled - packets/burst=16
242 nb forwarding cores=2 - nb forwarding ports=1
243 RX queues=1 - RX desc=128 - RX free threshold=0
244 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
245 TX queues=1 - TX desc=512 - TX free threshold=0
246 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
247 TX RS bit threshold=0 - TXQ flags=0x0
252 Set the packet forwarding mode::
254 testpmd> set fwd (io|mac|macswap|flowgen| \
255 rxonly|txonly|csum|icmpecho) (""|retry)
257 ``retry`` can be specified for forwarding engines except ``rx_only``.
259 The available information categories are:
261 * ``io``: Forwards packets "as-is" in I/O mode.
262 This is the fastest possible forwarding operation as it does not access packets data.
263 This is the default mode.
265 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
267 * ``macswap``: MAC swap forwarding mode.
268 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
270 * ``flowgen``: Multi-flow generation mode.
271 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
273 * ``rxonly``: Receives packets but doesn't transmit them.
275 * ``txonly``: Generates and transmits packets without receiving any.
277 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
279 * ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
281 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
283 Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``.
287 testpmd> set fwd rxonly
289 Set rxonly packet forwarding mode
295 Display an RX descriptor for a port RX queue::
297 testpmd> read rxd (port_id) (queue_id) (rxd_id)
301 testpmd> read rxd 0 0 4
302 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
307 Display a TX descriptor for a port TX queue::
309 testpmd> read txd (port_id) (queue_id) (txd_id)
313 testpmd> read txd 0 0 4
314 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
317 Configuration Functions
318 -----------------------
320 The testpmd application can be configured from the runtime as well as from the command-line.
322 This section details the available configuration functions that are available.
326 Configuration changes only become active when forwarding is started/restarted.
331 Reset forwarding to the default configuration::
338 Set the debug verbosity level::
340 testpmd> set verbose (level)
342 Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
347 Set the number of ports used by the application:
351 This is equivalent to the ``--nb-ports`` command-line option.
356 Set the number of cores used by the application::
358 testpmd> set nbcore (num)
360 This is equivalent to the ``--nb-cores`` command-line option.
364 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
369 Set the forwarding cores hexadecimal mask::
371 testpmd> set coremask (mask)
373 This is equivalent to the ``--coremask`` command-line option.
377 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
382 Set the forwarding ports hexadecimal mask::
384 testpmd> set portmask (mask)
386 This is equivalent to the ``--portmask`` command-line option.
391 Set number of packets per burst::
393 testpmd> set burst (num)
395 This is equivalent to the ``--burst command-line`` option.
397 When retry is enabled, the transmit delay time and number of retries can also be set::
399 testpmd> set burst tx delay (microseconds) retry (num)
404 Set the length of each segment of the TX-ONLY packets::
406 testpmd> set txpkts (x[,y]*)
408 Where x[,y]* represents a CSV list of values, without white space.
413 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
415 testpmd> set txsplit (off|on|rand)
419 * ``off`` disable packet copy & split for CSUM mode.
421 * ``on`` split outgoing packet into multiple segments. Size of each segment
422 and number of segments per packet is determined by ``set txpkts`` command
425 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
430 Set the list of forwarding cores::
432 testpmd> set corelist (x[,y]*)
434 For example, to change the forwarding cores:
436 .. code-block:: console
438 testpmd> set corelist 3,1
439 testpmd> show config fwd
441 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
442 Logical Core 3 (socket 0) forwards packets on 1 streams:
443 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
444 Logical Core 1 (socket 0) forwards packets on 1 streams:
445 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
449 The cores are used in the same order as specified on the command line.
454 Set the list of forwarding ports::
456 testpmd> set portlist (x[,y]*)
458 For example, to change the port forwarding:
460 .. code-block:: console
462 testpmd> set portlist 0,2,1,3
463 testpmd> show config fwd
465 io packet forwarding - ports=4 - cores=1 - streams=4
466 Logical Core 3 (socket 0) forwards packets on 4 streams:
467 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
468 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
469 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
470 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
475 Set the VLAN strip on a port::
477 testpmd> vlan set strip (on|off) (port_id)
482 Set the VLAN strip for a queue on a port::
484 testpmd> vlan set stripq (on|off) (port_id,queue_id)
489 Set the VLAN filter on a port::
491 testpmd> vlan set filter (on|off) (port_id)
496 Set the VLAN QinQ (extended queue in queue) on for a port::
498 testpmd> vlan set qinq (on|off) (port_id)
503 Set the inner or outer VLAN TPID for packet filtering on a port::
505 testpmd> vlan set (inner|outer) tpid (value) (port_id)
509 TPID value must be a 16-bit number (value <= 65536).
514 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
516 testpmd> rx_vlan add (vlan_id|all) (port_id)
520 VLAN filter must be set on that port. VLAN ID < 4096.
521 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
522 in VFTA table. This is important if enabling all vlan_ids.
527 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
529 testpmd> rx_vlan rm (vlan_id|all) (port_id)
534 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
536 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
541 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
543 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
548 Add a tunnel filter on a port::
550 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
551 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
552 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
554 The available information categories are:
556 * ``vxlan``: Set tunnel type as VXLAN.
558 * ``nvgre``: Set tunnel type as NVGRE.
560 * ``ipingre``: Set tunnel type as IP-in-GRE.
562 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
564 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
566 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
568 * ``imac``: Set filter type as Inner MAC.
570 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
572 * ``oip``: Set filter type as Outer IP.
574 * ``iip``: Set filter type as Inner IP.
578 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
579 192.168.2.2 0 ipingre oip 1 1
581 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
586 Remove a tunnel filter on a port::
588 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
589 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
590 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
595 Add an UDP port for VXLAN packet filter on a port::
597 testpmd> rx_vxlan_port add (udp_port) (port_id)
602 Remove an UDP port for VXLAN packet filter on a port::
604 testpmd> rx_vxlan_port rm (udp_port) (port_id)
609 Set hardware insertion of VLAN IDs in packets sent on a port::
611 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
613 For example, set a single VLAN ID (5) insertion on port 0::
617 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
625 Set port based hardware insertion of VLAN ID in packets sent on a port::
627 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
632 Disable hardware insertion of a VLAN header in packets sent on a port::
634 testpmd> tx_vlan reset (port_id)
639 Select hardware or software calculation of the checksum when
640 transmitting a packet using the ``csum`` forwarding engine::
642 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
646 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
648 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
649 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
650 supported). See also the ``csum parse-tunnel`` command.
654 Check the NIC Datasheet for hardware limits.
659 Define how tunneled packets should be handled by the csum forward
662 testpmd> csum parse-tunnel (on|off) (tx_port_id)
664 If enabled, the csum forward engine will try to recognize supported
665 tunnel headers (vxlan, gre, ipip).
667 If disabled, treat tunnel packets as non-tunneled packets (a inner
668 header is handled as a packet payload).
672 The port argument is the TX port like in the ``csum set`` command.
676 Consider a packet in packet like the following::
678 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
680 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
681 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
682 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``).
684 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
685 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
690 Display tx checksum offload configuration::
692 testpmd> csum show (port_id)
697 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
699 testpmd> tso set (segsize) (port_id)
703 Check the NIC datasheet for hardware limits.
708 Display the status of TCP Segmentation Offload::
710 testpmd> tso show (port_id)
715 Add an alternative MAC address to a port::
717 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
722 Remove a MAC address from a port::
724 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
729 Add an alternative MAC address for a VF to a port::
731 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
736 Set the unicast hash filter(s) on/off for a port::
738 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
743 Set the promiscuous mode on for a port or for all ports.
744 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
746 testpmd> set promisc (port_id|all) (on|off)
751 Set the allmulti mode for a port or for all ports::
753 testpmd> set allmulti (port_id|all) (on|off)
755 Same as the ifconfig (8) option. Controls how multicast packets are handled.
760 Set the link flow control parameter on a port::
762 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
763 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
764 autoneg (on|off) (port_id)
768 * ``high_water`` (integer): High threshold value to trigger XOFF.
770 * ``low_water`` (integer): Low threshold value to trigger XON.
772 * ``pause_time`` (integer): Pause quota in the Pause frame.
774 * ``send_xon`` (0/1): Send XON frame.
776 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
778 * ``autoneg``: Change the auto-negotiation para mete.
783 Set the priority flow control parameter on a port::
785 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
786 (pause_time) (priority) (port_id)
790 * ``high_water`` (integer): High threshold value.
792 * ``low_water`` (integer): Low threshold value.
794 * ``pause_time`` (integer): Pause quota in the Pause frame.
796 * ``priority`` (0-7): VLAN User Priority.
801 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
803 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
805 For example, to set rx queue 2 on port 0 to mapping 5::
807 testpmd>set stat_qmap rx 0 2 5
809 set port - rx/tx (for VF)
810 ~~~~~~~~~~~~~~~~~~~~~~~~~
812 Set VF receive/transmit from a port::
814 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
816 set port - mac address filter (for VF)
817 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
819 Add/Remove unicast or multicast MAC addr filter for a VF::
821 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
822 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
824 set port - rx mode(for VF)
825 ~~~~~~~~~~~~~~~~~~~~~~~~~~
827 Set the VF receive mode of a port::
829 testpmd> set port (port_id) vf (vf_id) \
830 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
832 The available receive modes are:
834 * ``AUPE``: Accepts untagged VLAN.
836 * ``ROPE``: Accepts unicast hash.
838 * ``BAM``: Accepts broadcast packets.
840 * ``MPE``: Accepts all multicast packets.
842 set port - tx_rate (for Queue)
843 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
845 Set TX rate limitation for a queue on a port::
847 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
849 set port - tx_rate (for VF)
850 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
852 Set TX rate limitation for queues in VF on a port::
854 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
856 set port - mirror rule
857 ~~~~~~~~~~~~~~~~~~~~~~
859 Set pool or vlan type mirror rule for a port::
861 testpmd> set port (port_id) mirror-rule (rule_id) \
862 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
863 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
865 Set link mirror rule for a port::
867 testpmd> set port (port_id) mirror-rule (rule_id) \
868 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
870 For example to enable mirror traffic with vlan 0,1 to pool 0::
872 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
874 reset port - mirror rule
875 ~~~~~~~~~~~~~~~~~~~~~~~~
877 Reset a mirror rule for a port::
879 testpmd> reset port (port_id) mirror-rule (rule_id)
884 Set the flush on RX streams before forwarding.
885 The default is flush ``on``.
886 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
888 testpmd> set flush_rx off
893 Set the bypass mode for the lowest port on bypass enabled NIC::
895 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
900 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
902 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
903 mode (normal|bypass|isolate) (port_id)
907 * ``timeout``: Enable bypass after watchdog timeout.
909 * ``os_on``: Enable bypass when OS/board is powered on.
911 * ``os_off``: Enable bypass when OS/board is powered off.
913 * ``power_on``: Enable bypass when power supply is turned on.
915 * ``power_off``: Enable bypass when power supply is turned off.
921 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
923 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
928 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
930 testpmd> show bypass config (port_id)
935 Set link up for a port::
937 testpmd> set link-up port (port id)
942 Set link down for a port::
944 testpmd> set link-down port (port id)
949 Enable E-tag insertion for a VF on a port::
951 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
953 Disable E-tag insertion for a VF on a port::
955 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
957 Enable/disable E-tag stripping on a port::
959 testpmd> E-tag set stripping (on|off) port (port_id)
961 Enable/disable E-tag based forwarding on a port::
963 testpmd> E-tag set forwarding (on|off) port (port_id)
965 Add an E-tag forwarding filter on a port::
967 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
969 Delete an E-tag forwarding filter on a port::
970 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
976 The following sections show functions for configuring ports.
980 Port configuration changes only become active when forwarding is started/restarted.
985 Attach a port specified by pci address or virtual device args::
987 testpmd> port attach (identifier)
989 To attach a new pci device, the device should be recognized by kernel first.
990 Then it should be moved under DPDK management.
991 Finally the port can be attached to testpmd.
993 For example, to move a pci device using ixgbe under DPDK management:
995 .. code-block:: console
997 # Check the status of the available devices.
998 ./tools/dpdk_nic_bind.py --status
1000 Network devices using DPDK-compatible driver
1001 ============================================
1004 Network devices using kernel driver
1005 ===================================
1006 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1009 # Bind the device to igb_uio.
1010 sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0
1013 # Recheck the status of the devices.
1014 ./tools/dpdk_nic_bind.py --status
1015 Network devices using DPDK-compatible driver
1016 ============================================
1017 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1019 To attach a port created by virtual device, above steps are not needed.
1021 For example, to attach a port whose pci address is 0000:0a:00.0.
1023 .. code-block:: console
1025 testpmd> port attach 0000:0a:00.0
1026 Attaching a new port...
1027 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1028 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1029 EAL: PCI memory mapped at 0x7f83bfa00000
1030 EAL: PCI memory mapped at 0x7f83bfa80000
1031 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1032 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1033 Port 0 is attached. Now total ports is 1
1036 For example, to attach a port created by pcap PMD.
1038 .. code-block:: console
1040 testpmd> port attach eth_pcap0
1041 Attaching a new port...
1042 PMD: Initializing pmd_pcap for eth_pcap0
1043 PMD: Creating pcap-backed ethdev on numa socket 0
1044 Port 0 is attached. Now total ports is 1
1047 In this case, identifier is ``eth_pcap0``.
1048 This identifier format is the same as ``--vdev`` format of DPDK applications.
1050 For example, to re-attach a bonded port which has been previously detached,
1051 the mode and slave parameters must be given.
1053 .. code-block:: console
1055 testpmd> port attach eth_bond_0,mode=0,slave=1
1056 Attaching a new port...
1057 EAL: Initializing pmd_bond for eth_bond_0
1058 EAL: Create bonded device eth_bond_0 on port 0 in mode 0 on socket 0.
1059 Port 0 is attached. Now total ports is 1
1066 Detach a specific port::
1068 testpmd> port detach (port_id)
1070 Before detaching a port, the port should be stopped and closed.
1072 For example, to detach a pci device port 0.
1074 .. code-block:: console
1076 testpmd> port stop 0
1079 testpmd> port close 0
1083 testpmd> port detach 0
1085 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1086 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1087 EAL: PCI memory unmapped at 0x7f83bfa00000
1088 EAL: PCI memory unmapped at 0x7f83bfa80000
1092 For example, to detach a virtual device port 0.
1094 .. code-block:: console
1096 testpmd> port stop 0
1099 testpmd> port close 0
1103 testpmd> port detach 0
1105 PMD: Closing pcap ethdev on numa socket 0
1106 Port 'eth_pcap0' is detached. Now total ports is 0
1109 To remove a pci device completely from the system, first detach the port from testpmd.
1110 Then the device should be moved under kernel management.
1111 Finally the device can be removed using kernel pci hotplug functionality.
1113 For example, to move a pci device under kernel management:
1115 .. code-block:: console
1117 sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0
1119 ./tools/dpdk_nic_bind.py --status
1121 Network devices using DPDK-compatible driver
1122 ============================================
1125 Network devices using kernel driver
1126 ===================================
1127 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
1129 To remove a port created by a virtual device, above steps are not needed.
1134 Start all ports or a specific port::
1136 testpmd> port start (port_id|all)
1141 Stop all ports or a specific port::
1143 testpmd> port stop (port_id|all)
1148 Close all ports or a specific port::
1150 testpmd> port close (port_id|all)
1152 port start/stop queue
1153 ~~~~~~~~~~~~~~~~~~~~~
1155 Start/stop a rx/tx queue on a specific port::
1157 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
1159 Only take effect when port is started.
1164 Set the speed and duplex mode for all ports or a specific port::
1166 testpmd> port config (port_id|all) speed (10|100|1000|10000|40000|100000|auto) \
1167 duplex (half|full|auto)
1169 port config - queues/descriptors
1170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1172 Set number of queues/descriptors for rxq, txq, rxd and txd::
1174 testpmd> port config all (rxq|txq|rxd|txd) (value)
1176 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
1178 port config - max-pkt-len
1179 ~~~~~~~~~~~~~~~~~~~~~~~~~
1181 Set the maximum packet length::
1183 testpmd> port config all max-pkt-len (value)
1185 This is equivalent to the ``--max-pkt-len`` command-line option.
1187 port config - CRC Strip
1188 ~~~~~~~~~~~~~~~~~~~~~~~
1190 Set hardware CRC stripping on or off for all ports::
1192 testpmd> port config all crc-strip (on|off)
1194 CRC stripping is off by default.
1196 The ``on`` option is equivalent to the ``--crc-strip`` command-line option.
1198 port config - scatter
1199 ~~~~~~~~~~~~~~~~~~~~~~~
1201 Set RX scatter mode on or off for all ports::
1203 testpmd> port config all scatter (on|off)
1205 RX scatter mode is off by default.
1207 The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
1209 port config - TX queue flags
1210 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1212 Set a hexadecimal bitmap of TX queue flags for all ports::
1214 testpmd> port config all txqflags value
1216 This command is equivalent to the ``--txqflags`` command-line option.
1218 port config - RX Checksum
1219 ~~~~~~~~~~~~~~~~~~~~~~~~~
1221 Set hardware RX checksum offload to on or off for all ports::
1223 testpmd> port config all rx-cksum (on|off)
1225 Checksum offload is off by default.
1227 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
1232 Set hardware VLAN on or off for all ports::
1234 testpmd> port config all hw-vlan (on|off)
1236 Hardware VLAN is on by default.
1238 The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option.
1240 port config - VLAN filter
1241 ~~~~~~~~~~~~~~~~~~~~~~~~~
1243 Set hardware VLAN filter on or off for all ports::
1245 testpmd> port config all hw-vlan-filter (on|off)
1247 Hardware VLAN filter is on by default.
1249 The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option.
1251 port config - VLAN strip
1252 ~~~~~~~~~~~~~~~~~~~~~~~~
1254 Set hardware VLAN strip on or off for all ports::
1256 testpmd> port config all hw-vlan-strip (on|off)
1258 Hardware VLAN strip is on by default.
1260 The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option.
1262 port config - VLAN extend
1263 ~~~~~~~~~~~~~~~~~~~~~~~~~
1265 Set hardware VLAN extend on or off for all ports::
1267 testpmd> port config all hw-vlan-extend (on|off)
1269 Hardware VLAN extend is off by default.
1271 The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option.
1273 port config - Drop Packets
1274 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1276 Set packet drop for packets with no descriptors on or off for all ports::
1278 testpmd> port config all drop-en (on|off)
1280 Packet dropping for packets with no descriptors is off by default.
1282 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
1287 Set the RSS (Receive Side Scaling) mode on or off::
1289 testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|none)
1291 RSS is on by default.
1293 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
1295 port config - RSS Reta
1296 ~~~~~~~~~~~~~~~~~~~~~~
1298 Set the RSS (Receive Side Scaling) redirection table::
1300 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
1305 Set the DCB mode for an individual port::
1307 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1309 The traffic class should be 4 or 8.
1314 Set the number of packets per burst::
1316 testpmd> port config all burst (value)
1318 This is equivalent to the ``--burst`` command-line option.
1320 port config - Threshold
1321 ~~~~~~~~~~~~~~~~~~~~~~~
1323 Set thresholds for TX/RX queues::
1325 testpmd> port config all (threshold) (value)
1327 Where the threshold type can be:
1329 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1331 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
1333 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1335 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1337 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
1339 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1341 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1343 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1345 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1347 These threshold options are also available from the command-line.
1352 Set the value of ether-type for E-tag::
1354 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
1356 Enable/disable the E-tag support::
1358 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
1361 Link Bonding Functions
1362 ----------------------
1364 The Link Bonding functions make it possible to dynamically create and
1365 manage link bonding devices from within testpmd interactive prompt.
1367 create bonded device
1368 ~~~~~~~~~~~~~~~~~~~~
1370 Create a new bonding device::
1372 testpmd> create bonded device (mode) (socket)
1374 For example, to create a bonded device in mode 1 on socket 0::
1376 testpmd> create bonded 1 0
1377 created new bonded device (port X)
1382 Adds Ethernet device to a Link Bonding device::
1384 testpmd> add bonding slave (slave id) (port id)
1386 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
1388 testpmd> add bonding slave 6 10
1391 remove bonding slave
1392 ~~~~~~~~~~~~~~~~~~~~
1394 Removes an Ethernet slave device from a Link Bonding device::
1396 testpmd> remove bonding slave (slave id) (port id)
1398 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
1400 testpmd> remove bonding slave 6 10
1405 Set the Link Bonding mode of a Link Bonding device::
1407 testpmd> set bonding mode (value) (port id)
1409 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
1411 testpmd> set bonding mode 3 10
1416 Set an Ethernet slave device as the primary device on a Link Bonding device::
1418 testpmd> set bonding primary (slave id) (port id)
1420 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
1422 testpmd> set bonding primary 6 10
1427 Set the MAC address of a Link Bonding device::
1429 testpmd> set bonding mac (port id) (mac)
1431 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
1433 testpmd> set bonding mac 10 00:00:00:00:00:01
1435 set bonding xmit_balance_policy
1436 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1438 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
1440 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1442 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
1444 testpmd> set bonding xmit_balance_policy 10 l34
1447 set bonding mon_period
1448 ~~~~~~~~~~~~~~~~~~~~~~
1450 Set the link status monitoring polling period in milliseconds for a bonding device.
1452 This adds support for PMD slave devices which do not support link status interrupts.
1453 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1454 link status ISR will be queried every polling interval to check if their link status has changed::
1456 testpmd> set bonding mon_period (port_id) (value)
1458 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
1460 testpmd> set bonding mon_period 5 150
1466 Show the current configuration of a Link Bonding device::
1468 testpmd> show bonding config (port id)
1471 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1472 in balance mode with a transmission policy of layer 2+3::
1474 testpmd> show bonding config 9
1476 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1478 Active Slaves (3): [1 3 4]
1485 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
1486 This is mainly useful for debugging purposes.
1487 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1488 and fields that can be accessed.
1493 Display the value of a port register::
1495 testpmd> read reg (port_id) (address)
1497 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
1499 testpmd> read reg 0 0xEE00
1500 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1505 Display a port register bit field::
1507 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
1509 For example, reading the lowest two bits from the register in the example above::
1511 testpmd> read regfield 0 0xEE00 0 1
1512 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1517 Display a single port register bit::
1519 testpmd> read regbit (port_id) (address) (bit_x)
1521 For example, reading the lowest bit from the register in the example above::
1523 testpmd> read regbit 0 0xEE00 0
1524 port 0 PCI register at offset 0xEE00: bit 0=1
1529 Set the value of a port register::
1531 testpmd> write reg (port_id) (address) (value)
1533 For example, to clear a register::
1535 testpmd> write reg 0 0xEE00 0x0
1536 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1541 Set bit field of a port register::
1543 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
1545 For example, writing to the register cleared in the example above::
1547 testpmd> write regfield 0 0xEE00 0 1 2
1548 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1553 Set single bit value of a port register::
1555 testpmd> write regbit (port_id) (address) (bit_x) (value)
1557 For example, to set the high bit in the register from the example above::
1559 testpmd> write regbit 0 0xEE00 31 1
1560 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
1566 This section details the available filter functions that are available.
1569 ~~~~~~~~~~~~~~~~~~~~
1571 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
1573 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
1574 ethertype (ether_type) (drop|fwd) queue (queue_id)
1576 The available information parameters are:
1578 * ``port_id``: The port which the Ethertype filter assigned on.
1580 * ``mac_addr``: Compare destination mac address.
1582 * ``mac_ignr``: Ignore destination mac address match.
1584 * ``mac_address``: Destination mac address to match.
1586 * ``ether_type``: The EtherType value want to match,
1587 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
1589 * ``queue_id``: The receive queue associated with this EtherType filter.
1590 It is meaningless when deleting or dropping.
1592 Example, to add/remove an ethertype filter rule::
1594 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
1595 ethertype 0x0806 fwd queue 3
1597 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
1598 ethertype 0x0806 fwd queue 3
1603 Add or delete a 2-tuple filter,
1604 which identifies packets by specific protocol and destination TCP/UDP port
1605 and forwards packets into one of the receive queues::
1607 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
1608 protocol (protocol_value) mask (mask_value) \
1609 tcp_flags (tcp_flags_value) priority (prio_value) \
1612 The available information parameters are:
1614 * ``port_id``: The port which the 2-tuple filter assigned on.
1616 * ``dst_port_value``: Destination port in L4.
1618 * ``protocol_value``: IP L4 protocol.
1620 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
1622 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
1624 * ``prio_value``: Priority of this filter.
1626 * ``queue_id``: The receive queue associated with this 2-tuple filter.
1628 Example, to add/remove an 2tuple filter rule::
1630 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
1631 tcp_flags 0x02 priority 3 queue 3
1633 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
1634 tcp_flags 0x02 priority 3 queue 3
1639 Add or delete a 5-tuple filter,
1640 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
1641 and routes packets into one of the receive queues::
1643 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
1644 (src_address) dst_port (dst_port_value) \
1645 src_port (src_port_value) protocol (protocol_value) \
1646 mask (mask_value) tcp_flags (tcp_flags_value) \
1647 priority (prio_value) queue (queue_id)
1649 The available information parameters are:
1651 * ``port_id``: The port which the 5-tuple filter assigned on.
1653 * ``dst_address``: Destination IP address.
1655 * ``src_address``: Source IP address.
1657 * ``dst_port_value``: TCP/UDP destination port.
1659 * ``src_port_value``: TCP/UDP source port.
1661 * ``protocol_value``: L4 protocol.
1663 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
1665 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
1667 * ``prio_value``: The priority of this filter.
1669 * ``queue_id``: The receive queue associated with this 5-tuple filter.
1671 Example, to add/remove an 5tuple filter rule::
1673 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1674 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1675 flags 0x0 priority 3 queue 3
1677 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1678 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1679 flags 0x0 priority 3 queue 3
1684 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
1686 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
1688 The available information parameters are:
1690 * ``port_id``: The port which the SYN filter assigned on.
1692 * ``high``: This SYN filter has higher priority than other filters.
1694 * ``low``: This SYN filter has lower priority than other filters.
1696 * ``queue_id``: The receive queue associated with this SYN filter
1700 testpmd> syn_filter 0 add priority high queue 3
1705 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
1706 and routed into one of the receive queues::
1708 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
1709 mask (mask_value) priority (prio_value) queue (queue_id)
1711 The available information parameters are:
1713 * ``port_id``: The port which the Flex filter is assigned on.
1715 * ``len_value``: Filter length in bytes, no greater than 128.
1717 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
1719 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
1721 * ``prio_value``: The priority of this filter.
1723 * ``queue_id``: The receive queue associated with this Flex filter.
1727 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
1728 mask 000C priority 3 queue 3
1730 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
1731 mask 000C priority 3 queue 3
1734 .. _testpmd_flow_director:
1736 flow_director_filter
1737 ~~~~~~~~~~~~~~~~~~~~
1739 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
1741 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
1742 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
1744 * Perfect match filters.
1745 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1746 The masked fields are for IP flow.
1748 * Signature filters.
1749 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
1751 * Perfect-mac-vlan match filters.
1752 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1753 The masked fields are for MAC VLAN flow.
1755 * Perfect-tunnel match filters.
1756 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1757 The masked fields are for tunnel flow.
1759 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
1760 per flow type and the flexible payload.
1762 The Flow Director can also mask out parts of all of these fields so that filters
1763 are only applied to certain fields or parts of the fields.
1765 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
1767 # Commands to add flow director filters of different flow types::
1769 flow_director_filter (port_id) mode IP (add|del|update) \
1770 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
1771 src (src_ip_address) dst (dst_ip_address) \
1772 tos (tos_value) proto (proto_value) ttl (ttl_value) \
1773 vlan (vlan_value) flexbytes (flexbytes_value) \
1774 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
1777 flow_director_filter (port_id) mode IP (add|del|update) \
1778 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
1779 src (src_ip_address) (src_port) \
1780 dst (dst_ip_address) (dst_port) \
1781 tos (tos_value) ttl (ttl_value) \
1782 vlan (vlan_value) flexbytes (flexbytes_value) \
1783 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
1786 flow_director_filter (port_id) mode IP (add|del|update) \
1787 flow (ipv4-sctp|ipv6-sctp) \
1788 src (src_ip_address) (src_port) \
1789 dst (dst_ip_address) (dst_port) \
1790 tos (tos_value) ttl (ttl_value) \
1791 tag (verification_tag) vlan (vlan_value) \
1792 flexbytes (flexbytes_value) (drop|fwd) \
1793 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
1795 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
1796 ether (ethertype) flexbytes (flexbytes_value) \
1797 (drop|fwd) pf|vf(vf_id) queue (queue_id)
1800 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
1801 mac (mac_address) vlan (vlan_value) \
1802 flexbytes (flexbytes_value) (drop|fwd) \
1803 queue (queue_id) fd_id (fd_id_value)
1805 flow_director_filter (port_id) mode Tunnel (add|del|update) \
1806 mac (mac_address) vlan (vlan_value) \
1807 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
1808 flexbytes (flexbytes_value) (drop|fwd) \
1809 queue (queue_id) fd_id (fd_id_value)
1811 For example, to add an ipv4-udp flow type filter::
1813 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
1814 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
1815 fwd pf queue 1 fd_id 1
1817 For example, add an ipv4-other flow type filter::
1819 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
1820 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
1821 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
1826 Flush all flow director filters on a device::
1828 testpmd> flush_flow_director (port_id)
1830 Example, to flush all flow director filter on port 0::
1832 testpmd> flush_flow_director 0
1837 Set flow director's input masks::
1839 flow_director_mask (port_id) mode IP vlan (vlan_value) \
1840 src_mask (ipv4_src) (ipv6_src) (src_port) \
1841 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
1843 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) \
1846 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
1847 mac (mac_value) tunnel-type (tunnel_type_value) \
1848 tunnel-id (tunnel_id_value)
1850 Example, to set flow director mask on port 0::
1852 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
1853 src_mask 255.255.255.255 \
1854 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
1855 dst_mask 255.255.255.255 \
1856 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
1858 flow_director_flex_mask
1859 ~~~~~~~~~~~~~~~~~~~~~~~
1861 set masks of flow director's flexible payload based on certain flow type::
1863 testpmd> flow_director_flex_mask (port_id) \
1864 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1865 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
1866 l2_payload|all) (mask)
1868 Example, to set flow director's flex mask for all flow type on port 0::
1870 testpmd> flow_director_flex_mask 0 flow all \
1871 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
1874 flow_director_flex_payload
1875 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1877 Configure flexible payload selection::
1879 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
1881 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
1883 testpmd> flow_director_flex_payload 0 l4 \
1884 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
1886 get_sym_hash_ena_per_port
1887 ~~~~~~~~~~~~~~~~~~~~~~~~~
1889 Get symmetric hash enable configuration per port::
1891 get_sym_hash_ena_per_port (port_id)
1893 For example, to get symmetric hash enable configuration of port 1::
1895 testpmd> get_sym_hash_ena_per_port 1
1897 set_sym_hash_ena_per_port
1898 ~~~~~~~~~~~~~~~~~~~~~~~~~
1900 Set symmetric hash enable configuration per port to enable or disable::
1902 set_sym_hash_ena_per_port (port_id) (enable|disable)
1904 For example, to set symmetric hash enable configuration of port 1 to enable::
1906 testpmd> set_sym_hash_ena_per_port 1 enable
1908 get_hash_global_config
1909 ~~~~~~~~~~~~~~~~~~~~~~
1911 Get the global configurations of hash filters::
1913 get_hash_global_config (port_id)
1915 For example, to get the global configurations of hash filters of port 1::
1917 testpmd> get_hash_global_config 1
1919 set_hash_global_config
1920 ~~~~~~~~~~~~~~~~~~~~~~
1922 Set the global configurations of hash filters::
1924 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
1925 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
1926 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \
1929 For example, to enable simple_xor for flow type of ipv6 on port 2::
1931 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
1936 Set the input set for hash::
1938 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1939 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
1940 l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
1941 ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
1942 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
1943 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
1944 fld-8th|none) (select|add)
1946 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
1948 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
1953 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
1954 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
1956 Set the input set for flow director::
1958 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1959 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
1960 l2_payload) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
1961 ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
1962 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
1963 sctp-dst-port|sctp-veri-tag|none) (select|add)
1965 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
1967 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
1972 Set different GRE key length for input set::
1974 global_config (port_id) gre-key-len (number in bytes)
1976 For example to set GRE key length for input set to 4 bytes on port 0::
1978 testpmd> global_config 0 gre-key-len 4