zephyr

History

Jukka Rissanen 0297e7ec15 samples: net: zperf: Ignore out of net_buf issue If we ran out of net_buf's while sending, ignore the issue and try to finish the test instead. Solving the "running out of network buffers" case would require careful tuning of number of network buffers, buffer size, upload speed etc. which is difficult to solve with generic buffer count options. The user should tweak mainly the CONFIG_NET_BUF_TX_COUNT option. Optionally CONFIG_NET_PKT_TX_COUNT can be changed too. Information about these options is printed to console after the test is finished. Fixes #20315 Signed-off-by: Jukka Rissanen <jukka.rissanen@linux.intel.com>		2019-12-10 10:00:53 +02:00
..
boards	boards: remove quarl_se_c1000	2019-07-29 21:30:25 -07:00
src	samples: net: zperf: Ignore out of net_buf issue	2019-12-10 10:00:53 +02:00
CMakeLists.txt	license: cleanup: add SPDX Apache-2.0 license identifier	2019-04-07 08:45:22 -04:00
README.rst	samples: net: zperf: Clarify that only iPerf 2.0.5 is supported	2019-11-05 09:29:15 -05:00
overlay-bt.conf	samples: net: Update overlay-bt.conf in various samples	2019-03-20 11:32:40 -05:00
overlay-netusb.conf	samples: net: Clean up netusb overlay configuration	2019-10-04 21:23:53 +03:00
prj.conf	samples: net: zperf: Fix TCP download command	2019-03-13 01:52:09 +01:00
sample.yaml	samples: net: Clean up netusb overlay configuration	2019-10-04 21:23:53 +03:00

README.rst

.. _zperf-sample:

zperf: Network Traffic Generator
################################

Description
***********

zperf is a network traffic generator for Zephyr that may be used to
evaluate network bandwidth.

Features
*********

- Compatible with iPerf_2.0.5. Note that in newer iPerf versions,
  an error message like this is printed and the server reported statistics
  are missing.

.. code-block:: console

   LAST PACKET NOT RECEIVED!!!

- Client or server mode allowed without need to modify the source code.

Supported Boards
****************

zperf is board-agnostic. However, to run the zperf sample application,
the target platform must provide a network interface supported by Zephyr.

This sample application has been tested on the following platforms:

- Freedom Board (FRDM K64F)
- Quark SE C1000 Development Board
- QEMU x86

Requirements
************

- iPerf 2.0.5 installed on the host machine
- Supported board

Depending on the network technology chosen, extra steps may be required
to setup the network environment.

Usage
*****

If Zephyr acts as a client, iPerf must be executed in server mode.
For example, the following command line must be used for UDP testing:

.. code-block:: console

   $ iperf -s -l 1K -u -V -B 2001:db8::2

For TCP testing, the command line would look like this:

.. code-block:: console

   $ iperf -s -l 1K -V -B 2001:db8::2


In the Zephyr console, zperf can be executed as follows:

.. code-block:: console

   zperf udp upload 2001:db8::2 5001 10 1K 1M


For TCP the zperf command would look like this:

.. code-block:: console

   zperf tcp upload 2001:db8::2 5001 10 1K 1M


If the IP addresses of Zephyr and the host machine are specified in the
config file, zperf can be started as follows:

.. code-block:: console

   zperf udp upload2 v6 10 1K 1M


or like this if you want to test TCP:

.. code-block:: console

   zperf tcp upload2 v6 10 1K 1M


If Zephyr is acting as a server, set the download mode as follows for UDP:

.. code-block:: console

   zperf udp download 5001


or like this for TCP:

.. code-block:: console

   zperf tcp download 5001


and in the host side, iPerf must be executed with the following
command line if you are testing UDP:

.. code-block:: console

   $ iperf -l 1K -u -V -c 2001:db8::1 -p 5001


and this if you are testing TCP:

.. code-block:: console

   $ iperf -l 1K -V -c 2001:db8::1 -p 5001


iPerf output can be limited by using the -b option if Zephyr is not
able to receive all the packets in orderly manner.