2 Copyright(c) 2010-2014 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 ID in packets sent on a port:
508 tx_vlan set (vlan_id) (port_id)
513 Set port based hardware insertion of VLAN ID in pacekts sent on a port:
515 tx_vlan set pvid (port_id) (vlan_id) (on|off)
520 Disable hardware insertion of a VLAN header in packets sent on a port:
522 tx_vlan reset (port_id)
527 Select hardware or software calculation of the checksum when
528 transmitting a packet using the csum forward engine:
530 csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
532 - ip|udp|tcp|sctp always concern the inner layer.
534 - outer-ip concerns the outer IP layer in case the packet is recognized
535 as a tunnel packet by the forward engine (vxlan, gre and ipip are
536 supported). See "csum parse-tunnel" command.
540 Check the NIC Datasheet for hardware limits.
545 Define how tunneled packets should be handled by the csum forward
548 csum parse-tunnel (on|off) (tx_port_id)
550 If enabled, the csum forward engine will try to recognize supported
551 tunnel headers (vxlan, gre, ipip).
553 If disabled, treat tunnel packets as non-tunneled packets (a inner
554 header is handled as a packet payload).
558 The port argument is the TX port like in the "csum set" command.
562 Consider a packet as following:
563 "eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in"
565 - If parse-tunnel is enabled, the ip|udp|tcp|sctp parameters of "csum
566 set" command are about inner headers (here ipv4_in and tcp_in), and the
567 outer-ip parameter is about outer headers (here ipv4_out).
569 - If parse-tunnel is disabled, the ip|udp|tcp|sctp parameters of "csum
570 set" command are about outer headers, here ipv4_out and udp_out.
575 Display tx checksum offload configuration:
582 Enable TCP Segmentation Offload in csum forward engine:
584 tso set (segsize) (port_id)
588 Check the NIC datasheet for hardware limits
593 Display the status of TCP Segmentation Offload:
600 Set the packet forwarding mode:
602 set fwd (io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho)
604 The available information categories are:
606 * io: forwards packets "as-is" in I/O mode.
607 This is the fastest possible forwarding operation as it does not access packets data.
608 This is the default mode.
610 * mac: changes the source and the destination Ethernet addresses of packets before forwarding them.
612 * mac_retry: same as "mac" forwarding mode, but includes retries if the destination queue is full.
614 * macswap: MAC swap forwarding mode.
615 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
617 * flowgen: multi-flow generation mode.
618 Originates a bunch of flows (varying destination IP addresses), and terminate receive traffic.
620 * rxonly: receives packets but doesn't transmit them.
622 * txonly: generates and transmits packets without receiving any.
624 * csum: changes the checksum field with HW or SW methods depending on the offload flags on the packet.
626 * icmpecho: receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
631 .. code-block:: console
633 testpmd> set fwd rxonly
635 Set rxonly packet forwarding mode
640 Add an alternative MAC address to a port:
642 mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
647 Remove a MAC address from a port:
649 mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
654 Add an alternative MAC address for a VF to a port:
656 mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
661 Set the unicast hash filter(s) on/off for a port X:
663 set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
668 Set the promiscuous mode on for a port or for all ports.
669 In promiscuous mode packets are not dropped if they aren't for the specified MAC address:
671 set promisc (port_id|all) (on|off)
676 Set the allmulti mode for a port or for all ports:
678 set allmulti (port_id|all) (on|off)
680 Same as the ifconfig (8) option. Controls how multicast packets are handled.
685 Set the link flow control parameter on a port:
687 set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
688 (pause_time) (send_xon) (port_id)
692 high_water (integer): High threshold value to trigger XOFF.
694 low_water (integer) : Low threshold value to trigger XON.
696 pause_time (integer): Pause quota in the Pause frame.
698 send_xon (0/1) : Send XON frame.
700 mac_ctrl_frame_fwd : Enable receiving MAC control frames
705 Set the priority flow control parameter on a port:
707 set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ (pause_time) (priority) (port_id)
711 priority (0-7): VLAN User Priority.
716 Set statistics mapping (qmapping 0..15) for RX/TX queue on port:
718 set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
720 For example, to set rx queue 2 on port 0 to mapping 5:
722 .. code-block:: console
724 testpmd>set stat_qmap rx 0 2 5
726 set port - rx/tx(for VF)
727 ~~~~~~~~~~~~~~~~~~~~~~~~
729 Set VF receive/transmit from a port:
731 set port (port_id) vf (vf_id) (rx|tx) (on|off)
733 set port - mac address filter (for VF)
734 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
736 Add/Remove unicast or multicast MAC addr filter for a VF:
738 set port (port_id) vf (vf_id) (mac_addr)
739 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
741 set port - rx mode(for VF)
742 ~~~~~~~~~~~~~~~~~~~~~~~~~~
744 Set the VF receive mode of a port:
746 set port (port_id) vf (vf_id) rxmode (AUPE|ROPE|BAM|MPE) (on|off)
748 The available receive modes are:
750 * AUPE: accepts untagged VLAN.
752 * ROPE: accepts unicast hash.
754 * BAM: accepts broadcast packets
756 * MPE: accepts all multicast packets
758 set port - tx_rate (for Queue)
759 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
761 Set TX rate limitation for queue of a port ID:
763 set port (port_id) queue (queue_id) rate (rate_value)
765 set port - tx_rate (for VF)
766 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
768 Set TX rate limitation for queues in VF of a port ID:
770 set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
772 set port - mirror rule
773 ~~~~~~~~~~~~~~~~~~~~~~
775 Set port or vlan type mirror rule for a port.
777 set port (port_id) mirror-rule (rule_id) (pool-mirror|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
779 For example to enable mirror traffic with vlan 0,1 to pool 0:
781 .. code-block:: console
783 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
785 reset port - mirror rule
786 ~~~~~~~~~~~~~~~~~~~~~~~~
788 Reset a mirror rule for a port.
790 reset port (port_id) mirror-rule (rule_id)
795 Flush (default) or don't flush RX streams before forwarding.
796 Mainly used with PCAP drivers to avoid the default behavior of flushing the first 512 packets on RX streams.
803 Set the bypass mode for the lowest port on bypass enabled NIC.
805 set bypass mode (normal|bypass|isolate) (port_id)
810 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled NIC where:
812 * timeout: enable bypass after watchdog timeout.
814 * os_on: enable bypass when OS/board is powered on.
816 * os_off: enable bypass when OS/board is powered off.
818 * power_on: enable bypass when power supply is turned on.
820 * power_off: enable bypass when power supply is turned off.
822 set bypass event (timeout|os_on|os_off|power_on|power_off) mode (normal|bypass|isolate) (port_id)
827 Set the bypass watchdog timeout to 'n' seconds where 0 = instant.
829 set bypass timeout (0|1.5|2|3|4|8|16|32)
834 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC.
836 show bypass config (port_id)
841 Set link up for a port.
843 set link-up port (port id)
848 Set link down for a port.
850 set link-down port (port id)
855 The following sections show functions for configuring ports.
859 Port configuration changes only become active when forwarding is started/restarted.
864 Attach a port specified by pci address or virtual device args.
866 To attach a new pci device, the device should be recognized by kernel first.
867 Then it should be moved under DPDK management.
868 Finally the port can be attached to testpmd.
869 On the other hand, to attach a port created by virtual device, above steps are not needed.
871 port attach (identifier)
873 For example, to attach a port whose pci address is 0000:02:00.0.
875 .. code-block:: console
877 testpmd> port attach 0000:02:00.0
878 Attaching a new port...
880 Port 0 is attached. Now total ports is 1
883 For example, to attach a port created by pcap PMD.
885 .. code-block:: console
887 testpmd> port attach eth_pcap0,iface=eth0
888 Attaching a new port...
890 Port 0 is attached. Now total ports is 1
893 In this case, identifier is "eth_pcap0,iface=eth0".
894 This identifier format is the same as "--vdev" format of DPDK applications.
899 Detach a specific port.
901 Before detaching a port, the port should be closed.
902 Also to remove a pci device completely from the system, first detach the port from testpmd.
903 Then the device should be moved under kernel management.
904 Finally the device can be removed using kernel pci hotplug functionality.
905 On the other hand, to remove a port created by a virtual device, above steps are not needed.
907 port detach (port_id)
909 For example, to detach a port 0.
911 .. code-block:: console
913 testpmd> port detach 0
921 Start all ports or a specific port:
923 port start (port_id|all)
928 Stop all ports or a specific port:
930 port stop (port_id|all)
935 Close all ports or a specific port:
937 port close (port_id|all)
939 port start/stop queue
940 ~~~~~~~~~~~~~~~~~~~~~
942 Start/stop a rx/tx queue on a specific port:
944 port (port_id) (rxq|txq) (queue_id) (start|stop)
946 Only take effect when port is started.
951 Set the speed and duplex mode for all ports or a specific port:
953 port config (port_id|all) speed (10|100|1000|10000|auto) duplex (half|full|auto)
955 port config - queues/descriptors
956 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
958 Set number of queues/descriptors for rxq, txq, rxd and txd:
960 port config all (rxq|txq|rxd|txd) (value)
962 This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.
964 port config - max-pkt-len
965 ~~~~~~~~~~~~~~~~~~~~~~~~~
967 Set the maximum packet length:
969 port config all max-pkt-len (value)
971 This is equivalent to the --max-pkt-len command-line option.
973 port config - CRC Strip
974 ~~~~~~~~~~~~~~~~~~~~~~~
976 Set hardware CRC stripping on or off for all ports:
978 port config all crc-strip (on|off)
980 CRC stripping is off by default.
982 The on option is equivalent to the --crc-strip command-line option.
984 port config - RX Checksum
985 ~~~~~~~~~~~~~~~~~~~~~~~~~
987 Set hardware RX checksum offload to on or off for all ports:
989 port config all rx-cksum (on|off)
991 Checksum offload is off by default.
993 The on option is equivalent to the --enable-rx-cksum command-line option.
998 Set hardware VLAN on or off for all ports:
1000 port config all hw-vlan (on|off)
1002 Hardware VLAN is on by default.
1004 The off option is equivalent to the --disable-hw-vlan command-line option.
1006 port config - VLAN filter
1007 ~~~~~~~~~~~~~~~~~~~~~~~~~
1009 Set hardware VLAN filter on or off for all ports:
1011 port config all hw-vlan-filter (on|off)
1013 Hardware VLAN filter is on by default.
1015 The off option is equivalent to the --disable-hw-vlan-filter command-line option.
1017 port config - VLAN strip
1018 ~~~~~~~~~~~~~~~~~~~~~~~~
1020 Set hardware VLAN strip on or off for all ports:
1022 port config all hw-vlan-strip (on|off)
1024 Hardware VLAN strip is on by default.
1026 The off option is equivalent to the --disable-hw-vlan-strip command-line option.
1028 port config - VLAN extend
1029 ~~~~~~~~~~~~~~~~~~~~~~~~~
1031 Set hardware VLAN extend on or off for all ports:
1033 port config all hw-vlan-extend (on|off)
1035 Hardware VLAN extend is off by default.
1037 The off option is equivalent to the --disable-hw-vlan-extend command-line option.
1039 port config - Drop Packets
1040 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1042 Set packet drop for packets with no descriptors on or off for all ports:
1044 port config all drop-en (on|off)
1046 Packet dropping for packets with no descriptors is off by default.
1048 The on option is equivalent to the --enable-drop-en command-line option.
1053 Set the RSS (Receive Side Scaling) mode on or off:
1055 port config all rss (all|ip|tcp|udp|sctp|ether|none)
1057 RSS is on by default.
1059 The off option is equivalent to the --disable-rss command-line option.
1061 port config - RSS Reta
1062 ~~~~~~~~~~~~~~~~~~~~~~
1064 Set the RSS (Receive Side Scaling) redirection table:
1066 port config all rss reta (hash,queue)[,(hash,queue)]
1071 Set the DCB mode for an individual port:
1073 port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1075 The traffic class should be 4 or 8.
1080 Set the number of packets per burst:
1082 port config all burst (value)
1084 This is equivalent to the --burst command-line option.
1086 port config - Threshold
1087 ~~~~~~~~~~~~~~~~~~~~~~~
1089 Set thresholds for TX/RX queues:
1091 port config all (threshold) (value)
1093 Where the threshold type can be:
1095 * txpt: Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1097 * txht: Set the host threshold register of the TX rings, 0 <= value <= 255.
1099 * txwt: Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1101 * rxpt: Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1103 * rxht: Set the host threshold register of the RX rings, 0 <= value <= 255.
1105 * rxwt: Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1107 * txfreet: Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1109 * rxfreet: Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1111 * txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1112 These threshold options are also available from the command-line.
1114 Link Bonding Functions
1115 ----------------------
1117 The Link Bonding functions make it possible to dynamically create and
1118 manage link bonding devices from within testpmd interactive prompt.
1120 create bonded device
1121 ~~~~~~~~~~~~~~~~~~~~
1123 Create a new bonding device:
1125 create bonded device (mode) (socket)
1127 For example, to create a bonded device in mode 1 on socket 0.
1129 .. code-block:: console
1131 testpmd> create bonded 1 0
1132 created new bonded device (port X)
1137 Adds Ethernet device to a Link Bonding device:
1139 add bonding slave (slave id) (port id)
1141 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10).
1143 .. code-block:: console
1145 testpmd> add bonding slave 6 10
1148 remove bonding slave
1149 ~~~~~~~~~~~~~~~~~~~~
1151 Removes an Ethernet slave device from a Link Bonding device:
1153 remove bonding slave (slave id) (port id)
1155 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10).
1157 .. code-block:: console
1159 testpmd> remove bonding slave 6 10
1164 Set the Link Bonding mode of a Link Bonding device:
1166 set bonding mode (value) (port id)
1168 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3).
1170 .. code-block:: console
1172 testpmd> set bonding mode 3 10
1177 Set an Ethernet slave device as the primary device on a Link Bonding device:
1179 set bonding primary (slave id) (port id)
1181 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10).
1183 .. code-block:: console
1185 testpmd> set bonding primary 6 10
1190 Set the MAC address of a Link Bonding device:
1192 set bonding mac (port id) (mac)
1194 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01
1196 .. code-block:: console
1198 testpmd> set bonding mac 10 00:00:00:00:00:01
1200 set bonding xmit_balance_policy
1201 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1203 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:
1205 set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1207 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports )
1209 .. code-block:: console
1211 testpmd> set bonding xmit_balance_policy 10 l34
1214 set bonding mon_period
1215 ~~~~~~~~~~~~~~~~~~~~~~
1217 Set the link status monitoring polling period in milliseconds for a bonding devicie.
1219 This adds support for PMD slave devices which do not support link status interrupts.
1220 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1221 link status ISR will be queried every polling interval to check if their link status has changed.
1223 set bonding mon_period (port_id) (value)
1225 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms
1227 .. code-block:: console
1229 testpmd> set bonding mon_period 5 150
1235 Show the current configuration of a Link Bonding device:
1237 show bonding config (port id)
1240 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1241 in balance mode with a transmission policy of layer 2+3.
1243 .. code-block:: console
1245 testpmd> show bonding config 9
1247 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1249 Active Slaves (3): [1 3 4]
1255 The Register functions can be used to read from and write to registers on the network card referenced by a port number.
1256 This is mainly useful for debugging purposes.
1257 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1258 and fields that can be accessed.
1263 Display the value of a port register:
1265 read reg (port_id) (address)
1267 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel® 82599 10 GbE Controller:
1269 .. code-block:: console
1271 testpmd> read reg 0 0xEE00
1272 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1277 Display a port register bit field:
1279 read regfield (port_id) (address) (bit_x) (bit_y)
1281 For example, reading the lowest two bits from the register in the example above:
1283 .. code-block:: console
1285 testpmd> read regfield 0 0xEE00 0 1
1286 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1291 Display a single port register bit:
1293 read regbit (port_id) (address) (bit_x)
1295 For example, reading the lowest bit from the register in the example above:
1297 .. code-block:: console
1299 testpmd> read regbit 0 0xEE00 0
1300 port 0 PCI register at offset 0xEE00: bit 0=1
1305 Set the value of a port register:
1307 write reg (port_id) (address) (value)
1309 For example, to clear a register:
1311 .. code-block:: console
1313 testpmd> write reg 0 0xEE00 0x0
1314 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1319 Set bit field of a port register:
1321 write regfield (port_id) (address) (bit_x) (bit_y) (value)
1323 For example, writing to the register cleared in the example above:
1325 .. code-block:: console
1327 testpmd> write regfield 0 0xEE00 0 1 2
1328 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1333 Set single bit value of a port register:
1335 write regbit (port_id) (address) (bit_x) (value)
1337 For example, to set the high bit in the register from the example above:
1339 .. code-block:: console
1341 testpmd> write regbit 0 0xEE00 31 1
1342 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
1347 This section details the available filter functions that are available.
1350 ~~~~~~~~~~~~~~~~~~~~
1352 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
1354 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) ethertype (ether_type) (drop|fwd) queue (queue_id)
1356 The available information parameters are:
1358 * port_id: the port which the Ethertype filter assigned on.
1360 * mac_addr: compare destination mac address.
1362 * mac_ignr: ignore destination mac address match.
1364 * mac_address: destination mac address to match.
1366 * ether_type: the EtherType value want to match,
1367 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
1369 * queue_id : The receive queue associated with this EtherType filter. It is meaningless when deleting or dropping.
1371 Example, to add/remove an ethertype filter rule:
1373 .. code-block:: console
1375 testpmd> ethertype_filter 0 add mac_ignr ethertype 0x0806 fwd queue 3
1376 testpmd> ethertype_filter 0 del mac_ignr ethertype 0x0806 fwd queue 3
1381 Add or delete a 2-tuple filter,
1382 which identify packets by specific protocol and destination TCP/UDP port
1383 and forwards packets into one of the receive queues.
1385 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) protocol (protocol_value)
1386 mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id)
1388 The available information parameters are:
1390 * port_id: the port which the 2-tuple filter assigned on.
1392 * dst_port_value: destination port in L4.
1394 * protocol_value: IP L4 protocol.
1396 * mask_value: participates in the match or not by bit for field above, 1b means participate.
1398 * tcp_flags_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
1400 * prio_value: priority of this filter.
1402 * queue_id: The receive queue associated with this 2-tuple filter.
1404 Example, to add/remove an 2tuple filter rule:
1406 .. code-block:: console
1408 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 tcp_flags 0x02 priority 3 queue 3
1409 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 tcp_flags 0x02 priority 3 queue 3
1414 Add or delete a 5-tuple filter,
1415 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
1416 and routes packets into one of the receive queues.
1418 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value)
1419 protocol (protocol_value) mask (mask_value) tcp_flags (tcp_flags_value) priority (prio_value) queue (queue_id)
1421 The available information parameters are:
1423 * port_id: the port which the 5-tuple filter assigned on.
1425 * dst_address: destination IP address.
1427 * src_address: source IP address.
1429 * dst_port_value: TCP/UDP destination port.
1431 * src_port_value: TCP/UDP source port.
1433 * protocol_value: L4 protocol.
1435 * mask_value: participates in the match or not by bit for field above, 1b means participate
1437 * tcp_flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
1439 * prio_value: the priority of this filter.
1441 * queue_id: The receive queue associated with this 5-tuple filter.
1443 Example, to add/remove an 5tuple filter rule:
1445 .. code-block:: console
1447 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
1448 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
1453 By SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue.
1455 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
1457 The available information parameters are:
1459 * port_id: the port which the SYN filter assigned on.
1461 * high: this SYN filter has higher priority than other filters.
1463 * low: this SYN filter has lower priority than other filters.
1465 * queue_id: The receive queue associated with this SYN filter
1469 .. code-block:: console
1471 testpmd> syn_filter 0 add priority high queue 3
1476 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
1477 and routes packets into one of the receive queues.
1479 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value)
1480 mask (mask_value) priority (prio_value) queue (queue_id)
1482 The available information parameters are:
1484 * port_id: the port which the Flex filter is assigned on.
1486 * len_value: filter length in bytes, no greater than 128.
1488 * bytes_value: a string in hexadecimal, means the value the flex filter needs to match.
1490 * mask_value: a string in hexadecimal, bit 1 means corresponding byte participates in the match.
1492 * prio_value: the priority of this filter.
1494 * queue_id: the receive queue associated with this Flex filter.
1498 .. code-block:: console
1500 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000
1501 mask 000C priority 3 queue 3
1503 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000
1504 mask 000C priority 3 queue 3
1506 flow_director_filter
1507 ~~~~~~~~~~~~~~~~~~~~
1509 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
1511 Two types of filtering are supported which are referred to as Perfect Match and Signature filters, the match mode
1512 is set by the --pkt-filter-mode command-line parameter:
1514 * Perfect match filters.
1515 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1517 * Signature filters.
1518 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
1520 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
1521 per flow type and the flexible payload. The Flow Director can also mask out parts of all of these fields so that filters
1522 are only applied to certain fields or parts of the fields.
1524 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
1526 # Commands to add flow director filters of different flow types.
1528 flow_director_filter (port_id) (add|del|update) flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag)
1529 src (src_ip_address) dst (dst_ip_address) vlan (vlan_value) flexbytes (flexbytes_value)
1530 (drop|fwd) queue (queue_id) fd_id (fd_id_value)
1532 flow_director_filter (port_id) (add|del|update) flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp)
1533 src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) vlan (vlan_value)
1534 flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
1536 flow_director_filter (port_id) (add|del|update) flow (ipv4-sctp|ipv6-sctp)
1537 src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) tag (verification_tag)
1538 vlan (vlan_value) flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
1540 For example, to add an ipv4-udp flow type filter:
1542 .. code-block:: console
1544 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
1546 For example, add an ipv4-other flow type filter:
1548 .. code-block:: console
1550 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
1555 flush all flow director filters on a device:
1557 flush_flow_director (port_id)
1559 Example, to flush all flow director filter on port 0:
1561 .. code-block:: console
1563 testpmd> flush_flow_director 0
1568 set flow director's masks on match input set
1570 flow_director_mask (port_id) vlan (vlan_value) src_mask (ipv4_src) (ipv6_src) (src_port) dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
1572 Example, to set flow director mask on port 0:
1574 .. code-block:: console
1576 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
1579 flow_director_flex_mask
1580 ~~~~~~~~~~~~~~~~~~~~~~~
1582 set masks of flow director's flexible payload based on certain flow type:
1584 flow_director_flex_mask (port_id) flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|
1585 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|all) (mask)
1587 Example, to set flow director's flex mask for all flow type on port 0:
1589 .. code-block:: console
1591 testpmd> flow_director_flex_mask 0 flow all (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
1594 flow_director_flex_payload
1595 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1597 Configure flexible payload selection.
1599 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
1601 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload.
1603 .. code-block:: console
1605 testpmd> flow_director_flex_payload 0 l4 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
1607 get_sym_hash_ena_per_port
1608 ~~~~~~~~~~~~~~~~~~~~~~~~~
1610 Get symmetric hash enable configuration per port.
1612 get_sym_hash_ena_per_port (port_id)
1614 For example, to get symmetric hash enable configuration of port 1.
1616 .. code-block:: console
1618 testpmd> get_sym_hash_ena_per_port 1
1620 set_sym_hash_ena_per_port
1621 ~~~~~~~~~~~~~~~~~~~~~~~~~
1623 Set symmetric hash enable configuration per port to enable or disable.
1625 set_sym_hash_ena_per_port (port_id) (enable|disable)
1627 For example, to set symmetric hash enable configuration of port 1 to enable.
1629 .. code-block:: console
1631 testpmd> set_sym_hash_ena_per_port 1 enable
1633 get_hash_global_config
1634 ~~~~~~~~~~~~~~~~~~~~~~
1636 Get the global configurations of hash filters.
1638 get_hash_global_config (port_id)
1640 For example, to get the global configurations of hash filters of port 1.
1642 .. code-block:: console
1644 testpmd> get_hash_global_config 1
1646 set_hash_global_config
1647 ~~~~~~~~~~~~~~~~~~~~~~
1649 Set the global configurations of hash filters.
1651 set_hash_global_config (port_id) (toeplitz|simple_xor|default)
1652 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload)
1655 For example, to enable simple_xor for flow type of ipv6 on port 2.
1657 .. code-block:: console
1659 testpmd> set_hash_global_config 2 simple_xor ipv6 enable