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 flowdir : Flow Director filter help.
75 help registers : Reading and setting port registers.
76 help filters : Filters configuration help.
77 help all : All of the above sections.
85 Start packet forwarding with current configuration:
92 Start packet forwarding with current configuration after sending one burst of packets:
99 Stop packet forwarding, and display accumulated statistics:
113 The functions in the following sections are used to display information about the
114 testpmd configuration or the NIC status.
119 Display information for a given port or all ports:
121 show port (info|stats|fdir|stat_qmap) (port_id|all)
123 The available information categories are:
125 info : General port information such as MAC address.
127 stats : RX/TX statistics.
129 fdir : Flow Director information and statistics.
131 stat_qmap : Queue statistics mapping.
135 .. code-block:: console
137 testpmd> show port info 0
139 ********************* Infos for port 0 *********************
141 MAC address: XX:XX:XX:XX:XX:XX
143 Link speed: 10000 Mbps
144 Link duplex: full-duplex
145 Promiscuous mode: enabled
146 Allmulticast mode: disabled
147 Maximum number of MAC addresses: 127
156 Display the rss redirection table entry indicated by masks on port X:
158 show port (port_id) rss reta (size) (mask0, mask1...)
160 size is used to indicate the hardware supported reta size
165 Display the RSS hash functions and RSS hash key of port (port_id).
167 show port (port_id) rss-hash [key] clear port
168 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
170 Clear the port statistics for a given port or for all ports:
172 clear port (info|stats|fdir|stat_qmap) (port_id|all)
176 .. code-block:: console
178 testpmd> clear port stats all
183 Displays the configuration of the application.
184 The configuration comes from the command-line, the runtime or the application defaults:
186 show config (rxtx|cores|fwd)
188 The available information categories are:
190 rxtx : RX/TX configuration items.
192 cores : List of forwarding cores.
194 fwd : Packet forwarding configuration.
198 .. code-block:: console
200 testpmd> show config rxtx
202 io packet forwarding - CRC stripping disabled - packets/burst=16
203 nb forwarding cores=2 - nb forwarding ports=1
204 RX queues=1 - RX desc=128 - RX free threshold=0
205 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
206 TX queues=1 - TX desc=512 - TX free threshold=0
207 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
208 TX RS bit threshold=0 - TXQ flags=0x0
213 Display an RX descriptor for a port RX queue:
215 read rxd (port_id) (queue_id) (rxd_id)
219 .. code-block:: console
221 testpmd> read rxd 0 0 4
222 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
227 Display a TX descriptor for a port TX queue:
229 read txd (port_id) (queue_id) (txd_id)
233 .. code-block:: console
235 testpmd> read txd 0 0 4
236 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
238 Configuration Functions
239 -----------------------
241 The testpmd application can be configured from the runtime as well as from the command-line.
243 This section details the available configuration functions that are available.
247 Configuration changes only become active when forwarding is started/restarted.
252 Reset forwarding to the default configuration:
259 Set the debug verbosity level:
263 Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
268 Set the number of ports used by the application:
272 This is equivalent to the --nb-ports command-line option.
277 Set the number of cores used by the application:
281 This is equivalent to the --nb-cores command-line option.
285 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
290 Set the forwarding cores hexadecimal mask:
294 This is equivalent to the --coremask command-line option.
298 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
303 Set the forwarding ports hexadecimal mask:
307 This is equivalent to the --portmask command-line option.
312 Set number of packets per burst:
316 This is equivalent to the --burst command-line option.
318 In mac_retry forwarding mode, the transmit delay time and number of retries can also be set.
320 set burst tx delay (micrseconds) retry (num)
325 Set the length of each segment of the TX-ONLY packets:
329 Where x[,y]* represents a CSV list of values, without white space.
334 Set the list of forwarding cores:
336 set corelist (x[,y]*)
338 For example, to change the forwarding cores:
340 .. code-block:: console
342 testpmd> set corelist 3,1
343 testpmd> show config fwd
345 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
346 Logical Core 3 (socket 0) forwards packets on 1 streams:
347 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
348 Logical Core 1 (socket 0) forwards packets on 1 streams:
349 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
353 The cores are used in the same order as specified on the command line.
358 Set the list of forwarding ports:
360 set portlist (x[,y]*)
362 For example, to change the port forwarding:
364 .. code-block:: console
366 testpmd> set portlist 0,2,1,3
367 testpmd> show config fwd
369 io packet forwarding - ports=4 - cores=1 - streams=4
370 Logical Core 3 (socket 0) forwards packets on 4 streams:
371 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
372 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
373 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
374 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
379 Set the VLAN strip on a port:
381 vlan set strip (on|off) (port_id)
386 Set the VLAN strip for a queue on a port:
388 vlan set stripq (on|off) (port_id,queue_id)
393 Set the VLAN filter on a port:
395 vlan set filter (on|off) (port_id)
400 Set the VLAN QinQ (extended queue in queue) on for a port:
402 vlan set qinq (on|off) (port_id)
407 Set the outer VLAN TPID for packet filtering on a port:
409 vlan set tpid (value) (port_id)
413 TPID value must be a 16-bit number (value <= 65536).
418 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID:
420 rx_vlan add (vlan_id|all) (port_id)
424 VLAN filter must be set on that port. VLAN ID < 4096.
429 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID:
431 rx_vlan rm (vlan_id|all) (port_id)
436 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID:
438 rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
443 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID:
445 rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
450 Set the outer VLAN TPID for packet filtering on a port:
452 rx_vlan set tpid (value) (port_id)
457 Add a tunnel filter on a port:
459 tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
460 (tunnel_type) (filter_type) (tenant_id) (queue_id)
465 Remove a tunnel filter on a port:
467 tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
468 (tunnel_type) (filter_type) (tenant_id) (queue_id)
473 Add an UDP port for VXLAN packet filter on a port:
475 rx_vxlan_port add (udp_port) (port_id)
480 Remove an UDP port for VXLAN packet filter on a port:
482 rx_vxlan_port rm (udp_port) (port_id)
487 Set hardware insertion of VLAN ID in packets sent on a port:
489 tx_vlan set (vlan_id) (port_id)
494 Set port based hardware insertion of VLAN ID in pacekts sent on a port:
496 tx_vlan set pvid (port_id) (vlan_id) (on|off)
501 Disable hardware insertion of a VLAN header in packets sent on a port:
503 tx_vlan reset (port_id)
508 Select hardware or software calculation of the checksum when
509 transmitting a packet using the csum forward engine:
511 tx_cksum set (ip|udp|tcp|sctp|vxlan)
513 ip|udp|tcp|sctp always concern the inner layer.
514 vxlan concerns the outer IP and UDP layer (in case the packet
515 is recognized as a vxlan packet by the forward engine)
519 Check the NIC Datasheet for hardware limits.
524 Display tx checksum offload configuration:
526 tx_checksum show (port_id)
531 Enable TCP Segmentation Offload in csum forward engine:
533 tso set (segsize) (port_id)
536 Please check the NIC datasheet for HW limits
541 Display the status of TCP Segmentation Offload:
548 Set the packet forwarding mode:
550 set fwd (io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho)
552 The available information categories are:
554 * io: forwards packets "as-is" in I/O mode.
555 This is the fastest possible forwarding operation as it does not access packets data.
556 This is the default mode.
558 * mac: changes the source and the destination Ethernet addresses of packets before forwarding them.
560 * mac_retry: same as "mac" forwarding mode, but includes retries if the destination queue is full.
562 * macswap: MAC swap forwarding mode.
563 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
565 * flowgen: multi-flow generation mode.
566 Originates a bunch of flows (varying destination IP addresses), and terminate receive traffic.
568 * rxonly: receives packets but doesn't transmit them.
570 * txonly: generates and transmits packets without receiving any.
572 * csum: changes the checksum field with HW or SW methods depending on the offload flags on the packet.
574 * icmpecho: receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
579 .. code-block:: console
581 testpmd> set fwd rxonly
583 Set rxonly packet forwarding mode
588 Add an alternative MAC address to a port:
590 mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
595 Remove a MAC address from a port:
597 mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
602 Add an alternative MAC address for a VF to a port:
604 mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
609 Set the unicast hash filter(s) on/off for a port X:
611 set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
616 Set the promiscuous mode on for a port or for all ports.
617 In promiscuous mode packets are not dropped if they aren't for the specified MAC address:
619 set promisc (port_id|all) (on|off)
624 Set the allmulti mode for a port or for all ports:
626 set allmulti (port_id|all) (on|off)
628 Same as the ifconfig (8) option. Controls how multicast packets are handled.
633 Set the link flow control parameter on a port:
635 set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
636 (pause_time) (send_xon) (port_id)
640 high_water (integer): High threshold value to trigger XOFF.
642 low_water (integer) : Low threshold value to trigger XON.
644 pause_time (integer): Pause quota in the Pause frame.
646 send_xon (0/1) : Send XON frame.
648 mac_ctrl_frame_fwd : Enable receiving MAC control frames
653 Set the priority flow control parameter on a port:
655 set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ (pause_time) (priority) (port_id)
659 priority (0-7): VLAN User Priority.
664 Set statistics mapping (qmapping 0..15) for RX/TX queue on port:
666 set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
668 For example, to set rx queue 2 on port 0 to mapping 5:
670 .. code-block:: console
672 testpmd>set stat_qmap rx 0 2 5
674 set port - rx/tx(for VF)
675 ~~~~~~~~~~~~~~~~~~~~~~~~
677 Set VF receive/transmit from a port:
679 set port (port_id) vf (vf_id) (rx|tx) (on|off)
681 set port - mac address filter (for VF)
682 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
684 Add/Remove unicast or multicast MAC addr filter for a VF:
686 set port (port_id) vf (vf_id) (mac_addr)
687 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
689 set port - rx mode(for VF)
690 ~~~~~~~~~~~~~~~~~~~~~~~~~~
692 Set the VF receive mode of a port:
694 set port (port_id) vf (vf_id) rxmode (AUPE|ROPE|BAM|MPE) (on|off)
696 The available receive modes are:
698 * AUPE: accepts untagged VLAN.
700 * ROPE: accepts unicast hash.
702 * BAM: accepts broadcast packets
704 * MPE: accepts all multicast packets
706 set port - tx_rate (for Queue)
707 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
709 Set TX rate limitation for queue of a port ID:
711 set port (port_id) queue (queue_id) rate (rate_value)
713 set port - tx_rate (for VF)
714 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
716 Set TX rate limitation for queues in VF of a port ID:
718 set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
720 set port - mirror rule
721 ~~~~~~~~~~~~~~~~~~~~~~
723 Set port or vlan type mirror rule for a port.
725 set port (port_id) mirror-rule (rule_id) (pool-mirror|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
727 For example to enable mirror traffic with vlan 0,1 to pool 0:
729 .. code-block:: console
731 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
733 reset port - mirror rule
734 ~~~~~~~~~~~~~~~~~~~~~~~~
736 Reset a mirror rule for a port.
738 reset port (port_id) mirror-rule (rule_id)
743 Flush (default) or don't flush RX streams before forwarding.
744 Mainly used with PCAP drivers to avoid the default behavior of flushing the first 512 packets on RX streams.
751 Set the bypass mode for the lowest port on bypass enabled NIC.
753 set bypass mode (normal|bypass|isolate) (port_id)
758 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled NIC where:
760 * timeout: enable bypass after watchdog timeout.
762 * os_on: enable bypass when OS/board is powered on.
764 * os_off: enable bypass when OS/board is powered off.
766 * power_on: enable bypass when power supply is turned on.
768 * power_off: enable bypass when power supply is turned off.
770 set bypass event (timeout|os_on|os_off|power_on|power_off) mode (normal|bypass|isolate) (port_id)
775 Set the bypass watchdog timeout to 'n' seconds where 0 = instant.
777 set bypass timeout (0|1.5|2|3|4|8|16|32)
782 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC.
784 show bypass config (port_id)
789 Set link up for a port.
791 set link-up port (port id)
796 Set link down for a port.
798 set link-down port (port id)
803 The following sections show functions for configuring ports.
807 Port configuration changes only become active when forwarding is started/restarted.
812 Start all ports or a specific port:
814 port start (port_id|all)
819 Stop all ports or a specific port:
821 port stop (port_id|all)
826 Close all ports or a specific port:
828 port close (port_id|all)
830 port start/stop queue
831 ~~~~~~~~~~~~~~~~~~~~~
833 Start/stop a rx/tx queue on a specific port:
835 port (port_id) (rxq|txq) (queue_id) (start|stop)
837 Only take effect when port is started.
842 Set the speed and duplex mode for all ports or a specific port:
844 port config (port_id|all) speed (10|100|1000|10000|auto) duplex (half|full|auto)
846 port config - queues/descriptors
847 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
849 Set number of queues/descriptors for rxq, txq, rxd and txd:
851 port config all (rxq|txq|rxd|txd) (value)
853 This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.
855 port config - max-pkt-len
856 ~~~~~~~~~~~~~~~~~~~~~~~~~
858 Set the maximum packet length:
860 port config all max-pkt-len (value)
862 This is equivalent to the --max-pkt-len command-line option.
864 port config - CRC Strip
865 ~~~~~~~~~~~~~~~~~~~~~~~
867 Set hardware CRC stripping on or off for all ports:
869 port config all crc-strip (on|off)
871 CRC stripping is off by default.
873 The on option is equivalent to the --crc-strip command-line option.
875 port config - RX Checksum
876 ~~~~~~~~~~~~~~~~~~~~~~~~~
878 Set hardware RX checksum offload to on or off for all ports:
880 port config all rx-cksum (on|off)
882 Checksum offload is off by default.
884 The on option is equivalent to the --enable-rx-cksum command-line option.
889 Set hardware VLAN on or off for all ports:
891 port config all hw-vlan (on|off)
893 Hardware VLAN is on by default.
895 The off option is equivalent to the --disable-hw-vlan command-line option.
897 port config - Drop Packets
898 ~~~~~~~~~~~~~~~~~~~~~~~~~~
900 Set packet drop for packets with no descriptors on or off for all ports:
902 port config all drop-en (on|off)
904 Packet dropping for packets with no descriptors is off by default.
906 The on option is equivalent to the --enable-drop-en command-line option.
911 Set the RSS (Receive Side Scaling) mode on or off:
913 port config all rss (ip|udp|none)
915 RSS is on by default.
917 The off option is equivalent to the --disable-rss command-line option.
919 port config - RSS Reta
920 ~~~~~~~~~~~~~~~~~~~~~~
922 Set the RSS (Receive Side Scaling) redirection table:
924 port config all rss reta (hash,queue)[,(hash,queue)]
929 Set the DCB mode for an individual port:
931 port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
933 The traffic class should be 4 or 8.
938 Set the number of packets per burst:
940 port config all burst (value)
942 This is equivalent to the --burst command-line option.
944 port config - Threshold
945 ~~~~~~~~~~~~~~~~~~~~~~~
947 Set thresholds for TX/RX queues:
949 port config all (threshold) (value)
951 Where the threshold type can be:
953 * txpt: Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
955 * txht: Set the host threshold register of the TX rings, 0 <= value <= 255.
957 * txwt: Set the write-back threshold register of the TX rings, 0 <= value <= 255.
959 * rxpt: Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
961 * rxht: Set the host threshold register of the RX rings, 0 <= value <= 255.
963 * rxwt: Set the write-back threshold register of the RX rings, 0 <= value <= 255.
965 * txfreet: Set the transmit free threshold of the TX rings, 0 <= value <= txd.
967 * rxfreet: Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
969 * txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
970 These threshold options are also available from the command-line.
972 Flow Director Functions
973 -----------------------
975 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
977 Two types of filtering are supported which are referred to as Perfect Match and Signature filters:
979 * Perfect match filters.
980 The hardware checks a match between the masked fields of the received packets and the programmed filters.
983 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
985 The Flow Director filters can match the following fields in a packet:
987 * Source IP and destination IP addresses.
989 * Source port and destination port numbers (for UDP and TCP packets).
991 * IPv4/IPv6 and UDP/ TCP/SCTP protocol match.
995 * Flexible 2-byte tuple match anywhere in the first 64 bytes of the packet.
997 The Flow Director can also mask out parts of all of these fields so that filters are only applied to certain fields
998 or parts of the fields.
999 For example it is possible to mask out sub-nets of IP addresses or to ignore VLAN headers.
1001 In the following sections, several common parameters are used in the Flow Director filters.
1002 These are explained below:
1004 * src: A pair of source address values. The source IP, in IPv4 or IPv6 format, and the source port:
1006 src 192.168.0.1 1024
1008 src 2001:DB8:85A3:0:0:8A2E:370:7000 1024
1010 * dst: A pair of destination address values. The destination IP, in IPv4 or IPv6 format, and the destination port.
1012 * flexbytes: A 2-byte tuple to be matched within the first 64 bytes of a packet.
1014 The offset where the match occurs is set by the --pkt-filter-flexbytes-offset command-line parameter
1015 and is counted from the first byte of the destination Ethernet MAC address.
1016 The default offset is 0xC bytes, which is the "Type" word in the MAC header.
1017 Typically, the flexbyte value is set to 0x0800 to match the IPv4 MAC type or 0x86DD to match IPv6.
1018 These values change when a VLAN tag is added.
1020 * vlan: The VLAN header to match in the packet.
1022 * queue: The index of the RX queue to route matched packets to.
1024 * soft: The 16-bit value in the MBUF flow director ID field for RX packets matching the filter.
1026 add_signature_filter
1027 ~~~~~~~~~~~~~~~~~~~~
1029 Add a signature filter:
1031 # Command is displayed on several lines for clarity.
1033 add_signature_filter (port_id) (ip|udp|tcp|sctp)
1035 src (src_ip_address) (src_port)
1037 dst (dst_ip_address) (dst_port)
1039 flexbytes (flexbytes_values)
1041 vlan (vlan_id) queue (queue_id)
1043 upd_signature_filter
1044 ~~~~~~~~~~~~~~~~~~~~
1046 Update a signature filter:
1048 # Command is displayed on several lines for clarity.
1050 upd_signature_filter (port_id) (ip|udp|tcp|sctp)
1052 src (src_ip_address) (src_port)
1054 dst (dst_ip_address) (dst_port)
1056 flexbytes (flexbytes_values)
1058 vlan (vlan_id) queue (queue_id)
1063 Remove a signature filter:
1065 # Command is displayed on several lines for clarity.
1067 rm_signature_filter (port_id) (ip|udp|tcp|sctp)
1069 src (src_ip_address) (src_port)
1071 dst (dst_ip_address) (dst_port)
1073 flexbytes (flexbytes_values)
1080 Add a perfect filter:
1082 # Command is displayed on several lines for clarity.
1084 add_perfect_filter (port_id) (ip|udp|tcp|sctp)
1086 src (src_ip_address) (src_port)
1088 dst (dst_ip_address) (dst_port)
1090 flexbytes (flexbytes_values)
1092 vlan (vlan_id) queue (queue_id) soft (soft_id)
1097 Update a perfect filter:
1099 # Command is displayed on several lines for clarity.
1101 upd_perfect_filter (port_id) (ip|udp|tcp|sctp)
1103 src (src_ip_address) (src_port)
1105 dst (dst_ip_address) (dst_port)
1107 flexbytes (flexbytes_values)
1109 vlan (vlan_id) queue (queue_id)
1114 Remove a perfect filter:
1116 rm_perfect_filter (port_id) (ip|udp|tcp|sctp)
1118 src (src_ip_address) (src_port)
1120 dst (dst_ip_address) (dst_port)
1122 flexbytes (flexbytes_values)
1124 vlan (vlan_id) soft (soft_id)
1129 Set IPv4 filter masks:
1131 # Command is displayed on several lines for clarity.
1133 set_masks_filter (port_id) only_ip_flow (0|1)
1135 src_mask (ip_src_mask) (src_port_mask)
1137 dst_mask (ip_dst_mask) (dst_port_mask)
1139 flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
1141 set_ipv6_masks_filter
1142 ~~~~~~~~~~~~~~~~~~~~~
1144 Set IPv6 filter masks:
1146 # Command is displayed on several lines for clarity.
1148 set_ipv6_masks_filter (port_id) only_ip_flow (0|1)
1150 src_mask (ip_src_mask) (src_port_mask)
1152 dst_mask (ip_dst_mask) (dst_port_mask)
1154 flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
1158 Link Bonding Functions
1159 ----------------------
1161 The Link Bonding functions make it possible to dynamically create and
1162 manage link bonding devices from within testpmd interactive prompt.
1164 create bonded device
1165 ~~~~~~~~~~~~~~~~~~~~
1167 Create a new bonding device:
1169 create bonded device (mode) (socket)
1171 For example, to create a bonded device in mode 1 on socket 0.
1173 .. code-block:: console
1175 testpmd> create bonded 1 0
1176 created new bonded device (port X)
1181 Adds Ethernet device to a Link Bonding device:
1183 add bonding slave (slave id) (port id)
1185 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10).
1187 .. code-block:: console
1189 testpmd> add bonding slave 6 10
1192 remove bonding slave
1193 ~~~~~~~~~~~~~~~~~~~~
1195 Removes an Ethernet slave device from a Link Bonding device:
1197 remove bonding slave (slave id) (port id)
1199 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10).
1201 .. code-block:: console
1203 testpmd> remove bonding slave 6 10
1208 Set the Link Bonding mode of a Link Bonding device:
1210 set bonding mode (value) (port id)
1212 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3).
1214 .. code-block:: console
1216 testpmd> set bonding mode 3 10
1221 Set an Ethernet slave device as the primary device on a Link Bonding device:
1223 set bonding primary (slave id) (port id)
1225 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10).
1227 .. code-block:: console
1229 testpmd> set bonding primary 6 10
1234 Set the MAC address of a Link Bonding device:
1236 set bonding mac (port id) (mac)
1238 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01
1240 .. code-block:: console
1242 testpmd> set bonding mac 10 00:00:00:00:00:01
1244 set bonding xmit_balance_policy
1245 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1247 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:
1249 set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1251 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports )
1253 .. code-block:: console
1255 testpmd> set bonding xmit_balance_policy 10 l34
1258 set bonding mon_period
1259 ~~~~~~~~~~~~~~~~~~~~~~
1261 Set the link status monitoring polling period in milliseconds for a bonding devicie.
1263 This adds support for PMD slave devices which do not support link status interrupts.
1264 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1265 link status ISR will be queried every polling interval to check if their link status has changed.
1267 set bonding mon_period (port_id) (value)
1269 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms
1271 .. code-block:: console
1273 testpmd> set bonding mon_period 5 150
1279 Show the current configuration of a Link Bonding device:
1281 show bonding config (port id)
1284 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1285 in balance mode with a transmission policy of layer 2+3.
1287 .. code-block:: console
1289 testpmd> show bonding config 9
1291 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1293 Active Slaves (3): [1 3 4]
1299 The Register functions can be used to read from and write to registers on the network card referenced by a port number.
1300 This is mainly useful for debugging purposes.
1301 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1302 and fields that can be accessed.
1307 Display the value of a port register:
1309 read reg (port_id) (address)
1311 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel® 82599 10 GbE Controller:
1313 .. code-block:: console
1315 testpmd> read reg 0 0xEE00
1316 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1321 Display a port register bit field:
1323 read regfield (port_id) (address) (bit_x) (bit_y)
1325 For example, reading the lowest two bits from the register in the example above:
1327 .. code-block:: console
1329 testpmd> read regfield 0 0xEE00 0 1
1330 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1335 Display a single port register bit:
1337 read regbit (port_id) (address) (bit_x)
1339 For example, reading the lowest bit from the register in the example above:
1341 .. code-block:: console
1343 testpmd> read regbit 0 0xEE00 0
1344 port 0 PCI register at offset 0xEE00: bit 0=1
1349 Set the value of a port register:
1351 write reg (port_id) (address) (value)
1353 For example, to clear a register:
1355 .. code-block:: console
1357 testpmd> write reg 0 0xEE00 0x0
1358 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1363 Set bit field of a port register:
1365 write regfield (port_id) (address) (bit_x) (bit_y) (value)
1367 For example, writing to the register cleared in the example above:
1369 .. code-block:: console
1371 testpmd> write regfield 0 0xEE00 0 1 2
1372 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1377 Set single bit value of a port register:
1379 write regbit (port_id) (address) (bit_x) (value)
1381 For example, to set the high bit in the register from the example above:
1383 .. code-block:: console
1385 testpmd> write regbit 0 0xEE00 31 1
1386 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
1391 This section details the available filter functions that are available.
1393 add_ethertype_filter
1394 ~~~~~~~~~~~~~~~~~~~~
1396 Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
1398 add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx)
1400 The available information parameters are:
1402 * port_id: the port which the Ethertype filter assigned on.
1404 * eth_value: the EtherType value want to match,
1405 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
1407 * enable: user priority participates in the match.
1409 * disable: user priority doesn't participate in the match.
1411 * pri_value: user priority value that want to match.
1413 * queue_id : The receive queue associated with this EtherType filter
1415 * index: the index of this EtherType filter
1419 .. code-block:: console
1421 testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
1422 Assign ARP packet to receive queue 3
1424 remove_ethertype_filter
1425 ~~~~~~~~~~~~~~~~~~~~~~~
1427 Remove a L2 Ethertype filter
1429 remove_ethertype_filter (port_id) index (idx)
1431 get_ethertype_filter
1432 ~~~~~~~~~~~~~~~~~~~~
1434 Get and display a L2 Ethertype filter
1436 get_ethertype_filter (port_id) index (idx)
1440 .. code-block:: console
1442 testpmd> get_ethertype_filter 0 index 0
1446 priority: disable, 0
1452 Add a 2-tuple filter,
1453 which identify packets by specific protocol and destination TCP/UDP port
1454 and forwards packets into one of the receive queues.
1456 add_2tuple_filter (port_id) protocol (pro_value) (pro_mask) dst_port (port_value) (port_mask)
1457 flags (flg_value) priority (prio_value) queue (queue_id) index (idx)
1459 The available information parameters are:
1461 * port_id: the port which the 2-tuple filter assigned on.
1463 * pro_value: IP L4 protocol
1465 * pro_mask: protocol participates in the match or not, 1 means participate
1467 * port_value: destination port in L4.
1469 * port_mask: destination port participates in the match or not, 1 means participate.
1471 * flg_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
1473 * prio_value: the priority of this filter.
1475 * queue_id: The receive queue associated with this 2-tuple filter
1477 * index: the index of this 2-tuple filter
1481 .. code-block:: console
1483 testpmd> add_2tuple_filter 0 protocol 0x06 1 dst_port 32 1 flags 0x02 priority 3 queue 3 index 0
1485 remove_2tuple_filter
1486 ~~~~~~~~~~~~~~~~~~~~
1488 Remove a 2-tuple filter
1490 remove_2tuple_filter (port_id) index (idx)
1495 Get and display a 2-tuple filter
1497 get_2tuple_filter (port_id) index (idx)
1501 .. code-block:: console
1503 testpmd> get_2tuple_filter 0 index 0
1506 Destination Port: 0x0020 mask: 1
1507 protocol: 0x06 mask:1 tcp_flags: 0x02
1508 priority: 3 queue: 3
1513 Add a 5-tuple filter,
1514 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
1515 and routes packets into one of the receive queues.
1517 add_5tuple_filter (port_id) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value)
1518 protocol (protocol_value) mask (mask_value) flags (flags_value) priority (prio_value) queue (queue_id) index (idx)
1520 The available information parameters are:
1522 * port_id: the port which the 5-tuple filter assigned on.
1524 * dst_address: destination IP address.
1526 * src_address: source IP address.
1528 * dst_port_value: TCP/UDP destination port.
1530 * src_port_value: TCP/UDP source port.
1532 * protocol_value: L4 protocol.
1534 * mask_value: participates in the match or not by bit for field above, 1b means participate
1536 * flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
1538 * prio_value: the priority of this filter.
1540 * queue_id: The receive queue associated with this 5-tuple filter.
1542 * index: the index of this 5-tuple filter
1546 .. code-block:: console
1548 testpmd> add_5tuple_filter 1 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 index 0
1550 remove_5tuple_filter
1551 ~~~~~~~~~~~~~~~~~~~~
1553 Remove a 5-tuple filter
1555 remove_5tuple_filter (port_id) index (idx)
1560 Get and display a 5-tuple filter
1562 get_5tuple_filter (port_id) index (idx)
1566 .. code-block:: console
1568 testpmd> get_5tuple_filter 1 index 0
1571 Destination IP: 0x02020205 mask: 1
1572 Source IP: 0x02020204 mask: 1
1573 Destination Port: 0x0040 mask: 1
1574 Source Port: 0x0020 mask: 1
1575 protocol: 0x06 mask: 1
1576 priority: 3 flags: 0x00 queue: 3
1581 Add SYN filter, which can forward TCP packets whose *SYN* flag is set into a separate queue.
1583 add_syn_filter (port_id) priority (high|low) queue (queue_id)
1585 The available information parameters are:
1587 * port_id: the port which the SYN filter assigned on.
1589 * high: this SYN filter has higher priority than other filters.
1591 * low: this SYN filter has lower priority than other filters.
1593 * queue_id: The receive queue associated with this SYN filter
1597 .. code-block:: console
1599 testpmd> add_syn_filter 0 priority high queue 3,
1606 remove_syn_filter (port_id)
1611 Get and display SYN filter
1613 get_syn_filter (port_id)
1617 .. code-block:: console
1619 testpmd> get_syn_filter 0
1621 syn filter: on, priority: high, queue: 3
1627 which recognizes any arbitrary pattern within the first 128 bytes of the packet
1628 and routes packets into one of the receive queues.
1630 add_flex_filter (port_id) len (len_value) bytes (bytes_string) mask (mask_value)
1631 priority (prio_value) queue (queue_id) index (idx)
1633 The available information parameters are:
1635 * port_id: the port which the Flex filter assigned on.
1637 * len_value: filter length in byte, no greater than 128.
1639 * bytes_string: a sting in format of octal, means the value the flex filter need to match.
1641 * mask_value: a sting in format of octal, bit 1 means corresponding byte in DWORD participates in the match.
1643 * prio_value: the priority of this filter.
1645 * queue_id: The receive queue associated with this Flex filter.
1647 * index: the index of this Flex filter
1651 .. code-block:: console
1653 testpmd> add_flex_filter 0 len 16 bytes 0x00000000000000000000000008060000 mask 000C priority 3 queue 3 index 0
1655 Assign a packet whose 13th and 14th bytes are 0x0806 to queue 3.
1660 Remove a Flex filter
1662 remove_flex_filter (port_id) index (idx)
1667 Get and display a Flex filter
1669 get_flex_filter (port_id) index (idx)
1673 .. code-block:: console
1675 testpmd> get_flex_filter 0 index 0
1681 dword[]: 0x00000000 00000000 00000000 08060000 00000000 00000000 00000000
1682 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
1683 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
1684 00000000 00000000 00000000 00000000 00000000 00000000 00000000
1687 0b0000000000001100000000000000000000000000000000000000000000000000000000
1688 0000000000000000000000000000000000000000000000000000000000
1690 priority: 3 queue: 3