android-iperf3

This repository is practically a copy of the KnightWhoSayNi/android-iperf/ repository for iperf3 (but not iperf2), to continue building iperf3 for Android. Note that this repository starts with iperf3 version 3.14, while the old repository stopped at version 3.10.1.

Getting Started

What is 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.

https://iperf.fr/

Remark No iperf3 source codes are included in this repo

Supported versions

Version	Release day	Source Code
3.13-mt-beta3	2023-05-17	Source Code
3.14	2023-07-07	Source Code
3.15	2023-09-27	Source Code
3.16-beta1	2023-11-15	Source Code
3.16	2023-12-01	Source Code
3.17.1	2024-05-13	Source Code

Download

Compiled iperf3 binaries using SDK 9477386_latest and NDK r22 for devices with Android 9.0+ (API level 28+).

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
docker rm 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>

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

KnightWhoSayNi