17685ff73b
Cargo's debug profile is not "slower" for this library — it is unusable, and it invalidated every on-device performance test to date: RustCrypto's AES-GCM compiles to generic-array iterator closures with per-byte precondition checks instead of ARMv8 hardware AES. Profiled live on a phone (simpleperf, 62k samples): ~800 µs of user CPU per 1.4 KB packet — the receive pump pinned above a full core yet only draining ~1,400 pkt/s of a 1,775 pkt/s (20 Mbps) stream, 2.3 MB standing in the kernel socket buffer, the latency-bound flush firing every 2 s forever. With release rust in the same debug APK: pump at ~12 % of a core, socket queue zero, no flushes, 2800x1260@120 streaming clean. preDebugBuild now depends on cargoNdkRelease; `-PrustDebug` opts back into a debug-profile native build for sessions that actually step through Rust. Kotlin debuggability is unchanged. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
128 lines
6.9 KiB
Kotlin
128 lines
6.9 KiB
Kotlin
import java.io.File
|
|
import java.util.Properties
|
|
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
|
|
|
|
plugins {
|
|
// AGP 9 built-in Kotlin compiles this module's Kotlin (NativeBridge) — no kotlin.android plugin.
|
|
id("com.android.library")
|
|
}
|
|
|
|
val ndkVer = "30.0.14904198" // r30-beta1 — matches the SDK NDK installed for cargo-ndk
|
|
|
|
android {
|
|
namespace = "io.unom.punktfunk.kit"
|
|
compileSdk = 37 // Android 17 — align with :app (androidx.core 1.19.0 requires it)
|
|
ndkVersion = ndkVer
|
|
|
|
defaultConfig {
|
|
minSdk = 28 // Android 9 — reaches older TV boxes; API 31+ features are runtime-gated.
|
|
// Keep in lockstep with :app — 32-bit armeabi-v7a for the many 32-bit Google TV / Android TV
|
|
// boxes, 64-bit arm64-v8a for phones + modern TV, x86_64 for the emulator.
|
|
ndk { abiFilters += listOf("arm64-v8a", "armeabi-v7a", "x86_64") }
|
|
}
|
|
compileOptions {
|
|
sourceCompatibility = JavaVersion.VERSION_21
|
|
targetCompatibility = JavaVersion.VERSION_21
|
|
}
|
|
packaging { jniLibs { useLegacyPackaging = false } } // 16 KB-page friendly
|
|
}
|
|
|
|
kotlin { compilerOptions { jvmTarget.set(JvmTarget.JVM_21) } }
|
|
|
|
dependencies {
|
|
// mTLS HTTPS client for the host's management API (the game-library fetch + cover-art loads).
|
|
// OkHttp lets us present the paired client cert and pin the host's self-signed cert by SHA-256.
|
|
implementation("com.squareup.okhttp3:okhttp:4.12.0")
|
|
testImplementation("junit:junit:4.13.2") // JVM unit test for the pure TXT parser
|
|
}
|
|
|
|
// ------------------------------------------------------------------------------------------------
|
|
// cargo-ndk: cross-compile clients/android/native (punktfunk-client-android) into this module's jniLibs/<abi>/ so the
|
|
// resulting libpunktfunk_android.so is packaged into the app (and any AAR this module produces).
|
|
// NDK r28+ aligns to 16 KB pages by default — no extra linker flags. Prereqs (see clients/android
|
|
// /README.md): `cargo install cargo-ndk` + `rustup target add aarch64-linux-android x86_64-linux-android`.
|
|
// ------------------------------------------------------------------------------------------------
|
|
val repoRoot = rootDir.parentFile.parentFile // clients/android -> clients -> repo root
|
|
val cargoBin = "${System.getProperty("user.home")}/.cargo/bin"
|
|
|
|
// SDK location without depending on AGP's DSL (sdkDirectory isn't in AGP 9's library extension):
|
|
// env first (set by Android Studio and by our CLI shell), then local.properties, then the default.
|
|
fun androidSdkDir(): String {
|
|
System.getenv("ANDROID_HOME")?.let { return it }
|
|
System.getenv("ANDROID_SDK_ROOT")?.let { return it }
|
|
val lp = rootProject.file("local.properties")
|
|
if (lp.exists()) {
|
|
val props = Properties()
|
|
lp.inputStream().use { props.load(it) }
|
|
props.getProperty("sdk.dir")?.let { return it }
|
|
}
|
|
return "${System.getProperty("user.home")}/Library/Android/sdk"
|
|
}
|
|
|
|
fun registerCargoNdk(taskName: String, release: Boolean) =
|
|
tasks.register<Exec>(taskName) {
|
|
group = "rust"
|
|
description = "cargo-ndk build of punktfunk-client-android (${if (release) "release" else "debug"})"
|
|
workingDir = repoRoot
|
|
val sdk = androidSdkDir()
|
|
// A GUI Android Studio launch does not source the login shell, so make cargo, the NDK, and
|
|
// cmake (libopus builds via the cmake crate) discoverable explicitly — same as a bare CLI.
|
|
val cmakeBin = "$sdk/cmake/3.22.1/bin"
|
|
environment(
|
|
"PATH",
|
|
cargoBin + File.pathSeparator + cmakeBin + File.pathSeparator + System.getenv("PATH"),
|
|
)
|
|
environment("ANDROID_HOME", sdk)
|
|
environment("ANDROID_NDK_HOME", "$sdk/ndk/$ndkVer")
|
|
// CMake's built-in Android support (used by the cmake crate for libopus) finds the NDK via
|
|
// these, and uses Ninja (bundled next to the SDK cmake) since there's no `make`.
|
|
environment("ANDROID_NDK_ROOT", "$sdk/ndk/$ndkVer")
|
|
environment("ANDROID_NDK", "$sdk/ndk/$ndkVer")
|
|
environment("CMAKE_GENERATOR", "Ninja")
|
|
// audiopus_sys picks static-vs-dynamic by HOST not target — force the bundled static libopus
|
|
// (pure C) so the android .so links it instead of looking for the host's libopus.so.
|
|
environment("LIBOPUS_STATIC", "1")
|
|
environment("LIBOPUS_NO_PKG", "1")
|
|
// Resolve cargo by ABSOLUTE path: Gradle's Exec resolves command[0] via the JVM's
|
|
// inherited PATH, NOT the environment("PATH", …) set above (that only reaches the spawned
|
|
// child). A GUI Android Studio launch (and any daemon it started) has no ~/.cargo/bin on
|
|
// its PATH, so a bare "cargo" fails to start. The env PATH above still lets cargo/cargo-ndk
|
|
// find their subtools.
|
|
val cmd = mutableListOf(
|
|
"$cargoBin/cargo", "ndk",
|
|
"-t", "arm64-v8a", "-t", "armeabi-v7a", "-t", "x86_64",
|
|
// Link against the minSdk-28 sysroot: libaaudio (API 26) is present, and building at the
|
|
// floor makes the linker reject any accidental >28 hard import (the one API-30 call we
|
|
// make, ANativeWindow_setFrameRate, is dlsym-resolved — see decode::try_set_frame_rate).
|
|
"--platform", "28",
|
|
"-o", file("src/main/jniLibs").absolutePath,
|
|
"build", "-p", "punktfunk-client-android",
|
|
)
|
|
if (release) cmd += "--release"
|
|
commandLine(cmd)
|
|
}
|
|
|
|
val cargoNdkDebug = registerCargoNdk("cargoNdkDebug", release = false)
|
|
val cargoNdkRelease = registerCargoNdk("cargoNdkRelease", release = true)
|
|
|
|
afterEvaluate {
|
|
// `-PskipRustBuild` skips the cargo-ndk native build — for JVM-only tasks (the Roborazzi
|
|
// screenshot unit tests render Compose on the JVM and never load libpunktfunk_android.so), so
|
|
// CI/local screenshot runs don't need the Rust toolchain or NDK. The native build stays wired
|
|
// for every normal APK/AAR build.
|
|
//
|
|
// DEBUG APKs SHIP RELEASE RUST. Cargo's debug profile is not "a bit slower" for this library —
|
|
// it is unusable: the AES-GCM data-plane decrypt runs through generic-array iterator closures
|
|
// with per-byte UB checks instead of ARMv8 hardware AES. Profiled live on a phone (simpleperf):
|
|
// ~800 µs of user CPU per 1.4 KB packet, the receive pump pinned over a full core yet unable to
|
|
// drain a 20 Mbps stream — every debug-APK on-device test was silently benchmarking unoptimized
|
|
// crypto, not the streaming pipeline. Kotlin debuggability is untouched (the APK is still a
|
|
// debug build); only the cargo profile changes. `-PrustDebug` restores a debug-profile native
|
|
// build for the rare session that actually steps through Rust.
|
|
if (!project.hasProperty("skipRustBuild")) {
|
|
val debugRust = if (project.hasProperty("rustDebug")) cargoNdkDebug else cargoNdkRelease
|
|
tasks.named("preDebugBuild").configure { dependsOn(debugRust) }
|
|
tasks.named("preReleaseBuild").configure { dependsOn(cargoNdkRelease) }
|
|
}
|
|
}
|