iperf3 Development

The iperf3 project is hosted on GitHub at:

https://github.com/esnet/iperf

This site includes the source code repository, issue tracker, and discussion forums.

Mailing Lists

The developer list for iperf3 is: iperf-dev@googlegroups.com. Information on joining the mailing list can be found at:

https://groups.google.com/group/iperf-dev

Project Constituencies

iperf3 has several different audiences. The development priorities for iperf3 are based around the needs of those various types of users, in roughly descending priority order.

  1. perfSONAR: iperf3 was developed initially to serve as the bandwidth tester for the perfSONAR measurement suite (https://www.perfsonar.net). This is considered the primary user base for iperf3 and requests from the developers of this project will generally get the highest priority.

  2. ESnet and R&E Networking: iperf3 is often used as a standalone tool for testing within ESnet (https://www.es.net/) and other R&E (Research and Education) networking environments. These settings are similar to those encountered in many networks using perfSONAR. They often include wide-area networks (sometimes with national or international scale) that have bitrates up to (and sometimes exceeding) 100Gbps speeds.

  3. The Internet community: iperf3 has been found to be useful by the Internet community at large. Users in this community may have a wide range of networking needs and environments, which might include different speeds and types of networks (such as homelabs, residential broadband, corporate networks), operating systems (non-UNIX or embedded OSs). Catering to the desires of this community can be challenging, but might be undertaken if this can be done without compromising the needs of the first two communities.

Bug Reports

Before submitting a bug report, try checking out the latest version of the code, and confirm that it’s not already fixed. Also see the iperf3 FAQ. Then submit to the iperf3 issue tracker on GitHub:

https://github.com/esnet/iperf/issues

For reporting potential security issues, please contact the developers at iperf@es.net.

Note: Issues submitted to the old iperf3 issue tracker on Google Code (or comments to existing issues on the Google Code issue tracker) will be ignored.

Code Submissions

Submissions of potential code changes can be made via GitHub’s Pull Request mechanism:

https://github.com/esnet/iperf/pulls

The iperf3 development team is grateful for all contributions, particularly those that fix bugs or security issues.

Please note that iperf3 is an extremely complicated program, primarily due to the large number of options it supports. (One of the primary developers has said repeatedly for years that there are “way too many options”.) These options often interact in various ways that might not be initially obvious to those unfamiliar with the iperf3 code base (or even those who have been reading it for years), so adding new features has in the past caused bugs due to unforeseen interactions wtih other bugs. The sheer number of combinations of options makes testing difficult for both humans and automated testing systems.

In addition the developers need to be able to maintain any code submissions. This can be difficult when dealing with new features outside the maintainers’ experience.

Finally every new feature comes at a cost (principally in terms of evaluating new code and later maintenance). The maintainers need to prioritize their limited time and effort to be able to support its main users (as detailed above, those are the perfSONAR community, ESnet, and R&E networking). This means that unrelated requests from the community might not get consideration.

As of this writing (late 2025), the developers are unlikely to add any major new features into the iperf3 codebase unless they’re known to be generally useful to the main audiences of this software. To those users who nevertheless want to add something to iperf3, please discuss your ideas with the iperf3 maintainers, preferably before starting work.

Known Issues

The following problems are notable known issues, which are probably of interest to a large fraction of users or have high impact for some users, and for which issues have already been filed in the issue tracker. These issues are either open (indicating no solution currently exists) or closed with the notation that no further attempts to solve the problem are currently being made:

  • When specifying the TCP buffer size using the -w flag on Linux, the Linux kernel automatically doubles the value passed in to compensate for overheads. (This can be observed by using iperf3’s --debug flag.) However, CWND does not actually ramp up to the doubled value, but only to about 75% of the doubled value. Some part of this behavior is documented in the tcp(7) manual page.

  • Although the -w flag is documented as setting the (TCP) window size, it is also used to set the socket buffer size. This has been shown to be helpful with high-bitrate UDP tests.

  • On some platforms (observed on at least one version of Ubuntu Linux), it might be necessary to invoke ldconfig manually after doing a make install before the iperf3 executable can find its shared library.

  • The results printed on the server side at the end of a test do not correctly reflect the client-side measurements. This is due to the ordering of computing and transferring results between the client and server.

  • The server could have a very short measurement reporting interval at the end of a test (particularly a UDP test), containing few or no packets. This issue is due to an artifact of timing between the client and server.

There are, of course, many other open and closed issues in the issue tracker.

Versioning

iperf3 version numbers use (roughly) a Semantic Versioning scheme, in which version numbers consist of three parts: MAJOR.MINOR.PATCH

The developers increment the:

  • MAJOR version when making incompatible API changes,

  • MINOR version when adding functionality in a backwards-compatible manner, and

  • PATCH version when making backwards-compatible bug fixes.

The iperf3 developers aim to produce two software releases per year, in April and October. These releases, indicated by a new minor version number, are essentially snapshots of the master codeline, and might contain new features or functionality.

Between these releases, the developers might need to release patch releases to address major bugs or security vulnerabilities. These will generally be based on the most recent minor release and will increment the patch version number component. Typically they will only contain selected fixes cherry-picked from the master codeline, which will be rolled up into the next minor release.

Release Engineering Checklist

  1. Start from a clean source tree (be sure that git status emits no output). Also ensure up-to-date installs of autoconf and automake.

  2. From the tip of master (or other appropriate integration branch), create a branch for release engineering changes. This should probably be named something along the lines of releng-3.20. So:

    git branch releng-3.20     # create short-lived branch
    git checkout releng-3.20   # check it out
    
  3. Ensure that README.md and LICENSE have correct copyright dates.:

    vi README.md
    vi LICENSE
    
  4. Update the README.md and RELNOTES.md files to be accurate.:

    vi RELNOTES.md     # update version number and release date
    
  5. Compose a release announcement. Most of the release announcement can be written before tagging. Usually the previous version’s announcement can be used as a starting point.

  6. Make the changes necessary to produce the new version, such as bumping version numbers:

    vi configure.ac    # update version parameter in AC_INIT
                       # (there should not be any "+" in artifacts)
    vi src/iperf3.1    # update manpage revision date (only if needed)
    vi src/libiperf.3  # update manpage revision date (only if needed)
    git commit -a      # commit changes to the local repository only
                       # (commit log should mention version number)
    ./bootstrap.sh     # regenerate configure script, etc.
                       # do this on a platform with a recent
                       # autotools/libtools, such as HomeBrew or
                       # FreeBSD ports.
    git commit -a      # commit changes to the local repository only
                       # (commit can be simply "Regen.")
    git push --set-upstream origin releng-3.20  # Push branch for review
    
  7. Create a pull request for this branch (e.g. releng-3.20)

  8. Review and get approval for the pull request

  9. Merge pull request to master or other appropriate integration branch.

  10. Create tag and tarfile. The result will be release artifacts that should be used for pre-testing. One will be a compressed tarball (e.g. iperf-3.20.tar.gz) and the other will contain SHA256 checksum (e.g. iperf-3.20.tar.gz.sha256):

    ./make_release tag 3.20 # this creates a tag in the local repo
    ./make_release tar 3.20 # create tarball and compute SHA256 hash
    
  1. Stage the tarball (and a file containing the SHA256 hash) to the download site. Currently this is located on downloads.es.net (accessed via downloads-mgt.es.net from the ESnet internal network) in the directory /var/www/html/pub/iperf/.

  2. From another host, test the link in the release announcement by downloading a fresh copy of the file and verifying the SHA256 checksum. Checking all other links in the release announcement is strongly recommended as well.

    The link to the tarball will be something of the form https://downloads.es.net/pub/iperf/iperf-3.20.tar.gz. If composing a release announcement using a HTML-aware editor, verify the link targets point to the correct artifacts.

  3. Also verify (with file(1)) that the tarball is actually a gzipped tarball.

  4. Try downloading, compiling, and smoke-testing the results of the tarball on all supported platforms.

  5. Verify that the version string in iperf3 --version matches the version number of the artifacts.

  6. (optional) PGP-sign the release announcement text using gpg --clearsign. The signed announcement will be sent out in a subsequent emails, but could also be archived. Decoupling the signing from emailing allows a signed release announcement to be resent via email or sent by other, non-email means.

  7. At this point, the release can and should be considered finalized. To commit the release-engineering-related changes to GitHub and make them public, push them out thusly:

    git push --tags     # Push the new tag to the GitHub repo
    
  8. Update GitHub Releases with the current release notes. Start from: https://github.com/esnet/iperf/releases/new. Remember to properly select the tag from the dropdown menu. Check “Set as the latest release” and (optionally) “Create a discussion for this release”.

  9. Attach the tarball and the SHA256 file to the release.

  10. Send the release announcement to the following addresses. Remember to turn off signing in the MUA, if applicable. Remember to check the source address when posting to lists, as “closed” list will reject posting from all from registered email addresses.

    Note: Thunderbird sometimes mangles the PGP-signed release announcement so that it does not verify correctly. This could be due to Thunderbird trying to wrap the length of extremely long lines (such as the SHA256 hash). Apple Mail and mutt seem to handle this situation correctly. Testing the release announcement sending process by sending a copy to oneself first and attempting to verify the signature is highly encouraged.

  11. Announce the new release in the #iperf3 channel in ESnet Slack.

  12. Create and submit a Monday Ping entry for the new release.

  13. Update the iperf3 Project News section of the documentation site to announce the new release (see docs/news.rst and docs/conf.py in the source tree). Be sure to double-check version numbers and copyright dates.

  14. If an update to the on-line manual page is needed, it can be generated with this sequence of commands and import the result into invoking.rst:

    TERM=
    export TERM
    nroff -Tascii -c -man src/iperf3.1 | ul | sed 's/^/   /' > iperf3.txt
    
  15. Commit documentation changes after viewing the rendered HTML, and deploy a new build of the documentation to GitHub Pages.

  16. Update the version number in configure.ac to some post-release number (with a “+”) and regenerate:

    vi configure.ac         # update version in AC_INIT, add "+"
    git commit configure.ac # commit changes to local repository
                            # commit log should mention
                            # "post-release version bump"
    ./bootstrap.sh          # regenerate configure script, etc.
    git commit -a           # commit changes to local repository
                            # (commit can be simply "Regen.")
    # test
    git push
    

Code Authors

The main authors of iperf3 are (in alphabetical order): Jon Dugan, Seth Elliott, Bruce A. Mah, Jeff Poskanzer, Kaustubh Prabhu. Additional code contributions have come from (also in alphabetical order): Mark Ashley, Aaron Brown, Aeneas Jaißle, Susant Sahani, Bruce Simpson, Brian Tierney.

iperf3 contains some original code from iperf2. The authors of iperf2 are (in alphabetical order): Jon Dugan, John Estabrook, Jim Ferbuson, Andrew Gallatin, Mark Gates, Kevin Gibbs, Stephen Hemminger, Nathan Jones, Feng Qin, Gerrit Renker, Ajay Tirumala, Alex Warshavsky.