.. index:: pair: group; TCP UPD performance test
.. _doxid-group__perf-tcp__udp__perf:

TCP UPD performance test
========================

.. toctree::
	:hidden:

Report TCP or UDP performance

Get the performance statistics of TCP UDP traffic and report it.

#. Configure Rx checksum offload on IUT interface if specified

#. Configure GRO on IUT interface if specified

#. Configure HW VLAN stripping on IUT interface if specified

#. Configure Tx checksum offload on IUT interface if specified

#. Configure GSO offload on IUT interface if specified

#. Configure TSO offload on IUT interface if specified

#. Configure HW VLAN insertion on IUT interface if specified

#. If **rx_coalesce_usecs** or **rx_max_coalesced_frames** is not -1, configure Rx coalesce on IUT interface.
   
   * Disable **use_adaptive_rx_coalesce** on IUT interface.
   
   * If **rx_coalesce_usecs** is not -1, configure it IUT interface.
   
   * If **rx_max_coalesced_frames** is not -1, configure it IUT interface.

#. Set Rx ring size according to **rx_ring** on IUT interface.

#. Set Tx ring size according to **tx_ring** on IUT interface.

#. Set number of combined channels on IUT interface according to **channels**.

#. If **rx_vlan_strip** or **tx_vlan_insert** is not default, create VLANs, assign addresses and use it for traffic checks below.

#. Set default perf options

#. Set test specific perf options

#. Allocate server ports for perf applications

#. Start server and client perf applications

#. Wait for perf report to be ready

Igor Romanov `Igor.Romanov@oktetlabs.ru <mailto:Igor.Romanov@oktetlabs.ru>`__



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- perf_bench

		- Performance benchmark type

	*
		- dual_mode

		- Run benchmark in bidirectional mode

	*
		- protocol

		- Use TCP or UDP protocol

	*
		- n_perf_insts

		- Number of performance apps to run

	*
		- n_streams

		- Number of parallel streams to run

	*
		- bandwidth

		- Target bandwidth in Mbps, negative means some internal tool value for UDP, unlimited for TCP

	*
		- rx_csum

		- Enable, disable Rx checksum offload or preserve default

	*
		- rx_gro

		- Enable, disable Rx GRO offload or preserve default

	*
		- rx_vlan_strip

		- Enable, disable Rx VLAN stripping offload or preserve default

	*
		- tx_csum

		- Enable, disable Tx checksum offload or preserve default

	*
		- tx_gso

		- Enable, disable Tx GSO offload or preserve default

	*
		- tso

		- Enable, disable TSO offload or preserve default

	*
		- tx_vlan_insert

		- Enable, disable Tx VLAN insertion offload or preserve default

	*
		- rx_coalesce_usecs

		- 
		  Value to set for **rx_coalesce_usecs:**
		  
		  * ``-1`` (keep default settings)
		  
		  * ``0`` (interrupt moderation is disabled)
		  
		  * ``30``
		  
		  * ``150``

	*
		- rx_max_coalesced_frames

		- 
		  Value to set **rx_max_coalesced_frames:**
		  
		  * ``-1`` (keep default settings)
		  
		  * ``0`` (do not coalesce based on it)
		  
		  * ``1`` (interrupt moderation is disabled)

	*
		- rx_ring

		- 
		  Rx rings size:
		  
		  * ``-1`` (keep default)
		  
		  * ``0`` (maximum)
		  
		  * ``64``
		  
		  * ``512``
		  
		  * ``1024``

	*
		- tx_ring

		- 
		  Tx rings size:
		  
		  * ``-1`` (keep default)
		  
		  * ``0`` (maximum)
		  
		  * ``64``
		  
		  * ``512``
		  
		  * ``1024``

	*
		- channels

		- 
		  Number of combined channels to use:
		  
		  * ``-1`` (keep default)
		  
		  * ``1``
		  
		  * ``2``
		  
		  * ``4``