README.md

April 28, 2025 · View on GitHub

Repository Purpose

This repository is a fork of the original iPerf3 repository specifically adapted for use with the OpenMobileNetworkToolkit developed by Fraunhofer FOKUS. Adapted versions of iPerf will be tagged with the format v3.XX.

Current adapted version is iPerf 3.18

How to use the Shared Library

1. How to build/get libiperf

You can download the latest libiperf from here, or you can build it locally with the Docker file:

docker build -t android-ndk:latest . 
docker run -d --name android-ndk-container android-ndk 
docker cp -a android-ndk-container:/tmp/iperf/jniLibs ./

2. Add the files to the Android App

Copy the executables to the jniLibs path, the default path is app/src/main/jniLibs. For every ABI a directory needs to be created. It should look like this:

app/src/main/jniLibs/
├─ arm64-v8a/
│  ├─ libiperf3.12.so
├─ armeabi-v7a/
│  ├─ libiperf3.12.so
├─ x86/
│  ├─ libiperf3.12.so
├─ x86_64/
│  ├─ libiperf3.12.so

3. Integrate iPerf into an android app

Load the Library

static {
    System.loadLibrary("iperf3.18");
    Log.i(TAG, "iperf.so loaded!");
}

Add the wrapepr function to the App

private native int iperf3Wrapper(String[] argv, String nativeLibraryDir);

Add the call to the App

iperf3Wrapper(cmd, getApplicationContext().getApplicationInfo().nativeLibraryDir);

For a working example have a look here

Please note

Starting with v3.18 we do not patch iPerf3 anymore, since we use now the RemoteWorkManager-API of Android, starting with OMNT Release 0.6.

Acknowledgments