android-iperf

Getting Started

What is iPerf / iPerf3 ?

iPerf3 is a tool for active measurements of the maximum achievable bandwidth on IP networks. It supports tuning of various parameters related to timing, buffers and protocols (TCP, UDP, SCTP with IPv4 and IPv6). For each test it reports the bandwidth, loss, and other parameters. This is a new implementation that shares no code with the original iPerf and also is not backwards compatible. iPerf was orginally developed by NLANR/DAST. iPerf3 is principally developed by ESnet / Lawrence Berkeley National Laboratory. It is released under a three-clause BSD license.

https://iperf.fr/

Remark No iperf/iperf3 source codes are included in this repo

Supported versions

iPerf2

Version	Release day	Source Code	Comments
2.0.5	2010-07-08	Source Code
2.0.10	2017-08-11	Source Code
2.0.11	2018-05-24	Source Code	compiled w/o HAVE_AF_PACKET
2.0.12	2018-06-26	Source Code	compiled w/o HAVE_AF_PACKET
2.0.13	2019-01-22	Source Code	compiled w/o HAVE_AF_PACKET
2.1.3	2021-07-15	Source Code	compiled w/o HAVE_AF_PACKET, HAVE_LINUX_UDP_H!
2.1.4	2021-08-19	Source Code	compiled w/o HAVE_AF_PACKET, HAVE_LINUX_UDP_H, HAVE_TUNTAP_TUN, HAVE_TUNTAP_TAP!

iPerf3

Version	Release day	Source Code
3.1.6	2017-02-02	Source Code
3.1.7	2017-03-03	Source Code
3.2	2017-06-26	Source Code
3.2rc1	2017-06-19	Source Code
3.3	2017-10-30	Source Code
3.4	2018-02-12	Source Code
3.5	2018-02-28	Source Code
3.6	2018-06-22	Source Code
3.7	2019-06-20	Source Code
3.8	2020-06-08	Source Code
3.8.1	2020-06-10	Source Code
3.9	2020-08-17	Source Code
3.10	2021-05-26	Source Code
3.10.1	2021-06-02	Source Code

Download

Compiled iperf and iperf3 binaries using SDK 4333796 and NDK r19 for devices with Android 9.0+ (API level 28+) - Travis-CI Deployment.

ABI	Binaries
arm64-v8a	here
armeabi-v7a	here
x86	here
x86_64	here

More about Application Binary Interface (ABI): https://developer.android.com/ndk/guides/abis

To get supported ABI by an Android device:

adb shell getprop ro.product.cpu.abilist

Build

Prerequisites

Docker

Running

1. Clone this repo
2. Build image from Dockerfile

docker build -t android-ndk:latest .

3. Run container and fetch binaries

docker run -d --name android-ndk-container android-ndk
mkdir -p binaries
docker cp -a android-ndk-container:/tmp/libs binaries
docker stop android-ndk-container

Usage

Upload a binary file (with compatible ABI) to an Android device

adb push <LOCAL_PATH_TO_BINARY_FILE>/<BINARY_NAME> /data/local/tmp/<BINARY_NAME>
adb shell chmod 777 /data/local/tmp/<BINARY_NAME>

iperf

Set a default iperf

adb shell ln -s /data/local/tmp/<IPERF2_BINARY_NAME> iperf

Execute iperf

adb shell /data/local/tmp/iperf <IPERF_ARGUMENTS>

iperf3

Set a default iperf3

adb shell ln -s /data/local/tmp/<IPERF3_BINARY_NAME> iperf3

Execute iperf3

adb shell /data/local/tmp/iperf3 <IPERF_ARGUMENTS>

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

iPerf community - iperf.fr