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 TX rate limitation for queue of a port ID:
452 set port (port_id) queue (queue_id) rate (rate_value)
457 Set TX rate limitation for queues in VF of a port ID:
459 set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
464 Set the outer VLAN TPID for packet filtering on a port:
466 rx_vlan set tpid (value) (port_id)
471 Add a tunnel filter on a port:
473 tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
474 (tunnel_type) (filter_type) (tenant_id) (queue_id)
479 Remove a tunnel filter on a port:
481 tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
482 (tunnel_type) (filter_type) (tenant_id) (queue_id)
487 Add an UDP port for VXLAN packet filter on a port:
489 rx_vxlan_port add (udp_port) (port_id)
494 Remove an UDP port for VXLAN packet filter on a port:
496 rx_vxlan_port rm (udp_port) (port_id)
501 Set hardware insertion of VLAN ID in packets sent on a port:
503 tx_vlan set (vlan_id) (port_id)
508 Set port based hardware insertion of VLAN ID in pacekts sent on a port:
510 tx_vlan set pvid (port_id) (vlan_id) (on|off)
515 Disable hardware insertion of a VLAN header in packets sent on a port:
517 tx_vlan reset (port_id)
522 Enable hardware insertion of checksum offload with a 4-bit mask, 0x0 - 0xF, in packets sent on a port:
524 tx_checksum set (mask) (port_id)
526 The bits in the mask are:
528 bit 0 - if set insert ip checksum offload
530 bit 1 - if set insert udp checksum offload
532 bit 2 - if set insert tcp checksum offload
534 bit 3 - if set insert sctp checksum offload
538 Check the NIC Datasheet for hardware limits.
543 Display tx checksum offload configuration:
545 tx_checksum show (port_id)
550 Enable TCP Segmentation Offload in csum forward engine:
552 tso set (segsize) (port_id)
555 Please check the NIC datasheet for HW limits
560 Display the status of TCP Segmentation Offload:
567 Set the packet forwarding mode:
569 set fwd (io|mac|mac_retry|macswap|flowgen|rxonly|txonly|csum|icmpecho)
571 The available information categories are:
573 * io: forwards packets "as-is" in I/O mode.
574 This is the fastest possible forwarding operation as it does not access packets data.
575 This is the default mode.
577 * mac: changes the source and the destination Ethernet addresses of packets before forwarding them.
579 * mac_retry: same as "mac" forwarding mode, but includes retries if the destination queue is full.
581 * macswap: MAC swap forwarding mode.
582 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
584 * flowgen: multi-flow generation mode.
585 Originates a bunch of flows (varying destination IP addresses), and terminate receive traffic.
587 * rxonly: receives packets but doesn't transmit them.
589 * txonly: generates and transmits packets without receiving any.
591 * csum: changes the checksum field with HW or SW methods depending on the offload flags on the packet.
593 * icmpecho: receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
598 .. code-block:: console
600 testpmd> set fwd rxonly
602 Set rxonly packet forwarding mode
607 Add an alternative MAC address to a port:
609 mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
614 Remove a MAC address from a port:
616 mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
621 Add an alternative MAC address for a VF to a port:
623 mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
628 Set the unicast hash filter(s) on/off for a port X:
630 set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
635 Set the promiscuous mode on for a port or for all ports.
636 In promiscuous mode packets are not dropped if they aren't for the specified MAC address:
638 set promisc (port_id|all) (on|off)
643 Set the allmulti mode for a port or for all ports:
645 set allmulti (port_id|all) (on|off)
647 Same as the ifconfig (8) option. Controls how multicast packets are handled.
652 Set the link flow control parameter on a port:
654 set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
655 (pause_time) (send_xon) (port_id)
659 high_water (integer): High threshold value to trigger XOFF.
661 low_water (integer) : Low threshold value to trigger XON.
663 pause_time (integer): Pause quota in the Pause frame.
665 send_xon (0/1) : Send XON frame.
667 mac_ctrl_frame_fwd : Enable receiving MAC control frames
672 Set the priority flow control parameter on a port:
674 set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \ (pause_time) (priority) (port_id)
678 priority (0-7): VLAN User Priority.
683 Set statistics mapping (qmapping 0..15) for RX/TX queue on port:
685 set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
687 For example, to set rx queue 2 on port 0 to mapping 5:
689 .. code-block:: console
691 testpmd>set stat_qmap rx 0 2 5
693 set port - rx/tx(for VF)
694 ~~~~~~~~~~~~~~~~~~~~~~~~
696 Set VF receive/transmit from a port:
698 set port (port_id) vf (vf_id) (rx|tx) (on|off)
700 set port - mac address filter (for VF)
701 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
703 Add/Remove unicast or multicast MAC addr filter for a VF:
705 set port (port_id) vf (vf_id) (mac_addr)
706 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
708 set port - rx mode(for VF)
709 ~~~~~~~~~~~~~~~~~~~~~~~~~~
711 Set the VF receive mode of a port:
713 set port (port_id) vf (vf_id) rxmode (AUPE|ROPE|BAM|MPE) (on|off)
715 The available receive modes are:
717 * AUPE: accepts untagged VLAN.
719 * ROPE: accepts unicast hash.
721 * BAM: accepts broadcast packets
723 * MPE: accepts all multicast packets
725 set port - mirror rule
726 ~~~~~~~~~~~~~~~~~~~~~~
728 Set port or vlan type mirror rule for a port.
730 set port (port_id) mirror-rule (rule_id) (pool-mirror|vlan-mirror) (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
732 For example to enable mirror traffic with vlan 0,1 to pool 0:
734 .. code-block:: console
736 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
738 reset port - mirror rule
739 ~~~~~~~~~~~~~~~~~~~~~~~~
741 Reset a mirror rule for a port.
743 reset port (port_id) mirror-rule (rule_id)
748 Flush (default) or don't flush RX streams before forwarding.
749 Mainly used with PCAP drivers to avoid the default behavior of flushing the first 512 packets on RX streams.
756 Set the bypass mode for the lowest port on bypass enabled NIC.
758 set bypass mode (normal|bypass|isolate) (port_id)
763 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled NIC where:
765 * timeout: enable bypass after watchdog timeout.
767 * os_on: enable bypass when OS/board is powered on.
769 * os_off: enable bypass when OS/board is powered off.
771 * power_on: enable bypass when power supply is turned on.
773 * power_off: enable bypass when power supply is turned off.
775 set bypass event (timeout|os_on|os_off|power_on|power_off) mode (normal|bypass|isolate) (port_id)
780 Set the bypass watchdog timeout to 'n' seconds where 0 = instant.
782 set bypass timeout (0|1.5|2|3|4|8|16|32)
787 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC.
789 show bypass config (port_id)
794 Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
796 add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx)
798 The available information parameters are:
800 * port_id: the port which the Ethertype filter assigned on.
802 * eth_value: the EtherType value want to match,
803 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
805 * enable: user priority participates in the match.
807 * disable: user priority doesn't participate in the match.
809 * pri_value: user priority value that want to match.
811 * queue_id : The receive queue associated with this EtherType filter
813 * index: the index of this EtherType filter
817 .. code-block:: console
819 testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
820 Assign ARP packet to receive queue 3
822 remove_ethertype_filter
823 ~~~~~~~~~~~~~~~~~~~~~~~
825 Remove a L2 Ethertype filter
827 remove_ethertype_filter (port_id) index (idx)
832 Get and display a L2 Ethertype filter
834 get_ethertype_filter (port_id) index (idx)
838 .. code-block:: console
840 testpmd> get_ethertype_filter 0 index 0
850 Add a 2-tuple filter,
851 which identify packets by specific protocol and destination TCP/UDP port
852 and forwards packets into one of the receive queues.
854 add_2tuple_filter (port_id) protocol (pro_value) (pro_mask) dst_port (port_value) (port_mask)
855 flags (flg_value) priority (prio_value) queue (queue_id) index (idx)
857 The available information parameters are:
859 * port_id: the port which the 2-tuple filter assigned on.
861 * pro_value: IP L4 protocol
863 * pro_mask: protocol participates in the match or not, 1 means participate
865 * port_value: destination port in L4.
867 * port_mask: destination port participates in the match or not, 1 means participate.
869 * flg_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
871 * prio_value: the priority of this filter.
873 * queue_id: The receive queue associated with this 2-tuple filter
875 * index: the index of this 2-tuple filter
879 .. code-block:: console
881 testpmd> add_2tuple_filter 0 protocol 0x06 1 dst_port 32 1 flags 0x02 priority 3 queue 3 index 0
886 Remove a 2-tuple filter
888 remove_2tuple_filter (port_id) index (idx)
893 Get and display a 2-tuple filter
895 get_2tuple_filter (port_id) index (idx)
899 .. code-block:: console
901 testpmd> get_2tuple_filter 0 index 0
904 Destination Port: 0x0020 mask: 1
905 protocol: 0x06 mask:1 tcp_flags: 0x02
911 Add a 5-tuple filter,
912 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
913 and routes packets into one of the receive queues.
915 add_5tuple_filter (port_id) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value)
916 protocol (protocol_value) mask (mask_value) flags (flags_value) priority (prio_value) queue (queue_id) index (idx)
918 The available information parameters are:
920 * port_id: the port which the 5-tuple filter assigned on.
922 * dst_address: destination IP address.
924 * src_address: source IP address.
926 * dst_port_value: TCP/UDP destination port.
928 * src_port_value: TCP/UDP source port.
930 * protocol_value: L4 protocol.
932 * mask_value: participates in the match or not by bit for field above, 1b means participate
934 * flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
936 * prio_value: the priority of this filter.
938 * queue_id: The receive queue associated with this 5-tuple filter.
940 * index: the index of this 5-tuple filter
944 .. code-block:: console
946 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
951 Remove a 5-tuple filter
953 remove_5tuple_filter (port_id) index (idx)
958 Get and display a 5-tuple filter
960 get_5tuple_filter (port_id) index (idx)
964 .. code-block:: console
966 testpmd> get_5tuple_filter 1 index 0
969 Destination IP: 0x02020205 mask: 1
970 Source IP: 0x02020204 mask: 1
971 Destination Port: 0x0040 mask: 1
972 Source Port: 0x0020 mask: 1
973 protocol: 0x06 mask: 1
974 priority: 3 flags: 0x00 queue: 3
979 Add SYN filter, which can forward TCP packets whose *SYN* flag is set into a separate queue.
981 add_syn_filter (port_id) priority (high|low) queue (queue_id)
983 The available information parameters are:
985 * port_id: the port which the SYN filter assigned on.
987 * high: this SYN filter has higher priority than other filters.
989 * low: this SYN filter has lower priority than other filters.
991 * queue_id: The receive queue associated with this SYN filter
995 .. code-block:: console
997 testpmd> add_syn_filter 0 priority high queue 3,
1004 remove_syn_filter (port_id)
1009 Get and display SYN filter
1011 get_syn_filter (port_id)
1015 .. code-block:: console
1017 testpmd> get_syn_filter 0
1019 syn filter: on, priority: high, queue: 3
1025 which recognizes any arbitrary pattern within the first 128 bytes of the packet
1026 and routes packets into one of the receive queues.
1028 add_flex_filter (port_id) len (len_value) bytes (bytes_string) mask (mask_value)
1029 priority (prio_value) queue (queue_id) index (idx)
1031 The available information parameters are:
1033 * port_id: the port which the Flex filter assigned on.
1035 * len_value: filter length in byte, no greater than 128.
1037 * bytes_string: a sting in format of octal, means the value the flex filter need to match.
1039 * mask_value: a sting in format of octal, bit 1 means corresponding byte in DWORD participates in the match.
1041 * prio_value: the priority of this filter.
1043 * queue_id: The receive queue associated with this Flex filter.
1045 * index: the index of this Flex filter
1049 .. code-block:: console
1051 testpmd> add_flex_filter 0 len 16 bytes 0x00000000000000000000000008060000 mask 000C priority 3 queue 3 index 0
1053 Assign a packet whose 13th and 14th bytes are 0x0806 to queue 3.
1058 Remove a Flex filter
1060 remove_flex_filter (port_id) index (idx)
1065 Get and display a Flex filter
1067 get_flex_filter (port_id) index (idx)
1071 .. code-block:: console
1073 testpmd> get_flex_filter 0 index 0
1079 dword[]: 0x00000000 00000000 00000000 08060000 00000000 00000000 00000000
1080 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
1081 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
1082 00000000 00000000 00000000 00000000 00000000 00000000 00000000
1085 0b0000000000001100000000000000000000000000000000000000000000000000000000
1086 0000000000000000000000000000000000000000000000000000000000
1088 priority: 3 queue: 3
1093 Set link up for a port.
1095 set link-up port (port id)
1100 Set link down for a port.
1102 set link-down port (port id)
1107 The following sections show functions for configuring ports.
1111 Port configuration changes only become active when forwarding is started/restarted.
1116 Start all ports or a specific port:
1118 port start (port_id|all)
1123 Stop all ports or a specific port:
1125 port stop (port_id|all)
1130 Close all ports or a specific port:
1132 port close (port_id|all)
1134 port start/stop queue
1135 ~~~~~~~~~~~~~~~~~~~~~
1137 Start/stop a rx/tx queue on a specific port:
1139 port (port_id) (rxq|txq) (queue_id) (start|stop)
1141 Only take effect when port is started.
1146 Set the speed and duplex mode for all ports or a specific port:
1148 port config (port_id|all) speed (10|100|1000|10000|auto) duplex (half|full|auto)
1150 port config - queues/descriptors
1151 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1153 Set number of queues/descriptors for rxq, txq, rxd and txd:
1155 port config all (rxq|txq|rxd|txd) (value)
1157 This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.
1159 port config - max-pkt-len
1160 ~~~~~~~~~~~~~~~~~~~~~~~~~
1162 Set the maximum packet length:
1164 port config all max-pkt-len (value)
1166 This is equivalent to the --max-pkt-len command-line option.
1168 port config - CRC Strip
1169 ~~~~~~~~~~~~~~~~~~~~~~~
1171 Set hardware CRC stripping on or off for all ports:
1173 port config all crc-strip (on|off)
1175 CRC stripping is off by default.
1177 The on option is equivalent to the --crc-strip command-line option.
1179 port config - RX Checksum
1180 ~~~~~~~~~~~~~~~~~~~~~~~~~
1182 Set hardware RX checksum offload to on or off for all ports:
1184 port config all rx-cksum (on|off)
1186 Checksum offload is off by default.
1188 The on option is equivalent to the --enable-rx-cksum command-line option.
1193 Set hardware VLAN on or off for all ports:
1195 port config all hw-vlan (on|off)
1197 Hardware VLAN is on by default.
1199 The off option is equivalent to the --disable-hw-vlan command-line option.
1201 port config - Drop Packets
1202 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1204 Set packet drop for packets with no descriptors on or off for all ports:
1206 port config all drop-en (on|off)
1208 Packet dropping for packets with no descriptors is off by default.
1210 The on option is equivalent to the --enable-drop-en command-line option.
1215 Set the RSS (Receive Side Scaling) mode on or off:
1217 port config all rss (ip|udp|none)
1219 RSS is on by default.
1221 The off option is equivalent to the --disable-rss command-line option.
1223 port config - RSS Reta
1224 ~~~~~~~~~~~~~~~~~~~~~~
1226 Set the RSS (Receive Side Scaling) redirection table:
1228 port config all rss reta (hash,queue)[,(hash,queue)]
1233 Set the DCB mode for an individual port:
1235 port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1237 The traffic class should be 4 or 8.
1242 Set the number of packets per burst:
1244 port config all burst (value)
1246 This is equivalent to the --burst command-line option.
1248 port config - Threshold
1249 ~~~~~~~~~~~~~~~~~~~~~~~
1251 Set thresholds for TX/RX queues:
1253 port config all (threshold) (value)
1255 Where the threshold type can be:
1257 * txpt: Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1259 * txht: Set the host threshold register of the TX rings, 0 <= value <= 255.
1261 * txwt: Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1263 * rxpt: Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1265 * rxht: Set the host threshold register of the RX rings, 0 <= value <= 255.
1267 * rxwt: Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1269 * txfreet: Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1271 * rxfreet: Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1273 * txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1274 These threshold options are also available from the command-line.
1276 Flow Director Functions
1277 -----------------------
1279 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
1281 Two types of filtering are supported which are referred to as Perfect Match and Signature filters:
1283 * Perfect match filters.
1284 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1286 * Signature filters.
1287 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
1289 The Flow Director filters can match the following fields in a packet:
1291 * Source IP and destination IP addresses.
1293 * Source port and destination port numbers (for UDP and TCP packets).
1295 * IPv4/IPv6 and UDP/ TCP/SCTP protocol match.
1299 * Flexible 2-byte tuple match anywhere in the first 64 bytes of the packet.
1301 The Flow Director can also mask out parts of all of these fields so that filters are only applied to certain fields
1302 or parts of the fields.
1303 For example it is possible to mask out sub-nets of IP addresses or to ignore VLAN headers.
1305 In the following sections, several common parameters are used in the Flow Director filters.
1306 These are explained below:
1308 * src: A pair of source address values. The source IP, in IPv4 or IPv6 format, and the source port:
1310 src 192.168.0.1 1024
1312 src 2001:DB8:85A3:0:0:8A2E:370:7000 1024
1314 * dst: A pair of destination address values. The destination IP, in IPv4 or IPv6 format, and the destination port.
1316 * flexbytes: A 2-byte tuple to be matched within the first 64 bytes of a packet.
1318 The offset where the match occurs is set by the --pkt-filter-flexbytes-offset command-line parameter
1319 and is counted from the first byte of the destination Ethernet MAC address.
1320 The default offset is 0xC bytes, which is the "Type" word in the MAC header.
1321 Typically, the flexbyte value is set to 0x0800 to match the IPv4 MAC type or 0x86DD to match IPv6.
1322 These values change when a VLAN tag is added.
1324 * vlan: The VLAN header to match in the packet.
1326 * queue: The index of the RX queue to route matched packets to.
1328 * soft: The 16-bit value in the MBUF flow director ID field for RX packets matching the filter.
1330 add_signature_filter
1331 ~~~~~~~~~~~~~~~~~~~~
1333 Add a signature filter:
1335 # Command is displayed on several lines for clarity.
1337 add_signature_filter (port_id) (ip|udp|tcp|sctp)
1339 src (src_ip_address) (src_port)
1341 dst (dst_ip_address) (dst_port)
1343 flexbytes (flexbytes_values)
1345 vlan (vlan_id) queue (queue_id)
1347 upd_signature_filter
1348 ~~~~~~~~~~~~~~~~~~~~
1350 Update a signature filter:
1352 # Command is displayed on several lines for clarity.
1354 upd_signature_filter (port_id) (ip|udp|tcp|sctp)
1356 src (src_ip_address) (src_port)
1358 dst (dst_ip_address) (dst_port)
1360 flexbytes (flexbytes_values)
1362 vlan (vlan_id) queue (queue_id)
1367 Remove a signature filter:
1369 # Command is displayed on several lines for clarity.
1371 rm_signature_filter (port_id) (ip|udp|tcp|sctp)
1373 src (src_ip_address) (src_port)
1375 dst (dst_ip_address) (dst_port)
1377 flexbytes (flexbytes_values)
1384 Add a perfect filter:
1386 # Command is displayed on several lines for clarity.
1388 add_perfect_filter (port_id) (ip|udp|tcp|sctp)
1390 src (src_ip_address) (src_port)
1392 dst (dst_ip_address) (dst_port)
1394 flexbytes (flexbytes_values)
1396 vlan (vlan_id) queue (queue_id) soft (soft_id)
1401 Update a perfect filter:
1403 # Command is displayed on several lines for clarity.
1405 upd_perfect_filter (port_id) (ip|udp|tcp|sctp)
1407 src (src_ip_address) (src_port)
1409 dst (dst_ip_address) (dst_port)
1411 flexbytes (flexbytes_values)
1413 vlan (vlan_id) queue (queue_id)
1418 Remove a perfect filter:
1420 rm_perfect_filter (port_id) (ip|udp|tcp|sctp)
1422 src (src_ip_address) (src_port)
1424 dst (dst_ip_address) (dst_port)
1426 flexbytes (flexbytes_values)
1428 vlan (vlan_id) soft (soft_id)
1433 Set IPv4 filter masks:
1435 # Command is displayed on several lines for clarity.
1437 set_masks_filter (port_id) only_ip_flow (0|1)
1439 src_mask (ip_src_mask) (src_port_mask)
1441 dst_mask (ip_dst_mask) (dst_port_mask)
1443 flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
1445 set_ipv6_masks_filter
1446 ~~~~~~~~~~~~~~~~~~~~~
1448 Set IPv6 filter masks:
1450 # Command is displayed on several lines for clarity.
1452 set_ipv6_masks_filter (port_id) only_ip_flow (0|1)
1454 src_mask (ip_src_mask) (src_port_mask)
1456 dst_mask (ip_dst_mask) (dst_port_mask)
1458 flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
1462 Link Bonding Functions
1463 ----------------------
1465 The Link Bonding functions make it possible to dynamically create and
1466 manage link bonding devices from within testpmd interactive prompt.
1468 create bonded device
1469 ~~~~~~~~~~~~~~~~~~~~
1471 Create a new bonding device:
1473 create bonded device (mode) (socket)
1475 For example, to create a bonded device in mode 1 on socket 0.
1477 .. code-block:: console
1479 testpmd> create bonded 1 0
1480 created new bonded device (port X)
1485 Adds Ethernet device to a Link Bonding device:
1487 add bonding slave (slave id) (port id)
1489 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10).
1491 .. code-block:: console
1493 testpmd> add bonding slave 6 10
1496 remove bonding slave
1497 ~~~~~~~~~~~~~~~~~~~~
1499 Removes an Ethernet slave device from a Link Bonding device:
1501 remove bonding slave (slave id) (port id)
1503 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10).
1505 .. code-block:: console
1507 testpmd> remove bonding slave 6 10
1512 Set the Link Bonding mode of a Link Bonding device:
1514 set bonding mode (value) (port id)
1516 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3).
1518 .. code-block:: console
1520 testpmd> set bonding mode 3 10
1525 Set an Ethernet slave device as the primary device on a Link Bonding device:
1527 set bonding primary (slave id) (port id)
1529 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10).
1531 .. code-block:: console
1533 testpmd> set bonding primary 6 10
1538 Set the MAC address of a Link Bonding device:
1540 set bonding mac (port id) (mac)
1542 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01
1544 .. code-block:: console
1546 testpmd> set bonding mac 10 00:00:00:00:00:01
1548 set bonding xmit_balance_policy
1549 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1551 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode:
1553 set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1555 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports )
1557 .. code-block:: console
1559 testpmd> set bonding xmit_balance_policy 10 l34
1562 set bonding mon_period
1563 ~~~~~~~~~~~~~~~~~~~~~~
1565 Set the link status monitoring polling period in milliseconds for a bonding devicie.
1567 This adds support for PMD slave devices which do not support link status interrupts.
1568 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1569 link status ISR will be queried every polling interval to check if their link status has changed.
1571 set bonding mon_period (port_id) (value)
1573 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms
1575 .. code-block:: console
1577 testpmd> set bonding mon_period 5 150
1583 Show the current configuration of a Link Bonding device:
1585 show bonding config (port id)
1588 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1589 in balance mode with a transmission policy of layer 2+3.
1591 .. code-block:: console
1593 testpmd> show bonding config 9
1595 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1597 Active Slaves (3): [1 3 4]
1603 The Register functions can be used to read from and write to registers on the network card referenced by a port number.
1604 This is mainly useful for debugging purposes.
1605 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1606 and fields that can be accessed.
1611 Display the value of a port register:
1613 read reg (port_id) (address)
1615 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an IntelĀ® 82599 10 GbE Controller:
1617 .. code-block:: console
1619 testpmd> read reg 0 0xEE00
1620 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1625 Display a port register bit field:
1627 read regfield (port_id) (address) (bit_x) (bit_y)
1629 For example, reading the lowest two bits from the register in the example above:
1631 .. code-block:: console
1633 testpmd> read regfield 0 0xEE00 0 1
1634 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1639 Display a single port register bit:
1641 read regbit (port_id) (address) (bit_x)
1643 For example, reading the lowest bit from the register in the example above:
1645 .. code-block:: console
1647 testpmd> read regbit 0 0xEE00 0
1648 port 0 PCI register at offset 0xEE00: bit 0=1
1653 Set the value of a port register:
1655 write reg (port_id) (address) (value)
1657 For example, to clear a register:
1659 .. code-block:: console
1661 testpmd> write reg 0 0xEE00 0x0
1662 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1667 Set bit field of a port register:
1669 write regfield (port_id) (address) (bit_x) (bit_y) (value)
1671 For example, writing to the register cleared in the example above:
1673 .. code-block:: console
1675 testpmd> write regfield 0 0xEE00 0 1 2
1676 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1681 Set single bit value of a port register:
1683 write regbit (port_id) (address) (bit_x) (value)
1685 For example, to set the high bit in the register from the example above:
1687 .. code-block:: console
1689 testpmd> write regbit 0 0xEE00 31 1
1690 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)