diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 9 | ||||
| -rw-r--r-- | docs/faq.rst | 28 | ||||
| -rw-r--r-- | docs/invoking.rst | 2 | ||||
| -rw-r--r-- | docs/news.rst | 24 |
4 files changed, 54 insertions, 9 deletions
diff --git a/docs/conf.py b/docs/conf.py index b03fcbd..96c352c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -45,17 +45,17 @@ master_doc = 'index' # General information about the project. project = u'iperf3' -copyright = u'2014-2023, ESnet' +copyright = u'2014-2024, ESnet' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '3.15' +version = '3.17' # The full version, including alpha/beta/rc tags. -release = '3.15' +release = '3.17' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -159,7 +159,8 @@ html_static_path = ['_static/esnet'] #html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -html_sidebars = {'index': None, 'search': None, '*': ['localtoc.html']} +#html_sidebars = {'index': None, 'search': None, '*': ['localtoc.html']} +html_sidebars = {'index': [], 'search': [], '**': ['localtoc.html']} # Additional templates that should be rendered to pages, maps page names to # template names. diff --git a/docs/faq.rst b/docs/faq.rst index 7b70026..b203e2a 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -22,7 +22,14 @@ What is the history of iperf3, and what is the difference between iperf2 and ipe current development is focused is on using UDP for latency testing, as well as broad platform support. - As of this writing (2017), both iperf2 and iperf3 are being actively + In 2023, iperf3 was modified and restructured to support + multi-threading, so that it uses one thread per test stream. This + allows it to use multiple CPU cores during tests, which in turn + permit it to keep up with continually increasing network link and + path bandwidths across the backbones of ESnet and other network + providers. + + As of this writing (2024), both iperf2 and iperf3 are being actively (although independently) developed. We recommend being familiar with both tools, and use whichever tool’s features best match your needs. @@ -30,9 +37,22 @@ What is the history of iperf3, and what is the difference between iperf2 and ipe https://fasterdata.es.net/performance-testing/network-troubleshooting-tools/throughput-tool-comparision/ iperf3 parallel stream performance is much less than iperf2. Why? - iperf3 is single threaded, and iperf2 is multi-threaded. We - recommend using iperf2 for parallel streams. - If you want to use multiple iperf3 streams use the method described `here <https://fasterdata.es.net/performance-testing/network-troubleshooting-tools/iperf/multi-stream-iperf3/>`_. + Versions of iperf3 before version 3.16 were all single threaded, and + iperf2 is multi-threaded. This could result in a performance gap + because iperf3 was only able to use one CPU core on a host, which + turned into a bottleneck when trying to do high bitrate tests + (faster than about 25 Gbps). + + Beginning with version 3.16, iperf3 is multi-threaded, which allows + it to take advantage of multiple CPU cores during a test (one thread + per stream). iperf3 has been observed to send and receive + approximately 160Gbps on a 200Gbps path in a test involving multiple + TCP flows, with little or no tuning. + + Prior to multi-threading support in iperf3, one might need to use + the method described `here + <https://fasterdata.es.net/performance-testing/network-troubleshooting-tools/iperf/multi-stream-iperf3/>`_ + to achieve faster speeds. I’m trying to use iperf3 on Windows, but having trouble. What should I do? iperf3 is not officially supported on Windows, but iperf2 is. We diff --git a/docs/invoking.rst b/docs/invoking.rst index 5b09463..7c91dea 100644 --- a/docs/invoking.rst +++ b/docs/invoking.rst @@ -194,7 +194,7 @@ the executable. --rcv-timeout # set idle timeout for receiving data during active tests. The receiver will halt a test if no data is received from the sender - for this number of ms (default to 12000 ms, or 2 minutes). + for this number of ms (default to 120000 ms, or 2 minutes). --snd-timeout # set timeout for unacknowledged TCP data (on both test and con- diff --git a/docs/news.rst b/docs/news.rst index b0bcfac..9903ec1 100644 --- a/docs/news.rst +++ b/docs/news.rst @@ -1,6 +1,30 @@ iperf3 Project News =================== +2024-05-10: iperf-3.17 released +-------------------------------- +| URL: https://downloads.es.net/pub/iperf/iperf-3.17.tar.gz +| SHA256: ``077ede831b11b733ecf8b273abd97f9630fd7448d3ec1eaa789f396d82c8c943`` + +iperf 3.17 contains a fix for a minor security vulnerability related +to iperf3's authentication feature and its use of RSA-encrypted +credentials. The release notes contain more +details on this breaking change, and how to revert to older, less +secure behavior if needed for backward compatibility with older +versions of iperf3. + +This version also contains a new streaming JSON output format (enabled +with the --json-stream) option, and a number of other bug fixes. + +2023-12-01: iperf-3.16 released +-------------------------------- +| URL: https://downloads.es.net/pub/iperf/iperf-3.16.tar.gz +| SHA256: ``cc740c6bbea104398cc3e466befc515a25896ec85e44a662d5f4a767b9cf713e`` + +iperf 3.16 uses multiple threads to serve parallel tests for improved +throughput on high-speed links. It also includes support for +OpenSSL 3. More details are provided in the release notes. + 2023-09-14: iperf-3.15 released -------------------------------- | URL: https://downloads.es.net/pub/iperf/iperf-3.15.tar.gz |