How succubussix/winlator-bionic-glibc works
Project Type and Purpose
• This is a full-stack Android application (“Winlator”) whose goal is to run Windows x86_64 applications on Android devices by embedding and orchestrating several native components (Wine, Box86/Box64, PRoot, Mesa drivers, DXVK/VKD3D, etc.) alongside a rich Java-based UI.
File Structure
• Top-level “app” directory: the Android Gradle project, containing
• Java/Kotlin code under app/src/main/java/com/winlator/cmod (Activities, Fragments, Managers, Dialogs)
• JNI-native C/C++ under app/src/main/cpp (modules: winlator, proot, sysvshm, virglrenderer, OpenXR-SDK, etc.)
• Assets (root filesystems, tarballs for Box86/Box64, DXVK, drivers)
• Prebuilt JNI libraries under jniLibs
• Separate native plugin projects: android_sysvshm, audio_plugin
• Input control presets under input_controls
• Build/config files: build.gradle, CMakeLists.txt, cross-compile toolchains
README for Additional Insights
• Confirms critical runtime dependencies: Wine, Box86/Box64, PRoot, Mesa, DXVK, VKD3D.
• Describes features: container settings, presets, environment variables.
• Use cases: launching Windows games/apps, per-shortcut configuration.
Main Architectural Components
a. Android UI Layer
• Activities & Fragments (MainActivity, ContainerDetailFragment, XServerDisplayActivity, TerminalActivity, etc.)
• Managers (ContainerManager, ContentsManager, EnvironmentManager)
b. Java-to-Native Bridge (JNI)
• NativeRenderer, GLRenderer, ALSAClient, SysVSharedMemory, XConnector, WineRequestHandler
c. Environment Orchestration Layer
• PRoot-based process launcher
• Container components (mounting rootfs, injecting env vars)
• AudioPlugin (ALSA server plugin)
• SysV shared memory module
d. Native Emulation & Rendering Engines
• Box86/Box64 binaries
• Wine binaries
• Mesa drivers (VirGLRenderer, Turnip/Zink)
• DXVK/VKD3D wrappers
• OpenXR-SDK (for XR support)
e. X Server & Input Handling
• Java XServer implementation (com.winlator.cmod.xserver)
• XConnector for Unix-socket communication
f. Asset & Filesystem Layer
• Prepackaged rootfs tarballs (Ubuntu Focal)
• DLLs, libraries, tarballs in assets
g. External Services
• SteamGrid API client for big-picture covers
Relationships and Data Flow
1. User interacts with Android UI → triggers ContainerManager in Java
2. ContainerManager uses EnvironmentManager → invokes JNI to launch PRoot
3. PRoot spawns processes: Box86/Box64 → loads Windows exe via Wine
4. Application’s Windows GUI calls X11 → goes over XConnector (Unix socket) → Java XServer → renders via GLSurfaceView with NativeRenderer/GLRenderer
5. Audio calls → forwarded via ALSAClient (JNI) → AudioPlugin C code → Android audio system
6. Shared memory segments managed by SysVSHM module between native processes and Java XServer
7. Input events (touch/gamepad) from Android → injected into XServer event queue → delivered to Windows app
Architectural Patterns & Design Principles
• MVC/MVP within Android UI: Activities/Fragments separate view logic from Managers.
• “Service Oriented” within container: discrete native services communicate over Unix sockets or shared memory.
• JNI as boundary between managed (Java) and unmanaged (C/C++) code.
• Modularization: each native component (proot, sysvshm, audio, virgl) lives in its own directory/CMake module for independent builds.
• Use of cross-compile toolchains (cross-armhf.cmake, cross-arm64.cmake) for multi-ABI support.
Technologies & Frameworks
• Android SDK / Gradle / Jetpack
• Java (Android) + JNI + C/C++ (NDK)
• CMake build system, shell build scripts
• PRoot, patchelf, Box86/Box64, Wine, FEXCore
• Mesa (VirGL, Turnip, Zink), DXVK, VKD3D
• OpenXR-SDK for VR support
Detail
• Major native module (proot, sysvshm, audio_plugin, virglrenderer)
• Cross-component communication (Unix sockets, shared memory)
• Relevant config files (assets JSONs, RC files)
• Critical environment variables (e.g., MESA_EXTENSION_MAX_YEAR)