2 Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 Testpmd Runtime Functions
34 =========================
36 Where the testpmd application is started in interactive mode, (``-i|--interactive``),
37 it displays a prompt that can be used to start and stop forwarding,
38 configure the application, display statistics, set the Flow Director and other tasks::
42 The testpmd prompt has some, limited, readline support.
43 Common bash command-line functions such as ``Ctrl+a`` and ``Ctrl+e`` to go to the start and end of the prompt line are supported
44 as well as access to the command history via the up-arrow.
46 There is also support for tab completion.
47 If you type a partial command and hit ``<TAB>`` you get a list of the available completions:
49 .. code-block:: console
51 testpmd> show port <TAB>
53 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
54 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
55 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
56 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
62 Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes::
64 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
65 (pause_time) (send_xon) (port_id)
67 In the real ``testpmd>`` prompt these commands should be on a single line.
72 The testpmd has on-line help for the functions that are available at runtime.
73 These are divided into sections and can be accessed using help, help section or help all:
75 .. code-block:: console
79 help control : Start and stop forwarding.
80 help display : Displaying port, stats and config information.
81 help config : Configuration information.
82 help ports : Configuring ports.
83 help registers : Reading and setting port registers.
84 help filters : Filters configuration help.
85 help all : All of the above sections.
94 Start packet forwarding with current configuration::
101 Start packet forwarding with current configuration after sending one burst of packets::
103 testpmd> start tx_first
108 Stop packet forwarding, and display accumulated statistics::
123 The functions in the following sections are used to display information about the
124 testpmd configuration or the NIC status.
129 Display information for a given port or all ports::
131 testpmd> show port (info|stats|fdir|stat_qmap|dcb_tc) (port_id|all)
133 The available information categories are:
135 * ``info``: General port information such as MAC address.
137 * ``stats``: RX/TX statistics.
139 * ``fdir``: Flow Director information and statistics.
141 * ``stat_qmap``: Queue statistics mapping.
143 * ``dcb_tc``: DCB information such as TC mapping.
147 .. code-block:: console
149 testpmd> show port info 0
151 ********************* Infos for port 0 *********************
153 MAC address: XX:XX:XX:XX:XX:XX
155 memory allocation on the socket: 0
157 Link speed: 40000 Mbps
158 Link duplex: full-duplex
159 Promiscuous mode: enabled
160 Allmulticast mode: disabled
161 Maximum number of MAC addresses: 64
162 Maximum number of MAC addresses of hash filtering: 0
167 Redirection table size: 512
168 Supported flow types:
184 Display the rss redirection table entry indicated by masks on port X::
186 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
188 size is used to indicate the hardware supported reta size
193 Display the RSS hash functions and RSS hash key of a port::
195 testpmd> show port (port_id) rss-hash ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|ipv6-udp-ex [key]
200 Clear the port statistics for a given port or for all ports::
202 testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all)
206 testpmd> clear port stats all
211 Display information for a given port's RX/TX queue::
213 testpmd> show (rxq|txq) info (port_id) (queue_id)
218 Displays the configuration of the application.
219 The configuration comes from the command-line, the runtime or the application defaults::
221 testpmd> show config (rxtx|cores|fwd|txpkts)
223 The available information categories are:
225 * ``rxtx``: RX/TX configuration items.
227 * ``cores``: List of forwarding cores.
229 * ``fwd``: Packet forwarding configuration.
231 * ``txpkts``: Packets to TX configuration.
235 .. code-block:: console
237 testpmd> show config rxtx
239 io packet forwarding - CRC stripping disabled - packets/burst=16
240 nb forwarding cores=2 - nb forwarding ports=1
241 RX queues=1 - RX desc=128 - RX free threshold=0
242 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
243 TX queues=1 - TX desc=512 - TX free threshold=0
244 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
245 TX RS bit threshold=0 - TXQ flags=0x0
250 Set the packet forwarding mode::
252 testpmd> set fwd (io|mac|mac_retry|macswap|flowgen| \
253 rxonly|txonly|csum|icmpecho)
255 The available information categories are:
257 * ``io``: Forwards packets "as-is" in I/O mode.
258 This is the fastest possible forwarding operation as it does not access packets data.
259 This is the default mode.
261 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
263 * ``mac_retry``: Same as "mac" forwarding mode, but includes retries if the destination queue is full.
265 * ``macswap``: MAC swap forwarding mode.
266 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
268 * ``flowgen``: Multi-flow generation mode.
269 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
271 * ``rxonly``: Receives packets but doesn't transmit them.
273 * ``txonly``: Generates and transmits packets without receiving any.
275 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
277 * ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
279 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
281 Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``.
285 testpmd> set fwd rxonly
287 Set rxonly packet forwarding mode
293 Display an RX descriptor for a port RX queue::
295 testpmd> read rxd (port_id) (queue_id) (rxd_id)
299 testpmd> read rxd 0 0 4
300 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
305 Display a TX descriptor for a port TX queue::
307 testpmd> read txd (port_id) (queue_id) (txd_id)
311 testpmd> read txd 0 0 4
312 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
315 Configuration Functions
316 -----------------------
318 The testpmd application can be configured from the runtime as well as from the command-line.
320 This section details the available configuration functions that are available.
324 Configuration changes only become active when forwarding is started/restarted.
329 Reset forwarding to the default configuration::
336 Set the debug verbosity level::
338 testpmd> set verbose (level)
340 Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
345 Set the number of ports used by the application:
349 This is equivalent to the ``--nb-ports`` command-line option.
354 Set the number of cores used by the application::
356 testpmd> set nbcore (num)
358 This is equivalent to the ``--nb-cores`` command-line option.
362 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
367 Set the forwarding cores hexadecimal mask::
369 testpmd> set coremask (mask)
371 This is equivalent to the ``--coremask`` command-line option.
375 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
380 Set the forwarding ports hexadecimal mask::
382 testpmd> set portmask (mask)
384 This is equivalent to the ``--portmask`` command-line option.
389 Set number of packets per burst::
391 testpmd> set burst (num)
393 This is equivalent to the ``--burst command-line`` option.
395 In ``mac_retry`` forwarding mode, the transmit delay time and number of retries can also be set::
397 testpmd> set burst tx delay (micrseconds) retry (num)
402 Set the length of each segment of the TX-ONLY packets::
404 testpmd> set txpkts (x[,y]*)
406 Where x[,y]* represents a CSV list of values, without white space.
411 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
413 testpmd> set txsplit (off|on|rand)
417 * ``off`` disable packet copy & split for CSUM mode.
419 * ``on`` split outgoing packet into multiple segments. Size of each segment
420 and number of segments per packet is determined by ``set txpkts`` command
423 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
428 Set the list of forwarding cores::
430 testpmd> set corelist (x[,y]*)
432 For example, to change the forwarding cores:
434 .. code-block:: console
436 testpmd> set corelist 3,1
437 testpmd> show config fwd
439 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
440 Logical Core 3 (socket 0) forwards packets on 1 streams:
441 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
442 Logical Core 1 (socket 0) forwards packets on 1 streams:
443 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
447 The cores are used in the same order as specified on the command line.
452 Set the list of forwarding ports::
454 testpmd> set portlist (x[,y]*)
456 For example, to change the port forwarding:
458 .. code-block:: console
460 testpmd> set portlist 0,2,1,3
461 testpmd> show config fwd
463 io packet forwarding - ports=4 - cores=1 - streams=4
464 Logical Core 3 (socket 0) forwards packets on 4 streams:
465 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
466 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
467 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
468 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
473 Set the VLAN strip on a port::
475 testpmd> vlan set strip (on|off) (port_id)
480 Set the VLAN strip for a queue on a port::
482 testpmd> vlan set stripq (on|off) (port_id,queue_id)
487 Set the VLAN filter on a port::
489 testpmd> vlan set filter (on|off) (port_id)
494 Set the VLAN QinQ (extended queue in queue) on for a port::
496 testpmd> vlan set qinq (on|off) (port_id)
501 Set the inner or outer VLAN TPID for packet filtering on a port::
503 testpmd> vlan set (inner|outer) tpid (value) (port_id)
507 TPID value must be a 16-bit number (value <= 65536).
512 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
514 testpmd> rx_vlan add (vlan_id|all) (port_id)
518 VLAN filter must be set on that port. VLAN ID < 4096.
519 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
520 in VFTA table. This is important if enabling all vlan_ids.
525 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
527 testpmd> rx_vlan rm (vlan_id|all) (port_id)
532 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
534 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
539 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
541 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
546 Add a tunnel filter on a port::
548 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
549 (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id)
554 Remove a tunnel filter on a port::
556 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
557 (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id)
562 Add an UDP port for VXLAN packet filter on a port::
564 testpmd> rx_vxlan_port add (udp_port) (port_id)
569 Remove an UDP port for VXLAN packet filter on a port::
571 testpmd> rx_vxlan_port rm (udp_port) (port_id)
576 Set hardware insertion of VLAN IDs in packets sent on a port::
578 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
580 For example, set a single VLAN ID (5) insertion on port 0::
584 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
592 Set port based hardware insertion of VLAN ID in packets sent on a port::
594 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
599 Disable hardware insertion of a VLAN header in packets sent on a port::
601 testpmd> tx_vlan reset (port_id)
606 Select hardware or software calculation of the checksum when
607 transmitting a packet using the ``csum`` forwarding engine::
609 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
613 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
615 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
616 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
617 supported). See also the ``csum parse-tunnel`` command.
621 Check the NIC Datasheet for hardware limits.
626 Define how tunneled packets should be handled by the csum forward
629 testpmd> csum parse-tunnel (on|off) (tx_port_id)
631 If enabled, the csum forward engine will try to recognize supported
632 tunnel headers (vxlan, gre, ipip).
634 If disabled, treat tunnel packets as non-tunneled packets (a inner
635 header is handled as a packet payload).
639 The port argument is the TX port like in the ``csum set`` command.
643 Consider a packet in packet like the following::
645 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
647 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
648 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
649 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``).
651 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
652 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
657 Display tx checksum offload configuration::
659 testpmd> csum show (port_id)
664 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
666 testpmd> tso set (segsize) (port_id)
670 Check the NIC datasheet for hardware limits.
675 Display the status of TCP Segmentation Offload::
677 testpmd> tso show (port_id)
682 Add an alternative MAC address to a port::
684 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
689 Remove a MAC address from a port::
691 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
696 Add an alternative MAC address for a VF to a port::
698 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
703 Set the unicast hash filter(s) on/off for a port::
705 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
710 Set the promiscuous mode on for a port or for all ports.
711 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
713 testpmd> set promisc (port_id|all) (on|off)
718 Set the allmulti mode for a port or for all ports::
720 testpmd> set allmulti (port_id|all) (on|off)
722 Same as the ifconfig (8) option. Controls how multicast packets are handled.
727 Set the link flow control parameter on a port::
729 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
730 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
731 autoneg (on|off) (port_id)
735 * ``high_water`` (integer): High threshold value to trigger XOFF.
737 * ``low_water`` (integer): Low threshold value to trigger XON.
739 * ``pause_time`` (integer): Pause quota in the Pause frame.
741 * ``send_xon`` (0/1): Send XON frame.
743 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
745 * ``autoneg``: Change the auto-negotiation para mete.
750 Set the priority flow control parameter on a port::
752 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
753 (pause_time) (priority) (port_id)
757 * ``high_water`` (integer): High threshold value.
759 * ``low_water`` (integer): Low threshold value.
761 * ``pause_time`` (integer): Pause quota in the Pause frame.
763 * ``priority`` (0-7): VLAN User Priority.
768 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
770 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
772 For example, to set rx queue 2 on port 0 to mapping 5::
774 testpmd>set stat_qmap rx 0 2 5
776 set port - rx/tx (for VF)
777 ~~~~~~~~~~~~~~~~~~~~~~~~~
779 Set VF receive/transmit from a port::
781 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
783 set port - mac address filter (for VF)
784 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
786 Add/Remove unicast or multicast MAC addr filter for a VF::
788 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
789 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
791 set port - rx mode(for VF)
792 ~~~~~~~~~~~~~~~~~~~~~~~~~~
794 Set the VF receive mode of a port::
796 testpmd> set port (port_id) vf (vf_id) \
797 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
799 The available receive modes are:
801 * ``AUPE``: Accepts untagged VLAN.
803 * ``ROPE``: Accepts unicast hash.
805 * ``BAM``: Accepts broadcast packets.
807 * ``MPE``: Accepts all multicast packets.
809 set port - tx_rate (for Queue)
810 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
812 Set TX rate limitation for a queue on a port::
814 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
816 set port - tx_rate (for VF)
817 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
819 Set TX rate limitation for queues in VF on a port::
821 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
823 set port - mirror rule
824 ~~~~~~~~~~~~~~~~~~~~~~
826 Set pool or vlan type mirror rule for a port::
828 testpmd> set port (port_id) mirror-rule (rule_id) \
829 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
830 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
832 Set link mirror rule for a port::
834 testpmd> set port (port_id) mirror-rule (rule_id) \
835 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
837 For example to enable mirror traffic with vlan 0,1 to pool 0::
839 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
841 reset port - mirror rule
842 ~~~~~~~~~~~~~~~~~~~~~~~~
844 Reset a mirror rule for a port::
846 testpmd> reset port (port_id) mirror-rule (rule_id)
851 Set the flush on RX streams before forwarding.
852 The default is flush ``on``.
853 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
855 testpmd> set flush_rx off
860 Set the bypass mode for the lowest port on bypass enabled NIC::
862 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
867 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
869 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
870 mode (normal|bypass|isolate) (port_id)
874 * ``timeout``: Enable bypass after watchdog timeout.
876 * ``os_on``: Enable bypass when OS/board is powered on.
878 * ``os_off``: Enable bypass when OS/board is powered off.
880 * ``power_on``: Enable bypass when power supply is turned on.
882 * ``power_off``: Enable bypass when power supply is turned off.
888 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
890 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
895 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
897 testpmd> show bypass config (port_id)
902 Set link up for a port::
904 testpmd> set link-up port (port id)
909 Set link down for a port::
911 testpmd> set link-down port (port id)
917 The following sections show functions for configuring ports.
921 Port configuration changes only become active when forwarding is started/restarted.
926 Attach a port specified by pci address or virtual device args.
928 To attach a new pci device, the device should be recognized by kernel first.
929 Then it should be moved under DPDK management.
930 Finally the port can be attached to testpmd.
932 For example, to move a pci device using ixgbe under DPDK management:
934 .. code-block:: console
936 # Check the status of the available devices.
937 ./tools/dpdk_nic_bind.py --status
939 Network devices using DPDK-compatible driver
940 ============================================
943 Network devices using kernel driver
944 ===================================
945 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
948 # Bind the device to igb_uio.
949 sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0
952 # Recheck the status of the devices.
953 ./tools/dpdk_nic_bind.py --status
954 Network devices using DPDK-compatible driver
955 ============================================
956 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
958 To attach a port created by virtual device, above steps are not needed.
960 port attach (identifier)
962 For example, to attach a port whose pci address is 0000:0a:00.0.
964 .. code-block:: console
966 testpmd> port attach 0000:0a:00.0
967 Attaching a new port...
968 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
969 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
970 EAL: PCI memory mapped at 0x7f83bfa00000
971 EAL: PCI memory mapped at 0x7f83bfa80000
972 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
973 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
974 Port 0 is attached. Now total ports is 1
977 For example, to attach a port created by pcap PMD.
979 .. code-block:: console
981 testpmd> port attach eth_pcap0
982 Attaching a new port...
983 PMD: Initializing pmd_pcap for eth_pcap0
984 PMD: Creating pcap-backed ethdev on numa socket 0
985 Port 0 is attached. Now total ports is 1
988 In this case, identifier is ``eth_pcap0``.
989 This identifier format is the same as ``--vdev`` format of DPDK applications.
991 For example, to re-attach a bonded port which has been previously detached,
992 the mode and slave parameters must be given.
994 .. code-block:: console
996 testpmd> port attach eth_bond_0,mode=0,slave=1
997 Attaching a new port...
998 EAL: Initializing pmd_bond for eth_bond_0
999 EAL: Create bonded device eth_bond_0 on port 0 in mode 0 on socket 0.
1000 Port 0 is attached. Now total ports is 1
1007 Detach a specific port.
1009 Before detaching a port, the port should be closed::
1011 testpmd> port detach (port_id)
1013 For example, to detach a pci device port 0.
1015 .. code-block:: console
1017 testpmd> port close 0
1021 testpmd> port detach 0
1023 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1024 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1025 EAL: PCI memory unmapped at 0x7f83bfa00000
1026 EAL: PCI memory unmapped at 0x7f83bfa80000
1030 For example, to detach a virtual device port 0.
1032 .. code-block:: console
1034 testpmd> port close 0
1038 testpmd> port detach 0
1040 PMD: Closing pcap ethdev on numa socket 0
1041 Port 'eth_pcap0' is detached. Now total ports is 0
1044 To remove a pci device completely from the system, first detach the port from testpmd.
1045 Then the device should be moved under kernel management.
1046 Finally the device can be removed using kernel pci hotplug functionality.
1048 For example, to move a pci device under kernel management:
1050 .. code-block:: console
1052 sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0
1054 ./tools/dpdk_nic_bind.py --status
1056 Network devices using DPDK-compatible driver
1057 ============================================
1060 Network devices using kernel driver
1061 ===================================
1062 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
1064 To remove a port created by a virtual device, above steps are not needed.
1069 Start all ports or a specific port::
1071 testpmd> port start (port_id|all)
1076 Stop all ports or a specific port::
1078 testpmd> port stop (port_id|all)
1083 Close all ports or a specific port::
1085 testpmd> port close (port_id|all)
1087 port start/stop queue
1088 ~~~~~~~~~~~~~~~~~~~~~
1090 Start/stop a rx/tx queue on a specific port::
1092 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
1094 Only take effect when port is started.
1099 Set the speed and duplex mode for all ports or a specific port::
1101 testpmd> port config (port_id|all) speed (10|100|1000|10000|auto) \
1102 duplex (half|full|auto)
1104 port config - queues/descriptors
1105 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1107 Set number of queues/descriptors for rxq, txq, rxd and txd::
1109 testpmd> port config all (rxq|txq|rxd|txd) (value)
1111 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
1113 port config - max-pkt-len
1114 ~~~~~~~~~~~~~~~~~~~~~~~~~
1116 Set the maximum packet length::
1118 testpmd> port config all max-pkt-len (value)
1120 This is equivalent to the ``--max-pkt-len`` command-line option.
1122 port config - CRC Strip
1123 ~~~~~~~~~~~~~~~~~~~~~~~
1125 Set hardware CRC stripping on or off for all ports::
1127 testpmd> port config all crc-strip (on|off)
1129 CRC stripping is off by default.
1131 The ``on`` option is equivalent to the ``--crc-strip`` command-line option.
1133 port config - RX Checksum
1134 ~~~~~~~~~~~~~~~~~~~~~~~~~
1136 Set hardware RX checksum offload to on or off for all ports::
1138 testpmd> port config all rx-cksum (on|off)
1140 Checksum offload is off by default.
1142 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
1147 Set hardware VLAN on or off for all ports::
1149 testpmd> port config all hw-vlan (on|off)
1151 Hardware VLAN is on by default.
1153 The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option.
1155 port config - VLAN filter
1156 ~~~~~~~~~~~~~~~~~~~~~~~~~
1158 Set hardware VLAN filter on or off for all ports::
1160 testpmd> port config all hw-vlan-filter (on|off)
1162 Hardware VLAN filter is on by default.
1164 The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option.
1166 port config - VLAN strip
1167 ~~~~~~~~~~~~~~~~~~~~~~~~
1169 Set hardware VLAN strip on or off for all ports::
1171 testpmd> port config all hw-vlan-strip (on|off)
1173 Hardware VLAN strip is on by default.
1175 The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option.
1177 port config - VLAN extend
1178 ~~~~~~~~~~~~~~~~~~~~~~~~~
1180 Set hardware VLAN extend on or off for all ports::
1182 testpmd> port config all hw-vlan-extend (on|off)
1184 Hardware VLAN extend is off by default.
1186 The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option.
1188 port config - Drop Packets
1189 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1191 Set packet drop for packets with no descriptors on or off for all ports::
1193 testpmd> port config all drop-en (on|off)
1195 Packet dropping for packets with no descriptors is off by default.
1197 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
1202 Set the RSS (Receive Side Scaling) mode on or off::
1204 testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|none)
1206 RSS is on by default.
1208 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
1210 port config - RSS Reta
1211 ~~~~~~~~~~~~~~~~~~~~~~
1213 Set the RSS (Receive Side Scaling) redirection table::
1215 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
1220 Set the DCB mode for an individual port::
1222 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1224 The traffic class should be 4 or 8.
1229 Set the number of packets per burst::
1231 testpmd> port config all burst (value)
1233 This is equivalent to the ``--burst`` command-line option.
1235 port config - Threshold
1236 ~~~~~~~~~~~~~~~~~~~~~~~
1238 Set thresholds for TX/RX queues::
1240 testpmd> port config all (threshold) (value)
1242 Where the threshold type can be:
1244 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1246 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
1248 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1250 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1252 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
1254 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1256 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1258 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1260 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1262 These threshold options are also available from the command-line.
1267 Set the value of ether-type for E-tag::
1269 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
1271 Enable/disable the E-tag support::
1273 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
1276 Link Bonding Functions
1277 ----------------------
1279 The Link Bonding functions make it possible to dynamically create and
1280 manage link bonding devices from within testpmd interactive prompt.
1282 create bonded device
1283 ~~~~~~~~~~~~~~~~~~~~
1285 Create a new bonding device::
1287 testpmd> create bonded device (mode) (socket)
1289 For example, to create a bonded device in mode 1 on socket 0::
1291 testpmd> create bonded 1 0
1292 created new bonded device (port X)
1297 Adds Ethernet device to a Link Bonding device::
1299 testpmd> add bonding slave (slave id) (port id)
1301 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
1303 testpmd> add bonding slave 6 10
1306 remove bonding slave
1307 ~~~~~~~~~~~~~~~~~~~~
1309 Removes an Ethernet slave device from a Link Bonding device::
1311 testpmd> remove bonding slave (slave id) (port id)
1313 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
1315 testpmd> remove bonding slave 6 10
1320 Set the Link Bonding mode of a Link Bonding device::
1322 testpmd> set bonding mode (value) (port id)
1324 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
1326 testpmd> set bonding mode 3 10
1331 Set an Ethernet slave device as the primary device on a Link Bonding device::
1333 testpmd> set bonding primary (slave id) (port id)
1335 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
1337 testpmd> set bonding primary 6 10
1342 Set the MAC address of a Link Bonding device::
1344 testpmd> set bonding mac (port id) (mac)
1346 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
1348 testpmd> set bonding mac 10 00:00:00:00:00:01
1350 set bonding xmit_balance_policy
1351 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1353 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
1355 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1357 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
1359 testpmd> set bonding xmit_balance_policy 10 l34
1362 set bonding mon_period
1363 ~~~~~~~~~~~~~~~~~~~~~~
1365 Set the link status monitoring polling period in milliseconds for a bonding device.
1367 This adds support for PMD slave devices which do not support link status interrupts.
1368 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1369 link status ISR will be queried every polling interval to check if their link status has changed::
1371 testpmd> set bonding mon_period (port_id) (value)
1373 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
1375 testpmd> set bonding mon_period 5 150
1381 Show the current configuration of a Link Bonding device::
1383 testpmd> show bonding config (port id)
1386 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1387 in balance mode with a transmission policy of layer 2+3::
1389 testpmd> show bonding config 9
1391 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1393 Active Slaves (3): [1 3 4]
1400 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
1401 This is mainly useful for debugging purposes.
1402 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1403 and fields that can be accessed.
1408 Display the value of a port register::
1410 testpmd> read reg (port_id) (address)
1412 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
1414 testpmd> read reg 0 0xEE00
1415 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1420 Display a port register bit field::
1422 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
1424 For example, reading the lowest two bits from the register in the example above::
1426 testpmd> read regfield 0 0xEE00 0 1
1427 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1432 Display a single port register bit::
1434 testpmd> read regbit (port_id) (address) (bit_x)
1436 For example, reading the lowest bit from the register in the example above::
1438 testpmd> read regbit 0 0xEE00 0
1439 port 0 PCI register at offset 0xEE00: bit 0=1
1444 Set the value of a port register::
1446 testpmd> write reg (port_id) (address) (value)
1448 For example, to clear a register::
1450 testpmd> write reg 0 0xEE00 0x0
1451 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1456 Set bit field of a port register::
1458 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
1460 For example, writing to the register cleared in the example above::
1462 testpmd> write regfield 0 0xEE00 0 1 2
1463 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1468 Set single bit value of a port register::
1470 testpmd> write regbit (port_id) (address) (bit_x) (value)
1472 For example, to set the high bit in the register from the example above::
1474 testpmd> write regbit 0 0xEE00 31 1
1475 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
1481 This section details the available filter functions that are available.
1484 ~~~~~~~~~~~~~~~~~~~~
1486 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
1488 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
1489 ethertype (ether_type) (drop|fwd) queue (queue_id)
1491 The available information parameters are:
1493 * ``port_id``: The port which the Ethertype filter assigned on.
1495 * ``mac_addr``: Compare destination mac address.
1497 * ``mac_ignr``: Ignore destination mac address match.
1499 * ``mac_address``: Destination mac address to match.
1501 * ``ether_type``: The EtherType value want to match,
1502 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
1504 * ``queue_id``: The receive queue associated with this EtherType filter.
1505 It is meaningless when deleting or dropping.
1507 Example, to add/remove an ethertype filter rule::
1509 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
1510 ethertype 0x0806 fwd queue 3
1512 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
1513 ethertype 0x0806 fwd queue 3
1518 Add or delete a 2-tuple filter,
1519 which identifies packets by specific protocol and destination TCP/UDP port
1520 and forwards packets into one of the receive queues::
1522 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
1523 protocol (protocol_value) mask (mask_value) \
1524 tcp_flags (tcp_flags_value) priority (prio_value) \
1527 The available information parameters are:
1529 * ``port_id``: The port which the 2-tuple filter assigned on.
1531 * ``dst_port_value``: Destination port in L4.
1533 * ``protocol_value``: IP L4 protocol.
1535 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
1537 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
1539 * ``prio_value``: Priority of this filter.
1541 * ``queue_id``: The receive queue associated with this 2-tuple filter.
1543 Example, to add/remove an 2tuple filter rule::
1545 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
1546 tcp_flags 0x02 priority 3 queue 3
1548 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
1549 tcp_flags 0x02 priority 3 queue 3
1554 Add or delete a 5-tuple filter,
1555 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
1556 and routes packets into one of the receive queues::
1558 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
1559 (src_address) dst_port (dst_port_value) \
1560 src_port (src_port_value) protocol (protocol_value) \
1561 mask (mask_value) tcp_flags (tcp_flags_value) \
1562 priority (prio_value) queue (queue_id)
1564 The available information parameters are:
1566 * ``port_id``: The port which the 5-tuple filter assigned on.
1568 * ``dst_address``: Destination IP address.
1570 * ``src_address``: Source IP address.
1572 * ``dst_port_value``: TCP/UDP destination port.
1574 * ``src_port_value``: TCP/UDP source port.
1576 * ``protocol_value``: L4 protocol.
1578 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
1580 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
1582 * ``prio_value``: The priority of this filter.
1584 * ``queue_id``: The receive queue associated with this 5-tuple filter.
1586 Example, to add/remove an 5tuple filter rule::
1588 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1589 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1590 flags 0x0 priority 3 queue 3
1592 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1593 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1594 flags 0x0 priority 3 queue 3
1599 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
1601 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
1603 The available information parameters are:
1605 * ``port_id``: The port which the SYN filter assigned on.
1607 * ``high``: This SYN filter has higher priority than other filters.
1609 * ``low``: This SYN filter has lower priority than other filters.
1611 * ``queue_id``: The receive queue associated with this SYN filter
1615 testpmd> syn_filter 0 add priority high queue 3
1620 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
1621 and routed into one of the receive queues::
1623 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
1624 mask (mask_value) priority (prio_value) queue (queue_id)
1626 The available information parameters are:
1628 * ``port_id``: The port which the Flex filter is assigned on.
1630 * ``len_value``: Filter length in bytes, no greater than 128.
1632 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
1634 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
1636 * ``prio_value``: The priority of this filter.
1638 * ``queue_id``: The receive queue associated with this Flex filter.
1642 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
1643 mask 000C priority 3 queue 3
1645 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
1646 mask 000C priority 3 queue 3
1649 .. _testpmd_flow_director:
1651 flow_director_filter
1652 ~~~~~~~~~~~~~~~~~~~~
1654 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
1656 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
1657 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
1659 * Perfect match filters.
1660 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1661 The masked fields are for IP flow.
1663 * Signature filters.
1664 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
1666 * Perfect-mac-vlan match filters.
1667 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1668 The masked fields are for MAC VLAN flow.
1670 * Perfect-tunnel match filters.
1671 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1672 The masked fields are for tunnel flow.
1674 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
1675 per flow type and the flexible payload.
1677 The Flow Director can also mask out parts of all of these fields so that filters
1678 are only applied to certain fields or parts of the fields.
1680 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
1682 # Commands to add flow director filters of different flow types::
1684 flow_director_filter (port_id) mode IP (add|del|update) \
1685 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag)
1686 src (src_ip_address) dst (dst_ip_address) \
1687 vlan (vlan_value) flexbytes (flexbytes_value) \
1688 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
1691 flow_director_filter (port_id) mode IP (add|del|update) \
1692 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
1693 src (src_ip_address) (src_port) \
1694 dst (dst_ip_address) (dst_port) \
1695 vlan (vlan_value) flexbytes (flexbytes_value) \
1696 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
1699 flow_director_filter (port_id) mode IP (add|del|update) \
1700 flow (ipv4-sctp|ipv6-sctp) \
1701 src (src_ip_address) (src_port) \
1702 dst (dst_ip_address) (dst_port)
1703 tag (verification_tag) vlan (vlan_value) \
1704 flexbytes (flexbytes_value) (drop|fwd) \
1705 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
1707 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
1708 ether (ethertype) flexbytes (flexbytes_value) \
1709 (drop|fwd) pf|vf(vf_id) queue (queue_id)
1712 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
1713 mac (mac_address) vlan (vlan_value) \
1714 flexbytes (flexbytes_value) (drop|fwd) \
1715 queue (queue_id) fd_id (fd_id_value)
1717 flow_director_filter (port_id) mode Tunnel (add|del|update) \
1718 mac (mac_address) vlan (vlan_value) \
1719 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
1720 flexbytes (flexbytes_value) (drop|fwd) \
1721 queue (queue_id) fd_id (fd_id_value)
1723 For example, to add an ipv4-udp flow type filter::
1725 testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 \
1726 dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
1728 For example, add an ipv4-other flow type filter::
1730 testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 \
1731 dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
1736 Flush all flow director filters on a device::
1738 testpmd> flush_flow_director (port_id)
1740 Example, to flush all flow director filter on port 0::
1742 testpmd> flush_flow_director 0
1747 Set flow director's input masks::
1749 flow_director_mask (port_id) mode IP vlan (vlan_value) \
1750 src_mask (ipv4_src) (ipv6_src) (src_port) \
1751 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
1753 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) \
1756 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
1757 mac (mac_value) tunnel-type (tunnel_type_value) \
1758 tunnel-id (tunnel_id_value)
1760 Example, to set flow director mask on port 0::
1762 testpmd> flow_director_mask 0 vlan 0xefff \
1763 src_mask 255.255.255.255 \
1764 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
1765 dst_mask 255.255.255.255 \
1766 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
1768 flow_director_flex_mask
1769 ~~~~~~~~~~~~~~~~~~~~~~~
1771 set masks of flow director's flexible payload based on certain flow type::
1773 testpmd> flow_director_flex_mask (port_id) \
1774 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1775 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
1776 l2_payload|all) (mask)
1778 Example, to set flow director's flex mask for all flow type on port 0::
1780 testpmd> flow_director_flex_mask 0 flow all \
1781 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
1784 flow_director_flex_payload
1785 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1787 Configure flexible payload selection::
1789 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
1791 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
1793 testpmd> flow_director_flex_payload 0 l4 \
1794 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
1796 get_sym_hash_ena_per_port
1797 ~~~~~~~~~~~~~~~~~~~~~~~~~
1799 Get symmetric hash enable configuration per port::
1801 get_sym_hash_ena_per_port (port_id)
1803 For example, to get symmetric hash enable configuration of port 1::
1805 testpmd> get_sym_hash_ena_per_port 1
1807 set_sym_hash_ena_per_port
1808 ~~~~~~~~~~~~~~~~~~~~~~~~~
1810 Set symmetric hash enable configuration per port to enable or disable::
1812 set_sym_hash_ena_per_port (port_id) (enable|disable)
1814 For example, to set symmetric hash enable configuration of port 1 to enable::
1816 testpmd> set_sym_hash_ena_per_port 1 enable
1818 get_hash_global_config
1819 ~~~~~~~~~~~~~~~~~~~~~~
1821 Get the global configurations of hash filters::
1823 get_hash_global_config (port_id)
1825 For example, to get the global configurations of hash filters of port 1::
1827 testpmd> get_hash_global_config 1
1829 set_hash_global_config
1830 ~~~~~~~~~~~~~~~~~~~~~~
1832 Set the global configurations of hash filters::
1834 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
1835 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
1836 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \
1839 For example, to enable simple_xor for flow type of ipv6 on port 2::
1841 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
1846 Set the input set for hash::
1848 set_hash_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1849 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
1850 l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
1851 ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
1852 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
1853 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
1854 fld-8th|none) (select|add)
1856 For example, to add source IP to hash input set for flow type of ipv4 on port 0::
1858 testpmd> set_hash_input_set 0 ipv4 src-ipv4 add
1863 Set the input set for Fdir::
1865 set_fdir_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1866 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload)
1867 (src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|udp-src-port|udp-dst-port| \
1868 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
1869 fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th|fld-8th|none) \
1872 For example to add source IP to FD input set for flow type of ipv4 on port 0::
1874 testpmd> set_fdir_input_set 0 ipv4 src-ipv4 add
1879 Set different GRE key length for input set::
1881 global_config (port_id) gre-key-len (number in bytes)
1883 For example to set GRE key length for input set to 4 bytes on port 0::
1885 testpmd> global_config 0 gre-key-len 4