4. Testpmd Runtime Functions

Where the testpmd application is started in interactive mode, (-i|--interactive), it displays a prompt that can be used to start and stop forwarding, configure the application, display statistics, set the Flow Director and other tasks:

testpmd>

The testpmd prompt has some, limited, readline support. 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 as well as access to the command history via the up-arrow.

There is also support for tab completion. If you type a partial command and hit <TAB> you get a list of the available completions:

testpmd> show port <TAB>

    info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
    info [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
    stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc X
    stats [Mul-choice STRING]: show|clear port info|stats|fdir|stat_qmap|dcb_tc all
    ...

Note

Some examples in this document are too long to fit on one line are are shown wrapped at “\” for display purposes:

testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
         (pause_time) (send_xon) (port_id)

In the real testpmd> prompt these commands should be on a single line.

4.1. Help Functions

The testpmd has on-line help for the functions that are available at runtime. These are divided into sections and can be accessed using help, help section or help all:

testpmd> help

    help control    : Start and stop forwarding.
    help display    : Displaying port, stats and config information.
    help config     : Configuration information.
    help ports      : Configuring ports.
    help registers  : Reading and setting port registers.
    help filters    : Filters configuration help.
    help all        : All of the above sections.

4.2. Control Functions

4.2.1. start

Start packet forwarding with current configuration:

testpmd> start

4.2.2. start tx_first

Start packet forwarding with current configuration after sending one burst of packets:

testpmd> start tx_first

4.2.3. stop

Stop packet forwarding, and display accumulated statistics:

testpmd> stop

4.2.4. quit

Quit to prompt:

testpmd> quit

4.3. Display Functions

The functions in the following sections are used to display information about the testpmd configuration or the NIC status.

4.3.1. show port

Display information for a given port or all ports:

testpmd> show port (info|stats|fdir|stat_qmap|dcb_tc) (port_id|all)

The available information categories are:

  • info: General port information such as MAC address.
  • stats: RX/TX statistics.
  • fdir: Flow Director information and statistics.
  • stat_qmap: Queue statistics mapping.
  • dcb_tc: DCB information such as TC mapping.

For example:

testpmd> show port info 0

********************* Infos for port 0 *********************

MAC address: XX:XX:XX:XX:XX:XX
Connect to socket: 0
memory allocation on the socket: 0
Link status: up
Link speed: 40000 Mbps
Link duplex: full-duplex
Promiscuous mode: enabled
Allmulticast mode: disabled
Maximum number of MAC addresses: 64
Maximum number of MAC addresses of hash filtering: 0
VLAN offload:
    strip on
    filter on
    qinq(extend) off
Redirection table size: 512
Supported flow types:
  ipv4-frag
  ipv4-tcp
  ipv4-udp
  ipv4-sctp
  ipv4-other
  ipv6-frag
  ipv6-tcp
  ipv6-udp
  ipv6-sctp
  ipv6-other
  l2_payload

4.3.2. show port rss reta

Display the rss redirection table entry indicated by masks on port X:

testpmd> show port (port_id) rss reta (size) (mask0, mask1...)

size is used to indicate the hardware supported reta size

4.3.3. show port rss-hash

Display the RSS hash functions and RSS hash key of a port:

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]

4.3.4. clear port

Clear the port statistics for a given port or for all ports:

testpmd> clear port (info|stats|fdir|stat_qmap) (port_id|all)

For example:

testpmd> clear port stats all

4.3.5. show (rxq|txq)

Display information for a given port’s RX/TX queue:

testpmd> show (rxq|txq) info (port_id) (queue_id)

4.3.6. show config

Displays the configuration of the application. The configuration comes from the command-line, the runtime or the application defaults:

testpmd> show config (rxtx|cores|fwd|txpkts)

The available information categories are:

  • rxtx: RX/TX configuration items.
  • cores: List of forwarding cores.
  • fwd: Packet forwarding configuration.
  • txpkts: Packets to TX configuration.

For example:

testpmd> show config rxtx

io packet forwarding - CRC stripping disabled - packets/burst=16
nb forwarding cores=2 - nb forwarding ports=1
RX queues=1 - RX desc=128 - RX free threshold=0
RX threshold registers: pthresh=8 hthresh=8 wthresh=4
TX queues=1 - TX desc=512 - TX free threshold=0
TX threshold registers: pthresh=36 hthresh=0 wthresh=0
TX RS bit threshold=0 - TXQ flags=0x0

4.3.7. set fwd

Set the packet forwarding mode:

testpmd> set fwd (io|mac|mac_retry|macswap|flowgen| \
                  rxonly|txonly|csum|icmpecho)

The available information categories are:

  • io: Forwards packets “as-is” in I/O mode. This is the fastest possible forwarding operation as it does not access packets data. This is the default mode.
  • mac: Changes the source and the destination Ethernet addresses of packets before forwarding them.
  • mac_retry: Same as “mac” forwarding mode, but includes retries if the destination queue is full.
  • macswap: MAC swap forwarding mode. Swaps the source and the destination Ethernet addresses of packets before forwarding them.
  • flowgen: Multi-flow generation mode. Originates a number of flows (with varying destination IP addresses), and terminate receive traffic.
  • rxonly: Receives packets but doesn’t transmit them.
  • txonly: Generates and transmits packets without receiving any.
  • csum: Changes the checksum field with hardware or software methods depending on the offload flags on the packet.
  • icmpecho: Receives a burst of packets, lookup for IMCP echo requests and, if any, send back ICMP echo replies.
  • ieee1588: Demonstrate L2 IEEE1588 V2 PTP timestamping for RX and TX. Requires CONFIG_RTE_LIBRTE_IEEE1588=y.

Note: TX timestamping is only available in the “Full Featured” TX path. To force testpmd into this mode set --txqflags=0.

Example:

testpmd> set fwd rxonly

Set rxonly packet forwarding mode

4.3.8. read rxd

Display an RX descriptor for a port RX queue:

testpmd> read rxd (port_id) (queue_id) (rxd_id)

For example:

testpmd> read rxd 0 0 4
     0x0000000B - 0x001D0180 / 0x0000000B - 0x001D0180

4.3.9. read txd

Display a TX descriptor for a port TX queue:

testpmd> read txd (port_id) (queue_id) (txd_id)

For example:

testpmd> read txd 0 0 4
     0x00000001 - 0x24C3C440 / 0x000F0000 - 0x2330003C

4.4. Configuration Functions

The testpmd application can be configured from the runtime as well as from the command-line.

This section details the available configuration functions that are available.

Note

Configuration changes only become active when forwarding is started/restarted.

4.4.1. set default

Reset forwarding to the default configuration:

testpmd> set default

4.4.2. set verbose

Set the debug verbosity level:

testpmd> set verbose (level)

Currently the only available levels are 0 (silent except for error) and 1 (fully verbose).

4.4.3. set nbport

Set the number of ports used by the application:

set nbport (num)

This is equivalent to the --nb-ports command-line option.

4.4.4. set nbcore

Set the number of cores used by the application:

testpmd> set nbcore (num)

This is equivalent to the --nb-cores command-line option.

Note

The number of cores used must not be greater than number of ports used multiplied by the number of queues per port.

4.4.5. set coremask

Set the forwarding cores hexadecimal mask:

testpmd> set coremask (mask)

This is equivalent to the --coremask command-line option.

Note

The master lcore is reserved for command line parsing only and cannot be masked on for packet forwarding.

4.4.6. set portmask

Set the forwarding ports hexadecimal mask:

testpmd> set portmask (mask)

This is equivalent to the --portmask command-line option.

4.4.7. set burst

Set number of packets per burst:

testpmd> set burst (num)

This is equivalent to the --burst command-line option.

In mac_retry forwarding mode, the transmit delay time and number of retries can also be set:

testpmd> set burst tx delay (micrseconds) retry (num)

4.4.8. set txpkts

Set the length of each segment of the TX-ONLY packets:

testpmd> set txpkts (x[,y]*)

Where x[,y]* represents a CSV list of values, without white space.

4.4.9. set txsplit

Set the split policy for the TX packets, applicable for TX-ONLY and CSUM forwarding modes:

testpmd> set txsplit (off|on|rand)

Where:

  • off disable packet copy & split for CSUM mode.
  • on split outgoing packet into multiple segments. Size of each segment and number of segments per packet is determined by set txpkts command (see above).
  • rand same as ‘on’, but number of segments per each packet is a random value between 1 and total number of segments.

4.4.10. set corelist

Set the list of forwarding cores:

testpmd> set corelist (x[,y]*)

For example, to change the forwarding cores:

testpmd> set corelist 3,1
testpmd> show config fwd

io packet forwarding - ports=2 - cores=2 - streams=2 - NUMA support disabled
Logical Core 3 (socket 0) forwards packets on 1 streams:
RX P=0/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:01
Logical Core 1 (socket 0) forwards packets on 1 streams:
RX P=1/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00

Note

The cores are used in the same order as specified on the command line.

4.4.11. set portlist

Set the list of forwarding ports:

testpmd> set portlist (x[,y]*)

For example, to change the port forwarding:

testpmd> set portlist 0,2,1,3
testpmd> show config fwd

io packet forwarding - ports=4 - cores=1 - streams=4
Logical Core 3 (socket 0) forwards packets on 4 streams:
RX P=0/Q=0 (socket 0) -> TX P=2/Q=0 (socket 0) peer=02:00:00:00:00:01
RX P=2/Q=0 (socket 0) -> TX P=0/Q=0 (socket 0) peer=02:00:00:00:00:00
RX P=1/Q=0 (socket 0) -> TX P=3/Q=0 (socket 0) peer=02:00:00:00:00:03
RX P=3/Q=0 (socket 0) -> TX P=1/Q=0 (socket 0) peer=02:00:00:00:00:02

4.4.12. vlan set strip

Set the VLAN strip on a port:

testpmd> vlan set strip (on|off) (port_id)

4.4.13. vlan set stripq

Set the VLAN strip for a queue on a port:

testpmd> vlan set stripq (on|off) (port_id,queue_id)

4.4.14. vlan set filter

Set the VLAN filter on a port:

testpmd> vlan set filter (on|off) (port_id)

4.4.15. vlan set qinq

Set the VLAN QinQ (extended queue in queue) on for a port:

testpmd> vlan set qinq (on|off) (port_id)

4.4.16. vlan set tpid

Set the outer VLAN TPID for packet filtering on a port:

testpmd> vlan set tpid (value) (port_id)

Note

TPID value must be a 16-bit number (value <= 65536).

4.4.17. rx_vlan add

Add a VLAN ID, or all identifiers, to the set of VLAN identifiers filtered by port ID:

testpmd> rx_vlan add (vlan_id|all) (port_id)

Note

VLAN filter must be set on that port. VLAN ID < 4096. Depending on the NIC used, number of vlan_ids may be limited to the maximum entries in VFTA table. This is important if enabling all vlan_ids.

4.4.18. rx_vlan rm

Remove a VLAN ID, or all identifiers, from the set of VLAN identifiers filtered by port ID:

testpmd> rx_vlan rm (vlan_id|all) (port_id)

4.4.19. rx_vlan add (for VF)

Add a VLAN ID, to the set of VLAN identifiers filtered for VF(s) for port ID:

testpmd> rx_vlan add (vlan_id) port (port_id) vf (vf_mask)

4.4.20. rx_vlan rm (for VF)

Remove a VLAN ID, from the set of VLAN identifiers filtered for VF(s) for port ID:

testpmd> rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)

4.4.21. rx_vlan set tpid

Set the outer VLAN TPID for packet filtering on a port:

testpmd> rx_vlan set tpid (value) (port_id)

4.4.22. tunnel_filter add

Add a tunnel filter on a port:

testpmd> tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) \
         (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id)

4.4.23. tunnel_filter remove

Remove a tunnel filter on a port:

testpmd> tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) \
         (inner_vlan) (tunnel_type) (filter_type) (tenant_id) (queue_id)

4.4.24. rx_vxlan_port add

Add an UDP port for VXLAN packet filter on a port:

testpmd> rx_vxlan_port add (udp_port) (port_id)

4.4.25. rx_vxlan_port remove

Remove an UDP port for VXLAN packet filter on a port:

testpmd> rx_vxlan_port rm (udp_port) (port_id)

4.4.26. tx_vlan set

Set hardware insertion of VLAN IDs in packets sent on a port:

testpmd> tx_vlan set (port_id) vlan_id[, vlan_id_outer]

For example, set a single VLAN ID (5) insertion on port 0:

tx_vlan set 0 5

Or, set double VLAN ID (inner: 2, outer: 3) insertion on port 1:

tx_vlan set 1 2 3

4.4.27. tx_vlan set pvid

Set port based hardware insertion of VLAN ID in packets sent on a port:

testpmd> tx_vlan set pvid (port_id) (vlan_id) (on|off)

4.4.28. tx_vlan reset

Disable hardware insertion of a VLAN header in packets sent on a port:

testpmd> tx_vlan reset (port_id)

4.4.29. csum set

Select hardware or software calculation of the checksum when transmitting a packet using the csum forwarding engine:

testpmd> csum set (ip|udp|tcp|sctp|outer-ip) (hw|sw) (port_id)

Where:

  • ip|udp|tcp|sctp always relate to the inner layer.
  • outer-ip relates to the outer IP layer (only for IPv4) in the case where the packet is recognized as a tunnel packet by the forwarding engine (vxlan, gre and ipip are supported). See also the csum parse-tunnel command.

Note

Check the NIC Datasheet for hardware limits.

4.4.30. csum parse-tunnel

Define how tunneled packets should be handled by the csum forward engine:

testpmd> csum parse-tunnel (on|off) (tx_port_id)

If enabled, the csum forward engine will try to recognize supported tunnel headers (vxlan, gre, ipip).

If disabled, treat tunnel packets as non-tunneled packets (a inner header is handled as a packet payload).

Note

The port argument is the TX port like in the csum set command.

Example:

Consider a packet in packet like the following:

eth_out/ipv4_out/udp_out/vxlan/eth_in/ipv4_in/tcp_in

  • If parse-tunnel is enabled, the ip|udp|tcp|sctp parameters of csum set command relate to the inner headers (here ipv4_in and tcp_in), and the outer-ip parameter relates to the outer headers (here ipv4_out).

  • If parse-tunnel is disabled, the ip|udp|tcp|sctp parameters of csum  set

    command relate to the outer headers, here ipv4_out and udp_out.

4.4.31. csum show

Display tx checksum offload configuration:

testpmd> csum show (port_id)

4.4.32. tso set

Enable TCP Segmentation Offload (TSO) in the csum forwarding engine:

testpmd> tso set (segsize) (port_id)

Note

Check the NIC datasheet for hardware limits.

4.4.33. tso show

Display the status of TCP Segmentation Offload:

testpmd> tso show (port_id)

4.4.34. mac_addr add

Add an alternative MAC address to a port:

testpmd> mac_addr add (port_id) (XX:XX:XX:XX:XX:XX)

4.4.35. mac_addr remove

Remove a MAC address from a port:

testpmd> mac_addr remove (port_id) (XX:XX:XX:XX:XX:XX)

4.4.36. mac_addr add(for VF)

Add an alternative MAC address for a VF to a port:

testpmd> mac_add add port (port_id) vf (vf_id) (XX:XX:XX:XX:XX:XX)

4.4.37. set port-uta

Set the unicast hash filter(s) on/off for a port:

testpmd> set port (port_id) uta (XX:XX:XX:XX:XX:XX|all) (on|off)

4.4.38. set promisc

Set the promiscuous mode on for a port or for all ports. In promiscuous mode packets are not dropped if they aren’t for the specified MAC address:

testpmd> set promisc (port_id|all) (on|off)

4.4.39. set allmulti

Set the allmulti mode for a port or for all ports:

testpmd> set allmulti (port_id|all) (on|off)

Same as the ifconfig (8) option. Controls how multicast packets are handled.

4.4.40. set flow_ctrl rx

Set the link flow control parameter on a port:

testpmd> set flow_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
         (pause_time) (send_xon) mac_ctrl_frame_fwd (on|off) \
         autoneg (on|off) (port_id)

Where:

  • high_water (integer): High threshold value to trigger XOFF.
  • low_water (integer): Low threshold value to trigger XON.
  • pause_time (integer): Pause quota in the Pause frame.
  • send_xon (0/1): Send XON frame.
  • mac_ctrl_frame_fwd: Enable receiving MAC control frames.
  • autoneg: Change the auto-negotiation para mete.

4.4.41. set pfc_ctrl rx

Set the priority flow control parameter on a port:

testpmd> set pfc_ctrl rx (on|off) tx (on|off) (high_water) (low_water) \
         (pause_time) (priority) (port_id)

Where:

  • high_water (integer): High threshold value.
  • low_water (integer): Low threshold value.
  • pause_time (integer): Pause quota in the Pause frame.
  • priority (0-7): VLAN User Priority.

4.4.42. set stat_qmap

Set statistics mapping (qmapping 0..15) for RX/TX queue on port:

testpmd> set stat_qmap (tx|rx) (port_id) (queue_id) (qmapping)

For example, to set rx queue 2 on port 0 to mapping 5:

testpmd>set stat_qmap rx 0 2 5

4.4.43. set port - rx/tx (for VF)

Set VF receive/transmit from a port:

testpmd> set port (port_id) vf (vf_id) (rx|tx) (on|off)

4.4.44. set port - mac address filter (for VF)

Add/Remove unicast or multicast MAC addr filter for a VF:

testpmd> set port (port_id) vf (vf_id) (mac_addr) \
         (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)

4.4.45. set port - rx mode(for VF)

Set the VF receive mode of a port:

testpmd> set port (port_id) vf (vf_id) \
         rxmode (AUPE|ROPE|BAM|MPE) (on|off)

The available receive modes are:

  • AUPE: Accepts untagged VLAN.
  • ROPE: Accepts unicast hash.
  • BAM: Accepts broadcast packets.
  • MPE: Accepts all multicast packets.

4.4.46. set port - tx_rate (for Queue)

Set TX rate limitation for a queue on a port:

testpmd> set port (port_id) queue (queue_id) rate (rate_value)

4.4.47. set port - tx_rate (for VF)

Set TX rate limitation for queues in VF on a port:

testpmd> set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)

4.4.48. set port - mirror rule

Set pool or vlan type mirror rule for a port:

testpmd> set port (port_id) mirror-rule (rule_id) \
         (pool-mirror-up|pool-mirror-down|vlan-mirror) \
         (poolmask|vlanid[,vlanid]*) dst-pool (pool_id) (on|off)

Set link mirror rule for a port:

testpmd> set port (port_id) mirror-rule (rule_id) \
        (uplink-mirror|downlink-mirror) dst-pool (pool_id) (on|off)

For example to enable mirror traffic with vlan 0,1 to pool 0:

set port 0 mirror-rule 0 vlan-mirror 0,1 dst-pool 0 on

4.4.49. reset port - mirror rule

Reset a mirror rule for a port:

testpmd> reset port (port_id) mirror-rule (rule_id)

4.4.50. set flush_rx

Set the flush on RX streams before forwarding. The default is flush on. Mainly used with PCAP drivers to turn off the default behavior of flushing the first 512 packets on RX streams:

testpmd> set flush_rx off

4.4.51. set bypass mode

Set the bypass mode for the lowest port on bypass enabled NIC:

testpmd> set bypass mode (normal|bypass|isolate) (port_id)

4.4.52. set bypass event

Set the event required to initiate specified bypass mode for the lowest port on a bypass enabled:

testpmd> set bypass event (timeout|os_on|os_off|power_on|power_off) \
         mode (normal|bypass|isolate) (port_id)

Where:

  • timeout: Enable bypass after watchdog timeout.
  • os_on: Enable bypass when OS/board is powered on.
  • os_off: Enable bypass when OS/board is powered off.
  • power_on: Enable bypass when power supply is turned on.
  • power_off: Enable bypass when power supply is turned off.

4.4.53. set bypass timeout

Set the bypass watchdog timeout to n seconds where 0 = instant:

testpmd> set bypass timeout (0|1.5|2|3|4|8|16|32)

4.4.54. show bypass config

Show the bypass configuration for a bypass enabled NIC using the lowest port on the NIC:

testpmd> show bypass config (port_id)

4.5. Port Functions

The following sections show functions for configuring ports.

Note

Port configuration changes only become active when forwarding is started/restarted.

4.5.1. port attach

Attach a port specified by pci address or virtual device args.

To attach a new pci device, the device should be recognized by kernel first. Then it should be moved under DPDK management. Finally the port can be attached to testpmd.

For example, to move a pci device using ixgbe under DPDK management:

# Check the status of the available devices.
./tools/dpdk_nic_bind.py --status

Network devices using DPDK-compatible driver
============================================
<none>

Network devices using kernel driver
===================================
0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=


# Bind the device to igb_uio.
sudo ./tools/dpdk_nic_bind.py -b igb_uio 0000:0a:00.0


# Recheck the status of the devices.
./tools/dpdk_nic_bind.py --status
Network devices using DPDK-compatible driver
============================================
0000:0a:00.0 '82599ES 10-Gigabit' drv=igb_uio unused=

To attach a port created by virtual device, above steps are not needed.

port attach (identifier)

For example, to attach a port whose pci address is 0000:0a:00.0.

testpmd> port attach 0000:0a:00.0
Attaching a new port...
EAL: PCI device 0000:0a:00.0 on NUMA socket -1
EAL:   probe driver: 8086:10fb rte_ixgbe_pmd
EAL:   PCI memory mapped at 0x7f83bfa00000
EAL:   PCI memory mapped at 0x7f83bfa80000
PMD: eth_ixgbe_dev_init(): MAC: 2, PHY: 18, SFP+: 5
PMD: eth_ixgbe_dev_init(): port 0 vendorID=0x8086 deviceID=0x10fb
Port 0 is attached. Now total ports is 1
Done

For example, to attach a port created by pcap PMD.

testpmd> port attach eth_pcap0
Attaching a new port...
PMD: Initializing pmd_pcap for eth_pcap0
PMD: Creating pcap-backed ethdev on numa socket 0
Port 0 is attached. Now total ports is 1
Done

In this case, identifier is eth_pcap0. This identifier format is the same as --vdev format of DPDK applications.

For example, to re-attach a bonded port which has been previously detached, the mode and slave parameters must be given.

testpmd> port attach eth_bond_0,mode=0,slave=1
Attaching a new port...
EAL: Initializing pmd_bond for eth_bond_0
EAL: Create bonded device eth_bond_0 on port 0 in mode 0 on socket 0.
Port 0 is attached. Now total ports is 1
Done

4.5.2. port detach

Detach a specific port.

Before detaching a port, the port should be closed:

testpmd> port detach (port_id)

For example, to detach a pci device port 0.

testpmd> port close 0
Closing ports...
Done

testpmd> port detach 0
Detaching a port...
EAL: PCI device 0000:0a:00.0 on NUMA socket -1
EAL:   remove driver: 8086:10fb rte_ixgbe_pmd
EAL:   PCI memory unmapped at 0x7f83bfa00000
EAL:   PCI memory unmapped at 0x7f83bfa80000
Done

For example, to detach a virtual device port 0.

testpmd> port close 0
Closing ports...
Done

testpmd> port detach 0
Detaching a port...
PMD: Closing pcap ethdev on numa socket 0
Port 'eth_pcap0' is detached. Now total ports is 0
Done

To remove a pci device completely from the system, first detach the port from testpmd. Then the device should be moved under kernel management. Finally the device can be removed using kernel pci hotplug functionality.

For example, to move a pci device under kernel management:

sudo ./tools/dpdk_nic_bind.py -b ixgbe 0000:0a:00.0

./tools/dpdk_nic_bind.py --status

Network devices using DPDK-compatible driver
============================================
<none>

Network devices using kernel driver
===================================
0000:0a:00.0 '82599ES 10-Gigabit' if=eth2 drv=ixgbe unused=igb_uio

To remove a port created by a virtual device, above steps are not needed.

4.5.3. port start

Start all ports or a specific port:

testpmd> port start (port_id|all)

4.5.4. port stop

Stop all ports or a specific port:

testpmd> port stop (port_id|all)

4.5.5. port close

Close all ports or a specific port:

testpmd> port close (port_id|all)

4.5.6. port start/stop queue

Start/stop a rx/tx queue on a specific port:

testpmd> port (port_id) (rxq|txq) (queue_id) (start|stop)

Only take effect when port is started.

4.5.7. port config - speed

Set the speed and duplex mode for all ports or a specific port:

testpmd> port config (port_id|all) speed (10|100|1000|10000|auto) \
         duplex (half|full|auto)

4.5.8. port config - queues/descriptors

Set number of queues/descriptors for rxq, txq, rxd and txd:

testpmd> port config all (rxq|txq|rxd|txd) (value)

This is equivalent to the --rxq, --txq, --rxd and --txd command-line options.

4.5.9. port config - max-pkt-len

Set the maximum packet length:

testpmd> port config all max-pkt-len (value)

This is equivalent to the --max-pkt-len command-line option.

4.5.10. port config - CRC Strip

Set hardware CRC stripping on or off for all ports:

testpmd> port config all crc-strip (on|off)

CRC stripping is off by default.

The on option is equivalent to the --crc-strip command-line option.

4.5.11. port config - RX Checksum

Set hardware RX checksum offload to on or off for all ports:

testpmd> port config all rx-cksum (on|off)

Checksum offload is off by default.

The on option is equivalent to the --enable-rx-cksum command-line option.

4.5.12. port config - VLAN

Set hardware VLAN on or off for all ports:

testpmd> port config all hw-vlan (on|off)

Hardware VLAN is on by default.

The off option is equivalent to the --disable-hw-vlan command-line option.

4.5.13. port config - VLAN filter

Set hardware VLAN filter on or off for all ports:

testpmd> port config all hw-vlan-filter (on|off)

Hardware VLAN filter is on by default.

The off option is equivalent to the --disable-hw-vlan-filter command-line option.

4.5.14. port config - VLAN strip

Set hardware VLAN strip on or off for all ports:

testpmd> port config all hw-vlan-strip (on|off)

Hardware VLAN strip is on by default.

The off option is equivalent to the --disable-hw-vlan-strip command-line option.

4.5.15. port config - VLAN extend

Set hardware VLAN extend on or off for all ports:

testpmd> port config all hw-vlan-extend (on|off)

Hardware VLAN extend is off by default.

The off option is equivalent to the --disable-hw-vlan-extend command-line option.

4.5.16. port config - Drop Packets

Set packet drop for packets with no descriptors on or off for all ports:

testpmd> port config all drop-en (on|off)

Packet dropping for packets with no descriptors is off by default.

The on option is equivalent to the --enable-drop-en command-line option.

4.5.17. port config - RSS

Set the RSS (Receive Side Scaling) mode on or off:

testpmd> port config all rss (all|ip|tcp|udp|sctp|ether|none)

RSS is on by default.

The none option is equivalent to the --disable-rss command-line option.

4.5.18. port config - RSS Reta

Set the RSS (Receive Side Scaling) redirection table:

testpmd> port config all rss reta (hash,queue)[,(hash,queue)]

4.5.19. port config - DCB

Set the DCB mode for an individual port:

testpmd> port config (port_id) dcb vt (on|off) (traffic_class) pfc (on|off)

The traffic class should be 4 or 8.

4.5.20. port config - Burst

Set the number of packets per burst:

testpmd> port config all burst (value)

This is equivalent to the --burst command-line option.

4.5.21. port config - Threshold

Set thresholds for TX/RX queues:

testpmd> port config all (threshold) (value)

Where the threshold type can be:

  • txpt: Set the prefetch threshold register of the TX rings, 0 <= value <= 255.
  • txht: Set the host threshold register of the TX rings, 0 <= value <= 255.
  • txwt: Set the write-back threshold register of the TX rings, 0 <= value <= 255.
  • rxpt: Set the prefetch threshold register of the RX rings, 0 <= value <= 255.
  • rxht: Set the host threshold register of the RX rings, 0 <= value <= 255.
  • rxwt: Set the write-back threshold register of the RX rings, 0 <= value <= 255.
  • txfreet: Set the transmit free threshold of the TX rings, 0 <= value <= txd.
  • rxfreet: Set the transmit free threshold of the RX rings, 0 <= value <= rxd.
  • txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.

These threshold options are also available from the command-line.

4.7. Register Functions

The Register Functions can be used to read from and write to registers on the network card referenced by a port number. This is mainly useful for debugging purposes. Reference should be made to the appropriate datasheet for the network card for details on the register addresses and fields that can be accessed.

4.7.1. read reg

Display the value of a port register:

testpmd> read reg (port_id) (address)

For example, to examine the Flow Director control register (FDIRCTL, 0x0000EE000) on an Intel 82599 10 GbE Controller:

testpmd> read reg 0 0xEE00
port 0 PCI register at offset 0xEE00: 0x4A060029 (1241907241)

4.7.2. read regfield

Display a port register bit field:

testpmd> read regfield (port_id) (address) (bit_x) (bit_y)

For example, reading the lowest two bits from the register in the example above:

testpmd> read regfield 0 0xEE00 0 1
port 0 PCI register at offset 0xEE00: bits[0, 1]=0x1 (1)

4.7.3. read regbit

Display a single port register bit:

testpmd> read regbit (port_id) (address) (bit_x)

For example, reading the lowest bit from the register in the example above:

testpmd> read regbit 0 0xEE00 0
port 0 PCI register at offset 0xEE00: bit 0=1

4.7.4. write reg

Set the value of a port register:

testpmd> write reg (port_id) (address) (value)

For example, to clear a register:

testpmd> write reg 0 0xEE00 0x0
port 0 PCI register at offset 0xEE00: 0x00000000 (0)

4.7.5. write regfield

Set bit field of a port register:

testpmd> write regfield (port_id) (address) (bit_x) (bit_y) (value)

For example, writing to the register cleared in the example above:

testpmd> write regfield 0 0xEE00 0 1 2
port 0 PCI register at offset 0xEE00: 0x00000002 (2)

4.7.6. write regbit

Set single bit value of a port register:

testpmd> write regbit (port_id) (address) (bit_x) (value)

For example, to set the high bit in the register from the example above:

testpmd> write regbit 0 0xEE00 31 1
port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)

4.8. Filter Functions

This section details the available filter functions that are available.

4.8.1. ethertype_filter

Add or delete a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue:

ethertype_filter (port_id) (add|del) (mac_addr|mac_ignr) (mac_address) \
                 ethertype (ether_type) (drop|fwd) queue (queue_id)

The available information parameters are:

  • port_id: The port which the Ethertype filter assigned on.
  • mac_addr: Compare destination mac address.
  • mac_ignr: Ignore destination mac address match.
  • mac_address: Destination mac address to match.
  • ether_type: The EtherType value want to match, for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
  • queue_id: The receive queue associated with this EtherType filter. It is meaningless when deleting or dropping.

Example, to add/remove an ethertype filter rule:

testpmd> ethertype_filter 0 add mac_ignr 00:11:22:33:44:55 \
                          ethertype 0x0806 fwd queue 3

testpmd> ethertype_filter 0 del mac_ignr 00:11:22:33:44:55 \
                          ethertype 0x0806 fwd queue 3

4.8.2. 2tuple_filter

Add or delete a 2-tuple filter, which identifies packets by specific protocol and destination TCP/UDP port and forwards packets into one of the receive queues:

2tuple_filter (port_id) (add|del) dst_port (dst_port_value) \
              protocol (protocol_value) mask (mask_value) \
              tcp_flags (tcp_flags_value) priority (prio_value) \
              queue (queue_id)

The available information parameters are:

  • port_id: The port which the 2-tuple filter assigned on.
  • dst_port_value: Destination port in L4.
  • protocol_value: IP L4 protocol.
  • mask_value: Participates in the match or not by bit for field above, 1b means participate.
  • tcp_flags_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
  • prio_value: Priority of this filter.
  • queue_id: The receive queue associated with this 2-tuple filter.

Example, to add/remove an 2tuple filter rule:

testpmd> 2tuple_filter 0 add dst_port 32 protocol 0x06 mask 0x03 \
                       tcp_flags 0x02 priority 3 queue 3

testpmd> 2tuple_filter 0 del dst_port 32 protocol 0x06 mask 0x03 \
                       tcp_flags 0x02 priority 3 queue 3

4.8.3. 5tuple_filter

Add or delete a 5-tuple filter, which consists of a 5-tuple (protocol, source and destination IP addresses, source and destination TCP/UDP/SCTP port) and routes packets into one of the receive queues:

5tuple_filter (port_id) (add|del) dst_ip (dst_address) src_ip \
              (src_address) dst_port (dst_port_value) \
              src_port (src_port_value) protocol (protocol_value) \
              mask (mask_value) tcp_flags (tcp_flags_value) \
              priority (prio_value) queue (queue_id)

The available information parameters are:

  • port_id: The port which the 5-tuple filter assigned on.
  • dst_address: Destination IP address.
  • src_address: Source IP address.
  • dst_port_value: TCP/UDP destination port.
  • src_port_value: TCP/UDP source port.
  • protocol_value: L4 protocol.
  • mask_value: Participates in the match or not by bit for field above, 1b means participate
  • tcp_flags_value: TCP control bits. The non-zero value is invalid, when the protocol_value is not set to 0x06 (TCP).
  • prio_value: The priority of this filter.
  • queue_id: The receive queue associated with this 5-tuple filter.

Example, to add/remove an 5tuple filter rule:

testpmd> 5tuple_filter 0 add dst_ip 2.2.2.5 src_ip 2.2.2.4 \
         dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
         flags 0x0 priority 3 queue 3

testpmd> 5tuple_filter 0 del dst_ip 2.2.2.5 src_ip 2.2.2.4 \
         dst_port 64 src_port 32 protocol 0x06 mask 0x1F \
         flags 0x0 priority 3 queue 3

4.8.4. syn_filter

Using the SYN filter, TCP packets whose SYN flag is set can be forwarded to a separate queue:

syn_filter (port_id) (add|del) priority (high|low) queue (queue_id)

The available information parameters are:

  • port_id: The port which the SYN filter assigned on.
  • high: This SYN filter has higher priority than other filters.
  • low: This SYN filter has lower priority than other filters.
  • queue_id: The receive queue associated with this SYN filter

Example:

testpmd> syn_filter 0 add priority high queue 3

4.8.5. flex_filter

With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet and routed into one of the receive queues:

flex_filter (port_id) (add|del) len (len_value) bytes (bytes_value) \
            mask (mask_value) priority (prio_value) queue (queue_id)

The available information parameters are:

  • port_id: The port which the Flex filter is assigned on.
  • len_value: Filter length in bytes, no greater than 128.
  • bytes_value: A string in hexadecimal, means the value the flex filter needs to match.
  • mask_value: A string in hexadecimal, bit 1 means corresponding byte participates in the match.
  • prio_value: The priority of this filter.
  • queue_id: The receive queue associated with this Flex filter.

Example:

testpmd> flex_filter 0 add len 16 bytes 0x00000000000000000000000008060000 \
                       mask 000C priority 3 queue 3

testpmd> flex_filter 0 del len 16 bytes 0x00000000000000000000000008060000 \
                       mask 000C priority 3 queue 3

4.8.6. flow_director_filter

The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.

Four types of filtering are supported which are referred to as Perfect Match, Signature, Perfect-mac-vlan and Perfect-tunnel filters, the match mode is set by the --pkt-filter-mode command-line parameter:

  • Perfect match filters. The hardware checks a match between the masked fields of the received packets and the programmed filters. The masked fields are for IP flow.
  • Signature filters. The hardware checks a match between a hash-based signature of the masked fields of the received packet.
  • Perfect-mac-vlan match filters. The hardware checks a match between the masked fields of the received packets and the programmed filters. The masked fields are for MAC VLAN flow.
  • Perfect-tunnel match filters. The hardware checks a match between the masked fields of the received packets and the programmed filters. The masked fields are for tunnel flow.

The Flow Director filters can match the different fields for different type of packet: flow type, specific input set per flow type and the flexible payload.

The Flow Director can also mask out parts of all of these fields so that filters are only applied to certain fields or parts of the fields.

Different NICs may have different capabilities, command show port fdir (port_id) can be used to acquire the information.

# Commands to add flow director filters of different flow types:

flow_director_filter (port_id) mode IP (add|del|update) \
                     flow (ipv4-other|ipv4-frag|ipv6-other|ipv6-frag)
                     src (src_ip_address) dst (dst_ip_address) \
                     vlan (vlan_value) flexbytes (flexbytes_value) \
                     (drop|fwd) pf|vf(vf_id) queue (queue_id) \
                     fd_id (fd_id_value)

flow_director_filter (port_id) mode IP (add|del|update) \
                     flow (ipv4-tcp|ipv4-udp|ipv6-tcp|ipv6-udp) \
                     src (src_ip_address) (src_port) \
                     dst (dst_ip_address) (dst_port) \
                     vlan (vlan_value) flexbytes (flexbytes_value) \
                     (drop|fwd) queue pf|vf(vf_id) (queue_id) \
                     fd_id (fd_id_value)

flow_director_filter (port_id) mode IP (add|del|update) \
                     flow (ipv4-sctp|ipv6-sctp) \
                     src (src_ip_address) (src_port) \
                     dst (dst_ip_address) (dst_port)
                     tag (verification_tag) vlan (vlan_value) \
                     flexbytes (flexbytes_value) (drop|fwd) \
                     pf|vf(vf_id) queue (queue_id) fd_id (fd_id_value)

flow_director_filter (port_id) mode IP (add|del|update) flow l2_payload \
                     ether (ethertype) flexbytes (flexbytes_value) \
                     (drop|fwd) pf|vf(vf_id) queue (queue_id)
                     fd_id (fd_id_value)

flow_director_filter (port_id) mode MAC-VLAN (add|del|update) \
                     mac (mac_address) vlan (vlan_value) \
                     flexbytes (flexbytes_value) (drop|fwd) \
                     queue (queue_id) fd_id (fd_id_value)

flow_director_filter (port_id) mode Tunnel (add|del|update) \
                     mac (mac_address) vlan (vlan_value) \
                     tunnel (NVGRE|VxLAN) tunnel-id (tunnel_id_value) \
                     flexbytes (flexbytes_value) (drop|fwd) \
                     queue (queue_id) fd_id (fd_id_value)

For example, to add an ipv4-udp flow type filter:

testpmd> flow_director_filter 0 add flow ipv4-udp src 2.2.2.3 32 \
         dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1

For example, add an ipv4-other flow type filter:

testpmd> flow_director_filter 0 add flow ipv4-other src 2.2.2.3 \
          dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd pf queue 1 fd_id 1

4.8.7. flush_flow_director

Flush all flow director filters on a device:

testpmd> flush_flow_director (port_id)

Example, to flush all flow director filter on port 0:

testpmd> flush_flow_director 0

4.8.8. flow_director_mask

Set flow director’s input masks:

flow_director_mask (port_id) mode IP vlan (vlan_value) \
                   src_mask (ipv4_src) (ipv6_src) (src_port) \
                   dst_mask (ipv4_dst) (ipv6_dst) (dst_port)

flow_director_mask (port_id) mode MAC-VLAN vlan (vlan_value) \
                   mac (mac_value)

flow_director_mask (port_id) mode Tunnel vlan (vlan_value) \
                   mac (mac_value) tunnel-type (tunnel_type_value) \
                   tunnel-id (tunnel_id_value)

Example, to set flow director mask on port 0:

testpmd> flow_director_mask 0 vlan 0xefff \
         src_mask 255.255.255.255 \
             FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF \
         dst_mask 255.255.255.255 \
             FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF 0xFFFF

4.8.9. flow_director_flex_mask

set masks of flow director’s flexible payload based on certain flow type:

testpmd> flow_director_flex_mask (port_id) \
         flow (none|ipv4-other|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
               ipv6-other|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp| \
               l2_payload|all) (mask)

Example, to set flow director’s flex mask for all flow type on port 0:

testpmd> flow_director_flex_mask 0 flow all \
         (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)

4.8.10. flow_director_flex_payload

Configure flexible payload selection:

flow_director_flex_payload (port_id) (raw|l2|l3|l4) (config)

For example, to select the first 16 bytes from the offset 4 (bytes) of packet’s payload as flexible payload:

testpmd> flow_director_flex_payload 0 l4 \
         (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)

4.8.11. get_sym_hash_ena_per_port

Get symmetric hash enable configuration per port:

get_sym_hash_ena_per_port (port_id)

For example, to get symmetric hash enable configuration of port 1:

testpmd> get_sym_hash_ena_per_port 1

4.8.12. set_sym_hash_ena_per_port

Set symmetric hash enable configuration per port to enable or disable:

set_sym_hash_ena_per_port (port_id) (enable|disable)

For example, to set symmetric hash enable configuration of port 1 to enable:

testpmd> set_sym_hash_ena_per_port 1 enable

4.8.13. get_hash_global_config

Get the global configurations of hash filters:

get_hash_global_config (port_id)

For example, to get the global configurations of hash filters of port 1:

testpmd> get_hash_global_config 1

4.8.14. set_hash_global_config

Set the global configurations of hash filters:

set_hash_global_config (port_id) (toeplitz|simple_xor|default) \
(ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp|ipv4-other|ipv6|ipv6-frag| \
ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload) \
(enable|disable)

For example, to enable simple_xor for flow type of ipv6 on port 2:

testpmd> set_hash_global_config 2 simple_xor ipv6 enable

4.8.15. set_hash_input_set

Set the input set for hash:

set_hash_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other| \
l2_payload) (ovlan|ivlan|src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|ipv4-tos| \
ipv4-proto|ipv6-tc|ipv6-next-header|udp-src-port|udp-dst-port| \
tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
udp-key|gre-key|fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th| \
fld-8th|none) (select|add)

For example, to add source IP to hash input set for flow type of ipv4 on port 0:

testpmd> set_hash_input_set 0 ipv4 src-ipv4 add

4.8.16. set_fdir_input_set

Set the input set for Fdir:

set_fdir_input_set (port_id) (ipv4|ipv4-frag|ipv4-tcp|ipv4-udp|ipv4-sctp| \
ipv4-other|ipv6|ipv6-frag|ipv6-tcp|ipv6-udp|ipv6-sctp|ipv6-other|l2_payload)
(src-ipv4|dst-ipv4|src-ipv6|dst-ipv6|udp-src-port|udp-dst-port| \
tcp-src-port|tcp-dst-port|sctp-src-port|sctp-dst-port|sctp-veri-tag| \
fld-1st|fld-2nd|fld-3rd|fld-4th|fld-5th|fld-6th|fld-7th|fld-8th|none) \
(select|add)

For example to add source IP to FD input set for flow type of ipv4 on port 0:

testpmd> set_fdir_input_set 0 ipv4 src-ipv4 add

4.8.17. global_config

Set different GRE key length for input set:

global_config (port_id) gre-key-len (number in bytes)

For example to set GRE key length for input set to 4 bytes on port 0:

testpmd> global_config 0 gre-key-len 4