2 Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
9 * Redistributions of source code must retain the above copyright
10 notice, this list of conditions and the following disclaimer.
11 * Redistributions in binary form must reproduce the above copyright
12 notice, this list of conditions and the following disclaimer in
13 the documentation and/or other materials provided with the
15 * Neither the name of Intel Corporation nor the names of its
16 contributors may be used to endorse or promote products derived
17 from this software without specific prior written permission.
19 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 Testpmd Runtime Functions
34 =========================
36 Where the testpmd application is started in interactive mode, (``-i|--interactive``),
37 it displays a prompt that can be used to start and stop forwarding,
38 configure the application, display statistics, set the Flow Director and other tasks::
42 The testpmd prompt has some, limited, readline support.
43 Common bash command-line functions such as ``Ctrl+a`` and ``Ctrl+e`` to go to the start and end of the prompt line are supported
44 as well as access to the command history via the up-arrow.
46 There is also support for tab completion.
47 If you type a partial command and hit ``<TAB>`` you get a list of the available completions:
49 .. code-block:: console
51 testpmd> show port <TAB>
53 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
54 info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
55 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
56 stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
62 Some examples in this document are too long to fit on one line are are shown wrapped at `"\\"` for display purposes::
64 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
65 (pause_time) (send_xon) (port_id)
67 In the real ``testpmd>`` prompt these commands should be on a single line.
72 The testpmd has on-line help for the functions that are available at runtime.
73 These are divided into sections and can be accessed using help, help section or help all:
75 .. code-block:: console
79 help control : Start and stop forwarding.
80 help display : Displaying port, stats and config information.
81 help config : Configuration information.
82 help ports : Configuring ports.
83 help registers : Reading and setting port registers.
84 help filters : Filters configuration help.
85 help all : All of the above sections.
94 Start packet forwarding with current configuration::
101 Start packet forwarding with current configuration after sending specified number of bursts of packets::
103 testpmd> start tx_first (""|burst_num)
105 The default burst number is 1 when ``burst_num`` not presented.
110 Stop packet forwarding, and display accumulated statistics::
125 The functions in the following sections are used to display information about the
126 testpmd configuration or the NIC status.
131 Display information for a given port or all ports::
133 testpmd> show port (info|stats|fdir|stat_qmap|dcb_tc) (port_id|all)
135 The available information categories are:
137 * ``info``: General port information such as MAC address.
139 * ``stats``: RX/TX statistics.
141 * ``fdir``: Flow Director information and statistics.
143 * ``stat_qmap``: Queue statistics mapping.
145 * ``dcb_tc``: DCB information such as TC mapping.
149 .. code-block:: console
151 testpmd> show port info 0
153 ********************* Infos for port 0 *********************
155 MAC address: XX:XX:XX:XX:XX:XX
157 memory allocation on the socket: 0
159 Link speed: 40000 Mbps
160 Link duplex: full-duplex
161 Promiscuous mode: enabled
162 Allmulticast mode: disabled
163 Maximum number of MAC addresses: 64
164 Maximum number of MAC addresses of hash filtering: 0
169 Redirection table size: 512
170 Supported flow types:
190 Display the rss redirection table entry indicated by masks on port X::
192 testpmd> show port (port_id) rss reta (size) (mask0, mask1...)
194 size is used to indicate the hardware supported reta size
199 Display the RSS hash functions and RSS hash key of a port::
201 testpmd> show port (port_id) rss-hash ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2-payload|ipv6-ex|ipv6-tcp-ex|ipv6-udp-ex [key]
206 Clear the port statistics for a given port or for all ports::
208 testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all)
212 testpmd> clear port stats all
217 Display information for a given port's RX/TX queue::
219 testpmd> show (rxq|txq) info (port_id) (queue_id)
224 Displays the configuration of the application.
225 The configuration comes from the command-line, the runtime or the application defaults::
227 testpmd> show config (rxtx|cores|fwd|txpkts)
229 The available information categories are:
231 * ``rxtx``: RX/TX configuration items.
233 * ``cores``: List of forwarding cores.
235 * ``fwd``: Packet forwarding configuration.
237 * ``txpkts``: Packets to TX configuration.
241 .. code-block:: console
243 testpmd> show config rxtx
245 io packet forwarding - CRC stripping disabled - packets/burst=16
246 nb forwarding cores=2 - nb forwarding ports=1
247 RX queues=1 - RX desc=128 - RX free threshold=0
248 RX threshold registers: pthresh=8 hthresh=8 wthresh=4
249 TX queues=1 - TX desc=512 - TX free threshold=0
250 TX threshold registers: pthresh=36 hthresh=0 wthresh=0
251 TX RS bit threshold=0 - TXQ flags=0x0
256 Set the packet forwarding mode::
258 testpmd> set fwd (io|mac|macswap|flowgen| \
259 rxonly|txonly|csum|icmpecho) (""|retry)
261 ``retry`` can be specified for forwarding engines except ``rx_only``.
263 The available information categories are:
265 * ``io``: Forwards packets "as-is" in I/O mode.
266 This is the fastest possible forwarding operation as it does not access packets data.
267 This is the default mode.
269 * ``mac``: Changes the source and the destination Ethernet addresses of packets before forwarding them.
271 * ``macswap``: MAC swap forwarding mode.
272 Swaps the source and the destination Ethernet addresses of packets before forwarding them.
274 * ``flowgen``: Multi-flow generation mode.
275 Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
277 * ``rxonly``: Receives packets but doesn't transmit them.
279 * ``txonly``: Generates and transmits packets without receiving any.
281 * ``csum``: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
283 * ``icmpecho``: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
285 * ``ieee1588``: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires ``CONFIG_RTE_LIBRTE_IEEE1588=y``.
287 Note: TX timestamping is only available in the "Full Featured" TX path. To force ``testpmd`` into this mode set ``--txqflags=0``.
291 testpmd> set fwd rxonly
293 Set rxonly packet forwarding mode
299 Display an RX descriptor for a port RX queue::
301 testpmd> read rxd (port_id) (queue_id) (rxd_id)
305 testpmd> read rxd 0 0 4
306 0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180
311 Display a TX descriptor for a port TX queue::
313 testpmd> read txd (port_id) (queue_id) (txd_id)
317 testpmd> read txd 0 0 4
318 0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C
321 Configuration Functions
322 -----------------------
324 The testpmd application can be configured from the runtime as well as from the command-line.
326 This section details the available configuration functions that are available.
330 Configuration changes only become active when forwarding is started/restarted.
335 Reset forwarding to the default configuration::
342 Set the debug verbosity level::
344 testpmd> set verbose (level)
346 Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).
351 Set the number of ports used by the application:
355 This is equivalent to the ``--nb-ports`` command-line option.
360 Set the number of cores used by the application::
362 testpmd> set nbcore (num)
364 This is equivalent to the ``--nb-cores`` command-line option.
368 The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.
373 Set the forwarding cores hexadecimal mask::
375 testpmd> set coremask (mask)
377 This is equivalent to the ``--coremask`` command-line option.
381 The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.
386 Set the forwarding ports hexadecimal mask::
388 testpmd> set portmask (mask)
390 This is equivalent to the ``--portmask`` command-line option.
395 Set number of packets per burst::
397 testpmd> set burst (num)
399 This is equivalent to the ``--burst command-line`` option.
401 When retry is enabled, the transmit delay time and number of retries can also be set::
403 testpmd> set burst tx delay (microseconds) retry (num)
408 Set the length of each segment of the TX-ONLY packets::
410 testpmd> set txpkts (x[,y]*)
412 Where x[,y]* represents a CSV list of values, without white space.
417 Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes::
419 testpmd> set txsplit (off|on|rand)
423 * ``off`` disable packet copy & split for CSUM mode.
425 * ``on`` split outgoing packet into multiple segments. Size of each segment
426 and number of segments per packet is determined by ``set txpkts`` command
429 * ``rand`` same as 'on', but number of segments per each packet is a random value between 1 and total number of segments.
434 Set the list of forwarding cores::
436 testpmd> set corelist (x[,y]*)
438 For example, to change the forwarding cores:
440 .. code-block:: console
442 testpmd> set corelist 3,1
443 testpmd> show config fwd
445 io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
446 Logical Core 3 (socket 0) forwards packets on 1 streams:
447 RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
448 Logical Core 1 (socket 0) forwards packets on 1 streams:
449 RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
453 The cores are used in the same order as specified on the command line.
458 Set the list of forwarding ports::
460 testpmd> set portlist (x[,y]*)
462 For example, to change the port forwarding:
464 .. code-block:: console
466 testpmd> set portlist 0,2,1,3
467 testpmd> show config fwd
469 io packet forwarding - ports=4 - cores=1 - streams=4
470 Logical Core 3 (socket 0) forwards packets on 4 streams:
471 RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
472 RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
473 RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
474 RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02
479 Set the VLAN strip on a port::
481 testpmd> vlan set strip (on|off) (port_id)
486 Set the VLAN strip for a queue on a port::
488 testpmd> vlan set stripq (on|off) (port_id,queue_id)
493 Set the VLAN filter on a port::
495 testpmd> vlan set filter (on|off) (port_id)
500 Set the VLAN QinQ (extended queue in queue) on for a port::
502 testpmd> vlan set qinq (on|off) (port_id)
507 Set the inner or outer VLAN TPID for packet filtering on a port::
509 testpmd> vlan set (inner|outer) tpid (value) (port_id)
513 TPID value must be a 16-bit number (value <= 65536).
518 Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID::
520 testpmd> rx_vlan add (vlan_id|all) (port_id)
524 VLAN filter must be set on that port. VLAN ID < 4096.
525 Depending on the NIC used, number of vlan_ids may be limited to the maximum entries
526 in VFTA table. This is important if enabling all vlan_ids.
531 Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID::
533 testpmd> rx_vlan rm (vlan_id|all) (port_id)
538 Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID::
540 testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)
545 Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID::
547 testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
552 Add a tunnel filter on a port::
554 testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
555 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
556 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
558 The available information categories are:
560 * ``vxlan``: Set tunnel type as VXLAN.
562 * ``nvgre``: Set tunnel type as NVGRE.
564 * ``ipingre``: Set tunnel type as IP-in-GRE.
566 * ``imac-ivlan``: Set filter type as Inner MAC and VLAN.
568 * ``imac-ivlan-tenid``: Set filter type as Inner MAC, VLAN and tenant ID.
570 * ``imac-tenid``: Set filter type as Inner MAC and tenant ID.
572 * ``imac``: Set filter type as Inner MAC.
574 * ``omac-imac-tenid``: Set filter type as Outer MAC, Inner MAC and tenant ID.
576 * ``oip``: Set filter type as Outer IP.
578 * ``iip``: Set filter type as Inner IP.
582 testpmd> tunnel_filter add 0 68:05:CA:28:09:82 00:00:00:00:00:00 \
583 192.168.2.2 0 ipingre oip 1 1
585 Set an IP-in-GRE tunnel on port 0, and the filter type is Outer IP.
590 Remove a tunnel filter on a port::
592 testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
593 (inner_vlan) (vxlan|nvgre|ipingre) (imac-ivlan|imac-ivlan-tenid|\
594 imac-tenid|imac|omac-imac-tenid|oip|iip) (tenant_id) (queue_id)
599 Add an UDP port for VXLAN packet filter on a port::
601 testpmd> rx_vxlan_port add (udp_port) (port_id)
606 Remove an UDP port for VXLAN packet filter on a port::
608 testpmd> rx_vxlan_port rm (udp_port) (port_id)
613 Set hardware insertion of VLAN IDs in packets sent on a port::
615 testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]
617 For example, set a single VLAN ID (5) insertion on port 0::
621 Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1::
629 Set port based hardware insertion of VLAN ID in packets sent on a port::
631 testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)
636 Disable hardware insertion of a VLAN header in packets sent on a port::
638 testpmd> tx_vlan reset (port_id)
643 Select hardware or software calculation of the checksum when
644 transmitting a packet using the ``csum`` forwarding engine::
646 testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)
650 * ``ip|udp|tcp|sctp`` always relate to the inner layer.
652 * ``outer-ip`` relates to the outer IP layer (only for IPv4) in the case where the packet is recognized
653 as a tunnel packet by the forwarding engine (vxlan, gre and ipip are
654 supported). See also the ``csum parse-tunnel`` command.
658 Check the NIC Datasheet for hardware limits.
663 Define how tunneled packets should be handled by the csum forward
666 testpmd> csum parse-tunnel (on|off) (tx_port_id)
668 If enabled, the csum forward engine will try to recognize supported
669 tunnel headers (vxlan, gre, ipip).
671 If disabled, treat tunnel packets as non-tunneled packets (a inner
672 header is handled as a packet payload).
676 The port argument is the TX port like in the ``csum set`` command.
680 Consider a packet in packet like the following::
682 eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in
684 * If parse-tunnel is enabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
685 command relate to the inner headers (here ``ipv4_in`` and ``tcp_in``), and the
686 ``outer-ip parameter`` relates to the outer headers (here ``ipv4_out``).
688 * If parse-tunnel is disabled, the ``ip|udp|tcp|sctp`` parameters of ``csum set``
689 command relate to the outer headers, here ``ipv4_out`` and ``udp_out``.
694 Display tx checksum offload configuration::
696 testpmd> csum show (port_id)
701 Enable TCP Segmentation Offload (TSO) in the ``csum`` forwarding engine::
703 testpmd> tso set (segsize) (port_id)
707 Check the NIC datasheet for hardware limits.
712 Display the status of TCP Segmentation Offload::
714 testpmd> tso show (port_id)
719 Add an alternative MAC address to a port::
721 testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)
726 Remove a MAC address from a port::
728 testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)
733 Add an alternative MAC address for a VF to a port::
735 testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)
740 Set the unicast hash filter(s) on/off for a port::
742 testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)
747 Set the promiscuous mode on for a port or for all ports.
748 In promiscuous mode packets are not dropped if they aren't for the specified MAC address::
750 testpmd> set promisc (port_id|all) (on|off)
755 Set the allmulti mode for a port or for all ports::
757 testpmd> set allmulti (port_id|all) (on|off)
759 Same as the ifconfig (8) option. Controls how multicast packets are handled.
764 Set the link flow control parameter on a port::
766 testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
767 (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
768 autoneg (on|off) (port_id)
772 * ``high_water`` (integer): High threshold value to trigger XOFF.
774 * ``low_water`` (integer): Low threshold value to trigger XON.
776 * ``pause_time`` (integer): Pause quota in the Pause frame.
778 * ``send_xon`` (0/1): Send XON frame.
780 * ``mac_ctrl_frame_fwd``: Enable receiving MAC control frames.
782 * ``autoneg``: Change the auto-negotiation para mete.
787 Set the priority flow control parameter on a port::
789 testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
790 (pause_time) (priority) (port_id)
794 * ``high_water`` (integer): High threshold value.
796 * ``low_water`` (integer): Low threshold value.
798 * ``pause_time`` (integer): Pause quota in the Pause frame.
800 * ``priority`` (0-7): VLAN User Priority.
805 Set statistics mapping (qmapping 0..15) for RX/TX queue on port::
807 testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)
809 For example, to set rx queue 2 on port 0 to mapping 5::
811 testpmd>set stat_qmap rx 0 2 5
813 set port - rx/tx (for VF)
814 ~~~~~~~~~~~~~~~~~~~~~~~~~
816 Set VF receive/transmit from a port::
818 testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)
820 set port - mac address filter (for VF)
821 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
823 Add/Remove unicast or multicast MAC addr filter for a VF::
825 testpmd> set port (port_id) vf (vf_id) (mac_addr) \
826 (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
828 set port - rx mode(for VF)
829 ~~~~~~~~~~~~~~~~~~~~~~~~~~
831 Set the VF receive mode of a port::
833 testpmd> set port (port_id) vf (vf_id) \
834 rxmode (AUPE|ROPE|BAM|MPE) (on|off)
836 The available receive modes are:
838 * ``AUPE``: Accepts untagged VLAN.
840 * ``ROPE``: Accepts unicast hash.
842 * ``BAM``: Accepts broadcast packets.
844 * ``MPE``: Accepts all multicast packets.
846 set port - tx_rate (for Queue)
847 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
849 Set TX rate limitation for a queue on a port::
851 testpmd> set port (port_id) queue (queue_id) rate (rate_value)
853 set port - tx_rate (for VF)
854 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
856 Set TX rate limitation for queues in VF on a port::
858 testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
860 set port - mirror rule
861 ~~~~~~~~~~~~~~~~~~~~~~
863 Set pool or vlan type mirror rule for a port::
865 testpmd> set port (port_id) mirror-rule (rule_id) \
866 (pool-mirror-up|pool-mirror-down|vlan-mirror) \
867 (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)
869 Set link mirror rule for a port::
871 testpmd> set port (port_id) mirror-rule (rule_id) \
872 (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)
874 For example to enable mirror traffic with vlan 0,1 to pool 0::
876 set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on
878 reset port - mirror rule
879 ~~~~~~~~~~~~~~~~~~~~~~~~
881 Reset a mirror rule for a port::
883 testpmd> reset port (port_id) mirror-rule (rule_id)
888 Set the flush on RX streams before forwarding.
889 The default is flush ``on``.
890 Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams::
892 testpmd> set flush_rx off
897 Set the bypass mode for the lowest port on bypass enabled NIC::
899 testpmd> set bypass mode (normal|bypass|isolate) (port_id)
904 Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled::
906 testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
907 mode (normal|bypass|isolate) (port_id)
911 * ``timeout``: Enable bypass after watchdog timeout.
913 * ``os_on``: Enable bypass when OS/board is powered on.
915 * ``os_off``: Enable bypass when OS/board is powered off.
917 * ``power_on``: Enable bypass when power supply is turned on.
919 * ``power_off``: Enable bypass when power supply is turned off.
925 Set the bypass watchdog timeout to ``n`` seconds where 0 = instant::
927 testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)
932 Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC::
934 testpmd> show bypass config (port_id)
939 Set link up for a port::
941 testpmd> set link-up port (port id)
946 Set link down for a port::
948 testpmd> set link-down port (port id)
953 Enable E-tag insertion for a VF on a port::
955 testpmd> E-tag set insertion on port-tag-id (value) port (port_id) vf (vf_id)
957 Disable E-tag insertion for a VF on a port::
959 testpmd> E-tag set insertion off port (port_id) vf (vf_id)
961 Enable/disable E-tag stripping on a port::
963 testpmd> E-tag set stripping (on|off) port (port_id)
965 Enable/disable E-tag based forwarding on a port::
967 testpmd> E-tag set forwarding (on|off) port (port_id)
969 Add an E-tag forwarding filter on a port::
971 testpmd> E-tag set filter add e-tag-id (value) dst-pool (pool_id) port (port_id)
973 Delete an E-tag forwarding filter on a port::
974 testpmd> E-tag set filter del e-tag-id (value) port (port_id)
980 The following sections show functions for configuring ports.
984 Port configuration changes only become active when forwarding is started/restarted.
989 Attach a port specified by pci address or virtual device args::
991 testpmd> port attach (identifier)
993 To attach a new pci device, the device should be recognized by kernel first.
994 Then it should be moved under DPDK management.
995 Finally the port can be attached to testpmd.
997 For example, to move a pci device using ixgbe under DPDK management:
999 .. code-block:: console
1001 # Check the status of the available devices.
1002 ./tools/dpdk-devbind.py --status
1004 Network devices using DPDK-compatible driver
1005 ============================================
1008 Network devices using kernel driver
1009 ===================================
1010 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=
1013 # Bind the device to igb_uio.
1014 sudo ./tools/dpdk-devbind.py -b igb_uio 0000:0a:00.0
1017 # Recheck the status of the devices.
1018 ./tools/dpdk-devbind.py --status
1019 Network devices using DPDK-compatible driver
1020 ============================================
1021 0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=
1023 To attach a port created by virtual device, above steps are not needed.
1025 For example, to attach a port whose pci address is 0000:0a:00.0.
1027 .. code-block:: console
1029 testpmd> port attach 0000:0a:00.0
1030 Attaching a new port...
1031 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1032 EAL: probe driver: 8086:10fb rte_ixgbe_pmd
1033 EAL: PCI memory mapped at 0x7f83bfa00000
1034 EAL: PCI memory mapped at 0x7f83bfa80000
1035 PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
1036 PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
1037 Port 0 is attached. Now total ports is 1
1040 For example, to attach a port created by pcap PMD.
1042 .. code-block:: console
1044 testpmd> port attach net_pcap0
1045 Attaching a new port...
1046 PMD: Initializing pmd_pcap for net_pcap0
1047 PMD: Creating pcap-backed ethdev on numa socket 0
1048 Port 0 is attached. Now total ports is 1
1051 In this case, identifier is ``net_pcap0``.
1052 This identifier format is the same as ``--vdev`` format of DPDK applications.
1054 For example, to re-attach a bonded port which has been previously detached,
1055 the mode and slave parameters must be given.
1057 .. code-block:: console
1059 testpmd> port attach net_bond_0,mode=0,slave=1
1060 Attaching a new port...
1061 EAL: Initializing pmd_bond for net_bond_0
1062 EAL: Create bonded device net_bond_0 on port 0 in mode 0 on socket 0.
1063 Port 0 is attached. Now total ports is 1
1070 Detach a specific port::
1072 testpmd> port detach (port_id)
1074 Before detaching a port, the port should be stopped and closed.
1076 For example, to detach a pci device port 0.
1078 .. code-block:: console
1080 testpmd> port stop 0
1083 testpmd> port close 0
1087 testpmd> port detach 0
1089 EAL: PCI device 0000:0a:00.0 on NUMA socket -1
1090 EAL: remove driver: 8086:10fb rte_ixgbe_pmd
1091 EAL: PCI memory unmapped at 0x7f83bfa00000
1092 EAL: PCI memory unmapped at 0x7f83bfa80000
1096 For example, to detach a virtual device port 0.
1098 .. code-block:: console
1100 testpmd> port stop 0
1103 testpmd> port close 0
1107 testpmd> port detach 0
1109 PMD: Closing pcap ethdev on numa socket 0
1110 Port 'net_pcap0' is detached. Now total ports is 0
1113 To remove a pci device completely from the system, first detach the port from testpmd.
1114 Then the device should be moved under kernel management.
1115 Finally the device can be removed using kernel pci hotplug functionality.
1117 For example, to move a pci device under kernel management:
1119 .. code-block:: console
1121 sudo ./tools/dpdk-devbind.py -b ixgbe 0000:0a:00.0
1123 ./tools/dpdk-devbind.py --status
1125 Network devices using DPDK-compatible driver
1126 ============================================
1129 Network devices using kernel driver
1130 ===================================
1131 0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio
1133 To remove a port created by a virtual device, above steps are not needed.
1138 Start all ports or a specific port::
1140 testpmd> port start (port_id|all)
1145 Stop all ports or a specific port::
1147 testpmd> port stop (port_id|all)
1152 Close all ports or a specific port::
1154 testpmd> port close (port_id|all)
1156 port start/stop queue
1157 ~~~~~~~~~~~~~~~~~~~~~
1159 Start/stop a rx/tx queue on a specific port::
1161 testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)
1163 Only take effect when port is started.
1168 Set the speed and duplex mode for all ports or a specific port::
1170 testpmd> port config (port_id|all) speed (10|100|1000|10000|40000|100000|auto) \
1171 duplex (half|full|auto)
1173 port config - queues/descriptors
1174 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1176 Set number of queues/descriptors for rxq, txq, rxd and txd::
1178 testpmd> port config all (rxq|txq|rxd|txd) (value)
1180 This is equivalent to the ``--rxq``, ``--txq``, ``--rxd`` and ``--txd`` command-line options.
1182 port config - max-pkt-len
1183 ~~~~~~~~~~~~~~~~~~~~~~~~~
1185 Set the maximum packet length::
1187 testpmd> port config all max-pkt-len (value)
1189 This is equivalent to the ``--max-pkt-len`` command-line option.
1191 port config - CRC Strip
1192 ~~~~~~~~~~~~~~~~~~~~~~~
1194 Set hardware CRC stripping on or off for all ports::
1196 testpmd> port config all crc-strip (on|off)
1198 CRC stripping is off by default.
1200 The ``on`` option is equivalent to the ``--crc-strip`` command-line option.
1202 port config - scatter
1203 ~~~~~~~~~~~~~~~~~~~~~~~
1205 Set RX scatter mode on or off for all ports::
1207 testpmd> port config all scatter (on|off)
1209 RX scatter mode is off by default.
1211 The ``on`` option is equivalent to the ``--enable-scatter`` command-line option.
1213 port config - TX queue flags
1214 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1216 Set a hexadecimal bitmap of TX queue flags for all ports::
1218 testpmd> port config all txqflags value
1220 This command is equivalent to the ``--txqflags`` command-line option.
1222 port config - RX Checksum
1223 ~~~~~~~~~~~~~~~~~~~~~~~~~
1225 Set hardware RX checksum offload to on or off for all ports::
1227 testpmd> port config all rx-cksum (on|off)
1229 Checksum offload is off by default.
1231 The ``on`` option is equivalent to the ``--enable-rx-cksum`` command-line option.
1236 Set hardware VLAN on or off for all ports::
1238 testpmd> port config all hw-vlan (on|off)
1240 Hardware VLAN is on by default.
1242 The ``off`` option is equivalent to the ``--disable-hw-vlan`` command-line option.
1244 port config - VLAN filter
1245 ~~~~~~~~~~~~~~~~~~~~~~~~~
1247 Set hardware VLAN filter on or off for all ports::
1249 testpmd> port config all hw-vlan-filter (on|off)
1251 Hardware VLAN filter is on by default.
1253 The ``off`` option is equivalent to the ``--disable-hw-vlan-filter`` command-line option.
1255 port config - VLAN strip
1256 ~~~~~~~~~~~~~~~~~~~~~~~~
1258 Set hardware VLAN strip on or off for all ports::
1260 testpmd> port config all hw-vlan-strip (on|off)
1262 Hardware VLAN strip is on by default.
1264 The ``off`` option is equivalent to the ``--disable-hw-vlan-strip`` command-line option.
1266 port config - VLAN extend
1267 ~~~~~~~~~~~~~~~~~~~~~~~~~
1269 Set hardware VLAN extend on or off for all ports::
1271 testpmd> port config all hw-vlan-extend (on|off)
1273 Hardware VLAN extend is off by default.
1275 The ``off`` option is equivalent to the ``--disable-hw-vlan-extend`` command-line option.
1277 port config - Drop Packets
1278 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1280 Set packet drop for packets with no descriptors on or off for all ports::
1282 testpmd> port config all drop-en (on|off)
1284 Packet dropping for packets with no descriptors is off by default.
1286 The ``on`` option is equivalent to the ``--enable-drop-en`` command-line option.
1291 Set the RSS (Receive Side Scaling) mode on or off::
1293 testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|port|vxlan|geneve|nvgre|none)
1295 RSS is on by default.
1297 The ``none`` option is equivalent to the ``--disable-rss`` command-line option.
1299 port config - RSS Reta
1300 ~~~~~~~~~~~~~~~~~~~~~~
1302 Set the RSS (Receive Side Scaling) redirection table::
1304 testpmd> port config all rss reta (hash,queue)[,(hash,queue)]
1309 Set the DCB mode for an individual port::
1311 testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)
1313 The traffic class should be 4 or 8.
1318 Set the number of packets per burst::
1320 testpmd> port config all burst (value)
1322 This is equivalent to the ``--burst`` command-line option.
1324 port config - Threshold
1325 ~~~~~~~~~~~~~~~~~~~~~~~
1327 Set thresholds for TX/RX queues::
1329 testpmd> port config all (threshold) (value)
1331 Where the threshold type can be:
1333 * ``txpt:`` Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
1335 * ``txht:`` Set the host threshold register of the TX rings, 0 <= value <= 255.
1337 * ``txwt:`` Set the write-back threshold register of the TX rings, 0 <= value <= 255.
1339 * ``rxpt:`` Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
1341 * ``rxht:`` Set the host threshold register of the RX rings, 0 <= value <= 255.
1343 * ``rxwt:`` Set the write-back threshold register of the RX rings, 0 <= value <= 255.
1345 * ``txfreet:`` Set the transmit free threshold of the TX rings, 0 <= value <= txd.
1347 * ``rxfreet:`` Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
1349 * ``txrst:`` Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
1351 These threshold options are also available from the command-line.
1356 Set the value of ether-type for E-tag::
1358 testpmd> port config (port_id|all) l2-tunnel E-tag ether-type (value)
1360 Enable/disable the E-tag support::
1362 testpmd> port config (port_id|all) l2-tunnel E-tag (enable|disable)
1365 Link Bonding Functions
1366 ----------------------
1368 The Link Bonding functions make it possible to dynamically create and
1369 manage link bonding devices from within testpmd interactive prompt.
1371 create bonded device
1372 ~~~~~~~~~~~~~~~~~~~~
1374 Create a new bonding device::
1376 testpmd> create bonded device (mode) (socket)
1378 For example, to create a bonded device in mode 1 on socket 0::
1380 testpmd> create bonded 1 0
1381 created new bonded device (port X)
1386 Adds Ethernet device to a Link Bonding device::
1388 testpmd> add bonding slave (slave id) (port id)
1390 For example, to add Ethernet device (port 6) to a Link Bonding device (port 10)::
1392 testpmd> add bonding slave 6 10
1395 remove bonding slave
1396 ~~~~~~~~~~~~~~~~~~~~
1398 Removes an Ethernet slave device from a Link Bonding device::
1400 testpmd> remove bonding slave (slave id) (port id)
1402 For example, to remove Ethernet slave device (port 6) to a Link Bonding device (port 10)::
1404 testpmd> remove bonding slave 6 10
1409 Set the Link Bonding mode of a Link Bonding device::
1411 testpmd> set bonding mode (value) (port id)
1413 For example, to set the bonding mode of a Link Bonding device (port 10) to broadcast (mode 3)::
1415 testpmd> set bonding mode 3 10
1420 Set an Ethernet slave device as the primary device on a Link Bonding device::
1422 testpmd> set bonding primary (slave id) (port id)
1424 For example, to set the Ethernet slave device (port 6) as the primary port of a Link Bonding device (port 10)::
1426 testpmd> set bonding primary 6 10
1431 Set the MAC address of a Link Bonding device::
1433 testpmd> set bonding mac (port id) (mac)
1435 For example, to set the MAC address of a Link Bonding device (port 10) to 00:00:00:00:00:01::
1437 testpmd> set bonding mac 10 00:00:00:00:00:01
1439 set bonding xmit_balance_policy
1440 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1442 Set the transmission policy for a Link Bonding device when it is in Balance XOR mode::
1444 testpmd> set bonding xmit_balance_policy (port_id) (l2|l23|l34)
1446 For example, set a Link Bonding device (port 10) to use a balance policy of layer 3+4 (IP addresses & UDP ports)::
1448 testpmd> set bonding xmit_balance_policy 10 l34
1451 set bonding mon_period
1452 ~~~~~~~~~~~~~~~~~~~~~~
1454 Set the link status monitoring polling period in milliseconds for a bonding device.
1456 This adds support for PMD slave devices which do not support link status interrupts.
1457 When the mon_period is set to a value greater than 0 then all PMD's which do not support
1458 link status ISR will be queried every polling interval to check if their link status has changed::
1460 testpmd> set bonding mon_period (port_id) (value)
1462 For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms::
1464 testpmd> set bonding mon_period 5 150
1470 Show the current configuration of a Link Bonding device::
1472 testpmd> show bonding config (port id)
1475 to show the configuration a Link Bonding device (port 9) with 3 slave devices (1, 3, 4)
1476 in balance mode with a transmission policy of layer 2+3::
1478 testpmd> show bonding config 9
1480 Balance Xmit Policy: BALANCE_XMIT_POLICY_LAYER23
1482 Active Slaves (3): [1 3 4]
1489 The Register Functions can be used to read from and write to registers on the network card referenced by a port number.
1490 This is mainly useful for debugging purposes.
1491 Reference should be made to the appropriate datasheet for the network card for details on the register addresses
1492 and fields that can be accessed.
1497 Display the value of a port register::
1499 testpmd> read reg (port_id) (address)
1501 For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller::
1503 testpmd> read reg 0 0xEE00
1504 port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)
1509 Display a port register bit field::
1511 testpmd> read regfield (port_id) (address) (bit_x) (bit_y)
1513 For example, reading the lowest two bits from the register in the example above::
1515 testpmd> read regfield 0 0xEE00 0 1
1516 port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)
1521 Display a single port register bit::
1523 testpmd> read regbit (port_id) (address) (bit_x)
1525 For example, reading the lowest bit from the register in the example above::
1527 testpmd> read regbit 0 0xEE00 0
1528 port 0 PCI register at offset 0xEE00: bit 0=1
1533 Set the value of a port register::
1535 testpmd> write reg (port_id) (address) (value)
1537 For example, to clear a register::
1539 testpmd> write reg 0 0xEE00 0x0
1540 port 0 PCI register at offset 0xEE00: 0x00000000 (0)
1545 Set bit field of a port register::
1547 testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)
1549 For example, writing to the register cleared in the example above::
1551 testpmd> write regfield 0 0xEE00 0 1 2
1552 port 0 PCI register at offset 0xEE00: 0x00000002 (2)
1557 Set single bit value of a port register::
1559 testpmd> write regbit (port_id) (address) (bit_x) (value)
1561 For example, to set the high bit in the register from the example above::
1563 testpmd> write regbit 0 0xEE00 31 1
1564 port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
1570 This section details the available filter functions that are available.
1573 ~~~~~~~~~~~~~~~~~~~~
1575 Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue::
1577 ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
1578 ethertype (ether_type) (drop|fwd) queue (queue_id)
1580 The available information parameters are:
1582 * ``port_id``: The port which the Ethertype filter assigned on.
1584 * ``mac_addr``: Compare destination mac address.
1586 * ``mac_ignr``: Ignore destination mac address match.
1588 * ``mac_address``: Destination mac address to match.
1590 * ``ether_type``: The EtherType value want to match,
1591 for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
1593 * ``queue_id``: The receive queue associated with this EtherType filter.
1594 It is meaningless when deleting or dropping.
1596 Example, to add/remove an ethertype filter rule::
1598 testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
1599 ethertype 0x0806 fwd queue 3
1601 testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
1602 ethertype 0x0806 fwd queue 3
1607 Add or delete a 2-tuple filter,
1608 which identifies packets by specific protocol and destination TCP/UDP port
1609 and forwards packets into one of the receive queues::
1611 2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
1612 protocol (protocol_value) mask (mask_value) \
1613 tcp_flags (tcp_flags_value) priority (prio_value) \
1616 The available information parameters are:
1618 * ``port_id``: The port which the 2-tuple filter assigned on.
1620 * ``dst_port_value``: Destination port in L4.
1622 * ``protocol_value``: IP L4 protocol.
1624 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate.
1626 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
1628 * ``prio_value``: Priority of this filter.
1630 * ``queue_id``: The receive queue associated with this 2-tuple filter.
1632 Example, to add/remove an 2tuple filter rule::
1634 testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
1635 tcp_flags 0x02 priority 3 queue 3
1637 testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
1638 tcp_flags 0x02 priority 3 queue 3
1643 Add or delete a 5-tuple filter,
1644 which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port)
1645 and routes packets into one of the receive queues::
1647 5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
1648 (src_address) dst_port (dst_port_value) \
1649 src_port (src_port_value) protocol (protocol_value) \
1650 mask (mask_value) tcp_flags (tcp_flags_value) \
1651 priority (prio_value) queue (queue_id)
1653 The available information parameters are:
1655 * ``port_id``: The port which the 5-tuple filter assigned on.
1657 * ``dst_address``: Destination IP address.
1659 * ``src_address``: Source IP address.
1661 * ``dst_port_value``: TCP/UDP destination port.
1663 * ``src_port_value``: TCP/UDP source port.
1665 * ``protocol_value``: L4 protocol.
1667 * ``mask_value``: Participates in the match or not by bit for field above, 1b means participate
1669 * ``tcp_flags_value``: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
1671 * ``prio_value``: The priority of this filter.
1673 * ``queue_id``: The receive queue associated with this 5-tuple filter.
1675 Example, to add/remove an 5tuple filter rule::
1677 testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1678 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1679 flags 0x0 priority 3 queue 3
1681 testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
1682 dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
1683 flags 0x0 priority 3 queue 3
1688 Using the SYN filter, TCP packets whose *SYN* flag is set can be forwarded to a separate queue::
1690 syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)
1692 The available information parameters are:
1694 * ``port_id``: The port which the SYN filter assigned on.
1696 * ``high``: This SYN filter has higher priority than other filters.
1698 * ``low``: This SYN filter has lower priority than other filters.
1700 * ``queue_id``: The receive queue associated with this SYN filter
1704 testpmd> syn_filter 0 add priority high queue 3
1709 With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
1710 and routed into one of the receive queues::
1712 flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
1713 mask (mask_value) priority (prio_value) queue (queue_id)
1715 The available information parameters are:
1717 * ``port_id``: The port which the Flex filter is assigned on.
1719 * ``len_value``: Filter length in bytes, no greater than 128.
1721 * ``bytes_value``: A string in hexadecimal, means the value the flex filter needs to match.
1723 * ``mask_value``: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
1725 * ``prio_value``: The priority of this filter.
1727 * ``queue_id``: The receive queue associated with this Flex filter.
1731 testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
1732 mask 000C priority 3 queue 3
1734 testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
1735 mask 000C priority 3 queue 3
1738 .. _testpmd_flow_director:
1740 flow_director_filter
1741 ~~~~~~~~~~~~~~~~~~~~
1743 The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
1745 Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and
1746 Perfect-tunnel filters, the match mode is set by the ``--pkt-filter-mode`` command-line parameter:
1748 * Perfect match filters.
1749 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1750 The masked fields are for IP flow.
1752 * Signature filters.
1753 The hardware checks a match between a hash-based signature of the masked fields of the received packet.
1755 * Perfect-mac-vlan match filters.
1756 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1757 The masked fields are for MAC VLAN flow.
1759 * Perfect-tunnel match filters.
1760 The hardware checks a match between the masked fields of the received packets and the programmed filters.
1761 The masked fields are for tunnel flow.
1763 The Flow Director filters can match the different fields for different type of packet: flow type, specific input set
1764 per flow type and the flexible payload.
1766 The Flow Director can also mask out parts of all of these fields so that filters
1767 are only applied to certain fields or parts of the fields.
1769 Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.
1771 # Commands to add flow director filters of different flow types::
1773 flow_director_filter (port_id) mode IP (add|del|update) \
1774 flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag) \
1775 src (src_ip_address) dst (dst_ip_address) \
1776 tos (tos_value) proto (proto_value) ttl (ttl_value) \
1777 vlan (vlan_value) flexbytes (flexbytes_value) \
1778 (drop|fwd) pf|vf(vf_id) queue (queue_id) \
1781 flow_director_filter (port_id) mode IP (add|del|update) \
1782 flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
1783 src (src_ip_address) (src_port) \
1784 dst (dst_ip_address) (dst_port) \
1785 tos (tos_value) ttl (ttl_value) \
1786 vlan (vlan_value) flexbytes (flexbytes_value) \
1787 (drop|fwd) queue pf|vf(vf_id) (queue_id) \
1790 flow_director_filter (port_id) mode IP (add|del|update) \
1791 flow (ipv4-sctp|ipv6-sctp) \
1792 src (src_ip_address) (src_port) \
1793 dst (dst_ip_address) (dst_port) \
1794 tos (tos_value) ttl (ttl_value) \
1795 tag (verification_tag) vlan (vlan_value) \
1796 flexbytes (flexbytes_value) (drop|fwd) \
1797 pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)
1799 flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
1800 ether (ethertype) flexbytes (flexbytes_value) \
1801 (drop|fwd) pf|vf(vf_id) queue (queue_id)
1804 flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
1805 mac (mac_address) vlan (vlan_value) \
1806 flexbytes (flexbytes_value) (drop|fwd) \
1807 queue (queue_id) fd_id (fd_id_value)
1809 flow_director_filter (port_id) mode Tunnel (add|del|update) \
1810 mac (mac_address) vlan (vlan_value) \
1811 tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
1812 flexbytes (flexbytes_value) (drop|fwd) \
1813 queue (queue_id) fd_id (fd_id_value)
1815 For example, to add an ipv4-udp flow type filter::
1817 testpmd> flow_director_filter 0 mode IP add flow ipv4-udp src 2.2.2.3 32 \
1818 dst 2.2.2.5 33 tos 2 ttl 40 vlan 0x1 flexbytes (0x88,0x48) \
1819 fwd pf queue 1 fd_id 1
1821 For example, add an ipv4-other flow type filter::
1823 testpmd> flow_director_filter 0 mode IP add flow ipv4-other src 2.2.2.3 \
1824 dst 2.2.2.5 tos 2 proto 20 ttl 40 vlan 0x1 \
1825 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1
1830 Flush all flow director filters on a device::
1832 testpmd> flush_flow_director (port_id)
1834 Example, to flush all flow director filter on port 0::
1836 testpmd> flush_flow_director 0
1841 Set flow director's input masks::
1843 flow_director_mask (port_id) mode IP vlan (vlan_value) \
1844 src_mask (ipv4_src) (ipv6_src) (src_port) \
1845 dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
1847 flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) \
1850 flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
1851 mac (mac_value) tunnel-type (tunnel_type_value) \
1852 tunnel-id (tunnel_id_value)
1854 Example, to set flow director mask on port 0::
1856 testpmd> flow_director_mask 0 mode IP vlan 0xefff \
1857 src_mask 255.255.255.255 \
1858 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
1859 dst_mask 255.255.255.255 \
1860 FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF
1862 flow_director_flex_mask
1863 ~~~~~~~~~~~~~~~~~~~~~~~
1865 set masks of flow director's flexible payload based on certain flow type::
1867 testpmd> flow_director_flex_mask (port_id) \
1868 flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1869 ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
1870 l2_payload|all) (mask)
1872 Example, to set flow director's flex mask for all flow type on port 0::
1874 testpmd> flow_director_flex_mask 0 flow all \
1875 (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
1878 flow_director_flex_payload
1879 ~~~~~~~~~~~~~~~~~~~~~~~~~~
1881 Configure flexible payload selection::
1883 flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)
1885 For example, to select the first 16 bytes from the offset 4 (bytes) of packet's payload as flexible payload::
1887 testpmd> flow_director_flex_payload 0 l4 \
1888 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
1890 get_sym_hash_ena_per_port
1891 ~~~~~~~~~~~~~~~~~~~~~~~~~
1893 Get symmetric hash enable configuration per port::
1895 get_sym_hash_ena_per_port (port_id)
1897 For example, to get symmetric hash enable configuration of port 1::
1899 testpmd> get_sym_hash_ena_per_port 1
1901 set_sym_hash_ena_per_port
1902 ~~~~~~~~~~~~~~~~~~~~~~~~~
1904 Set symmetric hash enable configuration per port to enable or disable::
1906 set_sym_hash_ena_per_port (port_id) (enable|disable)
1908 For example, to set symmetric hash enable configuration of port 1 to enable::
1910 testpmd> set_sym_hash_ena_per_port 1 enable
1912 get_hash_global_config
1913 ~~~~~~~~~~~~~~~~~~~~~~
1915 Get the global configurations of hash filters::
1917 get_hash_global_config (port_id)
1919 For example, to get the global configurations of hash filters of port 1::
1921 testpmd> get_hash_global_config 1
1923 set_hash_global_config
1924 ~~~~~~~~~~~~~~~~~~~~~~
1926 Set the global configurations of hash filters::
1928 set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
1929 (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
1930 ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \
1933 For example, to enable simple_xor for flow type of ipv6 on port 2::
1935 testpmd> set_hash_global_config 2 simple_xor ipv6 enable
1940 Set the input set for hash::
1942 set_hash_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1943 ipv4-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
1944 l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
1945 ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
1946 tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
1947 udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
1948 fld-8th|none) (select|add)
1950 For example, to add source IP to hash input set for flow type of ipv4-udp on port 0::
1952 testpmd> set_hash_input_set 0 ipv4-udp src-ipv4 add
1957 The Flow Director filters can match the different fields for different type of packet, i.e. specific input set
1958 on per flow type and the flexible payload. This command can be used to change input set for each flow type.
1960 Set the input set for flow director::
1962 set_fdir_input_set (port_id) (ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
1963 ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
1964 l2_payload) (ivlan|ethertype|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
1965 ipv4-proto|ipv4-ttl|ipv6-tc|ipv6-next-header|ipv6-hop-limits| \
1966 tudp-src-port|udp-dst-port|cp-src-port|tcp-dst-port|sctp-src-port| \
1967 sctp-dst-port|sctp-veri-tag|none) (select|add)
1969 For example to add source IP to FD input set for flow type of ipv4-udp on port 0::
1971 testpmd> set_fdir_input_set 0 ipv4-udp src-ipv4 add
1976 Set different GRE key length for input set::
1978 global_config (port_id) gre-key-len (number in bytes)
1980 For example to set GRE key length for input set to 4 bytes on port 0::
1982 testpmd> global_config 0 gre-key-len 4