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 Displays the configuration of the application.
212 The configuration comes from the command-line, the runtime or the application defaults::
214 testpmd> show config (rxtx|cores|fwd)
216 The available information categories are:
218 * ``rxtx``: RX/TX configuration items.
220 * ``cores``: List of forwarding cores.
222 * ``fwd``: Packet forwarding configuration.
226 .. code-block:: console
228 testpmd> show config rxtx
230 io packet forwarding - CRC stripping disabled - packets/burst=16
231 nb forwarding cores=2 - nb forwarding ports=1
232 RX queues=1 - RX desc=128 - RX free threshold=0
233 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
234 TX queues=1 - TX desc=512 - TX free threshold=0
235 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
236 TX RS bit threshold=0 - TXQ flags=0x0
241 Set the packet forwarding mode::
243 testpmd> set fwd (io|mac|mac_retry|macswap|flowgen| \
244 rxonly|txonly|csum|icmpecho)
246 The available information categories are:
248 * ``io``: Forwards packets "as-is" in I/O mode.
249 This is the fastest possible forwarding operation as it does not access packets data.
250 This is the default mode.
252 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
254 * ``mac_retry``: Same as "mac" forwarding mode, but includes retries if the destination queue is full.
256 * ``macswap``: MAC swap forwarding mode.
257 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
259 * ``flowgen``: Multi-flow generation mode.
260 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
262 * ``rxonly``: Receives packets but doesn't transmit them.
264 * ``txonly``: Generates and transmits packets without receiving any.
266 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
268 * ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
270 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
272 Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``.
276 testpmd> set fwd rxonly
278 Set rxonly packet forwarding mode
284 Display an RX descriptor for a port RX queue::
286 testpmd> read rxd (port_id) (queue_id) (rxd_id)
290 testpmd> read rxd 0 0 4
291 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
296 Display a TX descriptor for a port TX queue::
298 testpmd> read txd (port_id) (queue_id) (txd_id)
302 testpmd> read txd 0 0 4
303 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
306 Configuration Functions
307 -----------------------
309 The testpmd application can be configured from the runtime as well as from the command-line.
311 This section details the available configuration functions that are available.
315 Configuration changes only become active when forwarding is started/restarted.
320 Reset forwarding to the default configuration::
327 Set the debug verbosity level::
329 testpmd> set verbose (level)
331 Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
336 Set the number of ports used by the application:
340 This is equivalent to the ``--nb-ports`` command-line option.
345 Set the number of cores used by the application::
347 testpmd> set nbcore (num)
349 This is equivalent to the ``--nb-cores`` command-line option.
353 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
358 Set the forwarding cores hexadecimal mask::
360 testpmd> set coremask (mask)
362 This is equivalent to the ``--coremask`` command-line option.
366 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
371 Set the forwarding ports hexadecimal mask::
373 testpmd> set portmask (mask)
375 This is equivalent to the ``--portmask`` command-line option.
380 Set number of packets per burst::
382 testpmd> set burst (num)
384 This is equivalent to the ``--burst command-line`` option.
386 In ``mac_retry`` forwarding mode, the transmit delay time and number of retries can also be set::
388 testpmd> set burst tx delay (micrseconds) retry (num)
393 Set the length of each segment of the TX-ONLY packets::
395 testpmd> set txpkts (x[,y]*)
397 Where x[,y]* represents a CSV list of values, without white space.
402 Set the list of forwarding cores::
404 testpmd> set corelist (x[,y]*)
406 For example, to change the forwarding cores:
408 .. code-block:: console
410 testpmd> set corelist 3,1
411 testpmd> show config fwd
413 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
414 Logical Core 3 (socket 0) forwards packets on 1 streams:
415 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
416 Logical Core 1 (socket 0) forwards packets on 1 streams:
417 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
421 The cores are used in the same order as specified on the command line.
426 Set the list of forwarding ports::
428 testpmd> set portlist (x[,y]*)
430 For example, to change the port forwarding:
432 .. code-block:: console
434 testpmd> set portlist 0,2,1,3
435 testpmd> show config fwd
437 io packet forwarding - ports=4 - cores=1 - streams=4
438 Logical Core 3 (socket 0) forwards packets on 4 streams:
439 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
440 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
441 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
442 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
447 Set the VLAN strip on a port::
449 testpmd> vlan set strip (on|off) (port_id)
454 Set the VLAN strip for a queue on a port::
456 testpmd> vlan set stripq (on|off) (port_id,queue_id)
461 Set the VLAN filter on a port::
463 testpmd> vlan set filter (on|off) (port_id)
468 Set the VLAN QinQ (extended queue in queue) on for a port::
470 testpmd> vlan set qinq (on|off) (port_id)
475 Set the outer VLAN TPID for packet filtering on a port::
477 testpmd> vlan set tpid (value) (port_id)
481 TPID value must be a 16-bit number (value <= 65536).
486 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
488 testpmd> rx_vlan add (vlan_id|all) (port_id)
492 VLAN filter must be set on that port. VLAN ID < 4096.
493 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
494 in VFTA table. This is important if enabling all vlan_ids.
499 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
501 testpmd> rx_vlan rm (vlan_id|all) (port_id)
506 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
508 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
513 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
515 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
520 Set the outer VLAN TPID for packet filtering on a port::
522 testpmd> rx_vlan set tpid (value) (port_id)
527 Add a tunnel filter on a port::
529 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
530 (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id)
535 Remove a tunnel filter on a port::
537 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
538 (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id)
543 Add an UDP port for VXLAN packet filter on a port::
545 testpmd> rx_vxlan_port add (udp_port) (port_id)
550 Remove an UDP port for VXLAN packet filter on a port::
552 testpmd> rx_vxlan_port rm (udp_port) (port_id)
557 Set hardware insertion of VLAN IDs in packets sent on a port::
559 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
561 For example, set a single VLAN ID (5) insertion on port 0::
565 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
573 Set port based hardware insertion of VLAN ID in packets sent on a port::
575 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
580 Disable hardware insertion of a VLAN header in packets sent on a port::
582 testpmd> tx_vlan reset (port_id)
587 Select hardware or software calculation of the checksum when
588 transmitting a packet using the ``csum`` forwarding engine::
590 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
594 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
596 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
597 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
598 supported). See also the ``csum parse-tunnel`` command.
602 Check the NIC Datasheet for hardware limits.
607 Define how tunneled packets should be handled by the csum forward
610 testpmd> csum parse-tunnel (on|off) (tx_port_id)
612 If enabled, the csum forward engine will try to recognize supported
613 tunnel headers (vxlan, gre, ipip).
615 If disabled, treat tunnel packets as non-tunneled packets (a inner
616 header is handled as a packet payload).
620 The port argument is the TX port like in the ``csum set`` command.
624 Consider a packet in packet like the following::
626 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
628 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
629 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
630 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``).
632 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
633 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
638 Display tx checksum offload configuration::
640 testpmd> csum show (port_id)
645 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
647 testpmd> tso set (segsize) (port_id)
651 Check the NIC datasheet for hardware limits.
656 Display the status of TCP Segmentation Offload::
658 testpmd> tso show (port_id)
663 Add an alternative MAC address to a port::
665 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
670 Remove a MAC address from a port::
672 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
677 Add an alternative MAC address for a VF to a port::
679 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
684 Set the unicast hash filter(s) on/off for a port::
686 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
691 Set the promiscuous mode on for a port or for all ports.
692 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
694 testpmd> set promisc (port_id|all) (on|off)
699 Set the allmulti mode for a port or for all ports::
701 testpmd> set allmulti (port_id|all) (on|off)
703 Same as the ifconfig (8) option. Controls how multicast packets are handled.
708 Set the link flow control parameter on a port::
710 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
711 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
712 autoneg (on|off) (port_id)
716 * ``high_water`` (integer): High threshold value to trigger XOFF.
718 * ``low_water`` (integer): Low threshold value to trigger XON.
720 * ``pause_time`` (integer): Pause quota in the Pause frame.
722 * ``send_xon`` (0/1): Send XON frame.
724 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
726 * ``autoneg``: Change the auto-negotiation para mete.
731 Set the priority flow control parameter on a port::
733 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
734 (pause_time) (priority) (port_id)
738 * ``high_water`` (integer): High threshold value.
740 * ``low_water`` (integer): Low threshold value.
742 * ``pause_time`` (integer): Pause quota in the Pause frame.
744 * ``priority`` (0-7): VLAN User Priority.
749 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
751 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
753 For example, to set rx queue 2 on port 0 to mapping 5::
755 testpmd>set stat_qmap rx 0 2 5
757 set port - rx/tx (for VF)
758 ~~~~~~~~~~~~~~~~~~~~~~~~~
760 Set VF receive/transmit from a port::
762 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
764 set port - mac address filter (for VF)
765 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
767 Add/Remove unicast or multicast MAC addr filter for a VF::
769 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
770 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
772 set port - rx mode(for VF)
773 ~~~~~~~~~~~~~~~~~~~~~~~~~~
775 Set the VF receive mode of a port::
777 testpmd> set port (port_id) vf (vf_id) \
778 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
780 The available receive modes are:
782 * ``AUPE``: Accepts untagged VLAN.
784 * ``ROPE``: Accepts unicast hash.
786 * ``BAM``: Accepts broadcast packets.
788 * ``MPE``: Accepts all multicast packets.
790 set port - tx_rate (for Queue)
791 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
793 Set TX rate limitation for a queue on a port::
795 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
797 set port - tx_rate (for VF)
798 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
800 Set TX rate limitation for queues in VF on a port::
802 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
804 set port - mirror rule
805 ~~~~~~~~~~~~~~~~~~~~~~
807 Set pool or vlan type mirror rule for a port::
809 testpmd> set port (port_id) mirror-rule (rule_id) \
810 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
811 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
813 Set link mirror rule for a port::
815 testpmd> set port (port_id) mirror-rule (rule_id) \
816 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
818 For example to enable mirror traffic with vlan 0,1 to pool 0::
820 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
822 reset port - mirror rule
823 ~~~~~~~~~~~~~~~~~~~~~~~~
825 Reset a mirror rule for a port::
827 testpmd> reset port (port_id) mirror-rule (rule_id)
832 Set the flush on RX streams before forwarding.
833 The default is flush ``on``.
834 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
836 testpmd> set flush_rx off
841 Set the bypass mode for the lowest port on bypass enabled NIC::
843 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
848 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
850 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
851 mode (normal|bypass|isolate) (port_id)
855 * ``timeout``: Enable bypass after watchdog timeout.
857 * ``os_on``: Enable bypass when OS/board is powered on.
859 * ``os_off``: Enable bypass when OS/board is powered off.
861 * ``power_on``: Enable bypass when power supply is turned on.
863 * ``power_off``: Enable bypass when power supply is turned off.
869 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
871 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
876 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
878 testpmd> show bypass config (port_id)
883 Set link up for a port::
885 testpmd> set link-up port (port id)
890 Set link down for a port::
892 testpmd> set link-down port (port id)
898 The following sections show functions for configuring ports.
902 Port configuration changes only become active when forwarding is started/restarted.
907 Attach a port specified by pci address or virtual device args.
909 To attach a new pci device, the device should be recognized by kernel first.
910 Then it should be moved under DPDK management.
911 Finally the port can be attached to testpmd.
913 For example, to move a pci device using ixgbe under DPDK management:
915 .. code-block:: console
917 # Check the status of the available devices.
918 ./tools/dpdk_nic_bind.py --status
920 Network devices using DPDK-compatible driver
921 ============================================
924 Network devices using kernel driver
925 ===================================
926 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
929 # Bind the device to igb_uio.
930 sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0
933 # Recheck the status of the devices.
934 ./tools/dpdk_nic_bind.py --status
935 Network devices using DPDK-compatible driver
936 ============================================
937 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
939 To attach a port created by virtual device, above steps are not needed.
941 port attach (identifier)
943 For example, to attach a port whose pci address is 0000:0a:00.0.
945 .. code-block:: console
947 testpmd> port attach 0000:0a:00.0
948 Attaching a new port...
949 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
950 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
951 EAL: PCI memory mapped at 0x7f83bfa00000
952 EAL: PCI memory mapped at 0x7f83bfa80000
953 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
954 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
955 Port 0 is attached. Now total ports is 1
958 For example, to attach a port created by pcap PMD.
960 .. code-block:: console
962 testpmd> port attach eth_pcap0
963 Attaching a new port...
964 PMD: Initializing pmd_pcap for eth_pcap0
965 PMD: Creating pcap-backed ethdev on numa socket 0
966 Port 0 is attached. Now total ports is 1
969 In this case, identifier is ``eth_pcap0``.
970 This identifier format is the same as ``--vdev`` format of DPDK applications.
972 For example, to re-attach a bonded port which has been previously detached,
973 the mode and slave parameters must be given.
975 .. code-block:: console
977 testpmd> port attach eth_bond_0,mode=0,slave=1
978 Attaching a new port...
979 EAL: Initializing pmd_bond for eth_bond_0
980 EAL: Create bonded device eth_bond_0 on port 0 in mode 0 on socket 0.
981 Port 0 is attached. Now total ports is 1
988 Detach a specific port.
990 Before detaching a port, the port should be closed::
992 testpmd> port detach (port_id)
994 For example, to detach a pci device port 0.
996 .. code-block:: console
998 testpmd> port close 0
1002 testpmd> port detach 0
1004 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1005 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1006 EAL: PCI memory unmapped at 0x7f83bfa00000
1007 EAL: PCI memory unmapped at 0x7f83bfa80000
1011 For example, to detach a virtual device port 0.
1013 .. code-block:: console
1015 testpmd> port close 0
1019 testpmd> port detach 0
1021 PMD: Closing pcap ethdev on numa socket 0
1022 Port 'eth_pcap0' is detached. Now total ports is 0
1025 To remove a pci device completely from the system, first detach the port from testpmd.
1026 Then the device should be moved under kernel management.
1027 Finally the device can be removed using kernel pci hotplug functionality.
1029 For example, to move a pci device under kernel management:
1031 .. code-block:: console
1033 sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0
1035 ./tools/dpdk_nic_bind.py --status
1037 Network devices using DPDK-compatible driver
1038 ============================================
1041 Network devices using kernel driver
1042 ===================================
1043 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
1045 To remove a port created by a virtual device, above steps are not needed.
1050 Start all ports or a specific port::
1052 testpmd> port start (port_id|all)
1057 Stop all ports or a specific port::
1059 testpmd> port stop (port_id|all)
1064 Close all ports or a specific port::
1066 testpmd> port close (port_id|all)
1068 port start/stop queue
1069 ~~~~~~~~~~~~~~~~~~~~~
1071 Start/stop a rx/tx queue on a specific port::
1073 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
1075 Only take effect when port is started.
1080 Set the speed and duplex mode for all ports or a specific port::
1082 testpmd> port config (port_id|all) speed (10|100|1000|10000|auto) \
1083 duplex (half|full|auto)
1085 port config - queues/descriptors
1086 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1088 Set number of queues/descriptors for rxq, txq, rxd and txd::
1090 testpmd> port config all (rxq|txq|rxd|txd) (value)
1092 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
1094 port config - max-pkt-len
1095 ~~~~~~~~~~~~~~~~~~~~~~~~~
1097 Set the maximum packet length::
1099 testpmd> port config all max-pkt-len (value)
1101 This is equivalent to the ``--max-pkt-len`` command-line option.
1103 port config - CRC Strip
1104 ~~~~~~~~~~~~~~~~~~~~~~~
1106 Set hardware CRC stripping on or off for all ports::
1108 testpmd> port config all crc-strip (on|off)
1110 CRC stripping is off by default.
1112 The ``on`` option is equivalent to the ``--crc-strip`` command-line option.
1114 port config - RX Checksum
1115 ~~~~~~~~~~~~~~~~~~~~~~~~~
1117 Set hardware RX checksum offload to on or off for all ports::
1119 testpmd> port config all rx-cksum (on|off)
1121 Checksum offload is off by default.
1123 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
1128 Set hardware VLAN on or off for all ports::
1130 testpmd> port config all hw-vlan (on|off)
1132 Hardware VLAN is on by default.
1134 The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option.
1136 port config - VLAN filter
1137 ~~~~~~~~~~~~~~~~~~~~~~~~~
1139 Set hardware VLAN filter on or off for all ports::
1141 testpmd> port config all hw-vlan-filter (on|off)
1143 Hardware VLAN filter is on by default.
1145 The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option.
1147 port config - VLAN strip
1148 ~~~~~~~~~~~~~~~~~~~~~~~~
1150 Set hardware VLAN strip on or off for all ports::
1152 testpmd> port config all hw-vlan-strip (on|off)
1154 Hardware VLAN strip is on by default.
1156 The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option.
1158 port config - VLAN extend
1159 ~~~~~~~~~~~~~~~~~~~~~~~~~
1161 Set hardware VLAN extend on or off for all ports::
1163 testpmd> port config all hw-vlan-extend (on|off)
1165 Hardware VLAN extend is off by default.
1167 The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option.
1169 port config - Drop Packets
1170 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1172 Set packet drop for packets with no descriptors on or off for all ports::
1174 testpmd> port config all drop-en (on|off)
1176 Packet dropping for packets with no descriptors is off by default.
1178 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
1183 Set the RSS (Receive Side Scaling) mode on or off::
1185 testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|none)
1187 RSS is on by default.
1189 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
1191 port config - RSS Reta
1192 ~~~~~~~~~~~~~~~~~~~~~~
1194 Set the RSS (Receive Side Scaling) redirection table::
1196 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
1201 Set the DCB mode for an individual port::
1203 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1205 The traffic class should be 4 or 8.
1210 Set the number of packets per burst::
1212 testpmd> port config all burst (value)
1214 This is equivalent to the ``--burst`` command-line option.
1216 port config - Threshold
1217 ~~~~~~~~~~~~~~~~~~~~~~~
1219 Set thresholds for TX/RX queues::
1221 testpmd> port config all (threshold) (value)
1223 Where the threshold type can be:
1225 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1227 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
1229 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1231 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1233 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
1235 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1237 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1239 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1241 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1243 These threshold options are also available from the command-line.
1246 Link Bonding Functions
1247 ----------------------
1249 The Link Bonding functions make it possible to dynamically create and
1250 manage link bonding devices from within testpmd interactive prompt.
1252 create bonded device
1253 ~~~~~~~~~~~~~~~~~~~~
1255 Create a new bonding device::
1257 testpmd> create bonded device (mode) (socket)
1259 For example, to create a bonded device in mode 1 on socket 0::
1261 testpmd> create bonded 1 0
1262 created new bonded device (port X)
1267 Adds Ethernet device to a Link Bonding device::
1269 testpmd> add bonding slave (slave id) (port id)
1271 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
1273 testpmd> add bonding slave 6 10
1276 remove bonding slave
1277 ~~~~~~~~~~~~~~~~~~~~
1279 Removes an Ethernet slave device from a Link Bonding device::
1281 testpmd> remove bonding slave (slave id) (port id)
1283 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
1285 testpmd> remove bonding slave 6 10
1290 Set the Link Bonding mode of a Link Bonding device::
1292 testpmd> set bonding mode (value) (port id)
1294 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
1296 testpmd> set bonding mode 3 10
1301 Set an Ethernet slave device as the primary device on a Link Bonding device::
1303 testpmd> set bonding primary (slave id) (port id)
1305 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
1307 testpmd> set bonding primary 6 10
1312 Set the MAC address of a Link Bonding device::
1314 testpmd> set bonding mac (port id) (mac)
1316 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
1318 testpmd> set bonding mac 10 00:00:00:00:00:01
1320 set bonding xmit_balance_policy
1321 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1323 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
1325 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1327 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
1329 testpmd> set bonding xmit_balance_policy 10 l34
1332 set bonding mon_period
1333 ~~~~~~~~~~~~~~~~~~~~~~
1335 Set the link status monitoring polling period in milliseconds for a bonding device.
1337 This adds support for PMD slave devices which do not support link status interrupts.
1338 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1339 link status ISR will be queried every polling interval to check if their link status has changed::
1341 testpmd> set bonding mon_period (port_id) (value)
1343 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
1345 testpmd> set bonding mon_period 5 150
1351 Show the current configuration of a Link Bonding device::
1353 testpmd> show bonding config (port id)
1356 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1357 in balance mode with a transmission policy of layer 2+3::
1359 testpmd> show bonding config 9
1361 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1363 Active Slaves (3): [1 3 4]
1370 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
1371 This is mainly useful for debugging purposes.
1372 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1373 and fields that can be accessed.
1378 Display the value of a port register::
1380 testpmd> read reg (port_id) (address)
1382 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
1384 testpmd> read reg 0 0xEE00
1385 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1390 Display a port register bit field::
1392 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
1394 For example, reading the lowest two bits from the register in the example above::
1396 testpmd> read regfield 0 0xEE00 0 1
1397 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1402 Display a single port register bit::
1404 testpmd> read regbit (port_id) (address) (bit_x)
1406 For example, reading the lowest bit from the register in the example above::
1408 testpmd> read regbit 0 0xEE00 0
1409 port 0 PCI register at offset 0xEE00: bit 0=1
1414 Set the value of a port register::
1416 testpmd> write reg (port_id) (address) (value)
1418 For example, to clear a register::
1420 testpmd> write reg 0 0xEE00 0x0
1421 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1426 Set bit field of a port register::
1428 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
1430 For example, writing to the register cleared in the example above::
1432 testpmd> write regfield 0 0xEE00 0 1 2
1433 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1438 Set single bit value of a port register::
1440 testpmd> write regbit (port_id) (address) (bit_x) (value)
1442 For example, to set the high bit in the register from the example above::
1444 testpmd> write regbit 0 0xEE00 31 1
1445 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
1451 This section details the available filter functions that are available.
1454 ~~~~~~~~~~~~~~~~~~~~
1456 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
1458 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
1459 ethertype (ether_type) (drop|fwd) queue (queue_id)
1461 The available information parameters are:
1463 * ``port_id``: The port which the Ethertype filter assigned on.
1465 * ``mac_addr``: Compare destination mac address.
1467 * ``mac_ignr``: Ignore destination mac address match.
1469 * ``mac_address``: Destination mac address to match.
1471 * ``ether_type``: The EtherType value want to match,
1472 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
1474 * ``queue_id``: The receive queue associated with this EtherType filter.
1475 It is meaningless when deleting or dropping.
1477 Example, to add/remove an ethertype filter rule::
1479 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
1480 ethertype 0x0806 fwd queue 3
1482 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
1483 ethertype 0x0806 fwd queue 3
1488 Add or delete a 2-tuple filter,
1489 which identifies packets by specific protocol and destination TCP/UDP port
1490 and forwards packets into one of the receive queues::
1492 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
1493 protocol (protocol_value) mask (mask_value) \
1494 tcp_flags (tcp_flags_value) priority (prio_value) \
1497 The available information parameters are:
1499 * ``port_id``: The port which the 2-tuple filter assigned on.
1501 * ``dst_port_value``: Destination port in L4.
1503 * ``protocol_value``: IP L4 protocol.
1505 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
1507 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
1509 * ``prio_value``: Priority of this filter.
1511 * ``queue_id``: The receive queue associated with this 2-tuple filter.
1513 Example, to add/remove an 2tuple filter rule::
1515 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
1516 tcp_flags 0x02 priority 3 queue 3
1518 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
1519 tcp_flags 0x02 priority 3 queue 3
1524 Add or delete a 5-tuple filter,
1525 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
1526 and routes packets into one of the receive queues::
1528 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
1529 (src_address) dst_port (dst_port_value) \
1530 src_port (src_port_value) protocol (protocol_value) \
1531 mask (mask_value) tcp_flags (tcp_flags_value) \
1532 priority (prio_value) queue (queue_id)
1534 The available information parameters are:
1536 * ``port_id``: The port which the 5-tuple filter assigned on.
1538 * ``dst_address``: Destination IP address.
1540 * ``src_address``: Source IP address.
1542 * ``dst_port_value``: TCP/UDP destination port.
1544 * ``src_port_value``: TCP/UDP source port.
1546 * ``protocol_value``: L4 protocol.
1548 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
1550 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
1552 * ``prio_value``: The priority of this filter.
1554 * ``queue_id``: The receive queue associated with this 5-tuple filter.
1556 Example, to add/remove an 5tuple filter rule::
1558 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1559 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1560 flags 0x0 priority 3 queue 3
1562 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1563 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1564 flags 0x0 priority 3 queue 3
1569 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
1571 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
1573 The available information parameters are:
1575 * ``port_id``: The port which the SYN filter assigned on.
1577 * ``high``: This SYN filter has higher priority than other filters.
1579 * ``low``: This SYN filter has lower priority than other filters.
1581 * ``queue_id``: The receive queue associated with this SYN filter
1585 testpmd> syn_filter 0 add priority high queue 3
1590 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
1591 and routed into one of the receive queues::
1593 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
1594 mask (mask_value) priority (prio_value) queue (queue_id)
1596 The available information parameters are:
1598 * ``port_id``: The port which the Flex filter is assigned on.
1600 * ``len_value``: Filter length in bytes, no greater than 128.
1602 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
1604 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
1606 * ``prio_value``: The priority of this filter.
1608 * ``queue_id``: The receive queue associated with this Flex filter.
1612 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
1613 mask 000C priority 3 queue 3
1615 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
1616 mask 000C priority 3 queue 3
1619 .. _testpmd_flow_director:
1621 flow_director_filter
1622 ~~~~~~~~~~~~~~~~~~~~
1624 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
1626 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
1627 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
1629 * Perfect match filters.
1630 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1631 The masked fields are for IP flow.
1633 * Signature filters.
1634 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
1636 * Perfect-mac-vlan match filters.
1637 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1638 The masked fields are for MAC VLAN flow.
1640 * Perfect-tunnel match filters.
1641 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1642 The masked fields are for tunnel flow.
1644 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
1645 per flow type and the flexible payload.
1647 The Flow Director can also mask out parts of all of these fields so that filters
1648 are only applied to certain fields or parts of the fields.
1650 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
1652 # Commands to add flow director filters of different flow types::
1654 flow_director_filter (port_id) mode IP (add|del|update) \
1655 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag)
1656 src (src_ip_address) dst (dst_ip_address) \
1657 vlan (vlan_value) flexbytes (flexbytes_value) \
1658 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
1661 flow_director_filter (port_id) mode IP (add|del|update) \
1662 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
1663 src (src_ip_address) (src_port) \
1664 dst (dst_ip_address) (dst_port) \
1665 vlan (vlan_value) flexbytes (flexbytes_value) \
1666 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
1669 flow_director_filter (port_id) mode IP (add|del|update) \
1670 flow (ipv4-sctp|ipv6-sctp) \
1671 src (src_ip_address) (src_port) \
1672 dst (dst_ip_address) (dst_port)
1673 tag (verification_tag) vlan (vlan_value) \
1674 flexbytes (flexbytes_value) (drop|fwd) \
1675 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
1677 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
1678 ether (ethertype) flexbytes (flexbytes_value) \
1679 (drop|fwd) pf|vf(vf_id) queue (queue_id)
1682 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
1683 mac (mac_address) vlan (vlan_value) \
1684 flexbytes (flexbytes_value) (drop|fwd) \
1685 queue (queue_id) fd_id (fd_id_value)
1687 flow_director_filter (port_id) mode Tunnel (add|del|update) \
1688 mac (mac_address) vlan (vlan_value) \
1689 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
1690 flexbytes (flexbytes_value) (drop|fwd) \
1691 queue (queue_id) fd_id (fd_id_value)
1693 For example, to add an ipv4-udp flow type filter::
1695 testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 \
1696 dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
1698 For example, add an ipv4-other flow type filter::
1700 testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 \
1701 dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
1706 Flush all flow director filters on a device::
1708 testpmd> flush_flow_director (port_id)
1710 Example, to flush all flow director filter on port 0::
1712 testpmd> flush_flow_director 0
1717 Set flow director's input masks::
1719 flow_director_mask (port_id) mode IP vlan (vlan_value) \
1720 src_mask (ipv4_src) (ipv6_src) (src_port) \
1721 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
1723 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) \
1726 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
1727 mac (mac_value) tunnel-type (tunnel_type_value) \
1728 tunnel-id (tunnel_id_value)
1730 Example, to set flow director mask on port 0::
1732 testpmd> flow_director_mask 0 vlan 0xefff \
1733 src_mask 255.255.255.255 \
1734 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
1735 dst_mask 255.255.255.255 \
1736 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
1738 flow_director_flex_mask
1739 ~~~~~~~~~~~~~~~~~~~~~~~
1741 set masks of flow director's flexible payload based on certain flow type::
1743 testpmd> flow_director_flex_mask (port_id) \
1744 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1745 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
1746 l2_payload|all) (mask)
1748 Example, to set flow director's flex mask for all flow type on port 0::
1750 testpmd> flow_director_flex_mask 0 flow all \
1751 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
1754 flow_director_flex_payload
1755 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1757 Configure flexible payload selection::
1759 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
1761 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
1763 testpmd> flow_director_flex_payload 0 l4 \
1764 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
1766 get_sym_hash_ena_per_port
1767 ~~~~~~~~~~~~~~~~~~~~~~~~~
1769 Get symmetric hash enable configuration per port::
1771 get_sym_hash_ena_per_port (port_id)
1773 For example, to get symmetric hash enable configuration of port 1::
1775 testpmd> get_sym_hash_ena_per_port 1
1777 set_sym_hash_ena_per_port
1778 ~~~~~~~~~~~~~~~~~~~~~~~~~
1780 Set symmetric hash enable configuration per port to enable or disable::
1782 set_sym_hash_ena_per_port (port_id) (enable|disable)
1784 For example, to set symmetric hash enable configuration of port 1 to enable::
1786 testpmd> set_sym_hash_ena_per_port 1 enable
1788 get_hash_global_config
1789 ~~~~~~~~~~~~~~~~~~~~~~
1791 Get the global configurations of hash filters::
1793 get_hash_global_config (port_id)
1795 For example, to get the global configurations of hash filters of port 1::
1797 testpmd> get_hash_global_config 1
1799 set_hash_global_config
1800 ~~~~~~~~~~~~~~~~~~~~~~
1802 Set the global configurations of hash filters::
1804 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
1805 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
1806 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \
1809 For example, to enable simple_xor for flow type of ipv6 on port 2::
1811 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
1816 Set the input set for hash::
1818 set_hash_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1819 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
1820 l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
1821 ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
1822 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
1823 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
1824 fld-8th|none) (select|add)
1826 For example, to add source IP to hash input set for flow type of ipv4 on port 0::
1828 testpmd> set_hash_input_set 0 ipv4 src-ipv4 add
1833 Set the input set for Fdir::
1835 set_fdir_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1836 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload)
1837 (src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|udp-src-port|udp-dst-port| \
1838 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
1839 fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th|fld-8th|none) \
1842 For example to add source IP to FD input set for flow type of ipv4 on port 0::
1844 testpmd> set_fdir_input_set 0 ipv4 src-ipv4 add
1849 Set different GRE key length for input set::
1851 global_config (port_id) gre-key-len (number in bytes)
1853 For example to set GRE key length for input set to 4 bytes on port 0::
1855 testpmd> global_config 0 gre-key-len 4