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.
31 Testpmd Runtime Functions
32 =========================
34 Where the testpmd application is started in interactive mode, (-i|--interactive),
35 it displays a prompt that can be used to start and stop forwarding,
36 configure the application, display statistics, set the Flow Director and other tasks.
38 .. code-block:: console
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 X
54 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap all
55 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap X
56 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap all
62 The testpmd has on-line help for the functions that are available at runtime.
63 These are divided into sections and can be accessed using help, help section or help all:
65 .. code-block:: console
69 Help is available for the following sections:
70 help control : Start and stop forwarding.
71 help display : Displaying port, stats and config information.
72 help config : Configuration information.
73 help ports : Configuring ports.
74 help registers : Reading and setting port registers.
75 help filters : Filters configuration help.
76 help all : All of the above sections.
84 Start packet forwarding with current configuration:
91 Start packet forwarding with current configuration after sending one burst of packets:
98 Stop packet forwarding, and display accumulated statistics:
112 The functions in the following sections are used to display information about the
113 testpmd configuration or the NIC status.
118 Display information for a given port or all ports:
120 show port (info|stats|fdir|stat_qmap) (port_id|all)
122 The available information categories are:
124 info : General port information such as MAC address.
126 stats : RX/TX statistics.
128 fdir : Flow Director information and statistics.
130 stat_qmap : Queue statistics mapping.
134 .. code-block:: console
136 testpmd> show port info 0
138 ********************* Infos for port 0 *********************
140 MAC address: XX:XX:XX:XX:XX:XX
142 memory allocation on the socket: 0
144 Link speed: 40000 Mbps
145 Link duplex: full-duplex
146 Promiscuous mode: enabled
147 Allmulticast mode: disabled
148 Maximum number of MAC addresses: 64
149 Maximum number of MAC addresses of hash filtering: 0
154 Redirection table size: 512
155 Supported flow types:
171 Display the rss redirection table entry indicated by masks on port X:
173 show port (port_id) rss reta (size) (mask0, mask1...)
175 size is used to indicate the hardware supported reta size
180 Display the RSS hash functions and RSS hash key of a port:
182 show port (port_id) rss-hash [key]
187 Clear the port statistics for a given port or for all ports:
189 clear port (info|stats|fdir|stat_qmap) (port_id|all)
193 .. code-block:: console
195 testpmd> clear port stats all
200 Displays the configuration of the application.
201 The configuration comes from the command-line, the runtime or the application defaults:
203 show config (rxtx|cores|fwd)
205 The available information categories are:
207 rxtx : RX/TX configuration items.
209 cores : List of forwarding cores.
211 fwd : Packet forwarding configuration.
215 .. code-block:: console
217 testpmd> show config rxtx
219 io packet forwarding - CRC stripping disabled - packets/burst=16
220 nb forwarding cores=2 - nb forwarding ports=1
221 RX queues=1 - RX desc=128 - RX free threshold=0
222 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
223 TX queues=1 - TX desc=512 - TX free threshold=0
224 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
225 TX RS bit threshold=0 - TXQ flags=0x0
230 Display an RX descriptor for a port RX queue:
232 read rxd (port_id) (queue_id) (rxd_id)
236 .. code-block:: console
238 testpmd> read rxd 0 0 4
239 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
244 Display a TX descriptor for a port TX queue:
246 read txd (port_id) (queue_id) (txd_id)
250 .. code-block:: console
252 testpmd> read txd 0 0 4
253 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
255 Configuration Functions
256 -----------------------
258 The testpmd application can be configured from the runtime as well as from the command-line.
260 This section details the available configuration functions that are available.
264 Configuration changes only become active when forwarding is started/restarted.
269 Reset forwarding to the default configuration:
276 Set the debug verbosity level:
280 Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
285 Set the number of ports used by the application:
289 This is equivalent to the --nb-ports command-line option.
294 Set the number of cores used by the application:
298 This is equivalent to the --nb-cores command-line option.
302 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
307 Set the forwarding cores hexadecimal mask:
311 This is equivalent to the --coremask command-line option.
315 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
320 Set the forwarding ports hexadecimal mask:
324 This is equivalent to the --portmask command-line option.
329 Set number of packets per burst:
333 This is equivalent to the --burst command-line option.
335 In mac_retry forwarding mode, the transmit delay time and number of retries can also be set.
337 set burst tx delay (micrseconds) retry (num)
342 Set the length of each segment of the TX-ONLY packets:
346 Where x[,y]* represents a CSV list of values, without white space.
351 Set the list of forwarding cores:
353 set corelist (x[,y]*)
355 For example, to change the forwarding cores:
357 .. code-block:: console
359 testpmd> set corelist 3,1
360 testpmd> show config fwd
362 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
363 Logical Core 3 (socket 0) forwards packets on 1 streams:
364 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
365 Logical Core 1 (socket 0) forwards packets on 1 streams:
366 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
370 The cores are used in the same order as specified on the command line.
375 Set the list of forwarding ports:
377 set portlist (x[,y]*)
379 For example, to change the port forwarding:
381 .. code-block:: console
383 testpmd> set portlist 0,2,1,3
384 testpmd> show config fwd
386 io packet forwarding - ports=4 - cores=1 - streams=4
387 Logical Core 3 (socket 0) forwards packets on 4 streams:
388 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
389 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
390 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
391 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
396 Set the VLAN strip on a port:
398 vlan set strip (on|off) (port_id)
403 Set the VLAN strip for a queue on a port:
405 vlan set stripq (on|off) (port_id,queue_id)
410 Set the VLAN filter on a port:
412 vlan set filter (on|off) (port_id)
417 Set the VLAN QinQ (extended queue in queue) on for a port:
419 vlan set qinq (on|off) (port_id)
424 Set the outer VLAN TPID for packet filtering on a port:
426 vlan set tpid (value) (port_id)
430 TPID value must be a 16-bit number (value <= 65536).
435 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID:
437 rx_vlan add (vlan_id|all) (port_id)
441 VLAN filter must be set on that port. VLAN ID < 4096.
442 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
443 in VFTA table. This is important if enabling all vlan_ids.
448 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID:
450 rx_vlan rm (vlan_id|all) (port_id)
455 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID:
457 rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
462 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID:
464 rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
469 Set the outer VLAN TPID for packet filtering on a port:
471 rx_vlan set tpid (value) (port_id)
476 Add a tunnel filter on a port:
478 tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
479 (tunnel_type) (filter_type) (tenant_id) (queue_id)
484 Remove a tunnel filter on a port:
486 tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
487 (tunnel_type) (filter_type) (tenant_id) (queue_id)
492 Add an UDP port for VXLAN packet filter on a port:
494 rx_vxlan_port add (udp_port) (port_id)
499 Remove an UDP port for VXLAN packet filter on a port:
501 rx_vxlan_port rm (udp_port) (port_id)
506 Set hardware insertion of VLAN IDs in packets sent on a port:
508 tx_vlan set (port_id) vlan_id[, vlan_id_outer]
510 .. code-block:: console
512 Set a single VLAN ID (5) insertion on port 0.
516 Set double VLAN ID (inner: 2, outer: 3) insertion on port 1.
523 Set port based hardware insertion of VLAN ID in packets sent on a port:
525 tx_vlan set pvid (port_id) (vlan_id) (on|off)
530 Disable hardware insertion of a VLAN header in packets sent on a port:
532 tx_vlan reset (port_id)
537 Select hardware or software calculation of the checksum when
538 transmitting a packet using the csum forward engine:
540 csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
542 - ip|udp|tcp|sctp always concern the inner layer.
544 - outer-ip concerns the outer IP layer (only for IPv4) in case the packet is recognized
545 as a tunnel packet by the forward engine (vxlan, gre and ipip are
546 supported). See "csum parse-tunnel" command.
550 Check the NIC Datasheet for hardware limits.
555 Define how tunneled packets should be handled by the csum forward
558 csum parse-tunnel (on|off) (tx_port_id)
560 If enabled, the csum forward engine will try to recognize supported
561 tunnel headers (vxlan, gre, ipip).
563 If disabled, treat tunnel packets as non-tunneled packets (a inner
564 header is handled as a packet payload).
568 The port argument is the TX port like in the "csum set" command.
572 Consider a packet as following:
573 "eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in"
575 - If parse-tunnel is enabled, the ip|udp|tcp|sctp parameters of "csum
576 set" command are about inner headers (here ipv4_in and tcp_in), and the
577 outer-ip parameter is about outer headers (here ipv4_out).
579 - If parse-tunnel is disabled, the ip|udp|tcp|sctp parameters of "csum
580 set" command are about outer headers, here ipv4_out and udp_out.
585 Display tx checksum offload configuration:
592 Enable TCP Segmentation Offload in csum forward engine:
594 tso set (segsize) (port_id)
598 Check the NIC datasheet for hardware limits
603 Display the status of TCP Segmentation Offload:
610 Set the packet forwarding mode:
612 set fwd (io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho)
614 The available information categories are:
616 * io: forwards packets "as-is" in I/O mode.
617 This is the fastest possible forwarding operation as it does not access packets data.
618 This is the default mode.
620 * mac: changes the source and the destination Ethernet addresses of packets before forwarding them.
622 * mac_retry: same as "mac" forwarding mode, but includes retries if the destination queue is full.
624 * macswap: MAC swap forwarding mode.
625 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
627 * flowgen: multi-flow generation mode.
628 Originates a bunch of flows (varying destination IP addresses), and terminate receive traffic.
630 * rxonly: receives packets but doesn't transmit them.
632 * txonly: generates and transmits packets without receiving any.
634 * csum: changes the checksum field with HW or SW methods depending on the offload flags on the packet.
636 * icmpecho: receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
638 * ieee1588: demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
639 Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``.
643 .. code-block:: console
645 testpmd> set fwd rxonly
647 Set rxonly packet forwarding mode
652 Add an alternative MAC address to a port:
654 mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
659 Remove a MAC address from a port:
661 mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
666 Add an alternative MAC address for a VF to a port:
668 mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
673 Set the unicast hash filter(s) on/off for a port X:
675 set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
680 Set the promiscuous mode on for a port or for all ports.
681 In promiscuous mode packets are not dropped if they aren't for the specified MAC address:
683 set promisc (port_id|all) (on|off)
688 Set the allmulti mode for a port or for all ports:
690 set allmulti (port_id|all) (on|off)
692 Same as the ifconfig (8) option. Controls how multicast packets are handled.
697 Set the link flow control parameter on a port:
699 set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
700 (pause_time) (send_xon) (port_id)
704 high_water (integer): High threshold value to trigger XOFF.
706 low_water (integer) : Low threshold value to trigger XON.
708 pause_time (integer): Pause quota in the Pause frame.
710 send_xon (0/1) : Send XON frame.
712 mac_ctrl_frame_fwd : Enable receiving MAC control frames
717 Set the priority flow control parameter on a port:
719 set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ (pause_time) (priority) (port_id)
723 priority (0-7): VLAN User Priority.
728 Set statistics mapping (qmapping 0..15) for RX/TX queue on port:
730 set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
732 For example, to set rx queue 2 on port 0 to mapping 5:
734 .. code-block:: console
736 testpmd>set stat_qmap rx 0 2 5
738 set port - rx/tx(for VF)
739 ~~~~~~~~~~~~~~~~~~~~~~~~
741 Set VF receive/transmit from a port:
743 set port (port_id) vf (vf_id) (rx|tx) (on|off)
745 set port - mac address filter (for VF)
746 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
748 Add/Remove unicast or multicast MAC addr filter for a VF:
750 set port (port_id) vf (vf_id) (mac_addr)
751 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
753 set port - rx mode(for VF)
754 ~~~~~~~~~~~~~~~~~~~~~~~~~~
756 Set the VF receive mode of a port:
758 set port (port_id) vf (vf_id) rxmode (AUPE|ROPE|BAM|MPE) (on|off)
760 The available receive modes are:
762 * AUPE: accepts untagged VLAN.
764 * ROPE: accepts unicast hash.
766 * BAM: accepts broadcast packets
768 * MPE: accepts all multicast packets
770 set port - tx_rate (for Queue)
771 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
773 Set TX rate limitation for queue of a port ID:
775 set port (port_id) queue (queue_id) rate (rate_value)
777 set port - tx_rate (for VF)
778 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
780 Set TX rate limitation for queues in VF of a port ID:
782 set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
784 set port - mirror rule
785 ~~~~~~~~~~~~~~~~~~~~~~
787 Set pool or vlan type mirror rule for a port:
789 set port (port_id) mirror-rule (rule_id) (pool-mirror-up|pool-mirror-down|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
791 Set link mirror rule for a port:
793 set port (port_id) mirror-rule (rule_id) (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
795 For example to enable mirror traffic with vlan 0,1 to pool 0:
797 .. code-block:: console
799 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
801 reset port - mirror rule
802 ~~~~~~~~~~~~~~~~~~~~~~~~
804 Reset a mirror rule for a port.
806 reset port (port_id) mirror-rule (rule_id)
811 Flush (default) or don't flush RX streams before forwarding.
812 Mainly used with PCAP drivers to avoid the default behavior of flushing the first 512 packets on RX streams.
819 Set the bypass mode for the lowest port on bypass enabled NIC.
821 set bypass mode (normal|bypass|isolate) (port_id)
826 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled NIC where:
828 * timeout: enable bypass after watchdog timeout.
830 * os_on: enable bypass when OS/board is powered on.
832 * os_off: enable bypass when OS/board is powered off.
834 * power_on: enable bypass when power supply is turned on.
836 * power_off: enable bypass when power supply is turned off.
838 set bypass event (timeout|os_on|os_off|power_on|power_off) mode (normal|bypass|isolate) (port_id)
843 Set the bypass watchdog timeout to 'n' seconds where 0 = instant.
845 set bypass timeout (0|1.5|2|3|4|8|16|32)
850 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC.
852 show bypass config (port_id)
857 Set link up for a port.
859 set link-up port (port id)
864 Set link down for a port.
866 set link-down port (port id)
871 The following sections show functions for configuring ports.
875 Port configuration changes only become active when forwarding is started/restarted.
880 Attach a port specified by pci address or virtual device args.
882 To attach a new pci device, the device should be recognized by kernel first.
883 Then it should be moved under DPDK management.
884 Finally the port can be attached to testpmd.
886 For example, to move a pci device using ixgbe under DPDK management:
888 .. code-block:: console
890 ./tools/dpdk_nic_bind.py --status
892 Network devices using DPDK-compatible driver
893 ============================================
896 Network devices using kernel driver
897 ===================================
898 0000:0a:00.0 '82599ES 10-Gigabit SFI/SFP+ Network Connection' if=eth2 drv=ixgbe unused=
900 ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0
901 ./tools/dpdk_nic_bind.py --status
903 Network devices using DPDK-compatible driver
904 ============================================
905 0000:0a:00.0 '82599ES 10-Gigabit SFI/SFP+ Network Connection' drv=igb_uio unused=
907 To attach a port created by virtual device, above steps are not needed.
909 port attach (identifier)
911 For example, to attach a port whose pci address is 0000:0a:00.0.
913 .. code-block:: console
915 testpmd> port attach 0000:0a:00.0
916 Attaching a new port...
917 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
918 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
919 EAL: PCI memory mapped at 0x7f83bfa00000
920 EAL: PCI memory mapped at 0x7f83bfa80000
921 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
922 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
923 Port 0 is attached. Now total ports is 1
927 For example, to attach a port created by pcap PMD.
929 .. code-block:: console
931 testpmd> port attach eth_pcap0
932 Attaching a new port...
933 PMD: Initializing pmd_pcap for eth_pcap0
934 PMD: Creating pcap-backed ethdev on numa socket 0
935 Port 0 is attached. Now total ports is 1
939 In this case, identifier is "eth_pcap0".
940 This identifier format is the same as "--vdev" format of DPDK applications.
942 For example, to re-attach a bonded port which has been previously detached,
943 the mode and slave parameters must be given.
945 .. code-block:: console
947 testpmd> port attach eth_bond_testpmd_0,mode=0,slave=1
948 Attaching a new port...
949 EAL: Initializing pmd_bond for eth_bond_testpmd_0
950 EAL: Create bonded device eth_bond_testpmd_0 on port 0 in mode 0 on socket 0.
951 Port 0 is attached. Now total ports is 1
958 Detach a specific port.
960 Before detaching a port, the port should be closed.
962 port detach (port_id)
964 For example, to detach a pci device port 0.
966 .. code-block:: console
968 testpmd> port close 0
971 testpmd> port detach 0
973 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
974 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
975 EAL: PCI memory unmapped at 0x7f83bfa00000
976 EAL: PCI memory unmapped at 0x7f83bfa80000
980 For example, to detach a virtual device port 0.
982 .. code-block:: console
984 testpmd> port close 0
987 testpmd> port detach 0
989 PMD: Closing pcap ethdev on numa socket 0
990 Port 'eth_pcap0' is detached. Now total ports is 0
994 To remove a pci device completely from the system, first detach the port from testpmd.
995 Then the device should be moved under kernel management.
996 Finally the device can be removed using kernel pci hotplug functionality.
998 For example, to move a pci device under kernel management:
1000 .. code-block:: console
1002 ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0
1003 ./tools/dpdk_nic_bind.py --status
1005 Network devices using DPDK-compatible driver
1006 ============================================
1009 Network devices using kernel driver
1010 ===================================
1011 0000:0a:00.0 '82599ES 10-Gigabit SFI/SFP+ Network Connection' if=eth2 drv=ixgbe unused=igb_uio
1013 To remove a port created by a virtual device, above steps are not needed.
1018 Start all ports or a specific port:
1020 port start (port_id|all)
1025 Stop all ports or a specific port:
1027 port stop (port_id|all)
1032 Close all ports or a specific port:
1034 port close (port_id|all)
1036 port start/stop queue
1037 ~~~~~~~~~~~~~~~~~~~~~
1039 Start/stop a rx/tx queue on a specific port:
1041 port (port_id) (rxq|txq) (queue_id) (start|stop)
1043 Only take effect when port is started.
1048 Set the speed and duplex mode for all ports or a specific port:
1050 port config (port_id|all) speed (10|100|1000|10000|auto) duplex (half|full|auto)
1052 port config - queues/descriptors
1053 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1055 Set number of queues/descriptors for rxq, txq, rxd and txd:
1057 port config all (rxq|txq|rxd|txd) (value)
1059 This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.
1061 port config - max-pkt-len
1062 ~~~~~~~~~~~~~~~~~~~~~~~~~
1064 Set the maximum packet length:
1066 port config all max-pkt-len (value)
1068 This is equivalent to the --max-pkt-len command-line option.
1070 port config - CRC Strip
1071 ~~~~~~~~~~~~~~~~~~~~~~~
1073 Set hardware CRC stripping on or off for all ports:
1075 port config all crc-strip (on|off)
1077 CRC stripping is off by default.
1079 The on option is equivalent to the --crc-strip command-line option.
1081 port config - RX Checksum
1082 ~~~~~~~~~~~~~~~~~~~~~~~~~
1084 Set hardware RX checksum offload to on or off for all ports:
1086 port config all rx-cksum (on|off)
1088 Checksum offload is off by default.
1090 The on option is equivalent to the --enable-rx-cksum command-line option.
1095 Set hardware VLAN on or off for all ports:
1097 port config all hw-vlan (on|off)
1099 Hardware VLAN is on by default.
1101 The off option is equivalent to the --disable-hw-vlan command-line option.
1103 port config - VLAN filter
1104 ~~~~~~~~~~~~~~~~~~~~~~~~~
1106 Set hardware VLAN filter on or off for all ports:
1108 port config all hw-vlan-filter (on|off)
1110 Hardware VLAN filter is on by default.
1112 The off option is equivalent to the --disable-hw-vlan-filter command-line option.
1114 port config - VLAN strip
1115 ~~~~~~~~~~~~~~~~~~~~~~~~
1117 Set hardware VLAN strip on or off for all ports:
1119 port config all hw-vlan-strip (on|off)
1121 Hardware VLAN strip is on by default.
1123 The off option is equivalent to the --disable-hw-vlan-strip command-line option.
1125 port config - VLAN extend
1126 ~~~~~~~~~~~~~~~~~~~~~~~~~
1128 Set hardware VLAN extend on or off for all ports:
1130 port config all hw-vlan-extend (on|off)
1132 Hardware VLAN extend is off by default.
1134 The off option is equivalent to the --disable-hw-vlan-extend command-line option.
1136 port config - Drop Packets
1137 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1139 Set packet drop for packets with no descriptors on or off for all ports:
1141 port config all drop-en (on|off)
1143 Packet dropping for packets with no descriptors is off by default.
1145 The on option is equivalent to the --enable-drop-en command-line option.
1150 Set the RSS (Receive Side Scaling) mode on or off:
1152 port config all rss (all|ip|tcp|udp|sctp|ether|none)
1154 RSS is on by default.
1156 The off option is equivalent to the --disable-rss command-line option.
1158 port config - RSS Reta
1159 ~~~~~~~~~~~~~~~~~~~~~~
1161 Set the RSS (Receive Side Scaling) redirection table:
1163 port config all rss reta (hash,queue)[,(hash,queue)]
1168 Set the DCB mode for an individual port:
1170 port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1172 The traffic class should be 4 or 8.
1177 Set the number of packets per burst:
1179 port config all burst (value)
1181 This is equivalent to the --burst command-line option.
1183 port config - Threshold
1184 ~~~~~~~~~~~~~~~~~~~~~~~
1186 Set thresholds for TX/RX queues:
1188 port config all (threshold) (value)
1190 Where the threshold type can be:
1192 * txpt: Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1194 * txht: Set the host threshold register of the TX rings, 0 <= value <= 255.
1196 * txwt: Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1198 * rxpt: Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1200 * rxht: Set the host threshold register of the RX rings, 0 <= value <= 255.
1202 * rxwt: Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1204 * txfreet: Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1206 * rxfreet: Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1208 * txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1209 These threshold options are also available from the command-line.
1211 Link Bonding Functions
1212 ----------------------
1214 The Link Bonding functions make it possible to dynamically create and
1215 manage link bonding devices from within testpmd interactive prompt.
1217 create bonded device
1218 ~~~~~~~~~~~~~~~~~~~~
1220 Create a new bonding device:
1222 create bonded device (mode) (socket)
1224 For example, to create a bonded device in mode 1 on socket 0.
1226 .. code-block:: console
1228 testpmd> create bonded 1 0
1229 created new bonded device (port X)
1234 Adds Ethernet device to a Link Bonding device:
1236 add bonding slave (slave id) (port id)
1238 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10).
1240 .. code-block:: console
1242 testpmd> add bonding slave 6 10
1245 remove bonding slave
1246 ~~~~~~~~~~~~~~~~~~~~
1248 Removes an Ethernet slave device from a Link Bonding device:
1250 remove bonding slave (slave id) (port id)
1252 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10).
1254 .. code-block:: console
1256 testpmd> remove bonding slave 6 10
1261 Set the Link Bonding mode of a Link Bonding device:
1263 set bonding mode (value) (port id)
1265 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3).
1267 .. code-block:: console
1269 testpmd> set bonding mode 3 10
1274 Set an Ethernet slave device as the primary device on a Link Bonding device:
1276 set bonding primary (slave id) (port id)
1278 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10).
1280 .. code-block:: console
1282 testpmd> set bonding primary 6 10
1287 Set the MAC address of a Link Bonding device:
1289 set bonding mac (port id) (mac)
1291 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01
1293 .. code-block:: console
1295 testpmd> set bonding mac 10 00:00:00:00:00:01
1297 set bonding xmit_balance_policy
1298 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1300 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:
1302 set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1304 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports )
1306 .. code-block:: console
1308 testpmd> set bonding xmit_balance_policy 10 l34
1311 set bonding mon_period
1312 ~~~~~~~~~~~~~~~~~~~~~~
1314 Set the link status monitoring polling period in milliseconds for a bonding device.
1316 This adds support for PMD slave devices which do not support link status interrupts.
1317 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1318 link status ISR will be queried every polling interval to check if their link status has changed.
1320 set bonding mon_period (port_id) (value)
1322 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms
1324 .. code-block:: console
1326 testpmd> set bonding mon_period 5 150
1332 Show the current configuration of a Link Bonding device:
1334 show bonding config (port id)
1337 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1338 in balance mode with a transmission policy of layer 2+3.
1340 .. code-block:: console
1342 testpmd> show bonding config 9
1344 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1346 Active Slaves (3): [1 3 4]
1352 The Register functions can be used to read from and write to registers on the network card referenced by a port number.
1353 This is mainly useful for debugging purposes.
1354 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1355 and fields that can be accessed.
1360 Display the value of a port register:
1362 read reg (port_id) (address)
1364 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel® 82599 10 GbE Controller:
1366 .. code-block:: console
1368 testpmd> read reg 0 0xEE00
1369 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1374 Display a port register bit field:
1376 read regfield (port_id) (address) (bit_x) (bit_y)
1378 For example, reading the lowest two bits from the register in the example above:
1380 .. code-block:: console
1382 testpmd> read regfield 0 0xEE00 0 1
1383 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1388 Display a single port register bit:
1390 read regbit (port_id) (address) (bit_x)
1392 For example, reading the lowest bit from the register in the example above:
1394 .. code-block:: console
1396 testpmd> read regbit 0 0xEE00 0
1397 port 0 PCI register at offset 0xEE00: bit 0=1
1402 Set the value of a port register:
1404 write reg (port_id) (address) (value)
1406 For example, to clear a register:
1408 .. code-block:: console
1410 testpmd> write reg 0 0xEE00 0x0
1411 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1416 Set bit field of a port register:
1418 write regfield (port_id) (address) (bit_x) (bit_y) (value)
1420 For example, writing to the register cleared in the example above:
1422 .. code-block:: console
1424 testpmd> write regfield 0 0xEE00 0 1 2
1425 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1430 Set single bit value of a port register:
1432 write regbit (port_id) (address) (bit_x) (value)
1434 For example, to set the high bit in the register from the example above:
1436 .. code-block:: console
1438 testpmd> write regbit 0 0xEE00 31 1
1439 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
1444 This section details the available filter functions that are available.
1447 ~~~~~~~~~~~~~~~~~~~~
1449 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
1451 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
1453 The available information parameters are:
1455 * port_id: the port which the Ethertype filter assigned on.
1457 * mac_addr: compare destination mac address.
1459 * mac_ignr: ignore destination mac address match.
1461 * mac_address: destination mac address to match.
1463 * ether_type: the EtherType value want to match,
1464 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
1466 * queue_id : The receive queue associated with this EtherType filter. It is meaningless when deleting or dropping.
1468 Example, to add/remove an ethertype filter rule:
1470 .. code-block:: console
1472 testpmd> ethertype_filter 0 add mac_ignr ethertype 0x0806 fwd queue 3
1473 testpmd> ethertype_filter 0 del mac_ignr ethertype 0x0806 fwd queue 3
1478 Add or delete a 2-tuple filter,
1479 which identify packets by specific protocol and destination TCP/UDP port
1480 and forwards packets into one of the receive queues.
1482 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) protocol (protocol_value)
1483 mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id)
1485 The available information parameters are:
1487 * port_id: the port which the 2-tuple filter assigned on.
1489 * dst_port_value: destination port in L4.
1491 * protocol_value: IP L4 protocol.
1493 * mask_value: participates in the match or not by bit for field above, 1b means participate.
1495 * tcp_flags_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
1497 * prio_value: priority of this filter.
1499 * queue_id: The receive queue associated with this 2-tuple filter.
1501 Example, to add/remove an 2tuple filter rule:
1503 .. code-block:: console
1505 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 tcp_flags 0x02 priority 3 queue 3
1506 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 tcp_flags 0x02 priority 3 queue 3
1511 Add or delete a 5-tuple filter,
1512 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
1513 and routes packets into one of the receive queues.
1515 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value)
1516 protocol (protocol_value) mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id)
1518 The available information parameters are:
1520 * port_id: the port which the 5-tuple filter assigned on.
1522 * dst_address: destination IP address.
1524 * src_address: source IP address.
1526 * dst_port_value: TCP/UDP destination port.
1528 * src_port_value: TCP/UDP source port.
1530 * protocol_value: L4 protocol.
1532 * mask_value: participates in the match or not by bit for field above, 1b means participate
1534 * tcp_flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
1536 * prio_value: the priority of this filter.
1538 * queue_id: The receive queue associated with this 5-tuple filter.
1540 Example, to add/remove an 5tuple filter rule:
1542 .. code-block:: console
1544 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 dst_port 64 src_port 32 protocol 0x06 mask 0x1F flags 0x0 priority 3 queue 3
1545 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 dst_port 64 src_port 32 protocol 0x06 mask 0x1F flags 0x0 priority 3 queue 3
1550 By SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue.
1552 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
1554 The available information parameters are:
1556 * port_id: the port which the SYN filter assigned on.
1558 * high: this SYN filter has higher priority than other filters.
1560 * low: this SYN filter has lower priority than other filters.
1562 * queue_id: The receive queue associated with this SYN filter
1566 .. code-block:: console
1568 testpmd> syn_filter 0 add priority high queue 3
1573 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
1574 and routes packets into one of the receive queues.
1576 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value)
1577 mask (mask_value) priority (prio_value) queue (queue_id)
1579 The available information parameters are:
1581 * port_id: the port which the Flex filter is assigned on.
1583 * len_value: filter length in bytes, no greater than 128.
1585 * bytes_value: a string in hexadecimal, means the value the flex filter needs to match.
1587 * mask_value: a string in hexadecimal, bit 1 means corresponding byte participates in the match.
1589 * prio_value: the priority of this filter.
1591 * queue_id: the receive queue associated with this Flex filter.
1595 .. code-block:: console
1597 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000
1598 mask 000C priority 3 queue 3
1600 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000
1601 mask 000C priority 3 queue 3
1603 flow_director_filter
1604 ~~~~~~~~~~~~~~~~~~~~
1606 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
1608 Two types of filtering are supported which are referred to as Perfect Match and Signature filters, the match mode
1609 is set by the --pkt-filter-mode command-line parameter:
1611 * Perfect match filters.
1612 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1614 * Signature filters.
1615 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
1617 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
1618 per flow type and the flexible payload. The Flow Director can also mask out parts of all of these fields so that filters
1619 are only applied to certain fields or parts of the fields.
1621 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
1623 # Commands to add flow director filters of different flow types.
1625 flow_director_filter (port_id) (add|del|update) flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag)
1626 src (src_ip_address) dst (dst_ip_address) vlan (vlan_value) flexbytes (flexbytes_value)
1627 (drop|fwd) queue (queue_id) fd_id (fd_id_value)
1629 flow_director_filter (port_id) (add|del|update) flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp)
1630 src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) vlan (vlan_value)
1631 flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
1633 flow_director_filter (port_id) (add|del|update) flow (ipv4-sctp|ipv6-sctp)
1634 src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) tag (verification_tag)
1635 vlan (vlan_value) flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
1637 flow_director_filter (port_id) (add|del|update) flow l2_payload
1638 ether (ethertype) flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
1640 For example, to add an ipv4-udp flow type filter:
1642 .. code-block:: console
1644 testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
1646 For example, add an ipv4-other flow type filter:
1648 .. code-block:: console
1650 testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
1655 flush all flow director filters on a device:
1657 flush_flow_director (port_id)
1659 Example, to flush all flow director filter on port 0:
1661 .. code-block:: console
1663 testpmd> flush_flow_director 0
1668 set flow director's masks on match input set
1670 flow_director_mask (port_id) vlan (vlan_value) src_mask (ipv4_src) (ipv6_src) (src_port) dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
1672 Example, to set flow director mask on port 0:
1674 .. code-block:: console
1676 testpmd> flow_director_mask 0 vlan 0xefff src_mask 255.255.255.255 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF dst_mask 255.255.255.255 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
1679 flow_director_flex_mask
1680 ~~~~~~~~~~~~~~~~~~~~~~~
1682 set masks of flow director's flexible payload based on certain flow type:
1684 flow_director_flex_mask (port_id) flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|
1685 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|l2_payload|all) (mask)
1687 Example, to set flow director's flex mask for all flow type on port 0:
1689 .. code-block:: console
1691 testpmd> flow_director_flex_mask 0 flow all (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
1694 flow_director_flex_payload
1695 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1697 Configure flexible payload selection.
1699 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
1701 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload.
1703 .. code-block:: console
1705 testpmd> flow_director_flex_payload 0 l4 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
1707 get_sym_hash_ena_per_port
1708 ~~~~~~~~~~~~~~~~~~~~~~~~~
1710 Get symmetric hash enable configuration per port.
1712 get_sym_hash_ena_per_port (port_id)
1714 For example, to get symmetric hash enable configuration of port 1.
1716 .. code-block:: console
1718 testpmd> get_sym_hash_ena_per_port 1
1720 set_sym_hash_ena_per_port
1721 ~~~~~~~~~~~~~~~~~~~~~~~~~
1723 Set symmetric hash enable configuration per port to enable or disable.
1725 set_sym_hash_ena_per_port (port_id) (enable|disable)
1727 For example, to set symmetric hash enable configuration of port 1 to enable.
1729 .. code-block:: console
1731 testpmd> set_sym_hash_ena_per_port 1 enable
1733 get_hash_global_config
1734 ~~~~~~~~~~~~~~~~~~~~~~
1736 Get the global configurations of hash filters.
1738 get_hash_global_config (port_id)
1740 For example, to get the global configurations of hash filters of port 1.
1742 .. code-block:: console
1744 testpmd> get_hash_global_config 1
1746 set_hash_global_config
1747 ~~~~~~~~~~~~~~~~~~~~~~
1749 Set the global configurations of hash filters.
1751 set_hash_global_config (port_id) (toeplitz|simple_xor|default)
1752 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload)
1755 For example, to enable simple_xor for flow type of ipv6 on port 2.
1757 .. code-block:: console
1759 testpmd> set_hash_global_config 2 simple_xor ipv6 enable