help display : Displaying port, stats and config information.
help config : Configuration information.
help ports : Configuring ports.
- help flowdir : Flow Director filter help.
help registers : Reading and setting port registers.
help filters : Filters configuration help.
help all : All of the above sections.
quit
~~~~
-Quit to prompt in Linux or reboot on Baremetal:
+Quit to prompt:
quit
filter on
qinq(extend) off
+show port rss reta
+~~~~~~~~~~~~~~~~~~
+
+Display the rss redirection table entry indicated by masks on port X:
+
+show port (port_id) rss reta (size) (mask0, mask1...)
+
+size is used to indicate the hardware supported reta size
+
show port rss-hash
~~~~~~~~~~~~~~~~~~
-Display the RSS hash functions and RSS hash key of port (port_id).
+Display the RSS hash functions and RSS hash key of a port:
+
+show port (port_id) rss-hash [key]
-show port (port_id) rss-hash [key] clear port
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+clear port
+~~~~~~~~~~
Clear the port statistics for a given port or for all ports:
rx_vlan rm (vlan_id) port (port_id) vf (vf_mask)
-tx_rate (for Queue)
-~~~~~~~~~~~~~~~~~~~
+rx_vlan set tpid
+~~~~~~~~~~~~~~~~
-Set TX rate limitation for queue of a port ID:
+Set the outer VLAN TPID for packet filtering on a port:
-set port (port_id) queue (queue_id) rate (rate_value)
+rx_vlan set tpid (value) (port_id)
-tx_rate (for VF)
-~~~~~~~~~~~~~~~~
+tunnel_filter add
+~~~~~~~~~~~~~~~~~
-Set TX rate limitation for queues in VF of a port ID:
+Add a tunnel filter on a port:
-set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
+tunnel_filter add (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
+ (tunnel_type) (filter_type) (tenant_id) (queue_id)
-rx_vlan set tpid
-~~~~~~~~~~~~~~~~
+tunnel_filter remove
+~~~~~~~~~~~~~~~~~~~~
-Set the outer VLAN TPID for packet filtering on a port:
+Remove a tunnel filter on a port:
-rx_vlan set tpid (value) (port_id)
+tunnel_filter rm (port_id) (outer_mac) (inner_mac) (ip_addr) (inner_vlan)
+ (tunnel_type) (filter_type) (tenant_id) (queue_id)
+
+rx_vxlan_port add
+~~~~~~~~~~~~~~~~~
+
+Add an UDP port for VXLAN packet filter on a port:
+
+rx_vxlan_port add (udp_port) (port_id)
+
+rx_vxlan_port remove
+~~~~~~~~~~~~~~~~~~~~
+
+Remove an UDP port for VXLAN packet filter on a port:
+
+rx_vxlan_port rm (udp_port) (port_id)
tx_vlan set
~~~~~~~~~~~
tx_vlan reset (port_id)
-tx_checksum set mask
-~~~~~~~~~~~~~~~~~~~~
+tx_checksum set
+~~~~~~~~~~~~~~~
+
+Select hardware or software calculation of the checksum when
+transmitting a packet using the csum forward engine:
+
+tx_cksum set (ip|udp|tcp|sctp|vxlan)
+
+ip|udp|tcp|sctp always concern the inner layer.
+vxlan concerns the outer IP and UDP layer (in case the packet
+is recognized as a vxlan packet by the forward engine)
-Enable hardware insertion of checksum offload with a 4-bit mask, 0x0 - 0xF, in packets sent on a port:
+.. note::
+
+ Check the NIC Datasheet for hardware limits.
-tx_checksum set (mask) (port_id)
+tx_checksum show
+~~~~~~~~~~~~~~~~
-The bits in the mask are:
+Display tx checksum offload configuration:
-bit 0 - if set insert ip checksum offload
+tx_checksum show (port_id)
-bit 1 - if set insert udp checksum offload
+tso set
+~~~~~~~
-bit 2 - if set insert tcp checksum offload
+Enable TCP Segmentation Offload in csum forward engine:
-bit 3 - if set insert sctp checksum offload
+tso set (segsize) (port_id)
.. note::
+ Please check the NIC datasheet for HW limits
- Check the NIC Datasheet for hardware limits.
+tso show
+~~~~~~~~
+
+Display the status of TCP Segmentation Offload:
+tso show (port_id)
set fwd
~~~~~~~
set port (port_id) vf (vf_id) (rx|tx) (on|off)
+set port - mac address filter (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Add/Remove unicast or multicast MAC addr filter for a VF:
+
+set port (port_id) vf (vf_id) (mac_addr)
+ (exact-mac|exact-mac-vlan|hashmac|hashmac-vlan) (on|off)
+
set port - rx mode(for VF)
~~~~~~~~~~~~~~~~~~~~~~~~~~
* MPE: accepts all multicast packets
+set port - tx_rate (for Queue)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set TX rate limitation for queue of a port ID:
+
+set port (port_id) queue (queue_id) rate (rate_value)
+
+set port - tx_rate (for VF)
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Set TX rate limitation for queues in VF of a port ID:
+
+set port (port_id) vf (vf_id) rate (rate_value) queue_mask (queue_mask)
+
set port - mirror rule
~~~~~~~~~~~~~~~~~~~~~~
show bypass config (port_id)
-add_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Add a L2 Ethertype filter, which identify packets by their L2 Ethertype mainly assign them to a receive queue.
-
-add_ethertype_filter (port_id) ethertype (eth_value) priority (enable|disable) (pri_value) queue (queue_id) index (idx)
-
-The available information parameters are:
-
-* port_id: the port which the Ethertype filter assigned on.
-
-* eth_value: the EtherType value want to match,
- for example 0x0806 for ARP packet. 0x0800 (IPv4) and 0x86DD (IPv6) are invalid.
-
-* enable: user priority participates in the match.
-
-* disable: user priority doesn't participate in the match.
-
-* pri_value: user priority value that want to match.
-
-* queue_id : The receive queue associated with this EtherType filter
-
-* index: the index of this EtherType filter
-
-Example:
-
-.. code-block:: console
-
- testpmd> add_ethertype_filter 0 ethertype 0x0806 priority disable 0 queue 3 index 0
- Assign ARP packet to receive queue 3
-
-remove_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Remove a L2 Ethertype filter
-
-remove_ethertype_filter (port_id) index (idx)
-
-get_ethertype_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Get and display a L2 Ethertype filter
-
-get_ethertype_filter (port_id) index (idx)
-
-Example:
-
-.. code-block:: console
-
- testpmd> get_ethertype_filter 0 index 0
-
- filter[0]:
- ethertype: 0x0806
- priority: disable, 0
- queue: 3
-
-add_2tuple_filter
-~~~~~~~~~~~~~~~~~
-
-Add a 2-tuple filter,
-which identify packets by specific protocol and destination TCP/UDP port
-and forwards packets into one of the receive queues.
-
-add_2tuple_filter (port_id) protocol (pro_value) (pro_mask) dst_port (port_value) (port_mask)
-flags (flg_value) priority (prio_value) queue (queue_id) index (idx)
-
-The available information parameters are:
-
-* port_id: the port which the 2-tuple filter assigned on.
-
-* pro_value: IP L4 protocol
-
-* pro_mask: protocol participates in the match or not, 1 means participate
-
-* port_value: destination port in L4.
-
-* port_mask: destination port participates in the match or not, 1 means participate.
-
-* flg_value: TCP control bits. The non-zero value is invalid, when the pro_value is not set to 0x06 (TCP).
-
-* prio_value: the priority of this filter.
-
-* queue_id: The receive queue associated with this 2-tuple filter
-
-* index: the index of this 2-tuple filter
-
-Example:
-
-.. code-block:: console
-
- testpmd> add_2tuple_filter 0 protocol 0x06 1 dst_port 32 1 flags 0x02 priority 3 queue 3 index 0
-
-remove_2tuple_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Remove a 2-tuple filter
-
-remove_2tuple_filter (port_id) index (idx)
-
-get_2tuple_filter
-~~~~~~~~~~~~~~~~~
-
-Get and display a 2-tuple filter
-
-get_2tuple_filter (port_id) index (idx)
-
-Example:
-
-.. code-block:: console
-
- testpmd> get_2tuple_filter 0 index 0
-
- filter[0]:
- Destination Port: 0x0020 mask: 1
- protocol: 0x06 mask:1 tcp_flags: 0x02
- priority: 3 queue: 3
-
-add_5tuple_filter
-~~~~~~~~~~~~~~~~~
-
-Add 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.
-
-add_5tuple_filter (port_id) dst_ip (dst_address) src_ip (src_address) dst_port (dst_port_value) src_port (src_port_value)
-protocol (protocol_value) mask (mask_value) flags (flags_value) priority (prio_value) queue (queue_id) index (idx)
-
-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
-
-* 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.
-
-* index: the index of this 5-tuple filter
-
-Example:
-
-.. code-block:: console
-
- testpmd> add_5tuple_filter 1 dst_ip 2.2.2.5 src_ip 2.2.2.4 dst_port 64 src_port 32 protocol 0x06 mask 0x1F flags 0x0 priority 3 queue 3 index 0
-
-remove_5tuple_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Remove a 5-tuple filter
-
-remove_5tuple_filter (port_id) index (idx)
-
-get_5tuple_filter
-~~~~~~~~~~~~~~~~~
-
-Get and display a 5-tuple filter
-
-get_5tuple_filter (port_id) index (idx)
-
-Example:
-
-.. code-block:: console
-
- testpmd> get_5tuple_filter 1 index 0
-
- filter[0]:
- Destination IP: 0x02020205 mask: 1
- Source IP: 0x02020204 mask: 1
- Destination Port: 0x0040 mask: 1
- Source Port: 0x0020 mask: 1
- protocol: 0x06 mask: 1
- priority: 3 flags: 0x00 queue: 3
-
-add_syn_filter
-~~~~~~~~~~~~~~
-
-Add SYN filter, which can forward TCP packets whose *SYN* flag is set into a separate queue.
-
-add_syn_filter (port_id) 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:
-
-.. code-block:: console
-
- testpmd> add_syn_filter 0 priority high queue 3,
-
-remove_syn_filter
-~~~~~~~~~~~~~~~~~
-
-Remove SYN filter
-
-remove_syn_filter (port_id)
-
-get_syn_filter
-~~~~~~~~~~~~~~
-
-Get and display SYN filter
-
-get_syn_filter (port_id)
-
-Example:
-
-.. code-block:: console
-
- testpmd> get_syn_filter 0
-
- syn filter: on, priority: high, queue: 3
-
-add_flex_filter
-~~~~~~~~~~~~~~~
-
-Add a Flex filter,
-which recognizes any arbitrary pattern within the first 128 bytes of the packet
-and routes packets into one of the receive queues.
-
-add_flex_filter (port_id) len (len_value) bytes (bytes_string) mask (mask_value)
-priority (prio_value) queue (queue_id) index (idx)
-
-The available information parameters are:
-
-* port_id: the port which the Flex filter assigned on.
-
-* len_value: filter length in byte, no greater than 128.
-
-* bytes_string: a sting in format of octal, means the value the flex filter need to match.
-
-* mask_value: a sting in format of octal, bit 1 means corresponding byte in DWORD participates in the match.
-
-* prio_value: the priority of this filter.
-
-* queue_id: The receive queue associated with this Flex filter.
-
-* index: the index of this Flex filter
-
-Example:
-
-.. code-block:: console
-
- testpmd> add_flex_filter 0 len 16 bytes 0x00000000000000000000000008060000 mask 000C priority 3 queue 3 index 0
-
-Assign a packet whose 13th and 14th bytes are 0x0806 to queue 3.
-
-remove_flex_filter
-~~~~~~~~~~~~~~~~~~
-
-Remove a Flex filter
-
-remove_flex_filter (port_id) index (idx)
-
-get_flex_filter
-~~~~~~~~~~~~~~~
-
-Get and display a Flex filter
-
-get_flex_filter (port_id) index (idx)
-
-Example:
-
-.. code-block:: console
-
- testpmd> get_flex_filter 0 index 0
-
- filter[0]:
-
- length: 16
-
- dword[]: 0x00000000 00000000 00000000 08060000 00000000 00000000 00000000
- 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
- 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000
- 00000000 00000000 00000000 00000000 00000000 00000000 00000000
-
- mask[]:
- 0b0000000000001100000000000000000000000000000000000000000000000000000000
- 0000000000000000000000000000000000000000000000000000000000
-
- priority: 3 queue: 3
-
set link up
~~~~~~~~~~~
port close (port_id|all)
+port start/stop queue
+~~~~~~~~~~~~~~~~~~~~~
+
+Start/stop a rx/tx queue on a specific port:
+
+port (port_id) (rxq|txq) (queue_id) (start|stop)
+
+Only take effect when port is started.
+
port config - speed
~~~~~~~~~~~~~~~~~~~
* txrst: Set the transmit RS bit threshold of TX rings, 0 <= value <= txd.
These threshold options are also available from the command-line.
-Flow Director Functions
------------------------
-
-The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
-
-Two types of filtering are supported which are referred to as Perfect Match and Signature filters:
-
-* Perfect match filters.
- The hardware checks a match between the masked fields of the received packets and the programmed filters.
-
-* Signature filters.
- The hardware checks a match between a hash-based signature of the masked fields of the received packet.
-
-The Flow Director filters can match the following fields in a packet:
-
-* Source IP and destination IP addresses.
-
-* Source port and destination port numbers (for UDP and TCP packets).
-
-* IPv4/IPv6 and UDP/ TCP/SCTP protocol match.
-
-* VLAN header.
-
-* Flexible 2-byte tuple match anywhere in the first 64 bytes of the packet.
-
-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.
-For example it is possible to mask out sub-nets of IP addresses or to ignore VLAN headers.
-
-In the following sections, several common parameters are used in the Flow Director filters.
-These are explained below:
-
-* src: A pair of source address values. The source IP, in IPv4 or IPv6 format, and the source port:
-
- src 192.168.0.1 1024
-
- src 2001:DB8:85A3:0:0:8A2E:370:7000 1024
-
-* dst: A pair of destination address values. The destination IP, in IPv4 or IPv6 format, and the destination port.
-
-* flexbytes: A 2-byte tuple to be matched within the first 64 bytes of a packet.
-
-The offset where the match occurs is set by the --pkt-filter-flexbytes-offset command-line parameter
-and is counted from the first byte of the destination Ethernet MAC address.
-The default offset is 0xC bytes, which is the "Type" word in the MAC header.
-Typically, the flexbyte value is set to 0x0800 to match the IPv4 MAC type or 0x86DD to match IPv6.
-These values change when a VLAN tag is added.
-
-* vlan: The VLAN header to match in the packet.
-
-* queue: The index of the RX queue to route matched packets to.
-
-* soft: The 16-bit value in the MBUF flow director ID field for RX packets matching the filter.
-
-add_signature_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Add a signature filter:
-
-# Command is displayed on several lines for clarity.
-
-add_signature_filter (port_id) (ip|udp|tcp|sctp)
-
- src (src_ip_address) (src_port)
-
- dst (dst_ip_address) (dst_port)
-
- flexbytes (flexbytes_values)
-
- vlan (vlan_id) queue (queue_id)
-
-upd_signature_filter
-~~~~~~~~~~~~~~~~~~~~
-
-Update a signature filter:
-
-# Command is displayed on several lines for clarity.
-
-upd_signature_filter (port_id) (ip|udp|tcp|sctp)
-
- src (src_ip_address) (src_port)
-
- dst (dst_ip_address) (dst_port)
-
- flexbytes (flexbytes_values)
-
- vlan (vlan_id) queue (queue_id)
-
-rm_signature_filter
-~~~~~~~~~~~~~~~~~~~
-
-Remove a signature filter:
-
-# Command is displayed on several lines for clarity.
-
-rm_signature_filter (port_id) (ip|udp|tcp|sctp)
-
- src (src_ip_address) (src_port)
-
- dst (dst_ip_address) (dst_port)
-
- flexbytes (flexbytes_values)
-
- vlan (vlan_id)
-
-add_perfect_filter
-~~~~~~~~~~~~~~~~~~
-
-Add a perfect filter:
-
-# Command is displayed on several lines for clarity.
-
-add_perfect_filter (port_id) (ip|udp|tcp|sctp)
-
- src (src_ip_address) (src_port)
-
- dst (dst_ip_address) (dst_port)
-
- flexbytes (flexbytes_values)
-
- vlan (vlan_id) queue (queue_id) soft (soft_id)
-
-upd_perfect_filter
-~~~~~~~~~~~~~~~~~~
-
-Update a perfect filter:
-
-# Command is displayed on several lines for clarity.
-
-upd_perfect_filter (port_id) (ip|udp|tcp|sctp)
-
- src (src_ip_address) (src_port)
-
- dst (dst_ip_address) (dst_port)
-
- flexbytes (flexbytes_values)
-
- vlan (vlan_id) queue (queue_id)
-
-rm_perfect_filter
-~~~~~~~~~~~~~~~~~
-
-Remove a perfect filter:
-
-rm_perfect_filter (port_id) (ip|udp|tcp|sctp)
-
- src (src_ip_address) (src_port)
-
- dst (dst_ip_address) (dst_port)
-
- flexbytes (flexbytes_values)
-
- vlan (vlan_id) soft (soft_id)
-
-set_masks_filter
-~~~~~~~~~~~~~~~~
-
-Set IPv4 filter masks:
-
-# Command is displayed on several lines for clarity.
-
-set_masks_filter (port_id) only_ip_flow (0|1)
-
- src_mask (ip_src_mask) (src_port_mask)
-
- dst_mask (ip_dst_mask) (dst_port_mask)
-
- flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
-
-set_ipv6_masks_filter
-~~~~~~~~~~~~~~~~~~~~~
-
-Set IPv6 filter masks:
-
-# Command is displayed on several lines for clarity.
-
-set_ipv6_masks_filter (port_id) only_ip_flow (0|1)
-
- src_mask (ip_src_mask) (src_port_mask)
-
- dst_mask (ip_dst_mask) (dst_port_mask)
-
- flexbytes (0|1) vlan_id (0|1) vlan_prio (0|1)
-
- compare_dst (0|1)
-
-Link Bonding Functions
-----------------------
+Link Bonding Functions
+----------------------
The Link Bonding functions make it possible to dynamically create and
manage link bonding devices from within testpmd interactive prompt.
testpmd> set bonding xmit_balance_policy 10 l34
+
+set bonding mon_period
+~~~~~~~~~~~~~~~~~~~~~~
+
+Set the link status monitoring polling period in milliseconds for a bonding devicie.
+
+This adds support for PMD slave devices which do not support link status interrupts.
+When the mon_period is set to a value greater than 0 then all PMD's which do not support
+link status ISR will be queried every polling interval to check if their link status has changed.
+
+set bonding mon_period (port_id) (value)
+
+For example, to set the link status monitoring polling period of bonded device (port 5) to 150ms
+
+.. code-block:: console
+
+ testpmd> set bonding mon_period 5 150
+
+
show bonding config
~~~~~~~~~~~~~~~~~~~
testpmd> write regbit 0 0xEE00 31 1
port 0 PCI register at offset 0xEE00: 0x8000000A (2147483658)
+
+Filter Functions
+----------------
+
+This section details the available filter functions that are available.
+
+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:
+
+.. code-block:: console
+
+ testpmd> ethertype_filter 0 add mac_ignr ethertype 0x0806 fwd queue 3
+ testpmd> ethertype_filter 0 del mac_ignr ethertype 0x0806 fwd queue 3
+
+2tuple_filter
+~~~~~~~~~~~~~~~~~
+
+Add or delete a 2-tuple filter,
+which identify 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:
+
+.. code-block:: console
+
+ 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
+
+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:
+
+.. code-block:: console
+
+ 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
+
+syn_filter
+~~~~~~~~~~~~~~
+
+By 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:
+
+.. code-block:: console
+
+ testpmd> syn_filter 0 add priority high queue 3
+
+flex_filter
+~~~~~~~~~~~
+
+With flex filter, packets can be recognized by any arbitrary pattern within the first 128 bytes of the packet
+and routes packets 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:
+
+.. code-block:: console
+
+ 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
+
+flow_director_filter
+~~~~~~~~~~~~~~~~~~~~
+
+The Flow Director works in receive mode to identify specific flows or sets of flows and route them to specific queues.
+
+Two types of filtering are supported which are referred to as Perfect Match and Signature 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.
+
+* Signature filters.
+ The hardware checks a match between a hash-based signature of the masked fields of the received packet.
+
+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) (add|del|update) flow (ip4|ip4-frag|ip6|ip6-frag)
+src (src_ip_address) dst (dst_ip_address) vlan (vlan_value) flexbytes (flexbytes_value)
+(drop|fwd) queue (queue_id) fd_id (fd_id_value)
+
+flow_director_filter (port_id) (add|del|update) flow (udp4|tcp4|udp6|tcp6)
+src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) vlan (vlan_value)
+flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
+
+flow_director_filter (port_id) (add|del|update) flow (sctp4|sctp6)
+src (src_ip_address) (src_port) dst (dst_ip_address) (dst_port) tag (verification_tag)
+vlan (vlan_value) flexbytes (flexbytes_value) (drop|fwd) queue (queue_id) fd_id (fd_id_value)
+
+For example, to add an udp flow type filter:
+
+.. code-block:: console
+
+ testpmd> flow_director_filter 0 add flow udp4 src 2.2.2.3 32 dst 2.2.2.5 33 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
+
+For example, add an ip4 flow type filter:
+
+.. code-block:: console
+
+ testpmd> flow_director_filter 0 add flow ip4 src 2.2.2.3 dst 2.2.2.5 vlan 0x1 flexbytes (0x88,0x48) fwd queue 1 fd_id 1
+
+flush_flow_director
+~~~~~~~~~~~~~~~~~~~
+
+flush all flow director filters on a device:
+
+flush_flow_director (port_id)
+
+Example, to flush all flow director filter on port 0:
+
+.. code-block:: console
+
+ testpmd> flush_flow_director 0
+
+flow_director_mask
+~~~~~~~~~~~~~~~~~~
+
+set flow director's masks on match input set
+
+flow_director_mask (port_id) vlan (vlan_value) src_mask (ipv4_src) (ipv6_src) (src_port) dst_mask (ipv4_dst) (ipv6_dst) (dst_port)
+
+Example, to set flow director mask on port 0:
+
+.. code-block:: console
+
+ 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
+
+
+flow_director_flex_mask
+~~~~~~~~~~~~~~~~~~~~~~~
+
+set masks of flow director's flexible payload based on certain flow type:
+
+flow_director_flex_mask (port_id) flow (raw|ip4|ip4-frag|tcp4|udp4|sctp4|ip6|ip6-frag|tcp6|udp6|sctp6|all) (mask)
+
+Example, to set flow director's udpv4 flex mask on port 0:
+
+.. code-block:: console
+
+ testpmd> flow_director_flex_mask 0 flow all (0xff,0xff,0,0,0,0,0,0,0,0,0,0,0,0,0,0)
+
+
+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.
+
+.. code-block:: console
+
+ testpmd> flow_director_flex_payload 0 l4 (4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19)
git.droids-corp.org / dpdk.git / blobdiff