diff --git a/.coderabbit.yaml b/.coderabbit.yaml index ef66d13d74..c83ae0e95d 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -18,7 +18,7 @@ reviews: enabled: true auto_incremental_review: true auto_pause_after_reviewed_commits: 0 - drafts: false + drafts: true pre_merge_checks: docstrings: mode: "off" diff --git a/.gitattributes b/.gitattributes index 940dbb5f13..019aa1e8f9 100644 --- a/.gitattributes +++ b/.gitattributes @@ -10,3 +10,5 @@ tools/mangoapp/mangoapp text eol=lf app/src/main/assets/desktop-removal/*.json text eol=lf app/src/main/assets/desktop-removal/*.txt text eol=lf *.pdf binary + +app/src/main/resources/ea/graphql/*.gql -text diff --git a/.github/trusted-test-builds.txt b/.github/trusted-test-builds.txt index 8f7b0148c5..fa4cff1104 100644 --- a/.github/trusted-test-builds.txt +++ b/.github/trusted-test-builds.txt @@ -1,5 +1,7 @@ ASEbrahim FX192 K11MCH1 +KeegantheVeganat0r kingokksa ovurrsl +KeegantheVeganat0r diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e66bb49a0e..93b7bf0e45 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -195,6 +195,7 @@ jobs: !app/src/main/assets/linuxfs/i386/libfaultreport.so !app/src/main/assets/linuxfs/libblaudit.so !app/src/main/assets/linuxfs/libblfastpath.so + !app/src/main/assets/linuxfs/libddnatv-hook.so !app/src/main/assets/linuxfs/libblsession.so !app/src/main/assets/linuxfs/libfakeinput.so !app/src/main/assets/linuxfs/libssbs.so @@ -313,6 +314,11 @@ jobs: - name: Build the DiRT 3 / DiRT Showdown ws2_32 stand-in run: python3 tools/components/prepare.py dirt-ws2 + - name: Cache graphics driver inputs + uses: actions/cache@v4 + with: + path: app/build/quest-inputs + key: quest-inputs-${{ hashFiles('tools/quest/build-driver.py') }} - name: Prepare graphics driver variants run: python3 tools/quest/build-driver.py "$ANDROID_HOME/ndk/$NDK_VERSION" - name: Record and pack prepared components @@ -550,6 +556,12 @@ jobs: SOURCE_TREE: ${{ needs.source.outputs.tree-sha }} run: python3 tools/components/prepare.py unpack --tree "$SOURCE_TREE" + - name: Ubisoft launcher service (x86_64-pc-windows-gnu) + run: | + set -euo pipefail + command -v x86_64-w64-mingw32-gcc >/dev/null || { sudo apt-get update -qq && sudo apt-get install -y -qq gcc-mingw-w64-x86-64; } + bash tools/ubisoft-launcher/build.sh + - uses: actions/download-artifact@v4 with: name: xbox-arm64 @@ -558,9 +570,11 @@ jobs: - name: Cache checksum-pinned pack inputs uses: actions/cache@v4 with: - path: ~/.cache/droiddeck-pack-inputs - key: pack-inputs-v1-${{ hashFiles('tools/packs/build.sh', 'tools/packs/fetch-verified.sh', 'tools/packs/tracking/release.env') }} - restore-keys: pack-inputs-v1- + path: | + ~/.cache/droiddeck-pack-inputs + ~/.cache/droiddeck-build + key: pack-inputs-v2-${{ hashFiles('tools/packs/build.sh', 'tools/packs/fetch-verified.sh', 'tools/packs/tracking/release.env', 'tools/powervr/release.json') }} + restore-keys: pack-inputs-v2- - name: Build the add-on packs run: | python3 tools/powervr/fetch.py @@ -784,6 +798,9 @@ jobs: set -o pipefail cd app/src/main/rust/stores cargo test --locked 2>&1 | tail -60 + - name: Ubisoft launcher service host unit tests + timeout-minutes: 10 + run: cargo test --locked --manifest-path tools/ubisoft-launcher/Cargo.toml python-runner: needs: source @@ -883,6 +900,17 @@ jobs: variants: ${{ needs.build.outputs.variants }} secrets: inherit + scan: + needs: sign + if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' + permissions: + contents: read + uses: ./.github/workflows/scan.yml + with: + artifact: droiddeck-signed + variant: standard + secrets: inherit + packs: needs: [build, checks] if: github.event_name != 'pull_request' && github.ref == 'refs/heads/main' diff --git a/.github/workflows/pick-runner.yml b/.github/workflows/pick-runner.yml index 5eee6bc57c..cb2a0b0ffd 100644 --- a/.github/workflows/pick-runner.yml +++ b/.github/workflows/pick-runner.yml @@ -17,7 +17,7 @@ jobs: runs-on: ubuntu-24.04 timeout-minutes: 2 outputs: - labels: ${{ steps.runner.outputs.labels || '"ubuntu-24.04"' }} + labels: ${{ steps.runner.outputs.labels || steps.fork.outputs.labels || '"ubuntu-24.04"' }} steps: - name: Pick the compile runner id: runner @@ -36,3 +36,25 @@ jobs: fi echo "labels=$labels" >> "$GITHUB_OUTPUT" echo "Compile runner: \`$labels\`" >> "$GITHUB_STEP_SUMMARY" + - name: Pick the fork runner + id: fork + if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name != github.repository + continue-on-error: true + env: + GH_TOKEN: ${{ github.token }} + run: | + set -euo pipefail + labels='"ubuntu-24.04"' + gist=https://api.github.com/gists/0c7ed7ad6d6493de84f5123689c64ae6 + body=$(curl -fsS --max-time 15 -H "Authorization: Bearer $GH_TOKEN" "$gist" 2>/dev/null || curl -fsS --max-time 15 "$gist" 2>/dev/null || echo '{}') + IDLE_AT=$(jq -r 'select(.owner.login == "maxjivi05") | .files["idle-at"].content // "0"' <<< "$body" 2>/dev/null || echo 0) + echo "Heartbeat: ${IDLE_AT:-none}" + age=-1 + if [[ "${IDLE_AT:-0}" =~ ^[0-9]+$ ]] && [ "${IDLE_AT:-0}" -gt 0 ]; then + age=$(( $(date +%s) - IDLE_AT )) + fi + if [ "$age" -ge 0 ] && [ "$age" -lt 180 ]; then + labels='"droiddeck-fork"' + fi + echo "labels=$labels" >> "$GITHUB_OUTPUT" + echo "Compile runner: \`$labels\`" >> "$GITHUB_STEP_SUMMARY" diff --git a/.github/workflows/publish-packs.yml b/.github/workflows/publish-packs.yml index ca61616d18..53e26f4ed8 100644 --- a/.github/workflows/publish-packs.yml +++ b/.github/workflows/publish-packs.yml @@ -55,7 +55,7 @@ jobs: jq -r --arg n "$2" '.assets // [] | .[] | select(.name == $n) | .digest // empty' } commit=$(gh api "repos/$GITHUB_REPOSITORY/actions/runs/$BUILD_RUN" --jq .head_sha 2>/dev/null || echo "$GITHUB_SHA") - for name in proot directaudio tracking xbox comet butler powervr; do + for name in proot directaudio tracking xbox comet butler powervr ubisoft; do file="packs/$name.tar.zst" [ -f "$file" ] || { echo "::error::$name.tar.zst is missing from Build APK run $BUILD_RUN"; exit 1; } sha=$(sha256sum "$file" | cut -d' ' -f1) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a151592681..eabc77a358 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -63,6 +63,15 @@ jobs: artifact: droiddeck-release secrets: inherit + scan: + needs: sign + permissions: + contents: read + uses: ./.github/workflows/scan.yml + with: + artifact: droiddeck-release + secrets: inherit + packs: needs: find permissions: diff --git a/.github/workflows/scan.yml b/.github/workflows/scan.yml new file mode 100644 index 0000000000..9790f40c7b --- /dev/null +++ b/.github/workflows/scan.yml @@ -0,0 +1,49 @@ +name: Scan APKs + +on: + workflow_call: + inputs: + artifact: + description: Prefix of the signed artifacts to scan, as passed to sign.yml + type: string + required: true + variant: + description: Variant to scan, as listed in tools/release/variants.txt; every variant when omitted + type: string + default: '*' + fail_on_detection: + type: boolean + default: false + +permissions: + contents: read + +jobs: + virustotal: + name: VirusTotal + runs-on: ubuntu-24.04 + timeout-minutes: 90 + steps: + - uses: actions/checkout@v4 + with: + persist-credentials: false + sparse-checkout: tools/release + + - uses: actions/download-artifact@v4 + with: + pattern: ${{ inputs.artifact }}-${{ inputs.variant }} + merge-multiple: true + path: scan + + - name: Scan + continue-on-error: ${{ !inputs.fail_on_detection }} + env: + VT_API_KEY: ${{ secrets.VIRUSTOTAL_API_KEY }} + FAIL_ON_DETECTION: ${{ inputs.fail_on_detection && '1' || '0' }} + run: | + set -euo pipefail + if [ -z "$VT_API_KEY" ]; then + echo "::warning title=VirusTotal::no VIRUSTOTAL_API_KEY secret; skipping the scan" + exit 0 + fi + bash tools/release/virustotal-scan.sh scan/*.apk diff --git a/README.md b/README.md index 606b7a6707..73c18762b1 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@ DroidDeck brings the SteamOS experience to Android: Steam Gaming Mode, full Linux desktop, integration with GOG, Epic Games, Xbox, and other storefronts, Steam VR, and more! -

100% open source. No ads. No telemetry. No source withheld.

+

100% open source. No ads. No telemetry. No proprietary components. No source withheld.

- Download DroidDeck 0.6.9 + Download DroidDeck 0.7.1 Join the DroidDeck Discord

@@ -36,9 +36,9 @@ DroidDeck brings the SteamOS experience to Android: Steam Gaming Mode, full Linu ## Install -1. Android 9 or newer on Adreno 730 or newer, or any 8xx. Adreno 6xx is experimental. Mali, Xclipse, PowerVR and Adreno 710 are unsupported. No root needed. +1. Android 9 or newer on Adreno 730 or newer, or any 8xx. Adreno 6xx, Mali, Xclipse and PowerVR are experimental. Adreno 710 is currently unsupported. No root needed. 2. About 3 GB free for the runtime, plus 1.1 GB for the desktop and emulators. -3. Install the [APK](https://github.com/Droid-Deck/DroidDeck/releases/download/0.6.9/DroidDeck-0.6.9.apk), install the Linux runtime, press **Play** and sign in to Steam. +3. Install the [APK](https://github.com/Droid-Deck/DroidDeck/releases/download/0.7.1/DroidDeck-0.7.1.apk), install the Linux runtime, press **Play** and sign in to Steam. 4. On Android 14 and newer, turn on **Disable child process restrictions** in Developer options. On Android 12 and 13, Steam's first launch shows a **Fix it for me** button that walks you through it. Smart glasses setup is in the [support matrix](docs/smart-glasses-support.md). Release notes are in [docs/releases](docs/releases). @@ -79,7 +79,8 @@ DroidDeck is [GPL-3.0](LICENSE). Steam and Proton belong to Valve Corporation. V - droiddeck-ntsync follows the [Linux](https://github.com/torvalds/linux) ntsync semantics in `Documentation/userspace-api/ntsync.rst` (GPL-2.0). - The proot fast path orders bindings like [PRoot](https://github.com/proot-me/proot)'s `path/binding.c` (GPL-2.0-or-later). - DiRT 3 and DiRT Showdown keep their telemetry socket the way RoccoC's DiRTTelemetryErrorFix (MIT) does, based on the fix by Carsten Gottschling. -- Games use [Mesa](https://gitlab.freedesktop.org/mesa/mesa) Turnip's per render pass memory choice. The Steam client keeps `TU_DEBUG=sysmem`. +- Zink on PowerVR keeps colour textures in colour with Icenowy Zheng's upstream [Mesa](https://gitlab.freedesktop.org/mesa/mesa) fix d55418dae7 (MIT), carried as a runtime patch. +- Games and AppImage, Flatpak and Snap programs such as emulators use [Mesa](https://gitlab.freedesktop.org/mesa/mesa) Turnip's per render pass memory choice. The Steam client and Chromium-based apps keep `TU_DEBUG=sysmem`. - Black Ops III and Dark Souls Remastered start without [umu-protonfixes](https://github.com/Open-Wine-Components/umu-protonfixes) (BSD-2-Clause), whose `311210.py` and `570940.py` fail under ARM64 Proton. - [ReSkate](https://github.com/Dingo-Shenanigans/ReSkate) (GPL-3.0) by Dingo Shenanigans uses the launch option from its README and D3D12 feature level 12_1. - The arm64 client's sign in was checked by reading Steam's saved token with the `ConnectCache` format from [deadlock-api-ingest](https://github.com/deadlock-api/deadlock-api-ingest). @@ -92,6 +93,7 @@ DroidDeck is [GPL-3.0](LICENSE). Steam and Proton belong to Valve Corporation. V - Epic Games and GOG build on [Phobos](https://github.com/phobos665)'s adaptation of [Legendary](https://github.com/legendary-gl/legendary) and [gogdl](https://github.com/Heroic-Games-Launcher/heroic-gogdl). GOG install script registry entries are read the way [Heroic Games Launcher](https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher) (GPL-3.0) reads them. - Epic's official Linux launcher preview runs through FEX. That setup is outside Epic's listed Linux support. - Battle.net is by [@kayakyakr](https://github.com/kayakyakr). It runs Blizzard's own client in Proton (downloaded from Blizzard, not included) and shows key art from the [Battle.net Shop](https://shop.battle.net). Without Steam, its games see the pad as an Xbox 360 controller via `PROTON_SPOOF_STEAMINPUT_VIDPID` in [Proton](https://github.com/ValveSoftware/wine)'s `dlls/winebus.sys`. +- The EA store follows the EA app's protocols as documented by [ArmchairDevelopers](https://github.com/ArmchairDevelopers)' [Maxima](https://github.com/ArmchairDevelopers/Maxima) (GPL-3.0): sign-in, the GraphQL queries (included verbatim, since EA matches them by hash), build archives, online activation licences and the LSX game endpoint. The code is DroidDeck's own. - Battle.net installs drive Blizzard's Agent the way [@barncastle](https://github.com/barncastle)'s [Battle.Net-Installer](https://github.com/barncastle/Battle.Net-Installer) does, with requests from [wowdev.wiki](https://wowdev.wiki/Agent). Read without taking code: [@mubaraknumann](https://github.com/mubaraknumann)'s [unifideck](https://github.com/mubaraknumann/unifideck), [@djmittens](https://github.com/djmittens)'s [neo-mittens](https://github.com/djmittens/neo-mittens) `bnetswitch`, [@BCD1210](https://github.com/BCD1210)'s [soju](https://github.com/BCD1210/soju) and [Lutris](https://github.com/lutris/lutris)'s `product.db` reader. - World of Warcraft addon imports replace an addon's folder from a temporary copy, as [WowUp](https://github.com/WowUp/WowUp) does, and read flavour folders the way [WoWDeck](https://github.com/sigboe/wowdeck) does. No code from either is used. - The World of Warcraft addon Download window searches [WoWInterface](https://www.wowinterface.com) through its MMOUI API. [CurseForge](https://www.curseforge.com/wow) opens in the user's browser, with no API and no key. diff --git a/app/build.gradle b/app/build.gradle index 743ad2a847..28bf184e32 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -93,7 +93,7 @@ def trackingPack = rootProject.file('tools/packs/tracking/release.env').readLine def prootPackPin = rootProject.file('tools/packs/proot/release.env').readLines() .findAll { it.contains('=') && !it.startsWith('#') } .collectEntries { def kv = it.split('=', 2); [(kv[0].trim()): kv[1].trim()] } -def addonPacks = ['proot', 'directaudio', 'tracking', 'xbox', 'comet', 'butler', 'powervr'].collectEntries { name -> +def addonPacks = ['proot', 'directaudio', 'tracking', 'xbox', 'comet', 'butler', 'powervr', 'ubisoft'].collectEntries { name -> def pack = file("build/packs/${name}.tar.zst") if (!pack.isFile()) { if (ciBuild) throw new GradleException("Add-on pack ${pack} is missing: run tools/packs/build.sh app/build/packs") @@ -131,8 +131,8 @@ android { applicationId "com.droiddeck.launcher" minSdkVersion 26 targetSdkVersion 28 - versionCode 17 - versionName "0.6.9" + versionCode 19 + versionName "0.7.1" buildConfigField "String", "BUILD_LABEL", "\"${escapedBuildLabel}\"" buildConfigField "String", "SOURCE_COMMIT", "\"${sourceCommit}\"" buildConfigField "int", "PR_NUMBER", "${prNumber}" @@ -205,7 +205,7 @@ android { } androidResources { - ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:_*:!CVS:!thumbs.db:!picasa.ini:!*~:droiddeck-xbox:droiddeck-comet:directaudio:hybris' + ignoreAssetsPattern '!.svn:!.git:!.ds_store:!*.scc:.*:_*:!CVS:!thumbs.db:!picasa.ini:!*~:droiddeck-xbox:droiddeck-comet:droiddeck-ubisoft:directaudio:hybris' } packagingOptions { diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml index 5f010b48d3..514b4d9146 100644 --- a/app/src/main/AndroidManifest.xml +++ b/app/src/main/AndroidManifest.xml @@ -91,14 +91,6 @@ - - - - - @@ -266,6 +258,7 @@ android:exported="true" android:excludeFromRecents="true" android:noHistory="true" + android:taskAffinity="${applicationId}.agent" android:permission="android.permission.DUMP" android:theme="@style/SessionTheme" /> @@ -352,6 +345,14 @@ + + + + + #include #include +#include #include #include #include @@ -208,23 +209,33 @@ struct FakeConfig { bool uinput_enabled; }; +// The first allocation here can start the host program's own allocator, which may call a hooked +// function (mimalloc probes NUMA nodes with access()) and land back in config(). A guarded static +// would throw a recursive-init error there, so the fields are filled without allocating, and a +// reentry on the initializing thread gets them while other threads wait for the fork handlers. static FakeConfig &config() { - static FakeConfig *cfg = [] { - auto *c = new FakeConfig(); - const char *dir = getenv("FAKE_EVDEV_DIR"); - c->hook_dir = dir ? dir : "/data/data/com.termux/files/home/fake-input"; - c->udev_data_dir = getenv("FAKE_UDEV_DATA_DIR"); - c->vibration_enabled = - getenv("FAKE_EVDEV_VIBRATION") && atoi(getenv("FAKE_EVDEV_VIBRATION")); - const char *identity = getenv("FAKE_EVDEV_IDENTITY"); - c->xbox360_identity = identity && !strcmp(identity, "xbox360"); - c->uinput_enabled = getenv("FAKE_EVDEV_UINPUT") && atoi(getenv("FAKE_EVDEV_UINPUT")); - pthread_atfork(controller_fork_prepare, controller_fork_parent, - controller_fork_child); - Logger::init(); - return c; - }(); - return *cfg; + static FakeConfig cfg; + static std::atomic state{0}; + static __thread bool initializing __attribute__((tls_model("initial-exec"))); + if (state.load(std::memory_order_acquire) == 2 || initializing) return cfg; + int expected = 0; + if (!state.compare_exchange_strong(expected, 1, std::memory_order_acq_rel)) { + while (state.load(std::memory_order_acquire) != 2) sched_yield(); + return cfg; + } + initializing = true; + const char *dir = getenv("FAKE_EVDEV_DIR"); + cfg.hook_dir = dir ? dir : "/data/data/com.termux/files/home/fake-input"; + cfg.udev_data_dir = getenv("FAKE_UDEV_DATA_DIR"); + cfg.vibration_enabled = getenv("FAKE_EVDEV_VIBRATION") && atoi(getenv("FAKE_EVDEV_VIBRATION")); + const char *identity = getenv("FAKE_EVDEV_IDENTITY"); + cfg.xbox360_identity = identity && !strcmp(identity, "xbox360"); + cfg.uinput_enabled = getenv("FAKE_EVDEV_UINPUT") && atoi(getenv("FAKE_EVDEV_UINPUT")); + pthread_atfork(controller_fork_prepare, controller_fork_parent, controller_fork_child); + Logger::init(); + state.store(2, std::memory_order_release); + initializing = false; + return cfg; } static std::recursive_mutex &controller_mutex() { @@ -2311,7 +2322,15 @@ __attribute__((visibility("hidden"))) static bool is_deck_sysfs_path(const char if (!path) return false; if (!strncmp(path, "/sys/devices/droiddeck", 22) || !strncmp(path, "/sys/class/hidraw", 17)) return true; const char *listing = deck_listing_dir(); - return listing && !strncmp(path, listing, strlen(listing)); + if (!listing) return false; + if (!strncmp(path, listing, strlen(listing))) return true; + // Without proot, a descriptor's /proc/self/fd link names the stand-in where it really is (the + // listing's parent holds devices/ and class-hidraw/), not /sys + const char *slash = strrchr(listing, '/'); + if (!slash || slash == listing) return false; + size_t root = static_cast(slash - listing); + return !strncmp(path, listing, root) && path[root] == '/' && + (!strncmp(path + root, "/devices", 8) || !strncmp(path + root, "/class-hidraw", 13)); } __attribute__((visibility("hidden"))) static bool is_deck_sysfs_fd(int fd) { diff --git a/app/src/main/cpp/waylandcomp/src/vk_present.c b/app/src/main/cpp/waylandcomp/src/vk_present.c index 8d0267cc13..44fea0c768 100644 --- a/app/src/main/cpp/waylandcomp/src/vk_present.c +++ b/app/src/main/cpp/waylandcomp/src/vk_present.c @@ -213,7 +213,7 @@ static struct { } g_map; static pthread_mutex_t g_game_picture_lock = PTHREAD_MUTEX_INITIALIZER; static float g_game_picture_rect[4]; -static int g_game_picture_top; +static int g_game_picture_placed; static int64_t g_swap_retry_at_ns; static int g_swap_fail_logged; @@ -362,7 +362,7 @@ int vkp_completion_unknown(void) { return g_dev_state == -3; } void vk_present_set_scale_mode(int mode, int alignment) { if (mode < VKP_MODE_OFF || mode > VKP_MODE_INTEGER) mode = VKP_MODE_FIT; - if (alignment < VKP_ALIGN_CENTER || alignment > VKP_ALIGN_PICTURE_BOTTOM) alignment = VKP_ALIGN_CENTER; + if (alignment < VKP_ALIGN_CENTER || alignment > VKP_ALIGN_PICTURE_RIGHT) alignment = VKP_ALIGN_CENTER; g_mode = mode; g_align = alignment; } @@ -383,6 +383,8 @@ static const char *align_name(int a) { case VKP_ALIGN_BOTTOM: return "bottom"; case VKP_ALIGN_PICTURE_TOP: return "picture top"; case VKP_ALIGN_PICTURE_BOTTOM: return "picture bottom"; + case VKP_ALIGN_PICTURE_LEFT: return "picture left"; + case VKP_ALIGN_PICTURE_RIGHT: return "picture right"; default: return "center"; } } @@ -420,9 +422,11 @@ static void update_map(int scene_w, int scene_h) { } if (align == VKP_ALIGN_PICTURE_TOP) g_map.off_y = 0; else if (align == VKP_ALIGN_PICTURE_BOTTOM) g_map.off_y = H - scene_h * g_map.ky; + else if (align == VKP_ALIGN_PICTURE_LEFT) g_map.off_x = 0; + else if (align == VKP_ALIGN_PICTURE_RIGHT) g_map.off_x = W - scene_w * g_map.kx; g_map.valid = 1; pthread_mutex_lock(&g_game_picture_lock); - g_game_picture_top = align == VKP_ALIGN_PICTURE_TOP || align == VKP_ALIGN_PICTURE_BOTTOM; + g_game_picture_placed = align == VKP_ALIGN_PICTURE_TOP || align == VKP_ALIGN_PICTURE_BOTTOM || align == VKP_ALIGN_PICTURE_LEFT || align == VKP_ALIGN_PICTURE_RIGHT; g_game_picture_rect[0] = g_map.off_x; g_game_picture_rect[1] = g_map.off_y; g_game_picture_rect[2] = g_map.off_x + scene_w * g_map.kx; @@ -436,7 +440,7 @@ static void update_map(int scene_w, int scene_h) { int vkp_game_picture_rect(float rect[4]) { pthread_mutex_lock(&g_game_picture_lock); - int active = g_game_picture_top; + int active = g_game_picture_placed; if (active) memcpy(rect, g_game_picture_rect, sizeof(g_game_picture_rect)); pthread_mutex_unlock(&g_game_picture_lock); return active; diff --git a/app/src/main/cpp/waylandcomp/src/vk_present.h b/app/src/main/cpp/waylandcomp/src/vk_present.h index 3a76b4c0b6..2a363979e6 100644 --- a/app/src/main/cpp/waylandcomp/src/vk_present.h +++ b/app/src/main/cpp/waylandcomp/src/vk_present.h @@ -15,7 +15,9 @@ int vkp_quest_layer_presentation(void); enum vkp_scale_mode { VKP_MODE_OFF = 0, VKP_MODE_FIT = 1, VKP_MODE_STRETCH = 2, VKP_MODE_FILL = 3, VKP_MODE_INTEGER = 4 }; -enum vkp_align { VKP_ALIGN_CENTER = 0, VKP_ALIGN_TOP = 1, VKP_ALIGN_BOTTOM = 2, VKP_ALIGN_PICTURE_TOP = 3, VKP_ALIGN_PICTURE_BOTTOM = 4 }; +enum vkp_align { VKP_ALIGN_CENTER = 0, VKP_ALIGN_TOP = 1, VKP_ALIGN_BOTTOM = 2, + VKP_ALIGN_PICTURE_TOP = 3, VKP_ALIGN_PICTURE_BOTTOM = 4, + VKP_ALIGN_PICTURE_LEFT = 5, VKP_ALIGN_PICTURE_RIGHT = 6 }; void vk_present_set_scale_mode(int mode, int alignment); int vkp_game_picture_rect(float rect[4]); int vkp_output_to_scene(double ox, double oy, double *sx, double *sy); diff --git a/app/src/main/java/com/droiddeck/launcher/App.kt b/app/src/main/java/com/droiddeck/launcher/App.kt index 5ef39f6b6e..b4c1621a47 100644 --- a/app/src/main/java/com/droiddeck/launcher/App.kt +++ b/app/src/main/java/com/droiddeck/launcher/App.kt @@ -7,8 +7,11 @@ import com.droiddeck.launcher.session.EnhancedSessionLogShare import com.droiddeck.launcher.session.GpuClockPin class App : Application() { - override fun attachBaseContext(base: android.content.Context) = + override fun attachBaseContext(base: android.content.Context) { super.attachBaseContext(com.droiddeck.launcher.core.AppLanguage.wrap(base)) + val process = if (android.os.Build.VERSION.SDK_INT >= 28) Application.getProcessName() else packageName + com.droiddeck.launcher.lab.LabOverlay.load(this, process == packageName) + } override fun onConfigurationChanged(newConfig: android.content.res.Configuration) { super.onConfigurationChanged(newConfig) @@ -39,6 +42,7 @@ class App : Application() { if (process == "$packageName:vr_recovery" || process == "$packageName:rgb_diagnostic" || process == "$packageName:shortcuts_sync" || process == "$packageName:bottom_desktop") return CrashHandler.install(this) + com.droiddeck.launcher.lab.LabNotice.started(this) com.droiddeck.launcher.core.SteamIntegration.syncShortcutsListing(this) com.droiddeck.launcher.session.QuestExperimental.initialize(this) com.droiddeck.launcher.session.SessionPrefs.applyNtsyncDefault(this) @@ -61,6 +65,9 @@ class App : Application() { com.droiddeck.launcher.stores.StoresState.register(com.droiddeck.launcher.stores.xbox.XboxBackend) com.droiddeck.launcher.sync.Syncthing.init(this) com.droiddeck.launcher.stores.StoresState.register(com.droiddeck.launcher.stores.battlenet.BattleNetBackend) + com.droiddeck.launcher.stores.StoresState.register(com.droiddeck.launcher.stores.ubisoft.UbisoftBackend) + com.droiddeck.launcher.stores.ea.EaBackend.app = this + com.droiddeck.launcher.stores.StoresState.register(com.droiddeck.launcher.stores.ea.EaBackend) } private fun prefetchAddonPacks() { @@ -74,6 +81,8 @@ class App : Application() { if (com.droiddeck.launcher.stores.gog.GogComet.enabled(app)) com.droiddeck.launcher.core.AddonPack.COMET.ensure(app) if (com.droiddeck.launcher.stores.StoreAccounts.signedInAs(app, com.droiddeck.launcher.stores.Store.XBOX) != null) com.droiddeck.launcher.core.AddonPack.XBOX.ensure(app) + if (com.droiddeck.launcher.stores.StoreAccounts.signedInAs(app, com.droiddeck.launcher.stores.Store.UBISOFT) != null) + com.droiddeck.launcher.session.SessionFiles.ensureUbisoftService(app) com.droiddeck.launcher.handtracking.HandTracking.load(app) }.onFailure { android.util.Log.w("App", "add-on pack prefetch failed", it) } }, "addon-packs").start() diff --git a/app/src/main/java/com/droiddeck/launcher/DriverMenus.kt b/app/src/main/java/com/droiddeck/launcher/DriverMenus.kt index 669aad4e67..be0af56a06 100644 --- a/app/src/main/java/com/droiddeck/launcher/DriverMenus.kt +++ b/app/src/main/java/com/droiddeck/launcher/DriverMenus.kt @@ -603,11 +603,19 @@ internal class DriverMenus(private val activity: Activity, private val ui: Handl } fun selectDriver(id: String, linux: Boolean) { + if (!linux && id == TurnipDriver.AUTO) { + DriverBundle.selectDisplay(activity, id) + pairModeOpen = false + lastAutoCheck = 0L + setMode(auto = true) + refreshDrivers() + return + } val bundle = DriverBundle.containing(activity, id, linux) when { bundle != null -> useBundle(bundle) linux -> SessionPrefs.setLinuxDriver(activity, id) - else -> SessionPrefs.setAndroidDriver(activity, id) + else -> DriverBundle.selectDisplay(activity, id) } pairModeOpen = false setMode(auto = false, mix = true) diff --git a/app/src/main/java/com/droiddeck/launcher/FrontEndActivity.kt b/app/src/main/java/com/droiddeck/launcher/FrontEndActivity.kt index cbd9ba859b..f429efcbf7 100644 --- a/app/src/main/java/com/droiddeck/launcher/FrontEndActivity.kt +++ b/app/src/main/java/com/droiddeck/launcher/FrontEndActivity.kt @@ -23,6 +23,7 @@ import androidx.activity.ComponentActivity import androidx.activity.compose.setContent import androidx.activity.result.contract.ActivityResultContracts import androidx.compose.runtime.Composable +import androidx.compose.runtime.collectAsState import androidx.compose.runtime.getValue import androidx.compose.runtime.mutableIntStateOf import androidx.compose.runtime.mutableStateOf @@ -184,6 +185,7 @@ class FrontEndActivity : ComponentActivity() { private var gpuClockPin by mutableStateOf(false) private var prootNoSeccomp by mutableStateOf(false) private var prootFastPath by mutableStateOf(true) + private var nativeUserland by mutableStateOf(false) private var cursorComposite by mutableStateOf(false) private var guestHostname by mutableStateOf(SessionPrefs.DEFAULT_GUEST_HOSTNAME) private var phantomWarning by mutableStateOf(null) @@ -873,6 +875,7 @@ class FrontEndActivity : ComponentActivity() { android.widget.Toast.makeText(this, R.string.game_link_failed, android.widget.Toast.LENGTH_LONG).show() return false } + Library.recordPlayed(this, game) startActivity(Intent(this, SessionActivity::class.java).setAction(SessionService.ACTION_RESUME) .putExtra(SessionActivity.EXTRA_STEAMVR, steamVr) .returnTo(returnHome) @@ -888,7 +891,15 @@ class FrontEndActivity : ComponentActivity() { putExtra(SessionService.EXTRA_STEAM_URL, com.droiddeck.launcher.frontend.GameLaunchLink.steamUrl(game.gameIdString)) } - }, steamSession = true) + } + .playing(game), steamSession = true) + } + + private fun Intent.playing(game: Library.SteamGame): Intent = + apply { if (game.library == Library.ADDED) putExtra(SessionActivity.EXTRA_PLAYED_GAME, game.gameIdString) } + + private fun recordPlayed(intent: Intent) { + intent.getStringExtra(SessionActivity.EXTRA_PLAYED_GAME)?.let { Library.recordPlayed(this, it) } } private fun Intent.returnTo(returnHome: Boolean): Intent { @@ -915,14 +926,17 @@ class FrontEndActivity : ComponentActivity() { .putExtra(SessionService.EXTRA_PROGRAM, command.program) .putExtra(SessionService.EXTRA_PROGRAM_ARGS, command.args.toTypedArray()) .putExtra(SessionService.EXTRA_GAME_ID, com.droiddeck.launcher.session.NoSteamLaunch.scope(game)) + .playing(game) when { !SessionState.running -> startSessionOrWait(next) SessionState.stopRequested -> android.widget.Toast.makeText(this, R.string.game_link_session_busy, android.widget.Toast.LENGTH_LONG).show() - command.program == com.droiddeck.launcher.session.NoSteamLaunch.BATTLENET && handToBattleNet(command.args, returnHome) { pendingSwitch = next } -> {} - SessionState.mode == SessionService.MODE_RUN && SessionState.program == command.program && SessionState.programArgs == command.args -> + command.program == com.droiddeck.launcher.session.NoSteamLaunch.BATTLENET && handToBattleNet(command.args, next, returnHome) -> {} + SessionState.mode == SessionService.MODE_RUN && SessionState.program == command.program && SessionState.programArgs == command.args -> { + recordPlayed(next) startActivity(Intent(this, SessionActivity::class.java).setAction(SessionService.ACTION_RESUME) .returnTo(returnHome) .addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP or Intent.FLAG_ACTIVITY_SINGLE_TOP)) + } else -> pendingSwitch = next } } @@ -1123,6 +1137,10 @@ class FrontEndActivity : ComponentActivity() { applyLauncherFullscreen() updates.start() setContent { + val prootPack by com.droiddeck.launcher.core.AddonPack.PROOT.state.collectAsState() + androidx.compose.runtime.LaunchedEffect(prootPack) { + if (prootPack == com.droiddeck.launcher.core.AddonPack.State.Ready && installed == null) refresh() + } DroidDeckTheme(theme, appScale = appScale) { com.droiddeck.launcher.ui.FocusGlideHost(androidx.compose.ui.Modifier.fillMaxSize().exposeTestTags()) { if (decky.deckyPendingZip != null) com.droiddeck.launcher.ui.DeckyZipWarningDialog( @@ -2276,14 +2294,14 @@ class FrontEndActivity : ComponentActivity() { when { !SessionState.running -> startSessionOrWait(next) SessionState.stopRequested -> android.widget.Toast.makeText(this, R.string.game_link_session_busy, android.widget.Toast.LENGTH_LONG).show() - handToBattleNet(full) { pendingSwitch = next } -> {} + handToBattleNet(full, next) -> {} else -> pendingSwitch = next } } }, "battlenet-open").start() } - private fun handToBattleNet(args: List, returnHome: Boolean = false, otherwise: () -> Unit): Boolean { + private fun handToBattleNet(args: List, next: Intent, returnHome: Boolean = false): Boolean { if (SessionState.mode != SessionService.MODE_RUN || SessionState.program != com.droiddeck.launcher.session.NoSteamLaunch.BATTLENET) return false val library = args.takeIf { it.firstOrNull() == "--library" }?.getOrNull(1) val sessionLibrary = SessionState.programArgs.takeIf { it.firstOrNull() == "--library" }?.getOrNull(1) @@ -2294,10 +2312,13 @@ class FrontEndActivity : ComponentActivity() { val handed = request.isEmpty() || com.droiddeck.launcher.stores.battlenet.BattleNetClient.request(LinuxRuntime.sessionRoot(app), request) ui.post { if (isDestroyed) return@post - if (!handed) otherwise() - else startActivity(Intent(this, SessionActivity::class.java).setAction(SessionService.ACTION_RESUME) - .returnTo(returnHome) - .addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP or Intent.FLAG_ACTIVITY_SINGLE_TOP)) + if (!handed) pendingSwitch = next + else { + recordPlayed(next) + startActivity(Intent(this, SessionActivity::class.java).setAction(SessionService.ACTION_RESUME) + .returnTo(returnHome) + .addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP or Intent.FLAG_ACTIVITY_SINGLE_TOP)) + } } }, "battlenet-request").start() return true @@ -2537,7 +2558,7 @@ class FrontEndActivity : ComponentActivity() { deviceRamMb = (android.app.ActivityManager.MemoryInfo() .also((getSystemService(ACTIVITY_SERVICE) as android.app.ActivityManager)::getMemoryInfo).totalMem / (1024 * 1024)).toInt(), ramCapAvailable = com.droiddeck.launcher.core.ZramSupport.supported(), - prootNoSeccomp = prootNoSeccomp, prootFastPath = prootFastPath, cursorComposite = cursorComposite, + prootNoSeccomp = prootNoSeccomp, prootFastPath = prootFastPath, nativeUserland = nativeUserland, cursorComposite = cursorComposite, guestHostname = guestHostname, phantomWarning = phantomWarning, onClientOverride = { on -> SessionPrefs.setClientCpusOverride(this, on); clientOverride = on }, onTuSysmem = { on -> SessionPrefs.setTuSysmem(this, on); tuSysmem = on }, @@ -2555,6 +2576,7 @@ class FrontEndActivity : ComponentActivity() { onVramCapMb = { mb -> SessionPrefs.setVramCapMb(this, mb); vramCapMb = mb }, onProotNoSeccomp = { on -> SessionPrefs.setProotNoSeccomp(this, on); prootNoSeccomp = on }, onProotFastPath = { on -> SessionPrefs.setProotFastPath(this, on); prootFastPath = on }, + onNativeUserland = { on -> SessionPrefs.setNativeUserland(this, on); nativeUserland = on }, onCursorComposite = { on -> SessionPrefs.setCursorComposite(this, on); cursorComposite = on }, onGuestHostname = { name -> SessionPrefs.setGuestHostname(this, name) }, onClientCore = { core, on -> @@ -2777,6 +2799,7 @@ class FrontEndActivity : ComponentActivity() { gpuClockPin = SessionPrefs.gpuClockPin(this) prootNoSeccomp = SessionPrefs.prootNoSeccomp(this) prootFastPath = SessionPrefs.prootFastPath(this) + nativeUserland = SessionPrefs.nativeUserland(this) cursorComposite = SessionPrefs.cursorComposite(this) guestHostname = SessionPrefs.guestHostname(this) refreshPhantomStatus() diff --git a/app/src/main/java/com/droiddeck/launcher/SessionActivity.kt b/app/src/main/java/com/droiddeck/launcher/SessionActivity.kt index ed322ef176..5f39d03c6c 100644 --- a/app/src/main/java/com/droiddeck/launcher/SessionActivity.kt +++ b/app/src/main/java/com/droiddeck/launcher/SessionActivity.kt @@ -121,6 +121,7 @@ import com.droiddeck.launcher.session.SessionArtifacts import com.droiddeck.launcher.session.SessionLogShare import com.droiddeck.launcher.session.SessionPhase import com.droiddeck.launcher.session.SessionPaths +import com.droiddeck.launcher.session.SessionLoadingDecision import com.droiddeck.launcher.wayland.HdrSupport import com.droiddeck.launcher.session.SessionService import com.droiddeck.launcher.session.SessionState @@ -172,12 +173,17 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { val alignment = if (!active) ALIGN_CENTER else when (picturePosition) { "top" -> ALIGN_PICTURE_TOP "bottom" -> ALIGN_PICTURE_BOTTOM + "left" -> ALIGN_PICTURE_LEFT + "right" -> ALIGN_PICTURE_RIGHT else -> ALIGN_CENTER } WaylandCompositor.nativeSetScaleMode(SCALE_FIT, alignment) } private var unfoldedPanel by mutableStateOf(null) private var unfoldedColumn: android.widget.LinearLayout? = null + private var unfoldedDeckSurface: com.droiddeck.launcher.ui.InputSurfaceView? = null + private var unfoldedDeckPanel by mutableStateOf(null) + private var deckPanelLayouts: Map = emptyMap() private lateinit var sessionRoot: FrameLayout private var inputRouter: InputRouter? = null private var physicalInputBindings: com.droiddeck.launcher.input.PhysicalInputBindings? = null @@ -283,6 +289,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { private var directHoldBehavior by mutableStateOf(com.droiddeck.launcher.input.TouchGestureConfig.MOUSE_BEHAVIOR_CLICK) private var relativeMouseMode by mutableIntStateOf(0) @Volatile private var appliedRelativeMouseMode: Int? = null + private val agentReadyListener: () -> Unit = { relativeMouseRetries = 0; requestRelativeMouse() } private val appTextFocus get() = wowChat.request != null private val wowChat by lazy { com.droiddeck.launcher.ui.WowChat(this, ::sendWowChat, ::cancelWowChat, ::readGameField) } private var wowChatBottom: SecondScreenPresentation? = null @@ -384,8 +391,9 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { ) private val mouseBackInput = com.droiddeck.launcher.input.MouseBackInput( sendRight = { down -> heldButtons.set(32, PointerGestures.BTN_RIGHT, down) }, - mouseAttached = ::mouseAttached, + mouseAttached = ::externalMouseAttached, ) + private var lastExternalMouse: InputDevice? = null private var drawerDirectionKey = KeyEvent.KEYCODE_UNKNOWN private var drawerDirectionDownTime = 0L private var drawerDirectionDeviceId = -1 @@ -565,6 +573,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { private var sessionActivityDisplayId = Display.DEFAULT_DISPLAY private lateinit var displayManager: DisplayManager private var secondScreenPresentation: SecondScreenPresentation? = null + private val inputWindowDisplays = mutableListOf() private val bottomScreenListener: () -> Unit = { if (secondScreenPresentation?.display?.displayId?.let(com.droiddeck.launcher.input.DualScreen::taken) == true) closeSecondScreen(reset = false) updateBottomGame() @@ -632,6 +641,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { padBridge?.syncConnectedControllers() refreshControls() updatePointerCapture() + requestRelativeMouse() updateHandCamera() refreshSecondScreenDisplays() } @@ -647,12 +657,14 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { if (::padMouse.isInitialized) padMouse.reset() refreshControls() updatePointerCapture() + requestRelativeMouse() updateHandCamera() refreshSecondScreenDisplays() } override fun onInputDeviceChanged(deviceId: Int) { joyConVr?.refresh() refreshControls() + requestRelativeMouse() refreshSecondScreenDisplays() } } @@ -661,6 +673,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) + AgentGuest.readyListener = agentReadyListener if (com.droiddeck.launcher.runtime.LinuxRuntimeInstaller.isRemoving() || com.droiddeck.launcher.runtime.LinuxRuntimeInstaller.isMaintaining()) { runtimeRemovalBlocked = true @@ -977,7 +990,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { } } else { com.droiddeck.launcher.ui.FocusGlideHost(androidx.compose.ui.Modifier.fillMaxSize()) { - CursorOverlay({ cursorPos }, cursorVisible && !uiPointer && !bottomOutputActive, + CursorOverlay({ cursorPos }, cursorVisible && (!uiPointer || onlyPcKeyboardOpen()) && !bottomOutputActive, resources.displayMetrics.density, cursorImage, cursorHotX, cursorHotY, cursorImageScale) if (memoryHud.text.isNotEmpty()) HudText(memoryHud.text, hudColor, hudOpacity) @@ -1222,7 +1235,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { textureLodBias = if (drawerGameProfileId == null) textureLodBias else drawerTextureLodBias, frameGen = frameGen, lossless = lossless, - oscMode = oscMode, onScreenButtonsVisible = onScreenButtonsVisible, suspendPolicy = suspendPolicy, + oscMode = oscMode, suspendPolicy = suspendPolicy, steamDownloadsInBackground = steamDownloadsInBackground, touchMode = touchMode, micAvailable = SessionState.micAvailable && !SessionState.suspended, micEnabled = SessionState.micEnabled, @@ -1443,6 +1456,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { } }, onClose = { drawerOpen = false }, + onDismissScreen = if (docked) ({ selectSecondScreenMode(SecondScreenMode.NONE) }) else null, components = drawerComponents, onComponentsRefresh = { refreshDrawerComponents() @@ -1955,6 +1969,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { val nextRoutedTouchMode = effectiveTouchMode() if (routedTouchMode != nextRoutedTouchMode) gestureTouchStreamGate.reset() routedTouchMode = nextRoutedTouchMode + requestRelativeMouse() frameGen = FrameGen.mode(this) fexPreset = SessionPrefs.fexPreset(this) suspendPolicy = SessionPrefs.suspendPolicy(this, SessionState.mode) @@ -2225,6 +2240,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { intent.getStringExtra(SessionService.EXTRA_GAME_ID), sessionActivityDisplayId, ) + intent.getStringExtra(EXTRA_PLAYED_GAME)?.let { com.droiddeck.launcher.frontend.Library.recordPlayed(this, it) } } applyFrameGen() applyGameAlignment() @@ -2315,9 +2331,11 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { if (::touchscreenGestures.isInitialized) touchscreenGestures.cancel() if (::touchpad.isInitialized) touchpad.cancel() if (::directTouchHold.isInitialized) directTouchHold.cancel() + if (::twoFingerGestures.isInitialized) twoFingerGestures.cancel() if (::scrollTouch.isInitialized) scrollTouch.cancel() scrollTouchGesture = false gesturePointerReady = false + if (sessionTouchDown) dismissTouch = true } private fun panelBounds(): android.graphics.Rect = if (Build.VERSION.SDK_INT >= 30) { @@ -2421,6 +2439,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { private fun watchSession() { val handler = Handler(Looper.getMainLooper()) var ticks = 0 + val loadingStartedAt = SystemClock.elapsedRealtime() val poll = object : Runnable { override fun run() { if (!watching) return @@ -2433,6 +2452,12 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { finish() return } + if (loading.visible && !loading.ended && !SessionState.running && !installingRuntime && + SessionLoadingDecision.shouldReturnToLauncher( + loadingStartedAt, SystemClock.elapsedRealtime(), SessionState.running, SessionState.phase)) { + finish() + return + } if (loading.visible && !loading.ended) { if (!installingRuntime) loading.update(this@SessionActivity, SessionState.logFile) if (ticks++ % 2 == 0) loading.tick() @@ -2457,8 +2482,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { val hint = sessionExitHint(status) runOnUiThread { if (isFinishing || isDestroyed) return@runOnUiThread - if (status == 0) SessionState.relaunch?.let { next -> - SessionState.relaunch = null + if (status == 0) SessionState.takeRelaunch()?.let { next -> next.putExtra(EXTRA_RETURN_HOME, intent.getBooleanExtra(EXTRA_RETURN_HOME, false)) next.putExtra(EXTRA_LINK_TASK, intent.getIntExtra(EXTRA_LINK_TASK, -1)) setIntent(next) @@ -2660,7 +2684,22 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { } val mouseToGuest = !pipUi && !appTextFocus && !drawerOpen && !pcKeyboardOpen && !achievementsOpen && !gestureSettingsOpen && !inputSettingsOpen && !SessionState.suspended && !(::loading.isInitialized && (loading.visible || loading.ended)) - if (mouseBackInput.onKeyEvent(event, mouseToGuest)) return true + if (event.keyCode == KeyEvent.KEYCODE_BACK && event.action == KeyEvent.ACTION_DOWN && event.repeatCount == 0 && + com.droiddeck.launcher.input.MouseBackInput.isInjectedBack(event)) lastExternalMouse = null + val mouseBackHandled = mouseBackInput.onKeyEvent(event, mouseToGuest) + if (event.keyCode == KeyEvent.KEYCODE_BACK && event.action == KeyEvent.ACTION_DOWN && event.repeatCount == 0 && + com.droiddeck.launcher.input.MouseBackInput.isInjectedBack(event) && mouseToGuest) { + val device = lastExternalMouse + if (mouseBackHandled && device != null) { + Log.i(TAG, String.format(java.util.Locale.ROOT, + "injected Back right-click mouse=\"%s\" (%04x:%04x, id %d, sources 0x%x, external=%s, virtual=%s)", + device.name, device.vendorId, device.productId, device.id, device.sources, + Build.VERSION.SDK_INT < Build.VERSION_CODES.Q || device.isExternal, device.isVirtual)) + } else if (!mouseBackHandled) { + Log.i(TAG, "injected Back no external mouse found") + } + } + if (mouseBackHandled) return true val backToQam = !pipUi && !appTextFocus && !drawerOpen && !pcKeyboardOpen && !achievementsOpen && !inputSettingsOpen && !gestureSettingsOpen && SessionState.mode == SessionService.MODE_STEAM && SessionState.running && SessionState.firstFrameSeen && @@ -2826,6 +2865,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { return onScreenControls?.let { takes(it, it::takesTouchAt) } == true || steamTouchControls?.let { takes(it, it::takesTouchAt) } == true || unfoldedPanel?.let { takes(it, it::takesTouchAt) } == true || + unfoldedDeckSurface?.let { takes(it, it::takesTouchAt) } == true || unfoldedColumn?.getChildAt(0)?.let { takes(it) { _, _ -> true } } == true } @@ -2972,7 +3012,15 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { } private fun applyRelativeMouse() { - val mode = desiredRelativeMouseMode + val wanted = desiredRelativeMouseMode + val touchpadRoute = com.droiddeck.launcher.input.TouchRouter.decide(com.droiddeck.launcher.input.TouchRouter.Snapshot( + uiBlocking = false, + mode = routedTouchMode, + scrollLayer = false, + steamSession = SessionState.mode == SessionService.MODE_STEAM, + steamDesktopUi = SessionState.steamUi == "desktop", + )) == com.droiddeck.launcher.input.TouchRouter.Route.TOUCHPAD + val mode = com.droiddeck.launcher.input.TouchGestureConfig.gamescopeRelativeMouse(wanted, mouseAttached(), touchpadRoute) if (appliedRelativeMouseMode == mode) return val request = org.json.JSONObject() .put("kind", "exec") @@ -2988,7 +3036,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { Log.w(TAG, "gamescope did not take relative mouse $mode: ${result.exceptionOrNull() ?: answer}") if (relativeMouseRetries++ < RELATIVE_MOUSE_MAX_RETRIES) uiHandler.postDelayed({ requestRelativeMouse() }, 2_000) } - if (desiredRelativeMouseMode != mode) requestRelativeMouse() + if (desiredRelativeMouseMode != wanted) requestRelativeMouse() } private fun refreshGestureConfig() { @@ -3183,12 +3231,17 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { cursorVisible = false return } - val rect = drawnRect() ?: return + val rect = if (glassesOutputActive) pointerSurfaceRect() else drawnRect() + val pointerRect = rect ?: return val position = cursorPos - val x = if (position.x >= 0f) position.x.coerceIn(rect.left, rect.right) else rect.centerX() - val y = if (position.y >= 0f) position.y.coerceIn(rect.top, rect.bottom) else rect.centerY() + val x = if (position.x >= 0f) position.x.coerceIn(pointerRect.left, pointerRect.right) else pointerRect.centerX() + val y = if (position.y >= 0f) position.y.coerceIn(pointerRect.top, pointerRect.bottom) else pointerRect.centerY() val out = SessionState.outputSize - movePointer(x + dx * rect.width() / out.first, y + dy * rect.height() / out.second) + val nextX = (x + dx * pointerRect.width() / out.first) + .coerceIn(pointerRect.left, pointerRect.right) + val nextY = (y + dy * pointerRect.height() / out.second) + .coerceIn(pointerRect.top, pointerRect.bottom) + movePointer(nextX, nextY) // Make frame-callback updates visible to drawing before this frame's traversal. androidx.compose.runtime.snapshots.Snapshot.sendApplyNotifications() } @@ -3378,6 +3431,10 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { } var presentation = secondScreenPresentation if (presentation?.display?.displayId != target.displayId) { + if (target.displayId in inputWindowDisplays) { + panelMode(mode) + return + } dropDockedDrawer() presentation?.closeControls() presentation = secondScreenPresentation(target) @@ -3432,50 +3489,9 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { private fun bottomPages(): List = sessionBottomPages(BottomPageActions( takeScreenshot = ::captureScreenshot, fps = { if (::hud.isInitialized) hud.liveFps else null }, - openSettings = ::openSettingsBelow, runningGame = { gestureGame }, )) - private fun openSettingsBelow(intent: android.content.Intent, done: () -> Boolean) { - val presentation = secondScreenPresentation - if (presentation == null) { - if (!bottomOutputActive) return - listOf(intent, android.content.Intent(android.provider.Settings.ACTION_NOTIFICATION_LISTENER_SETTINGS)).any { - runCatching { startActivity(android.content.Intent(it)) } - .onFailure { e -> Log.w(TAG, "could not open ${it.action}", e) } - .isSuccess - } - return - } - val options = android.app.ActivityOptions.makeBasic().setLaunchDisplayId(presentation.display.displayId) - val opened = listOf(intent, android.content.Intent(android.provider.Settings.ACTION_NOTIFICATION_LISTENER_SETTINGS)).any { - runCatching { startActivity(android.content.Intent(it).addFlags(android.content.Intent.FLAG_ACTIVITY_NEW_TASK), options.toBundle()) } - .onFailure { e -> Log.w(TAG, "could not open ${it.action} on display ${presentation.display.displayId}", e) } - .isSuccess - } - if (!opened) return - presentation.hide() - var checks = 0 - fun showAgain() { - try { - presentation.show() - } catch (e: Exception) { - Log.w(TAG, "could not show the dashboard again", e) - if (secondScreenPresentation === presentation) closeSecondScreen(reset = true) - } - } - uiHandler.postDelayed(object : Runnable { - override fun run() { - if (secondScreenPresentation !== presentation || presentation.isShowing) return - if (done()) { - showAgain() - return - } - if (++checks < SETTINGS_WATCH_CHECKS) uiHandler.postDelayed(this, SETTINGS_WATCH_MS) else showAgain() - } - }, SETTINGS_WATCH_MS) - } - private fun captureScreenshot(onDone: (Boolean) -> Unit) { val source = if (glassesOutputActive) glassesScreen?.surfaceView else if (bottomOutputActive) bottomGame?.surfaceView else if (::surfaceView.isInitialized) surfaceView else null @@ -3518,8 +3534,15 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { val main = window.decorView.display if (role == InputRole.PRIMARY) return bottomGame?.display ?: main if (bottomGame != null) return main - return displayManager.getDisplay(selectedSecondScreenDisplay) - ?: secondScreenDisplays.firstOrNull()?.let { displayManager.getDisplay(it.id) } + return com.droiddeck.launcher.input.SecondScreenDisplays.editorCandidates(selectedSecondScreenDisplay, + secondScreenDisplays.map { it.id }, com.droiddeck.launcher.input.DualScreen::taken).firstNotNullOfOrNull(displayManager::getDisplay) + } + + fun inputWindowShown(displayId: Int) { inputWindowDisplays += displayId } + + fun inputWindowClosed(displayId: Int) { + inputWindowDisplays -= displayId + if (started && displayId !in inputWindowDisplays && secondScreenMode != SecondScreenMode.NONE && secondScreenPresentation == null) showSecondScreen(secondScreenMode) } private fun refreshInputProfile() { @@ -3530,6 +3553,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { adaptiveSticks = primaryInputLayout?.adaptiveSticks quickButtons = primaryInputLayout?.takeIf { it.editable }?.let { l -> l.quickButtons.associateWith { it !in l.style.hidden } }.orEmpty() secondaryInputLayout = library.panelLayout(desktop, secondScreenMode.panel(this)) + deckPanelLayouts = com.droiddeck.launcher.input.DeckPanel.entries.associateWith { library.panelLayout(desktop, it.bindings) } inputUsesLocalActions = InputControl.padControls.any { inputProfile.action(InputRole.PHYSICAL, it) !is InputAction.Native } inputUsesPointer = inputProfile.bindings.values.any { bindings -> bindings.values.any { it is InputAction.Pointer || it is InputAction.MouseButton || it is InputAction.Scroll } @@ -3543,6 +3567,8 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { onScreenControls?.updateLayout(primaryInputLayout) bottomInputControls?.updateLayout(primaryInputLayout) unfoldedPanel?.updateLayout(primaryInputLayout) + if (unfoldedPanel != null) applyUnfoldedControls() + showUnfoldedDeckPanel() updateOnScreenPad() secondScreenPresentation?.refreshControls() } @@ -3586,7 +3612,10 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { val width = sessionRoot.width val height = sessionRoot.height val wanted = controlsBelowWanted() - val gameHeight = if (wanted) com.droiddeck.launcher.session.SessionDisplay.unfoldedGameHeight(width, height) + val tabRow = unfoldedColumn?.getChildAt(0)?.height?.let { + it - (com.droiddeck.launcher.ui.BAR_HEIGHT.value * resources.displayMetrics.density + 0.5f).toInt() + } ?: 0 + val gameHeight = if (wanted) com.droiddeck.launcher.session.SessionDisplay.unfoldedGameHeight(width, height, tabRow) else FrameLayout.LayoutParams.MATCH_PARENT val params = surfaceView.layoutParams as FrameLayout.LayoutParams if (params.height != gameHeight) { @@ -3594,11 +3623,15 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { Log.i(TAG, if (wanted) "unfolded controls: game ${width}x$gameHeight, controls ${width}x${height - gameHeight}" else "unfolded controls: game full screen") } - val dock = com.droiddeck.launcher.input.OnScreenLayout.Dock(!com.droiddeck.launcher.session.SessionDisplay.foldable(this), SessionState.deckPad) + val portrait = !com.droiddeck.launcher.session.SessionDisplay.foldable(this) + val dock = if (SessionState.deckPad) com.droiddeck.launcher.input.OnScreenLayout.Dock.deck(portrait, deckPanelLayouts[com.droiddeck.launcher.input.DeckPanel.GAMEPAD]) + else com.droiddeck.launcher.input.OnScreenLayout.Dock(portrait, false) var panel = unfoldedPanel if (panel != null && (!wanted || panel.dock != dock)) { sessionRoot.removeView(unfoldedColumn) unfoldedColumn = null + unfoldedDeckSurface = null + unfoldedDeckPanel = null unfoldedPanel = null panel = null if (!wanted) updateOnScreenControls() @@ -3608,21 +3641,47 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { panel = OnScreenControls(this, padBridge, dock).also { it.updateLayout(primaryInputLayout) } val column = android.widget.LinearLayout(this).apply { orientation = android.widget.LinearLayout.VERTICAL - addView(unfoldedBar(), android.widget.LinearLayout.LayoutParams(android.widget.LinearLayout.LayoutParams.MATCH_PARENT, - (com.droiddeck.launcher.ui.BAR_HEIGHT.value * resources.displayMetrics.density + 0.5f).toInt())) + addView(unfoldedBar().apply { + addOnLayoutChangeListener { _, _, top, _, bottom, _, oldTop, _, oldBottom -> + if (bottom - top != oldBottom - oldTop) post { applyUnfoldedControls() } + } + }, android.widget.LinearLayout.LayoutParams(android.widget.LinearLayout.LayoutParams.MATCH_PARENT, + android.widget.LinearLayout.LayoutParams.WRAP_CONTENT)) addView(panel, android.widget.LinearLayout.LayoutParams(android.widget.LinearLayout.LayoutParams.MATCH_PARENT, 0, 1f)) } sessionRoot.addView(column, sessionRoot.indexOfChild(surfaceView) + 1) unfoldedColumn = column unfoldedPanel = panel + showUnfoldedDeckPanel() updateOnScreenControls() } unfoldedColumn?.layoutParams = FrameLayout.LayoutParams(FrameLayout.LayoutParams.MATCH_PARENT, height - gameHeight, Gravity.BOTTOM) } private fun unfoldedBar(): View = com.droiddeck.launcher.ui.bottomScreenBarView(this) { - com.droiddeck.launcher.ui.sessionBarModel(getString(R.string.deck_tab_gamepad), { chooseUnfoldedControls(false) }, - { drawerOpen = true }, ::tapSteamButton, ::tapQam) + val deck = unfoldedDeckPanel + com.droiddeck.launcher.ui.sessionBarModel(getString(if (deck != null) R.string.second_mode_deck_controls else R.string.deck_tab_gamepad), + { chooseUnfoldedControls(false) }, { drawerOpen = true }, ::tapSteamButton, ::tapQam, + tabs = deck?.let { com.droiddeck.launcher.ui.deckPanelTabs(this, it, ::selectDeckPanel) }) + } + + private fun showUnfoldedDeckPanel() { + val column = unfoldedColumn + val panel = unfoldedPanel + val selected = SessionPrefs.deckPanel(this).takeIf { column != null && panel?.dock?.grips == true } + unfoldedDeckPanel = selected + val layout = selected?.takeIf { it != com.droiddeck.launcher.input.DeckPanel.GAMEPAD }?.let { deckPanelLayouts[it] } + if (layout != null && unfoldedDeckSurface?.tag == layout) return + unfoldedDeckSurface?.let { it.releaseInputs(); column?.removeView(it) } + unfoldedDeckSurface = null + if (column == null || panel == null) return + if (layout == null) { panel.visibility = View.VISIBLE; return } + panel.releaseAll() + panel.visibility = View.GONE + unfoldedDeckSurface = com.droiddeck.launcher.ui.InputSurfaceView(this, padBridge, layout.elements, InputRole.PRIMARY, layout.style, haptics = true).also { + it.tag = layout + column.addView(it, android.widget.LinearLayout.LayoutParams(android.widget.LinearLayout.LayoutParams.MATCH_PARENT, 0, 1f)) + } } private fun bottomKeyboardPresentation(): SecondScreenPresentation? { @@ -3798,6 +3857,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { if (next == SessionPrefs.TOUCH_OFF) cursorVisible = false gestureTouchStreamGate.reset() routedTouchMode = next + requestRelativeMouse() if (directTouchCursorHidden()) cursorVisible = false } @@ -3890,8 +3950,29 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { val width = outputView().width.takeIf { it > 0 } ?: return null val height = outputView().height.takeIf { it > 0 } ?: return null topPictureMapped = CompositorHost.isStarted && WaylandCompositor.nativeGamePictureRect(gamePictureBounds) - if (topPictureMapped) return android.graphics.RectF( - gamePictureBounds[0], gamePictureBounds[1], gamePictureBounds[2], gamePictureBounds[3]) + if (topPictureMapped) { + val rect = android.graphics.RectF( + gamePictureBounds[0], gamePictureBounds[1], + gamePictureBounds[2], gamePictureBounds[3] + ) + + if (glassesOutputActive) { + val mode = glassesScreen?.display?.mode ?: return null + val outputWidth = mode.physicalWidth.takeIf { it > 0 } ?: return null + val outputHeight = mode.physicalHeight.takeIf { it > 0 } ?: return null + val scaleX = width.toFloat() / outputWidth + val scaleY = height.toFloat() / outputHeight + + return android.graphics.RectF( + rect.left * scaleX, + rect.top * scaleY, + rect.right * scaleX, + rect.bottom * scaleY + ) + } + + return rect + } val out = SessionState.outputSize val scale = minOf(width / out.first.toFloat(), height / out.second.toFloat()) val drawnW = out.first * scale @@ -3918,9 +3999,17 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { private var lockedSwipeX = 0f private var lockedSwipeY = 0f private var dismissTouch = false + private var sessionTouchDown = false override fun onTouchEvent(event: MotionEvent): Boolean { if (event.isFromSource(android.view.InputDevice.SOURCE_MOUSE)) return onMouse(event) + when (event.actionMasked) { + MotionEvent.ACTION_DOWN -> { + sessionTouchDown = true + dismissTouch = false + } + MotionEvent.ACTION_UP, MotionEvent.ACTION_CANCEL -> sessionTouchDown = false + } if (drawerOpen && drawerDocked && event.actionMasked == MotionEvent.ACTION_DOWN) { drawerLayerOpen = false drawerOpenState = false @@ -3932,7 +4021,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { if (event.actionMasked == MotionEvent.ACTION_UP || event.actionMasked == MotionEvent.ACTION_CANCEL) dismissTouch = false return true } - val uiBlocking = drawerOpen || pcKeyboardOpen || achievementsOpen || gestureSettingsOpen || inputSettingsOpen || pipUi || SessionState.suspended + val uiBlocking = drawerOpen || achievementsOpen || gestureSettingsOpen || inputSettingsOpen || pipUi || SessionState.suspended if (event.actionMasked == MotionEvent.ACTION_DOWN && !uiBlocking && routedTouchMode != SessionPrefs.TOUCH_GESTURES) { scrollTouchGesture = scrollTouchMode() scrollRestX = 0f @@ -3960,7 +4049,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { com.droiddeck.launcher.input.TouchRouter.Route.SCROLL -> scrollTouch.onTouch(event) else -> { if (com.droiddeck.launcher.input.TouchRouter.steamKeyboardZone(snapshot)) { - val wasActive = threeFingerTap.active + val wasActive = threeFingerTap.active && event.actionMasked != MotionEvent.ACTION_DOWN if (threeFingerTap.onTouch(event)) padBridge?.triggerSteamKeyboard() if (threeFingerTap.active && !wasActive) { if (route == com.droiddeck.launcher.input.TouchRouter.Route.TOUCHPAD) touchpad.cancel() @@ -4036,9 +4125,10 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { return true } if (event.actionMasked == MotionEvent.ACTION_DOWN) lockedSwipeUsed = false + if (lockedSwipeUsed && (event.actionMasked != MotionEvent.ACTION_MOVE || !programLocksPointer())) return true if (programLocksPointer() && event.actionMasked == MotionEvent.ACTION_MOVE) { + if (lockedSwipeUsed) directTouchHold.cancelPendingHold() else directTouchHold.cancelTouch() lockedSwipeUsed = true - directTouchHold.cancelPendingHold() val scale = sceneScale(rect) sendSceneDelta((event.x - swipeX) * scale, (event.y - swipeY) * scale) return true @@ -4089,6 +4179,12 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { isHardwareMouse(d) && d?.supportsSource(InputDevice.SOURCE_TOUCHPAD) != true } + private fun externalMouseAttached(): Boolean { + lastExternalMouse = InputDevice.getDeviceIds().map { InputDevice.getDevice(it) } + .firstOrNull { device -> device != null && com.droiddeck.launcher.input.MouseBackInput.isExternalMouse(device) } + return lastExternalMouse != null + } + private fun relativeMouseAttached(): Boolean = !isInMultiWindowMode && !glassesOutputActive && InputDevice.getDeviceIds().any { id -> val d = InputDevice.getDevice(id) isHardwareMouse(d) && d?.supportsSource(InputDevice.SOURCE_TOUCHPAD) != true @@ -4155,6 +4251,9 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { applyPlatformPointer(appUiOwnsPointer()) } + private fun onlyPcKeyboardOpen(): Boolean = + pcKeyboardOpen && !drawerOpen && !achievementsOpen && !inputSettingsOpen && !pipUi && !glassesOutputActive && !touchEditorOpen && !wowChatOnTop + private fun appUiOwnsPointer(): Boolean = drawerOpen || pcKeyboardOpen || achievementsOpen || inputSettingsOpen || pipUi || glassesOutputActive || bottomOutputActive || touchEditorOpen || wowChatOnTop @@ -4245,7 +4344,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { updateOnScreenPad() val c = onScreenControls glassesSlot = when { - c == null || c.visibility != View.VISIBLE -> 0 + c == null || c.visibility != View.VISIBLE || c.isPinnedOnly -> 0 c.isButtonsOnly -> -1 primaryInputLayout?.let { l -> l.elements.any { it.quickButton == InputCommand.KEYBOARD && !l.style.hides(it) } } ?: (controllerSettings?.keyboardButton != false) -> 2 @@ -4260,12 +4359,17 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { ?.let { FileUtils.readString(it)?.trim()?.lowercase() } ?: SessionPrefs.oscMode(this) val controls = onScreenControls ?: return + fun showPinned() { + controls.setPinnedOnly(true) + val pinned = controls.hasPinned && !pipUi && !inputSettingsOpen + if (!pinned) controls.releaseAll() + controls.visibility = if (pinned) View.VISIBLE else View.GONE + } if (pipUi || unfoldedPanel != null || pcKeyboardOpen || inputSettingsOpen || (SessionState.mode == SessionService.MODE_STEAM && !SessionPrefs.builtinPad(this))) { onScreenButtonsVisible = false hideBottomControls() - controls.releaseAll() - controls.visibility = View.GONE + showPinned() steamTouchControls?.let { it.cancelEditing(); it.releaseAll(); it.visibility = View.GONE } com.droiddeck.launcher.input.SteamTouchDevice.current?.plugged = false applyTouchRouting() @@ -4298,7 +4402,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { val drawn = show && !keyboardCoversPad() if (steam != null) { hideBottomControls() - if (controls.visibility == View.VISIBLE) { controls.releaseAll(); controls.visibility = View.GONE } + showPinned() if (!drawn) { steam.cancelEditing(); steam.releaseAll() } steam.visibility = if (drawn) View.VISIBLE else View.GONE com.droiddeck.launcher.input.SteamTouchDevice.current?.plugged = show @@ -4307,7 +4411,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { return } val bottomRoot = bottomGame?.surfaceView?.parent as? android.view.ViewGroup - if (drawn && bottomRoot != null) { + if (bottomRoot != null && (drawn || controls.hasPinned)) { controls.releaseAll(); controls.visibility = View.GONE var bottom = bottomInputControls if (bottom?.parent !== bottomRoot) { @@ -4320,13 +4424,14 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { } bottom.updateLayout(primaryInputLayout) bottom.setButtonsOnly(buttonsOnly) + bottom.setPinnedOnly(!drawn) bottom.visibility = View.VISIBLE return } hideBottomControls() - if (drawn == (controls.visibility == View.VISIBLE)) return - if (!drawn) controls.releaseAll() - controls.visibility = if (drawn) View.VISIBLE else View.GONE + val wasDrawn = controls.visibility == View.VISIBLE && !controls.isPinnedOnly + if (!drawn) showPinned() else { controls.setPinnedOnly(false); controls.visibility = View.VISIBLE } + if (drawn == wasDrawn) return Log.i(TAG, "on-screen controls " + when { !drawn -> "hidden" buttonsOnly -> "Steam + QAM" @@ -5069,7 +5174,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { com.droiddeck.launcher.ui.BottomScreenBar(bar(getString(SecondScreenMode.KEYBOARD_TRACKPAD.label), listOf(keyboardExtra))) SecondScreenMode.DECK_CONTROLS -> com.droiddeck.launcher.ui.BottomScreenBar(bar(getString(SecondScreenMode.DECK_CONTROLS.label), tabs = com.droiddeck.launcher.ui.deckPanelTabs(this@SessionActivity, SessionPrefs.deckPanel(this@SessionActivity), ::selectDeckPanel))) - else -> Unit + else -> com.droiddeck.launcher.ui.BottomScreenBar(bar(getString(secondScreenMode.label))) } androidx.compose.runtime.key(profileLayout) { androidx.compose.ui.viewinterop.AndroidView( @@ -5286,6 +5391,7 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { } override fun onDestroy() { + if (AgentGuest.readyListener === agentReadyListener) AgentGuest.readyListener = null com.droiddeck.launcher.input.HomeButtonShortcuts.detach(this) relativeMouseRequests.shutdownNow() backQamInput.cancel() @@ -5390,13 +5496,12 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { const val EXTRA_RETURN_HOME = "returnHome" const val EXTRA_LINK_TASK = "linkTask" const val EXTRA_STEAMVR = "steamVr" + const val EXTRA_PLAYED_GAME = "com.droiddeck.launcher.PLAYED_GAME" const val EXTRA_REPAIR_RUNTIME = "repairRuntime" private const val LEAVE_TIMEOUT_MS = 1_500L private const val TEXT_FIELD_TAP_MS = 1_000L private const val PAUSED_FRAME_MAX_EDGE = 1920f private const val PAUSED_FRAME_REDRAW_MS = 150L - private const val SETTINGS_WATCH_MS = 1_000L - private const val SETTINGS_WATCH_CHECKS = 600 private const val BOTTOM_RECOVERY_MS = 1_000L private const val BOTTOM_RECOVERY_TRIES = 3 private const val TAG = "SessionActivity" @@ -5438,6 +5543,8 @@ class SessionActivity : ComponentActivity(), SurfaceHolder.Callback { private const val ALIGN_CENTER = 0 private const val ALIGN_PICTURE_TOP = 3 private const val ALIGN_PICTURE_BOTTOM = 4 + private const val ALIGN_PICTURE_LEFT = 5 + private const val ALIGN_PICTURE_RIGHT = 6 private val RUNTIME_LINES = PackageLines( R.string.session_runtime_downloading, R.string.session_runtime_downloading_mb, R.string.session_runtime_checking, R.string.session_runtime_unpacking, diff --git a/app/src/main/java/com/droiddeck/launcher/agent/AgentBridgeProvider.kt b/app/src/main/java/com/droiddeck/launcher/agent/AgentBridgeProvider.kt index c1955caa05..93922c8050 100644 --- a/app/src/main/java/com/droiddeck/launcher/agent/AgentBridgeProvider.kt +++ b/app/src/main/java/com/droiddeck/launcher/agent/AgentBridgeProvider.kt @@ -85,6 +85,10 @@ class AgentBridgeProvider : ContentProvider() { AgentAccess.requireCommands(context) guest(context, JSONObject(request.toString()).put("kind", "exec"), timeoutMs(request, 30.0, 10_000)) } + "native" -> { + AgentAccess.requireCommands(context) + AgentNative.run(context, request, timeoutMs(request, 30.0, 0)) + } "cdp" -> { AgentAccess.requireCommands(context) guest(context, JSONObject(request.toString()).put("kind", "cdp"), timeoutMs(request, 15.0, 5_000)) @@ -284,6 +288,8 @@ class AgentBridgeProvider : ContentProvider() { return JSONObject() .put("schema", SCHEMA) .put("build", BuildConfig.BUILD_LABEL) + .put("apkCommit", com.droiddeck.launcher.lab.LabOverlay.apkCommit) + .put("lab", com.droiddeck.launcher.lab.LabOverlay.active?.label ?: JSONObject.NULL) .put("appVersion", context.packageManager.getPackageInfo(context.packageName, 0).versionName) .put("runtime", JSONObject() .put("installed", LinuxRuntime.isInstalled(context)) diff --git a/app/src/main/java/com/droiddeck/launcher/agent/AgentCallReceiver.kt b/app/src/main/java/com/droiddeck/launcher/agent/AgentCallReceiver.kt new file mode 100644 index 0000000000..6ef8b2d4ba --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/agent/AgentCallReceiver.kt @@ -0,0 +1,41 @@ +package com.droiddeck.launcher.agent + +import android.content.BroadcastReceiver +import android.content.Context +import android.content.Intent +import android.os.Bundle +import java.io.File + +/** + * The agent bridge for devices whose shell has no `content` command: the same calls as + * [AgentBridgeProvider], answered in a file under the app's external files folder. + */ +class AgentCallReceiver : BroadcastReceiver() { + + override fun onReceive(context: Context, intent: Intent) { + val method = intent.getStringExtra("method") ?: return + val id = intent.getStringExtra("id")?.takeIf { it.matches(Regex("[A-Za-z0-9_-]{1,64}")) } ?: return + val arg = intent.getStringExtra("arg") + val request = intent.getStringExtra(AgentBridgeProvider.EXTRA_REQUEST) + val pending = goAsync() + Thread({ + val json = try { + val extras = Bundle().apply { putString(AgentBridgeProvider.EXTRA_REQUEST, request) } + context.contentResolver.call("${context.packageName}.agent", method, arg, extras) + ?.getString(AgentBridgeProvider.RESULT_JSON) ?: """{"ok":false,"error":{"code":"NO_RESPONSE","message":"no response"}}""" + } catch (e: Exception) { + org.json.JSONObject().put("ok", false) + .put("error", org.json.JSONObject().put("code", "COMMAND_FAILED").put("message", e.message ?: e.javaClass.simpleName)).toString() + } + try { + val dir = File(context.getExternalFilesDir(null), "agent-calls").apply { mkdirs() } + File(dir, "$id.json.part").writeText(json) + File(dir, "$id.json.part").renameTo(File(dir, "$id.json")) + } catch (e: Exception) { + android.util.Log.w("AgentCallReceiver", "could not write the answer to $method: ${e.message}") + } finally { + pending.finish() + } + }, "agent-call-$id").start() + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/agent/AgentGuest.kt b/app/src/main/java/com/droiddeck/launcher/agent/AgentGuest.kt index eaa2bbc0f7..e04dda2580 100644 --- a/app/src/main/java/com/droiddeck/launcher/agent/AgentGuest.kt +++ b/app/src/main/java/com/droiddeck/launcher/agent/AgentGuest.kt @@ -33,6 +33,7 @@ object AgentGuest { var keyboardDismissals by mutableIntStateOf(0) private set @Volatile private var keyboardRoute = false + @Volatile var readyListener: (() -> Unit)? = null @Volatile private var routeDir: File? = null private const val TAG = "AgentGuest" private const val POLL_MS = 50L @@ -59,6 +60,7 @@ object AgentGuest { when (path) { "hello.json" -> readJson(File(dir, path))?.let { SessionEvents.record("agent.ready", mapOf("pid" to it.optInt("pid"), "focus" to it.optBoolean("focus"))) + readyListener?.invoke() } "focus.json" -> readJson(File(dir, path))?.let(::recordFocus) "keyboard.json" -> readJson(File(dir, path))?.let { recordKeyboard(this, it) } diff --git a/app/src/main/java/com/droiddeck/launcher/agent/AgentNative.kt b/app/src/main/java/com/droiddeck/launcher/agent/AgentNative.kt new file mode 100644 index 0000000000..613cbe2c39 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/agent/AgentNative.kt @@ -0,0 +1,65 @@ +package com.droiddeck.launcher.agent + +import android.content.Context +import com.droiddeck.launcher.runtime.LinuxRuntime +import com.droiddeck.launcher.runtime.NativeGuest +import org.json.JSONArray +import org.json.JSONObject +import java.util.concurrent.TimeUnit + +/** Runs a guest program without proot (`droiddeckctl native`), for testing the native userland. */ +object AgentNative { + private const val OUTPUT_CAP = 256 * 1024 + + fun run(context: Context, request: JSONObject, timeoutMs: Long): JSONObject { + val root = LinuxRuntime.rootDir(context) + com.droiddeck.launcher.session.SessionFiles.stage(context, root) + // with the setting off, staging leaves the rootfs as proot wants it + if (!com.droiddeck.launcher.session.SessionPrefs.nativeUserland(context)) NativeGuest.prepare(context, root) + if (!NativeGuest.available(root)) throw AgentException("NATIVE_UNAVAILABLE", "The rootfs has no native hook or glibc loader yet; start a session once") + val argvJson = request.optJSONArray("argv") ?: throw AgentException("INVALID_REQUEST", "argv is required") + val argv = (0 until argvJson.length()).map { argvJson.getString(it) } + if (argv.isEmpty()) throw AgentException("INVALID_REQUEST", "argv is empty") + val env = linkedMapOf() + request.optJSONObject("env")?.let { obj -> obj.keys().forEach { env[it] = obj.getString(it) } } + val preload = request.optJSONArray("preload")?.let { a -> (0 until a.length()).map { a.getString(it) } } ?: emptyList() + val builder = NativeGuest.builder(root, request.optString("cwd", "/root"), argv, env, preload) + val started = System.nanoTime() + val process = builder.start() + val out = StringBuilder() + val err = StringBuilder() + val readers = listOf( + Thread { drain(process.inputStream, out) }, + Thread { drain(process.errorStream, err) }, + ).onEach { it.isDaemon = true; it.start() } + // written beside the wait: a program that never reads more than a pipe holds would block it + val input = request.optString("stdin").toByteArray() + Thread { + try { + process.outputStream.use { stdin -> if (input.isNotEmpty()) stdin.write(input) } + } catch (_: java.io.IOException) { + } + }.apply { isDaemon = true; start() } + val finished = process.waitFor(timeoutMs, TimeUnit.MILLISECONDS) + if (!finished) process.destroyForcibly().waitFor() + readers.forEach { it.join(2000) } + val code = if (finished) process.exitValue() else -1 + return JSONObject().put("ok", true).put("command", "native") + .put("exitCode", code).put("timedOut", !finished) + .put("ms", (System.nanoTime() - started) / 1_000_000) + .put("stdout", JSONObject().put("text", out.toString())) + .put("stderr", JSONObject().put("text", err.toString())) + .put("argv", JSONArray(argv)) + } + + private fun drain(input: java.io.InputStream, into: StringBuilder) { + val buffer = ByteArray(8192) + val text = java.io.ByteArrayOutputStream() + while (true) { + val n = try { input.read(buffer) } catch (e: java.io.IOException) { -1 } + if (n < 0) break + if (text.size() < OUTPUT_CAP) text.write(buffer, 0, minOf(n, OUTPUT_CAP - text.size())) + } + into.append(text.toString(Charsets.UTF_8.name())) + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/core/AddonPack.kt b/app/src/main/java/com/droiddeck/launcher/core/AddonPack.kt index 4f88d90e34..d3d5cf2c74 100644 --- a/app/src/main/java/com/droiddeck/launcher/core/AddonPack.kt +++ b/app/src/main/java/com/droiddeck/launcher/core/AddonPack.kt @@ -152,5 +152,7 @@ internal class AddonPack( @JvmField val POWERVR = AddonPack("powervr", BuildConfig.PACK_POWERVR_SHA256, BuildConfig.PACK_POWERVR_SIZE, listOf("runtime.tzst", "version.txt")) + val UBISOFT = AddonPack("ubisoft", BuildConfig.PACK_UBISOFT_SHA256, BuildConfig.PACK_UBISOFT_SIZE, + listOf("droiddeck-upc.exe")) } } diff --git a/app/src/main/java/com/droiddeck/launcher/core/DeviceReport.kt b/app/src/main/java/com/droiddeck/launcher/core/DeviceReport.kt index cb0b9487b8..63037a24ac 100644 --- a/app/src/main/java/com/droiddeck/launcher/core/DeviceReport.kt +++ b/app/src/main/java/com/droiddeck/launcher/core/DeviceReport.kt @@ -278,6 +278,7 @@ object DeviceReport { k("RAM cap", SessionPrefs.ramCapMb(context).let { if (it > 0) "$it MB" else "off" }) k("VRAM cap", SessionPrefs.vramCapMb(context).let { if (it > 0) "$it MB" else "driver default" }) k("proot without seccomp", SessionPrefs.prootNoSeccomp(context)) + k("native userland (no proot)", SessionPrefs.nativeUserland(context)) k("proot fast path", SessionPrefs.prootFastPath(context)) k("proot binary", LinuxRuntime.prootSource(context) + " " + LinuxRuntime.prootBinary(context).path) k("proot fast path (eligible)", com.droiddeck.launcher.runtime.ProotFastPath.enabled(context)) diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/AddedGames.kt b/app/src/main/java/com/droiddeck/launcher/frontend/AddedGames.kt index 7057cadd39..c7d774bf2e 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/AddedGames.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/AddedGames.kt @@ -417,7 +417,7 @@ object AddedGames { private fun scanGame(context: Context, folder: File, out: MutableList, single: AddedExes.Entry? = null, reuse: Boolean = false) { run { - val sidecar = StoreGameSidecar.read(folder) + val sidecar = StoreGameSidecar.read(folder)?.let { com.droiddeck.launcher.stores.StoreLaunch.adopt(folder, it) } sidecar?.takeIf { it.id.isNotEmpty() }?.let { SessionPrefs.followStoreGame(context, "${it.store.id}:${it.id}", folder.path) { old -> !File(old).exists() } } val ranking = rank(folder, reuse) val candidates = ranking.exes @@ -457,7 +457,11 @@ object AddedGames { steamId?.toLong() ?: ((appId shl 32) or 0x02000000L), candidates, steamId, source = sidecar?.store?.id ?: Library.ADDED, storeId = sidecar?.id, exeUncertain = sidecar == null && chosen == null && adopted == null && ranking.uncertain, - launchOptions = if (sidecar == null) SessionPrefs.addedGameLaunch(context, folder.path) else "", + launchOptions = when { + sidecar == null -> SessionPrefs.addedGameLaunch(context, folder.path) + sidecar.store == Store.UBISOFT -> com.droiddeck.launcher.stores.ubisoft.UbisoftConnect.launchOptions(context) + else -> "" + }, single = single != null)) } } diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/Library.kt b/app/src/main/java/com/droiddeck/launcher/frontend/Library.kt index ef7ec06a10..b303ecc71e 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/Library.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/Library.kt @@ -18,9 +18,10 @@ object Library { val source: String = SOURCE_STEAM, val storeId: String? = null, val logo: File? = null, + val installedAt: Long = 0L, ) { fun withArt(art: File?, hero: File?, icon: File?, logo: File? = this.logo) = - SteamGame(appId, name, art, library, gameId, hero, lastPlayed, gameFiles, protonPrefix, icon, source, storeId, logo) + SteamGame(appId, name, art, library, gameId, hero, lastPlayed, gameFiles, protonPrefix, icon, source, storeId, logo, installedAt) val gameIdString: String get() = java.lang.Long.toUnsignedString(gameId) val launchKey: String get() = if (storeId != null) "$source:$storeId" else gameIdString @@ -31,6 +32,7 @@ object Library { } } const val ADDED = "added" + private const val PLAYED = "added_games_played" const val EPIC_LAUNCHER = "epic-launcher" const val EPIC_LAUNCHER_NAME = "Epic Games Launcher" const val BATTLENET_LAUNCHER = "battlenet-launcher" @@ -221,6 +223,18 @@ object Library { return (steam + own.map { g -> addedGame(context, g, roots, played[g.appId] ?: 0L) }).distinctBy { it.gameId } } + fun recordPlayed(context: Context, game: SteamGame) { + if (game.library == ADDED) recordPlayed(context, game.gameIdString) + } + + fun recordPlayed(context: Context, gameId: String) { + context.getSharedPreferences(PLAYED, Context.MODE_PRIVATE).edit() + .putLong(gameId, System.currentTimeMillis() / 1000).apply() + } + + internal fun recordedPlay(context: Context, gameId: Long): Long = + context.getSharedPreferences(PLAYED, Context.MODE_PRIVATE).getLong(java.lang.Long.toUnsignedString(gameId), 0L) + internal fun shortcutsLastPlayed(root: File): Map = runCatching { val config = AddedGames.accountConfig(root) ?: return emptyMap() val bytes = File(config, "shortcuts.vdf").takeIf { it.isFile }?.readBytes() ?: return emptyMap() @@ -249,12 +263,13 @@ object Library { AddedGameArt.resolve(context, g).let { art -> SteamGame( g.steamAppId ?: g.appId.toInt(), g.name, art.portrait ?: art.header, ADDED, g.gameId, - hero = art.hero ?: art.header, lastPlayed = lastPlayed, gameFiles = g.folder, + hero = art.hero ?: art.header, lastPlayed = maxOf(lastPlayed, recordedPlay(context, g.gameId)), gameFiles = g.folder, protonPrefix = if (g.source == com.droiddeck.launcher.stores.Store.BATTLENET.id) File(com.droiddeck.launcher.runtime.BattleNet.prefix(context), "pfx").takeIf { it.isDirectory } else protonPrefix(context, g.steamAppId?.toLong() ?: g.appId, libraries = roots), icon = art.icon?.takeIf { it.extension.lowercase() != "ico" }, source = g.source, storeId = g.storeId, logo = art.logo, + installedAt = g.folder.lastModified(), ) } diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/LibraryCache.kt b/app/src/main/java/com/droiddeck/launcher/frontend/LibraryCache.kt index 6fa35c753a..81434ce2ca 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/LibraryCache.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/LibraryCache.kt @@ -27,6 +27,7 @@ object LibraryCache { source = o.optString("source").ifEmpty { if (o.getString("library") == Library.ADDED) Library.ADDED else Library.SOURCE_STEAM }, storeId = o.optString("storeId").ifEmpty { null }, logo = o.file("logo"), + installedAt = o.optLong("installedAt"), ) } to x64 }.getOrElse { e -> Log.w(TAG, "unreadable, ignored: ${e.message}"); Pair(emptyList(), false) } @@ -44,7 +45,7 @@ object LibraryCache { JSONObject().put("appId", g.appId).put("name", g.name).put("library", g.library).put("gameId", g.gameId) .put("lastPlayed", g.lastPlayed).putFile("art", g.art).putFile("hero", g.hero) .putFile("gameFiles", g.gameFiles).putFile("protonPrefix", g.protonPrefix).putFile("icon", g.icon).putFile("logo", g.logo) - .put("source", g.source).apply { g.storeId?.let { put("storeId", it) } }, + .put("source", g.source).put("installedAt", g.installedAt).apply { g.storeId?.let { put("storeId", it) } }, ) val f = file(context) val tmp = File(f.path + ".tmp") diff --git a/app/src/main/java/com/droiddeck/launcher/frontend/WinCompSources.kt b/app/src/main/java/com/droiddeck/launcher/frontend/WinCompSources.kt index 22044c76d4..e9910a67df 100644 --- a/app/src/main/java/com/droiddeck/launcher/frontend/WinCompSources.kt +++ b/app/src/main/java/com/droiddeck/launcher/frontend/WinCompSources.kt @@ -9,7 +9,7 @@ import java.io.File import java.util.Locale object WinCompSources { - enum class Origin { STEAM, GOG, EPIC, AMAZON, STEAM_NAME, FOLDER, XBOX } + enum class Origin { STEAM, GOG, EPIC, AMAZON, STEAM_NAME, FOLDER, XBOX, UBISOFT } data class Finding(val component: String?, val original: String, val origin: Origin, val auto: Boolean, val args: List = emptyList()) @@ -83,6 +83,13 @@ object WinCompSources { } } + /** The prerequisite installers a Ubisoft manifest lists, with `$INSTALL_DIR` dropped. */ + internal fun ubisoftInstallRuns(setup: String?): List { + val runs = setup?.let { runCatching { org.json.JSONObject(it).optJSONArray("installRuns") }.getOrNull() } ?: return emptyList() + return (0 until runs.length()).mapNotNull { runs.optJSONObject(it)?.optString("exe") } + .map { it.replace('\\', '/').removePrefix("\$INSTALL_DIR").trimStart('/') }.filter { it.isNotEmpty() } + } + fun forGame(context: Context, game: Library.SteamGame): List { val folder = game.gameFiles val out = ArrayList() @@ -112,6 +119,12 @@ object WinCompSources { if (parts.isEmpty()) out += Finding(null, original, Origin.AMAZON, false) parts.forEach { out += Finding(it, original, Origin.AMAZON, true) } } + store == Store.UBISOFT -> ubisoftInstallRuns(sidecar?.extra?.get(com.droiddeck.launcher.stores.ubisoft.UbisoftLaunch.SETUP)).forEach { exe -> + val parts = installer(exe) + val original = exe.substringAfterLast('/') + if (parts.isEmpty()) out += Finding(null, original, Origin.UBISOFT, false) + parts.forEach { out += Finding(it, original, Origin.UBISOFT, true) } + } else -> {} } if (game.library == Library.ADDED && folder != null) SteamMatch.get(context, folder.path)?.let { match -> diff --git a/app/src/main/java/com/droiddeck/launcher/gpu/DriverBundle.kt b/app/src/main/java/com/droiddeck/launcher/gpu/DriverBundle.kt index 594dbebb27..319a123811 100644 --- a/app/src/main/java/com/droiddeck/launcher/gpu/DriverBundle.kt +++ b/app/src/main/java/com/droiddeck/launcher/gpu/DriverBundle.kt @@ -159,6 +159,12 @@ object DriverBundle { SessionPrefs.setLinuxDriver(context, bundle.linuxId) } + fun selectDisplay(context: Context, id: String) { + val left = active(context) + SessionPrefs.setAndroidDriver(context, id) + if (left != null && left.androidId != id) SessionPrefs.setLinuxDriver(context, "") + } + fun remove(context: Context, bundle: Bundle) { TurnipDriver(context).remove(bundle.androidId) LinuxVulkanDriverManager(context).removeDriver(bundle.linuxId) diff --git a/app/src/main/java/com/droiddeck/launcher/gpu/SystemVulkanDriver.java b/app/src/main/java/com/droiddeck/launcher/gpu/SystemVulkanDriver.java index 25a6e363c6..1106ac9602 100644 --- a/app/src/main/java/com/droiddeck/launcher/gpu/SystemVulkanDriver.java +++ b/app/src/main/java/com/droiddeck/launcher/gpu/SystemVulkanDriver.java @@ -191,6 +191,7 @@ public final class SystemVulkanDriver { /** Collect abandoned stages, and obsolete versions once older guests can no longer load them. */ public static synchronized void pruneUnused(Context context, boolean guestsStopped) throws IOException { + if (!AddonPack.POWERVR.installed(context)) return; pruneUnused(runtimeDirectory(context), guestsStopped); } diff --git a/app/src/main/java/com/droiddeck/launcher/hud/GameFrames.kt b/app/src/main/java/com/droiddeck/launcher/hud/GameFrames.kt index 98dc35074f..2aba209ded 100644 --- a/app/src/main/java/com/droiddeck/launcher/hud/GameFrames.kt +++ b/app/src/main/java/com/droiddeck/launcher/hud/GameFrames.kt @@ -6,6 +6,7 @@ import kotlin.math.roundToInt internal class FrameStats { private val graph = FloatArray(GRAPH_FRAMES) private var graphHead = 0 + private var graphFrames = 0L private var lastPresentNs = 0L private var lastFpsUpdateNs = 0L private var framesSinceUpdate = 0 @@ -38,6 +39,7 @@ internal class FrameStats { if (lastPresentNs != 0L) { graph[graphHead] = frametimeNs / 1e6f graphHead = (graphHead + 1) % GRAPH_FRAMES + graphFrames++ } val elapsed = timeNs - lastFpsUpdateNs if (elapsed >= FPS_PERIOD_NS) { @@ -68,6 +70,7 @@ internal class FrameStats { fun reset() { graph.fill(0f) graphHead = 0 + graphFrames = 0L lastPresentNs = 0L lastFpsUpdateNs = 0L framesSinceUpdate = 0 @@ -86,8 +89,9 @@ internal class FrameStats { fun frametimeMs(): Float = 1000f / maxOf(fps, 1f) @Synchronized - fun graph(out: FloatArray) { + fun graph(out: FloatArray): Long { for (i in 0 until GRAPH_FRAMES) out[i] = graph[(graphHead + i) % GRAPH_FRAMES] + return graphFrames } @Synchronized diff --git a/app/src/main/java/com/droiddeck/launcher/input/BottomScreenGuests.kt b/app/src/main/java/com/droiddeck/launcher/input/BottomScreenGuests.kt index ae44dc0e6c..574536e18a 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/BottomScreenGuests.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/BottomScreenGuests.kt @@ -9,6 +9,7 @@ import android.hardware.display.DisplayManager import android.os.Build import android.os.Handler import android.os.HandlerThread +import android.os.SystemClock import android.util.Log import android.view.Display import android.view.accessibility.AccessibilityEvent @@ -33,6 +34,8 @@ object BottomScreenGuests { else -> null } + internal fun current(arrivedAt: Long, ownShownAt: Long?): Boolean = ownShownAt == null || arrivedAt >= ownShownAt + internal fun ignorable(type: Int): Boolean = type == AccessibilityWindowInfo.TYPE_INPUT_METHOD || type == AccessibilityWindowInfo.TYPE_ACCESSIBILITY_OVERLAY || type == AccessibilityWindowInfo.TYPE_SPLIT_SCREEN_DIVIDER || @@ -43,7 +46,7 @@ object BottomScreenGuests { } class BottomScreenWatch(private val service: AccessibilityService) { - private class Arrival(val pkg: String) + private class Arrival(val pkg: String, val at: Long) private val thread = HandlerThread("bottom-screen").apply { start() } private val handler = Handler(thread.looper) @@ -52,6 +55,8 @@ class BottomScreenWatch(private val service: AccessibilityService) { private var homes: Set = emptySet() private var keyboards: Set = emptySet() private var holders: Map = emptyMap() + private var ownWindows: Map> = emptyMap() + private val ownShownAt = mutableMapOf() private val check = Runnable { evaluate() } fun start() { @@ -72,7 +77,7 @@ class BottomScreenWatch(private val service: AccessibilityService) { AccessibilityEvent.TYPE_WINDOW_STATE_CHANGED -> { val pkg = event.packageName?.toString() ?: return if (event.displayId == Display.DEFAULT_DISPLAY || pkg == own || pkg == SYSTEM_UI) return - arrivals[event.displayId] = Arrival(pkg) + arrivals[event.displayId] = Arrival(pkg, event.eventTime) } AccessibilityEvent.TYPE_WINDOWS_CHANGED -> Unit else -> return @@ -97,19 +102,25 @@ class BottomScreenWatch(private val service: AccessibilityService) { val all = runCatching { service.windowsOnAllDisplays }.getOrNull() ?: return val displays = service.getSystemService(DisplayManager::class.java) ?: return val taken = mutableMapOf() + val shown = mutableMapOf>() + val now = SystemClock.uptimeMillis() for (i in 0 until all.size()) { val id = all.keyAt(i) if (id == Display.DEFAULT_DISPLAY) continue val display = displays.getDisplay(id)?.takeIf(DualScreen::builtIn) ?: continue val windows = all.valueAt(i) - val topPkg = windows.asSequence() .filter { !BottomScreenGuests.ignorable(it.type) && cover(it, display) >= BottomScreenGuests.MIN_COVER } .sortedByDescending { it.layer } - .firstNotNullOfOrNull { packageOf(it)?.takeUnless { pkg -> pkg == own } } - val arrival = seen[id] - if (topPkg != null && arrival != null) arrivals.remove(id, arrival) + .map { it to packageOf(it) } + val ours = windows.filter { it.second == own }.map { it.first.id }.toSet() + if (!ownWindows[id].orEmpty().containsAll(ours)) ownShownAt[id] = now + shown[id] = ours + val topPkg = windows.firstNotNullOfOrNull { it.second?.takeUnless { pkg -> pkg == own } } + val arrival = seen[id]?.takeIf { BottomScreenGuests.current(it.at, ownShownAt[id]) } + seen[id]?.takeIf { topPkg != null || arrival == null }?.let { arrivals.remove(id, it) } BottomScreenGuests.holder(topPkg, arrival?.pkg?.takeUnless { it in keyboards }, homes)?.let { taken[id] = it } } + ownWindows = shown if (current !== this) return if (taken != holders) Log.i(TAG, "bottom screen holders: $taken") holders = taken diff --git a/app/src/main/java/com/droiddeck/launcher/input/ControllerPrefs.kt b/app/src/main/java/com/droiddeck/launcher/input/ControllerPrefs.kt index 1edc2395ce..5231a753ac 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/ControllerPrefs.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/ControllerPrefs.kt @@ -73,7 +73,7 @@ object ControllerPrefs { keyboardButton = p.getBoolean("keyboardButton", true), selectSteam = p.getBoolean("selectSteam", false), joyConVr = joyConVr(context), - snap = p.getBoolean("snap", true), + snap = snap(context), customLayout = p.all.keys.any { it.startsWith("layout.") }, mapping = mappable.associate { (id, _) -> id to target(context, id) }, deadZone = deadZone(context), @@ -87,11 +87,6 @@ object ControllerPrefs { prefs(context).edit().putString("map.$id", target).apply() } - fun resetMapping(context: Context) { - val p = prefs(context) - p.edit().apply { p.all.keys.filter { it.startsWith("map.") }.forEach { remove(it) } }.apply() - } - fun setTint(context: Context, tint: Int) { prefs(context).edit().putInt("tint", tint).apply() } @@ -129,10 +124,6 @@ object ControllerPrefs { prefs(context).edit().putBoolean("steamButton", on).apply() } - fun setQamButton(context: Context, on: Boolean) { - prefs(context).edit().putBoolean("qamButton", on).apply() - } - fun setKeyboardButton(context: Context, on: Boolean) { prefs(context).edit().putBoolean("keyboardButton", on).apply() } @@ -147,6 +138,8 @@ object ControllerPrefs { prefs(context).edit().putBoolean("joyConVr", on).apply() } + fun snap(context: Context): Boolean = prefs(context).getBoolean("snap", true) + fun setSnap(context: Context, on: Boolean) { prefs(context).edit().putBoolean("snap", on).apply() } @@ -172,9 +165,4 @@ object ControllerPrefs { fun resetAll(context: Context) { prefs(context).edit().clear().putBoolean("rumble", true).apply() } - - fun resetAllLayouts(context: Context) { - val p = prefs(context) - p.edit().apply { p.all.keys.filter { it.startsWith("layout.") }.forEach { remove(it) } }.apply() - } } diff --git a/app/src/main/java/com/droiddeck/launcher/input/DirectTouchHold.kt b/app/src/main/java/com/droiddeck/launcher/input/DirectTouchHold.kt index ee8d68ef05..7a64caaac6 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/DirectTouchHold.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/DirectTouchHold.kt @@ -70,6 +70,14 @@ class DirectTouchHold( handler.removeCallbacks(hold) } + fun cancelTouch() { + handler.removeCallbacks(hold) + handler.removeCallbacks(lift) + liftPending = false + if (forwarded) touch.cancel() + forwarded = false + } + fun onTouch(event: MotionEvent): Boolean { if (event.actionMasked == MotionEvent.ACTION_DOWN) { if (liftPending) { diff --git a/app/src/main/java/com/droiddeck/launcher/input/InputLibraries.kt b/app/src/main/java/com/droiddeck/launcher/input/InputLibraries.kt index 074fd834a8..bcc641ebaa 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/InputLibraries.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/InputLibraries.kt @@ -4,12 +4,13 @@ import android.content.Context import android.hardware.display.DisplayManager import android.util.DisplayMetrics import android.view.Display +import com.droiddeck.launcher.session.SessionPrefs import org.json.JSONArray import org.json.JSONObject import java.util.UUID object InputLibraries { - private const val VERSION = 12 + private const val VERSION = 14 private const val KEY = "library" private const val RECOVERY = "library-recovery." const val OVERLAY = "builtin.overlay" @@ -30,6 +31,8 @@ object InputLibraries { if (version < 11) library = neutralStockLayouts(library) if (version < 10) library = restyleGamepads(context, library) if (version < 12) library = barStockLayouts(library) + if (version < 13) library = LegacyScreenKeyMigration.pin(library) + if (version < 14) library = deckGamepadSurfaces(context, library) if (version < 6 || !p.contains(LegacyScreenKeyMigration.BACKUP)) { val legacy = LegacyScreenKeyMigration.snapshot(context) if (legacy != null) { @@ -263,6 +266,15 @@ object InputLibraries { return addStockLayouts(result) } + private fun deckGamepadSurfaces(context: Context, library: InputLibrary): InputLibrary { + val leftPad = SessionPrefs.gamepadSurface(context, right = false) == SessionPrefs.SURFACE_TRACKPAD + val rightStick = SessionPrefs.gamepadSurface(context, right = true) == SessionPrefs.SURFACE_STICK + if (!leftPad && !rightStick) return library + val saved = library.layouts.firstOrNull { it.id == DeckPanel.GAMEPAD.layout } ?: return library + if (saved.elements != InputStockLayouts.gamepad(leftPad = false, rightStick = false)) return library + return library.withLayout(saved.copy(elements = InputStockLayouts.gamepad(leftPad, rightStick))).validate() + } + private fun migrationBindingId(library: InputLibrary, binding: String, layout: String): String { val seed = JSONArray(listOf(binding, layout)).toString().toByteArray(Charsets.UTF_8) val base = "migrated.bindings." + UUID.nameUUIDFromBytes(seed) @@ -292,7 +304,7 @@ object InputLibraries { for (e in layout.elements) elements.put(JSONObject().put("id", e.id).put("kind", e.kind.name) .put("control", e.control.id).put("name", e.name).put("x", e.x.toDouble()).put("y", e.y.toDouble()) .put("width", e.width.toDouble()).put("height", e.height.toDouble()).put("floating", e.floating).put("hideWhenIdle", e.hideWhenIdle).put("mouseGestures", e.mouseGestures).put("toggle", e.toggle).put("icon", e.icon).put("image", e.image) - .put("elementOpacity", e.opacity.toDouble()).put("buttonShape", e.buttonShape.name).put("showLabel", e.showLabel)) + .put("elementOpacity", e.opacity.toDouble()).put("buttonShape", e.buttonShape.name).put("showLabel", e.showLabel).put("alwaysShown", e.alwaysShown)) layouts.put(JSONObject().put("id", layout.id).put("name", layout.name).put("template", layout.template.name).put("elements", elements) .put("tint", layout.style.tint ?: JSONObject.NULL).put("opacity", layout.style.opacity).put("screen", layout.screen.name).put("aspect", layout.aspect.toDouble()).put("scale", layout.scale.toDouble()) .put("hidden", JSONArray(layout.style.hidden.map { it.name }.sorted())).put("origin", layout.origin ?: JSONObject.NULL)) @@ -333,7 +345,7 @@ object InputLibraries { e.getDouble("y").toFloat(), e.getDouble("width").toFloat(), e.getDouble("height").toFloat(), e.getString("id"), InputElementKind.valueOf(e.getString("kind")), e.getString("name"), e.optBoolean("floating", true), e.optBoolean("hideWhenIdle", false), e.optBoolean("mouseGestures", false), e.optBoolean("toggle", false), e.optInt("icon", 0), e.optString("image", ""), - e.optDouble("elementOpacity", 1.0).toFloat(), InputButtonShape.valueOf(e.optString("buttonShape", InputButtonShape.ROUNDED.name)), e.optBoolean("showLabel", true)) + e.optDouble("elementOpacity", 1.0).toFloat(), InputButtonShape.valueOf(e.optString("buttonShape", InputButtonShape.ROUNDED.name)), e.optBoolean("showLabel", true), e.optBoolean("alwaysShown", false)) } SavedInputLayout(layout.getString("id"), layout.getString("name"), elements, InputLayoutTemplate.valueOf(layout.getString("template")), InputSurfaceStyle(if (!layout.has("tint")) ControllerPrefs.STEAM_BLUE else if (layout.isNull("tint")) null else layout.getInt("tint"), layout.optInt("opacity", 100), diff --git a/app/src/main/java/com/droiddeck/launcher/input/InputStockLayouts.kt b/app/src/main/java/com/droiddeck/launcher/input/InputStockLayouts.kt index 059fbb1dda..f3c451d6f7 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/InputStockLayouts.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/InputStockLayouts.kt @@ -45,6 +45,14 @@ internal object InputStockLayouts { InputSurfaceElement(InputControl.SELECT, .42f, .3f, .07f, .1f, buttonShape = InputButtonShape.PILL), InputSurfaceElement(InputControl.START, .51f, .3f, .07f, .1f, buttonShape = InputButtonShape.PILL)) } + fun gamepad(leftPad: Boolean, rightStick: Boolean) = gamepad().map { + when { + leftPad && it.control == InputControl.LS -> InputSurfaceElement(InputControl.LEFT_PAD, it.x, it.y, it.width, it.height) + rightStick && it.control == InputControl.RIGHT_PAD -> InputSurfaceElement(InputControl.RS, it.x, it.y, it.width, it.height) + else -> it + } + } + fun layouts() = listOf( SavedInputLayout(InputLibraries.DECK, "Deck grips + trackpads", pads() + grips(), style = NEUTRAL, screen = InputLayoutScreen.SECONDARY), SavedInputLayout(InputLibraries.TRACKPAD, "Trackpad + keyboard", listOf( diff --git a/app/src/main/java/com/droiddeck/launcher/input/InputSurfaceLayout.kt b/app/src/main/java/com/droiddeck/launcher/input/InputSurfaceLayout.kt index de16d485f4..e7e1c58a36 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/InputSurfaceLayout.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/InputSurfaceLayout.kt @@ -34,6 +34,7 @@ data class InputSurfaceElement( val opacity: Float = 1f, val buttonShape: InputButtonShape = InputButtonShape.ROUNDED, val showLabel: Boolean = true, + val alwaysShown: Boolean = false, ) { val hasClick get() = kind == InputElementKind.STICK || kind == InputElementKind.TRACKPAD diff --git a/app/src/main/java/com/droiddeck/launcher/input/InputSurfaceSource.kt b/app/src/main/java/com/droiddeck/launcher/input/InputSurfaceSource.kt index 555f99b3e0..7012731ae0 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/InputSurfaceSource.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/InputSurfaceSource.kt @@ -11,6 +11,7 @@ class InputSurfaceSource(private val pad: PadBridge, private val role: InputRole private val gestureRight = if (element.mouseGestures) router?.channel(role, InputControl.A, fixedAction = InputAction.MouseButton(273)) else null private val gestureMiddle = if (element.mouseGestures) router?.channel(role, InputControl.A, fixedAction = InputAction.MouseButton(274)) else null val mouseGestures get() = element.mouseGestures && route?.action is InputAction.Pointer + val directions get() = route?.action as? InputAction.Directions fun gestureContact(touching: Boolean) { if (!closed) route?.update(0f, 0f, touching) } fun pointerDelta(dx: Float, dy: Float) { diff --git a/app/src/main/java/com/droiddeck/launcher/input/LegacyGamepadLayout.kt b/app/src/main/java/com/droiddeck/launcher/input/LegacyGamepadLayout.kt index f2857900af..e281a2b741 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/LegacyGamepadLayout.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/LegacyGamepadLayout.kt @@ -225,7 +225,8 @@ internal class LegacyGamepadLayout(private val context: Context, private val wid ) } - fun dock(stored: List, portrait: Boolean, grips: Boolean): List { + fun dock(stored: List, portrait: Boolean, grips: Boolean, left: InputControl = InputControl.LS, + right: InputControl = InputControl.RS): List { val boxes = GamepadGeometry.layout(width.toFloat(), height.toFloat(), resources.displayMetrics.density, portrait) val placed = mutableListOf() fun box(control: InputControl, slot: GamepadGeometry.Slot, shape: InputButtonShape) { @@ -243,9 +244,9 @@ internal class LegacyGamepadLayout(private val context: Context, private val wid b.cx + direction.first * spread, b.cy + direction.second * spread, radius) } } - box(InputControl.LS, GamepadGeometry.Slot.LEFT_MAIN, InputButtonShape.CIRCLE) + box(left, GamepadGeometry.Slot.LEFT_MAIN, InputButtonShape.CIRCLE) cross(DPAD_ORDER, GamepadGeometry.Slot.LEFT_SECOND) - box(InputControl.RS, GamepadGeometry.Slot.RIGHT_MAIN, InputButtonShape.CIRCLE) + box(right, GamepadGeometry.Slot.RIGHT_MAIN, InputButtonShape.CIRCLE) cross(FACE_ORDER, GamepadGeometry.Slot.RIGHT_SECOND) box(InputControl.LT, GamepadGeometry.Slot.LEFT_OUTER_SHOULDER, InputButtonShape.PILL) box(InputControl.LB, GamepadGeometry.Slot.LEFT_INNER_SHOULDER, InputButtonShape.PILL) @@ -254,7 +255,8 @@ internal class LegacyGamepadLayout(private val context: Context, private val wid box(InputControl.SELECT, GamepadGeometry.Slot.VIEW, InputButtonShape.PILL) box(InputControl.START, GamepadGeometry.Slot.MENU, InputButtonShape.PILL) if (grips) GRIPS.forEach { (control, slot) -> box(control, slot, InputButtonShape.ROUNDED) } - return withGeometry(stored, placed) + placed.filter { p -> GRIPS.any { it.first == p.control } && stored.none { it.id == p.id } } + val surfaces = listOf(left, right).filter { it.isTrackpad } + return withGeometry(stored, placed) + placed.filter { p -> (GRIPS.any { it.first == p.control } || p.control in surfaces) && stored.none { it.id == p.id } } } private fun circle(e: InputSurfaceElement, cx: Float, cy: Float, radius: Float) = diff --git a/app/src/main/java/com/droiddeck/launcher/input/LegacyScreenKeyMigration.kt b/app/src/main/java/com/droiddeck/launcher/input/LegacyScreenKeyMigration.kt index 58329fc88e..9921fdf960 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/LegacyScreenKeyMigration.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/LegacyScreenKeyMigration.kt @@ -40,7 +40,7 @@ internal object LegacyScreenKeyMigration { if (result.profiles.any { it.id == id }) continue val converted = convert(context, set.second, metrics.widthPixels, metrics.heightPixels, metrics.density) if (converted.isEmpty()) continue - val layout = SavedInputLayout("$id.layout", set.first, converted.map { it.first }, style = style, screen = InputLayoutScreen.MAIN, + val layout = SavedInputLayout("$id.layout", set.first, converted.map { it.first.copy(alwaysShown = true) }, style = style, screen = InputLayoutScreen.MAIN, aspect = (metrics.widthPixels.coerceAtLeast(1).toFloat() / metrics.heightPixels.coerceAtLeast(1)).coerceIn(.05f, 20f)) val bindings = SavedInputBindings("$id.bindings", set.first, false, layout.id, elements = converted.associate { it.first.id to it.second }) val base = library.profile(library.steam) @@ -68,6 +68,17 @@ internal object LegacyScreenKeyMigration { return result.validate() } + fun pin(library: InputLibrary): InputLibrary { + val keys = library.layouts.firstOrNull { it.id == "$SHOWN.layout" }?.elements.orEmpty() + return library.copy(layouts = library.layouts.map { layout -> + val imported = layout.id.startsWith("migrated.screenkeys.") + layout.copy(elements = layout.elements.map { e -> + val key = e.id.startsWith("imported:") && (imported || keys.any { it.id == e.id && it.kind == e.kind && it.name == e.name }) + if (key) e.copy(alwaysShown = true) else e + }) + }) + } + internal fun convert(context: Context, raw: String, width: Int, height: Int, density: Float): List> = convert(context, parse(raw), width, height, density) diff --git a/app/src/main/java/com/droiddeck/launcher/input/MouseBackInput.kt b/app/src/main/java/com/droiddeck/launcher/input/MouseBackInput.kt index 261c88a74b..9f8240640f 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/MouseBackInput.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/MouseBackInput.kt @@ -1,5 +1,6 @@ package com.droiddeck.launcher.input +import android.os.Build import android.view.InputDevice import android.view.KeyCharacterMap import android.view.KeyEvent @@ -7,7 +8,7 @@ import android.view.KeyEvent /** * Some firmware turns a mouse's right button into Back. Most report it from the mouse itself; REDMAGIC's * cast mode injects it from no device and without the virtual-hard-key flag that the navigation bar and - * back gesture set, so that form only counts while a mouse is connected. + * back gesture set, so that form only counts while an external mouse is connected. */ class MouseBackInput(private val sendRight: (Boolean) -> Unit, private val mouseAttached: () -> Boolean) { private val held = mutableSetOf() @@ -45,6 +46,21 @@ class MouseBackInput(private val sendRight: (Boolean) -> Unit, private val mouse } companion object { + fun isExternalMouse(device: InputDevice?): Boolean { + if (device == null || device.isVirtual || PadBridge.isSystemVirtualInputName(device.name) || + declaresVirtual(device.name) || + PadBridge.isFromController(device) || + (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q && !device.isExternal)) return false + return (device.supportsSource(InputDevice.SOURCE_MOUSE) || + device.supportsSource(InputDevice.SOURCE_MOUSE_RELATIVE)) && + !device.supportsSource(InputDevice.SOURCE_TOUCHPAD) && + !device.supportsSource(InputDevice.SOURCE_TOUCHSCREEN) + } + + private val VIRTUAL_NAME = Regex("\\bvirtual\\b", RegexOption.IGNORE_CASE) + + fun declaresVirtual(name: String?): Boolean = name != null && VIRTUAL_NAME.containsMatchIn(name) + fun isFromMouse(event: KeyEvent): Boolean = event.isFromSource(InputDevice.SOURCE_MOUSE) || event.isFromSource(InputDevice.SOURCE_MOUSE_RELATIVE) diff --git a/app/src/main/java/com/droiddeck/launcher/input/OnScreenControls.kt b/app/src/main/java/com/droiddeck/launcher/input/OnScreenControls.kt index e285337124..4923221fa0 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/OnScreenControls.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/OnScreenControls.kt @@ -29,6 +29,9 @@ class OnScreenControls(context: Context, pad: PadBridge?, val dock: OnScreenLayo private set var isQuickHidden = false private set + var isPinnedOnly = false + private set + val hasPinned get() = layout?.elements?.any { it.alwaysShown } == true var onTouchMiss: ((MotionEvent) -> Unit)? get() = surface.onTouchMiss set(value) { surface.onTouchMiss = value } @@ -61,6 +64,13 @@ class OnScreenControls(context: Context, pad: PadBridge?, val dock: OnScreenLayo render() } + fun setPinnedOnly(enabled: Boolean) { + if (isPinnedOnly == enabled) return + releaseAll() + isPinnedOnly = enabled + render() + } + private data class Placement(val layout: SavedInputLayout?, val width: Int, val height: Int, val safe: Rect, val buttonsOnly: Boolean) private fun placed(): List { @@ -72,12 +82,16 @@ class OnScreenControls(context: Context, pad: PadBridge?, val dock: OnScreenLayo private fun render() { val elements = placed() - surface.updateCustomLayout(if (isQuickHidden) elements.filter { it.id == "builtin:keyboard" } else elements) + surface.updateCustomLayout(when { + isPinnedOnly -> elements.filter { it.alwaysShown } + isQuickHidden -> elements.filter { it.id == "builtin:keyboard" || it.alwaysShown } + else -> elements + }) val style = layout?.style ?: InputSurfaceStyle() surface.updateStyle(style) quickToggle.tint = style.tint quickToggle.alpha = style.opacity / 100f - quickToggle.visibility = if (isButtonsOnly || layout == null || dock != null) GONE else VISIBLE + quickToggle.visibility = if (isButtonsOnly || isPinnedOnly || layout == null || dock != null) GONE else VISIBLE quickToggle.invalidate() } diff --git a/app/src/main/java/com/droiddeck/launcher/input/OnScreenLayout.kt b/app/src/main/java/com/droiddeck/launcher/input/OnScreenLayout.kt index b7c1bafea6..3935c1a565 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/OnScreenLayout.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/OnScreenLayout.kt @@ -7,7 +7,18 @@ import kotlin.math.max import kotlin.math.min object OnScreenLayout { - data class Dock(val portrait: Boolean, val grips: Boolean) + data class Dock(val portrait: Boolean, val grips: Boolean, val left: InputControl = InputControl.LS, val right: InputControl = InputControl.RS) { + companion object { + fun deck(portrait: Boolean, gamepad: SavedInputLayout?): Dock { + fun side(right: Boolean) = gamepad?.elements?.firstOrNull { + (it.kind == InputElementKind.STICK || it.kind == InputElementKind.TRACKPAD) && (it.x + it.width / 2f >= .5f) == right + }?.kind + val left = if (side(false) == InputElementKind.TRACKPAD) InputControl.LEFT_PAD else InputControl.LS + val right = if (side(true) == InputElementKind.STICK) InputControl.RS else InputControl.RIGHT_PAD + return Dock(portrait, true, left, right) + } + } + } private const val TOLERANCE = .01f private const val KEYBOARD_ID = "builtin:keyboard" @@ -17,13 +28,13 @@ object OnScreenLayout { val stored = layout?.elements ?: return emptyList() if (width <= 0 || height <= 0) return stored val generator = LegacyGamepadLayout(context, width, height, safe, layout.scale) - if (buttonsOnly && dock == null) return generator.buttonsOnly(stored) val (reference, generated) = reference(context, layout, width, height) + if (buttonsOnly && dock == null) return generator.buttonsOnly(stored) + fit(stored.filter { it.alwaysShown }, reference.first, reference.second, width, height, safe) val gamepad = if (generated) stored.filter(::isGamepad) else emptyList() - val others = fit(stored.filterNot { generated && isGamepad(it) }, reference.first, reference.second, width, height, safe) + val others = fit(stored.filterNot { generated && isGamepad(it) || dock != null && it.alwaysShown }, reference.first, reference.second, width, height, safe) val placed = when { gamepad.isEmpty() -> emptyList() - dock != null -> generator.dock(gamepad, dock.portrait, dock.grips) + dock != null -> generator.dock(gamepad, dock.portrait, dock.grips, dock.left, dock.right) else -> generator.regenerate(gamepad) } val byId = (placed + others).associateBy { it.id } diff --git a/app/src/main/java/com/droiddeck/launcher/input/SecondScreenMode.kt b/app/src/main/java/com/droiddeck/launcher/input/SecondScreenMode.kt index 316ac08243..2d0006925f 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/SecondScreenMode.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/SecondScreenMode.kt @@ -52,4 +52,7 @@ object SecondScreenDisplays { ) } .toList() + + fun editorCandidates(selected: Int, available: List, taken: (Int) -> Boolean): List = + (listOf(selected) + available).distinct().filterNot(taken) } diff --git a/app/src/main/java/com/droiddeck/launcher/input/TouchGestureConfig.kt b/app/src/main/java/com/droiddeck/launcher/input/TouchGestureConfig.kt index d3be470568..035060585f 100644 --- a/app/src/main/java/com/droiddeck/launcher/input/TouchGestureConfig.kt +++ b/app/src/main/java/com/droiddeck/launcher/input/TouchGestureConfig.kt @@ -213,6 +213,9 @@ data class TouchGestureConfig( return if (value == MOUSE_BEHAVIOR_CLICK) MOUSE_BEHAVIOR_CLICK else MOUSE_BEHAVIOR_HOLD } + fun gamescopeRelativeMouse(mode: Int, mouseAttached: Boolean, touchpad: Boolean): Int = + if (mode == RELATIVE_MOUSE_AUTO && !mouseAttached && !touchpad) RELATIVE_MOUSE_OFF else mode + private fun normalizeRelativeMouseMode(mode: Int): Int { return if (mode in RELATIVE_MOUSE_AUTO..RELATIVE_MOUSE_OFF) mode else RELATIVE_MOUSE_AUTO } diff --git a/app/src/main/java/com/droiddeck/launcher/lab/LabNotice.kt b/app/src/main/java/com/droiddeck/launcher/lab/LabNotice.kt new file mode 100644 index 0000000000..85e1bab990 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/lab/LabNotice.kt @@ -0,0 +1,60 @@ +package com.droiddeck.launcher.lab + +import android.app.Notification +import android.app.NotificationChannel +import android.app.NotificationManager +import android.app.PendingIntent +import android.content.Context +import android.content.Intent +import com.droiddeck.launcher.FrontEndActivity +import com.droiddeck.launcher.R +import com.droiddeck.launcher.stores.download.StoreDownloadService + +/** + * Says what happened to a Lab build when the app starts, so a restart onto a new build does not + * look like a crash, and a build Android or the safety checks turned off is not lost silently. + */ +object LabNotice { + private const val CHANNEL_ID = "lab" + private const val NOTIFICATION_ID = 4120 + + /** Where a start that just moved a Lab build into use opens; the agent that built it sets it. */ + @Volatile var openOnInstall: String = "updates" + + fun started(context: Context) { + val app = context.applicationContext + val active = LabOverlay.active + val skipped = LabOverlay.skipped + val current = LabOverlay.current(app) + when { + LabOverlay.promoted && active != null -> + post(app, app.getString(R.string.lab_installed_title), app.getString(R.string.lab_installed_text, active.label), openOnInstall) + skipped == LabOverlay.SKIPPED_APP_IMAGE && current != null -> + post(app, app.getString(R.string.lab_paused_title), app.getString(R.string.lab_paused_text, current.label), "updates") + skipped == LabOverlay.Reason.OTHER_INSTALL.name || skipped == LabOverlay.Reason.DID_NOT_START.name -> { + val reason = if (skipped == LabOverlay.Reason.OTHER_INSTALL.name) R.string.lab_off_other_install else R.string.lab_off_did_not_start + post(app, app.getString(R.string.lab_off_title), app.getString(reason), "updates") + } + } + } + + private fun post(app: Context, title: String, text: String, nav: String) { + val manager = app.getSystemService(NotificationManager::class.java) ?: return + manager.createNotificationChannel(NotificationChannel(CHANNEL_ID, app.getString(R.string.upd_lab), NotificationManager.IMPORTANCE_DEFAULT)) + val open = PendingIntent.getActivity( + app, NOTIFICATION_ID, + Intent(app, FrontEndActivity::class.java).putExtra(StoreDownloadService.EXTRA_NAV, nav) + .addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP or Intent.FLAG_ACTIVITY_REORDER_TO_FRONT), + PendingIntent.FLAG_IMMUTABLE or PendingIntent.FLAG_UPDATE_CURRENT, + ) + val notification = Notification.Builder(app, CHANNEL_ID) + .setSmallIcon(R.drawable.ic_stat_session) + .setContentTitle(title) + .setContentText(text) + .setStyle(Notification.BigTextStyle().bigText(text)) + .setContentIntent(open) + .setAutoCancel(true) + .build() + runCatching { manager.notify(NOTIFICATION_ID, notification) } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/lab/LabOverlay.kt b/app/src/main/java/com/droiddeck/launcher/lab/LabOverlay.kt new file mode 100644 index 0000000000..7fb7f7a26d --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/lab/LabOverlay.kt @@ -0,0 +1,276 @@ +package com.droiddeck.launcher.lab + +import android.app.Activity +import android.app.Application +import android.content.Context +import android.content.Intent +import android.content.res.Resources +import android.content.res.loader.ResourcesLoader +import android.content.res.loader.ResourcesProvider +import android.os.Build +import android.os.Bundle +import android.os.Handler +import android.os.Looper +import android.os.ParcelFileDescriptor +import android.util.Log +import androidx.annotation.RequiresApi +import androidx.annotation.VisibleForTesting +import com.droiddeck.launcher.BuildConfig +import org.json.JSONObject +import java.io.File + +/** + * A Lab build: app code and resources an on-device agent built from this install's own commit, + * loaded over the installed APK at startup so it can be tried without reinstalling or re-signing. + * + * `files/lab/next` holds a build waiting for the next start and `files/lab/active` the one in use, + * each with `overlay.apk` (the build's dex files and linked resources) and `overlay.json`. A build + * that is replaced, turned off or refused moves to `files/lab/builds`, so it can be used again. + */ +object LabOverlay { + data class Info(val label: String, val baseCommit: String, val baseApk: String, val built: Long = 0) + + enum class Reason { REPLACED, TURNED_OFF, OTHER_INSTALL, DID_NOT_START, UNREADABLE } + + /** A build kept in `files/lab/builds`; [usable] when it was made for this install. */ + data class Saved(val dir: File, val info: Info?, val reason: Reason?, val usable: Boolean) + + private const val TAG = "LabOverlay" + private const val MAX_FAILED_STARTS = 2 + private const val STABLE_AFTER_MS = 10_000L + private const val KEEP_BUILDS = 12 + const val SKIPPED_APP_IMAGE = "app image present" + + /** The installed APK's commit; this class always comes from the APK, never from a Lab build. */ + val apkCommit: String = BuildConfig.SOURCE_COMMIT + + @Volatile var active: Info? = null + private set + @Volatile var skipped: String? = null + private set + /** This start moved a newly staged build into use. */ + @Volatile var promoted = false + private set + + private var loader: Any? = null + + @VisibleForTesting + internal var injectDex: (ClassLoader, File) -> Unit = ::prependDex + @VisibleForTesting + internal var openResources: (File) -> Any? = { if (Build.VERSION.SDK_INT >= 30) createLoader(it) else null } + @VisibleForTesting + internal var appImage: (Context) -> Boolean = ::hasAppImage + + fun root(context: Context) = File(context.filesDir, "lab") + + /** Called from [Application.attachBaseContext], before any class the build may change is loaded. */ + fun load(app: Application, mainProcess: Boolean) { + active = null + skipped = null + promoted = false + try { + val root = root(app) + if (mainProcess) promoted = promote(root) + val dir = File(root, "active") + val apk = File(dir, "overlay.apk") + val meta = File(dir, "overlay.json") + if (!apk.isFile || !meta.isFile) return + val info = parse(meta.readText()) ?: return refuse(root, mainProcess, Reason.UNREADABLE) + if (!madeFor(app, info)) return refuse(root, mainProcess, Reason.OTHER_INSTALL) + if (Build.VERSION.SDK_INT < 30) return skip("needs Android 11") + // Classes in an app image are loaded before attachBaseContext and would ignore the overlay; + // dd-lab-build recompiles the app without one (cmd package compile -m verify). + if (appImage(app)) return skip(SKIPPED_APP_IMAGE) + if (mainProcess) { + val starts = failedStarts(root) + 1 + if (starts > MAX_FAILED_STARTS) return refuse(root, true, Reason.DID_NOT_START) + File(root, "starts").writeText(starts.toString()) + } + apk.setReadOnly() + loader = openResources(apk) + injectDex(app.classLoader, apk) + active = info + addLoader(app.resources) + app.registerActivityLifecycleCallbacks(Callbacks(root, mainProcess)) + } catch (e: Throwable) { + Log.w(TAG, "Lab build not loaded", e) + skipped = e.message ?: e.javaClass.simpleName + } + } + + /** The APK's path changes with every install and update of the app, so it pins a build to one install. */ + fun madeFor(context: Context, info: Info) = info.baseCommit == apkCommit && info.baseApk == context.applicationInfo.sourceDir + + /** The build in `active`, whether or not this start loaded it. */ + fun current(context: Context): Info? = read(File(root(context), "active")) + + /** A build staged for the next start. */ + fun pending(context: Context): Info? = read(File(root(context), "next")) + + /** Kept builds, newest first. */ + fun saved(context: Context): List = File(root(context), "builds").listFiles().orEmpty() + .filter { File(it, "overlay.apk").isFile } + .sortedByDescending { it.name.toLongOrNull() ?: 0L } + .map { dir -> + val info = read(dir) + val reason = File(dir, "reason").takeIf { it.isFile }?.readText()?.trim()?.let { r -> Reason.entries.firstOrNull { it.name == r } } + Saved(dir, info, reason, info != null && madeFor(context, info)) + } + + /** Leaves the Lab build and restarts the app on the installed APK. */ + fun turnOff(context: Context) { + val root = root(context) + archive(root, File(root, "active"), Reason.TURNED_OFF) + archive(root, File(root, "next"), Reason.TURNED_OFF) + File(root, "next").deleteRecursively() + File(root, "starts").delete() + restart(context) + } + + /** Stages [build] for the next start and keeps a build that was waiting; the caller restarts the app. */ + fun stage(context: Context, build: Saved) { + val root = root(context) + val next = File(root, "next") + val waiting = File(root, "next.replaced").apply { deleteRecursively() } + next.renameTo(waiting) + next.deleteRecursively() + File(build.dir, "reason").delete() + if (!build.dir.renameTo(next)) { + waiting.renameTo(next) + error("could not stage ${build.dir.name}") + } + archive(root, waiting, Reason.REPLACED) + waiting.deleteRecursively() + } + + fun delete(build: Saved) { + build.dir.deleteRecursively() + } + + /** + * Android's background optimization can give the APK an app image again, which keeps a Lab + * build from loading. Recompiling without one needs a shell, which the caller provides. + */ + fun needsRecompile(context: Context) = appImage(context) + + fun recompileCommand(context: Context) = "cmd package compile -m verify -f ${context.packageName}" + + fun restart(context: Context) { + val launch = context.packageManager.getLaunchIntentForPackage(context.packageName) + ?.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK or Intent.FLAG_ACTIVITY_CLEAR_TASK) + if (launch != null) context.startActivity(launch) + Runtime.getRuntime().exit(0) + } + + @VisibleForTesting + internal fun parse(json: String): Info? = runCatching { + val o = JSONObject(json) + Info(o.getString("label"), o.getString("baseCommit"), o.getString("baseApk"), o.optLong("built")) + }.getOrNull() + + private fun read(dir: File): Info? = File(dir, "overlay.json").takeIf { it.isFile && File(dir, "overlay.apk").isFile }?.let { parse(it.readText()) } + + /** Moves `next` into use and keeps the build it replaces. Returns whether there was one to move. */ + @VisibleForTesting + internal fun promote(root: File): Boolean { + val next = File(root, "next") + if (!File(next, "overlay.apk").isFile || !File(next, "overlay.json").isFile) return false + val active = File(root, "active") + archive(root, active, Reason.REPLACED) + active.deleteRecursively() + if (!next.renameTo(active)) return false + File(root, "starts").delete() + return true + } + + @VisibleForTesting + internal fun archive(root: File, dir: File, reason: Reason) { + if (!File(dir, "overlay.apk").isFile) return + val builds = File(root, "builds").apply { mkdirs() } + var stamp = System.currentTimeMillis() + while (File(builds, stamp.toString()).exists()) stamp++ + val target = File(builds, stamp.toString()) + if (!dir.renameTo(target)) return + File(target, "reason").writeText(reason.name) + builds.listFiles().orEmpty().sortedByDescending { it.name.toLongOrNull() ?: 0L }.drop(KEEP_BUILDS).forEach { it.deleteRecursively() } + } + + @VisibleForTesting + internal fun failedStarts(root: File) = File(root, "starts").takeIf { it.isFile }?.readText()?.trim()?.toIntOrNull() ?: 0 + + private fun refuse(root: File, mainProcess: Boolean, reason: Reason) { + skipped = reason.name + Log.w(TAG, "Lab build turned off: $reason") + if (!mainProcess) return + archive(root, File(root, "active"), reason) + File(root, "starts").delete() + File(root, "last-off-reason").writeText(reason.name) + } + + private fun skip(reason: String) { + skipped = reason + Log.w(TAG, "Lab build not loaded: $reason") + } + + private fun hasAppImage(context: Context): Boolean { + val apk = File(context.applicationInfo.sourceDir) + val oat = File(apk.parentFile, "oat") + return oat.listFiles().orEmpty().any { File(it, "${apk.nameWithoutExtension}.art").isFile } + } + + @RequiresApi(30) + private fun createLoader(apk: File): ResourcesLoader = + ParcelFileDescriptor.open(apk, ParcelFileDescriptor.MODE_READ_ONLY).use { fd -> + ResourcesLoader().apply { addProvider(ResourcesProvider.loadFromApk(fd)) } + } + + /** Gives [resources] the Lab build's resources; contexts made from them inherit it. */ + fun addLoader(resources: Resources) { + if (Build.VERSION.SDK_INT < 30) return + val current = loader as? ResourcesLoader ?: return + resources.addLoaders(current) + } + + private fun prependDex(classLoader: ClassLoader, apk: File) { + val pathList = field(Class.forName("dalvik.system.BaseDexClassLoader"), "pathList").get(classLoader)!! + val elementsField = field(pathList.javaClass, "dexElements") + @Suppress("UNCHECKED_CAST") val installed = elementsField.get(pathList) as Array + val errors = ArrayList() + val made = try { + pathList.javaClass.getDeclaredMethod("makeDexElements", List::class.java, File::class.java, List::class.java, ClassLoader::class.java) + .apply { isAccessible = true }.invoke(null, listOf(apk), null, errors, classLoader) + } catch (_: NoSuchMethodException) { + pathList.javaClass.getDeclaredMethod( + "makeDexElements", List::class.java, File::class.java, List::class.java, ClassLoader::class.java, Boolean::class.javaPrimitiveType, + ).apply { isAccessible = true }.invoke(null, listOf(apk), null, errors, classLoader, false) + } + errors.firstOrNull()?.let { throw it } + @Suppress("UNCHECKED_CAST") val added = made as Array + if (added.isEmpty()) error("no dex in ${apk.name}") + val merged = java.lang.reflect.Array.newInstance(installed.javaClass.componentType!!, added.size + installed.size) + System.arraycopy(added, 0, merged, 0, added.size) + System.arraycopy(installed, 0, merged, added.size, installed.size) + elementsField.set(pathList, merged) + } + + private fun field(type: Class<*>, name: String) = type.getDeclaredField(name).apply { isAccessible = true } + + private class Callbacks(private val root: File, private val mainProcess: Boolean) : Application.ActivityLifecycleCallbacks { + private var settled = false + + override fun onActivityPreCreated(activity: Activity, savedInstanceState: Bundle?) = addLoader(activity.resources) + + override fun onActivityResumed(activity: Activity) { + if (settled || !mainProcess) return + settled = true + Handler(Looper.getMainLooper()).postDelayed({ File(root, "starts").delete() }, STABLE_AFTER_MS) + } + + override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) = Unit + override fun onActivityStarted(activity: Activity) = Unit + override fun onActivityPaused(activity: Activity) = Unit + override fun onActivityStopped(activity: Activity) = Unit + override fun onActivitySaveInstanceState(activity: Activity, outState: Bundle) = Unit + override fun onActivityDestroyed(activity: Activity) = Unit + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/BwrapSpawner.kt b/app/src/main/java/com/droiddeck/launcher/runtime/BwrapSpawner.kt index 2d1a9aa401..4a98fdedec 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/BwrapSpawner.kt +++ b/app/src/main/java/com/droiddeck/launcher/runtime/BwrapSpawner.kt @@ -182,6 +182,7 @@ object BwrapSpawner { val argv = request.getJSONArray("argv").let { a -> (0 until a.length()).map { a.getString(it) } } val env = LinkedHashMap() request.optJSONObject("env")?.let { e -> e.keys().forEach { k -> env[k] = e.getString(k) } } + withoutRootfsSettings(env, rootfs) val envTool = request.optString("envTool").takeIf { it.startsWith("/") } if (envTool == null && binds.any { it.guest == "/dev" }) gpu(rootfs, root, env)?.forEach { addBind(it) } val libc = listOf("/usr/lib/aarch64-linux-gnu/libc.so.6", "/lib/aarch64-linux-gnu/libc.so.6").map { hostPath(binds, root.path, it) } @@ -191,6 +192,24 @@ object BwrapSpawner { return Plan(root, binds, request.optString("cwd", "/").ifEmpty { "/" }, argv, env, envTool ?: "/usr/bin/env") } + private val ROOTFS_PIPEWIRE = listOf("PIPEWIRE_MODULE_DIR", "SPA_PLUGIN_DIR", "PIPEWIRE_CONFIG_DIR") + + /** + * The session's Flatpak passes settings for the session's own root on: the native hook's, + * DroidDeck's PipeWire build, which a runtime does not have (its apps found no PipeWire plugins), + * and the session's video driver for SDL. + */ + internal fun withoutRootfsSettings(env: MutableMap, rootfs: String) { + env.keys.removeAll { it.startsWith("DDNATV_") } + for (key in ROOTFS_PIPEWIRE) if (env[key]?.startsWith("/usr/local/lib/droiddeck-pipewire") == true) env.remove(key) + // the session's choice of X11 for SDL, in an app that Flatpak gave Wayland and no X display + if (env["SDL_VIDEODRIVER"] == "x11" && env["DISPLAY"].isNullOrEmpty() && !env["WAYLAND_DISPLAY"].isNullOrEmpty()) env.remove("SDL_VIDEODRIVER") + env["LD_PRELOAD"]?.let { preload -> + val kept = preload.split(':').filter { it.isNotEmpty() && it != rootfs && !it.startsWith("$rootfs/") } + if (kept.isEmpty()) env.remove("LD_PRELOAD") else env["LD_PRELOAD"] = kept.joinToString(":") + } + } + private const val GPU_DIR = "/run/droiddeck-gpu" private val LIB_DIRS = listOf("usr/lib/aarch64-linux-gnu", "usr/lib") @@ -347,22 +366,201 @@ object BwrapSpawner { try { Os.chmod(f.path, mode) } catch (e: Exception) { } } + private val SANDBOX_LOADERS = listOf("/usr/lib/aarch64-linux-gnu/ld-linux-aarch64.so.1", "/usr/lib/ld-linux-aarch64.so.1", + "/lib/ld-linux-aarch64.so.1", "/lib64/ld-linux-aarch64.so.1") + private val SANDBOX_LIBCS = listOf("/usr/lib/aarch64-linux-gnu/libc.so.6", "/usr/lib/libc.so.6", "/lib/aarch64-linux-gnu/libc.so.6") + private val SANDBOX_LIB_DIRS = listOf("/app/lib/aarch64-linux-gnu", "/app/lib", "/usr/lib/aarch64-linux-gnu", "/usr/lib") + private val seccompPatched = java.util.concurrent.ConcurrentHashMap.newKeySet() + + /** + * The sandbox started by the runtime's own glibc loader with the native hook, which maps the + * sandbox's mounts; null when the runtime cannot load the hook (older glibc), so proot runs it. + */ + private fun nativeLaunch(context: Context, plan: Plan): Pair, Map>? { + val rootfs = LinuxRuntime.rootDir(context) + val sandbox = plan.root.path + fun host(guest: String) = File(hostPath(plan.binds, sandbox, guest)) + if (!hasEnvTool(plan)) { + val program = plan.argv.firstOrNull()?.takeIf { it.startsWith("/") }?.let(::host)?.canonicalFile + ?.takeIf { it.isFile && isStaticElf(it) } ?: return null + if (!linkMounts(plan)) return null + return (listOf(program.path) + plan.argv.drop(1)) to plan.env + } + val loader = SANDBOX_LOADERS.map(::host).firstOrNull { it.isFile }?.canonicalFile ?: return null + val libc = SANDBOX_LIBCS.map(::host).firstOrNull { it.isFile }?.canonicalFile ?: return null + val hook = NativeGuest.hook(rootfs) + val need = glibcMinor(hook, GLIBC_NEED) { it.maxOrNull() } ?: return null + val have = glibcMinor(libc, GLIBC_RELEASE) { it.firstOrNull() } ?: return null + if (have < need) { + Log.i(TAG, "native userland: this runtime's glibc 2.$have cannot load the hook (2.$need); proot runs the sandbox") + return null + } + for (file in listOf(loader, libc)) { + val key = "${file.path}:${file.length()}:${file.lastModified()}" + if (key in seccompPatched) continue + // an unpatched loader or libc dies under Android's filter before the hook loads: proot runs it + val patched = runCatching { ElfSeccompPatch.patchFile(file) } + .onFailure { Log.e(TAG, "native userland: could not patch $file for Android's seccomp filter; proot runs the sandbox", it) } + if (patched.isFailure) return null + seccompPatched.add("${file.path}:${file.length()}:${file.lastModified()}") + } + val program = host(plan.envTool).canonicalFile.takeIf { it.isFile } ?: return null + if (!linkMounts(plan)) return null + writeRunpathConf(plan, ::host) + val launch = listOf(loader.path, "--argv0", program.name, program.path, "-i") + + plan.env.map { (k, v) -> "$k=$v" } + plan.argv + val env = linkedMapOf( + "DDNATV_ROOT" to sandbox, + "DDNATV_LINK_ROOT" to rootfs.path, + "DDNATV_BINDS" to plan.binds.joinToString("|") { "${it.host}:${it.guest}" }, + "DDNATV_HOSTNAME" to SessionPrefs.guestHostname(context), + "LD_LIBRARY_PATH" to SANDBOX_LIB_DIRS.map(::host).filter { it.isDirectory }.joinToString(":") { it.path }, + "LD_PRELOAD" to hook.path, + ).filterValues { it.isNotEmpty() } + return (NativeGuest.simulator(rootfs)?.let { it + launch } ?: launch) to env + } + + private val runpathDirs = java.util.concurrent.ConcurrentHashMap>() + + /** + * ld.so opens a library's absolute RUNPATH (libpulse's pulseaudio/ directory) without the hook, + * on Android's own filesystem, so those directories are listed for the hook in the sandbox's + * ld.so.conf too, as [NativeGuest.syncLibraryDirs] does for the rootfs. A checkout never changes. + */ + private fun writeRunpathConf(plan: Plan, host: (String) -> File) { + val confDir = inRoot(plan.root, "/run/flatpak/ld.so.conf.d")?.takeIf { it.isDirectory } ?: return + val dirs = sortedSetOf() + for (top in listOf("/usr/lib", "/app/lib")) { + val real = host(top).takeIf { it.isDirectory }?.canonicalFile ?: continue + dirs += runpathDirs.getOrPut(real.path) { + real.walkTopDown().maxDepth(4).onEnter { !Files.isSymbolicLink(it.toPath()) } + .filter { it.isFile && ".so" in it.name && !Files.isSymbolicLink(it.toPath()) } + .flatMap { runCatching { ElfRunpath.read(it) }.getOrDefault(emptyList()) } + .filter { it.startsWith("/usr/") || it.startsWith("/app/") || it.startsWith("/lib") } + .distinct().toList() + } + } + if (dirs.isEmpty()) return + runCatching { File(confDir, "runtime-999-droiddeck-runpath.conf").writeText(dirs.joinToString("\n", postfix = "\n")) } + } + + /** A runtime extension's apply_extra runs in a sandbox with nothing but the extension itself. */ + private fun hasEnvTool(plan: Plan): Boolean = + File(hostPath(plan.binds, plan.root.path, plan.envTool)).let { it.exists() || Files.isSymbolicLink(it.toPath()) } + + internal fun isStaticElf(file: File): Boolean = try { + java.io.RandomAccessFile(file, "r").use { f -> + val head = ByteArray(64).also { f.readFully(it) } + if (head[0] != 0x7f.toByte() || head[1] != 'E'.code.toByte() || head[4] != 2.toByte() || head[5] != 1.toByte()) return false + val le = java.nio.ByteBuffer.wrap(head).order(java.nio.ByteOrder.LITTLE_ENDIAN) + val phoff = le.getLong(32) + val phentsize = le.getShort(54).toInt() and 0xffff + val phnum = le.getShort(56).toInt() and 0xffff + val entry = ByteArray(4) + (0 until phnum).none { i -> + f.seek(phoff + i.toLong() * phentsize) + f.readFully(entry) + java.nio.ByteBuffer.wrap(entry).order(java.nio.ByteOrder.LITTLE_ENDIAN).int == 3 // PT_INTERP + } + } + } catch (_: java.io.IOException) { + false + } + + /** + * The kernel follows paths the hook does not see (ld.so, symbolic links), so each top-level + * mount of the sandbox is also a link to its source in the sandbox's own root, and the + * sandbox's links with absolute guest targets are made relative, which reaches them through those. + * False when a mount's place could not be made; proot then runs the sandbox, whose mounts hide + * whatever was left at their places. + */ + private fun linkMounts(plan: Plan): Boolean { + val root = plan.root.toPath() + plan.root.walkTopDown().onEnter { !Files.isSymbolicLink(it.toPath()) }.map { it.toPath() } + .filter { Files.isSymbolicLink(it) }.toList().forEach { link -> + runCatching { + val target = Files.readSymbolicLink(link).toString() + if (!target.startsWith("/")) return@runCatching + Files.delete(link) + Files.createSymbolicLink(link, link.parent.relativize(root.resolve(target.removePrefix("/")))) + } + } + // a mount inside another mount (a GL extension at /usr/lib/aarch64-linux-gnu/GL) needs its own + // place: the links of the mounts it is in become directories of links to their entries + val entryLinks = HashSet() + for (bind in plan.binds.sortedBy { it.guest.length }) { + if (bind.guest == "/") continue + val at = try { + mountPlace(plan.root, bind.guest, entryLinks)?.also { at -> + val path = at.toPath() + if (path in entryLinks) { + Files.delete(path) + entryLinks.remove(path) + } + } + } catch (e: java.io.IOException) { + Log.e(TAG, "native userland: could not make a place for ${bind.guest}; proot runs the sandbox", e) + return false + } ?: continue + val path = at.toPath() + if (at.exists() || Files.isSymbolicLink(path)) continue + at.parentFile?.mkdirs() + runCatching { Files.createSymbolicLink(path, java.nio.file.Paths.get(bind.host)) } + } + return true + } + + private fun mountPlace(root: File, guest: String, entryLinks: MutableSet): File? { + val parts = guest.split('/').filter { it.isNotEmpty() } + var f = root + for ((i, part) in parts.withIndex()) { + if (part == "..") return null + f = File(f, part) + val path = f.toPath() + if (i == parts.lastIndex || !Files.isSymbolicLink(path)) continue + val target = Files.readSymbolicLink(path) + // a link of the sandbox's own tree, made relative above, is not a mount + if (!target.isAbsolute) return null + Files.delete(path) + entryLinks.remove(path) + Files.createDirectory(path) + target.toFile().listFiles()?.forEach { entry -> + val link = path.resolve(entry.name) + Files.createSymbolicLink(link, entry.toPath()) + entryLinks.add(link) + } + } + return f + } + private fun run(context: Context, plan: Plan, client: LocalSocket, out: DataOutputStream, id: Int) { - val cmd = LinuxRuntime.prootPrefix(context, plan.root, plan.cwd) val verbose = plan.env["DROIDDECK_PROOT_VERBOSE"]?.toIntOrNull() - if (verbose != null) { cmd.add(1, "-v"); cmd.add(2, verbose.toString()) } - plan.binds.forEach { cmd.add("-b"); cmd.add(it.spec) } - cmd.add(plan.envTool) - cmd.add("-i") - plan.env.forEach { (k, v) -> cmd.add("$k=$v") } - cmd.addAll(plan.argv) - val builder = ProcessBuilder(cmd).redirectErrorStream(true).directory(plan.root) - builder.environment().apply { - clear() - put("PROOT_LOADER", LinuxRuntime.prootLoader(context).path) - put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(context).path) - if (SessionPrefs.prootNoSeccomp(context)) put("PROOT_NO_SECCOMP", "1") - LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + val native = if (NativeGuest.forSession(context)) nativeLaunch(context, plan) else null + val builder = if (native != null) { + ProcessBuilder(native.first).redirectErrorStream(true) + .directory(File(hostPath(plan.binds, plan.root.path, plan.cwd)).takeIf { it.isDirectory } ?: plan.root) + .also { b -> b.environment().apply { clear(); putAll(native.second) } } + } else { + val cmd = LinuxRuntime.prootPrefix(context, plan.root, plan.cwd) + if (verbose != null) { cmd.add(1, "-v"); cmd.add(2, verbose.toString()) } + plan.binds.forEach { cmd.add("-b"); cmd.add(it.spec) } + val envTool = hasEnvTool(plan) + if (envTool) { + cmd.add(plan.envTool) + cmd.add("-i") + plan.env.forEach { (k, v) -> cmd.add("$k=$v") } + } + cmd.addAll(plan.argv) + ProcessBuilder(cmd).redirectErrorStream(true).directory(plan.root).also { b -> + b.environment().apply { + clear() + if (!envTool) putAll(plan.env) + put("PROOT_LOADER", LinuxRuntime.prootLoader(context).path) + put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(context).path) + if (SessionPrefs.prootNoSeccomp(context)) put("PROOT_NO_SECCOMP", "1") + LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + } + } } val process = builder.start() val pid = HostProcess.pidOf(process) diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/DesktopCatalog.kt b/app/src/main/java/com/droiddeck/launcher/runtime/DesktopCatalog.kt index 2b976796fc..835c85894d 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/DesktopCatalog.kt +++ b/app/src/main/java/com/droiddeck/launcher/runtime/DesktopCatalog.kt @@ -15,6 +15,7 @@ object DesktopCatalog { const val CATALOG_URL = "https://raw.githubusercontent.com/Droid-Deck/DroidDeck-Components/main/desktop.json" const val STEAM_SEED_URL = "https://raw.githubusercontent.com/Droid-Deck/DroidDeck-Components/main/steam-seed.json" const val PROTON_SEED_ID = "proton-arm64" + const val APPIMAGE_EXEC = "/usr/local/bin/droiddeck-appimage-exec" class Entry( val id: String, val name: String, val tier: Int, val version: String, val kind: String, @@ -216,7 +217,7 @@ object DesktopCatalog { target.setExecutable(true, false) FileUtils.writeString(File(root, "usr/share/applications/droiddeck-${entry.id}.desktop"), "[Desktop Entry]\nType=Application\nName=${entry.name}\n" + - "Exec=env APPIMAGE_EXTRACT_AND_RUN=1 /opt/appimages/${entry.id}.AppImage\n" + + "Exec=$APPIMAGE_EXEC /opt/appimages/${entry.id}.AppImage\n" + "Icon=${entry.icon}\nTerminal=false\nCategories=${entry.category};\n") } else -> { diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/ElfRunpath.kt b/app/src/main/java/com/droiddeck/launcher/runtime/ElfRunpath.kt new file mode 100644 index 0000000000..dc772c49a1 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/runtime/ElfRunpath.kt @@ -0,0 +1,72 @@ +package com.droiddeck.launcher.runtime + +import java.io.File +import java.io.RandomAccessFile +import java.nio.ByteBuffer +import java.nio.ByteOrder + +/** The absolute DT_RUNPATH and DT_RPATH directories of a 64-bit little-endian ELF object. */ +object ElfRunpath { + private const val PT_LOAD = 1 + private const val PT_DYNAMIC = 2 + private const val DT_STRTAB = 5 + private const val DT_RPATH = 15 + private const val DT_RUNPATH = 29 + + fun read(file: File): List { + if (file.length() < 64) return emptyList() + RandomAccessFile(file, "r").use { raf -> + val channel = raf.channel + val header = ByteBuffer.allocate(64).order(ByteOrder.LITTLE_ENDIAN) + channel.read(header, 0) + if (header.getInt(0) != 0x464c457f || header.get(4).toInt() != 2 || header.get(5).toInt() != 1) return emptyList() + val phoff = header.getLong(32) + val phentsize = header.getShort(54).toInt() and 0xffff + val phnum = header.getShort(56).toInt() and 0xffff + if (phnum == 0 || phnum > 128 || phentsize < 56) return emptyList() + val table = ByteBuffer.allocate(phentsize * phnum).order(ByteOrder.LITTLE_ENDIAN) + channel.read(table, phoff) + class Load(val vaddr: Long, val offset: Long, val size: Long) + val loads = ArrayList() + var dynOffset = -1L + var dynSize = 0L + for (i in 0 until phnum) { + val at = i * phentsize + val type = table.getInt(at) + val offset = table.getLong(at + 8) + val vaddr = table.getLong(at + 16) + val filesz = table.getLong(at + 32) + if (type == PT_LOAD) loads.add(Load(vaddr, offset, filesz)) + if (type == PT_DYNAMIC) { dynOffset = offset; dynSize = filesz } + } + if (dynOffset < 0 || dynSize <= 0 || dynSize > 1 shl 20) return emptyList() + val dynamic = ByteBuffer.allocate(dynSize.toInt()).order(ByteOrder.LITTLE_ENDIAN) + channel.read(dynamic, dynOffset) + var strtab = -1L + val names = ArrayList() + var at = 0 + while (at + 16 <= dynamic.capacity()) { + val tag = dynamic.getLong(at) + val value = dynamic.getLong(at + 8) + if (tag == 0L) break + if (tag == DT_STRTAB.toLong()) strtab = value + if (tag == DT_RPATH.toLong() || tag == DT_RUNPATH.toLong()) names.add(value) + at += 16 + } + if (strtab < 0 || names.isEmpty()) return emptyList() + val strtabOffset = loads.firstOrNull { strtab >= it.vaddr && strtab < it.vaddr + it.size } + ?.let { strtab - it.vaddr + it.offset } ?: return emptyList() + val result = ArrayList() + for (name in names) { + val buffer = ByteBuffer.allocate(4096) + val n = channel.read(buffer, strtabOffset + name) + if (n <= 0) continue + val bytes = buffer.array() + var end = 0 + while (end < n && bytes[end].toInt() != 0) end++ + String(bytes, 0, end, Charsets.UTF_8).split(':').filter { it.startsWith("/") }.forEach { result.add(it.trimEnd('/')) } + } + return result + } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/ElfSeccompPatch.kt b/app/src/main/java/com/droiddeck/launcher/runtime/ElfSeccompPatch.kt new file mode 100644 index 0000000000..817cbc9757 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/runtime/ElfSeccompPatch.kt @@ -0,0 +1,85 @@ +package com.droiddeck.launcher.runtime + +import java.io.File +import java.nio.ByteBuffer +import java.nio.ByteOrder + +/** + * Android's app seccomp filter kills a process with SIGSYS for rseq, set_robust_list and clone3. glibc's + * dynamic linker makes the first two before any preloaded library (so before the hook's SIGSYS + * handler) exists, so the call sites in the rootfs's ld.so and libc answer by themselves instead: the + * `svc` after `mov x8, #nr` becomes a no-op for set_robust_list (glibc ignores the result) and + * `mov x0, #-ENOSYS` for rseq and clone3 (glibc falls back from both). Under proot the same + * answers are what proot gives. + */ +object ElfSeccompPatch { + private const val SVC = 0xd4000001.toInt() + private const val NOP = 0xd503201f.toInt() + private const val MOV_X0_ENOSYS = 0x928004a0.toInt() + private const val MOV_X8_SET_ROBUST_LIST = 0xd2800c68.toInt() + private const val MOV_X8_CLONE3 = 0xd2803668.toInt() + private const val MOV_X8_RSEQ = 0xd28024a8.toInt() + private const val WINDOW = 16 + + /** Patches [data] in place and returns the number of call sites changed. */ + fun patch(data: ByteArray): Int { + if (data.size < 64 || data[0] != 0x7f.toByte() || data[1] != 'E'.code.toByte() || data[4].toInt() != 2 || data[5].toInt() != 1) return 0 + val buffer = ByteBuffer.wrap(data).order(ByteOrder.LITTLE_ENDIAN) + if (buffer.getShort(18).toInt() != 183) return 0 + val phoff = buffer.getLong(32).toInt() + val phentsize = buffer.getShort(54).toInt() and 0xffff + val phnum = buffer.getShort(56).toInt() and 0xffff + var patched = 0 + for (i in 0 until phnum) { + val at = phoff + i * phentsize + if (at + 56 > data.size) break + if (buffer.getInt(at) != 1 || (buffer.getInt(at + 4) and 1) == 0) continue + val start = ((buffer.getLong(at + 8).toInt()) + 3) and 3.inv() + val end = minOf(data.size, buffer.getLong(at + 8).toInt() + buffer.getLong(at + 32).toInt()) and 3.inv() + var pos = start + while (pos + 4 <= end) { + val replacement = when (buffer.getInt(pos)) { + MOV_X8_SET_ROBUST_LIST -> NOP + MOV_X8_CLONE3, MOV_X8_RSEQ -> MOV_X0_ENOSYS + else -> null + } + if (replacement != null) { + var next = pos + 4 + val limit = minOf(end, pos + 4 + WINDOW * 4) + while (next < limit) { + val insn = buffer.getInt(next) + if (insn == SVC) { + buffer.putInt(next, replacement) + patched++ + break + } + // A site patched before, or x8 set again: an svc after it is another call's + // (a second run found clone3's thread exit there and turned it into -ENOSYS) + if (insn == MOV_X0_ENOSYS || (insn and 0x1f) == 8) break + next += 4 + } + } + pos += 4 + } + } + return patched + } + + /** Patches the file behind [path] (symlinks followed) if it still has unpatched call sites. */ + fun patchFile(path: File): Int { + val target = path.canonicalFile + if (!target.isFile) return 0 + val data = target.readBytes() + val count = patch(data) + if (count == 0) return 0 + val temp = File(target.parentFile, "." + target.name + ".seccomp") + temp.writeBytes(data) + temp.setExecutable(true, false) + temp.setReadable(true, false) + if (!temp.renameTo(target)) { + temp.delete() + throw java.io.IOException("could not replace ${target.path}") + } + return count + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/GuestCommand.kt b/app/src/main/java/com/droiddeck/launcher/runtime/GuestCommand.kt index 8e5769c312..0560752a31 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/GuestCommand.kt +++ b/app/src/main/java/com/droiddeck/launcher/runtime/GuestCommand.kt @@ -35,12 +35,10 @@ object GuestCommand { SessionFiles.stage(context, root) LinuxNetworkLinkComponent(context, root).publish() val runtimeDir = File(context.filesDir, ".flatpak-rt").apply { mkdirs() } - val cmd = LinuxRuntime.prootPrefix(context, root, "/root", fakeRoot) - if (linkDir != null) cmd.add(1, "--link2symlink") val binds = LinuxRuntime.binds(context, null, runtimeDir, Environment.getExternalStorageDirectory(), extraBinds) - binds.forEach { cmd.add("-b"); cmd.add(it) } - val fastPathKey = if (fastPath && !fakeRoot && linkDir == null && ProotFastPath.enabled(context)) ProotFastPath.key(root, binds) else null - cmd += listOf( + val native = NativeGuest.forSession(context) + val fastPathKey = if (!native && fastPath && !fakeRoot && linkDir == null && ProotFastPath.enabled(context)) ProotFastPath.key(root, binds) else null + val guest = mutableListOf( "/usr/bin/env", "-i", "HOME=/root", "USER=root", "LANG=C.UTF-8", "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games", "XDG_RUNTIME_DIR=${LinuxRuntime.GUEST_RUNTIME_DIR}", "XDG_DATA_HOME=/root/.local/share", "FLATPAK_BWRAP=${FlatpakManager.BWRAP}", @@ -48,22 +46,31 @@ object GuestCommand { "XDG_DATA_DIRS=/root/.local/share/flatpak/exports/share:/usr/local/share:/usr/share", ) DownloadSource.proxyHostPort(context).takeIf { it.isNotEmpty() }?.let { hostPort -> - cmd += listOf( + guest += listOf( "http_proxy=http://$hostPort", "https_proxy=http://$hostPort", "HTTP_PROXY=http://$hostPort", "HTTPS_PROXY=http://$hostPort", "no_proxy=localhost,127.0.0.1,::1", "NO_PROXY=localhost,127.0.0.1,::1", ) } - fastPathKey?.let { cmd += ProotFastPath.guestEnv(root, binds, it) } - cmd += argv - val builder = ProcessBuilder(cmd).directory(root).redirectErrorStream(true) - builder.environment().apply { - put("PROOT_LOADER", LinuxRuntime.prootLoader(context).path) - put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(context).path) - if (linkDir != null) put("PROOT_L2S_DIR", linkDir.path) - if (SessionPrefs.prootNoSeccomp(context)) put("PROOT_NO_SECCOMP", "1") - fastPathKey?.let { ProotFastPath.hostEnv(it).let { (k, v) -> put(k, v) } } - LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + fastPathKey?.let { guest += ProotFastPath.guestEnv(root, binds, it) } + guest += argv + val builder = if (native) { + NativeGuest.processBuilder(context, root, binds, guest).redirectErrorStream(true) + } else { + val cmd = LinuxRuntime.prootPrefix(context, root, "/root", fakeRoot) + if (linkDir != null) cmd.add(1, "--link2symlink") + binds.forEach { cmd.add("-b"); cmd.add(it) } + cmd += guest + ProcessBuilder(cmd).directory(root).redirectErrorStream(true).also { b -> + b.environment().apply { + put("PROOT_LOADER", LinuxRuntime.prootLoader(context).path) + put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(context).path) + if (linkDir != null) put("PROOT_L2S_DIR", linkDir.path) + if (SessionPrefs.prootNoSeccomp(context)) put("PROOT_NO_SECCOMP", "1") + fastPathKey?.let { ProotFastPath.hostEnv(it).let { (k, v) -> put(k, v) } } + LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + } + } } if (cancelled?.get() == true) return 130 val process = builder.start() diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/LegacyNames.kt b/app/src/main/java/com/droiddeck/launcher/runtime/LegacyNames.kt index eb01d3dc53..3febbfd1fa 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/LegacyNames.kt +++ b/app/src/main/java/com/droiddeck/launcher/runtime/LegacyNames.kt @@ -21,9 +21,11 @@ object LegacyNames { "etc/bannerlator-network.json" to "etc/droiddeck-network.json", "etc/bannerlator-wifi-scan-request" to "etc/droiddeck-wifi-scan-request", ) - private const val MENU_DIR = "usr/local/share/applications" - private const val OLD_BIN = "/usr/local/bin/bannerlator-" - private const val NEW_BIN = "/usr/local/bin/droiddeck-" + private val MENU_REWRITES = listOf( + Triple("usr/local/share/applications", "/usr/local/bin/bannerlator-", "/usr/local/bin/droiddeck-"), + Triple("usr/share/applications", "Exec=env APPIMAGE_EXTRACT_AND_RUN=1 /opt/appimages/", + "Exec=${DesktopCatalog.APPIMAGE_EXEC} /opt/appimages/"), + ) @JvmStatic @Synchronized @@ -95,14 +97,16 @@ object LegacyNames { } private fun rewriteMenuEntries(root: File) { - val entries = File(root, MENU_DIR).listFiles { f -> f.isFile && f.name.startsWith("droiddeck-") && f.name.endsWith(".desktop") } ?: return - for (entry in entries) { - val text = FileUtils.readString(entry) ?: continue - if (!text.contains(OLD_BIN)) continue - val staged = File(entry.parentFile, entry.name + ".staged") - if (!FileUtils.writeString(staged, text.replace(OLD_BIN, NEW_BIN)) || !staged.renameTo(entry)) { - staged.delete() - Log.w(TAG, "could not rewrite $entry") + for ((dir, old, new) in MENU_REWRITES) { + val entries = File(root, dir).listFiles { f -> f.isFile && f.name.startsWith("droiddeck-") && f.name.endsWith(".desktop") } ?: continue + for (entry in entries) { + val text = FileUtils.readString(entry) ?: continue + if (!text.contains(old)) continue + val staged = File(entry.parentFile, entry.name + ".staged") + if (!FileUtils.writeString(staged, text.replace(old, new)) || !staged.renameTo(entry)) { + staged.delete() + Log.w(TAG, "could not rewrite $entry") + } } } } diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/LinuxRuntime.java b/app/src/main/java/com/droiddeck/launcher/runtime/LinuxRuntime.java index 3e5b0a29cb..0253604021 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/LinuxRuntime.java +++ b/app/src/main/java/com/droiddeck/launcher/runtime/LinuxRuntime.java @@ -155,6 +155,11 @@ public final class LinuxRuntime { private static volatile List lastBinds; + /** The mounts of a session started without proot, which sandboxes and root helpers see too. */ + public static void rememberSessionBinds(List binds) { + lastBinds = binds; + } + public static List lastBinds(Context context) { List binds = lastBinds; if (binds != null) return binds; @@ -306,7 +311,17 @@ public final class LinuxRuntime { private static boolean unreadablePciDevice() { File[] devices = new File("/sys/bus/pci/devices").listFiles(); - if (devices == null) return false; + if (devices == null) { + // The directory is there but the app may not list it (Android 13 on the AYN Thor): libpci then + // aborts the whole program with "Cannot open /sys/bus/pci/devices", which Chromium's GPU + // initialisation runs into. Not there at all (no PCI bus) is fine as it is. + try { + android.system.Os.stat("/sys/bus/pci/devices"); + return true; + } catch (android.system.ErrnoException e) { + return e.errno == android.system.OsConstants.EACCES; + } + } for (File device : devices) { if (!new File(device, "vendor").canRead()) return true; } diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/LinuxRuntimeInstaller.java b/app/src/main/java/com/droiddeck/launcher/runtime/LinuxRuntimeInstaller.java index 21a40a92ae..cf613008bb 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/LinuxRuntimeInstaller.java +++ b/app/src/main/java/com/droiddeck/launcher/runtime/LinuxRuntimeInstaller.java @@ -82,8 +82,12 @@ public final class LinuxRuntimeInstaller { private LinuxRuntimeInstaller() {} public static String installedVersion(Context context) { + return LinuxRuntime.isInstalled(context) ? rootfsVersion(context) : null; + } + + private static String rootfsVersion(Context context) { File marker = new File(LinuxRuntime.rootDir(context), VERSION_FILE); - if (!marker.isFile() || !LinuxRuntime.isInstalled(context)) return null; + if (!marker.isFile()) return null; String v = FileUtils.readString(marker); return v == null ? null : v.trim(); } @@ -144,6 +148,10 @@ public final class LinuxRuntimeInstaller { } }; boolean desktop = DesktopCatalog.INSTANCE.desktopInstalled(app); + if (packsOnly(app, release, progress)) { + job.ok = true; + return true; + } job.ok = installOnce(app, release, progress); if (job.ok && desktop) keepDesktop(app, progress); return job.ok; @@ -283,6 +291,31 @@ public final class LinuxRuntimeInstaller { for (File file : files) file.delete(); } + private static kotlin.jvm.functions.Function1 packProgress(ProgressListener listener, String stage) { + return state -> { + if (listener != null && state instanceof AddonPack.State.Downloading) { + listener.onProgress(Step.DOWNLOADING, stage, Math.round(((AddonPack.State.Downloading) state).getProgress() * 100f)); + } + return kotlin.Unit.INSTANCE; + }; + } + + private static boolean packsOnly(Context context, Release release, ProgressListener listener) { + if (!LinuxRuntime.hasRootfs(context) || LinuxRuntime.isInstalled(context) || !release.version.equals(rootfsVersion(context))) return false; + File root = LinuxRuntime.rootDir(context); + try { + recoverInterruptedSwap(root, new File(root.getParentFile(), LinuxRuntime.DIR + ".new"), new File(root.getParentFile(), LinuxRuntime.DIR + ".old")); + } catch (IOException e) { + Log.w(TAG, "packs only: " + e); + return false; + } + String downloading = context.getString(R.string.rtinst_downloading); + if (listener != null) listener.onProgress(Step.DOWNLOADING, downloading, 0); + return AddonPack.PROOT.await(context, () -> true, packProgress(listener, downloading)) + && AddonPack.DIRECTAUDIO.await(context, () -> true, packProgress(listener, downloading)) + && LinuxRuntime.isInstalled(context); + } + private static boolean installOnce(Context context, Release release, ProgressListener listener) { File archive = new File(context.getCacheDir(), archiveName(release)); boolean keepPartial = false; @@ -294,10 +327,10 @@ public final class LinuxRuntimeInstaller { emptyTrash(LinuxRuntime.rootDir(context).getParentFile()); String downloading = context.getString(R.string.rtinst_downloading); if (listener != null) listener.onProgress(Step.DOWNLOADING, downloading, 0); - if (!LinuxRuntime.patchedProot(context) && !AddonPack.PROOT.await(context) + if (!LinuxRuntime.patchedProot(context) && !AddonPack.PROOT.await(context, () -> true, packProgress(listener, downloading)) && !SessionPrefs.allowStockProot(context)) throw new IOException("Cannot download proot"); - if (!AddonPack.DIRECTAUDIO.await(context)) throw new IOException("Cannot download DirectAudio"); + if (!AddonPack.DIRECTAUDIO.await(context, () -> true, packProgress(listener, downloading))) throw new IOException("Cannot download DirectAudio"); boolean ok = Downloader.downloadFile(release.url, archive, true, release.sha256, (fraction) -> { if (listener != null) { listener.onProgress(Step.DOWNLOADING, downloading, diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/NativeGuest.kt b/app/src/main/java/com/droiddeck/launcher/runtime/NativeGuest.kt new file mode 100644 index 0000000000..ae4106a081 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/runtime/NativeGuest.kt @@ -0,0 +1,269 @@ +package com.droiddeck.launcher.runtime + +import android.content.Context +import com.droiddeck.launcher.session.SessionPrefs +import java.io.File +import java.nio.file.Files + +/** + * Starts guest programs directly on the Android kernel, with no proot: the glibc loader of the + * rootfs runs the program and [HOOK] translates the guest's absolute paths, execs and the system + * calls Android's seccomp policy blocks, from inside the process. + */ +object NativeGuest { + private const val TAG = "NativeGuest" + const val HOOK = "usr/lib/libddnatv-hook.so" + private val LIB_DIRS = listOf("usr/lib", "usr/lib/aarch64-linux-gnu", "usr/local/lib", "usr/lib/systemd") + + /** Libraries every native program loads before the hook, as /etc/ld.so.preload does for proot. */ + fun preloadList(root: File): List { + val listed = File(root, "etc/droiddeck/native-preload").takeIf { it.isFile }?.readLines().orEmpty() + return listed.map { it.trim() }.filter { it.startsWith("/") && File(root, it.removePrefix("/")).isFile } + } + + fun enabled(context: Context): Boolean = + SessionPrefs.nativeUserland(context) && available(LinuxRuntime.rootDir(context)) + + /** The mode the running session started in; null between sessions. */ + @Volatile var sessionMode: Boolean? = null + + /** + * Whether a session's helpers (root commands, Flatpak sandboxes, installers) run natively: the + * session's own mode while one runs, as the setting can change under it and the rootfs is only + * prepared for native programs at a session's start. + */ + fun forSession(context: Context): Boolean = sessionMode ?: enabled(context) + + /** + * Development switch: etc/droiddeck/seccomp-sim names a helper (a guest path, then its arguments) + * that applies Android's app seccomp filter before the program starts, for devices that run apps + * without one (eng builds, or a permissive SELinux, where zygote skips it). Guest paths among the + * arguments are given as their places in the rootfs, as the helper runs before the hook. + */ + fun simulator(root: File): List? { + val words = File(root, "etc/droiddeck/seccomp-sim").takeIf { it.isFile }?.readText()?.trim() + ?.split(Regex("\\s+"))?.filter { it.isNotEmpty() } ?: return null + val helper = words.firstOrNull()?.takeIf { it.startsWith("/") }?.let { File(root, it.removePrefix("/")) } + ?.takeIf { it.isFile } ?: return null + return listOf(helper.path) + words.drop(1).map { if (it.startsWith("/")) File(root, it.removePrefix("/")).path else it } + } + + fun hook(root: File): File = File(root, HOOK) + + fun loader(root: File): File? = + listOf("usr/lib/ld-linux-aarch64.so.1", "lib/ld-linux-aarch64.so.1").map { File(root, it) }.firstOrNull { it.exists() } + + fun available(root: File): Boolean = hook(root).isFile && loader(root) != null + + fun libraryPath(root: File): String = LIB_DIRS.joinToString(":") { File(root, it).path } + + /** Environment every native process starts with; a guest `env -i` is re-seeded by the hook. */ + fun environment(root: File, preload: List = emptyList()): Map = linkedMapOf( + "DDNATV_ROOT" to root.path, + "LD_LIBRARY_PATH" to libraryPath(root), + "LD_PRELOAD" to (preload.map { File(root, it.removePrefix("/")).path } + hook(root).path).joinToString(":"), + ) + + /** + * The host command line for the guest program at [program] (an absolute guest path to a real + * file, not a symlink). + */ + fun command(root: File, program: String, args: List): List { + val loader = checkNotNull(loader(root)) { "no glibc loader in ${root.path}" } + val host = File(root, program.removePrefix("/")) + val launch = listOf(loader.path, "--argv0", host.name, host.path) + args + return simulator(root)?.let { it + launch } ?: launch + } + + /** The environment of the session process: the hook's root, the mounts proot used to make, the preload list. */ + fun sessionEnvironment(root: File, binds: List, hostname: String? = null): Map { + val preload = preloadList(root) + return linkedMapOf( + "DDNATV_ROOT" to root.path, + "DDNATV_HOSTNAME" to hostname.orEmpty(), + "DDNATV_BINDS" to binds.joinToString("|") { if (it.contains(':')) it else "$it:$it" }, + "DDNATV_PRELOAD" to preload.joinToString(":"), + "LD_LIBRARY_PATH" to libraryPath(root), + "LD_PRELOAD" to (preload.map { File(root, it.removePrefix("/")).path } + hook(root).path).joinToString(":"), + ).filterValues { it.isNotEmpty() } + } + + /** Where guest directory [cwd] is, through the session's mounts ([binds], "src:dst"); the rootfs if it is nowhere. */ + fun workingDirectory(root: File, binds: List, cwd: String): File = + File(BwrapSpawner.hostPath(binds.map { BwrapSpawner.Bind.parse(it) }, root.path, cwd)).takeIf { it.isDirectory } ?: root + + /** A process for [guest] (argv) started as proot would with [binds], in guest directory [cwd]. */ + fun processBuilder(context: Context, root: File, binds: List, guest: List, cwd: String = "/root"): ProcessBuilder = + ProcessBuilder(command(root, guest.first(), guest.drop(1))) + .directory(workingDirectory(root, binds, cwd)) + .also { builder -> + builder.environment().apply { + remove("LD_AUDIT") + putAll(sessionEnvironment(root, binds, SessionPrefs.guestHostname(context))) + } + } + + private const val RUNPATH_CONF = "etc/ld.so.conf.d/zz-droiddeck-native.conf" + private val SCAN_DIRS = listOf("usr/lib", "usr/local/lib", "opt") + + /** + * ld.so opens the absolute RUNPATH directories of a library itself, with system calls the hook + * cannot translate, so every one of them is also listed in ld.so.conf (which the hook maps). + * Rescanned when dpkg's state or a library directory changes. + */ + fun syncLibraryDirs(root: File) { + val conf = File(root, RUNPATH_CONF) + val signature = (listOf("var/lib/dpkg/status", "usr/lib", "usr/local/lib", "usr/lib/aarch64-linux-gnu") + .joinToString(",") { File(root, it).lastModified().toString() }) + "," + conf.parentFile.list()?.size + val stamp = File(root, "etc/droiddeck/native-runpath-signature") + if (conf.isFile && stamp.isFile && stamp.readText() == signature) return + val dirs = sortedSetOf() + for (name in SCAN_DIRS) File(root, name).walkTopDown().maxDepth(6) + .onEnter { !Files.isSymbolicLink(it.toPath()) } + .filter { it.isFile && !Files.isSymbolicLink(it.toPath()) && ".so" in it.name } + .forEach { file -> runCatching { ElfRunpath.read(file) }.getOrNull()?.let { dirs.addAll(it) } } + val kept = dirs.filter { it.startsWith("/usr") || it.startsWith("/lib") || it.startsWith("/opt") } + conf.parentFile?.mkdirs() + conf.writeText(kept.joinToString("\n", postfix = "\n")) + stamp.parentFile?.mkdirs() + stamp.writeText(signature) + } + + /** What a rootfs needs before anything runs in it natively; cheap once done. */ + fun prepare(context: Context, root: File) { + val relinked = relinkAbsoluteSymlinks(context, root) + if (relinked > 0) android.util.Log.i(TAG, "native userland: $relinked absolute symlinks made relative") + val patched = patchForSeccomp(root) + if (patched > 0) android.util.Log.i(TAG, "native userland: $patched system call sites in ld.so and libc answer Android's blocked calls") + syncLibraryDirs(root) + } + + /** See [ElfSeccompPatch]: the linker and libc must survive Android's seccomp filter before the hook loads. */ + fun patchForSeccomp(root: File): Int = + listOf("usr/lib/ld-linux-aarch64.so.1", "usr/lib/aarch64-linux-gnu/ld-linux-aarch64.so.1", + "usr/lib/aarch64-linux-gnu/libc.so.6", "usr/lib/libc.so.6") + .map { File(root, it) }.filter { it.exists() } + .distinctBy { it.canonicalPath }.sumOf { file -> + runCatching { ElfSeccompPatch.patchFile(file) }.getOrElse { + android.util.Log.e(TAG, "native userland: could not patch $file for Android's seccomp filter; programs will die with SIGSYS", it) + 0 + } + } + + private val HOST_LINK_TARGETS = listOf("/proc", "/dev", "/sys", "/sdcard", "/storage", "/data", "/system", "/vendor", "/apex", + "/system_ext", "/product", "/odm", "/linkerconfig", "/mnt") + + /** + * Symbolic links the kernel follows by itself (ld.so, Steam, anything that skips the hook) read + * their absolute target on Android's own filesystem. The image's links were made for proot, + * which reads the target inside the rootfs, so each is rewritten as a relative link, which + * resolves the same way under proot and without it. Rerun when the runtime changes. + */ + fun relinkAbsoluteSymlinks(context: Context, root: File): Int { + val stamp = File(root, "etc/droiddeck/native-symlinks") + val version = com.droiddeck.launcher.runtime.LinuxRuntimeInstaller.installedVersion(context).orEmpty() + "/2" + if (stamp.isFile && stamp.readText() == version) return 0 + val rootPath = root.toPath() + var rewritten = 0 + Files.walkFileTree(rootPath, object : java.nio.file.SimpleFileVisitor() { + override fun visitFile(file: java.nio.file.Path, attrs: java.nio.file.attribute.BasicFileAttributes): java.nio.file.FileVisitResult { + if (attrs.isSymbolicLink) { + try { + val target = Files.readSymbolicLink(file).toString() + if (target.startsWith("/") && HOST_LINK_TARGETS.none { target == it || target.startsWith("$it/") } + && !target.startsWith(root.path)) { + val relative = file.parent.relativize(rootPath.resolve(target.removePrefix("/"))) + val temp = file.resolveSibling(".relink-" + file.fileName) + Files.deleteIfExists(temp) + Files.createSymbolicLink(temp, relative) + Files.move(temp, file, java.nio.file.StandardCopyOption.REPLACE_EXISTING) + rewritten++ + } + } catch (_: java.io.IOException) { + } + } + return java.nio.file.FileVisitResult.CONTINUE + } + + override fun visitFileFailed(file: java.nio.file.Path, exc: java.io.IOException) = java.nio.file.FileVisitResult.CONTINUE + }) + stamp.parentFile?.mkdirs() + stamp.writeText(version) + return rewritten + } + + /** + * The guest path that host path [target] stands for in a session with [binds] ("src:dst"), or null + * when it is a guest path already: the rootfs, or the longest mount source holding it (the first + * such mount when several share a source). + */ + fun guestLinkTarget(target: String, root: String, binds: List): String? { + if (!target.startsWith("/")) return null + fun under(path: String, dir: String) = path == dir || path.startsWith("$dir/") + var best: Pair? = if (under(target, root)) root to "/" else null + for (spec in binds) { + val colon = spec.indexOf(':') + if (colon < 0) continue + val src = spec.substring(0, colon).trimEnd('/') + val dst = spec.substring(colon + 1).trimEnd('/').ifEmpty { "/" } + if (src.isEmpty() || src == dst || !under(target, src)) continue + if (best == null || src.length > best.first.length) best = src to dst + } + val (src, dst) = best ?: return null + val rest = target.removePrefix(src) + return if (rest.isEmpty()) dst else dst.trimEnd('/') + rest + } + + /** + * Wine prefixes' drive links (dosdevices) hold guest paths ("s:" -> /mnt/droiddeck-sd), which + * proot follows and the hook follows inside a mount. Earlier native sessions made them point at + * their real places, which proot cannot see: those are given their guest paths back. + */ + fun relinkPrefixDrives(root: File, binds: List): Int { + val compatdata = listOf(File(root, "root/.local/share/Steam/steamapps/compatdata")) + binds.mapNotNull { spec -> + val colon = spec.indexOf(':') + if (colon > 0 && spec.substring(colon + 1).trimEnd('/').endsWith("/steamapps/compatdata")) File(spec.substring(0, colon)) else null + } + var rewritten = 0 + for (prefix in compatdata.distinct().flatMap { it.listFiles()?.toList().orEmpty() }) { + val devices = File(prefix, "pfx/dosdevices").toPath() + val links = try { + Files.newDirectoryStream(devices).use { it.toList() } + } catch (e: java.nio.file.NoSuchFileException) { + continue + } catch (e: java.io.IOException) { + android.util.Log.w(TAG, "native userland: could not read the drive links of $prefix", e) + continue + } catch (e: java.nio.file.DirectoryIteratorException) { + android.util.Log.w(TAG, "native userland: could not read the drive links of $prefix", e) + continue + } + for (link in links) { + try { + if (!Files.isSymbolicLink(link)) continue + val guest = guestLinkTarget(Files.readSymbolicLink(link).toString(), root.path, binds) ?: continue + val temp = link.resolveSibling(".relink-" + link.fileName) + Files.deleteIfExists(temp) + Files.createSymbolicLink(temp, java.nio.file.Paths.get(guest)) + Files.move(temp, link, java.nio.file.StandardCopyOption.REPLACE_EXISTING) + rewritten++ + } catch (_: java.io.IOException) { + } + } + } + return rewritten + } + + fun builder(root: File, cwd: String, argv: List, env: Map, preload: List = emptyList()): ProcessBuilder { + val program = argv.first() + val cmd = command(root, program, argv.drop(1)) + val builder = ProcessBuilder(cmd).redirectErrorStream(false) + builder.directory(File(root, cwd.removePrefix("/")).takeIf { it.isDirectory } ?: root) + builder.environment().apply { + clear() + putAll(environment(root, preload)) + putAll(env) + } + return builder + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/ProotFastPath.kt b/app/src/main/java/com/droiddeck/launcher/runtime/ProotFastPath.kt index e9a9f4a72e..11265bd8ae 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/ProotFastPath.kt +++ b/app/src/main/java/com/droiddeck/launcher/runtime/ProotFastPath.kt @@ -12,15 +12,16 @@ object ProotFastPath { const val LIBRARY = "/usr/local/lib/libblfastpath.so" const val MAX_BINDS = 256 - fun allows(preference: Boolean, noSeccomp: Boolean, source: String): Boolean = - preference && !noSeccomp && source == LinuxRuntime.PROOT_PACK + fun allows(preference: Boolean, noSeccomp: Boolean, source: String, nativeUserland: Boolean = false): Boolean = + preference && !noSeccomp && !nativeUserland && source == LinuxRuntime.PROOT_PACK fun enabled(context: Context): Boolean { val preference = SessionPrefs.prootFastPath(context) val noSeccomp = SessionPrefs.prootNoSeccomp(context) + val nativeUserland = SessionPrefs.nativeUserland(context) val source = LinuxRuntime.prootSource(context) - val on = allows(preference, noSeccomp, source) - if (preference && !noSeccomp && !on) + val on = allows(preference, noSeccomp, source, nativeUserland) + if (preference && !noSeccomp && !nativeUserland && !on) Log.i(TAG, "proot: fast path off - binary is $source, not the patched proot") return on } diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/RootSpawner.kt b/app/src/main/java/com/droiddeck/launcher/runtime/RootSpawner.kt index 1138bab0de..a96ff46f38 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/RootSpawner.kt +++ b/app/src/main/java/com/droiddeck/launcher/runtime/RootSpawner.kt @@ -113,20 +113,26 @@ object RootSpawner { val argv = request.getJSONArray("argv").let { a -> (0 until a.length()).map { a.getString(it) } } if (argv.isEmpty()) throw IOException("no command") val cwd = request.optString("cwd", "/root").ifEmpty { "/root" } - val cmd = LinuxRuntime.prootPrefix(context, root, cwd, true) - cmd.add(1, "--link2symlink") - LinuxRuntime.lastBinds(context).filterNot { it.startsWith("/proc/self/fd/") }.forEach { cmd.add("-b"); cmd.add(it) } - cmd.add("/usr/bin/env") - cmd.add("-i") - request.optJSONObject("env")?.let { e -> e.keys().forEach { k -> cmd.add("$k=${e.getString(k)}") } } - cmd.addAll(argv) - val builder = ProcessBuilder(cmd).directory(root) - builder.environment().apply { - clear() - put("PROOT_LOADER", LinuxRuntime.prootLoader(context).path) - put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(context).path) - if (SessionPrefs.prootNoSeccomp(context)) put("PROOT_NO_SECCOMP", "1") - LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + val binds = LinuxRuntime.lastBinds(context).filterNot { it.startsWith("/proc/self/fd/") } + val guest = mutableListOf("/usr/bin/env", "-i") + request.optJSONObject("env")?.let { e -> e.keys().forEach { k -> guest.add("$k=${e.getString(k)}") } } + guest.addAll(argv) + val builder = if (NativeGuest.forSession(context)) { + NativeGuest.processBuilder(context, root, binds, guest, cwd) + } else { + val cmd = LinuxRuntime.prootPrefix(context, root, cwd, true) + cmd.add(1, "--link2symlink") + binds.forEach { cmd.add("-b"); cmd.add(it) } + cmd.addAll(guest) + ProcessBuilder(cmd).directory(root).also { b -> + b.environment().apply { + clear() + put("PROOT_LOADER", LinuxRuntime.prootLoader(context).path) + put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(context).path) + if (SessionPrefs.prootNoSeccomp(context)) put("PROOT_NO_SECCOMP", "1") + LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + } + } } val streams = listOf(stdio(fds.getOrNull(0), false), stdio(fds.getOrNull(1), true), stdio(fds.getOrNull(2), true)) try { diff --git a/app/src/main/java/com/droiddeck/launcher/runtime/UserApps.kt b/app/src/main/java/com/droiddeck/launcher/runtime/UserApps.kt index f40443e028..cd16d03b42 100644 --- a/app/src/main/java/com/droiddeck/launcher/runtime/UserApps.kt +++ b/app/src/main/java/com/droiddeck/launcher/runtime/UserApps.kt @@ -35,6 +35,7 @@ object UserApps { private const val GITHUB_REPO = "github-repo" private const val GITHUB_TAG = "github-tag" private const val GITHUB_PUBLISHED = "github-published" + private const val GITHUB_ASSET = "github-asset" enum class Kind { SCRIPT, APPIMAGE, FLATPAK } @@ -56,7 +57,7 @@ object UserApps { sealed class Source { class Script(val file: File) : Source() class AppImage(val file: File) : Source() - class GitHub(val repo: String) : Source() + class GitHub(val repo: String, val asset: String? = null) : Source() class Flatpak(val id: String) : Source() class FlatpakBundle(val file: File) : Source() } @@ -113,7 +114,7 @@ object UserApps { when (val s = request.source) { is Source.Script -> addScript(context, s.file, name, icon, request.meta, onProgress) is Source.AppImage -> AppImageManager.import(context, s.file, name, icon, request.meta) { onProgress(it, -1) } - is Source.GitHub -> addFromGitHub(context, s.repo, name, icon, onProgress) + is Source.GitHub -> addFromGitHub(context, s.repo, s.asset, name, icon, onProgress) is Source.Flatpak -> addFlatpak(context, s.id, name, icon, onProgress) is Source.FlatpakBundle -> addFlatpakBundle(context, s.file, name, icon, onProgress) } @@ -305,14 +306,26 @@ object UserApps { return if (repo.isEmpty() || repo == "." || repo == "..") null else "${m.groupValues[1]}/$repo" } - internal fun pickAsset(names: List): String? { + fun githubAsset(input: String): String? = + Regex("github\\.com/[\\w.-]+/[\\w.-]+/releases/(?:download/[^/]+|latest/download)/([^/?#]+\\.appimage)(?:[?#].*)?$", RegexOption.IGNORE_CASE) + .find(input.trim())?.groupValues?.get(1)?.let { runCatching { java.net.URLDecoder.decode(it, "UTF-8") }.getOrNull() } + + private fun assetVariant(name: String): Set = + name.lowercase().replace(Regex("x86[_-]64|amd64"), "x64").replace(Regex("x86[_-]32|i[36]86"), "x32") + .split(Regex("[^a-z0-9]+")).filter { it.isNotEmpty() && !Regex("[0-9a-f]{7,}|v?[0-9]+").matches(it) }.toSet() + + internal fun pickAsset(names: List, wanted: String? = null): String? { val images = names.filter { it.endsWith(".appimage", ignoreCase = true) } + if (wanted != null) { + images.firstOrNull { it == wanted }?.let { return it } + images.firstOrNull { assetVariant(it) == assetVariant(wanted) }?.let { return it } + } return images.firstOrNull { Regex("aarch64|arm64", RegexOption.IGNORE_CASE).containsMatchIn(it) } ?: images.firstOrNull { !Regex("x86_64|x86-64|amd64|x64|i[36]86|armhf|armv7", RegexOption.IGNORE_CASE).containsMatchIn(it) } ?: images.firstOrNull { Regex("x86_64|x86-64|amd64|x64", RegexOption.IGNORE_CASE).containsMatchIn(it) } } - private fun latestRelease(context: Context, repo: String): Pair { + private fun latestRelease(context: Context, repo: String, wanted: String? = null): Pair { val body = Downloader.downloadString("https://api.github.com/repos/$repo/releases?per_page=15") val releases = body?.let { runCatching { JSONArray(it) }.getOrNull() } ?: return null to context.getString(R.string.user_apps_github_unreachable, repo) @@ -321,7 +334,7 @@ object UserApps { if (r.optBoolean("draft")) return@mapNotNull null val assets = r.optJSONArray("assets") ?: return@mapNotNull null val byName = (0 until assets.length()).associate { j -> assets.getJSONObject(j).let { it.getString("name") to it } } - pickAsset(byName.keys.toList())?.let { asset -> + pickAsset(byName.keys.toList(), wanted)?.let { asset -> r.optBoolean("prerelease") to byName.getValue(asset).let { a -> Release(r.optString("tag_name", asset), r.optString("published_at"), asset, a.getString("browser_download_url"), Hashes.githubSha256(a.optString("digest"))) @@ -344,11 +357,11 @@ object UserApps { } private fun githubMeta(repo: String, release: Release) = - mapOf(GITHUB_REPO to repo, GITHUB_TAG to release.tag, GITHUB_PUBLISHED to release.published) + mapOf(GITHUB_REPO to repo, GITHUB_TAG to release.tag, GITHUB_PUBLISHED to release.published, GITHUB_ASSET to release.asset) - private fun addFromGitHub(context: Context, repo: String, name: String?, icon: File?, onProgress: (String, Int) -> Unit): String? { + private fun addFromGitHub(context: Context, repo: String, asset: String?, name: String?, icon: File?, onProgress: (String, Int) -> Unit): String? { onProgress(context.getString(R.string.user_apps_github_checking, repo), -1) - val (release, problem) = latestRelease(context, repo) + val (release, problem) = latestRelease(context, repo, asset) if (release == null) return problem return withDownload(context, release, onProgress) { file -> AppImageManager.import(context, file, name ?: repo.substringAfter('/'), icon, githubMeta(repo, release)) { onProgress(it, -1) } @@ -381,9 +394,10 @@ object UserApps { fun checkUpdate(context: Context, app: App): UpdateCheck { val repo = app.repo ?: return UpdateCheck.Failed(context.getString(R.string.user_apps_update_failed)) - val (release, problem) = latestRelease(context, repo) + val dir = AppImageManager.dir(context, app.key.substringAfter(':')) + val (release, problem) = latestRelease(context, repo, FileUtils.readString(File(dir, GITHUB_ASSET))?.trim()?.takeIf { it.isNotEmpty() }) if (release == null) return UpdateCheck.Failed(problem ?: context.getString(R.string.user_apps_update_failed)) - val published = FileUtils.readString(File(AppImageManager.dir(context, app.key.substringAfter(':')), GITHUB_PUBLISHED))?.trim().orEmpty() + val published = FileUtils.readString(File(dir, GITHUB_PUBLISHED))?.trim().orEmpty() val newer = if (published.isNotEmpty() && release.published.isNotEmpty()) release.published > published else release.tag != app.version return if (newer) UpdateCheck.Available(release) else UpdateCheck.Current(app.version ?: release.tag) } diff --git a/app/src/main/java/com/droiddeck/launcher/session/BottomDesktop.kt b/app/src/main/java/com/droiddeck/launcher/session/BottomDesktop.kt index 36b9c3dfdc..10d031715b 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/BottomDesktop.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/BottomDesktop.kt @@ -39,6 +39,7 @@ object BottomDesktop { val sessionDir: File, val generation: Int, val installed: Boolean, + val nativeUserland: Boolean, ) @Volatile private var launch: Launch? = null @@ -89,10 +90,11 @@ object BottomDesktop { root: File, sessionDir: File, generation: Int, + nativeUserland: Boolean, stillCurrent: () -> Boolean, ) { val prepared = Launch(ArrayList(guest), ArrayList(binds), sessionRoot, hostEnvironment.copyOf(), root, sessionDir, generation, - DesktopCatalog.desktopInstalled(root)) + DesktopCatalog.desktopInstalled(root), nativeUserland) synchronized(launchLock) { if (stillCurrent()) launch = prepared } } @@ -320,9 +322,17 @@ object BottomDesktop { add("BL_IME_DIR=" + imeDir.path) add(SCRIPT) } - val command = LinuxRuntime.commandWithBinds(context, current.root, binds, guest) + val command = if (current.nativeUserland) { + com.droiddeck.launcher.runtime.NativeGuest.command(current.root, guest.first(), guest.drop(1)) + } else { + LinuxRuntime.commandWithBinds(context, current.root, binds, guest) + } + val environment = if (current.nativeUserland) { + com.droiddeck.launcher.runtime.NativeGuest.sessionEnvironment(current.root, binds, SessionPrefs.guestHostname(context)) + .map { (k, v) -> "$k=$v" }.toTypedArray() + } else current.hostEnvironment val line = command.joinToString(" ") { it.replace("\\", "\\\\").replace(" ", "\\ ") } - val pid = HostProcess.start(line, current.hostEnvironment, current.root, { status -> + val pid = HostProcess.start(line, environment, current.root, { status -> main.post { if (generation != guestGeneration) return@post Log.i(TAG, "the desktop ended ($status)") diff --git a/app/src/main/java/com/droiddeck/launcher/session/BottomNotifications.kt b/app/src/main/java/com/droiddeck/launcher/session/BottomNotifications.kt deleted file mode 100644 index 45e0890c52..0000000000 --- a/app/src/main/java/com/droiddeck/launcher/session/BottomNotifications.kt +++ /dev/null @@ -1,60 +0,0 @@ -package com.droiddeck.launcher.session - -import android.app.Notification -import android.content.Context -import android.service.notification.NotificationListenerService -import android.service.notification.StatusBarNotification -import androidx.compose.runtime.mutableStateListOf -import androidx.core.app.NotificationManagerCompat - -data class BottomNotification(val key: String, val app: String, val title: String, val text: String, val postedAt: Long) - -object BottomNotifications { - val items = mutableStateListOf() - - fun granted(context: Context): Boolean = - context.packageName in NotificationManagerCompat.getEnabledListenerPackages(context) - - internal fun keep(own: String, pkg: String, ongoing: Boolean, groupSummary: Boolean, title: String, text: String): Boolean = - pkg != own && !ongoing && !groupSummary && (title.isNotBlank() || text.isNotBlank()) - - internal fun add(list: MutableList, item: BottomNotification) { - list.removeAll { it.key == item.key } - list.add(0, item) - while (list.size > MAX_ITEMS) list.removeAt(list.lastIndex) - } - - fun clear() = items.clear() - - internal fun post(context: Context, sbn: StatusBarNotification) { - val n = sbn.notification ?: return - val extras = n.extras - val title = extras?.getCharSequence(Notification.EXTRA_TITLE)?.toString().orEmpty() - val text = (extras?.getCharSequence(Notification.EXTRA_BIG_TEXT) ?: extras?.getCharSequence(Notification.EXTRA_TEXT))?.toString().orEmpty() - if (!keep(context.packageName, sbn.packageName, sbn.isOngoing, (n.flags and Notification.FLAG_GROUP_SUMMARY) != 0, title, text)) return - val app = runCatching { - val pm = context.packageManager - pm.getApplicationLabel(pm.getApplicationInfo(sbn.packageName, 0)).toString() - }.getOrDefault(sbn.packageName) - add(items, BottomNotification(sbn.key, app, title, text, sbn.postTime)) - } - - internal fun remove(key: String) { - items.removeAll { it.key == key } - } - - private const val MAX_ITEMS = 30 -} - -class BottomNotificationListener : NotificationListenerService() { - override fun onListenerConnected() { - BottomNotifications.clear() - runCatching { activeNotifications }.getOrNull()?.sortedBy { it.postTime }?.forEach { BottomNotifications.post(this, it) } - } - - override fun onNotificationPosted(sbn: StatusBarNotification) = BottomNotifications.post(this, sbn) - - override fun onNotificationRemoved(sbn: StatusBarNotification) = BottomNotifications.remove(sbn.key) - - override fun onListenerDisconnected() = BottomNotifications.clear() -} diff --git a/app/src/main/java/com/droiddeck/launcher/session/GameStorage.kt b/app/src/main/java/com/droiddeck/launcher/session/GameStorage.kt index 26fe486c80..5bf25103b0 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/GameStorage.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/GameStorage.kt @@ -68,8 +68,9 @@ object GameStorage { externalStoragePath: Boolean = isExternalStoragePath(path), ): Boolean = when { state == Environment.MEDIA_MOUNTED || state == Environment.MEDIA_MOUNTED_READ_ONLY -> true + path.isDirectory -> true externalStoragePath -> false - state == Environment.MEDIA_UNKNOWN || state == null -> path.isDirectory || path.parentFile?.isDirectory == true + state == Environment.MEDIA_UNKNOWN || state == null -> path.parentFile?.isDirectory == true else -> false } diff --git a/app/src/main/java/com/droiddeck/launcher/session/ProtonExtras.kt b/app/src/main/java/com/droiddeck/launcher/session/ProtonExtras.kt index 962291d2c7..94334f4dc9 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/ProtonExtras.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/ProtonExtras.kt @@ -48,11 +48,19 @@ object ProtonExtras { internal fun installedIn(dir: File, tool: Tool): List = dir.listFiles() - ?.filter { it.isDirectory && it.name.startsWith(tool.prefix) && File(it, "toolmanifest.vdf").isFile } + ?.filter { it.isDirectory && it.name.startsWith(tool.prefix) && usable(it) } ?.map { it.name } ?.sortedWith { a, b -> compareVersions(a, b) } ?: emptyList() + private fun usable(dir: File): Boolean { + val manifest = runCatching { File(dir, "toolmanifest.vdf").readText() }.getOrNull() ?: return false + val command = Regex("\\\"commandline\\\"\\s+\\\"/?([^\\\" ]+)").find(manifest)?.groupValues?.getOrNull(1) ?: return false + val compat = runCatching { File(dir, "compatibilitytool.vdf").readText() }.getOrNull() ?: return false + return Regex("\\\"from_oslist\\\"\\s+\\\"[^\\\"]*windows", RegexOption.IGNORE_CASE).containsMatchIn(compat) && + File(dir, command).isFile && File(dir, command).canExecute() + } + private val ARCH = Regex("(?i)aarch64|arm64|x86_64|x86-64|amd64") private val NUMBER = Regex("\\d+") @@ -275,14 +283,20 @@ object ProtonExtras { "LANG=C.UTF-8", "XDG_DATA_HOME=/root/.local/share", "/usr/local/bin/droiddeck-proton-extra", "/root/.local/share/Steam", archive.absolutePath, ) - val command = LinuxRuntime.command(context, null, runtimeDir, null, guest) - val process = ProcessBuilder(command) - .directory(root) - .redirectErrorStream(true) - val hostEnv = process.environment() - hostEnv["PROOT_LOADER"] = LinuxRuntime.prootLoader(context).path - hostEnv["PROOT_TMP_DIR"] = LinuxRuntime.prootTempDir(context).path - LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { hostEnv["LD_LIBRARY_PATH"] = it } + val process = if (com.droiddeck.launcher.runtime.NativeGuest.enabled(context)) { + com.droiddeck.launcher.runtime.NativeGuest.processBuilder(context, root, + LinuxRuntime.binds(context, null, runtimeDir, null, null), guest).redirectErrorStream(true) + } else { + ProcessBuilder(LinuxRuntime.command(context, null, runtimeDir, null, guest)) + .directory(root) + .redirectErrorStream(true) + .also { builder -> + val hostEnv = builder.environment() + hostEnv["PROOT_LOADER"] = LinuxRuntime.prootLoader(context).path + hostEnv["PROOT_TMP_DIR"] = LinuxRuntime.prootTempDir(context).path + LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { hostEnv["LD_LIBRARY_PATH"] = it } + } + } val child = process.start() var placed: String? = null child.inputStream.bufferedReader().useLines { lines -> diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionDisplay.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionDisplay.kt index 1cb526c90d..9b253d88a7 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionDisplay.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionDisplay.kt @@ -69,8 +69,8 @@ object SessionDisplay { const val UNFOLDED_MIN_DP = 600 - fun unfoldedGameHeight(width: Int, height: Int): Int = - minOf(width * 9 / 16, (height * UNFOLDED_MAX_GAME_SHARE).toInt()) and 1.inv() + fun unfoldedGameHeight(width: Int, height: Int, tabRow: Int = 0): Int = + (minOf(width * 9 / 16, (height * UNFOLDED_MAX_GAME_SHARE).toInt()) - tabRow.coerceAtLeast(0)).coerceAtLeast(0) and 1.inv() fun unfoldedControlsWanted( enabled: Boolean, diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionEvents.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionEvents.kt index 26b63fd5cf..6c0a076456 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionEvents.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionEvents.kt @@ -14,6 +14,7 @@ object SessionEvents { SessionPaths.take() val dir = SessionPaths.beginOrCurrent(context, label ?: SessionPaths.label(mode, null)) synchronized(SessionState) { + SessionState.clearRelaunch() SessionState.phase = SessionPhase.PREPARING SessionState.mode = mode SessionState.sessionId = dir.name diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionFiles.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionFiles.kt index cb9b5391fc..8c5e7431b1 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionFiles.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionFiles.kt @@ -33,6 +33,37 @@ object SessionFiles { "etc/xdg/autostart/droiddeck-clipboard.desktop" to "etc/xdg/autostart/droiddeck-clipboard.desktop", ) + private const val UBISOFT_SERVICE = "usr/local/lib/droiddeck-ubisoft/droiddeck-upc.exe" + + /** Fetches the Ubisoft pack and, once it lands, stages the service so a running session gets it without restarting. */ + fun ensureUbisoftService(context: Context) { + AddonPack.UBISOFT.ensure(context) { app -> + com.droiddeck.launcher.runtime.LinuxRuntime.rootDir(app).takeIf { it.isDirectory } + ?.let { stageUbisoftService(app, it, null) } + } + } + + @Synchronized + private fun stageUbisoftService(context: Context, root: File, ledger: StageLedger?) { + val pack = AddonPack.UBISOFT.takeIf { it.installed(context) }?.dir(context) ?: return + val target = File(root, UBISOFT_SERVICE) + if (ledger?.current(UBISOFT_SERVICE, target) == true) return + val staged = File(target.parentFile, target.name + ".staged") + var installed = false + try { + target.parentFile?.mkdirs() + File(pack, "droiddeck-upc.exe").inputStream().use { input -> + staged.outputStream().use { output -> FileUtils.copy(input, output) } + } + installed = staged.setExecutable(true, false) && staged.renameTo(target) + } catch (e: Exception) { + Log.w(TAG, "could not stage the Ubisoft launcher service", e) + } finally { + if (!installed) staged.delete() + } + if (installed) ledger?.staged(UBISOFT_SERVICE, target) else Log.e(TAG, "$UBISOFT_SERVICE NOT staged") + } + fun stage(context: Context, root: File, startsSession: Boolean = false) { if (DesktopCatalog.desktopInstalled(root) && !DesktopCatalog.desktopFromPack(root)) try { DesktopCatalog.cleanLegacy(context) } catch (e: Exception) { Log.w(TAG, "LXQt cleanup will retry next session", e) } @@ -40,8 +71,10 @@ object SessionFiles { WinComponents.publish(context) val files = arrayOf( "usr/local/bin/droiddeck-game-env" to "usr/local/bin/droiddeck-game-env", + "usr/local/bin/droiddeck-game-gpu" to "usr/local/bin/droiddeck-game-gpu", "usr/local/bin/droiddeck-diagnostic-inventory" to "usr/local/bin/droiddeck-diagnostic-inventory", "usr/local/bin/droiddeck-wincomponents" to "usr/local/bin/droiddeck-wincomponents", + "usr/local/bin/droiddeck-wine-pe" to "usr/local/bin/droiddeck-wine-pe", "usr/local/bin/droiddeck-msi-install" to "usr/local/bin/droiddeck-msi-install", "usr/local/bin/droiddeck-esync" to "usr/local/bin/droiddeck-esync", "usr/local/bin/droiddeck-steam-compat" to "usr/local/bin/droiddeck-steam-compat", @@ -50,6 +83,7 @@ object SessionFiles { "libblsession.so" to "usr/local/lib/libblsession.so", "libfakeinput.so" to "usr/local/lib/libfakeinput.so", "libblfastpath.so" to "usr/local/lib/libblfastpath.so", + "libddnatv-hook.so" to "usr/lib/libddnatv-hook.so", "libblaudit.so" to "usr/local/lib/libblaudit.so", "libssbs.so" to "usr/local/lib/libssbs.so", "usr/local/bin/droiddeck-session" to "usr/local/bin/droiddeck-session", @@ -112,6 +146,7 @@ object SessionFiles { "usr/local/bin/droiddeck-flatpak-setup" to "usr/local/bin/droiddeck-flatpak-setup", "usr/local/bin/droiddeck-flatpak-run" to "usr/local/bin/droiddeck-flatpak-run", "usr/local/bin/droiddeck-appimage-run" to "usr/local/bin/droiddeck-appimage-run", + "usr/local/bin/droiddeck-appimage-exec" to "usr/local/bin/droiddeck-appimage-exec", "usr/local/bin/droiddeck-script-run" to "usr/local/bin/droiddeck-script-run", "usr/local/bin/droiddeck-open" to "usr/local/bin/droiddeck-open", "usr/local/bin/droiddeck-proton-run" to "usr/local/bin/droiddeck-proton-run", @@ -248,18 +283,23 @@ object SessionFiles { } if (installed) ledger.staged(key, target) else Log.e(TAG, "DirectAudio $set/$relative NOT staged") } + stageUbisoftService(context, root, ledger) ledger.save() for (old in arrayOf("aarch64-unix", "aarch64-windows", "i386-windows")) File(root, "$DIRECTAUDIO_DIR/lib/wine/$old").deleteRecursively() val preload = StringBuilder("/usr/local/lib/libblsession.so\n") if (!File(Environment.getExternalStorageDirectory(), NO_PAD_SWITCH).exists()) { preload.append("/usr/local/lib/libfakeinput.so\n") } + val nativeUserland = SessionPrefs.nativeUserland(context) + if (nativeUserland) com.droiddeck.launcher.runtime.NativeGuest.prepare(context, root) if (ProotFastPath.enabled(context)) { val library = com.droiddeck.launcher.agent.AgentEnv.fastPathLibrary(context) preload.append(library + "\n") if (startsSession && library != ProotFastPath.LIBRARY) Log.i(TAG, "fast path preload: $library (debugging override)") } val etc = File(root, "etc").apply { mkdirs() } + File(etc, "droiddeck").mkdirs() + FileUtils.writeString(File(etc, "droiddeck/native-preload"), preload.toString()) val staged = File(etc, "ld.so.preload.staged") if (!FileUtils.writeString(staged, preload.toString()) || !staged.renameTo(File(etc, "ld.so.preload"))) { diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionLoadingDecision.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionLoadingDecision.kt new file mode 100644 index 0000000000..1c5d034dff --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionLoadingDecision.kt @@ -0,0 +1,8 @@ +package com.droiddeck.launcher.session + +internal object SessionLoadingDecision { + const val TIMEOUT_MS = 10_000L + + fun shouldReturnToLauncher(startedAt: Long, now: Long, running: Boolean, phase: SessionPhase): Boolean = + !running && phase in setOf(SessionPhase.IDLE, SessionPhase.FAILED) && now - startedAt >= TIMEOUT_MS +} diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionPrefs.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionPrefs.kt index 91ac74b20c..4b0a94f7b6 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionPrefs.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionPrefs.kt @@ -558,11 +558,11 @@ object SessionPrefs { fun picturePosition(context: Context): String = prefs(context).getString("picturePosition", "center") - ?.takeIf { it in listOf("top", "bottom", "center") } ?: "center" + ?.takeIf { it in listOf("top", "bottom", "left", "right", "center") } ?: "center" fun setPicturePosition(context: Context, position: String) { prefs(context).edit().putString("picturePosition", - position.takeIf { it in listOf("top", "bottom", "center") } ?: "center").apply() + position.takeIf { it in listOf("top", "bottom", "left", "right", "center") } ?: "center").apply() } fun returnAfterGame(context: Context): Boolean = prefs(context).getBoolean("returnAfterGame", true) @@ -752,6 +752,12 @@ object SessionPrefs { prefs(context).edit().putBoolean("prootNoSeccomp", on).apply() } + fun nativeUserland(context: Context): Boolean = prefs(context).getBoolean("nativeUserland", false) + + fun setNativeUserland(context: Context, on: Boolean) { + prefs(context).edit().putBoolean("nativeUserland", on).apply() + } + fun prootFastPath(context: Context): Boolean = prefs(context).getBoolean("prootFastPath", true) fun setProotFastPath(context: Context, on: Boolean) { @@ -1555,10 +1561,6 @@ object SessionPrefs { prefs(context).getString(if (right) "gamepadRight" else "gamepadLeft", null) ?: if (right) SURFACE_TRACKPAD else SURFACE_STICK - fun setGamepadSurface(context: Context, right: Boolean, surface: String) { - prefs(context).edit().putString(if (right) "gamepadRight" else "gamepadLeft", surface).apply() - } - fun deckPanel(context: Context): com.droiddeck.launcher.input.DeckPanel = com.droiddeck.launcher.input.DeckPanel.from(prefs(context).getString("deckPanel", null)) diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionService.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionService.kt index cc67bc800d..4faa870866 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionService.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionService.kt @@ -665,6 +665,10 @@ class SessionService : Service() { FileUtils.clear(File(LinuxRuntime.liveDir(this), "shm")) val binds = sessionBinds(controllersOn, fakeInputDir, sessionDir, guest, sessionRoot, runtimeDir) + val nativeUserland = com.droiddeck.launcher.runtime.NativeGuest.enabled(this) + synchronized(stopLock) { + if (gen == sessionGen && SessionState.running) com.droiddeck.launcher.runtime.NativeGuest.sessionMode = nativeUserland + } val fastPathKey = if (ProotFastPath.enabled(this)) { val prootBinds = LinuxRuntime.binds( this, sessionRoot, runtimeDir, Environment.getExternalStorageDirectory(), binds, @@ -681,27 +685,42 @@ class SessionService : Service() { } } else null - val command = LinuxRuntime.command( - this, sessionRoot, runtimeDir, Environment.getExternalStorageDirectory(), binds, guest, - ) - - val hostEnv = HostEnvironment() - hostEnv["PROOT_LOADER"] = LinuxRuntime.prootLoader(this).path - hostEnv["PROOT_TMP_DIR"] = LinuxRuntime.prootTempDir(this).path - if (SessionPrefs.prootNoSeccomp(this)) { - hostEnv["PROOT_NO_SECCOMP"] = "1" - Log.i(TAG, "proot: seccomp acceleration off by request") + val sessionBindSpecs = LinuxRuntime.binds(this, sessionRoot, runtimeDir, Environment.getExternalStorageDirectory(), binds) + val command = if (nativeUserland) { + LinuxRuntime.rememberSessionBinds(sessionBindSpecs) + com.droiddeck.launcher.runtime.NativeGuest.command(root, guest.first(), guest.drop(1)) + } else { + LinuxRuntime.command(this, sessionRoot, runtimeDir, Environment.getExternalStorageDirectory(), binds, guest) } - fastPathKey?.let { ProotFastPath.hostEnv(it).let { (k, v) -> hostEnv[k] = v } } + + val prootEnv = HostEnvironment() + prootEnv["PROOT_LOADER"] = LinuxRuntime.prootLoader(this).path + prootEnv["PROOT_TMP_DIR"] = LinuxRuntime.prootTempDir(this).path + if (SessionPrefs.prootNoSeccomp(this)) { + prootEnv["PROOT_NO_SECCOMP"] = "1" + if (!nativeUserland) Log.i(TAG, "proot: seccomp acceleration off by request") + } + fastPathKey?.let { ProotFastPath.hostEnv(it).let { (k, v) -> prootEnv[k] = v } } for (key in listOf("PROOT_PROFILE", "PROOT_PROFILE_SLOW_US")) { - guest.lastOrNull { it.startsWith("$key=") }?.substringAfter('=')?.let { hostEnv[key] = it } + guest.lastOrNull { it.startsWith("$key=") }?.substringAfter('=')?.let { prootEnv[key] = it } } val prootLibs = LinuxRuntime.prootLibraryPath(this) - if (prootLibs.isNotEmpty()) hostEnv["LD_LIBRARY_PATH"] = prootLibs + if (prootLibs.isNotEmpty()) prootEnv["LD_LIBRARY_PATH"] = prootLibs - val terminalCommand = LinuxRuntime.command( - this, sessionRoot, runtimeDir, Environment.getExternalStorageDirectory(), binds, shellGuest, - ) + val drives = com.droiddeck.launcher.runtime.NativeGuest.relinkPrefixDrives(root, sessionBindSpecs) + if (drives > 0) Log.i(TAG, "$drives Wine drive links given their guest paths back") + val hostEnv = if (nativeUserland) HostEnvironment().also { env -> + Log.i(TAG, "native userland: no proot (${sessionBindSpecs.size} mounts)") + com.droiddeck.launcher.runtime.NativeGuest.sessionEnvironment(root, sessionBindSpecs, SessionPrefs.guestHostname(this)) + .forEach { (k, v) -> env[k] = v } + } else prootEnv + + // The terminal and the bottom desktop run the way the session does: without proot when it does + val terminalCommand = if (nativeUserland) { + com.droiddeck.launcher.runtime.NativeGuest.command(root, shellGuest.first(), shellGuest.drop(1)) + } else { + LinuxRuntime.command(this, sessionRoot, runtimeDir, Environment.getExternalStorageDirectory(), binds, shellGuest) + } val terminalHostEnvironment = LinkedHashMap(System.getenv()) hostEnv.asArray().forEach { entry -> val separator = entry.indexOf('=') @@ -711,7 +730,7 @@ class SessionService : Service() { SessionTerminal.prepare(terminalCommand, terminalHostEnvironment.map { (key, value) -> "$key=$value" }.toTypedArray(), root, gen) val (fastPathName, _) = ProotFastPath.hostEnv("") BottomDesktop.prepare(desktopGuest, binds, sessionRoot, - hostEnv.asArray().filterNot { it.startsWith("$fastPathName=") }.toTypedArray(), root, sessionDir, gen, + prootEnv.asArray().filterNot { it.startsWith("$fastPathName=") }.toTypedArray(), root, sessionDir, gen, nativeUserland, ) { gen == sessionGen && SessionState.running } } @@ -1697,8 +1716,8 @@ class SessionService : Service() { .putExtra(EXTRA_STEAM_UI, ui) .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK) if (url.isNotEmpty()) next.putExtra(EXTRA_STEAM_URL, url) - SessionState.relaunch = next - android.os.Handler(android.os.Looper.getMainLooper()).post { stopSession(0) } + SessionState.queueRelaunch(next) + android.os.Handler(android.os.Looper.getMainLooper()).post { stopSession(0, relaunch = true) } } } watcher.startWatching() @@ -2013,7 +2032,7 @@ class SessionService : Service() { } } - private fun stopSession(status: Int, gen: Int? = null) { + private fun stopSession(status: Int, gen: Int? = null, relaunch: Boolean = false) { if (gen != null && gen != sessionGen) { Log.i(TAG, "ignoring a stop from session $gen; session $sessionGen is current") return @@ -2023,7 +2042,10 @@ class SessionService : Service() { if (gen != null && gen != sessionGen) return cancelQueuedSteamGame() gameExitWatchToken++ + // also when startup stopped before the guest ran + com.droiddeck.launcher.runtime.NativeGuest.sessionMode = null if (!SessionState.running) return + if (relaunch) SessionState.confirmRelaunchStop() SessionEvents.record("guest.exited", mapOf("status" to status)) SessionEvents.transition(SessionPhase.STOPPING, "session.stopping", mapOf("status" to status)) SessionState.running = false diff --git a/app/src/main/java/com/droiddeck/launcher/session/SessionState.kt b/app/src/main/java/com/droiddeck/launcher/session/SessionState.kt index fa6eb38c90..5f17212e52 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SessionState.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SessionState.kt @@ -73,7 +73,44 @@ object SessionState { @Volatile var steamClientArch: String? = null var steamVr by mutableStateOf(false) + @Volatile var relaunch: android.content.Intent? = null + @Volatile + private var relaunchSessionId: String? = null + @Volatile + private var relaunchStopRequested = false + + fun queueRelaunch(intent: android.content.Intent) { + synchronized(this) { + relaunch = intent + relaunchSessionId = sessionId + relaunchStopRequested = false + } + } + + fun confirmRelaunchStop() { + synchronized(this) { + relaunchStopRequested = relaunch != null && relaunchSessionId == sessionId + } + } + + fun takeRelaunch(): android.content.Intent? = synchronized(this) { + val next = relaunch + val valid = relaunchStopRequested && relaunchSessionId == sessionId + relaunch = null + relaunchSessionId = null + relaunchStopRequested = false + next.takeIf { valid } + } + + fun clearRelaunch() { + synchronized(this) { + relaunch = null + relaunchSessionId = null + relaunchStopRequested = false + } + } + @JvmStatic var hdr = false @Volatile private var deckPadValue = false diff --git a/app/src/main/java/com/droiddeck/launcher/session/SettingsReset.kt b/app/src/main/java/com/droiddeck/launcher/session/SettingsReset.kt index 2146ac1942..67f013b78f 100644 --- a/app/src/main/java/com/droiddeck/launcher/session/SettingsReset.kt +++ b/app/src/main/java/com/droiddeck/launcher/session/SettingsReset.kt @@ -22,7 +22,7 @@ object SettingsReset { "gpuDriverMode", "androidDriver", "linuxDriver", "linuxDriver.steam", "linuxDriver.desktop", "tuSysmem", "glThread", "noGlError", "zinkLazy", "mangoapp", "gpuClockPin", "gamescopeRealtime", "ramCapMb", "vramCapMb", "zramClient", "directAudio", "mic", "wifiDiscovery", "clientCpusOverride", "clientCpus", "gameCpus", - "noXalia", "fastSync", "fsyncFirst", "syncFallback", "prootNoSeccomp", "prootFastPath", "cursorComposite", + "noXalia", "fastSync", "fsyncFirst", "syncFallback", "prootNoSeccomp", "prootFastPath", "nativeUserland", "cursorComposite", "guestHostname", "fexPreset", "forceSsbs", "logs", "gameDebugLogsEnabled", "enhancedDiagnosticsNext", "storageDiagnostics", "upscaler", "upscaleSharpness", "screenEffects", "textureAnisotropy", "textureLodBias", "steamDownloadsInBackground", "steam_offline", "bootMovie", "bootMovieSound", "bootMovieVolume", "bootMovieSeconds", diff --git a/app/src/main/java/com/droiddeck/launcher/stores/CloudSaves.kt b/app/src/main/java/com/droiddeck/launcher/stores/CloudSaves.kt index 48244c4895..f68ab0ce62 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/CloudSaves.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/CloudSaves.kt @@ -87,7 +87,7 @@ object CloudSaves { val item = sidecar.extra["catalogItemId"].orEmpty() if (ns.isEmpty() || item.isEmpty()) "" else EpicApiClient.getCustomAttribute(token, ns, item, "CloudSaveFolder") } - Store.AMAZON, Store.ITCH, Store.GAMEJOLT, Store.XBOX, Store.BATTLENET -> "" + Store.AMAZON, Store.ITCH, Store.GAMEJOLT, Store.XBOX, Store.BATTLENET, Store.EA, Store.UBISOFT -> "" } ?: return null p.edit() .putString("cloud_template_$id", fetched.ifEmpty { TEMPLATE_NONE }) @@ -148,7 +148,7 @@ object CloudSaves { val dir = when (store) { Store.GOG -> CloudSavePaths.gog(template, pfx, folder) Store.EPIC -> CloudSavePaths.epic(template, pfx, folder, EpicCredentialStore.load(context)?.accountId.orEmpty(), id) - Store.AMAZON, Store.ITCH, Store.GAMEJOLT, Store.XBOX, Store.BATTLENET -> null + Store.AMAZON, Store.ITCH, Store.GAMEJOLT, Store.XBOX, Store.BATTLENET, Store.EA, Store.UBISOFT -> null } return dir to (if (dir == null) "unresolved" else "ok") } @@ -173,7 +173,7 @@ object CloudSaves { val account = EpicCredentialStore.load(context)?.accountId.orEmpty() if (token == null || account.isEmpty()) null else EpicCloud(account, id, token) } - Store.AMAZON, Store.ITCH, Store.GAMEJOLT, Store.XBOX, Store.BATTLENET -> null + Store.AMAZON, Store.ITCH, Store.GAMEJOLT, Store.XBOX, Store.BATTLENET, Store.EA, Store.UBISOFT -> null } private fun gogScopedToken(context: Context, id: String, clientId: String): String? { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/LoginFlows.kt b/app/src/main/java/com/droiddeck/launcher/stores/LoginFlows.kt index 4e53c5ea08..980f496b26 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/LoginFlows.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/LoginFlows.kt @@ -13,11 +13,15 @@ internal object LoginFlows { Store.EPIC -> epicFlow() Store.AMAZON -> amazonFlow() Store.GAMEJOLT -> gameJoltFlow(browserUserAgent) + Store.UBISOFT -> ubisoftFlow(browserUserAgent) + Store.EA -> eaFlow(browserUserAgent) Store.ITCH, Store.XBOX, Store.BATTLENET -> null } @Volatile var epicFlow: () -> StoreLoginActivity.Flow? = { null } @Volatile var amazonFlow: () -> StoreLoginActivity.Flow? = { null } + @Volatile var ubisoftFlow: (String) -> StoreLoginActivity.Flow? = { null } + @Volatile var eaFlow: (String) -> StoreLoginActivity.Flow? = { null } @Volatile var gameJoltFlow: (String) -> StoreLoginActivity.Flow? = { null } private class GogFlow(private val state: String, override val userAgent: String) : StoreLoginActivity.Flow { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/Store.kt b/app/src/main/java/com/droiddeck/launcher/stores/Store.kt index b7d0fbce1c..b8a6e8931e 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/Store.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/Store.kt @@ -7,7 +7,9 @@ enum class Store(val id: String, val label: String, val shortLabel: String) { XBOX("xbox", "Xbox", "Xbox"), ITCH("itch", "Itch.io", "Itch.io"), GAMEJOLT("gamejolt", "Game Jolt", "Game Jolt"), - BATTLENET("battlenet", "Battle.net", "Battle.net"); + BATTLENET("battlenet", "Battle.net", "Battle.net"), + UBISOFT("ubisoft", "Ubisoft Connect", "Ubisoft"), + EA("ea", "EA", "EA"); val folder: String get() = if (this == ITCH) "itch" else shortLabel diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt index ad59e511a0..cb46d23601 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreCatalog.kt @@ -65,6 +65,8 @@ private fun releaseDateValue(raw: String): Long = runCatching { java.time.LocalDate.parse(day).toEpochDay() }.getOrDefault(0L) } ?: 0L +internal fun entryTime(first: Long?, fallback: Long?): Long = first?.takeIf { it > 0 } ?: fallback?.takeIf { it > 0 } ?: 0L + fun sortGames( items: List, sort: String, diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreExe.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreExe.kt index ad2d478c18..0e9792edc7 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreExe.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreExe.kt @@ -3,7 +3,8 @@ package com.droiddeck.launcher.stores import java.io.File object StoreExe { - private val SKIP = listOf("redist", "unins", "setup", "crash", "report", "helper", "dotnet", "vcredist", "directx", "eac", "easyanticheat", "battleye", "launcher", "updater", "config") + private val SKIP = listOf("redist", "unins", "setup", "crash", "report", "helper", "dotnet", "vcredist", "directx", "eac", "easyanticheat", "battleye", "launcher", "updater", "config", "installer", "autorun") + private val SKIP_DIRS = setOf("installer_resources", "redist", "_commonredist", "support") fun pick(folder: File, hint: String?, title: String): String { val hinted = hint?.takeIf { it.isNotBlank() }?.replace('\\', '/')?.trimStart('/')?.let { File(folder, it) } @@ -28,7 +29,7 @@ object StoreExe { if (SKIP.none { lower.contains(it) }) out.add(f) } } - for (f in files) if (f.isDirectory && !f.name.startsWith(".")) collect(f, out, depth + 1) + for (f in files) if (f.isDirectory && !f.name.startsWith(".") && f.name.lowercase() !in SKIP_DIRS) collect(f, out, depth + 1) } private fun depth(root: File, f: File): Int = relative(root, f).count { it == '/' } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunch.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunch.kt index 378d7fa74b..222b53702e 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunch.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunch.kt @@ -11,9 +11,14 @@ object StoreLaunch { const val LAUNCHER = ".droiddeck-launch.bat" const val EPIC_CODE = ".droiddeck-epic-code" const val EPIC_ARGS = ".droiddeck-epic-args" + const val UBISOFT_LAUNCH = ".droiddeck-ubisoft.json" + private const val UBISOFT_SERVICE = "Z:\\usr\\local\\lib\\droiddeck-ubisoft\\droiddeck-upc.exe" + const val EA_ENV = ".droiddeck-ea-env" + /** A sleeping stand-in that the launch hook installs; older EA SDKs require a running Origin process. */ + const val EA_ORIGIN = "C:\\Program Files (x86)\\Origin\\Origin.exe" fun writeLauncher(folder: File, sidecar: StoreGameSidecar): StoreGameSidecar { - val needs = sidecar.args.isNotEmpty() || sidecar.env.isNotEmpty() || sidecar.store == Store.EPIC + val needs = sidecar.args.isNotEmpty() || sidecar.env.isNotEmpty() || sidecar.store == Store.EPIC || sidecar.store == Store.EA || sidecar.store == Store.UBISOFT val file = File(folder, LAUNCHER) if (!needs) { file.delete(); return sidecar.copy(launcher = null) } file.writeText(launcherText(sidecar)) @@ -49,6 +54,21 @@ object StoreLaunch { lines += "del \"%~dp0$EPIC_ARGS\"" lines += "if exist \"%~dp0$EPIC_CODE\" del \"%~dp0$EPIC_CODE\"" lines += "set \"$CLIENT_VAR=\" & \"%~dp0$exe\" %$CLIENT_VAR%" + } else if (sidecar.store == Store.UBISOFT) { + lines += "if not exist \"%~dp0$UBISOFT_LAUNCH\" goto direct" + lines += "if not exist \"$UBISOFT_SERVICE\" goto direct" + lines += "\"$UBISOFT_SERVICE\" \"%~dp0$UBISOFT_LAUNCH\"" + lines += "goto :eof" + lines += ":direct" + lines += run + } else if (sidecar.store == Store.EA) { + lines += "if not exist \"%~dp0$EA_ENV\" goto run" + lines += "for /f \"usebackq tokens=1,* delims==\" %%a in (\"%~dp0$EA_ENV\") do set \"%%a=%%b\"" + lines += "del \"%~dp0$EA_ENV\"" + lines += ":run" + lines += "if exist \"$EA_ORIGIN\" start \"\" \"$EA_ORIGIN\"" + lines += run + lines += "taskkill /f /im Origin.exe >nul 2>&1" } else { lines += run } @@ -73,6 +93,17 @@ object StoreLaunch { return Library.addedGame(context, game) } + /** Gives a Ubisoft game installed before it needed one the launcher that starts the launcher service. */ + fun adopt(folder: File, sidecar: StoreGameSidecar): StoreGameSidecar { + if (sidecar.store != Store.UBISOFT || !sidecar.isInstalled) return sidecar + val wrongExe = !sidecar.exeFile(folder).isFile || sidecar.exe.contains("installer", ignoreCase = true) || sidecar.exe.contains("autorun", ignoreCase = true) + if (sidecar.launcher == LAUNCHER && !wrongExe) return sidecar + val exe = if (wrongExe) StoreExe.pick(folder, null, sidecar.title).ifEmpty { sidecar.exe } else sidecar.exe + if (exe == sidecar.exe && sidecar.launcher == LAUNCHER && + runCatching { File(folder, LAUNCHER).readText() }.getOrNull() == launcherText(sidecar)) return sidecar + return runCatching { writeLauncher(folder, sidecar.copy(exe = exe)).also { it.write(folder) } }.getOrDefault(sidecar) + } + fun refreshLauncher(folder: File, sidecar: StoreGameSidecar) { if (sidecar.launcher != LAUNCHER) return val file = File(folder, LAUNCHER) diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunchRequests.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunchRequests.kt index b4b9f7669a..18f5a161e3 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunchRequests.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreLaunchRequests.kt @@ -38,6 +38,7 @@ object StoreLaunchRequests { fun stop() { com.droiddeck.launcher.stores.xbox.XboxRuntime.stop() + com.droiddeck.launcher.stores.ea.EaLsx.stop() synchronized(lock) { observer?.stopWatching() observer = null @@ -58,6 +59,12 @@ object StoreLaunchRequests { "xbox-renew" -> JSONObject().put("ok", com.droiddeck.launcher.stores.xbox.XboxRuntime.renew(app, request.optString("id"), request.optString("lease"))) "xbox-prepare" -> runCatching { com.droiddeck.launcher.stores.xbox.XboxRuntime.prepare(app, request.getString("id")) } .getOrElse { JSONObject().put("ok", false).put("reason", "Xbox account service is unavailable. Sign in again and retry.") } + "ea-prepare" -> runCatching { lastLaunched = Store.EA to request.optString("id"); com.droiddeck.launcher.stores.ea.EaLaunch.prepare(app, request) } + .getOrElse { JSONObject().put("ok", false).put("reason", "error-" + it.javaClass.simpleName) } + "ea-exited" -> { + com.droiddeck.launcher.stores.ea.EaLsx.stop(request.optString("id")) + JSONObject().put("ok", true) + } "gog-achievements" -> runCatching { com.droiddeck.launcher.stores.gog.GogComet.prepare(app, request.optString("id")) } .getOrElse { JSONObject().put("ok", false).put("ready", false).put("reason", "service-unavailable") } "epic-code" -> { @@ -69,6 +76,15 @@ object StoreLaunchRequests { JSONObject().put("ok", true).put("code", code.written).put("reason", code.reason) } } + "ubisoft-launch" -> { + val id = request.optString("id") + if (id.isEmpty()) JSONObject().put("ok", false).put("reason", "no-id") + else { + lastLaunched = Store.UBISOFT to id + runCatching { com.droiddeck.launcher.stores.ubisoft.UbisoftLaunch.prepare(app, id) } + .getOrElse { JSONObject().put("ok", false).put("reason", it.javaClass.simpleName) } + } + } "cloud-down" -> { val store = Store.byId(request.optString("store")) val id = request.optString("id") diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreLoginActivity.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreLoginActivity.kt index 228d97cd78..a07e0be855 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreLoginActivity.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreLoginActivity.kt @@ -47,6 +47,9 @@ class StoreLoginActivity : ComponentActivity() { ?.takeIf { "Chrome/" in it } ?: "Mozilla/5.0 (Linux; Android ${Build.VERSION.RELEASE}; ${Build.MODEL}) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.6533.103 Mobile Safari/537.36" + private const val PAGE_TRIES = 20 + private const val PAGE_RETRY_MS = 500L + fun generateState(): String { val bytes = ByteArray(24) java.security.SecureRandom().nextBytes(bytes) @@ -60,6 +63,8 @@ class StoreLoginActivity : ComponentActivity() { fun isRedirect(url: String): Boolean fun finish(activity: StoreLoginActivity, view: WebView, url: String): String? val readsPage: Boolean get() = false + val pageScript: String get() = "(function(){ try { return document.body.innerText; } catch(e){ return ''; } })()" + fun pageReady(result: String): Boolean = true fun forgetSignIn(done: () -> Unit) = done() } @@ -323,6 +328,14 @@ class StoreLoginActivity : ComponentActivity() { } } + private fun readPage(view: WebView, f: Flow, left: Int) { + view.evaluateJavascript(f.pageScript) { json -> + val result = json ?: "" + if (!f.pageReady(result) && left > 0) view.postDelayed({ readPage(view, f, left - 1) }, PAGE_RETRY_MS) + else Thread({ settle(f.finish(this, view, result)) }, "store-login").start() + } + } + private fun complete(view: WebView, url: String) { if (!captured.compareAndSet(false, true)) return val f = flow ?: return @@ -332,11 +345,7 @@ class StoreLoginActivity : ComponentActivity() { titleText.text = getString(R.string.stores_login_finishing) if (!f.readsPage) view.stopLoading() } - if (f.readsPage) { - view.evaluateJavascript("(function(){ try { return document.body.innerText; } catch(e){ return ''; } })()") { json -> - Thread({ settle(f.finish(this, view, json ?: "")) }, "store-login").start() - } - } else Thread({ settle(f.finish(this, view, url)) }, "store-login").start() + if (f.readsPage) readPage(view, f, PAGE_TRIES) else Thread({ settle(f.finish(this, view, url)) }, "store-login").start() } private fun settle(problem: String?) { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/StoreSizes.kt b/app/src/main/java/com/droiddeck/launcher/stores/StoreSizes.kt index 545c981e50..5e8ce7c6d7 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/StoreSizes.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/StoreSizes.kt @@ -55,7 +55,8 @@ object StoreSizes { Store.EPIC -> EpicPrefs.get(app).edit().putLong("size_${item.id}", it).apply() Store.AMAZON -> AmazonPrefs.get(app).edit().putLong("size_${item.id}", it).apply() Store.ITCH, Store.GAMEJOLT -> {} - Store.GOG, Store.XBOX, Store.BATTLENET -> {} + Store.EA -> com.droiddeck.launcher.stores.ea.EaPrefs.get(app).edit().putLong("size_${item.id}", it).apply() + Store.GOG, Store.XBOX, Store.BATTLENET, Store.UBISOFT -> {} } } }, pool).exceptionally { error -> @@ -111,7 +112,8 @@ object StoreSizes { val bytes = AmazonApiClient.getBytes(AmazonApiClient.appendPath(spec.downloadUrl, "manifest.proto"), token) ?: return 0L AmazonManifest.parse(bytes).totalInstallSize } - Store.GOG, Store.XBOX, Store.BATTLENET -> 0L + Store.EA -> com.droiddeck.launcher.stores.ea.EaSizes.size(context, item) + Store.GOG, Store.XBOX, Store.BATTLENET, Store.UBISOFT -> 0L Store.ITCH -> com.droiddeck.launcher.stores.itch.ItchLibrary.size(context, item) Store.GAMEJOLT -> com.droiddeck.launcher.stores.gamejolt.GameJoltBuilds.size(context, item) } } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/battlenet/BattleNetStore.kt b/app/src/main/java/com/droiddeck/launcher/stores/battlenet/BattleNetStore.kt index 737ba3b4ff..403b867538 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/battlenet/BattleNetStore.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/battlenet/BattleNetStore.kt @@ -204,7 +204,8 @@ object BattleNetBackend : StoreBackend { fun installedGames(context: Context): List = installed(context).map { game -> val art = BattleNet.art(context, game.title) val cover = art.cover?.let { Uri.fromFile(it).toString() } - InstalledStoreGame(StoreGameSidecar(store, game.title.uid, game.name, "", cover = cover, hero = art.header?.let { Uri.fromFile(it).toString() } ?: cover), game.folder) + InstalledStoreGame(StoreGameSidecar(store, game.title.uid, game.name, "", installedAt = game.folder.lastModified(), + cover = cover, hero = art.header?.let { Uri.fromFile(it).toString() } ?: cover), game.folder) } private fun shelves(context: Context): StoreShelves { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaApi.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaApi.kt new file mode 100644 index 0000000000..185e23f424 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaApi.kt @@ -0,0 +1,224 @@ +package com.droiddeck.launcher.stores.ea + +import android.net.Uri +import org.json.JSONArray +import org.json.JSONObject + +class EaApiException(val status: Int, message: String) : Exception(message) + +object EaApi { + private const val GRAPHQL = "https://service-aggregation-layer.juno.ea.com/graphql" + private const val LOCALE = "DEFAULT" + + class Player(val userId: String, val personaId: String, val displayName: String, val eaId: String) + + class OwnedProduct( + val offerId: String, + val productId: String, + val name: String, + val slug: String, + val baseSlug: String, + val gameType: String, + val downloadable: Boolean, + val trial: Boolean, + val ownership: List, + ) + + class Offer( + val offerId: String, + val contentId: String, + val displayName: String, + val displayType: String, + val downloadable: Boolean, + val executePathOverride: String, + val installCheckOverride: String, + val executeParameters: String, + val multiplayerId: String, + val masterTitleId: String, + val gameVersion: String, + val cloudSaves: String, + val locales: List, + ) + + class Images(val tall: String?, val wide: String?, val logo: String?) + + class Build(val buildId: String, val gameVersion: String, val liveDate: String) + + private val queries = HashMap() + + internal fun query(name: String): String = synchronized(queries) { + queries.getOrPut(name) { + val stream = EaApi::class.java.getResourceAsStream("/ea/graphql/$name.gql") ?: throw IllegalStateException("missing query $name") + stream.use { it.readBytes().toString(Charsets.UTF_8) } + } + } + + private fun persisted(name: String): String = + JSONObject().put("persistedQuery", JSONObject().put("version", 1).put("sha256Hash", EaCrypto.hex(EaCrypto.sha256(query(name).toByteArray())))).toString() + + internal fun call(token: String, name: String, variables: JSONObject): JSONObject { + val headers = mapOf("Authorization" to "Bearer $token", "Accept" to "application/json") + val get = Uri.parse(GRAPHQL).buildUpon() + .appendQueryParameter("extensions", persisted(name)) + .appendQueryParameter("operationName", name) + .appendQueryParameter("variables", variables.toString()) + .build().toString() + var reply = EaHttp.request(get, headers = headers) + var json = runCatching { JSONObject(reply.text) }.getOrNull() + if (!reply.ok || json == null || json.has("errors")) { + val body = JSONObject() + .put("extensions", JSONObject(persisted(name))) + .put("variables", variables) + .put("operationName", name) + .put("query", query(name)) + reply = EaHttp.request(GRAPHQL, "POST", headers + ("Content-Type" to "application/json"), body.toString().toByteArray()) + json = runCatching { JSONObject(reply.text) }.getOrNull() + } + if (reply.status == 401) throw EaApiException(401, "EA refused the session") + if (json == null) throw EaApiException(reply.status, "EA gave no answer to $name (${reply.status})") + json.optJSONArray("errors")?.optJSONObject(0)?.let { throw EaApiException(reply.status, "$name: ${it.optString("message")}") } + return json.optJSONObject("data") ?: throw EaApiException(reply.status, "$name returned no data") + } + + fun player(token: String): Player { + val me = call(token, "GetUserPlayer", JSONObject()).optJSONObject("me") ?: throw EaApiException(0, "no player") + val p = me.optJSONObject("player") + return Player( + userId = me.optString("pd"), + personaId = p?.optString("psd").orEmpty(), + displayName = p?.optString("displayName").orEmpty(), + eaId = p?.optString("uniqueName").orEmpty().ifEmpty { p?.optString("displayName").orEmpty() }, + ) + } + + internal fun parseOwned(page: JSONObject): Pair, String?> { + val owned = page.optJSONObject("me")?.optJSONObject("ownedGameProducts") ?: return emptyList() to null + val items = owned.optJSONArray("items") ?: JSONArray() + val list = (0 until items.length()).mapNotNull { items.optJSONObject(it) }.mapNotNull { o -> + val product = o.optJSONObject("product") ?: return@mapNotNull null + val base = product.optJSONObject("baseItem") + val user = product.optJSONObject("gameProductUser") + val methods = user?.optJSONArray("ownershipMethods") + OwnedProduct( + offerId = o.optString("originOfferId").ifEmpty { return@mapNotNull null }, + productId = product.optString("id"), + name = (base?.optString("title")?.takeIf { it.isNotBlank() } ?: product.optString("name")).replace("\n", " ").trim(), + slug = product.optString("gameSlug"), + baseSlug = base?.optString("baseGameSlug").orEmpty().takeIf { it != "null" }.orEmpty(), + gameType = base?.optString("gameType").orEmpty(), + downloadable = product.optBoolean("downloadable", true), + trial = product.optJSONObject("trialDetails")?.optString("trialType").orEmpty().let { it.isNotEmpty() && it != "null" }, + ownership = (0 until (methods?.length() ?: 0)).map { methods!!.optString(it) }, + ) + } + val next = owned.optString("next").takeIf { it.isNotBlank() && it != "null" } + return list to next + } + + fun owned(token: String): List { + val out = ArrayList() + var next: String? = "0" + var guard = 0 + while (next != null && guard++ < 50) { + val variables = JSONObject() + .put("isMac", false) + .put("limit", 100) + .put("next", next) + .put("type", JSONArray().put("DIGITAL_FULL_GAME").put("PACKAGED_FULL_GAME")) + .put("storefronts", JSONArray().put("EA")) + .put("platforms", JSONArray().put("PC")) + val (items, after) = parseOwned(call(token, "getPreloadedOwnedGames", variables)) + out += items + next = after?.takeIf { it != next && items.isNotEmpty() } + } + return out + } + + internal fun parseOffers(data: JSONObject): List { + val arr = data.optJSONArray("legacyOffers") ?: return emptyList() + return (0 until arr.length()).mapNotNull { arr.optJSONObject(it) }.mapNotNull { o -> + val downloads = o.optJSONArray("downloads") + val version = (0 until (downloads?.length() ?: 0)).mapNotNull { downloads!!.optJSONObject(it) } + .firstOrNull { it.optString("downloadType").equals("LIVE", true) }?.optString("gameVersion") + ?: downloads?.optJSONObject(0)?.optString("gameVersion") + val locales = o.optJSONArray("softwareLocales") + fun s(k: String) = o.optString(k).takeIf { it != "null" }.orEmpty() + Offer( + offerId = s("offerId").ifEmpty { return@mapNotNull null }, + contentId = s("contentId"), + displayName = s("displayName"), + displayType = s("displayType"), + downloadable = o.optBoolean("isDownloadable", true), + executePathOverride = s("executePathOverride"), + installCheckOverride = s("installCheckOverride"), + executeParameters = s("executeParameters"), + multiplayerId = s("multiplayerId"), + masterTitleId = s("primaryMasterTitleId"), + gameVersion = version.orEmpty().takeIf { it != "null" }.orEmpty(), + cloudSaves = s("cloudSaveConfigurationOverride"), + locales = (0 until (locales?.length() ?: 0)).map { locales!!.optString(it) }, + ) + } + } + + fun offers(token: String, ids: List): List = ids.distinct().chunked(50).flatMap { chunk -> + parseOffers(call(token, "getLegacyCatalogDefs", JSONObject().put("offerIds", JSONArray(chunk)))) + } + + private fun path(o: JSONObject?, vararg keys: String): String? { + var cur = o ?: return null + for (k in keys.dropLast(1)) cur = cur.optJSONObject(k) ?: return null + return cur.optString(keys.last()).takeIf { it.startsWith("http") } + } + + internal fun parseImages(data: JSONObject): Images { + val game = data.optJSONObject("game") + val key = game?.optJSONObject("keyArt") + val pack = game?.optJSONObject("packArt") + return Images( + tall = path(pack, "aspect9x16Image", "path") ?: path(key, "aspect9x16Image", "path"), + wide = path(key, "aspect16x9Image", "path") ?: path(key, "largestImage", "path") ?: path(pack, "aspect2x1Image", "path"), + logo = path(game, "primaryLogo", "largestImage", "path") ?: path(game, "primaryLogo", "path"), + ) + } + + fun images(token: String, slug: String): Images = + parseImages(call(token, "GameImages", JSONObject().put("gameSlug", slug).put("locale", LOCALE))) + + fun downloadUrl(token: String, offerId: String, buildId: String? = null): String { + val data = call(token, "downloadUrl", JSONObject().put("offerId", offerId).put("buildId", buildId.orEmpty())) + return data.optJSONObject("downloadUrl")?.optString("url").orEmpty().ifEmpty { throw EaApiException(0, "EA gave no download link") } + } + + fun builds(token: String, offerId: String): List { + val arr = call(token, "availableBuilds", JSONObject().put("offerId", offerId)).optJSONArray("availableBuilds") ?: return emptyList() + return (0 until arr.length()).mapNotNull { arr.optJSONObject(it) }.map { + Build(it.optString("buildId"), it.optString("gameVersion").takeIf { v -> v != "null" }.orEmpty(), it.optString("buildLiveDate")) + } + } + + fun legacyEntitlements(token: String): List { + val out = ArrayList() + var next: String? = "0" + var guard = 0 + while (next != null && guard++ < 50) { + val variables = JSONObject().put("limit", 100).put("next", next).put("storeFronts", JSONArray().put("EA")) + val page = call(token, "getLegacyEntitlements", variables).optJSONObject("me")?.optJSONObject("legacyEntitlements") ?: break + val items = page.optJSONArray("items") ?: JSONArray() + for (i in 0 until items.length()) items.optJSONObject(i)?.let(out::add) + next = page.optString("next").takeIf { it.isNotBlank() && it != "null" && it != next && items.length() > 0 } + } + return out + } + + fun entitlements(token: String, group: String): JSONArray { + val variables = JSONObject() + .put("productIds", JSONArray()) + .put("includeChildGroups", false) + .put("groupNames", JSONArray().put(group)) + .put("entitlementTag", "") + .put("pageSize", 100) + .put("pageNumber", 1) + return call(token, "sdkEntitlements", variables).optJSONObject("me")?.optJSONObject("sdkEntitlements")?.optJSONArray("entitlements") ?: JSONArray() + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaAuth.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaAuth.kt new file mode 100644 index 0000000000..67fb8e655e --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaAuth.kt @@ -0,0 +1,230 @@ +package com.droiddeck.launcher.stores.ea + +import android.content.Context +import android.net.Uri +import android.util.Log +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreAccounts +import org.json.JSONObject +import java.security.SecureRandom +import java.text.SimpleDateFormat +import java.util.Date +import java.util.Locale +import java.util.TimeZone + +object EaAuth { + private const val TAG = "EaAuth" + const val CLIENT_ID = "JUNO_PC_CLIENT" + private const val CLIENT_SECRET = "4mRLtYMb6vq9qglomWEaT4ChxsXWcyqbQpuBNfMPOYOiDmYYQmjuaBsF2Zp0RyVeWkfqhE9TuGgAw7te" + const val AUTH_URL = "https://accounts.ea.com/connect/auth" + private const val TOKEN_URL = "https://accounts.ea.com/connect/token" + const val REDIRECT = "qrc:///html/login_successful.html" + private const val REFRESH_MARGIN_MS = 5 * 60 * 1000L + private val refreshLock = Any() + private val random = SecureRandom() + + private val PC_SIGN_KEYS = mapOf( + "v1" to "ISa3dpGOc8wW7Adn4auACSQmaccrOyR2".toByteArray(), + "v2" to "nt5FfJbdPzNcl2pkC3zgjO43Knvscxft".toByteArray(), + ) + + val OPAQUE_SCOPES = listOf( + "basic.commerce.cartv2", "service.atom", "dp.client.default", "signin", "social_recommendation_user", + "basic.optin.write", "basic.commerce.cartv2.write", "basic.billing", "external.social_information_ups_admin", + ) + + class Account( + val accessToken: String, + val refreshToken: String, + val expiresAt: Long, + val userId: String, + val personaId: String, + val displayName: String, + val eaId: String, + ) + + class Pending(val url: String, val verifier: String) + + internal fun fromJson(o: JSONObject): Account? { + val access = o.optString("access_token").ifEmpty { return null } + return Account( + accessToken = access, + refreshToken = o.optString("refresh_token"), + expiresAt = o.optLong("expires_at"), + userId = o.optString("user_id"), + personaId = o.optString("persona_id"), + displayName = o.optString("display_name"), + eaId = o.optString("ea_id"), + ) + } + + fun load(context: Context): Account? = StoreAccounts.read(context.applicationContext, Store.EA)?.let(::fromJson) + + private fun deviceId(context: Context): String { + val prefs = EaPrefs.get(context) + prefs.getString("device", null)?.let { return it } + val made = EaCrypto.hex(ByteArray(16).also(random::nextBytes)) + prefs.edit().putString("device", made).apply() + return made + } + + internal fun pcSign(device: String, now: Date = Date(), version: String = if (random.nextBoolean()) "v1" else "v2"): String { + val stamp = SimpleDateFormat("yyyy-MM-dd HH:mm:ss:SSS", Locale.US).apply { timeZone = TimeZone.getTimeZone("UTC") }.format(now) + val mid = EaCrypto.fnv1a(("DroidDeck" + device.uppercase() + "DroidDeck").toByteArray()).toString() + val json = "{\"av\":\"v1\",\"bsn\":\"None\",\"gid\":0,\"hsn\":\"None\",\"mid\":\"$mid\",\"msn\":\"${device.uppercase()}\",\"sv\":\"$version\",\"ts\":\"$stamp\"}" + val payload = EaCrypto.base64Url(json.toByteArray()) + val signature = EaCrypto.base64Url(EaCrypto.hmacSha256(PC_SIGN_KEYS.getValue(version), payload.toByteArray())) + return "$payload.$signature" + } + + internal fun authUrl( + device: String, + responseType: String, + challenge: String? = null, + accessToken: String? = null, + clientId: String = CLIENT_ID, + scopes: List = emptyList(), + tokenFormat: String? = null, + expiresIn: Int? = null, + ): String { + val b = Uri.parse(AUTH_URL).buildUpon() + .appendQueryParameter("client_id", clientId) + .appendQueryParameter("sbiod_enabled", "false") + .appendQueryParameter("response_type", responseType) + .appendQueryParameter("locale", "en_US") + .appendQueryParameter("pc_sign", pcSign(device)) + .appendQueryParameter("nonce", random.nextInt().toString()) + if (scopes.isNotEmpty()) b.appendQueryParameter("scope", scopes.joinToString(" ")) + if (challenge != null) { + b.appendQueryParameter("code_challenge_method", "S256") + b.appendQueryParameter("code_challenge", challenge) + } + if (accessToken != null) b.appendQueryParameter("access_token", accessToken) + if (tokenFormat != null) b.appendQueryParameter("token_format", tokenFormat) + if (expiresIn != null) b.appendQueryParameter("expires_in", expiresIn.toString()) + return b.build().toString() + } + + fun begin(context: Context): Pending { + val verifier = EaCrypto.base64Url(ByteArray(32).also(random::nextBytes)) + val challenge = EaCrypto.base64Url(EaCrypto.sha256(verifier.toByteArray())) + return Pending(authUrl(deviceId(context), "code", challenge = challenge), verifier) + } + + /** Pulls one parameter out of the redirect EA sends to its desktop client's local page. */ + internal fun redirectValue(location: String, name: String): String? { + val normal = location.replace("qrc:///html", "http://127.0.0.1").replace("qrc:/html", "http://127.0.0.1") + val uri = Uri.parse(normal) + uri.getQueryParameter(name)?.let { return it } + val fragment = uri.encodedFragment ?: return null + return Uri.parse("http://x/?$fragment").getQueryParameter(name) + } + + private fun tokenCall(values: List>): JSONObject { + val reply = EaHttp.request( + TOKEN_URL, "POST", + mapOf("Content-Type" to "application/x-www-form-urlencoded"), + EaHttp.form(values + listOf("client_id" to CLIENT_ID, "client_secret" to CLIENT_SECRET)).toByteArray(), + follow = false, + ) + val json = runCatching { JSONObject(reply.text) }.getOrNull() + if (!reply.ok || json == null || json.optString("access_token").isEmpty()) { + throw IllegalStateException("EA token request failed (${reply.status}): ${json?.optString("error_description")?.ifEmpty { json.optString("error") } ?: ""}") + } + return json + } + + fun exchange(context: Context, code: String, verifier: String) { + val token = tokenCall( + listOf( + "grant_type" to "authorization_code", "code" to code, "code_verifier" to verifier, + "redirect_uri" to REDIRECT, "token_format" to "JWS", + ), + ) + val access = token.getString("access_token") + val player = runCatching { EaApi.player(access) }.onFailure { Log.w(TAG, "player: ${it.message}") }.getOrNull() + val record = JSONObject() + .put("access_token", access) + .put("refresh_token", token.optString("refresh_token")) + .put("expires_at", System.currentTimeMillis() + token.optLong("expires_in", 3600) * 1000) + .put("user_id", player?.userId.orEmpty()) + .put("persona_id", player?.personaId.orEmpty()) + .put("display_name", player?.displayName.orEmpty()) + .put("ea_id", player?.eaId.orEmpty()) + StoreAccounts.write(context.applicationContext, Store.EA, record) + } + + private fun fresh(a: Account) = a.expiresAt - System.currentTimeMillis() > REFRESH_MARGIN_MS || a.refreshToken.isEmpty() + + private fun refreshLocked(context: Context, a: Account): String? { + if (a.refreshToken.isEmpty()) return null + val token = try { + tokenCall(listOf("grant_type" to "refresh_token", "refresh_token" to a.refreshToken)) + } catch (e: Exception) { + Log.w(TAG, "refresh: ${e.message}") + return null + } + val access = token.getString("access_token") + val player = if (load(context)?.userId.isNullOrEmpty()) runCatching { EaApi.player(access) }.getOrNull() else null + return access.takeIf { storeRefreshed(context, access, token.optLong("expires_in", 3600), token.optString("refresh_token"), player) } + } + + /** Writes a refreshed token into the saved sign-in, unless sign-out removed it meanwhile. */ + internal fun storeRefreshed(context: Context, access: String, expiresIn: Long, refresh: String, player: EaApi.Player? = null): Boolean = + synchronized(refreshLock) { + val app = context.applicationContext + val record = StoreAccounts.read(app, Store.EA) ?: return false + record.put("access_token", access).put("expires_at", System.currentTimeMillis() + expiresIn * 1000) + refresh.takeIf { it.isNotEmpty() }?.let { record.put("refresh_token", it) } + player?.let { record.put("user_id", it.userId).put("persona_id", it.personaId).put("display_name", it.displayName).put("ea_id", it.eaId) } + StoreAccounts.write(app, Store.EA, record) + true + } + + fun accessToken(context: Context): String? { + val current = load(context) ?: return null + if (fresh(current)) return current.accessToken + synchronized(refreshLock) { + val again = load(context) ?: return null + if (fresh(again)) return again.accessToken + return refreshLocked(context, again) ?: again.accessToken.takeIf { again.expiresAt > System.currentTimeMillis() } + } + } + + fun refreshNow(context: Context, stale: String?): String? = synchronized(refreshLock) { + val current = load(context) ?: return null + if (stale != null && current.accessToken != stale) return current.accessToken + refreshLocked(context, current) + } + + /** Asks EA to mint a code or token for another client from the signed-in session, as the EA app does for games. */ + fun mint( + context: Context, + clientId: String, + responseType: String, + scopes: List = emptyList(), + tokenFormat: String? = null, + expiresIn: Int? = null, + ): String? { + val access = accessToken(context) ?: return null + val url = authUrl(deviceId(context), responseType, accessToken = access, clientId = clientId, scopes = scopes, tokenFormat = tokenFormat, expiresIn = expiresIn) + val reply = runCatching { EaHttp.request(url, follow = false) }.getOrElse { + Log.w(TAG, "mint $clientId: ${it.javaClass.simpleName}") + return null + } + val location = reply.header("Location") ?: run { + Log.w(TAG, "mint $clientId: no redirect (${reply.status})") + return null + } + if (location.startsWith("https://signin.ea.com")) { + Log.w(TAG, "mint $clientId: the session needs a new sign-in") + return null + } + return redirectValue(location, if (responseType == "token") "access_token" else responseType) + } + + /** Waits for any refresh in progress, so it cannot write the sign-in back afterwards. */ + fun signOut(context: Context) { + synchronized(refreshLock) { StoreAccounts.clear(context.applicationContext, Store.EA) } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaBackend.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaBackend.kt new file mode 100644 index 0000000000..091243ae53 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaBackend.kt @@ -0,0 +1,131 @@ +package com.droiddeck.launcher.stores.ea + +import android.content.Context +import android.content.Intent +import android.util.Log +import android.webkit.WebView +import androidx.compose.runtime.mutableStateMapOf +import com.droiddeck.launcher.R +import com.droiddeck.launcher.stores.CatalogItem +import com.droiddeck.launcher.stores.InstalledStoreGame +import com.droiddeck.launcher.stores.LoginFlows +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreBackend +import com.droiddeck.launcher.stores.StoreInstallRoot +import com.droiddeck.launcher.stores.StoreLoginActivity +import com.droiddeck.launcher.stores.StoresState +import com.droiddeck.launcher.stores.WebCookies +import com.droiddeck.launcher.stores.download.DownloadEntry +import com.droiddeck.launcher.stores.download.DownloadQueue + +object EaBackend : StoreBackend { + override val store: Store = Store.EA + + @Volatile internal var app: Context? = null + + init { + LoginFlows.eaFlow = { ua -> app?.let { EaLogin(EaAuth.begin(it), ua) } } + } + + override fun signIn(context: Context) { + app = context.applicationContext + context.startActivity( + Intent(context, StoreLoginActivity::class.java) + .putExtra(StoreLoginActivity.EXTRA_STORE, store.id) + .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK), + ) + } + + override fun signOut(context: Context) { + val app = context.applicationContext + EaAuth.signOut(app) + EaLibrary.reset(app) + EaUpdates.available.clear() + runCatching { WebCookies.expire(EaLogin.SIGN_IN_URLS, ".ea.com", listOf("/")) {} } + } + + override fun syncLibrary(context: Context, force: Boolean) { + val app = context.applicationContext + this.app = app + Thread({ EaLibrary.sync(app, force) }, "ea-sync").start() + } + + override fun loadShelves(context: Context, force: Boolean) {} + + override fun install(context: Context, item: CatalogItem, root: java.io.File) { + val app = context.applicationContext + if (!EaNative.ready()) { + StoresState.logLine(EaNative.ENGINE_MISSING) + StoresState.post { StoresState.problems[store] = EaNative.ENGINE_MISSING } + return + } + val folder = StoreInstallRoot.folderFor(app, store, item.id, item.title, root) + val entry = DownloadEntry(store, item.id, item.title, cover = item.tallImageUrl ?: item.imageUrl, bytesTotal = item.sizeBytes, location = StoreInstallRoot.labelFor(app, folder)) + DownloadQueue.enqueue(app, entry) { EaInstaller(app, item, folder) } + } + + override fun uninstall(context: Context, game: InstalledStoreGame) {} +} + +internal class EaLogin(private val pending: EaAuth.Pending, override val userAgent: String) : StoreLoginActivity.Flow { + override val startUrl: String get() = pending.url + + override fun isRedirect(url: String): Boolean = url.startsWith("qrc:", ignoreCase = true) + + override fun forgetSignIn(done: () -> Unit) { + runCatching { WebCookies.expire(SIGN_IN_URLS, ".ea.com", listOf("/")) { done() } }.onFailure { done() } + } + + override fun finish(activity: StoreLoginActivity, view: WebView, url: String): String? { + val code = EaAuth.redirectValue(url, "code") ?: return activity.getString(R.string.stores_login_error_verification) + return try { + EaAuth.exchange(activity, code, pending.verifier) + null + } catch (e: Exception) { + Log.w("EaLogin", "sign-in failed: ${e.message}") + activity.getString(R.string.stores_login_error_generic) + } + } + + companion object { + val SIGN_IN_URLS = listOf("https://accounts.ea.com", "https://signin.ea.com", "https://www.ea.com") + } +} + +object EaUpdates { + val available = mutableStateMapOf() + private val checked = java.util.concurrent.ConcurrentHashMap() + private const val RECHECK_MS = 30 * 60 * 1000L + + fun check(context: Context, game: InstalledStoreGame, force: Boolean = false) { + val app = context.applicationContext + val id = game.sidecar.id + val now = System.currentTimeMillis() + if (!force && now - (checked[id] ?: 0L) < RECHECK_MS) return + checked[id] = now + Thread({ + val token = EaAuth.accessToken(app) + val offer = token?.let { runCatching { EaApi.offers(it, listOf(id)) }.getOrNull() }?.firstOrNull() + if (offer == null) { + checked.remove(id) + return@Thread + } + val live = offer.gameVersion + val installed = game.sidecar.installVersion + StoresState.post { + if (live.isNotEmpty() && installed.isNotEmpty() && live != installed) available[game.key] = live else available.remove(game.key) + } + }, "ea-update-check").start() + } + + fun start(context: Context, game: InstalledStoreGame) { + val app = context.applicationContext + val root = game.folder.parentFile?.parentFile ?: return + val known = EaLibrary.game(app, game.sidecar.id) + val item = known?.let { EaLibrary.toCatalogItem(app, it) } ?: CatalogItem( + Store.EA, game.sidecar.id, game.sidecar.title, game.sidecar.hero, tallImageUrl = game.sidecar.cover, owned = true, extra = game.sidecar.extra, + ) + available.remove(game.key) + StoresState.install(app, item, root) + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaCrypto.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaCrypto.kt new file mode 100644 index 0000000000..d36a541085 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaCrypto.kt @@ -0,0 +1,83 @@ +package com.droiddeck.launcher.stores.ea + +import java.security.MessageDigest +import java.time.LocalDate +import java.time.ZoneOffset +import javax.crypto.Cipher +import javax.crypto.Mac +import javax.crypto.spec.IvParameterSpec +import javax.crypto.spec.SecretKeySpec + +internal object EaCrypto { + val LSX_DEFAULT_KEY = ByteArray(16) { it.toByte() } + + private val OOA_KEY = intArrayOf(65, 50, 114, 45, 208, 130, 239, 176, 220, 100, 87, 197, 118, 104, 202, 9) + .map { it.toByte() }.toByteArray() + + private const val PRIME_10K = 104729L + private const val PRIME_20K = 224737L + private const val PRIME_30K = 350377L + + fun ecbEncrypt(data: ByteArray, key: ByteArray): ByteArray = + Cipher.getInstance("AES/ECB/PKCS5Padding").run { init(Cipher.ENCRYPT_MODE, SecretKeySpec(key, "AES")); doFinal(data) } + + fun ecbDecrypt(data: ByteArray, key: ByteArray): ByteArray = + Cipher.getInstance("AES/ECB/PKCS5Padding").run { init(Cipher.DECRYPT_MODE, SecretKeySpec(key, "AES")); doFinal(data) } + + fun licenseEncrypt(data: ByteArray): ByteArray = + Cipher.getInstance("AES/CBC/PKCS5Padding").run { init(Cipher.ENCRYPT_MODE, SecretKeySpec(OOA_KEY, "AES"), IvParameterSpec(ByteArray(16))); doFinal(data) } + + fun licenseDecrypt(data: ByteArray): ByteArray = + Cipher.getInstance("AES/CBC/PKCS5Padding").run { init(Cipher.DECRYPT_MODE, SecretKeySpec(OOA_KEY, "AES"), IvParameterSpec(ByteArray(16))); doFinal(data) } + + fun hex(bytes: ByteArray): String = bytes.joinToString("") { "%02x".format(it.toInt() and 0xFF) } + + fun unhex(text: String): ByteArray { + val digits = text.lowercase().filter { it in '0'..'9' || it in 'a'..'f' } + if (digits.length % 2 != 0) return ByteArray(0) + return ByteArray(digits.length / 2) { i -> digits.substring(i * 2, i * 2 + 2).toInt(16).toByte() } + } + + /** The session key both sides derive after the LSX challenge, from a seed the game picks. */ + fun lsxKey(seed: Int): ByteArray { + if (seed == 0) return LSX_DEFAULT_KEY.copyOf() + var state = 7L + fun next(): Int { + state = (state * 214013L + 2531011L) and 0xFFFFFFFFL + return ((state ushr 16) and 0xFFFF).toInt() + } + val start = (next().toLong() + seed) and 0xFFFFFFFFL + state = start + return ByteArray(16) { next().toByte() } + } + + fun challengeAnswer(key: String): String = hex(ecbEncrypt(key.toByteArray(Charsets.US_ASCII), LSX_DEFAULT_KEY)) + + fun challengeSeed(version: String, answer: String): Int? = when (version) { + "2" -> 0 + "3" -> (answer[0].code shl 8) or answer[1].code + else -> null + } + + /** EA's launch handshake code, which changes every UTC day. */ + fun rtpCode(day: LocalDate = LocalDate.now(ZoneOffset.UTC)): Long { + val time = ((PRIME_10K * day.year) xor (day.monthValue * PRIME_20K) xor (day.dayOfMonth * PRIME_30K)) and 0xFFFFFFFFL + return (time xor ((time shl 16) and 0xFFFFFFFFL) xor (time ushr 16)) and 0xFFFFFFFFL + } + + fun sha256(data: ByteArray): ByteArray = MessageDigest.getInstance("SHA-256").digest(data) + + fun sha1(data: ByteArray): ByteArray = MessageDigest.getInstance("SHA-1").digest(data) + + fun hmacSha256(key: ByteArray, data: ByteArray): ByteArray = + Mac.getInstance("HmacSHA256").run { init(SecretKeySpec(key, "HmacSHA256")); doFinal(data) } + + fun fnv1a(data: ByteArray): ULong { + var hash = 0xcbf29ce484222325UL + for (b in data) hash = (hash xor (b.toUByte().toULong())) * 0x100000001b3UL + return hash + } + + fun base64Url(data: ByteArray): String = + java.util.Base64.getUrlEncoder().withoutPadding().encodeToString(data) +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaHttp.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaHttp.kt new file mode 100644 index 0000000000..193c4d741c --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaHttp.kt @@ -0,0 +1,47 @@ +package com.droiddeck.launcher.stores.ea + +import java.net.HttpURLConnection +import java.net.URL +import java.net.URLEncoder + +internal class EaReply(val status: Int, val body: ByteArray, val headers: Map>) { + val ok: Boolean get() = status in 200..299 + val text: String get() = body.toString(Charsets.UTF_8) + fun header(name: String): String? = headers.entries.firstOrNull { it.key.equals(name, ignoreCase = true) }?.value?.firstOrNull() +} + +internal object EaHttp { + const val USER_AGENT = "Mozilla/5.0 EA Desktop/13.735.2.6250" + private const val TIMEOUT = 30_000 + + fun form(values: List>): String = + values.joinToString("&") { (k, v) -> URLEncoder.encode(k, "UTF-8") + "=" + URLEncoder.encode(v, "UTF-8") } + + fun request( + url: String, + method: String = "GET", + headers: Map = emptyMap(), + body: ByteArray? = null, + follow: Boolean = true, + ): EaReply { + val c = URL(url).openConnection() as HttpURLConnection + try { + c.requestMethod = method + c.connectTimeout = TIMEOUT + c.readTimeout = TIMEOUT + c.instanceFollowRedirects = follow + c.setRequestProperty("User-Agent", USER_AGENT) + for ((k, v) in headers) c.setRequestProperty(k, v) + if (body != null) { + c.doOutput = true + c.outputStream.use { it.write(body) } + } + val status = c.responseCode + val stream = if (status >= 400) c.errorStream else c.inputStream + val bytes = stream?.use { it.readBytes() } ?: ByteArray(0) + return EaReply(status, bytes, c.headerFields.filterKeys { it != null }) + } finally { + c.disconnect() + } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaInstaller.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaInstaller.kt new file mode 100644 index 0000000000..22d973592d --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaInstaller.kt @@ -0,0 +1,140 @@ +package com.droiddeck.launcher.stores.ea + +import android.content.Context +import com.droiddeck.launcher.R +import com.droiddeck.launcher.stores.CatalogItem +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreExe +import com.droiddeck.launcher.stores.StoreGameSidecar +import com.droiddeck.launcher.stores.StoreInstalls +import com.droiddeck.launcher.stores.StoreLanguage +import com.droiddeck.launcher.stores.amazon.AmazonNative +import com.droiddeck.launcher.stores.download.DownloadQueue +import com.droiddeck.launcher.stores.download.DownloadStage +import com.droiddeck.launcher.stores.download.StoreDownloadTier +import org.json.JSONArray +import org.json.JSONObject +import java.io.File +import java.util.concurrent.atomic.AtomicBoolean +import java.util.concurrent.atomic.AtomicLong + +internal class EaInstaller( + private val app: Context, + private val item: CatalogItem, + private val folder: File, +) : DownloadQueue.DownloadJob { + private val cancelled = AtomicBoolean(false) + + override fun run(handle: DownloadQueue.JobHandle): String? { + handle.stage(DownloadStage.MANIFEST, app.getString(R.string.stores_sync_sign_in)) + var token = EaAuth.accessToken(app) ?: throw IllegalStateException("Not signed in to EA") + val url = try { + EaApi.downloadUrl(token, item.id) + } catch (e: EaApiException) { + if (e.status != 401) throw IllegalStateException(e.message) + token = EaAuth.refreshNow(app, token) ?: throw IllegalStateException("The EA sign-in has expired") + EaApi.downloadUrl(token, item.id) + } + val game = EaLibrary.game(app, item.id) + val version = runCatching { EaApi.offers(token, listOf(item.id)).firstOrNull()?.gameVersion }.getOrNull().orEmpty() + .ifEmpty { game?.version.orEmpty() } + val cover = item.tallImageUrl ?: item.imageUrl + StoreInstalls.begin(folder, Store.EA, item.id, item.title, cover, item.imageUrl) + if (cancelled.get()) return null + + val tier = StoreDownloadTier.current(app) + handle.log("ea: \"${item.title}\" tier=${tier.id} window=${tier.networkWindow}") + val request = JSONObject() + .put("url", url) + .put("gameDir", folder.absolutePath) + .put("maxWorkers", tier.networkWindow.coerceIn(1, 64)) + .put("processWorkers", tier.processWorkers) + .put("caBundle", "") + val shown = AtomicLong(-1) + val downloading = AtomicBoolean(false) + val listener = object : AmazonNative.InstallListener { + override fun onStatus(text: String) { handle.stage(DownloadStage.MANIFEST, text) } + override fun onCheck(doneBytes: Long, totalBytes: Long, files: Int, filesTotal: Int) { + handle.stage(DownloadStage.MANIFEST, "Checking files…") + handle.stageProgress(doneBytes, totalBytes, files, filesTotal, bytes = true) + } + override fun onSizes(pendingBytes: Long, totalBytes: Long) { handle.diskSize(totalBytes) } + override fun onProgress(done: Long, total: Long, files: Int, filesTotal: Int) { + if (downloading.compareAndSet(false, true)) handle.stage(DownloadStage.DOWNLOAD) + while (true) { + val before = shown.get() + if (done < before) return + if (shown.compareAndSet(before, done)) break + } + handle.progress(done, total, "Downloading ($files/$filesTotal files)") + } + override fun onLog(line: String) { handle.log("ea: $line") } + override fun beforeReplace(): Boolean = try { + StoreInstalls.markUpdating(folder) + true + } catch (e: Exception) { + handle.log("ea: the install record could not be switched to updating (${e.javaClass.simpleName})") + false + } + override fun onComplete(success: Boolean, cancelled: Boolean, error: String, result: String) = Unit + } + val outcome = EaNative.install(request, listener, cancelled) + if (outcome.cancelled || cancelled.get() && !outcome.success) return null + if (!outcome.success) throw IllegalStateException(outcome.error.ifEmpty { "The EA install failed" }) + val result = outcome.result ?: JSONObject() + result.optLong("totalBytes").takeIf { it > 0 }?.let { EaPrefs.get(app).edit().putLong("size_${item.id}", it).apply() } + + handle.stage(DownloadStage.INSTALL, app.getString(R.string.stores_registering)) + val sidecar = sidecarFor(app, item, folder, game, version, cover) { handle.log("ea: $it") } + StoreInstalls.complete(app, folder, sidecar, onStep = { done, steps -> handle.stageProgress(done.toLong(), steps.toLong()) }) + return folder.path + } + + override fun cancel(deleteFiles: Boolean) { + cancelled.set(true) + if (deleteFiles) StoreInstalls.discard(app, folder, emptyList()) + } + + companion object { + fun locale(context: Context, available: List): String { + val wanted = StoreLanguage.localeFor(null, context) + val exact = "${wanted.language}_${wanted.country}" + return available.firstOrNull { it.equals(exact, true) } + ?: available.firstOrNull { it.substringBefore('_').equals(wanted.language, true) } + ?: available.firstOrNull { it.equals("en_US", true) } + ?: "en_US" + } + + internal fun sidecarFor(app: Context, item: CatalogItem, folder: File, game: EaGame?, version: String, cover: String?, log: (String) -> Unit): StoreGameSidecar { + val manifest = EaManifest.read(folder) + if (manifest == null) log("no installerdata.xml in ${folder.name}") + val launcher = manifest?.launcher() + val candidates = listOfNotNull(launcher?.path, game?.executePath?.takeIf { it.isNotEmpty() }) + var exe = candidates.firstNotNullOfOrNull { EaPaths.relativeOnDisk(folder, EaPaths.relative(it)) }.orEmpty() + if (exe.isEmpty()) exe = StoreExe.pick(folder, null, item.title) + if (exe.isEmpty()) { log("no exe found; pick one in Steam settings › Added games"); exe = "game.exe" } else log("exe=$exe") + val args = EaPaths.splitArgs(listOf(game?.parameters.orEmpty(), launcher?.parameters.orEmpty()).filter { it.isNotBlank() }.joinToString(" ")) + val keys = JSONArray() + listOfNotNull(game?.installCheck, game?.executePath, launcher?.path).mapNotNull { EaPaths.registered(it) } + .distinctBy { it.key.lowercase() + "|" + it.value.lowercase() } + .forEach { keys.put(JSONArray().put(it.key).put(it.value)) } + val extra = linkedMapOf( + "contentId" to (game?.contentId ?: item.extra["contentId"].orEmpty()), + "slug" to (game?.slug ?: item.extra["slug"].orEmpty()), + "multiplayerId" to game?.multiplayerId.orEmpty(), + "masterTitleId" to game?.masterTitleId.orEmpty(), + "locale" to locale(app, game?.locales.orEmpty()), + "registry" to keys.toString(), + "touchup" to manifest?.touchupPath.orEmpty().replace('\\', '/').trimStart('/'), + "touchupArgs" to manifest?.touchupParameters.orEmpty(), + "contentIds" to manifest?.contentIds.orEmpty().joinToString(","), + "displayName" to manifest?.title(locale(app, game?.locales.orEmpty())).orEmpty(), + ).filterValues { it.isNotEmpty() } + return StoreGameSidecar( + Store.EA, item.id, item.title, exe = exe, args = args, + installVersion = version.ifEmpty { manifest?.version.orEmpty() }, installedAt = System.currentTimeMillis(), + cover = cover, hero = item.imageUrl, extra = extra, cloud = false, logo = item.logoUrl, + ) + } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLaunch.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLaunch.kt new file mode 100644 index 0000000000..a9b623a2d6 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLaunch.kt @@ -0,0 +1,138 @@ +package com.droiddeck.launcher.stores.ea + +import android.content.Context +import android.util.Base64 +import android.util.Log +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreGameSidecar +import com.droiddeck.launcher.stores.StoreInstallRoot +import org.json.JSONArray +import org.json.JSONObject +import java.io.File +import java.util.UUID + +object EaLaunch { + private const val TAG = "EaLaunch" + const val ENV_FILE = ".droiddeck-ea-env" + + private fun installed(context: Context, id: String): Pair? = + StoreInstallRoot.gameFolders(context).firstNotNullOfOrNull { f -> + StoreGameSidecar.read(f)?.takeIf { it.store == Store.EA && it.id == id && it.isInstalled }?.let { f to it } + } + + internal fun environment( + offerId: String, + contentId: String, + locale: String, + generic: String, + access: String, + opaque: String, + account: EaAuth.Account, + session: String = UUID.randomUUID().toString(), + ): LinkedHashMap = linkedMapOf( + "EAAuthCode" to "unavailable", + "EAEgsProxyIpcPort" to "0", + "EAEntitlementSource" to "EA", + "EAExternalSource" to "EA", + "EAFreeTrialGame" to "false", + "EAGameLocale" to locale, + "EAGenericAuthToken" to generic, + "EALaunchCode" to "unavailable", + "EALaunchOwner" to "EA", + "EALaunchEAID" to account.eaId.ifEmpty { account.displayName }, + "EALaunchEnv" to "production", + "EALaunchOfflineMode" to "false", + "EALsxPort" to EaLsx.PORT.toString(), + "EARtPLaunchCode" to EaCrypto.rtpCode().toString(), + "EASecureLaunchTokenTemp" to account.userId, + "EASteamProxyIpcPort" to "0", + "OriginSessionKey" to session, + "ContentId" to contentId, + "EAOnErrorExitRetCode" to "1", + "EAConnectionId" to offerId, + "EALicenseToken" to offerId, + "EALaunchUserAuthToken" to opaque, + "EAAccessTokenJWS" to access, + ) + + /** Adds what installs made before the manifest's content ids and title were recorded are missing. */ + internal fun backfill(folder: File, sidecar: StoreGameSidecar): StoreGameSidecar { + if (sidecar.extra.containsKey("contentIds") || sidecar.extra.containsKey("displayName")) return sidecar + val manifest = EaManifest.read(folder) ?: return sidecar + val locale = sidecar.extra["locale"].orEmpty().ifEmpty { "en_US" } + val added = mapOf( + "contentIds" to manifest.contentIds.joinToString(","), + "displayName" to manifest.title(locale).orEmpty(), + ).filterValues { it.isNotEmpty() } + if (added.isEmpty()) return sidecar + val updated = sidecar.copy(extra = sidecar.extra + added) + runCatching { updated.write(folder) }.onFailure { Log.w(TAG, "sidecar: ${it.javaClass.simpleName}") } + return updated + } + + /** Answers the guest's request right before an EA game starts: session, licence and the LSX endpoint. */ + fun prepare(context: Context, request: JSONObject): JSONObject { + val app = context.applicationContext + val id = request.optString("id") + val reply = JSONObject().put("ok", false) + val (folder, recorded) = installed(app, id) ?: return reply.put("reason", "not-installed") + val sidecar = backfill(folder, recorded) + runCatching { com.droiddeck.launcher.stores.StoreLaunch.refreshLauncher(folder, sidecar) } + File(folder, ENV_FILE).delete() + val account = EaAuth.load(app) ?: return reply.put("reason", "signed-out") + val access = EaAuth.accessToken(app) ?: return reply.put("reason", "sign-in-expired") + val contentId = sidecar.extra["contentId"].orEmpty() + val locale = sidecar.extra["locale"].orEmpty().ifEmpty { "en_US" } + val core = EaOoa.coreDir(folder, sidecar.exe) + val hashVersion = core?.let(EaOoa::activationVersion) ?: 1 + val hardware = request.optJSONObject("hardware")?.let(EaOoa.Hardware::fromJson)?.takeIf { it.complete(hashVersion) } + val legacy = EaOoa.legacyCore(core) + + val lifetime = if (legacy) 14400 else 550 + val opaque = EaAuth.mint(app, EaAuth.CLIENT_ID, "token", EaAuth.OPAQUE_SCOPES, "OPAQUE", lifetime).orEmpty() + val known = (sidecar.extra["contentIds"].orEmpty().split(',') + sidecar.extra["multiplayerId"].orEmpty()).map { it.trim() }.filter { it.isNotEmpty() }.toSet() + val lsx = EaLsx.start(app, EaLsx.Game(id, contentId, sidecar.title, sidecar.installVersion, locale, hardware, hashVersion, opaque, + System.currentTimeMillis() + (lifetime - 30) * 1000L, known)) + val env = environment(id, contentId, locale, if (legacy && opaque.isNotEmpty()) opaque else access, access, opaque, EaAuth.load(app) ?: account) + val tmp = File(folder, "$ENV_FILE.tmp") + tmp.writeText(env.entries.joinToString("\r\n", postfix = "\r\n") { "${it.key}=${it.value}" }) + tmp.renameTo(File(folder, ENV_FILE)) + + val licenses = JSONArray() + val notes = ArrayList() + if (core != null) { + val ids = (listOf(contentId) + sidecar.extra["contentIds"].orEmpty().split(',')).map { it.trim() }.filter { it.isNotEmpty() }.distinct() + if (hardware == null) notes += "no-hardware" else { + val hash = EaOoa.machineHash(hardware, hashVersion) + for (content in ids) { + notes += try { + for ((path, data) in EaOoa.files(core, EaOoa.request(access, content, hash))) { + licenses.put(JSONObject().put("path", path).put("data", Base64.encodeToString(data, Base64.NO_WRAP))) + } + "$content:ok" + } catch (e: Exception) { + Log.w(TAG, "licence $content for $id: ${e.message}") + com.droiddeck.launcher.stores.StoresState.logLine("ea licence $content for $id v$hashVersion legacy=$legacy: ${e.message}") + "$content:refused" + } + } + } + } + if (core != null && notes.isNotEmpty() && notes.none { it.endsWith(":ok") }) runCatching { + val rows = EaApi.legacyEntitlements(access).filter { it.optString("productId") == id } + val types = rows.joinToString(",") { it.optString("entitlementType") + "/" + it.optString("entitlementTag") + "/" + it.optString("status") } + com.droiddeck.launcher.stores.StoresState.logLine("ea $id has no licence; entitlements: ${types.ifEmpty { "none" }}") + } + val licenseNote = if (core == null) "none-needed" else "v$hashVersion " + notes.joinToString(",") + Log.i(TAG, "prepared $id lsx=$lsx legacy=$legacy opaque=${opaque.isNotEmpty()} licence=$licenseNote") + return reply.put("ok", true).put("lsx", lsx).put("license", licenseNote).put("licenses", licenses) + } +} + +object EaSizes { + fun size(context: Context, item: com.droiddeck.launcher.stores.CatalogItem): Long { + val token = EaAuth.accessToken(context) ?: return 0L + val url = runCatching { EaApi.downloadUrl(token, item.id) }.getOrNull() ?: return 0L + return EaNative.call("zip.size", JSONObject().put("url", url))?.optLong("totalBytes") ?: 0L + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLibrary.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLibrary.kt new file mode 100644 index 0000000000..2a90b2550c --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLibrary.kt @@ -0,0 +1,293 @@ +package com.droiddeck.launcher.stores.ea + +import android.content.Context +import android.content.SharedPreferences +import com.droiddeck.launcher.R +import com.droiddeck.launcher.stores.CatalogItem +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreNet +import com.droiddeck.launcher.stores.StoreShelves +import com.droiddeck.launcher.stores.StoresState +import com.droiddeck.launcher.stores.mergeItems +import org.json.JSONArray +import org.json.JSONObject +import java.util.concurrent.Executors +import java.util.concurrent.TimeUnit +import java.util.concurrent.atomic.AtomicBoolean + +object EaPrefs { + const val FILE = "stores.ea" + fun get(context: Context): SharedPreferences = context.applicationContext.getSharedPreferences(FILE, Context.MODE_PRIVATE) +} + +data class EaGame( + val offerId: String, + val contentId: String, + val title: String, + val slug: String, + val tall: String = "", + val wide: String = "", + val logo: String = "", + val version: String = "", + val executePath: String = "", + val installCheck: String = "", + val parameters: String = "", + val multiplayerId: String = "", + val masterTitleId: String = "", + val cloudSaves: String = "", + val locales: List = emptyList(), +) { + fun toJson(): JSONObject = JSONObject() + .put("offerId", offerId).put("contentId", contentId).put("title", title).put("slug", slug) + .put("tall", tall).put("wide", wide).put("logo", logo).put("version", version) + .put("executePath", executePath).put("installCheck", installCheck).put("parameters", parameters) + .put("multiplayerId", multiplayerId).put("masterTitleId", masterTitleId).put("cloudSaves", cloudSaves) + .put("locales", JSONArray(locales)) + + companion object { + fun fromJson(o: JSONObject): EaGame? { + val locales = o.optJSONArray("locales") + return EaGame( + offerId = o.optString("offerId").ifEmpty { return null }, + contentId = o.optString("contentId"), + title = o.optString("title"), + slug = o.optString("slug"), + tall = o.optString("tall"), + wide = o.optString("wide"), + logo = o.optString("logo"), + version = o.optString("version"), + executePath = o.optString("executePath"), + installCheck = o.optString("installCheck"), + parameters = o.optString("parameters"), + multiplayerId = o.optString("multiplayerId"), + masterTitleId = o.optString("masterTitleId"), + cloudSaves = o.optString("cloudSaves"), + locales = (0 until (locales?.length() ?: 0)).map { locales!!.optString(it) }, + ) + } + } +} + +object EaLibrary { + private const val KEY_CACHE = "library_cache" + private const val KEY_SYNCED_AT = "library_synced_at" + private const val THROTTLE_MS = 6 * 60 * 60 * 1000L + private const val ART_TTL_MS = 7 * 24 * 60 * 60 * 1000L + private const val ART_THREADS = 4 + const val STORE_URL = "https://www.ea.com/ea-app/library" + private val gate = SyncGate() + private val generation = java.util.concurrent.atomic.AtomicInteger() + + /** Drops the cache and makes any sync already running drop its results, in one step. */ + fun reset(context: Context) { + synchronized(cacheLock) { + generation.incrementAndGet() + EaPrefs.get(context).edit().remove(KEY_CACHE).remove(KEY_SYNCED_AT).commit() + } + } + + internal fun snapshot(app: Context): Pair> = synchronized(cacheLock) { generation.get() to cached(app) } + + internal fun storeCache(app: Context, games: List, gen: Int): Boolean = synchronized(cacheLock) { + gen == generation.get() && + EaPrefs.get(app).edit().putString(KEY_CACHE, JSONArray(games.map { it.toJson() }).toString()).putLong(KEY_SYNCED_AT, System.currentTimeMillis()).commit() + } + + private val cacheLock = Any() + private val store = Store.EA + + fun cached(context: Context): List { + val text = EaPrefs.get(context).getString(KEY_CACHE, null) ?: return emptyList() + val arr = runCatching { JSONArray(text) }.getOrNull() ?: return emptyList() + return (0 until arr.length()).mapNotNull { arr.optJSONObject(it)?.let(EaGame::fromJson) } + } + + fun game(context: Context, offerId: String): EaGame? = cached(context).firstOrNull { it.offerId == offerId } + + + fun toCatalogItem(context: Context, g: EaGame): CatalogItem { + val prefs = EaPrefs.get(context) + val tall = g.tall.ifEmpty { prefs.getString("poster_${g.offerId}", null).orEmpty() } + return CatalogItem( + store = store, + id = g.offerId, + title = g.title.ifBlank { g.slug }, + imageUrl = g.wide.ifEmpty { tall }.ifEmpty { null }, + tallImageUrl = tall.ifEmpty { g.wide }.ifEmpty { null }, + publisher = "Electronic Arts", + owned = true, + sizeBytes = prefs.getLong("size_${g.offerId}", 0L), + storeUrl = STORE_URL, + extra = mapOf("contentId" to g.contentId, "slug" to g.slug, "version" to g.version), + logoUrl = g.logo.ifEmpty { null }, + ) + } + + /** One entry per game: owned editions of the same base game collapse onto the base offer. */ + internal fun pick(owned: List, offers: Map): List> { + val usable = owned.filter { o -> + val offer = offers[o.offerId] ?: return@filter false + !o.trial && o.downloadable && offer.downloadable && + (offer.displayType.isEmpty() || offer.displayType.equals("FullGame", true)) && + (o.gameType.isEmpty() || o.gameType.equals("BASE_GAME", true)) + } + return usable.groupBy { it.baseSlug.ifEmpty { it.slug }.ifEmpty { it.offerId } }.values.map { group -> + val chosen = group.firstOrNull { it.baseSlug.isEmpty() } ?: group.first() + chosen to offers.getValue(chosen.offerId) + }.sortedBy { it.first.name.lowercase() } + } + + private fun art(app: Context, token: String, slugs: Collection, gen: Int): Map { + val prefs = EaPrefs.get(app) + val now = System.currentTimeMillis() + val out = java.util.concurrent.ConcurrentHashMap() + val pool = Executors.newFixedThreadPool(ART_THREADS) + try { + for (slug in slugs.filter { it.isNotEmpty() }) { + if (gen != generation.get()) break + val cached = prefs.getString("art_$slug", null)?.let { runCatching { JSONObject(it) }.getOrNull() } + if (cached != null && now - cached.optLong("at") < ART_TTL_MS) { + out[slug] = EaApi.Images(cached.optString("tall").ifEmpty { null }, cached.optString("wide").ifEmpty { null }, cached.optString("logo").ifEmpty { null }) + continue + } + pool.execute { + if (gen != generation.get()) return@execute + val images = runCatching { EaApi.images(token, slug) }.getOrNull() ?: return@execute + out[slug] = images + prefs.edit().putString( + "art_$slug", + JSONObject().put("at", now).put("tall", images.tall.orEmpty()).put("wide", images.wide.orEmpty()).put("logo", images.logo.orEmpty()).toString(), + ).apply() + } + } + } finally { + pool.shutdown() + pool.awaitTermination(2, TimeUnit.MINUTES) + } + return out + } + + private fun posters(app: Context, games: List, gen: Int) { + val prefs = EaPrefs.get(app) + val todo = games.filter { it.tall.isEmpty() && !prefs.contains("poster_${it.offerId}") }.take(40) + if (todo.isEmpty()) return + val pool = Executors.newFixedThreadPool(ART_THREADS) + try { + for (g in todo) pool.execute { + if (gen != generation.get()) return@execute + prefs.edit().putString("poster_${g.offerId}", runCatching { StoreNet.sgdbPoster(g.title) }.getOrDefault("")).apply() + } + } finally { + pool.shutdown() + pool.awaitTermination(5, TimeUnit.MINUTES) + } + } + + private fun publish(app: Context, games: List, gen: Int = generation.get()) { + if (gen != generation.get()) return + val items = games.map { toCatalogItem(app, it) } + StoresState.post { + if (gen != generation.get()) return@post + StoresState.library[store] = mergeItems(StoresState.library[store], items) + val installed = StoresState.installed.filter { it.sidecar.store == store }.map { it.sidecar.id }.toSet() + StoresState.shelves[store] = StoreShelves(trending = items.filterNot { it.id in installed }, art = StoresState.shelves[store]?.art.orEmpty()) + } + } + + private inline fun withToken(app: Context, token: String, call: (String) -> T): T = try { + call(token) + } catch (e: EaApiException) { + if (e.status != 401) throw e + call(EaAuth.refreshNow(app, token) ?: throw e) + } + + fun sync(context: Context, force: Boolean) { + if (!gate.enter()) return + var forced = force + do { + runCatching { syncOnce(context.applicationContext, forced) } + forced = true + } while (gate.leave()) + } + + private fun syncOnce(app: Context, force: Boolean) { + val (gen, cache) = snapshot(app) + val prefs = EaPrefs.get(app) + val quiet = cache.isNotEmpty() && !force + fun status(id: Int) { if (!quiet) StoresState.post { StoresState.status[store] = app.getString(id) } } + fun problem(text: String?) { + StoresState.post { + StoresState.status.remove(store) + if (text == null) StoresState.problems.remove(store) else StoresState.problems[store] = text + } + } + try { + if (cache.isNotEmpty()) publish(app, cache, gen) + if (!force && cache.isNotEmpty() && System.currentTimeMillis() - prefs.getLong(KEY_SYNCED_AT, 0L) in 0 until THROTTLE_MS) { + return problem(null) + } + status(R.string.stores_sync_sign_in) + val token = EaAuth.accessToken(app) ?: return problem(StoresState.notSignedInLine(store)) + status(R.string.stores_sync_game_list) + val owned = withToken(app, token) { EaApi.owned(it) } + val offers = withToken(app, token) { EaApi.offers(it, owned.map { o -> o.offerId }) }.associateBy { it.offerId } + val picked = pick(owned, offers) + StoresState.logLine("ea: ${owned.size} owned products, ${picked.size} games") + for ((o, offer) in picked) StoresState.logLine( + "ea: owned ${o.offerId} content=${offer.contentId} master=${offer.masterTitleId} mp=${offer.multiplayerId} via=${o.ownership.joinToString("+")} type=${o.gameType}") + if (picked.isEmpty()) return problem(if (cache.isEmpty()) app.getString(R.string.stores_sync_no_games, store.label) else null) + if (gen != generation.get()) return + status(R.string.stores_sync_cover_art) + val images = art(app, token, picked.map { it.first.slug }, gen) + val games = picked.map { (o, offer) -> + val img = images[o.slug] + EaGame( + offerId = o.offerId, contentId = offer.contentId, title = o.name.ifBlank { offer.displayName }, slug = o.slug, + tall = img?.tall.orEmpty(), wide = img?.wide.orEmpty(), logo = img?.logo.orEmpty(), version = offer.gameVersion, + executePath = offer.executePathOverride, installCheck = offer.installCheckOverride, parameters = offer.executeParameters, + multiplayerId = offer.multiplayerId, masterTitleId = offer.masterTitleId, cloudSaves = offer.cloudSaves, locales = offer.locales, + ) + } + if (!storeCache(app, games, gen)) return + posters(app, games, gen) + if (gen != generation.get()) return + publish(app, games, gen) + problem(null) + } catch (e: EaApiException) { + StoresState.logLine("ea: library sync failed: ${e.message}") + if (e.status == 401) StoresState.markSignInExpired(store) + problem(if (cache.isEmpty()) e.message else null) + } catch (e: Exception) { + StoresState.logLine("ea: library sync failed: ${e.javaClass.simpleName} ${e.message.orEmpty()}") + problem(if (cache.isEmpty()) e.message ?: app.getString(R.string.stores_sync_failed) else null) + } + } +} + +/** One sync at a time; a request made meanwhile makes the running one go round again rather than being lost. */ +internal class SyncGate { + private var busy = false + private var again = false + + /** True when the caller should run; false when a running sync will pick the request up. */ + @Synchronized + fun enter(): Boolean { + if (busy) { + again = true + return false + } + busy = true + return true + } + + /** True when another round was requested while running; the caller stays the runner. */ + @Synchronized + fun leave(): Boolean { + if (again) { + again = false + return true + } + busy = false + return false + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLsx.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLsx.kt new file mode 100644 index 0000000000..f9e6b286a0 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaLsx.kt @@ -0,0 +1,446 @@ +package com.droiddeck.launcher.stores.ea + +import android.content.Context +import android.util.Log +import org.xmlpull.v1.XmlPullParser +import org.xmlpull.v1.XmlPullParserFactory +import java.io.ByteArrayOutputStream +import java.io.OutputStream +import java.io.StringReader +import java.net.InetAddress +import java.net.ServerSocket +import java.net.Socket +import java.time.LocalDateTime +import java.time.ZoneOffset +import java.time.format.DateTimeFormatter + +/** + * The local SDK endpoint EA games talk to in place of the EA app (LSX: XML over TCP, AES after a + * challenge). It answers for the one game DroidDeck last prepared. + */ +object EaLsx { + private const val TAG = "EaLsx" + const val PORT = 3216 + private const val SENDER = "EALS" + private const val CHALLENGE_KEY = "cacf897a20b6d612ad0c05e011df52bb" + private const val CHALLENGE_VERSION = "10,5,30,15625" + private const val LANGUAGES = "ar_SA,de_DE,en_US,es_ES,es_MX,fr_FR,it_IT,ja_JP,ko_KR,pl_PL,pt_BR,ru_RU,zh_CN,zh_TW" + + private val SERVICES = listOf( + "EbisuSDK" to "SDK", "EbisuSDK" to "PROFILE", "XMPP" to "PRESENCE", "XMPP" to "FRIENDS", "Commerce" to "COMMERCE", + "EbisuSDK" to "RECENTPLAYER", "EbisuSDK" to "IGO", "EbisuSDK" to "MISC", "EALS" to "LOGIN", "EbisuSDK" to "UTILITY", + "XMPP" to "XMPP", "XMPP" to "CHAT", "EbisuSDK" to "IGO_EVENT", "EALS" to "EALS_EVENTS", "EbisuSDK" to "LOGIN_EVENT", + "XMPP" to "INVITE_EVENT", "EbisuSDK" to "PROFILE_EVENT", "XMPP" to "PRESENCE_EVENT", "XMPP" to "FRIENDS_EVENT", + "Commerce" to "COMMERCE_EVENT", "XMPP" to "CHAT_EVENT", "EbisuSDK" to "DOWNLOAD_EVENT", "EbisuSDK" to "PERMISSION", + "EbisuSDK" to "RESOURCES", "EbisuSDK" to "BLOCKED_USERS", "EbisuSDK" to "BLOCKED_USER_EVENT", "EbisuSDK" to "GET_USERID", + "EbisuSDK" to "ONLINE_STATUS_EVENT", "EbisuSDK" to "ACHIEVEMENT", "EbisuSDK" to "ACHIEVEMENT_EVENT", + "EbisuSDK" to "BROADCAST_EVENT", "PI" to "PROGRESSIVE_INSTALLATION", "PI" to "PROGRESSIVE_INSTALLATION_EVENT", + "EbisuSDK" to "CONTENT", + ) + + class Game( + val offerId: String, + val contentId: String, + val title: String, + val version: String, + val locale: String, + val hardware: EaOoa.Hardware?, + val hashVersion: Int, + val token: String = "", + val tokenExpiresAt: Long = 0L, + val contentIds: Set = emptySet(), + ) { + val validToken: String? get() = token.takeIf { it.isNotEmpty() && System.currentTimeMillis() < tokenExpiresAt } + } + + /** The parts of a request a reply depends on. */ + class Message(val recipient: String, val id: String, val name: String, val attrs: Map, val children: List>) + + interface Account { + val userId: String + val personaId: String + val persona: String + fun authCode(clientId: String, scope: String?): String? + fun license(contentId: String, requestTicket: String, ticketEngine: String): String? + fun entitlements(group: String): List> + fun token(): String? + } + + @Volatile var game: Game? = null + @Volatile private var account: Account? = null + /** The one session of the current launch that may act for the account. */ + /** Bumped whenever the launch changes; a connection accepted under an older one is not admitted. */ + @Volatile internal var generation = 0 + private val holder = java.util.concurrent.atomic.AtomicReference(null) + private var server: ServerSocket? = null + private val lock = Any() + private const val MAX_CLIENTS = 8 + private val WHITESPACE = Regex("[ \t]+") + + fun start(context: Context, game: Game): Boolean { + synchronized(lock) { + closeSessions() + this.game = game + account = AppAccount(context.applicationContext) + runCatching { server?.close() } + return try { + val socket = ServerSocket().apply { + reuseAddress = true + bind(java.net.InetSocketAddress(InetAddress.getByName("127.0.0.1"), PORT), 8) + } + server = socket + Thread({ accept(socket) }, "ea-lsx").apply { isDaemon = true }.start() + Log.i(TAG, "listening on $PORT") + true + } catch (e: Exception) { + Log.w(TAG, "could not listen on $PORT: ${e.javaClass.simpleName}") + false + } + } + } + + /** Ends the endpoint; with [offerId], only if it still serves that game, so a late exit cannot stop a newer launch. */ + fun stop(offerId: String? = null) { + synchronized(lock) { + if (offerId != null && game?.offerId != offerId) return + runCatching { server?.close() } + server = null + game = null + account = null + closeSessions() + } + } + + private fun closeSessions() { + generation++ + holder.set(null) + synchronized(sessions) { sessions.forEach { it.trusted = false } } + for (socket in open) runCatching { socket.close() } + open.clear() + } + + private val open = java.util.Collections.newSetFromMap(java.util.concurrent.ConcurrentHashMap()) + private const val HANDSHAKE_TIMEOUT_MS = 15_000 + private const val UNTRUSTED_IDLE_MS = 10 * 60 * 1000 + + private fun accept(socket: ServerSocket) { + while (!socket.isClosed) { + val client = runCatching { socket.accept() }.getOrNull() ?: continue + val (owner, unreadable) = ownerUid(client) + val verified = owner?.let { it == android.os.Process.myUid() } + if (verified == false) { + Log.w(TAG, "refused a connection from another app") + runCatching { client.close() } + continue + } + if (unreadable != null) note("peer cannot be identified: $unreadable") + val session = runCatching { Session(client, client.getOutputStream(), verified == true, unreadable != null) }.getOrNull() + val live = session != null && synchronized(lock) { server === socket && admit(session).also { if (it) open += client } } + if (!live) { + runCatching { client.close() } + continue + } + Thread({ try { serve(client, session!!) } finally { synchronized(sessions) { sessions -= session!! }; open -= client } }, "ea-lsx-client").apply { isDaemon = true }.start() + } + } + + /** + * The uid owning the connecting socket, or null where SELinux hides /proc/net. The guest runs + * under this app's uid, so any other uid is another app; an unknown owner never gets credentials. + */ + /** The connecting socket's uid, or why Android hid socket ownership from this app (some builds deny /proc/net). */ + private fun ownerUid(client: Socket): Pair { + val port = client.port + var denied: String? = null + var read = false + for (path in listOf("/proc/net/tcp6", "/proc/net/tcp")) { + val lines = runCatching { java.io.File(path).readLines() }.onFailure { denied = "$path ${it.javaClass.simpleName}" }.getOrNull() ?: continue + read = true + owner(lines, port)?.let { return it to null } + } + return null to if (read) null else denied ?: "no socket table" + } + + internal fun owner(lines: List, port: Int): Int? = lines.drop(1).firstNotNullOfOrNull { line -> + val f = line.trim().split(WHITESPACE) + val local = f.getOrNull(1)?.substringAfterLast(':')?.toIntOrNull(16) + val remote = f.getOrNull(2)?.substringAfterLast(':')?.toIntOrNull(16) + if (local == port && remote == PORT) f.getOrNull(7)?.toIntOrNull() else null + } + + /** + * Adds [session] unless the cap is reached by sessions that cannot be replaced; otherwise the + * oldest session that never claimed the prepared game (then the oldest untrusted one) makes room. + * Counting and eviction share one lock, so the live total never passes the cap. + */ + internal fun admit(session: Session): Boolean = synchronized(sessions) { + if (sessions.count { !it.evicted } >= MAX_CLIENTS) { + val candidates = sessions.filter { !it.trusted && !it.evicted } + val victim = candidates.firstOrNull { !it.claimed } ?: candidates.firstOrNull() ?: return false + victim.evicted = true + runCatching { victim.socket.close() } + } + sessions += session + true + } + + internal val sessions = LinkedHashSet() + + /** Trust and eviction exclude each other: an evicted session never becomes trusted, a trusted one is never evicted. */ + internal fun promote(session: Session, matches: Boolean) { + synchronized(sessions) { session.trusted = matches && !session.evicted && session.born == generation && holder.compareAndSet(null, session) } + } + + internal class Session(val socket: Socket, val output: OutputStream, val verified: Boolean, val unverifiable: Boolean = false) { + val born = generation + val connectedAt = System.currentTimeMillis() + @Volatile var evicted = false + @Volatile var claimed = false + var key: ByteArray? = null + @Volatile var trusted = false + var pending: ByteArray? = null + + /** A peer Android names as another app never gets account data; one Android cannot name is judged by its claim alone. */ + val mayTrust get() = (verified || unverifiable) && claimed + + @Synchronized + fun send(xml: String) { + val key = this.key + val text = if (key == null) xml else EaCrypto.hex(EaCrypto.ecbEncrypt(xml.toByteArray(), key)) + output.write(text.toByteArray()) + output.write(0) + output.flush() + } + } + + private fun note(line: String) = com.droiddeck.launcher.stores.StoresState.logLine("ea lsx: $line") + + private fun serve(client: Socket, session: Session) { + client.tcpNoDelay = true + client.soTimeout = HANDSHAKE_TIMEOUT_MS + val seen = LinkedHashSet() + var why = "closed by the game" + note("game connected") + try { + session.send("") + val input = client.getInputStream() + val pending = ByteArrayOutputStream() + val chunk = ByteArray(16 * 1024) + while (true) { + if (session.key == null) { + val left = session.connectedAt + HANDSHAKE_TIMEOUT_MS - System.currentTimeMillis() + if (left <= 0) throw java.net.SocketTimeoutException() + client.soTimeout = left.toInt() + } + val n = input.read(chunk) + if (n < 0) break + pending.write(chunk, 0, n) + for (frame in frames(pending, session.key)) { + for (one in Regex(".*?", RegexOption.DOT_MATCHES_ALL).findAll(frame)) { + val message = parse(one.value) ?: continue + if (seen.add(message.name)) note("request ${message.name}") + val reply = runCatching { answer(session, message) } + .onFailure { note("${message.name} failed: ${it.javaClass.simpleName}") }.getOrNull() + if (reply != null) session.send("$reply") + session.pending?.let { session.key = it; session.pending = null } + if (session.key != null) { + val idle = if (session.trusted) 0 else UNTRUSTED_IDLE_MS + if (client.soTimeout != idle) client.soTimeout = idle + } + } + } + if (pending.size() > 4 * 1024 * 1024) { why = "message too large"; break } + } + } catch (e: java.net.SocketTimeoutException) { + why = "no trusted handshake in time" + } catch (e: Exception) { + why = e.javaClass.simpleName + } finally { + holder.compareAndSet(session, null) + note("game disconnected ($why)") + runCatching { client.close() } + } + } + + /** + * Complete messages in what has arrived so far. Messages normally end in a NUL; one that does + * not counts once it holds a whole `` element, plain or decrypted. + */ + private fun frames(pending: ByteArrayOutputStream, key: ByteArray?): List { + val bytes = pending.toByteArray() + val out = ArrayList() + var start = 0 + for (i in bytes.indices) { + if (bytes[i].toInt() != 0) continue + if (i > start) decode(String(bytes, start, i - start, Charsets.UTF_8), key)?.let(out::add) + start = i + 1 + } + var rest = String(bytes, start, bytes.size - start, Charsets.UTF_8) + if (rest.isNotBlank()) decode(rest, key)?.takeIf { it.contains("") }?.let { out += it; rest = "" } + pending.reset() + pending.write(rest.toByteArray(Charsets.UTF_8)) + return out + } + + private fun decode(frame: String, key: ByteArray?): String? { + val text = frame.trim() + if (text.isEmpty()) return null + if (text.startsWith("<")) return text + val k = key ?: return null + return runCatching { String(EaCrypto.ecbDecrypt(EaCrypto.unhex(text), k)) }.getOrNull() + } + + internal fun parse(xml: String): Message? = runCatching { + val parser = XmlPullParserFactory.newInstance().newPullParser() + parser.setInput(StringReader(xml)) + var recipient = "" + var id = "" + var name = "" + val attrs = HashMap() + val children = ArrayList>() + var depth = 0 + var child = "" + while (parser.eventType != XmlPullParser.END_DOCUMENT) { + when (parser.eventType) { + XmlPullParser.START_TAG -> { + depth++ + when (depth) { + 2 -> if (parser.name == "Request") { + recipient = parser.getAttributeValue(null, "recipient").orEmpty() + id = parser.getAttributeValue(null, "id").orEmpty() + } else return@runCatching null + 3 -> { + name = parser.name + for (i in 0 until parser.attributeCount) attrs[parser.getAttributeName(i)] = parser.getAttributeValue(i) + } + 4 -> child = parser.name + } + } + XmlPullParser.TEXT -> if (depth == 4) children += child to parser.text.trim() + XmlPullParser.END_TAG -> depth-- + } + parser.next() + } + if (name.isEmpty()) null else Message(recipient, id, name, attrs, children) + }.getOrNull() + + private fun esc(s: String) = s.replace("&", "&").replace("<", "<").replace(">", ">").replace("\"", """) + + private fun tag(name: String, vararg attrs: Pair, body: String? = null): String { + val a = attrs.filter { it.second != null }.joinToString("") { " ${it.first}=\"${esc(it.second.toString())}\"" } + return if (body == null) "<$name$a/>" else "<$name$a>$body" + } + + private fun now() = LocalDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss")) + + private fun answer(session: Session, m: Message): String? { + val g = game + val who = account + val person = who?.takeIf { session.trusted } + val locale = g?.locale ?: "en_US" + return when (m.name) { + "ChallengeResponse" -> { + val answer = EaCrypto.challengeAnswer(m.attrs["key"].orEmpty()) + val version = m.attrs["version"].orEmpty() + val seed = EaCrypto.challengeSeed(version, answer) ?: 0 + val content = m.children.firstOrNull { it.first == "ContentId" }?.second.orEmpty() + session.claimed = g != null && content.isNotEmpty() && (content == g.contentId || content == g.offerId || content in g.contentIds) + val matches = session.mayTrust + promote(session, matches) + note("challenge version '$version' content '$content' ${when { session.trusted -> "matches the prepared game"; matches -> "matches, but another session holds this launch"; !session.verified && !session.unverifiable -> "comes from an unverified peer"; else -> "does not match the prepared game" }}") + session.pending = EaCrypto.lsxKey(seed) + Log.i(TAG, "game connected: ${m.children.firstOrNull { it.first == "Title" }?.second.orEmpty()}") + tag("ChallengeAccepted", "response" to answer) + } + "GetConfig" -> tag("GetConfigResponse", body = SERVICES.joinToString("") { tag("Service", "Name" to it.first, "Facility" to it.second) }) + "GetProfile" -> tag( + "GetProfileResponse", + "Persona" to person?.persona.orEmpty(), "SubscriberLevel" to 0, "CommerceCurrency" to "USD", "IsTrialSubscriber" to false, + "Country" to "US", "UserId" to person?.userId.orEmpty(), "GeoCountry" to "US", "AvatarId" to "", "IsSubscriber" to false, + "IsSteamSubscriber" to false, "PersonaId" to person?.personaId.orEmpty(), "IsUnderAge" to false, "UserIndex" to 0, + ) + "GetSetting" -> tag("GetSettingResponse", "Setting" to when (m.attrs["SettingId"]) { + "ENVIRONMENT" -> "production" + "LANGUAGE" -> locale + else -> "false" + }) + "GetGameInfo" -> tag("GetGameInfoResponse", "GameInfo" to when (m.attrs["GameInfoId"]) { + "FREETRIAL" -> "false" + "LANGUAGES" -> LANGUAGES + "INSTALLED_LANGUAGE" -> locale + "INSTALLED_VERSION", "AVAILABLE_VERSION" -> g?.version.orEmpty() + else -> "" + }) + "GetAllGameInfo" -> tag( + "GetAllGameInfoResponse", + "FullGamePurchased" to true, "FullGameReleased" to true, "InstalledVersion" to (g?.version ?: "0"), "MaxGroupSize" to 16, + "Languages" to LANGUAGES, "Expiration" to "0000-00-00T00:00:00", "UpToDate" to true, "HasExpiration" to false, + "EntitlementSource" to "EA", "AvailableVersion" to (g?.version ?: "0"), "DisplayName" to g?.title.orEmpty(), + "FreeTrial" to false, "InstalledLanguage" to locale, "FullGameReleaseDate" to "2000-01-01T00:00:00", "SystemTime" to now(), + ) + "GetInternetConnectedState" -> tag("InternetConnectedState", "connected" to 1) + "IsProgressiveInstallationAvailable" -> tag("IsProgressiveInstallationAvailableResponse", "ItemId" to m.attrs["ItemId"].orEmpty(), "Available" to false) + "AreChunksInstalled" -> tag( + "AreChunksInstalledResponse", "ItemId" to m.attrs["ItemId"].orEmpty(), "Installed" to true, + body = m.children.joinToString("") { tag(it.first, body = esc(it.second)) }, + ) + "GetAuthCode" -> tag("AuthCode", "value" to (who?.takeIf { session.trusted }?.authCode(m.attrs["ClientId"].orEmpty(), m.attrs["Scope"])?.takeIf { session.trusted } ?: "invalid")) + "GetAuthToken" -> tag("AuthToken", "value" to if (!session.trusted) "" else (g?.validToken ?: who?.token().orEmpty())) + "RequestLicense" -> { + val token = who?.takeIf { session.trusted }?.license(g?.contentId.orEmpty(), m.attrs["RequestTicket"].orEmpty(), m.attrs["TicketEngine"].orEmpty())?.takeIf { session.trusted }.orEmpty() + tag("RequestLicenseResponse", "License" to token) + } + "QueryEntitlements" -> { + val group = m.attrs["Group"].orEmpty() + val rows = who?.takeIf { session.trusted }?.entitlements(group).orEmpty() + tag("QueryEntitlementsResponse", body = rows.joinToString("") { e -> + tag( + "Entitlement", + "LastModifiedDate" to "0000-00-00T00:00:00", "EntitlementId" to e["id"], "UseCount" to (e["useCount"] ?: "0"), + "Version" to (e["version"] ?: "0"), "ItemId" to e["productId"], "ResourceId" to "", "GrantDate" to e["grantDate"], + "Group" to group, "EntitlementTag" to e["entitlementTag"], "Type" to e["entitlementType"], + "Expiration" to (e["terminationDate"]?.takeIf { it.isNotEmpty() && it != "null" } ?: "0000-00-00T00:00:00"), "Source" to "", + ) + }) + } + "GetPresence" -> tag("GetPresenceResponse", "UserId" to person?.userId.orEmpty(), "Presence" to "INGAME") + "QueryPresence" -> tag("QueryPresenceResponse", body = "") + "QueryFriends" -> tag("QueryFriendsResponse", body = "") + "GetBlockList" -> tag("GetBlockListResponse", "Return" to "Success", body = "") + "QueryOffers" -> tag("QueryOffersResponse", body = "") + "QueryImage" -> tag("QueryImageResponse", "Result" to 0, body = "") + "GetVoipStatus" -> tag("GetVoipStatusResponse", "Available" to false, "Active" to false) + "ShowIGOWindow", "SetDownloaderUtilization" -> null + else -> tag("ErrorSuccess", "Code" to 0, "Description" to "") + } + } + + private class AppAccount(private val app: Context) : Account { + private val saved get() = EaAuth.load(app) + override val userId: String get() = saved?.userId.orEmpty() + override val personaId: String get() = saved?.personaId.orEmpty() + override val persona: String get() = saved?.eaId?.ifEmpty { null } ?: saved?.displayName.orEmpty() + + override fun authCode(clientId: String, scope: String?): String? = + EaAuth.mint(app, clientId, "code", scopes = scope?.split(' ')?.filter { it.isNotBlank() }.orEmpty()) + + override fun license(contentId: String, requestTicket: String, ticketEngine: String): String? { + val g = game ?: return null + val hw = g.hardware ?: return null + val token = EaAuth.accessToken(app) ?: return null + return runCatching { + EaOoa.request(token, contentId, EaOoa.machineHash(hw, g.hashVersion), requestTicket.ifEmpty { null }, ticketEngine.ifEmpty { null }).gameToken + }.onFailure { Log.w(TAG, "licence: ${it.message}") }.getOrNull() + } + + override fun token(): String? = EaAuth.mint(app, EaAuth.CLIENT_ID, "token", EaAuth.OPAQUE_SCOPES, "OPAQUE", 14400) + + override fun entitlements(group: String): List> { + val token = EaAuth.accessToken(app) ?: return emptyList() + val arr = runCatching { EaApi.entitlements(token, group) }.getOrNull() ?: return emptyList() + return (0 until arr.length()).mapNotNull { arr.optJSONObject(it) }.map { o -> + o.keys().asSequence().associateWith { k -> o.optString(k) } + } + } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaManifest.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaManifest.kt new file mode 100644 index 0000000000..8c98311c0c --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaManifest.kt @@ -0,0 +1,134 @@ +package com.droiddeck.launcher.stores.ea + +import org.xmlpull.v1.XmlPullParser +import org.xmlpull.v1.XmlPullParserFactory +import java.io.File +import java.io.StringReader + +/** What `__Installer/installerdata.xml` in an EA build says about running and finishing the install. */ +class EaManifest( + val version: String, + val launchers: List, + val touchupPath: String, + val touchupParameters: String, + val contentIds: List = emptyList(), + val titles: Map = emptyMap(), +) { + fun title(locale: String): String? = titles[locale] ?: titles["en_US"] ?: titles.values.firstOrNull() + + class Launcher(val path: String, val parameters: String, val trial: Boolean) + + fun launcher(): Launcher? = launchers.firstOrNull { !it.trial } ?: launchers.firstOrNull() + + companion object { + const val RELATIVE = "__Installer/installerdata.xml" + + fun decode(bytes: ByteArray): String { + val utf16 = bytes.size >= 2 && ((bytes[0] == 0xFF.toByte() && bytes[1] == 0xFE.toByte()) || (bytes[0] == 0xFE.toByte() && bytes[1] == 0xFF.toByte())) + val text = if (utf16) String(bytes, Charsets.UTF_16) else String(bytes, Charsets.UTF_8) + return text.trimStart('') + } + + fun read(folder: File): EaManifest? { + val file = File(folder, RELATIVE).takeIf { it.isFile } ?: EaPaths.find(folder, RELATIVE) ?: return null + return runCatching { parse(decode(file.readBytes())) }.getOrNull() + } + + fun parse(xml: String): EaManifest { + val parser = XmlPullParserFactory.newInstance().newPullParser() + parser.setInput(StringReader(xml.replace(Regex("^<\\?xml[^>]*\\?>"), ""))) + val stack = ArrayList() + var version = "" + val launchers = ArrayList() + var touchupPath = "" + var touchupParams = "" + var path = "" + var params = "" + var trial = false + val contentIds = ArrayList() + val titles = LinkedHashMap() + var locale = "" + while (parser.eventType != XmlPullParser.END_DOCUMENT) { + when (parser.eventType) { + XmlPullParser.START_TAG -> { + val name = parser.name + stack += name + if (name.equals("gameVersion", true)) { + version = parser.getAttributeValue(null, "version") ?: version + } + if (name.equals("launcher", true)) { path = ""; params = ""; trial = false } + if (name.equals("localeInfo", true)) locale = parser.getAttributeValue(null, "locale").orEmpty() + } + XmlPullParser.TEXT -> { + val text = parser.text.trim() + val tag = stack.lastOrNull().orEmpty() + val parent = stack.getOrNull(stack.size - 2).orEmpty() + if (text.isNotEmpty()) when { + parent.equals("launcher", true) && tag.equals("filePath", true) -> path = text + parent.equals("launcher", true) && tag.equals("parameters", true) -> params = text + parent.equals("launcher", true) && tag.equals("trial", true) -> trial = text.equals("true", true) || text == "1" + (parent.equals("touchup", true) || parent.equals("executable", true)) && tag.equals("filePath", true) -> touchupPath = text + (parent.equals("touchup", true) || parent.equals("executable", true)) && tag.equals("parameters", true) -> touchupParams = text + parent.equals("contentIDs", true) && tag.equals("contentID", true) -> contentIds += text + parent.equals("localeInfo", true) && tag.equals("title", true) && locale.isNotEmpty() -> titles[locale] = text + } + } + XmlPullParser.END_TAG -> { + if (parser.name.equals("launcher", true) && path.isNotEmpty()) launchers += Launcher(path, params, trial) + stack.removeLastOrNull() + } + } + parser.next() + } + return EaManifest(version, launchers, touchupPath, touchupParams, contentIds, titles) + } + } +} + +object EaPaths { + private val KEY = Regex("^\\[([^\\]]+)\\](.*)$") + + /** `[HKEY_LOCAL_MACHINE\SOFTWARE\Publisher\Game\Install Dir]bin\game.exe` splits into the registry key, value and relative path. */ + class Registered(val key: String, val value: String, val rest: String) + + fun registered(path: String): Registered? { + val m = KEY.find(path.trim()) ?: return null + val full = m.groupValues[1] + val cut = full.lastIndexOf('\\').takeIf { it > 0 } ?: return null + return Registered(full.substring(0, cut), full.substring(cut + 1), m.groupValues[2]) + } + + fun relative(path: String): String { + val rest = registered(path)?.rest ?: path.replace("{installLocation}", "", ignoreCase = true) + return rest.replace('\\', '/').trimStart('/').split('/').filter { it.isNotEmpty() && it != "." }.joinToString("/") + } + + /** The real file for a path the manifest may spell in a different case. */ + fun find(folder: File, relative: String): File? { + var cur = folder + for (part in relative.replace('\\', '/').split('/').filter { it.isNotEmpty() }) { + val names = cur.listFiles() ?: return null + cur = names.firstOrNull { it.name == part } ?: names.firstOrNull { it.name.equals(part, true) } ?: return null + } + return cur.takeIf { it.exists() && it != folder } + } + + fun relativeOnDisk(folder: File, relative: String): String? = + find(folder, relative)?.relativeTo(folder)?.path?.replace(File.separatorChar, '/') + + fun splitArgs(text: String): List { + val out = ArrayList() + val cur = StringBuilder() + var quoted = false + var any = false + for (c in text) { + when { + c == '"' -> { quoted = !quoted; any = true } + c.isWhitespace() && !quoted -> { if (any || cur.isNotEmpty()) out += cur.toString(); cur.clear(); any = false } + else -> cur.append(c) + } + } + if (any || cur.isNotEmpty()) out += cur.toString() + return out + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaNative.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaNative.kt new file mode 100644 index 0000000000..b8a4b60052 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaNative.kt @@ -0,0 +1,57 @@ +package com.droiddeck.launcher.stores.ea + +import android.util.Log +import com.droiddeck.launcher.stores.StoresNative +import com.droiddeck.launcher.stores.amazon.AmazonNative +import org.json.JSONObject +import java.util.concurrent.CountDownLatch +import java.util.concurrent.TimeUnit +import java.util.concurrent.atomic.AtomicBoolean + +object EaNative { + private const val TAG = "EaNative" + const val ENGINE_MISSING = "EA: the store engine is not available" + + fun ready(): Boolean = StoresNative.ensureLoaded() + + fun call(op: String, request: JSONObject): JSONObject? { + if (!ready()) return null + val text = try { nativeCall(op, request.toString()) } catch (t: Throwable) { + Log.w(TAG, "$op: ${t.javaClass.simpleName}") + null + } ?: return null + return runCatching { JSONObject(text) }.getOrNull() + } + + fun install(request: JSONObject, events: AmazonNative.InstallListener, cancelled: AtomicBoolean): AmazonNative.InstallOutcome { + if (!ready()) return AmazonNative.InstallOutcome(false, false, ENGINE_MISSING, null) + val done = CountDownLatch(1) + val holder = arrayOfNulls(1) + val bridge = object : AmazonNative.InstallListener by events { + override fun onComplete(success: Boolean, cancelled: Boolean, error: String, result: String) { + holder[0] = AmazonNative.InstallOutcome(success, cancelled, error, result.takeIf { it.isNotEmpty() }?.let { runCatching { JSONObject(it) }.getOrNull() }) + done.countDown() + } + } + val handle = try { nativeInstall(request.toString(), bridge) } catch (t: Throwable) { + return AmazonNative.InstallOutcome(false, false, "The EA install could not start: ${t.javaClass.simpleName}", null) + } + if (handle == 0L) return holder[0] ?: AmazonNative.InstallOutcome(false, false, "The EA install could not start", null) + try { + var forwarded = false + while (true) { + val finished = try { done.await(250, TimeUnit.MILLISECONDS) } catch (e: InterruptedException) { cancelled.set(true); false } + if (finished) break + if (!forwarded && cancelled.get()) { nativeCancel(handle); forwarded = true } + } + } finally { + nativeRelease(handle) + } + return holder[0] ?: AmazonNative.InstallOutcome(false, false, "The EA install ended without a result", null) + } + + @JvmStatic private external fun nativeCall(op: String, request: String): String? + @JvmStatic private external fun nativeInstall(request: String, listener: AmazonNative.InstallListener): Long + @JvmStatic private external fun nativeCancel(handle: Long) + @JvmStatic private external fun nativeRelease(handle: Long) +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ea/EaOoa.kt b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaOoa.kt new file mode 100644 index 0000000000..9590ce4a0b --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ea/EaOoa.kt @@ -0,0 +1,196 @@ +package com.droiddeck.launcher.stores.ea + +import org.json.JSONObject +import org.xmlpull.v1.XmlPullParser +import org.xmlpull.v1.XmlPullParserFactory +import java.io.File +import java.io.StringReader +import java.net.URLEncoder +import java.security.SecureRandom + +/** Origin Online Activation: the per-machine licence an EA game's activation layer checks before it runs. */ +object EaOoa { + private const val LICENSES = "https://proxy.novafusion.ea.com/licenses" + const val LICENSE_DIR = "ProgramData/Electronic Arts/EA Services/License" + private const val SIGNATURE_SLOT = 65 + + /** + * What the game sees of the machine inside its Wine prefix: firmware and OS values from Wine's + * WMI, CPU values from CPUID executed as x86 code, since an emulated game sees the emulator's + * CPUID rather than the host CPU WMI describes. + */ + class Hardware( + val boardManufacturer: String, + val boardSerial: String, + val biosManufacturer: String, + val biosSerial: String, + val osInstallDate: String, + val osSerial: String, + val volumeSerial: String, + val gpuPnpId: String, + val cpuVendor: String, + val cpuEdx: String, + val cpuEax: String, + val cpuEcx: String, + val brand: String, + val hostname: String, + ) { + /** Whether the probe reported everything the hash of this activation version is built from. */ + fun complete(version: Int): Boolean { + val needed = arrayListOf(boardManufacturer, biosManufacturer) + when { + version <= 1 -> needed += listOf(hostname, osInstallDate, osSerial) + version == 2 -> needed += listOf(osInstallDate, osSerial, volumeSerial, cpuVendor, cpuEdx, cpuEcx) + version == 3 -> needed += listOf(volumeSerial, cpuVendor, cpuEdx, cpuEcx) + else -> needed += listOf(volumeSerial, cpuVendor, cpuEdx, cpuEax) + } + return needed.all { it.isNotEmpty() } + } + + companion object { + fun fromJson(o: JSONObject): Hardware { + fun s(k: String) = o.optString(k).trim() + return Hardware( + boardManufacturer = s("boardManufacturer"), + boardSerial = s("boardSerial").ifEmpty { "None" }, + biosManufacturer = s("biosManufacturer"), + biosSerial = s("biosSerial").ifEmpty { "None" }, + osInstallDate = s("osInstallDate"), + osSerial = s("osSerial"), + volumeSerial = s("volumeSerial").replace("-", "").lowercase().let { if (it.isEmpty()) it else it.padStart(8, '0') }, + gpuPnpId = s("gpuPnpId").ifEmpty { "None" }, + cpuVendor = s("cpuVendor"), + cpuEdx = s("cpuEdx").uppercase(), + cpuEax = s("cpuEax").uppercase(), + cpuEcx = s("cpuEcx").lowercase(), + brand = o.optString("cpuBrand"), + hostname = s("hostname"), + ) + } + } + } + + fun machineHash(hw: Hardware, version: Int): String { + val edxEax = hw.cpuEdx + hw.cpuEax + val edx = hw.cpuEdx.lowercase() + val shortGpu = hw.gpuPnpId.substringBeforeLast('\\', hw.gpuPnpId) + val parts = arrayListOf(hw.boardManufacturer, hw.boardSerial) + when { + version <= 1 -> parts += listOf(hw.hostname, hw.biosManufacturer, hw.biosSerial, hw.osInstallDate, hw.osSerial) + version == 2 -> parts += listOf(hw.biosManufacturer, hw.biosSerial, hw.osInstallDate, hw.osSerial, hw.volumeSerial, shortGpu, hw.cpuVendor, edx, hw.cpuEcx) + version == 3 -> parts += listOf(hw.biosManufacturer, hw.biosSerial, hw.volumeSerial, shortGpu, hw.cpuVendor, edx, hw.cpuEcx) + else -> parts += listOf(hw.biosManufacturer, hw.biosSerial, hw.volumeSerial, hw.gpuPnpId, hw.cpuVendor, edxEax) + } + val text = StringBuilder(parts.joinToString(";")).append(';') + if (version >= 2) text.append(hw.brand.take(47).padEnd(47, '\u0000')).append(';') + val digest = EaCrypto.sha1(text.toString().toByteArray(Charsets.ISO_8859_1)) + return if (version < 4) digest.joinToString("") { Integer.toHexString(it.toInt() and 0xFF) } else EaCrypto.hex(digest) + } + + /** Version of the game's activation layer, which decides how the machine hash is built. */ + fun activationVersion(core: File): Int { + val dll = listOf("activation.dll", "awc.dll").firstNotNullOfOrNull { EaPaths.find(core, it) } ?: return 1 + val (major, minor, patch) = productVersion(dll.readBytes()) ?: return 1 + return when { + major >= 5 -> 4 + major == 4 && (minor > 7 || (minor == 7 && patch >= 6)) -> 3 + major == 4 && minor == 7 -> 2 + major == 4 -> 1 + else -> 0 + } + } + + /** The activation layer's folder: `Core` beside the game's exe, where EA ships it, or at the game root. */ + fun coreDir(game: File, exe: String): File? { + val exeDir = exe.replace('\\', '/').substringBeforeLast('/', "") + val candidates = listOfNotNull(exeDir.takeIf { it.isNotEmpty() }?.let { "$it/Core" }, "Core") + return candidates.firstNotNullOfOrNull { EaPaths.find(game, it)?.takeIf { f -> f.isDirectory } } + } + + /** Games built on the 2012-era EA Core client, which want an opaque token rather than a JWS one. */ + fun legacyCore(core: File?): Boolean = core != null && EaPaths.find(core, "EACore.dll") != null + + private fun encodedSignature(core: File): Boolean = EaPaths.find(core, "activation.exe") != null + + internal fun productVersion(pe: ByteArray): Triple? { + val magic = byteArrayOf(0xBD.toByte(), 0x04, 0xEF.toByte(), 0xFE.toByte()) + var i = 0 + while (i + 24 <= pe.size) { + if (pe[i] == magic[0] && pe[i + 1] == magic[1] && pe[i + 2] == magic[2] && pe[i + 3] == magic[3]) { + fun u32(at: Int) = (pe[at].toLong() and 0xFF) or ((pe[at + 1].toLong() and 0xFF) shl 8) or ((pe[at + 2].toLong() and 0xFF) shl 16) or ((pe[at + 3].toLong() and 0xFF) shl 24) + val ms = u32(i + 16) + val ls = u32(i + 20) + return Triple((ms ushr 16).toInt(), (ms and 0xFFFF).toInt(), (ls ushr 16).toInt()) + } + i++ + } + return null + } + + class License(val fields: LinkedHashMap, val namespace: String, val signature: String) { + val gameToken: String? get() = fields["GameToken"]?.takeIf { it.isNotEmpty() } + val contentId: String get() = fields["ContentId"].orEmpty() + } + + internal fun parseLicense(xml: String, signature: String): License { + val parser = XmlPullParserFactory.newInstance().apply { isNamespaceAware = false }.newPullParser() + parser.setInput(StringReader(xml.replace(Regex("^<\\?xml[^>]*\\?>"), "").trim())) + val fields = LinkedHashMap() + var ns = "" + var depth = 0 + var tag = "" + while (parser.eventType != XmlPullParser.END_DOCUMENT) { + when (parser.eventType) { + XmlPullParser.START_TAG -> { + depth++ + if (depth == 1) ns = parser.getAttributeValue(null, "xmlns").orEmpty() else tag = parser.name + if (depth == 2) fields[tag] = "" + } + XmlPullParser.TEXT -> if (depth == 2) fields[tag] = fields[tag].orEmpty() + parser.text + XmlPullParser.END_TAG -> depth-- + } + parser.next() + } + return License(fields, ns, signature) + } + + private fun esc(s: String) = s.replace("&", "&").replace("<", "<").replace(">", ">").replace("\"", """) + + fun licenseXml(l: License): String { + val order = listOf("CipherKey", "MachineHash", "ContentId", "UserId", "GameToken", "GrantTime", "StartTime", "Nonce") + val body = StringBuilder("") + body.append("") + for (k in order) { + val v = l.fields[k] ?: continue + if (k == "GameToken" && v.isEmpty()) continue + body.append('<').append(k).append('>').append(esc(v)).append("') + } + return body.append("").toString() + } + + fun licenseBlob(l: License, encoded: Boolean): ByteArray { + val signature = if (encoded) l.signature.toByteArray() else java.util.Base64.getDecoder().decode(l.signature) + val head = ByteArray(SIGNATURE_SLOT) + System.arraycopy(signature, 0, head, 0, signature.size.coerceAtMost(SIGNATURE_SLOT)) + return head + EaCrypto.licenseEncrypt(licenseXml(l).toByteArray()) + } + + fun request(token: String, contentId: String, machineHash: String, requestToken: String? = null, requestType: String? = null): License { + val nonce = EaCrypto.hex(ByteArray(4).also(SecureRandom()::nextBytes)) + val params = mutableListOf("contentId" to contentId, "machineHash" to machineHash, "nonce" to nonce, "ea_eadmtoken" to token) + if (requestToken != null) params += "requestToken" to requestToken + if (requestType != null) params += "requestType" to requestType + val url = LICENSES + "?" + params.joinToString("&") { (k, v) -> k + "=" + URLEncoder.encode(v, "UTF-8") } + val reply = EaHttp.request(url, headers = mapOf("X-Requester-Id" to "Origin Online Activation", "User-Agent" to "EACTransaction")) + if (!reply.ok) throw IllegalStateException("EA refused the licence (${reply.status}): ${reply.text.replace(Regex("(eadmToken value=\")[^\"]*"), "$1\"").take(600)}") + val signature = reply.header("x-signature") ?: throw IllegalStateException("EA's licence had no signature") + return parseLicense(String(EaCrypto.licenseDecrypt(reply.body), Charsets.UTF_8), signature) + } + + /** Licence files for a game about to start, named as the activation layer looks for them. */ + fun files(core: File, license: License): List> { + val blob = licenseBlob(license, encodedSignature(core)) + val id = license.contentId + return listOf("$LICENSE_DIR/$id.dlf" to blob, "$LICENSE_DIR/${id}_cached.dlf" to blob) + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogBackend.kt b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogBackend.kt index fb6b0c8905..e36f0fc16d 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogBackend.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogBackend.kt @@ -64,6 +64,8 @@ object GogBackend : StoreBackend { }, "gog-sync").start() } + override fun search(context: Context, query: String): List = GogStoreCatalog.search(query) + override fun loadShelves(context: Context, force: Boolean) { val app = context.applicationContext GogStoreCatalog.cachedFeatured(app)?.let { StoresState.post { StoresState.shelves[store] = it } } diff --git a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogComet.kt b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogComet.kt index dec376c456..8ad240e651 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogComet.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogComet.kt @@ -139,15 +139,21 @@ object GogComet { !File(LinuxRuntime.rootDir(context), BIN.removePrefix("/")).isFile) return reply(false, "not-installed") val data = File(context.filesDir, "gog-achievements").apply { mkdirs() } val ready = CountDownLatch(1) - val command = LinuxRuntime.command(context, null, null, Environment.getExternalStorageDirectory(), - listOf("/usr/bin/env", "HOME=/root", "XDG_DATA_HOME=${data.path}/data", "XDG_CONFIG_HOME=${data.path}/config", "COMET_LOG=off", "COMET_ALLOWED_CLIENTS=${policy.path}", BIN, "--credentials-stdin")) - val pb = ProcessBuilder(command).redirectErrorStream(true) - pb.environment().apply { - remove("LD_PRELOAD"); remove("LD_AUDIT"); remove("LD_LIBRARY_PATH") - put("PROOT_LOADER", LinuxRuntime.prootLoader(context).path) - put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(context).path) - if (SessionPrefs.prootNoSeccomp(context)) put("PROOT_NO_SECCOMP", "1") - LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + val guest = listOf("/usr/bin/env", "HOME=/root", "XDG_DATA_HOME=${data.path}/data", "XDG_CONFIG_HOME=${data.path}/config", "COMET_LOG=off", "COMET_ALLOWED_CLIENTS=${policy.path}", BIN, "--credentials-stdin") + val pb = if (com.droiddeck.launcher.runtime.NativeGuest.forSession(context)) { + val root = LinuxRuntime.rootDir(context) + com.droiddeck.launcher.runtime.NativeGuest.processBuilder(context, root, + LinuxRuntime.binds(context, null, null, Environment.getExternalStorageDirectory(), null), guest).redirectErrorStream(true) + } else { + ProcessBuilder(LinuxRuntime.command(context, null, null, Environment.getExternalStorageDirectory(), guest)).redirectErrorStream(true).also { + it.environment().apply { + remove("LD_PRELOAD"); remove("LD_AUDIT"); remove("LD_LIBRARY_PATH") + put("PROOT_LOADER", LinuxRuntime.prootLoader(context).path) + put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(context).path) + if (SessionPrefs.prootNoSeccomp(context)) put("PROOT_NO_SECCOMP", "1") + LinuxRuntime.prootLibraryPath(context).takeIf { it.isNotEmpty() }?.let { put("LD_LIBRARY_PATH", it) } + } + } } try { val child = pb.start() diff --git a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogContent.kt b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogContent.kt index 3d86fd5854..8ab48333e7 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogContent.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogContent.kt @@ -16,6 +16,7 @@ internal object GogContent { fun token(context: Context) = GogAuth.validToken(context) ?: error("Sign in to GOG and retry") + @JvmStatic fun builds(id: String, token: String): JSONObject { val result = json("$SYSTEM/products/$id/os/windows/builds?generation=2", token) if (result.optJSONArray("items")?.length() != 0) return result @@ -24,6 +25,36 @@ internal object GogContent { fun product(id: String, token: String): JSONObject = json("https://api.gog.com/products/$id?expand=downloads", token) + @JvmStatic + fun ownedProductIds(token: String): Set? = runCatching { + val body = StoreNet.get("https://embed.gog.com/user/data/games", bearer = token) ?: return@runCatching null + JSONObject(body).optJSONArray("owned")?.strings()?.toSet() ?: emptySet() + }.getOrNull() + + @JvmStatic + fun depotProducts(depot: JSONObject, baseProductId: String): List = + depot.optJSONArray("gameIDs")?.strings() ?: listOf(depot.optString("productId").ifEmpty { baseProductId }) + + @JvmStatic + fun clientCredentials(manifest: JSONObject): Pair? { + val clientId = manifest.optString("clientId") + val clientSecret = manifest.optString("clientSecret") + return clientId.takeIf { it.isNotBlank() }?.let { id -> clientSecret.takeIf { it.isNotBlank() }?.let { id to it } } + } + + @JvmStatic + fun tempExecutable(manifest: JSONObject): String? = manifest.optJSONArray("products")?.optJSONObject(0) + ?.optString("temp_executable")?.takeIf { it.isNotBlank() } + + @JvmStatic + fun installProducts(baseProductId: String, depots: JSONArray, installed: List, token: String, + ownership: (String) -> Set? = { ownedProductIds(it) }): Set { + val listed = depots.objects().flatMap { depotProducts(it, baseProductId) }.distinct() + val owned = if (listed.any { it != baseProductId } || installed.any { it != baseProductId }) ownership(token) else emptySet() + check(installed.all { it == baseProductId || owned?.contains(it) == true }) { "Could not confirm ownership of installed GOG DLC" } + return (listOf(baseProductId) + installed + listed.filter { it == baseProductId || owned?.contains(it) == true }).toSet() + } + fun downloadFilename(url: String): String = java.net.URLDecoder.decode(URL(url).path.substringAfterLast('/').replace("+", "%2B"), "UTF-8") fun resolveDownload(download: GogOfflineDownload, token: String): GogOfflineDownload = download.copy(parts = download.parts.map { part -> @@ -42,6 +73,7 @@ internal object GogContent { } finally { connection.disconnect() } }) + @JvmStatic fun json(url: String, token: String? = null): JSONObject { require(URL(url).protocol == "https") { "GOG metadata requires HTTPS" } val connection = URL(url).openConnection() as HttpURLConnection @@ -61,21 +93,21 @@ internal object GogContent { } fun snapshot(old: GogInstallRecord, build: GogBuild, token: String, - metadata: (String, String?) -> JSONObject = ::json): GogInstallRecord { + ownership: (String) -> Set? = { ownedProductIds(it) }, + metadata: (String, String?) -> JSONObject = ::json, + onManifest: (JSONObject) -> Unit = {}): GogInstallRecord { check(build.link.isNotBlank()) { "GOG build manifest is unavailable" } val manifest = metadata(build.link, token) + onManifest(manifest) val files = JSONArray() val depots = if (build.generation == 1) manifest.optJSONObject("product")?.optJSONArray("depots") ?: manifest.optJSONArray("depot") else manifest.optJSONArray("depots") check(depots != null) { "GOG build has no depot list" } val resolvedLanguage = StoreLanguage.pick(StoreLanguage.codesFromDepots(depots), old.language) val selectedBitness = if (depots.objects().any { it.optJSONArray("osBitness")?.strings()?.contains("64") == true }) "64" else "32" - val owned = if (old.products.any { it != old.id }) StoreNet.get("https://embed.gog.com/user/data/games", bearer = token)?.let { JSONObject(it).optJSONArray("owned")?.strings()?.toSet() } else emptySet() - val products = old.products.filter { it == old.id || owned?.contains(it) == true } - check(old.products.all { it == old.id || owned?.contains(it) == true }) { "Could not confirm ownership of installed GOG DLC" } + val products = installProducts(old.id, depots, old.products, token, ownership) for (depot in depots.objects()) { if (depot.has("redist")) continue - val ids = depot.optJSONArray("gameIDs")?.strings() ?: listOf(depot.optString("productId", old.id)) - val product = ids.firstOrNull { it in products } ?: continue + val product = depotProducts(depot, old.id).firstOrNull { it in products } ?: continue val languages = depot.optJSONArray("languages")?.strings().orEmpty() if (!languageSelected(languages, resolvedLanguage)) continue val bitness = depot.optJSONArray("osBitness")?.strings().orEmpty() @@ -108,7 +140,7 @@ internal object GogContent { } check(files.length() > 0) { "GOG build contains no matching files" } return old.copy(source = "depot", generation = build.generation, build = build.id, version = build.version, - branch = build.branch, language = resolvedLanguage, manifest = sanitize(manifest), files = files, products = products, verified = true) + branch = build.branch, language = resolvedLanguage, manifest = sanitize(manifest), files = files, products = products.toList(), verified = true) } fun languageSelected(list: List, selected: String): Boolean = list.any { it.equals("Neutral", true) } || StoreLanguage.depotMatchesResolved(list.toTypedArray(), selected) diff --git a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogDownloadManager.java b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogDownloadManager.java index 352fa5c1f6..a09629bc4c 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogDownloadManager.java +++ b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogDownloadManager.java @@ -125,211 +125,22 @@ public final class GogDownloadManager { private static Gen2Outcome runGen2(Context ctx, GogGame game, String token, String buildsJson, File installPath, Callback cb, AtomicBoolean cancelled, String language) { Gen2Outcome out = new Gen2Outcome(); try { - cb.onProgress("Fetching manifest…", 5); - Gen2Manifest gm = resolveGen2Manifest(buildsJson, token, cb); - if (gm == null) { out.error = "gen2 manifest unavailable"; return out; } - JSONObject manifest = gm.manifest; - JSONArray depots = manifest.optJSONArray("depots"); - if (depots == null) { out.error = "no depots in manifest"; return out; } - JSONArray products = manifest.optJSONArray("products"); - String tempExe = null; - if (products != null && products.length() > 0) { - tempExe = products.getJSONObject(0).optString("temp_executable", null); - if (tempExe != null && tempExe.isEmpty()) tempExe = null; - } - String baseProductId = manifest.optString("baseProductId", null); - if ((baseProductId == null || baseProductId.isEmpty()) && products != null && products.length() > 0) - baseProductId = products.getJSONObject(0).optString("productId", null); - if (baseProductId == null || baseProductId.isEmpty()) baseProductId = game.gameId; - JSONArray deps = manifest.optJSONArray("dependencies"); - List dependencies = new ArrayList<>(); - if (deps != null) for (int i = 0; i < deps.length(); i++) { String d = deps.optString(i, ""); if (!d.isEmpty()) dependencies.add(d); } - if (!dependencies.isEmpty()) cb.onLog("gog: build lists dependencies " + deps); - - cb.onProgress("Reading depot manifests…", 10); - List files = new ArrayList<>(); - List depotJsons = new ArrayList<>(); - JSONArray owned = new JSONArray(); - List ownedDepots = new ArrayList<>(); - for (int i = 0; i < depots.length(); i++) { - JSONObject depot = depots.getJSONObject(i); - String depotPid = depot.optString("productId", ""); - if (!depotPid.isEmpty() && !depotPid.equals(baseProductId)) continue; - owned.put(depot); - ownedDepots.add(depot); - } - String resolved = StoreLanguage.pick(StoreLanguage.codesFromDepots(owned), language); - cb.onLog("gog: language " + resolved); - for (int i = 0; i < ownedDepots.size(); i++) { - if (cancelled.get()) return out; - JSONObject depot = ownedDepots.get(i); - if (!depotSelected(depot, resolved)) continue; - String manifestHash = depot.optString("manifest"); - if (manifestHash == null || manifestHash.isEmpty()) continue; - byte[] dmRaw = fetchBytes("https://gog-cdn-fastly.gog.com/content-system/v2/meta/" + buildCdnPath(manifestHash), null); - if (dmRaw == null) { cb.onLog("gog: depot " + i + " meta fetch failed"); continue; } - String dmStr = decompressBytes(dmRaw); - if (dmStr == null) { cb.onLog("gog: depot " + i + " decompress failed"); continue; } - parseDepotManifest(dmStr, files); - depotJsons.add(dmStr); - } - if (files.isEmpty()) { out.error = "no depot files collected"; return out; } - - cb.onProgress("Fetching CDN link…", 15); - String secureLinkUrl = "https://content-system.gog.com/products/" + baseProductId + "/secure_link?_version=2&generation=2&path=/"; - String cdnBase = parseCdnUrl(httpGet(secureLinkUrl, token)); - if (cdnBase == null) { out.error = "secure link refused"; return out; } - - installPath.mkdirs(); - long plannedBytes = 0; - for (DepotFile df : files) plannedBytes += df.totalSize; - long remainingBytes = remainingInstallBytes(files, installPath); - if (remainingBytes > 0) { - long usable = com.droiddeck.launcher.stores.StoreInstallRoot.availableBytes(installPath); - if (com.droiddeck.launcher.stores.StoreInstallRoot.insufficientSpace(remainingBytes, usable)) { - out.hardStop = true; - out.error = "Not enough free space: need " + formatBytes(remainingBytes) + ", only " + formatBytes(usable) + " free"; - return out; - } - } - Collections.sort(files, (a, b) -> Long.compare(b.totalSize, a.totalSize)); - - final int total = files.size(); - final long planned = plannedBytes; - final AtomicInteger doneCount = new AtomicInteger(0); - final AtomicLong totalBytes = new AtomicLong(0); - final AtomicLong lastSpeedMs = new AtomicLong(System.currentTimeMillis()); - final AtomicLong lastSpeedB = new AtomicLong(0); - final AtomicLong speedBps = new AtomicLong(0); - final AtomicBoolean anyFailed = new AtomicBoolean(false); - final AtomicReference cdnBaseRef = new AtomicReference<>(cdnBase); - final AtomicInteger cdnRefreshCount = new AtomicInteger(0); - final int MAX_CDN_REFRESH = 5; - cb.onSizes(planned, planned); - cb.onBytes(0, planned, 0); - cb.onLog("gog: " + total + " files, " + formatBytes(planned) + ", base=" + baseProductId); - - int threads = downloadThreads(); - if (GogNative.isAvailable()) { - runNativeEngine(ctx, GogNative.KIND_GEN2_CHUNKS, "Verified…", depotJsons, installPath, cdnBaseRef, secureLinkUrl, token, - cdnRefreshCount, MAX_CDN_REFRESH, threads, threads, true, "gog base=" + baseProductId, - cancelled, anyFailed, doneCount, total, planned, totalBytes, lastSpeedMs, lastSpeedB, speedBps, cb); - } else { - cb.onLog("gog: engine=built-in (" + threads + " threads)"); - ExecutorService pool = Executors.newFixedThreadPool(threads, com.droiddeck.launcher.stores.download.DownloadQueue.workerFactory("gog-dl")); - List> futures = new ArrayList<>(); - for (DepotFile df : files) { - futures.add(pool.submit((Callable) () -> { - if (cancelled.get() || anyFailed.get()) return null; - File outFile = new File(installPath, df.relativePath); - outFile.getParentFile().mkdirs(); - if (fileVerified(outFile, df.totalSize, df.md5)) { - int done = doneCount.incrementAndGet(); - long tb = totalBytes.addAndGet(df.totalSize); - cb.onProgress("Verified…", 15 + (int) ((done / (float) total) * 80)); - cb.onBytes(tb, planned, speedBps.get()); - return null; - } - boolean ok = assembleDepotFile(df, outFile, cdnBaseRef, secureLinkUrl, token, cdnRefreshCount, MAX_CDN_REFRESH, cancelled, cb); - if (cancelled.get()) return null; - if (!ok) { cb.onLog("FAIL file=" + df.relativePath); anyFailed.set(true); return null; } - int done = doneCount.incrementAndGet(); - long tb = totalBytes.addAndGet(df.totalSize); - sampleSpeed(tb, lastSpeedMs, lastSpeedB, speedBps); - cb.onProgress("Downloading: " + baseName(df.relativePath) + speedSuffix(speedBps.get()), 15 + (int) ((done / (float) total) * 80)); - cb.onBytes(tb, planned, speedBps.get()); - return null; - })); - } - pool.shutdown(); - try { - for (Future f : futures) f.get(); - } catch (Exception e) { - pool.shutdownNow(); - out.error = "download pool error: " + e.getClass().getSimpleName(); - return out; - } - } - if (cancelled.get()) return out; - if (anyFailed.get()) { out.error = "one or more chunks failed to download"; return out; } - - cb.onProgress("Finishing…", 96); - try { - GogMaintenance.captureDepot(game.gameId, installPath, gm.buildId, buildsJson, manifest, new JSONArray(depotJsons), resolved); - } catch (Exception e) { - cb.onLog("gog: maintenance inventory not recorded: " + e.getMessage()); - } - writeFile(new File(installPath, MARKER), ("{\"gameId\":\"" + game.gameId + "\",\"buildId\":\"" + gm.buildId + "\"}").getBytes("UTF-8")); - deleteCounted(new File(installPath, ".gog_chunks"), cb); - String clientId = manifest.optString("clientId", null); - if (clientId != null && !clientId.isEmpty()) GogPrefs.get(ctx).edit().putString("client_id_" + game.gameId, clientId).apply(); - String clientSecret = manifest.optString("clientSecret", null); - if (clientSecret != null && !clientSecret.isEmpty()) GogPrefs.get(ctx).edit().putString("client_secret_" + game.gameId, clientSecret).apply(); - GameTask task = pickTask(installPath, game.gameId, tempExe, game.title); - out.result = new Result(task == null ? "" : task.path, gm.buildId, planned); - if (task != null) out.result.workDir = task.workDir; - out.result.dependencies = dependencies; - out.result.dependenciesRead = true; - out.result.language = resolved; - return out; + out.result = GogMaintenance.installContent(ctx, game, installPath, new JSONObject(buildsJson), language, cb, cancelled); + if (out.result == null && !cancelled.get()) out.error = "no usable public Windows build"; } catch (Exception e) { out.error = "exception: " + e.getClass().getSimpleName() + (e.getMessage() != null ? ": " + e.getMessage() : ""); return out; } - } - - private static final class Gen2Manifest { - final JSONObject manifest; final String buildId; - Gen2Manifest(JSONObject manifest, String buildId) { this.manifest = manifest; this.buildId = buildId; } - } - - private static Gen2Manifest resolveGen2Manifest(String buildsJson, String token, Callback cb) { - try { - JSONArray items = new JSONObject(buildsJson).optJSONArray("items"); - if (items == null || items.length() == 0) { cb.onLog("gog: no gen2 builds"); return null; } - String buildId = null, manifestUrl = null; - for (int i = 0; i < items.length(); i++) { - JSONObject item = items.getJSONObject(i); - if ("windows".equals(item.optString("os")) && (item.isNull("branch") || item.optString("branch").isEmpty())) { - buildId = item.optString("build_id"); - manifestUrl = item.optString("link"); - if (manifestUrl == null || manifestUrl.isEmpty()) manifestUrl = item.optString("meta_url"); - break; - } - } - if (buildId == null || manifestUrl == null || manifestUrl.isEmpty()) { cb.onLog("gog: no windows build"); return null; } - byte[] raw = fetchBytes(manifestUrl, token); - if (raw == null) { cb.onLog("gog: manifest fetch failed"); return null; } - String str = decompressBytes(raw); - if (str == null) { cb.onLog("gog: manifest decompress failed"); return null; } - return new Gen2Manifest(new JSONObject(str), buildId); - } catch (Exception e) { - cb.onLog("gog: manifest " + e.getClass().getSimpleName()); - return null; - } - } - - private static boolean depotSelected(JSONObject depot, String resolved) { - JSONArray languages = depot.optJSONArray("languages"); - if (languages == null || languages.length() == 0) return true; - String[] listed = new String[languages.length()]; - for (int i = 0; i < languages.length(); i++) listed[i] = languages.optString(i, ""); - return StoreLanguage.depotMatchesResolved(listed, resolved); + return out; } public static List listLanguages(Context ctx, String gameId) { try { String token = GogAuth.validToken(ctx); - String buildsUrl = "https://content-system.gog.com/products/" + gameId + "/os/windows/builds?generation=2"; - String buildsJson = httpGet(buildsUrl, null); - if (buildsJson == null) buildsJson = httpGet(buildsUrl, token); - if (buildsJson == null) return Collections.emptyList(); - Callback silent = new Callback() { - @Override public void onProgress(String message, int pct) {} - }; - Gen2Manifest gm = resolveGen2Manifest(buildsJson, token, silent); - if (gm == null) return Collections.emptyList(); - return StoreLanguage.codesFromDepots(gm.manifest.optJSONArray("depots")); + JSONObject builds = GogContent.builds(gameId, token); + GogBuild build = GogBuild.Companion.select(builds, "", ""); + if (build == null || build.getGeneration() != 2) return Collections.emptyList(); + return StoreLanguage.codesFromDepots(GogContent.json(build.getLink(), token).optJSONArray("depots")); } catch (Exception e) { return Collections.emptyList(); } @@ -398,7 +209,7 @@ public final class GogDownloadManager { int threads = downloadThreads(); if (GogNative.isAvailable()) { runNativeEngine(ctx, GogNative.KIND_GEN1_RANGES, "Resuming…", Collections.singletonList(manifestStr), installPath, - new AtomicReference<>(""), null, null, new AtomicInteger(0), 0, threads, threads, false, "gog gen1=" + game.gameId, + threads, threads, false, "gog gen1=" + game.gameId, cancelled, anyFailed, done, total, planned, totalBytes, lastSpeedMs, lastSpeedB, speedBps, cb); } else { ExecutorService pool = Executors.newFixedThreadPool(threads, com.droiddeck.launcher.stores.download.DownloadQueue.workerFactory("gog-dl")); @@ -659,8 +470,7 @@ public final class GogDownloadManager { private static void runNativeEngine(Context ctx, int kind, String verifiedMsg, List depotJsons, File installPath, - AtomicReference cdnBaseRef, String secureLinkUrl, String token, - AtomicInteger cdnRefreshCount, int maxCdnRefresh, int maxWorkers, int processWorkers, + int maxWorkers, int processWorkers, boolean sortLargestFirst, String label, AtomicBoolean cancelled, AtomicBoolean anyFailed, AtomicInteger doneCount, int total, long planned, AtomicLong totalBytes, AtomicLong lastSpeedMs, AtomicLong lastSpeedB, AtomicLong speedBps, Callback cb) { @@ -673,10 +483,8 @@ public final class GogDownloadManager { int run = 0; while (!cancelled.get()) { run++; - final String base = cdnBaseRef.get(); final CountDownLatch latch = new CountDownLatch(1); final AtomicBoolean okRef = new AtomicBoolean(false); - final AtomicBoolean linkExpiryRef = new AtomicBoolean(false); final AtomicReference errRef = new AtomicReference<>(""); final long runStart = totalBytes.get(); final AtomicLong verifiedInRun = new AtomicLong(0); @@ -702,12 +510,10 @@ public final class GogDownloadManager { @Override public void onLog(String line) { cb.onLog(line); } @Override public void onMaintenance(long networkBytes, long reusedBytes, long appliedBytes) {} @Override public void onComplete(boolean success, boolean wasCancelled, boolean linkExpiry, String error, long bytesWritten, int filesDone) { - okRef.set(success); linkExpiryRef.set(linkExpiry); errRef.set(error == null ? "" : error); latch.countDown(); + okRef.set(success); errRef.set(error == null ? "" : error); latch.countDown(); } }; - String[] bases = (base == null || base.isEmpty()) ? new String[0] : base.split("\n"); - if (run == 1) cb.onLog("gog: " + bases.length + " CDN host(s) offered"); - long handle = GogNative.start(kind, manifests, bases, installPath.getAbsolutePath(), donePaths.toArray(new String[0]), "", + long handle = GogNative.start(kind, manifests, new String[0], installPath.getAbsolutePath(), donePaths.toArray(new String[0]), "", workers, process, sortLargestFirst, label + " run=" + run, listener); if (handle == 0L) { cb.onLog("gog: native start failed"); anyFailed.set(true); return; } boolean interrupted = false; @@ -721,85 +527,13 @@ public final class GogDownloadManager { } if (interrupted) { Thread.currentThread().interrupt(); anyFailed.set(true); return; } if (cancelled.get() || okRef.get()) return; - String err = errRef.get(); - if (linkExpiryRef.get() && tryRefreshCdn(cdnBaseRef, base, secureLinkUrl, token, cdnRefreshCount, maxCdnRefresh, cb)) { - cb.onLog("gog: secure link expired (" + err + "); refreshed, running again for the remaining files"); - continue; - } - cb.onLog("gog: engine failed: " + err); + cb.onLog("gog: engine failed: " + errRef.get()); anyFailed.set(true); return; } } - private static void parseDepotManifest(String json, List out) { - try { - JSONObject depotObj = new JSONObject(json).optJSONObject("depot"); - if (depotObj == null) return; - JSONArray depot = depotObj.optJSONArray("items"); - if (depot == null) return; - for (int i = 0; i < depot.length(); i++) { - JSONObject entry = depot.getJSONObject(i); - String path = entry.optString("path", "").replace("\\", "/"); - if (path.startsWith("/")) path = path.substring(1); - JSONArray chunks = entry.optJSONArray("chunks"); - if (path.isEmpty() || chunks == null || chunks.length() == 0) continue; - DepotFile df = new DepotFile(path); - String fileMd5 = entry.optString("md5", null); - if (fileMd5 != null && !fileMd5.isEmpty()) df.md5 = fileMd5; - long fileTotal = 0; - for (int c = 0; c < chunks.length(); c++) { - JSONObject chunk = chunks.getJSONObject(c); - String compressedMd5 = chunk.optString("compressedMd5"), decMd5 = chunk.optString("md5"); - String hash = (compressedMd5 != null && !compressedMd5.isEmpty()) ? compressedMd5 : decMd5; - if (hash == null || hash.isEmpty()) continue; - long decSize = chunk.optLong("size", 0); - df.chunks.add(new DepotFile.ChunkRef(hash, compressedMd5, decMd5, chunk.optLong("compressedSize", 0), decSize)); - fileTotal += decSize; - } - df.totalSize = fileTotal; - if (!df.chunks.isEmpty()) out.add(df); - } - } catch (Exception e) { - Log.w(TAG, "depot manifest parse: " + e.getClass().getSimpleName()); - } - } - - static String buildCdnPath(String hash) { return hash.substring(0, 2) + "/" + hash.substring(2, 4) + "/" + hash; } - - private static boolean assembleDepotFile(DepotFile df, File outFile, AtomicReference cdnBaseRef, String secureLinkUrl, String token, - AtomicInteger cdnRefreshCount, int maxCdnRefresh, AtomicBoolean cancelled, Callback cb) { - File tmpFile = new File(outFile.getAbsolutePath() + ".bhtmp"); - File parent = outFile.getParentFile(); - if (parent != null) parent.mkdirs(); - tmpFile.delete(); - boolean ok = true; - try (FileOutputStream fos = new FileOutputStream(tmpFile)) { - for (DepotFile.ChunkRef chunk : df.chunks) { - if (cancelled.get()) { ok = false; break; } - byte[] inflated = fetchChunkVerified(cdnBaseRef, buildCdnPath(chunk.hash), chunk, secureLinkUrl, token, cdnRefreshCount, maxCdnRefresh, cancelled, cb); - if (inflated == null) { ok = false; break; } - fos.write(inflated); - } - } catch (Exception e) { - ok = false; - } - if (!ok || cancelled.get()) { tmpFile.delete(); return false; } - if (df.totalSize > 0 && tmpFile.length() != df.totalSize) { cb.onLog("size mismatch file=" + df.relativePath); tmpFile.delete(); return false; } - if (df.md5 != null && !df.md5.isEmpty()) { - String actual = md5HexFile(tmpFile); - if (actual == null || !actual.equalsIgnoreCase(df.md5)) { cb.onLog("md5 mismatch file=" + df.relativePath); tmpFile.delete(); return false; } - } - if (outFile.exists()) outFile.delete(); - return tmpFile.renameTo(outFile); - } - - private static String parseCdnUrl(String json) { - java.util.List all = parseCdnUrls(json); - return all.isEmpty() ? null : String.join("\n", all); - } - static java.util.List parseCdnUrls(String json) { java.util.List out = new ArrayList<>(); if (json == null) return out; @@ -824,18 +558,6 @@ public final class GogDownloadManager { return out; } - private static final AtomicInteger CDN_TURN = new AtomicInteger(); - - static String pickCdn(String set) { - String[] all = set.split("\n"); - return all[Math.floorMod(CDN_TURN.getAndIncrement(), all.length)]; - } - - static String firstCdn(String set) { - int nl = set.indexOf('\n'); - return nl < 0 ? set : set.substring(0, nl); - } - private static boolean downloadRange(String url, long offset, long size, File out) { try { HttpURLConnection conn = (HttpURLConnection) new URL(url).openConnection(); @@ -951,15 +673,6 @@ public final class GogDownloadManager { } } - private static String buildChunkUrl(String base, String chunkPath) { - int q = base.indexOf('?'); - return q >= 0 ? base.substring(0, q) + "/" + chunkPath + base.substring(q) : base + "/" + chunkPath; - } - - private static String md5Hex(byte[] data) { - try { return toHex(java.security.MessageDigest.getInstance("MD5").digest(data)); } catch (Exception e) { return null; } - } - private static String md5HexFile(File f) { try (FileInputStream fis = new FileInputStream(f)) { java.security.MessageDigest md = java.security.MessageDigest.getInstance("MD5"); @@ -988,58 +701,6 @@ public final class GogDownloadManager { return true; } - private static void sleepBackoff(int attempt) { - try { Thread.sleep(Math.min(1000L << Math.max(0, attempt - 1), 8000L)); } catch (InterruptedException ie) { Thread.currentThread().interrupt(); } - } - - private static boolean tryRefreshCdn(AtomicReference cdnBaseRef, String staleBase, String secureLinkUrl, String token, - AtomicInteger refreshCount, int cap, Callback cb) { - if (secureLinkUrl == null) return false; - synchronized (cdnBaseRef) { - String current = cdnBaseRef.get(); - if (staleBase == null || !staleBase.equals(current)) return true; - if (refreshCount.get() >= cap) { cb.onLog("gog: CDN refresh cap reached (" + cap + ")"); return false; } - String neu = parseCdnUrl(httpGet(secureLinkUrl, token)); - if (neu == null || neu.isEmpty()) { cb.onLog("gog: CDN refresh failed"); return false; } - cdnBaseRef.set(neu); - cb.onLog("gog: secure link refreshed #" + refreshCount.incrementAndGet()); - return true; - } - } - - private static byte[] fetchChunkVerified(AtomicReference cdnBaseRef, String chunkPath, DepotFile.ChunkRef chunk, String secureLinkUrl, String token, - AtomicInteger cdnRefreshCount, int maxCdnRefresh, AtomicBoolean cancelled, Callback cb) { - int hardFail = 0, guard = 0; - while (guard++ < 8) { - if (cancelled.get()) return null; - String base = cdnBaseRef.get(); - HttpResult res = fetchBytesEx(buildChunkUrl(pickCdn(base), chunkPath), null); - if (res.body == null) { - int code = res.status; - if ((code == 401 || code == 403 || code == 404 || code == 500) && tryRefreshCdn(cdnBaseRef, base, secureLinkUrl, token, cdnRefreshCount, maxCdnRefresh, cb)) continue; - cb.onLog("chunk http fail code=" + code); - if (++hardFail >= 3) return null; - sleepBackoff(hardFail); - continue; - } - byte[] raw = res.body; - if (chunk.compressedSize > 0 && raw.length != chunk.compressedSize) { if (++hardFail >= 3) return null; sleepBackoff(hardFail); continue; } - if (chunk.compressedMd5 != null && !chunk.compressedMd5.isEmpty()) { - String actual = md5Hex(raw); - if (actual == null || !actual.equalsIgnoreCase(chunk.compressedMd5)) { if (++hardFail >= 3) return null; sleepBackoff(hardFail); continue; } - } - byte[] inflated = inflateZlib(raw); - if (inflated == null) inflated = raw; - if (chunk.size > 0 && inflated.length != chunk.size) { if (++hardFail >= 3) return null; sleepBackoff(hardFail); continue; } - if (chunk.md5 != null && !chunk.md5.isEmpty()) { - String actual = md5Hex(inflated); - if (actual == null || !actual.equalsIgnoreCase(chunk.md5)) { if (++hardFail >= 3) return null; sleepBackoff(hardFail); continue; } - } - return inflated; - } - return null; - } - private static void sampleSpeed(long totalBytes, AtomicLong lastSpeedMs, AtomicLong lastSpeedB, AtomicLong speedBps) { long nowMs = System.currentTimeMillis(), prevMs = lastSpeedMs.get(); if (nowMs - prevMs >= 500 && lastSpeedMs.compareAndSet(prevMs, nowMs)) { @@ -1289,30 +950,6 @@ public final class GogDownloadManager { for (File f : files) if (f.isDirectory()) collectExeRecursive(f, out); } - static long remainingInstallBytes(List files, File installPath) { - long remaining = 0; - for (DepotFile file : files) { - File output = new File(installPath, file.relativePath); - if (!fileVerified(output, file.totalSize, file.md5)) remaining += file.totalSize; - } - return remaining; - } - - static final class DepotFile { - final String relativePath; - final List chunks = new ArrayList<>(); - String md5; - long totalSize; - DepotFile(String relativePath) { this.relativePath = relativePath; } - static final class ChunkRef { - final String hash, compressedMd5, md5; - final long compressedSize, size; - ChunkRef(String hash, String compressedMd5, String md5, long compressedSize, long size) { - this.hash = hash; this.compressedMd5 = compressedMd5; this.md5 = md5; this.compressedSize = compressedSize; this.size = size; - } - } - } - private static final class Gen1File { final String path, url; final long offset, size; Gen1File(String path, String url, long offset, long size) { this.path = path; this.url = url; this.offset = offset; this.size = size; } @@ -1382,7 +1019,11 @@ public final class GogDownloadManager { String resolved = StoreLanguage.pick(StoreLanguage.codesFromDepots(depots), StoreLanguage.preferredCode()); for (int i = 0; i < depots.length(); i++) { JSONObject depot = depots.getJSONObject(i); - if (depotSelected(depot, resolved)) total += depot.optLong("size", 0); + JSONArray languages = depot.optJSONArray("languages"); + String[] listed = new String[languages == null ? 0 : languages.length()]; + for (int j = 0; j < listed.length; j++) listed[j] = languages.optString(j, ""); + if (listed.length == 0 || StoreLanguage.depotMatchesResolved(listed, resolved)) + total += depot.optLong("size", 0); } return total > 0 ? total : -1; } catch (Exception e) { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogLibrary.kt b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogLibrary.kt index 8f48740ee2..5b8be22303 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogLibrary.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogLibrary.kt @@ -58,16 +58,17 @@ object GogLibrary { val token = GogAuth.validToken(app) ?: return SyncResult.NotLoggedIn onStatus(app.getString(R.string.stores_sync_game_list)) val listing = ownedListing(token) + val account = ownedIds(token) val listed: List = listing?.games - ?: ownedIds(token)?.map { GogGame(it, "", "", "", "", "", 1, null, "", "") } + ?: account?.map { GogGame(it, "", "", "", "", "", 1, null, "", "") } ?: return SyncResult.Failed(app.getString(R.string.stores_sync_gog_unreachable)) val named = listing != null - StoresState.logLine(if (named) "GOG: listing ${listed.size} games" else "GOG: listing unreadable, ${listed.size} owned ids") - val ownedSet = listing?.owned ?: listed.mapTo(HashSet()) { it.gameId } val cachedList = cached(app) + val cachedIds = cachedList.mapTo(HashSet()) { it.gameId } + val ownedSet = ownedSet(listing?.owned ?: listed.mapTo(HashSet()) { it.gameId }, account, cachedIds) + StoresState.logLine(if (named) "GOG: listing ${listed.size} games, ${ownedSet.size} owned ids" else "GOG: listing unreadable, ${listed.size} owned ids") val stale = System.currentTimeMillis() - p.getLong(LAST_SYNC_KEY, 0L) >= THROTTLE_MS val heavy = force || cachedList.isEmpty() || stale - val cachedIds = cachedList.mapTo(HashSet()) { it.gameId } val skipped = java.util.Collections.newSetFromMap(java.util.concurrent.ConcurrentHashMap()) skipped.addAll(p.getStringSet(SKIPPED_KEY, emptySet()).orEmpty()) val idsToFetch = if (heavy) ownedSet.toList() else ownedSet.filter { it !in cachedIds && it !in skipped } @@ -133,6 +134,9 @@ object GogLibrary { return all.ifEmpty { null }?.let { Listing(it, owned) } } + fun ownedSet(listed: Set, account: List?, cached: Set = emptySet()): Set = + if (account == null) listed + cached else listed + account + private fun ownedIds(token: String): List? { val json = StoreNet.get(OWNED_URL, bearer = token, userAgent = GogAuth.GALAXY_UA) ?: return null val owned = runCatching { JSONObject(json).optJSONArray("owned") }.getOrNull() ?: return null diff --git a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogMaintenance.kt b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogMaintenance.kt index 84cb27802d..e024d7d951 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogMaintenance.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogMaintenance.kt @@ -377,16 +377,24 @@ internal object GogMaintenance { val build = GogBuild.select(builds) ?: return null folder.mkdirs() val old = GogInstallRecord(game.gameId, "depot", language = language) - val target = GogContent.snapshot(old, build, GogContent.token(context)) + var credentials: Pair? = null + val target = GogContent.snapshot(old, build, GogContent.token(context), onManifest = { manifest -> + credentials = GogContent.clientCredentials(manifest) + }) GogFiles.validate(target.files, folder) val bytes = target.files.objects().sumOf { it.optJSONArray("chunks")?.objects()?.sumOf { c -> c.optLong("compressedSize") }?.takeIf { n -> n > 0 } ?: it.optLong("size") } val disk = target.files.objects().sumOf { it.optLong("size") } - check(!StoreInstallRoot.insufficientSpace(disk, StoreInstallRoot.availableBytes(folder))) { "Not enough free space for GOG installation" } + val remaining = GogEstimate.calculate(folder, old, target, JSONArray(), reuseChunks = GogNative.isAvailable()).required + check(!StoreInstallRoot.insufficientSpace(remaining, StoreInstallRoot.availableBytes(folder))) { "Not enough free space for GOG installation" } callback.onSizes(bytes, disk) transfer(context, Proposal(folder, old, target, GogOperation.UPDATE, bytes, disk), null, cancelled, callback) if (cancelled.get()) return null target.write(folder) - val task = GogDownloadManager.pickTask(folder, game.gameId, null, game.title) + credentials?.let { (clientId, clientSecret) -> + GogPrefs.get(context).edit().putString("client_id_${game.gameId}", clientId) + .putString("client_secret_${game.gameId}", clientSecret).apply() + } + val task = GogDownloadManager.pickTask(folder, game.gameId, GogContent.tempExecutable(target.manifest), game.title) val result = GogDownloadManager.Result(task?.path ?: "", build.id, disk) result.workDir = task?.workDir result.language = target.language @@ -395,20 +403,6 @@ internal object GogMaintenance { return result } - @JvmStatic - fun captureDepot(id: String, folder: File, build: String, buildsJson: String, manifest: JSONObject, depots: JSONArray, language: String) { - val selected = GogBuild.select(JSONObject(buildsJson), pinned = build) - val files = JSONArray() - for (depot in depots.strings()) for (item in JSONObject(depot).getJSONObject("depot").getJSONArray("items").objects()) { - val chunks = item.optJSONArray("chunks") ?: continue - files.put(JSONObject().put("path", item.getString("path").replace('\\', '/')).put("size", chunks.objects().sumOf { it.optLong("size") }) - .put("md5", item.optString("md5")).put("chunks", chunks).put("product", id)) - } - GogFiles.validate(files, folder) - GogInstallRecord(id, "depot", 2, build, selected?.version.orEmpty(), selected?.branch.orEmpty(), language, - manifest = GogContent.sanitize(manifest), files = files).write(folder) - } - @JvmStatic fun captureOffline(id: String, folder: File, downloads: JSONObject) { val selected = GogOfflineDownload.parse(downloads, "installers").firstOrNull() ?: return diff --git a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogNative.kt b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogNative.kt index 80024ab6ac..0714117eb9 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/gog/GogNative.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/gog/GogNative.kt @@ -6,8 +6,6 @@ import com.droiddeck.launcher.stores.StoresNative object GogNative { private const val TAG = "GogNative" - const val KIND_GEN2_CHUNKS = 0 - const val KIND_GEN1_RANGES = 1 interface Listener { diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftActivation.kt b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftActivation.kt new file mode 100644 index 0000000000..d11fde4210 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftActivation.kt @@ -0,0 +1,74 @@ +package com.droiddeck.launcher.stores.ubisoft + +import android.content.Context +import com.droiddeck.launcher.runtime.LinuxRuntime +import com.droiddeck.launcher.session.SessionState +import com.droiddeck.launcher.stores.StoresState +import org.json.JSONObject +import java.io.File + +/** + * Answers Denuvo activations for a running Ubisoft game. droiddeck-upc.exe writes the challenge + * the game's aux DLL sends to `bridge-/denuvo-.req`; the answer goes to `.rsp`. + */ +object UbisoftActivation { + private const val POLL_MS = 250L + private const val IDLE_MS = 60_000L + private val watching = HashMap() + + fun bridge(context: Context, product: Long) = File(LinuxRuntime.rootDir(context), "root/.cache/droiddeck/ubisoft/bridge-$product") + + /** Starts answering the product's activations; stale requests are cleared before this returns. */ + fun watch(app: Context, product: Long) { + val dir = bridge(app, product) + synchronized(watching) { + val running = watching.containsKey(product) + watching[product] = System.currentTimeMillis() + if (running) return + dir.mkdirs() + dir.listFiles()?.forEach { it.delete() } + } + Thread({ + var idleSince = 0L + while (true) { + runCatching { dir.listFiles { f -> f.name.startsWith("denuvo-") && f.name.endsWith(".req") }?.forEach { answer(app, product, it) } } + .onFailure { StoresState.logLine("Ubisoft: activation for $product: ${it.javaClass.simpleName}") } + val now = System.currentTimeMillis() + if (SessionState.running) idleSince = 0L + else if (idleSince == 0L) idleSince = now + else if (now - idleSince > IDLE_MS) synchronized(watching) { + if (now - (watching[product] ?: 0L) > IDLE_MS) { watching.remove(product); return@Thread } + } + runCatching { Thread.sleep(POLL_MS) } + } + }, "ubisoft-activation-$product").start() + } + + private fun answer(app: Context, product: Long, request: File) { + val challenge = runCatching { request.readBytes() }.getOrNull() ?: return + request.delete() + val reply = File(request.parentFile, request.name.removeSuffix(".req") + ".rsp") + val token = activate(app, product, challenge) + val part = File(reply.path + ".part") + part.writeBytes(token ?: ByteArray(0)) + part.renameTo(reply) + } + + private fun activate(app: Context, product: Long, challenge: ByteArray): ByteArray? { + val s = UbisoftAuth.current(app) ?: return null.also { StoresState.logLine("Ubisoft: activation for $product: signed out") } + val answer = UbisoftNative.call("denuvo", JSONObject().put("ticket", s.ticket).put("sessionId", s.sessionId) + .put("productId", product).put("challenge", hex(challenge))) + answer?.optString("error")?.takeIf { it.isNotEmpty() }?.let { + StoresState.logLine("Ubisoft: activation for $product: $it") + return null + } + val token = answer?.optString("token")?.takeIf { it.isNotEmpty() }?.let(::unhex) + StoresState.logLine("Ubisoft: activation for $product: ${token?.size ?: 0} B game token") + return token + } + + internal fun hex(b: ByteArray): String = b.joinToString("") { "%02x".format(it) } + + internal fun unhex(s: String): ByteArray? = + if (s.length % 2 != 0) null else runCatching { ByteArray(s.length / 2) { s.substring(it * 2, it * 2 + 2).toInt(16).toByte() } }.getOrNull() +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftAuth.kt b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftAuth.kt new file mode 100644 index 0000000000..f1cf2ea84d --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftAuth.kt @@ -0,0 +1,176 @@ +package com.droiddeck.launcher.stores.ubisoft + +import android.content.Context +import android.util.Log +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreAccounts +import org.json.JSONArray +import org.json.JSONObject +import java.net.HttpURLConnection +import java.net.URL +import java.net.URLEncoder + +/** UbiServices sessions: a ticket from Ubisoft's own web sign-in, exchanged for a launcher session that remember-me renews. */ +object UbisoftAuth { + private const val TAG = "UbisoftAuth" + const val SESSIONS = "https://public-ubiservices.ubi.com/v3/profiles/sessions" + + /** The web app and genome connect.ubisoft.com's sign-in page accepts. */ + private const val WEB_APP_ID = "f35adcb5-1911-440c-b1c9-48fdc1701c68" + private const val WEB_GENOME_ID = "5b36b900-65d8-47f3-93c8-86bdaa48ab50" + + /** The Ubisoft Connect PC app id; its sessions are accepted by the library GraphQL and Demux. */ + const val APP_ID = "f68a4bb5-608a-4ff2-8123-be8ef797e0a6" + private const val REFRESH_MARGIN_MS = 10 * 60 * 1000L + private val lock = Any() + + class Session( + val ticket: String, + val sessionId: String, + val profileId: String, + val userId: String, + val name: String, + val expiresAt: Long, + val rememberMe: String, + ) + + class Reply(val status: Int, val body: String, val headers: Map) { + val ok get() = status in 200..299 + } + + private val loggedIn = "https://connect.ubisoft.com/logged-in.html?appId=$WEB_APP_ID&lang=en-US&genomeId=$WEB_GENOME_ID" + val loginUrl = "https://connect.ubisoft.com/login?appId=$WEB_APP_ID&genomeId=$WEB_GENOME_ID&lang=en-US&nextUrl=" + URLEncoder.encode(loggedIn, "UTF-8") + val SIGN_IN_URLS = listOf("https://connect.ubisoft.com", "https://account.ubisoft.com", "https://ubisoft.com") + + fun isLoggedInPage(url: String) = url.startsWith("https://connect.ubisoft.com/logged-in.html") + + /** Reads connect.ubisoft.com's stored sign-in; the WebAuth SDK keeps it under keys holding `loginData` and `rememberMe`. */ + const val PAGE_SCRIPT = "(function(){try{var o={};for(var i=0;i = emptyMap()): Reply { + val c = URL(url).openConnection() as HttpURLConnection + c.requestMethod = method + c.connectTimeout = 15_000 + c.readTimeout = 25_000 + c.setRequestProperty("Ubi-AppId", APP_ID) + c.setRequestProperty("Ubi-RequestedPlatformType", "uplay") + c.setRequestProperty("Content-Type", "application/json") + c.setRequestProperty("User-Agent", "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/122.0.0.0 Safari/537.36") + authorization?.let { c.setRequestProperty("Authorization", it) } + sessionId?.let { c.setRequestProperty("Ubi-SessionId", it) } + for ((k, v) in extra) c.setRequestProperty(k, v) + try { + if (body != null) { + c.doOutput = true + c.outputStream.use { it.write(body.toByteArray()) } + } + val status = c.responseCode + val text = (if (status in 200..299) c.inputStream else c.errorStream)?.use { it.readBytes().toString(Charsets.UTF_8) }.orEmpty() + val headers = c.headerFields.filterKeys { it != null }.mapKeys { it.key.lowercase() }.mapValues { it.value.joinToString(",") } + return Reply(status, text, headers) + } finally { + c.disconnect() + } + } + + /** POSTs a session request, replaying it once when UbiServices answers with a challenge. */ + private fun session(authorization: String): Reply { + val body = JSONObject().put("rememberMe", true).toString() + val first = request(SESSIONS, "POST", authorization, body = body) + val challenge = first.headers["ubi-challenge"] ?: return first + return request(SESSIONS, "POST", authorization, body = body, extra = mapOf("Ubi-Challenge" to challenge)) + } + + internal fun parseSession(body: String, rememberFallback: String = ""): Session? { + val o = runCatching { JSONObject(body) }.getOrNull() ?: return null + val ticket = o.optString("ticket").takeIf { it.isNotEmpty() && it != "null" } ?: return null + return Session( + ticket = ticket, + sessionId = o.optString("sessionId"), + profileId = o.optString("profileId"), + userId = o.optString("userId"), + name = o.optString("nameOnPlatform"), + expiresAt = parseTime(o.optString("expiration")), + rememberMe = o.optString("rememberMeTicket").takeIf { it.isNotEmpty() && it != "null" } ?: rememberFallback, + ) + } + + internal fun parseTime(s: String): Long = runCatching { java.time.OffsetDateTime.parse(s).toInstant().toEpochMilli() } + .recoverCatching { java.time.Instant.parse(s).toEpochMilli() }.getOrDefault(System.currentTimeMillis() + 60 * 60 * 1000L) + + /** Values the web sign-in stored, found wherever the SDK nests them. */ + internal fun webValues(dump: String): Map { + val out = HashMap() + fun walk(v: Any?) { + when (v) { + is JSONObject -> v.keys().forEach { k -> + val x = v.opt(k) + if (x is String && x.isNotEmpty() && k !in out) { + val nested = if (x.startsWith("{") || x.startsWith("[")) runCatching { org.json.JSONTokener(x).nextValue() }.getOrNull() else null + if (nested != null) walk(nested) else out[k] = x + } else walk(x) + } + is JSONArray -> for (i in 0 until v.length()) walk(v.opt(i)) + } + } + val top = runCatching { org.json.JSONTokener(dump).nextValue() }.getOrNull() + walk(if (top is String) runCatching { JSONObject(top) }.getOrNull() else top) + return out + } + + /** Turns the page's stored sign-in into a launcher session; returns null on success or a reason. */ + fun completeWebSignIn(context: Context, dump: String): String? { + val web = webValues(dump) + val ticket = web["ticket"] + val remember = web["rememberMeTicket"].orEmpty() + val fresh = when { + ticket != null -> session("ubi_v1 t=$ticket").let { r -> + parseSession(r.body, remember) ?: run { Log.w(TAG, "ticket exchange: ${r.status} ${r.body.take(200)}"); null } + } + else -> null + } ?: remember.takeIf { it.isNotEmpty() }?.let { rm -> parseSession(session("rm_v1 t=$rm").body, rm) } + ?: return "no ticket" + save(context, fresh) + com.droiddeck.launcher.session.SessionFiles.ensureUbisoftService(context) + return null + } + + private fun save(context: Context, s: Session) { + val name = s.name.ifEmpty { profileName(s) } + StoreAccounts.write(context.applicationContext, Store.UBISOFT, JSONObject() + .put("access_token", s.ticket) + .put("session_id", s.sessionId) + .put("profile_id", s.profileId) + .put("user_id", s.userId) + .put("display_name", name) + .put("expires_at", s.expiresAt) + .put("remember_me", s.rememberMe)) + } + + private fun profileName(s: Session): String = runCatching { + JSONObject(request("https://public-ubiservices.ubi.com/v3/profiles/me", authorization = "ubi_v1 t=${s.ticket}", sessionId = s.sessionId).body).optString("nameOnPlatform") + }.getOrDefault("") + + fun load(context: Context): Session? { + val o = StoreAccounts.read(context.applicationContext, Store.UBISOFT) ?: return null + val ticket = o.optString("access_token").takeIf { it.isNotEmpty() } ?: return null + return Session(ticket, o.optString("session_id"), o.optString("profile_id"), o.optString("user_id"), o.optString("display_name"), o.optLong("expires_at"), o.optString("remember_me")) + } + + /** A live session, renewed through remember-me shortly before it expires. */ + fun current(context: Context): Session? = synchronized(lock) { + val s = load(context) ?: return null + if (s.expiresAt - System.currentTimeMillis() > REFRESH_MARGIN_MS || s.rememberMe.isEmpty()) return s + val renewed = runCatching { session("rm_v1 t=${s.rememberMe}") }.getOrNull()?.let { parseSession(it.body, s.rememberMe) } + if (renewed == null) { + Log.w(TAG, "remember-me renewal failed") + return if (s.expiresAt > System.currentTimeMillis()) s else null + } + save(context, Session(renewed.ticket, renewed.sessionId, renewed.profileId.ifEmpty { s.profileId }, renewed.userId.ifEmpty { s.userId }, + renewed.name.ifEmpty { s.name }, renewed.expiresAt, renewed.rememberMe)) + load(context) + } + + fun signOut(context: Context) = synchronized(lock) { StoreAccounts.clear(context.applicationContext, Store.UBISOFT) } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftBackend.kt b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftBackend.kt new file mode 100644 index 0000000000..09008e1927 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftBackend.kt @@ -0,0 +1,246 @@ +package com.droiddeck.launcher.stores.ubisoft + +import android.content.Context +import android.content.Intent +import android.util.Log +import android.webkit.WebView +import com.droiddeck.launcher.R +import com.droiddeck.launcher.stores.CatalogItem +import com.droiddeck.launcher.stores.InstalledStoreGame +import com.droiddeck.launcher.stores.LoginFlows +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreBackend +import com.droiddeck.launcher.stores.StoreInstallRoot +import com.droiddeck.launcher.stores.download.DownloadEntry +import com.droiddeck.launcher.stores.download.DownloadQueue +import com.droiddeck.launcher.stores.StoreLoginActivity +import com.droiddeck.launcher.stores.StoresState +import com.droiddeck.launcher.stores.WebCookies +import org.json.JSONObject + +object UbisoftBackend : StoreBackend { + override val store: Store = Store.UBISOFT + + init { + LoginFlows.ubisoftFlow = { ua -> UbisoftLogin(ua) } + } + + override fun signIn(context: Context) { + context.startActivity( + Intent(context, StoreLoginActivity::class.java) + .putExtra(StoreLoginActivity.EXTRA_STORE, store.id) + .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK), + ) + } + + override fun signOut(context: Context) { + UbisoftAuth.signOut(context.applicationContext) + UbisoftLibrary.reset() + runCatching { WebCookies.expire(UbisoftAuth.SIGN_IN_URLS, ".ubisoft.com", listOf("/")) {} } + } + + override fun syncLibrary(context: Context, force: Boolean) { + val app = context.applicationContext + Thread({ UbisoftLibrary.sync(app, force) }, "ubisoft-sync").start() + } + + override fun loadShelves(context: Context, force: Boolean) {} + + override fun install(context: Context, item: CatalogItem, root: java.io.File) { + val app = context.applicationContext + item.extra[STEAM_APP]?.takeIf { item.extra["productId"] == null }?.let { steam -> + StoresState.logLine("Ubisoft: ${item.title} is owned on Steam; installing Steam app $steam") + installInSteam(app, steam) + return + } + if (!UbisoftNative.ready()) { + StoresState.logLine(UbisoftNative.ENGINE_MISSING) + StoresState.post { StoresState.problems[store] = UbisoftNative.ENGINE_MISSING } + return + } + val folder = StoreInstallRoot.folderFor(app, store, item.id, item.title, root) + val entry = DownloadEntry(store, item.id, item.title, cover = item.tallImageUrl ?: item.imageUrl, + bytesTotal = item.sizeBytes, location = StoreInstallRoot.labelFor(app, folder)) + DownloadQueue.enqueue(app, entry) { UbisoftInstaller(app, item, folder) } + } + + override fun uninstall(context: Context, game: InstalledStoreGame) {} + + const val STEAM_APP = "steamAppId" + + /** Steam asks to install a game it does not have when told to run it. */ + private fun installInSteam(app: Context, steamAppId: String) { + if (com.droiddeck.launcher.session.SessionState.running) { + if (!com.droiddeck.launcher.session.SessionService.launchGame(app, steamAppId)) StoresState.logLine("Ubisoft: Steam is busy; install Steam app $steamAppId there") + return + } + app.startActivity(Intent(app, com.droiddeck.launcher.SessionActivity::class.java) + .putExtra(com.droiddeck.launcher.session.SessionService.EXTRA_STEAM_URL, com.droiddeck.launcher.frontend.GameLaunchLink.steamUrl(steamAppId)) + .addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)) + } +} + +internal class UbisoftLogin(override val userAgent: String) : StoreLoginActivity.Flow { + override val startUrl: String get() = UbisoftAuth.loginUrl + override val readsPage: Boolean get() = true + override val pageScript: String get() = UbisoftAuth.PAGE_SCRIPT + override fun pageReady(result: String): Boolean = result.contains("ticket", ignoreCase = true) + override fun isRedirect(url: String): Boolean = UbisoftAuth.isLoggedInPage(url) + + override fun forgetSignIn(done: () -> Unit) { + runCatching { WebCookies.expire(UbisoftAuth.SIGN_IN_URLS, ".ubisoft.com", listOf("/")) { done() } }.onFailure { done() } + } + + override fun finish(activity: StoreLoginActivity, view: WebView, url: String): String? = try { + UbisoftAuth.completeWebSignIn(activity, url)?.let { + Log.w("UbisoftLogin", "sign-in incomplete: $it") + activity.getString(R.string.stores_login_error_verification) + } + } catch (e: Exception) { + Log.w("UbisoftLogin", "sign-in failed: ${e.javaClass.simpleName}") + activity.getString(R.string.stores_login_error_generic) + } +} + +object UbisoftLibrary { + private const val GRAPHQL = "https://public-ubiservices.ubi.com/v1/profiles/me/uplay/graphql" + private const val PAGE = 50 + private const val QUERY = "query OwnedGames(\$limit: Int, \$offset: Int) { viewer { games(limit: \$limit, offset: \$offset) { totalCount nodes { id spaceId name coverUrl backgroundUrl bannerUrl releaseDate } } } }" + private val generation = java.util.concurrent.atomic.AtomicInteger() + private val running = java.util.concurrent.atomic.AtomicReference(null) + + /** Forgets the signed-out account: its sync results are dropped and a new account may sync at once. */ + fun reset() { + generation.incrementAndGet() + StoresState.post { StoresState.shelves.remove(Store.UBISOFT) } + } + + private fun post(gen: Int, block: () -> Unit) = StoresState.post { if (generation.get() == gen) block() } + + internal fun parsePage(body: String): Pair, Int> { + val o = JSONObject(body) + o.optJSONArray("errors")?.optJSONObject(0)?.let { throw IllegalStateException(it.optString("message")) } + val games = o.optJSONObject("data")?.optJSONObject("viewer")?.optJSONObject("games") ?: return emptyList() to 0 + val nodes = games.optJSONArray("nodes") + val items = (0 until (nodes?.length() ?: 0)).mapNotNull { nodes!!.optJSONObject(it) }.mapNotNull { n -> + val space = n.optString("spaceId").takeIf { it.isNotEmpty() } ?: return@mapNotNull null + fun s(k: String) = n.optString(k).takeIf { it.isNotEmpty() && it != "null" } + CatalogItem( + Store.UBISOFT, space, n.optString("name").trim(), s("backgroundUrl") ?: s("bannerUrl"), + tallImageUrl = s("coverUrl"), releaseDate = s("releaseDate")?.take(10).orEmpty(), owned = true, + extra = mapOf("spaceId" to space, "gameId" to n.optString("id")), + ) + } + return items to games.optInt("totalCount", items.size) + } + + /** Base games with a manifest, by UbiServices space; add-ons and bundles share spaces with their game. */ + internal fun ownedBySpace(owned: JSONObject?): Map { + val list = owned?.optJSONArray("games") ?: return emptyMap() + val games = (0 until list.length()).mapNotNull { list.optJSONObject(it) } + .filter { it.optString("manifest").isNotEmpty() && it.optInt("productType") == 0 && it.optBoolean("owned", true) } + val out = LinkedHashMap() + for (key in listOf("spaceId")) for (g in games) { + val space = g.optString(key).takeIf { it.isNotEmpty() } ?: continue + out.putIfAbsent(space, g) + } + return out + } + + private val STEAM_ID = Regex("""^\s*steam_app_id:\s*['"]?(\d+)""", RegexOption.MULTILINE) + private val THIRD_PARTY = Regex("""^\s*third_party_platform:\s*\r?\n\s+name:\s*['"]?Steam\b""", setOf(RegexOption.MULTILINE, RegexOption.IGNORE_CASE)) + + /** The Steam app of a product Ubisoft says is owned and installed through Steam. */ + internal fun steamApp(configuration: String): String? = + if (THIRD_PARTY.containsMatchIn(configuration)) STEAM_ID.find(configuration)?.groupValues?.get(1) else null + + /** Owned games Ubisoft delivers through Steam, by UbiServices space. */ + internal fun steamBySpace(owned: JSONObject?): Map { + val list = owned?.optJSONArray("games") ?: return emptyMap() + return (0 until list.length()).mapNotNull { list.optJSONObject(it) } + .filter { it.optInt("productType") == 0 && it.optBoolean("owned", true) && it.optString("spaceId").isNotEmpty() } + .mapNotNull { o -> steamApp(o.optString("configuration"))?.let { o.optString("spaceId") to it } }.toMap() + } + + private val RELATIVE = Regex("""relative:\s*['"]?([^'"\r\n]+?)['"]?\s*$""", RegexOption.MULTILINE) + + private val NAME = Regex("""^\s{1,4}name:\s*['"]?(.+?)['"]?\s*$""", RegexOption.MULTILINE) + + /** The product's name from its configuration, following a localisation key such as `l1` to its default text. */ + internal fun title(configuration: String): String? { + val raw = NAME.find(configuration)?.groupValues?.get(1)?.trim()?.takeIf { it.isNotEmpty() } ?: return null + if (!Regex("""l\d+""").matches(raw)) return raw + val local = configuration.indexOf("localizations:").takeIf { it >= 0 } ?: return raw + return Regex("""^\s+${raw}:\s*['"]?(.+?)['"]?\s*$""", RegexOption.MULTILINE).find(configuration, local)?.groupValues?.get(1)?.trim() ?: raw + } + + /** The first launch path under `start_game` in a product's configuration. */ + internal fun executable(configuration: String): String? { + val start = configuration.indexOf("start_game").takeIf { it >= 0 } ?: return null + return RELATIVE.find(configuration, start)?.groupValues?.get(1)?.trim()?.takeIf { it.endsWith(".exe", true) } + } + + fun sync(app: Context, force: Boolean) { + val gen = generation.get() + if (running.getAndSet(gen) == gen) return + try { + val s = UbisoftAuth.current(app) + if (s == null) { + post(gen) { StoresState.status.remove(Store.UBISOFT); StoresState.problems[Store.UBISOFT] = app.getString(R.string.stores_sync_sign_in) } + return + } + if (StoresState.library[Store.UBISOFT].isNullOrEmpty()) post(gen) { StoresState.status[Store.UBISOFT] = app.getString(R.string.stores_sync_game_list) } + val all = ArrayList() + var offset = 0 + while (true) { + val body = JSONObject().put("operationName", "OwnedGames").put("query", QUERY) + .put("variables", JSONObject().put("limit", PAGE).put("offset", offset)).toString() + val reply = UbisoftAuth.request(GRAPHQL, "POST", "Ubi_v1 t=${s.ticket}", s.sessionId, body) + if (reply.status == 401) StoresState.markSignInExpired(Store.UBISOFT) + if (!reply.ok) throw IllegalStateException("library ${reply.status}") + val (items, total) = parsePage(reply.body) + all += items + offset += PAGE + if (items.isEmpty() || offset >= total) break + } + val owned = UbisoftNative.call("owned", JSONObject().put("ticket", s.ticket).put("sessionId", s.sessionId)) + owned?.optString("error")?.takeIf { it.isNotEmpty() }?.let { StoresState.logLine("Ubisoft: ownership: $it") } + val bySpace = ownedBySpace(owned) + owned?.takeIf { it.optInt("manifestsAsked") > 0 }?.let { + StoresState.logLine("Ubisoft: latest manifests: ${it.optInt("manifestsFound")} of ${it.optInt("manifestsAsked")} ${it.optString("manifestError")}".trim()) + } + fun download(o: JSONObject) = listOfNotNull( + "productId" to o.optLong("productId").toString(), + o.optString("manifest").takeIf { it.isNotEmpty() }?.let { "manifest" to it }, + o.optString("appId").takeIf { it.isNotEmpty() }?.let { "appId" to it }, + executable(o.optString("configuration"))?.let { "exe" to it }, + ) + val listed = all.distinctBy { it.id } + val onSteam = steamBySpace(owned) + val matched = listed.map { g -> bySpace[g.id]?.let { g.copy(extra = g.extra + download(it)) } ?: onSteam[g.id]?.let { g.copy(extra = g.extra + (UbisoftBackend.STEAM_APP to it)) } ?: g } + .let { games -> games.filter { g -> g.extra["productId"] == null || games.first { it.extra["productId"] == g.extra["productId"] } === g } } + .let { games -> games.filter { g -> g.extra["productId"] != null || games.none { it !== g && it.title == g.title && it.extra["productId"] != null } } } + val products = matched.mapNotNull { it.extra["productId"] }.toSet() + val unlisted = bySpace.filterKeys { space -> listed.none { it.id == space } }.filterValues { it.optLong("productId").toString() !in products }.mapNotNull { (space, o) -> + val title = title(o.optString("configuration")) ?: return@mapNotNull null + CatalogItem(Store.UBISOFT, space, title, null, owned = true, extra = mapOf("spaceId" to space) + download(o)) + } + val games = (matched + unlisted).sortedBy { it.title.lowercase() } + StoresState.logLine("Ubisoft: ${bySpace.size} downloadable products; " + + games.filter { it.extra.containsKey("productId") }.joinToString(", ") { "${it.title}=${it.extra["productId"]}" }) + post(gen) { + StoresState.status.remove(Store.UBISOFT) + StoresState.problems.remove(Store.UBISOFT) + StoresState.library[Store.UBISOFT] = games + StoresState.shelves[Store.UBISOFT] = com.droiddeck.launcher.stores.StoreShelves( + trending = games.sortedByDescending { it.extra.containsKey("productId") }, art = games.mapNotNull { it.imageUrl }) + } + StoresState.logLine("Ubisoft: ${games.size} owned games; on Steam: " + games.filter { it.extra.containsKey(UbisoftBackend.STEAM_APP) }.joinToString(", ") { "${it.title}=${it.extra[UbisoftBackend.STEAM_APP]}" }) + } catch (e: Exception) { + StoresState.logLine("Ubisoft: library sync failed: ${e.javaClass.simpleName} ${e.message.orEmpty().take(200)}") + post(gen) { StoresState.status.remove(Store.UBISOFT); StoresState.problems[Store.UBISOFT] = app.getString(R.string.stores_sync_failed) } + } finally { + running.compareAndSet(gen, null) + } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftConnect.kt b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftConnect.kt new file mode 100644 index 0000000000..23cc92cd20 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftConnect.kt @@ -0,0 +1,18 @@ +package com.droiddeck.launcher.stores.ubisoft + +import android.content.Context +import com.droiddeck.launcher.frontend.AddedGames +import com.droiddeck.launcher.runtime.LinuxRuntime +import java.io.File + +/** The one prefix every Ubisoft game runs in, so Ubisoft Connect is installed and signed in once. */ +object UbisoftConnect { + const val APP_ID = 2929927072L + + fun prefix(context: Context) = File(LinuxRuntime.rootDir(context), "root/.local/share/Steam/steamapps/compatdata/$APP_ID") + + fun installed(context: Context) = File(prefix(context), "pfx/drive_c/Program Files (x86)/Ubisoft/Ubisoft Game Launcher/upc.exe").isFile + + fun launchOptions(context: Context): String = + AddedGames.guestPath(context, prefix(context))?.let { "STEAM_COMPAT_DATA_PATH=$it %command%" }.orEmpty() +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftInstaller.kt b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftInstaller.kt new file mode 100644 index 0000000000..1bf4c4e360 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftInstaller.kt @@ -0,0 +1,104 @@ +package com.droiddeck.launcher.stores.ubisoft + +import android.content.Context +import com.droiddeck.launcher.R +import com.droiddeck.launcher.stores.CatalogItem +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreExe +import com.droiddeck.launcher.stores.StoreGameSidecar +import com.droiddeck.launcher.stores.StoreInstalls +import com.droiddeck.launcher.stores.StoreLanguage +import com.droiddeck.launcher.stores.amazon.AmazonNative +import com.droiddeck.launcher.stores.download.DownloadQueue +import com.droiddeck.launcher.stores.download.DownloadStage +import org.json.JSONObject +import java.io.File +import java.util.concurrent.atomic.AtomicBoolean +import java.util.concurrent.atomic.AtomicLong + +internal class UbisoftInstaller( + private val app: Context, + private val item: CatalogItem, + private val folder: File, +) : DownloadQueue.DownloadJob { + private val cancelled = AtomicBoolean(false) + + override fun run(handle: DownloadQueue.JobHandle): String? { + handle.stage(DownloadStage.MANIFEST, app.getString(R.string.stores_sync_sign_in)) + val s = UbisoftAuth.current(app) ?: throw IllegalStateException("Not signed in to Ubisoft") + val product = item.extra["productId"]?.toLongOrNull() ?: throw IllegalStateException("Ubisoft lists no download for ${item.title} on this account") + val cover = item.tallImageUrl ?: item.imageUrl + StoreInstalls.begin(folder, Store.UBISOFT, item.id, item.title, cover, item.imageUrl) + if (cancelled.get()) return null + val locale = StoreLanguage.localeFor(null, app) + val request = JSONObject() + .put("ticket", s.ticket) + .put("sessionId", s.sessionId) + .put("productId", product) + .put("manifest", item.extra["manifest"].orEmpty()) + .put("folder", folder.absolutePath) + .put("language", "${locale.language}-${locale.country}") + val shown = AtomicLong(-1) + val downloading = AtomicBoolean(false) + val listener = object : AmazonNative.InstallListener { + override fun onStatus(text: String) { handle.stage(DownloadStage.MANIFEST, text) } + override fun onCheck(doneBytes: Long, totalBytes: Long, files: Int, filesTotal: Int) { + handle.stageProgress(doneBytes, totalBytes, files, filesTotal, bytes = true) + } + override fun onSizes(pendingBytes: Long, totalBytes: Long) { handle.diskSize(totalBytes) } + override fun onProgress(done: Long, total: Long, files: Int, filesTotal: Int) { + if (downloading.compareAndSet(false, true)) handle.stage(DownloadStage.DOWNLOAD) + while (true) { + val before = shown.get() + if (done < before) return + if (shown.compareAndSet(before, done)) break + } + handle.progress(done, total, "Downloading ($files/$filesTotal files)") + } + override fun onLog(line: String) { handle.log(line) } + override fun beforeReplace(): Boolean = true + override fun onComplete(success: Boolean, cancelled: Boolean, error: String, result: String) = Unit + } + val outcome = UbisoftNative.install(request, listener, cancelled) + if (outcome.cancelled || cancelled.get() && !outcome.success) return null + if (!outcome.success) throw IllegalStateException(outcome.error.ifEmpty { "The Ubisoft install failed" }) + + handle.stage(DownloadStage.INSTALL, app.getString(R.string.stores_registering)) + val configured = resolve(folder, item.extra["exe"].orEmpty()) + val exe = configured ?: StoreExe.pick(folder, null, item.title).ifEmpty { "game.exe" } + handle.log("ubisoft: exe=$exe") + val sidecar = StoreGameSidecar( + Store.UBISOFT, item.id, item.title, exe = exe, + installVersion = item.extra["manifest"].orEmpty(), installedAt = System.currentTimeMillis(), + cover = cover, hero = item.imageUrl, cloud = false, + extra = item.extra.filterKeys { it in KEPT } + listOfNotNull( + outcome.result?.optJSONArray("chunks")?.let { UbisoftLaunch.CHUNKS to it.toString() }, + outcome.result?.optJSONObject("setup")?.let { UbisoftLaunch.SETUP to it.toString() }, + ), + ) + StoreInstalls.complete(app, folder, sidecar, onStep = { done, steps -> handle.stageProgress(done.toLong(), steps.toLong()) }) + return folder.path + } + + override fun cancel(deleteFiles: Boolean) { + cancelled.set(true) + if (deleteFiles) StoreInstalls.discard(app, folder, emptyList()) + } + + internal companion object { + val KEPT = setOf("productId", "spaceId", "manifest", "appId") + + /** A configured exe the way Windows finds it: any letter case, else the same file name anywhere in the install. */ + fun resolve(folder: File, configured: String): String? { + val rel = configured.replace('\\', '/').trimStart('/').takeIf { it.isNotEmpty() } ?: return null + var at = folder + for (part in rel.split('/')) { + at = at.listFiles()?.firstOrNull { it.name.equals(part, ignoreCase = true) } ?: return byName(folder, rel.substringAfterLast('/')) + } + return if (at.isFile) at.relativeTo(folder).invariantSeparatorsPath else byName(folder, rel.substringAfterLast('/')) + } + + private fun byName(folder: File, name: String): String? = + folder.walkTopDown().maxDepth(5).firstOrNull { it.isFile && it.name.equals(name, ignoreCase = true) }?.relativeTo(folder)?.invariantSeparatorsPath + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftLaunch.kt b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftLaunch.kt new file mode 100644 index 0000000000..279d3b3e43 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftLaunch.kt @@ -0,0 +1,86 @@ +package com.droiddeck.launcher.stores.ubisoft + +import android.content.Context +import com.droiddeck.launcher.stores.StoreInstallRoot +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreGameSidecar +import com.droiddeck.launcher.stores.StoresState +import org.json.JSONArray +import org.json.JSONObject + +/** What the launcher service hands a starting Ubisoft game: the account, its products and a fresh game ticket. */ +object UbisoftLaunch { + private const val ENTITLEMENTS = "https://public-ubiservices.ubi.com/v1/profiles/me/global/ubiconnect/entitlement/api/entitlements" + private const val ME = "https://public-ubiservices.ubi.com/v3/users/me" + + fun prepare(app: Context, id: String): JSONObject { + val folder = StoreInstallRoot.gameFolders(app).firstOrNull { f -> + StoreGameSidecar.read(f)?.let { it.store == Store.UBISOFT && it.id == id } == true + } ?: return failure("not-installed") + val sidecar = StoreGameSidecar.read(folder) ?: return failure("not-installed") + val product = sidecar.extra["productId"]?.toLongOrNull() ?: return failure("no-product") + val s = UbisoftAuth.current(app) ?: return failure("signed-out") + val native = UbisoftNative.call("launch", JSONObject().put("ticket", s.ticket).put("sessionId", s.sessionId).put("productId", product)) + ?: return failure("engine-missing") + native.optString("error").takeIf { it.isNotEmpty() }?.let { + StoresState.logLine("Ubisoft: launch ticket for $product: $it") + return failure("ticket: $it") + } + val auth = "Ubi_v1 t=${s.ticket}" + val me = runCatching { UbisoftAuth.request(ME, "GET", auth, s.sessionId) }.getOrNull()?.takeIf { it.ok } + ?.let { runCatching { JSONObject(it.body) }.getOrNull() } + val account = JSONObject() + .put("userId", s.userId) + .put("username", me?.optString("username")?.takeIf { it.isNotEmpty() } ?: s.name) + .put("nameOnPlatform", me?.optString("nameOnPlatform")?.takeIf { it.isNotEmpty() } ?: s.name) + .put("email", me?.optString("email").orEmpty()) + .put("country", me?.optString("country")?.takeIf { it.isNotEmpty() } ?: "US") + val appId = runCatching { UbisoftAuth.request(ENTITLEMENTS, "GET", auth, s.sessionId) }.getOrNull()?.takeIf { it.ok } + ?.let { applicationId(it.body, product) } ?: sidecar.extra["appId"].orEmpty() + StoresState.logLine("Ubisoft: launch ticket for $product ready (${native.optJSONArray("owned")?.length() ?: 0} products, appId ${if (appId.isEmpty()) "unknown" else "found"})") + val language = com.droiddeck.launcher.stores.StoreLanguage.localeFor(null, app).let { "${it.language}-${it.country}" } + val cached = sidecar.extra[CHUNKS]?.let { runCatching { JSONArray(it) }.getOrNull() } + var setup = sidecar.extra[SETUP]?.let { runCatching { JSONObject(it) }.getOrNull() } + val chunks = if (cached != null && setup != null) cached else + UbisoftNative.call("chunks", JSONObject().put("ticket", s.ticket).put("sessionId", s.sessionId).put("productId", product) + .put("manifest", sidecar.extra["manifest"] ?: sidecar.installVersion).put("folder", folder.path).put("language", language)) + ?.let { r -> + r.optString("error").takeIf { it.isNotEmpty() }?.let { StoresState.logLine("Ubisoft: manifest for $product: $it") } + setup = r.optJSONObject("setup") + r.optJSONArray("chunks") + }?.also { c -> + runCatching { + StoreGameSidecar.read(folder)?.let { sc -> + sc.copy(extra = sc.extra + (CHUNKS to c.toString()) + listOfNotNull(setup?.let { SETUP to it.toString() })).write(folder) + } + com.droiddeck.launcher.stores.StoreLaunch.installedGame(app, Store.UBISOFT, id) + ?.let { com.droiddeck.launcher.frontend.AutoComponents.refreshLater(app, it) } + } + } ?: cached + setup?.let { StoresState.logLine("Ubisoft: setup for $product: ${it.toString().take(1500)}") } + UbisoftActivation.watch(app, product) + return JSONObject().put("ok", true) + .put("productId", product) + .put("ticket", native.optString("ticket")) + .put("owned", native.optJSONArray("owned") ?: JSONArray()) + .put("products", native.optJSONArray("products") ?: JSONArray()) + .put("account", account) + .put("appId", appId) + .put("language", language) + .put("chunks", chunks ?: JSONArray()) + .put("registry", setup?.optJSONArray("registry") ?: JSONArray()) + } + + const val CHUNKS = "chunks" + const val SETUP = "setup" + + /** The entitlement's `applicationId` for the product; the list sits under one of a few keys depending on the API version. */ + internal fun applicationId(body: String, product: Long): String? { + val root = runCatching { JSONObject(body) }.getOrNull() ?: return null + val list = sequenceOf("items", "entitlements", "products", "games", "results").firstNotNullOfOrNull { root.optJSONArray(it) } ?: return null + return (0 until list.length()).mapNotNull { list.optJSONObject(it) } + .firstOrNull { it.optLong("productId") == product }?.optString("applicationId")?.takeIf { it.isNotEmpty() } + } + + private fun failure(reason: String) = JSONObject().put("ok", false).put("reason", reason) +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftNative.kt b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftNative.kt new file mode 100644 index 0000000000..7a7d2eb881 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/stores/ubisoft/UbisoftNative.kt @@ -0,0 +1,57 @@ +package com.droiddeck.launcher.stores.ubisoft + +import android.util.Log +import com.droiddeck.launcher.stores.StoresNative +import com.droiddeck.launcher.stores.amazon.AmazonNative +import org.json.JSONObject +import java.util.concurrent.CountDownLatch +import java.util.concurrent.TimeUnit +import java.util.concurrent.atomic.AtomicBoolean + +object UbisoftNative { + private const val TAG = "UbisoftNative" + const val ENGINE_MISSING = "Ubisoft: the store engine is not available" + + fun ready(): Boolean = StoresNative.ensureLoaded() + + fun call(op: String, request: JSONObject): JSONObject? { + if (!ready()) return null + val text = try { nativeCall(op, request.toString()) } catch (t: Throwable) { + Log.w(TAG, "$op: ${t.javaClass.simpleName}") + null + } ?: return null + return runCatching { JSONObject(text) }.getOrNull() + } + + fun install(request: JSONObject, events: AmazonNative.InstallListener, cancelled: AtomicBoolean): AmazonNative.InstallOutcome { + if (!ready()) return AmazonNative.InstallOutcome(false, false, ENGINE_MISSING, null) + val done = CountDownLatch(1) + val holder = arrayOfNulls(1) + val bridge = object : AmazonNative.InstallListener by events { + override fun onComplete(success: Boolean, cancelled: Boolean, error: String, result: String) { + holder[0] = AmazonNative.InstallOutcome(success, cancelled, error, result.takeIf { it.isNotEmpty() }?.let { runCatching { JSONObject(it) }.getOrNull() }) + done.countDown() + } + } + val handle = try { nativeInstall(request.toString(), bridge) } catch (t: Throwable) { + return AmazonNative.InstallOutcome(false, false, "The Ubisoft install could not start: ${t.javaClass.simpleName}", null) + } + if (handle == 0L) return holder[0] ?: AmazonNative.InstallOutcome(false, false, "The Ubisoft install could not start", null) + try { + var forwarded = false + while (true) { + val finished = try { done.await(250, TimeUnit.MILLISECONDS) } catch (e: InterruptedException) { cancelled.set(true); false } + if (finished) break + if (!forwarded && cancelled.get()) { nativeCancel(handle); forwarded = true } + } + } finally { + nativeRelease(handle) + } + return holder[0] ?: AmazonNative.InstallOutcome(false, false, "The Ubisoft install ended without a result", null) + } + + @JvmStatic private external fun nativeCall(op: String, request: String): String? + @JvmStatic private external fun nativeInstall(request: String, listener: AmazonNative.InstallListener): Long + @JvmStatic private external fun nativeCancel(handle: Long) + @JvmStatic private external fun nativeRelease(handle: Long) +} diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt index c8b126519f..59403dac0f 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/XboxCredentials.kt @@ -64,15 +64,32 @@ internal class XboxCredentials(private val app: Context, expectedGeneration: Str if (root <= 0 || pid <= 0) return null val status = java.io.File("/proc/$pid/status").readLines() val tracer = status.first { it.startsWith("TracerPid:") }.substringAfter(':').trim().toInt() - val tracerGroup = java.io.File("/proc/$tracer/status").readLines() - .first { it.startsWith("Tgid:") }.substringAfter(':').trim().toInt() - if (tracerGroup != root) return null + if (tracer != 0) { + // under proot, every guest process is traced by the proot the app started + val tracerGroup = java.io.File("/proc/$tracer/status").readLines() + .first { it.startsWith("Tgid:") }.substringAfter(':').trim().toInt() + if (tracerGroup != root) return null + } else if (!descendsFrom(pid, root)) { + // without proot, the process the app started is the backend itself (or its parent) + return null + } val executable = android.system.Os.stat(binary.path) if (!mapsBackend(java.io.File("/proc/$pid/maps").readText(), binary.path, executable.st_ino)) return null return java.io.File("/proc/$pid/stat").readText().substringAfterLast(") ").split(' ')[19] + ":${executable.st_dev}:${executable.st_ino}" } + private fun descendsFrom(pid: Int, root: Int): Boolean { + var current = pid + repeat(32) { + if (current == root) return true + if (current <= 1) return false + current = java.io.File("/proc/$current/status").readLines() + .firstOrNull { it.startsWith("PPid:") }?.substringAfter(':')?.trim()?.toIntOrNull() ?: return false + } + return false + } + fun signalBackend(signal: Int) { val process = backend ?: return if (!process.isAlive) return diff --git a/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt b/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt index f803d06416..f27794d1b5 100644 --- a/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt +++ b/app/src/main/java/com/droiddeck/launcher/stores/xbox/Xodus.kt @@ -88,7 +88,8 @@ internal object Xodus { val fastPathPreloaded = runCatching { File(root, "etc/ld.so.preload").useLines { lines -> lines.any { it.trim() == ProotFastPath.LIBRARY } } }.getOrDefault(false) - val fastPathKey = if (ProotFastPath.enabled(app) && fastPathPreloaded && + val native = com.droiddeck.launcher.runtime.NativeGuest.forSession(app) + val fastPathKey = if (!native && ProotFastPath.enabled(app) && fastPathPreloaded && File(root, ProotFastPath.LIBRARY.removePrefix("/")).isFile) ProotFastPath.key(root, binds) else null val guestCommand = mutableListOf( "/usr/bin/env", "HOME=/root", "XODUS_LOG=off", "RUST_LOG=off", @@ -98,12 +99,12 @@ internal object Xodus { guestCommand.addAll(guestCommand.lastIndex, ProotFastPath.guestEnv(root, binds, key)) } guestCommand.addAll(args) - val command = LinuxRuntime.commandWithBinds(app, root, binds, guestCommand) - val builder = ProcessBuilder(command).directory(LinuxRuntime.rootDir(app)) + val builder = if (native) com.droiddeck.launcher.runtime.NativeGuest.processBuilder(app, root, binds, guestCommand) + else ProcessBuilder(LinuxRuntime.commandWithBinds(app, root, binds, guestCommand)).directory(LinuxRuntime.rootDir(app)) if (launchDirectory != null) builder.environment()["TMPDIR"] = launchDirectory.path builder.environment()["DROIDDECK_XBOX_CREDENTIAL_PORT"] = credentials.port.toString() builder.environment()["DROIDDECK_XBOX_CREDENTIAL_KEY"] = credentials.key - builder.environment().apply { + if (!native) builder.environment().apply { remove("LD_PRELOAD"); remove("LD_AUDIT"); remove("LD_LIBRARY_PATH") put("PROOT_LOADER", LinuxRuntime.prootLoader(app).path) put("PROOT_TMP_DIR", LinuxRuntime.prootTempDir(app).path) diff --git a/app/src/main/java/com/droiddeck/launcher/ui/AddAppDialog.kt b/app/src/main/java/com/droiddeck/launcher/ui/AddAppDialog.kt index 660e0723c0..8e7aaf9966 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/AddAppDialog.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/AddAppDialog.kt @@ -151,7 +151,7 @@ internal fun AddAppDialog(runtimeReady: Boolean, onDismiss: () -> Unit, onAdd: ( ?.let { UserApps.Request(UserApps.Source.Script(it), custom, iconPath) to (custom ?: it.nameWithoutExtension) } AddSource.APPIMAGE -> imagePath?.takeIf { it.endsWith(".appimage", ignoreCase = true) }?.let { File(it) } ?.let { UserApps.Request(UserApps.Source.AppImage(it), custom, iconPath) to (custom ?: it.nameWithoutExtension) } - AddSource.GITHUB -> repoId?.let { UserApps.Request(UserApps.Source.GitHub(it), custom, iconPath) to (custom ?: it) } + AddSource.GITHUB -> repoId?.let { UserApps.Request(UserApps.Source.GitHub(it, UserApps.githubAsset(repo)), custom, iconPath) to (custom ?: it) } AddSource.FLATPAK -> bundlePath?.takeIf { it.endsWith(".flatpak", ignoreCase = true) }?.let { File(it) } ?.let { UserApps.Request(UserApps.Source.FlatpakBundle(it), custom, iconPath) to (custom ?: it.nameWithoutExtension) } ?: flatpakId?.let { UserApps.Request(UserApps.Source.Flatpak(it), custom, iconPath) to (custom ?: it) } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/BottomNotificationsPage.kt b/app/src/main/java/com/droiddeck/launcher/ui/BottomNotificationsPage.kt deleted file mode 100644 index 266cb5a592..0000000000 --- a/app/src/main/java/com/droiddeck/launcher/ui/BottomNotificationsPage.kt +++ /dev/null @@ -1,116 +0,0 @@ -package com.droiddeck.launcher.ui - -import android.content.Intent -import android.provider.Settings -import androidx.compose.foundation.background -import androidx.compose.foundation.clickable -import androidx.compose.foundation.layout.Arrangement -import androidx.compose.foundation.layout.Box -import androidx.compose.foundation.layout.Column -import androidx.compose.foundation.layout.Row -import androidx.compose.foundation.layout.fillMaxSize -import androidx.compose.foundation.layout.fillMaxWidth -import androidx.compose.foundation.layout.height -import androidx.compose.foundation.layout.padding -import androidx.compose.foundation.lazy.LazyColumn -import androidx.compose.foundation.lazy.items -import androidx.compose.foundation.shape.RoundedCornerShape -import androidx.compose.material3.MaterialTheme -import androidx.compose.material3.Text -import androidx.compose.runtime.Composable -import androidx.compose.runtime.LaunchedEffect -import androidx.compose.runtime.getValue -import androidx.compose.runtime.mutableStateOf -import androidx.compose.runtime.remember -import androidx.compose.runtime.setValue -import androidx.compose.ui.Alignment -import androidx.compose.ui.Modifier -import androidx.compose.ui.draw.clip -import androidx.compose.ui.platform.LocalContext -import androidx.compose.ui.platform.testTag -import androidx.compose.ui.res.stringResource -import androidx.compose.ui.semantics.Role -import androidx.compose.ui.text.font.FontWeight -import androidx.compose.ui.text.style.TextAlign -import androidx.compose.ui.text.style.TextOverflow -import androidx.compose.ui.unit.dp -import androidx.compose.ui.unit.sp -import com.droiddeck.launcher.R -import com.droiddeck.launcher.session.BottomNotifications -import kotlinx.coroutines.delay - -internal fun notificationAccessIntent(context: android.content.Context): Intent = - if (android.os.Build.VERSION.SDK_INT >= android.os.Build.VERSION_CODES.R) { - Intent(Settings.ACTION_NOTIFICATION_LISTENER_DETAIL_SETTINGS).putExtra( - Settings.EXTRA_NOTIFICATION_LISTENER_COMPONENT_NAME, - android.content.ComponentName(context, com.droiddeck.launcher.session.BottomNotificationListener::class.java).flattenToString(), - ) - } else Intent(Settings.ACTION_NOTIFICATION_LISTENER_SETTINGS) - -@Composable -fun BottomNotificationsPage(openSettings: ((Intent, () -> Boolean) -> Unit)?) { - val context = LocalContext.current - val colors = MaterialTheme.colorScheme - val pal = LocalPalette.current - var granted by remember { mutableStateOf(BottomNotifications.granted(context)) } - LaunchedEffect(Unit) { - while (true) { - granted = BottomNotifications.granted(context) - delay(2_000L) - } - } - if (!granted) { - Column(Modifier.fillMaxSize().padding(24.dp), horizontalAlignment = Alignment.CenterHorizontally, - verticalArrangement = Arrangement.spacedBy(16.dp, Alignment.CenterVertically)) { - Text(stringResource(R.string.bottom_notifications_why), fontSize = 15.sp, color = colors.onBackground, textAlign = TextAlign.Center) - BottomPillButton(stringResource(R.string.bottom_notifications_allow), "bottom-notifications-allow") { - val intent = notificationAccessIntent(context) - if (openSettings != null) openSettings(intent) { BottomNotifications.granted(context) } - else runCatching { context.startActivity(intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)) } - } - } - return - } - val shown = BottomNotifications.items - if (shown.isEmpty()) { - Box(Modifier.fillMaxSize(), contentAlignment = Alignment.Center) { - Text(stringResource(R.string.bottom_notifications_none), fontSize = 15.sp, color = colors.onSurfaceVariant) - } - return - } - val timeFormat = remember { android.text.format.DateFormat.getTimeFormat(context) } - Column(Modifier.fillMaxSize(), verticalArrangement = Arrangement.spacedBy(8.dp)) { - Row(Modifier.fillMaxWidth(), verticalAlignment = Alignment.CenterVertically) { - Text(stringResource(R.string.bottom_notifications_count, shown.size), fontSize = 13.sp, color = colors.onSurfaceVariant, - modifier = Modifier.weight(1f)) - BottomPillButton(stringResource(R.string.bottom_notifications_clear), "bottom-notifications-clear") { BottomNotifications.clear() } - } - LazyColumn(Modifier.weight(1f).fillMaxWidth(), verticalArrangement = Arrangement.spacedBy(8.dp)) { - items(shown.toList(), key = { it.key }) { n -> - Column(Modifier.fillMaxWidth().clip(RoundedCornerShape(14.dp)).background(pal.surface).padding(horizontal = 14.dp, vertical = 10.dp), - verticalArrangement = Arrangement.spacedBy(4.dp)) { - Row(verticalAlignment = Alignment.CenterVertically) { - Text(n.app, fontSize = 12.sp, fontWeight = FontWeight.SemiBold, color = pal.signal, maxLines = 1, - overflow = TextOverflow.Ellipsis, modifier = Modifier.weight(1f)) - Text(timeFormat.format(java.util.Date(n.postedAt)), fontSize = 12.sp, color = colors.onSurfaceVariant) - } - if (n.title.isNotBlank()) Text(n.title, fontSize = 15.sp, fontWeight = FontWeight.SemiBold, color = colors.onBackground, - maxLines = 1, overflow = TextOverflow.Ellipsis) - if (n.text.isNotBlank()) Text(n.text, fontSize = 14.sp, color = colors.onBackground, maxLines = 4, overflow = TextOverflow.Ellipsis) - } - } - } - } -} - -@Composable -internal fun BottomPillButton(label: String, tag: String, onClick: () -> Unit) { - val pal = LocalPalette.current - Box( - Modifier.height(40.dp).clip(RoundedCornerShape(20.dp)).background(pal.signal.copy(alpha = 0.16f)) - .clickable(role = Role.Button, onClick = onClick).testTag(tag).padding(horizontal = 16.dp), - contentAlignment = Alignment.Center, - ) { - Text(label, fontSize = 14.sp, fontWeight = FontWeight.SemiBold, color = pal.signal, maxLines = 1) - } -} diff --git a/app/src/main/java/com/droiddeck/launcher/ui/BottomPages.kt b/app/src/main/java/com/droiddeck/launcher/ui/BottomPages.kt index a8884fdec7..2d2e401fa7 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/BottomPages.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/BottomPages.kt @@ -1,17 +1,31 @@ package com.droiddeck.launcher.ui +import androidx.compose.foundation.background +import androidx.compose.foundation.clickable +import androidx.compose.foundation.layout.Box +import androidx.compose.foundation.layout.height +import androidx.compose.foundation.layout.padding +import androidx.compose.foundation.shape.RoundedCornerShape import androidx.compose.material.icons.Icons import androidx.compose.material.icons.outlined.Download import androidx.compose.material.icons.outlined.Forum import androidx.compose.material.icons.outlined.Speed -import androidx.compose.material.icons.outlined.Notifications import androidx.compose.material.icons.outlined.PhotoLibrary +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.clip +import androidx.compose.ui.platform.testTag +import androidx.compose.ui.semantics.Role +import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp import com.droiddeck.launcher.R class BottomPageActions( val takeScreenshot: ((onDone: (Boolean) -> Unit) -> Unit)? = null, val fps: () -> Float? = { null }, - val openSettings: ((intent: android.content.Intent, done: () -> Boolean) -> Unit)? = null, val runningGame: () -> String? = { null }, ) @@ -20,7 +34,18 @@ internal const val BOTTOM_PAGE_TELEMETRY = "telemetry" fun sessionBottomPages(actions: BottomPageActions): List = listOf( BottomPage(BOTTOM_PAGE_TELEMETRY, R.string.bottom_page_telemetry, Icons.Outlined.Speed) { BottomTelemetryPage(actions.fps, actions.runningGame) }, BottomPage("downloads", R.string.bottom_page_downloads, Icons.Outlined.Download) { BottomDownloadsPage() }, - BottomPage("notifications", R.string.bottom_page_notifications, Icons.Outlined.Notifications) { BottomNotificationsPage(actions.openSettings) }, BottomPage("screenshots", R.string.bottom_page_screenshots, Icons.Outlined.PhotoLibrary) { BottomScreenshotsPage(actions.takeScreenshot) }, BottomPage("chat", R.string.bottom_page_chat, Icons.Outlined.Forum) { BottomChatPage() }, ) + +@Composable +internal fun BottomPillButton(label: String, tag: String, onClick: () -> Unit) { + val pal = LocalPalette.current + Box( + Modifier.height(40.dp).clip(RoundedCornerShape(20.dp)).background(pal.signal.copy(alpha = 0.16f)) + .clickable(role = Role.Button, onClick = onClick).testTag(tag).padding(horizontal = 16.dp), + contentAlignment = Alignment.Center, + ) { + Text(label, fontSize = 14.sp, fontWeight = FontWeight.SemiBold, color = pal.signal, maxLines = 1) + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/ui/BottomTelemetryPage.kt b/app/src/main/java/com/droiddeck/launcher/ui/BottomTelemetryPage.kt index 4aee7fc22f..08b4ae8ada 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/BottomTelemetryPage.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/BottomTelemetryPage.kt @@ -304,7 +304,8 @@ fun BottomTelemetryPage(fps: () -> Float?, runningGame: () -> String? = { null } val now = System.nanoTime() val live = frames.live val stats = frames.stats - val graph = FloatArray(FrameStats.GRAPH_FRAMES).also { if (live) stats.graph(it) } + val graph = FloatArray(FrameStats.GRAPH_FRAMES) + val graphEnd = if (live) stats.graph(graph) else 0L val hz = (frames.refreshMilliHz + 499) / 1000 val data = HudData( fps = fpsNow, avgFps = if (live) stats.averageFps() else null, lows = if (live) stats.lows(now) else FrameStats.Lows.EMPTY, @@ -317,6 +318,7 @@ fun BottomTelemetryPage(fps: () -> Float?, runningGame: () -> String? = { null } title = title, cover = cover, played = playedSeconds?.let(::playedText), clock = clock, fpsHistory = fpsHistory.snapshot(), cpuHistory = cpuHistory.snapshot(), gpuHistory = gpuHistory.snapshot(), historySeconds = maxOf(fpsHistory.spanSeconds(), cpuHistory.spanSeconds(), gpuHistory.spanSeconds()), + graphEnd = graphEnd, coreGroups = coreGroups, gameCores = gameCores, fahrenheit = tempDisplay.fahrenheit, tempColor = { sensor, c -> thresholds[sensor]?.let { Color(HudMetrics.tempColor(c.toFloat(), it, tempDisplay, TEMP_PLAIN)) } ?: Color(TEMP_PLAIN) diff --git a/app/src/main/java/com/droiddeck/launcher/ui/BuildWatermark.kt b/app/src/main/java/com/droiddeck/launcher/ui/BuildWatermark.kt index 648d754aac..a9d0c3d1a2 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/BuildWatermark.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/BuildWatermark.kt @@ -38,7 +38,8 @@ object BuildWatermark { if (text.length <= TITLE_LIMIT) text else text.take(TITLE_LIMIT - 1).trimEnd() + "…" fun install(app: Application) { - val lines = lines() ?: return + val lab = com.droiddeck.launcher.lab.LabOverlay.active?.let { "LAB | ${truncate(it.label)}" } + val lines = (listOfNotNull(lab) + lines().orEmpty()).ifEmpty { return } app.registerActivityLifecycleCallbacks(object : Application.ActivityLifecycleCallbacks { override fun onActivityCreated(activity: Activity, savedInstanceState: Bundle?) { if (activity is QuestXrActivity) return diff --git a/app/src/main/java/com/droiddeck/launcher/ui/EaUpdateButton.kt b/app/src/main/java/com/droiddeck/launcher/ui/EaUpdateButton.kt new file mode 100644 index 0000000000..9fe2a41155 --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/ui/EaUpdateButton.kt @@ -0,0 +1,17 @@ +package com.droiddeck.launcher.ui + +import androidx.compose.runtime.Composable +import androidx.compose.runtime.LaunchedEffect +import androidx.compose.ui.platform.LocalContext +import androidx.compose.ui.res.stringResource +import com.droiddeck.launcher.R +import com.droiddeck.launcher.stores.InstalledStoreGame +import com.droiddeck.launcher.stores.ea.EaUpdates + +@Composable +internal fun EaUpdateButton(installed: InstalledStoreGame, enabled: Boolean) { + val ctx = LocalContext.current + LaunchedEffect(installed.key, installed.sidecar.installVersion) { EaUpdates.check(ctx, installed) } + if (EaUpdates.available[installed.key] == null) return + SecondaryButton(stringResource(R.string.common_update), enabled = enabled) { EaUpdates.start(ctx, installed) } +} diff --git a/app/src/main/java/com/droiddeck/launcher/ui/GameDetail.kt b/app/src/main/java/com/droiddeck/launcher/ui/GameDetail.kt index 808c944858..f42a85de51 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/GameDetail.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/GameDetail.kt @@ -430,6 +430,7 @@ internal fun GameActions( openUrl(ctx, item?.storeUrl.orEmpty().ifBlank { GameJoltApi.pageUrl("game", installed.sidecar.id) }) } } + if (store == Store.EA && installed != null) EaUpdateButton(installed, download == null && StoresState.uninstalling[installed.key] == null) if (store == Store.GOG && installed != null) GogMaintenanceActions(installed) if (store == Store.XBOX && id != null) XboxInstalledStream(id, game?.name ?: item?.title.orEmpty(), item) if (store == Store.XBOX && installed != null && id != null) { @@ -915,7 +916,7 @@ private fun AddonRow(name: String, target: WowAddons.Target, a: FrontEndActions) @Composable private fun CloudRows(g: Library.SteamGame) { - val store = Store.byId(g.source)?.takeIf { it != Store.AMAZON } ?: return + val store = Store.byId(g.source)?.takeIf { it != Store.AMAZON && it != Store.EA } ?: return val id = g.storeId ?: return val context = LocalContext.current.applicationContext var busy by remember(g.gameId) { mutableStateOf(null) } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/InputActionEditor.kt b/app/src/main/java/com/droiddeck/launcher/ui/InputActionEditor.kt index a53de480bb..01464cef3b 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/InputActionEditor.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/InputActionEditor.kt @@ -16,7 +16,7 @@ import com.droiddeck.launcher.input.* internal fun InputActionEditor( control: InputControl, current: InputAction, title: String, onBack: () -> Unit, onSave: (InputAction) -> Unit, element: InputSurfaceElement? = null, nativeTargets: Boolean = true, detail: String? = null, - properties: (@Composable ColumnScope.() -> Unit)? = null, + properties: (@Composable ColumnScope.(InputAction) -> Unit)? = null, click: Boolean = false, ) { val context = LocalContext.current @@ -46,7 +46,7 @@ internal fun InputActionEditor( SettingsPage(host, title, onBack, eyebrow = stringResource(R.string.input_properties), lede = detail, action = { PrimaryButton(stringResource(R.string.gesture_save_changes), enabled = valid(draft), modifier = Modifier.testTag("input-action-save")) { onSave(draft) } }) { - properties?.invoke(this) + properties?.invoke(this, draft) Spacer(Modifier.height(12.dp)) SheetChips(listOf(stringResource(R.string.input_route_controller), stringResource(R.string.input_route_local), stringResource(R.string.input_disabled)), route) { when (it) { diff --git a/app/src/main/java/com/droiddeck/launcher/ui/InputDisplayContent.kt b/app/src/main/java/com/droiddeck/launcher/ui/InputDisplayContent.kt index 4fd41036f3..bf4674ddfa 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/InputDisplayContent.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/InputDisplayContent.kt @@ -58,12 +58,17 @@ internal fun InputDisplayContent(host: ComponentActivity, display: Display, onDi dismiss() } } + (host as? com.droiddeck.launcher.SessionActivity)?.inputWindowShown(display.displayId) showPresentation() val observer = LifecycleEventObserver { _, event -> if (event == Lifecycle.Event.ON_STOP && !host.screenIsOff()) presentation.hide() if (event == Lifecycle.Event.ON_START) showPresentation() } host.lifecycle.addObserver(observer) - onDispose { host.lifecycle.removeObserver(observer); presentation.dismiss() } + onDispose { + host.lifecycle.removeObserver(observer) + presentation.dismiss() + (host as? com.droiddeck.launcher.SessionActivity)?.inputWindowClosed(display.displayId) + } } } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/InputElementProperties.kt b/app/src/main/java/com/droiddeck/launcher/ui/InputElementProperties.kt index 33f5a68f80..406e6f7f5f 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/InputElementProperties.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/InputElementProperties.kt @@ -24,7 +24,7 @@ import kotlinx.coroutines.launch import kotlinx.coroutines.withContext @Composable -internal fun InputElementProperties(element: InputSurfaceElement, onChange: (InputSurfaceElement) -> Unit) { +internal fun InputElementProperties(element: InputSurfaceElement, action: InputAction? = null, onChange: (InputSurfaceElement) -> Unit) { val current by rememberUpdatedState(element) val change by rememberUpdatedState(onChange) OutlinedTextField(element.name, { onChange(element.copy(name = it.take(80))) }, label = { Text(stringResource(R.string.input_name)) }, @@ -72,7 +72,9 @@ internal fun InputElementProperties(element: InputSurfaceElement, onChange: (Inp } val host = rememberMenuHost() if ((element.kind == InputElementKind.BUTTON || element.kind == InputElementKind.TRIGGER) && element.icon == 0 && element.image.isEmpty() || - element.kind == InputElementKind.STICK && element.id.startsWith("legacy:")) + element.kind == InputElementKind.STICK && element.id.startsWith("legacy:") || + (element.kind == InputElementKind.STICK || element.kind == InputElementKind.DPAD) && (action as? InputAction.Directions) + ?.let { listOf(it.up, it.right, it.down, it.left).plus(if (element.kind == InputElementKind.STICK) it.diagonals.orEmpty() else emptyList()).any { code -> code != 0 } } == true) ToggleRow(host, "element-label", stringResource(R.string.input_show_label), null, element.showLabel) { onChange(element.copy(showLabel = it)) } SliderRow(stringResource(R.string.ctrl_opacity), null, (element.opacity * 100).roundToInt().coerceIn(20, 100), 20..100, step = 5, format = { "$it%" }, modifier = Modifier.testTag("setting-element-opacity")) { onChange(element.copy(opacity = it / 100f)) } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/InputSettingsPage.kt b/app/src/main/java/com/droiddeck/launcher/ui/InputSettingsPage.kt index 66d81ffa33..812557f368 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/InputSettingsPage.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/InputSettingsPage.kt @@ -169,7 +169,7 @@ private fun InputSettingsContent(onBack: () -> Unit, onChanged: () -> Unit, embe ?: b.controls[editing.control] ?: InputAction.Native() InputActionEditor(editing.control, current, if (editing.click) stringResource(R.string.input_click_name, editing.element!!.name) else editing.element?.name ?: editing.key?.label ?: editing.control.label, - properties = { if (!editing.click) elementProperties?.let { e -> InputElementProperties(e) { elementProperties = it } } }, + properties = { action -> if (!editing.click) elementProperties?.let { e -> InputElementProperties(e, action) { elementProperties = it } } }, onBack = { edit = null }, element = editing.element, nativeTargets = editing.key == null, click = editing.click, detail = if (library.usersOfBindings(b.id).size > 1) stringResource(R.string.input_shared_detail, b.name, library.usersOfBindings(b.id).size) else "${profile.name} · ${roleLabel(role)}", onSave = { action -> diff --git a/app/src/main/java/com/droiddeck/launcher/ui/InputSurfaceDialog.kt b/app/src/main/java/com/droiddeck/launcher/ui/InputSurfaceDialog.kt index e58204cc6e..ddf5838be8 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/InputSurfaceDialog.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/InputSurfaceDialog.kt @@ -69,7 +69,7 @@ private class GamepadScaler(private val context: android.content.Context, privat } private class SurfaceDraft(val layout: SavedInputLayout, val preset: SavedInputBindings, val defaults: List? = null, - private val gamepad: GamepadScaler? = null) { + private val gamepad: GamepadScaler? = null, snap: Boolean = true) { var elements by mutableStateOf(layout.elements) var actions by mutableStateOf(preset.elements) var clicks by mutableStateOf(preset.clicks) @@ -77,7 +77,7 @@ private class SurfaceDraft(val layout: SavedInputLayout, val preset: SavedInputB var toolsExpanded by mutableStateOf(false) var toolsX by mutableFloatStateOf(.02f) var toolsY by mutableFloatStateOf(.02f) - var snap by mutableStateOf(true) + var snap by mutableStateOf(snap) var adding by mutableStateOf(false) var properties by mutableStateOf(false) var clickProperties by mutableStateOf(false) @@ -132,7 +132,7 @@ fun InputSurfaceDialog(profile: String, onDismiss: () -> Unit, onChanged: () -> val (w, h) = OnScreenLayout.generatedSize(context, savedLayout, metrics.widthPixels, metrics.heightPixels) ?: (metrics.widthPixels to metrics.heightPixels) GamepadScaler(display, w, h) } - SurfaceDraft(savedLayout, savedBindings, InputLibraries.defaultPositions(context, library, savedLayout), gamepad) + SurfaceDraft(savedLayout, savedBindings, InputLibraries.defaultPositions(context, library, savedLayout), gamepad, ControllerPrefs.snap(context)) } val manager = remember { context.getSystemService(DisplayManager::class.java) } var revision by remember { mutableIntStateOf(0) } @@ -162,7 +162,7 @@ fun InputSurfaceDialog(profile: String, onDismiss: () -> Unit, onChanged: () -> val listener = object : DisplayManager.DisplayListener { override fun onDisplayAdded(id: Int) { revision++ } override fun onDisplayRemoved(id: Int) { revision++ } - override fun onDisplayChanged(id: Int) { revision++ } + override fun onDisplayChanged(id: Int) = Unit } manager.registerDisplayListener(listener, Handler(Looper.getMainLooper())) onDispose { manager.unregisterDisplayListener(listener) } @@ -171,13 +171,18 @@ fun InputSurfaceDialog(profile: String, onDismiss: () -> Unit, onChanged: () -> val presentation = SurfaceEditorPresentation(host, target, transparent = host is SessionActivity && role == InputRole.PRIMARY) { SurfaceCanvas(draft, transparent = host is SessionActivity && role == InputRole.PRIMARY) } + (host as? SessionActivity)?.inputWindowShown(target.displayId) runCatching { presentation.show() }.onFailure { failure = it.message } val observer = LifecycleEventObserver { _, event -> if (event == Lifecycle.Event.ON_STOP && !host.screenIsOff()) presentation.hide() if (event == Lifecycle.Event.ON_START) runCatching { presentation.show() } } host.lifecycle.addObserver(observer) - onDispose { host.lifecycle.removeObserver(observer); presentation.dismiss() } + onDispose { + host.lifecycle.removeObserver(observer) + presentation.dismiss() + (host as? SessionActivity)?.inputWindowClosed(target.displayId) + } } // Compose 1.6 custom dialog sizing subtracts system bars even when they are hidden. Dialog(onDismissRequest = ::leave, properties = DialogProperties(usePlatformDefaultWidth = true, decorFitsSystemWindows = false)) { @@ -198,8 +203,8 @@ fun InputSurfaceDialog(profile: String, onDismiss: () -> Unit, onChanged: () -> if (draft.clickProperties) draft.clickAction(element) else draft.action(element), if (draft.clickProperties) stringResource(R.string.input_click_name, element.name) else element.name, onBack = { draft.properties = false }, element = element, click = draft.clickProperties, - properties = { - if (!draft.clickProperties) InputElementProperties(properties) { properties = it } + properties = { action -> + if (!draft.clickProperties) InputElementProperties(properties, action) { properties = it } if (layoutUsers > 1) Text(stringResource(R.string.input_editor_shared, layoutUsers), style = MaterialTheme.typography.bodySmall, color = MaterialTheme.colorScheme.onSurfaceVariant, modifier = Modifier.padding(bottom = 12.dp)) @@ -309,13 +314,14 @@ private fun FloatingSurfaceTools(draft: SurfaceDraft, onSave: () -> Unit, onLeav @OptIn(ExperimentalLayoutApi::class) @Composable private fun SurfaceToolbar(draft: SurfaceDraft, onSave: () -> Unit, onLeave: () -> Unit) { + val context = LocalContext.current FlowRow(Modifier.fillMaxWidth().padding(8.dp), horizontalArrangement = Arrangement.spacedBy(8.dp), verticalArrangement = Arrangement.spacedBy(4.dp)) { SecondaryButton(stringResource(R.string.common_cancel), compact = true, onClick = onLeave) SecondaryButton(stringResource(R.string.input_editor_add), enabled = draft.elements.size < 64, compact = true) { draft.adding = true } SecondaryButton(stringResource(R.string.input_editor_undo), enabled = draft.history.isNotEmpty(), compact = true) { draft.undo() } if (draft.defaults != null) SecondaryButton(stringResource(R.string.input_reset_positions), enabled = draft.positioned != null, compact = true) { draft.resetPositions() } Row(verticalAlignment = Alignment.CenterVertically) { - Checkbox(draft.snap, { draft.snap = it }) + Checkbox(draft.snap, { draft.snap = it; ControllerPrefs.setSnap(context, it) }) Text(stringResource(R.string.ctrl_editor_snap)) } PrimaryButton(stringResource(R.string.input_editor_done), compact = true, onClick = onSave) diff --git a/app/src/main/java/com/droiddeck/launcher/ui/InputSurfaceView.kt b/app/src/main/java/com/droiddeck/launcher/ui/InputSurfaceView.kt index b1cab727ea..f121a9a73a 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/InputSurfaceView.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/InputSurfaceView.kt @@ -32,10 +32,12 @@ import com.droiddeck.launcher.input.InputSurfaceStyle import com.droiddeck.launcher.input.pointerSubset import com.droiddeck.launcher.input.InputSurfaceSource import com.droiddeck.launcher.input.InputElementKind +import com.droiddeck.launcher.input.InputAction import com.droiddeck.launcher.input.InputButtonIcons import com.droiddeck.launcher.input.InputButtonShape import com.droiddeck.launcher.input.InputButtonImages import com.droiddeck.launcher.input.PadBridge +import com.droiddeck.launcher.input.pcKeyLabel import com.droiddeck.launcher.session.SessionPrefs import kotlin.math.atan2 import kotlin.math.hypot @@ -195,7 +197,7 @@ class InputSurfaceView( canvas.addView(when (element.kind) { InputElementKind.STICK -> StickView(context, element, source, element.floating, element.hideWhenIdle && pad != null) InputElementKind.TRACKPAD -> TrackpadView(context, element.control == InputControl.RIGHT_PAD, source = source) - InputElementKind.DPAD -> DirectionPad(context, source) + InputElementKind.DPAD -> DirectionPad(context, element, source) else -> HoldButton(context, element, source) }.apply { tag = element; contentDescription = element.name; styleElement(this); source?.onStateChanged = { postInvalidate() } }) } @@ -541,6 +543,7 @@ class InputSurfaceView( if (touching || clicking) shade(color, 160, 1f) else shade(color, 120, 0.35f), if (touching) light(color, 230, 0.7f) else light(color, 150, 0.25f)) if (!element.showLabel) return labelPaint.color = textColor(touching) + if (drawDirectionLabels(canvas, source, false, cx, cy, radius * 0.66f, radius * 0.34f, labelPaint)) return labelPaint.textSize = knobRadius * 0.8f val label = if (element.name == element.control.label) glyph(element.control) else element.name canvas.drawText(label, cx + knobX, cy + knobY + labelPaint.textSize * 0.35f, labelPaint) @@ -552,6 +555,9 @@ class InputSurfaceView( canvas.drawCircle(cx, cy, reach(), ring) knob.color = if (touching) ACCENT else KNOB canvas.drawCircle(cx + knobX, cy + knobY, reach() * 0.45f, knob) + if (!element.showLabel) return + labelPaint.color = if (touching) ACCENT else TEXT + drawDirectionLabels(canvas, source, false, cx, cy, reach() * 1.32f, reach() * 0.68f, labelPaint) } @SuppressLint("ClickableViewAccessibility") @@ -613,10 +619,11 @@ class InputSurfaceView( } } - private inner class DirectionPad(context: Context, private val source: InputSurfaceSource? = null) : View(context) { + private inner class DirectionPad(context: Context, private val element: InputSurfaceElement, private val source: InputSurfaceSource? = null) : View(context) { private val density = resources.displayMetrics.density private var held = 0 private val arm = Paint(Paint.ANTI_ALIAS_FLAG) + private val label = Paint(Paint.ANTI_ALIAS_FLAG).apply { textAlign = Paint.Align.CENTER; typeface = Typeface.create(Typeface.DEFAULT, Typeface.BOLD); color = TEXT } private val rect = RectF() override fun onDraw(canvas: Canvas) { @@ -636,6 +643,7 @@ class InputSurfaceView( armRect(2, cx + thick, cy - thick, cx + half, cy + thick) arm.color = KNOB canvas.drawRect(cx - thick, cy - thick, cx + thick, cy + thick, arm) + if (element.showLabel) drawDirectionLabels(canvas, source, true, cx, cy, (half + thick) / 2f, thick * 1.7f, label) } @SuppressLint("ClickableViewAccessibility") @@ -717,6 +725,29 @@ class InputSurfaceView( else -> control.id.uppercase() } + private val CARDINAL = listOf(0f to -1f, 1f to 0f, 0f to 1f, -1f to 0f) + private val DIAGONAL = listOf(.7071f to -.7071f, .7071f to .7071f, -.7071f to .7071f, -.7071f to -.7071f) + + internal fun directionLabels(context: Context, action: InputAction.Directions?, cardinalOnly: Boolean): List, String>> { + if (action == null) return emptyList() + val codes = listOf(action.up, action.right, action.down, action.left).zip(CARDINAL) + + if (cardinalOnly) emptyList() else action.diagonals.orEmpty().zip(DIAGONAL) + return codes.filter { it.first != 0 }.map { (code, unit) -> unit to pcKeyLabel(context, code) } + } + + private fun View.drawDirectionLabels(canvas: Canvas, source: InputSurfaceSource?, cardinalOnly: Boolean, cx: Float, cy: Float, + distance: Float, box: Float, paint: Paint): Boolean { + val labels = directionLabels(context, source?.directions, cardinalOnly) + paint.style = Paint.Style.FILL + for ((unit, text) in labels) { + paint.textSize = box * .6f + val measured = paint.measureText(text) + if (measured > box) paint.textSize *= box / measured + canvas.drawText(text, cx + unit.first * distance, cy + unit.second * distance - (paint.ascent() + paint.descent()) / 2f, paint) + } + return labels.isNotEmpty() + } + private fun drawArrow(canvas: Canvas, x: Float, y: Float, size: Float, direction: Int, paint: Paint) { val (fx, fy) = when (direction) { 0 -> 0f to -1f; 1 -> 1f to 0f; 2 -> 0f to 1f; else -> -1f to 0f } val path = Path() diff --git a/app/src/main/java/com/droiddeck/launcher/ui/LabBuilds.kt b/app/src/main/java/com/droiddeck/launcher/ui/LabBuilds.kt new file mode 100644 index 0000000000..8bfc59306b --- /dev/null +++ b/app/src/main/java/com/droiddeck/launcher/ui/LabBuilds.kt @@ -0,0 +1,162 @@ +package com.droiddeck.launcher.ui + +import android.text.format.DateUtils +import androidx.compose.foundation.background +import androidx.compose.foundation.border +import androidx.compose.foundation.layout.Arrangement +import androidx.compose.foundation.layout.Box +import androidx.compose.foundation.layout.Column +import androidx.compose.foundation.layout.Row +import androidx.compose.foundation.layout.fillMaxWidth +import androidx.compose.foundation.layout.height +import androidx.compose.foundation.layout.heightIn +import androidx.compose.foundation.layout.padding +import androidx.compose.foundation.layout.size +import androidx.compose.material.icons.Icons +import androidx.compose.material.icons.outlined.Code +import androidx.compose.material3.Icon +import androidx.compose.material3.MaterialTheme +import androidx.compose.material3.Text +import androidx.compose.runtime.Composable +import androidx.compose.runtime.getValue +import androidx.compose.runtime.mutableIntStateOf +import androidx.compose.runtime.mutableStateOf +import androidx.compose.runtime.remember +import androidx.compose.runtime.setValue +import androidx.compose.ui.Alignment +import androidx.compose.ui.Modifier +import androidx.compose.ui.draw.clip +import androidx.compose.ui.platform.LocalContext +import androidx.compose.ui.res.stringResource +import androidx.compose.ui.text.font.FontWeight +import androidx.compose.ui.text.style.TextOverflow +import androidx.compose.ui.unit.dp +import androidx.compose.ui.unit.sp +import com.droiddeck.launcher.R +import com.droiddeck.launcher.core.WirelessAdbFix +import com.droiddeck.launcher.lab.LabOverlay + +/** + * Lab builds on this device: the one in use, one waiting for a restart, and the kept ones. + * [onRebuild] offers to build a kept one again for this install, when something can. + */ +@Composable +internal fun LabBuilds(sessionRunning: Boolean = false, onRebuild: ((LabOverlay.Info) -> Unit)? = null) { + val context = LocalContext.current + var version by remember { mutableIntStateOf(0) } + var busy by remember { mutableStateOf(false) } + var error by remember { mutableStateOf(null) } + val current = remember(version) { LabOverlay.current(context) } + val pending = remember(version) { LabOverlay.pending(context) } + val saved = remember(version) { LabOverlay.saved(context) } + if (current == null && pending == null && saved.isEmpty()) return + val active = LabOverlay.active + val paused = active == null && current != null && LabOverlay.skipped == LabOverlay.SKIPPED_APP_IMAGE + val restartFailed = stringResource(R.string.lab_restart_failed) + val canRestart = !busy && !sessionRunning + + /** Android may have given the APK an app image again, which a Lab build cannot load over. */ + fun restart() { + busy = true + error = null + Thread({ + val result = runCatching { + if (LabOverlay.needsRecompile(context)) WirelessAdbFix.shell(context, LabOverlay.recompileCommand(context)) + } + android.os.Handler(android.os.Looper.getMainLooper()).post { + busy = false + if (result.isSuccess) LabOverlay.restart(context) + else error = restartFailed.format(result.exceptionOrNull()?.message.orEmpty()) + } + }, "lab-restart").start() + } + + val colors = MaterialTheme.colorScheme + val pal = LocalPalette.current + Column(Modifier.fillMaxWidth().padding(top = 18.dp)) { + Text( + stringResource(R.string.lab_builds).uppercase(), fontSize = 12.sp, fontWeight = FontWeight.SemiBold, letterSpacing = 1.5.sp, + color = colors.onSurfaceVariant, modifier = Modifier.padding(start = 2.dp, top = 2.dp, bottom = 10.dp), + ) + Column(Modifier.fillMaxWidth().clip(Shape14).background(colors.surface).border(1.dp, pal.line, Shape14)) { + val rows = mutableListOf<@Composable () -> Unit>() + if (current != null) rows += { + BuildRow( + current, true, + when { + active != null -> stringResource(R.string.lab_in_use) + paused -> stringResource(R.string.lab_paused_row) + else -> stringResource(R.string.lab_not_loaded, LabOverlay.skipped.orEmpty()) + }, + warn = active == null, + ) { + if (paused) PrimaryButton(stringResource(R.string.lab_restart), compact = true, enabled = canRestart) { restart() } + SecondaryButton(stringResource(R.string.lab_turn_off), compact = true, enabled = canRestart) { LabOverlay.turnOff(context) } + } + } + if (pending != null) rows += { + BuildRow(pending, false, stringResource(R.string.lab_waiting), warn = false) { + PrimaryButton(stringResource(R.string.lab_restart), compact = true, enabled = canRestart) { restart() } + } + } + for (build in saved) rows += { + var armed by remember(build.dir) { mutableStateOf(false) } + val info = build.info + BuildRow( + info, false, + when { + armed -> stringResource(R.string.lab_delete_warning) + !build.usable -> stringResource(R.string.lab_other_install) + build.reason == LabOverlay.Reason.DID_NOT_START -> stringResource(R.string.lab_off_did_not_start) + else -> stringResource(R.string.lab_kept) + }, + warn = armed || !build.usable || build.reason == LabOverlay.Reason.DID_NOT_START, + ) { + if (!build.usable && !armed && info != null && onRebuild != null) SecondaryButton(stringResource(R.string.lab_rebuild), compact = true, enabled = !busy) { + onRebuild(info) + } + if (build.usable && !armed) SecondaryButton(stringResource(R.string.lab_use), compact = true, enabled = canRestart) { + runCatching { LabOverlay.stage(context, build) } + .onSuccess { version++; restart() } + .onFailure { error = it.message } + } + SecondaryButton(stringResource(if (armed) R.string.lab_delete_confirm else R.string.lab_delete), compact = true, enabled = !busy) { + if (armed) { + LabOverlay.delete(build) + version++ + } else armed = true + } + } + } + rows.forEachIndexed { index, row -> + row() + if (index < rows.lastIndex) Box(Modifier.fillMaxWidth().height(1.dp).background(pal.line)) + } + } + error?.let { Text(it, fontSize = 12.5.sp, color = AttentionAmber, modifier = Modifier.padding(start = 2.dp, top = 8.dp)) } + } +} + +@Composable +private fun BuildRow(info: LabOverlay.Info?, current: Boolean, status: String, warn: Boolean, actions: @Composable () -> Unit) { + val colors = MaterialTheme.colorScheme + val pal = LocalPalette.current + Row( + verticalAlignment = Alignment.CenterVertically, + horizontalArrangement = Arrangement.spacedBy(12.dp), + modifier = Modifier.fillMaxWidth().heightIn(min = 60.dp).padding(horizontal = 14.dp, vertical = 10.dp), + ) { + Box(contentAlignment = Alignment.Center, modifier = Modifier.size(34.dp).clip(Shape12) + .background(if (current) pal.signal.copy(alpha = 0.18f) else colors.surfaceVariant)) { + Icon(Icons.Outlined.Code, null, tint = if (current) pal.signal else colors.onSurfaceVariant, modifier = Modifier.size(20.dp)) + } + Column(Modifier.weight(1f)) { + Text(info?.label ?: "?", fontSize = 14.5.sp, fontWeight = FontWeight.SemiBold, color = colors.onBackground, + maxLines = 1, overflow = TextOverflow.Ellipsis) + val built = info?.built?.takeIf { it > 0 }?.let { DateUtils.getRelativeTimeSpanString(it * 1000, System.currentTimeMillis(), DateUtils.MINUTE_IN_MILLIS).toString() } + Text(listOfNotNull(status, built).joinToString(" · "), fontSize = 12.5.sp, color = if (warn) AttentionAmber else colors.onSurfaceVariant, + maxLines = 2, overflow = TextOverflow.Ellipsis) + } + Row(horizontalArrangement = Arrangement.spacedBy(8.dp)) { actions() } + } +} diff --git a/app/src/main/java/com/droiddeck/launcher/ui/LibraryPage.kt b/app/src/main/java/com/droiddeck/launcher/ui/LibraryPage.kt index 6550a2fd06..73dad7aa70 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/LibraryPage.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/LibraryPage.kt @@ -109,6 +109,7 @@ import com.droiddeck.launcher.stores.itch.ItchUpdates import com.droiddeck.launcher.stores.gog.GogMaintenance import com.droiddeck.launcher.stores.retainOrder import com.droiddeck.launcher.stores.xbox.XboxLibraryFilter +import com.droiddeck.launcher.stores.entryTime import com.droiddeck.launcher.stores.sortGames import kotlinx.coroutines.launch import androidx.compose.runtime.setValue @@ -296,8 +297,8 @@ internal fun LibraryPage(s: FrontEndState, a: FrontEndActions, selected: String, val sizesPending = sizeSort && !sizesWaited && candidates.any { sizeOf(it) == null } val sorted = sortGames( candidates, sort, title = { it.title }, releaseDate = { it.item?.releaseDate.orEmpty() }, - lastPlayed = { e -> e.game?.lastPlayed ?: e.storeKey?.let { lastPlayed[it] } ?: 0L }, - installedAt = { e -> e.storeKey?.let { installedAt[it] } ?: 0L }, + lastPlayed = { e -> entryTime(e.game?.lastPlayed, e.storeKey?.let { lastPlayed[it] }) }, + installedAt = { e -> entryTime(e.storeKey?.let { installedAt[it] }, e.game?.installedAt) }, size = { e -> sizeOf(e) ?: 0L }, ) var stable by remember { mutableStateOf(emptyList()) } @@ -741,7 +742,7 @@ internal fun LibraryMarker(e: LibraryEntry, download: DownloadEntry?, showDownlo } } -private fun libraryUpdateAvailable(e: LibraryEntry): Boolean = e.storeKey?.let { it in ItchUpdates.available || it in GameJoltUpdates.available } == true || +private fun libraryUpdateAvailable(e: LibraryEntry): Boolean = e.storeKey?.let { it in ItchUpdates.available || it in GameJoltUpdates.available || it in com.droiddeck.launcher.stores.ea.EaUpdates.available } == true || e.source == Store.GOG.id && (e.item?.id ?: e.game?.storeId)?.let { GogMaintenance.checks[it]?.state } == GogMaintenance.State.AVAILABLE @Composable diff --git a/app/src/main/java/com/droiddeck/launcher/ui/ModeSettingsDialog.kt b/app/src/main/java/com/droiddeck/launcher/ui/ModeSettingsDialog.kt index 8489f5cceb..70fd435c94 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/ModeSettingsDialog.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/ModeSettingsDialog.kt @@ -224,6 +224,8 @@ fun ModeSheetRows(s: ModeSettings, a: ModeSettingsActions, tab: String, extras: ChoiceRow(host, "picture-position", stringResource(R.string.display_picture_position), null, listOf("top" to stringResource(R.string.display_position_top), "bottom" to stringResource(R.string.display_position_bottom), + "left" to stringResource(R.string.display_position_left), + "right" to stringResource(R.string.display_position_right), "center" to stringResource(R.string.display_position_center)), position, onPick = a.onPicturePosition) } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/PerformanceDialog.kt b/app/src/main/java/com/droiddeck/launcher/ui/PerformanceDialog.kt index 2c0927bc88..f8f44907a7 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/PerformanceDialog.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/PerformanceDialog.kt @@ -53,6 +53,7 @@ fun PerformancePage( ramCapAvailable: Boolean, prootNoSeccomp: Boolean, prootFastPath: Boolean, + nativeUserland: Boolean, cursorComposite: Boolean, guestHostname: String, phantomWarning: String?, @@ -72,6 +73,7 @@ fun PerformancePage( onVramCapMb: (Int) -> Unit, onProotNoSeccomp: (Boolean) -> Unit, onProotFastPath: (Boolean) -> Unit, + onNativeUserland: (Boolean) -> Unit, onCursorComposite: (Boolean) -> Unit, onGuestHostname: (String) -> Unit, onClientCore: (Int, Boolean) -> Unit, @@ -187,9 +189,18 @@ fun PerformancePage( ) ToggleRow( host, "fastpath", stringResource(R.string.perf_fastpath), - if (prootNoSeccomp) stringResource(R.string.perf_fastpath_needs_seccomp) - else stringResource(R.string.perf_fastpath_hint), - prootFastPath && !prootNoSeccomp, enabled = !prootNoSeccomp, onChange = onProotFastPath, + when { + nativeUserland -> stringResource(R.string.perf_fastpath_needs_proot) + prootNoSeccomp -> stringResource(R.string.perf_fastpath_needs_seccomp) + else -> stringResource(R.string.perf_fastpath_hint) + }, + prootFastPath && !prootNoSeccomp && !nativeUserland, enabled = !prootNoSeccomp && !nativeUserland, + onChange = onProotFastPath, + ) + ToggleRow( + host, "nativeuserland", stringResource(R.string.perf_native_userland), + stringResource(R.string.perf_native_userland_hint), + nativeUserland, onChange = onNativeUserland, ) ToggleRow( host, "cursorcomposite", stringResource(R.string.perf_cursor_composite), diff --git a/app/src/main/java/com/droiddeck/launcher/ui/SecondScreenPresentation.kt b/app/src/main/java/com/droiddeck/launcher/ui/SecondScreenPresentation.kt index 000aa8afc6..d9a4967d76 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/SecondScreenPresentation.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/SecondScreenPresentation.kt @@ -323,7 +323,7 @@ class SecondScreenPresentation( context.getString(if (keyboardShown.value) R.string.second_hide_keyboard else R.string.second_show_keyboard), icon = R.drawable.ic_bottom_keyboard, active = keyboardShown.value, tag = "bottom-keyboard") { showKeyboard() })) SecondScreenMode.DECK_CONTROLS -> model(swap, deckPanelTabs(context, deckPanel.value, ::selectDeckPanel)) - SecondScreenMode.DASHBOARD -> model(swap) + SecondScreenMode.DASHBOARD, SecondScreenMode.CUSTOM_CONTROLS -> model(swap) SecondScreenMode.TERMINAL -> model(listOf(BarExtra(context.getString(R.string.drawer_keyboard), icon = R.drawable.ic_bottom_keyboard, tag = "bottom-keyboard") { terminalPanel?.showKeyboard() })) else -> null diff --git a/app/src/main/java/com/droiddeck/launcher/ui/SessionOverlay.kt b/app/src/main/java/com/droiddeck/launcher/ui/SessionOverlay.kt index dc0e8f3202..7315817c1c 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/SessionOverlay.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/SessionOverlay.kt @@ -219,7 +219,6 @@ class DrawerActions( val frameGen: FrameGen.Mode, val lossless: Lossless.State, val oscMode: String, - val onScreenButtonsVisible: Boolean, val suspendPolicy: String, val steamDownloadsInBackground: Boolean = false, val micAvailable: Boolean = false, @@ -325,6 +324,7 @@ class DrawerActions( val onStop: () -> Unit, val onStopFrom: ((androidx.compose.ui.geometry.Rect?) -> Unit)? = null, val onClose: () -> Unit, + val onDismissScreen: (() -> Unit)? = null, val components: ComponentsManager.Snapshot? = null, val systemPowerVr: Boolean = false, val onComponentsRefresh: () -> Unit = {}, @@ -488,7 +488,7 @@ internal fun SessionDrawer(open: Boolean, requestedPage: SessionDrawerPage, cont ) { SteamActionPill( stringResource(R.string.common_close), Icons.Outlined.Close, focus.track(page, "close"), - ) { host.open = null; a.onClose() } + ) { host.open = null; (a.onDismissScreen ?: a.onClose)() } if (roomyHeader) Spacer(Modifier.weight(1f)) SteamActionPill( stringResource(R.string.stores_dl_pause), Icons.Outlined.Pause, focus.track(page, "pause"), diff --git a/app/src/main/java/com/droiddeck/launcher/ui/StatsHud.kt b/app/src/main/java/com/droiddeck/launcher/ui/StatsHud.kt index b14dd39dc3..0ed81319c1 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/StatsHud.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/StatsHud.kt @@ -98,6 +98,7 @@ internal class HudData( val tempColor: (HudMetrics.TempSensor, Int) -> Color, val redC: (HudMetrics.TempSensor) -> Int?, val historySeconds: Int = 0, + val graphEnd: Long = 0L, ) { val frametimeMs: Float? get() = fps?.takeIf { it > 0f }?.let { 1000f / it } val hz: Int get() = if (refreshHz > 0) refreshHz else 60 @@ -268,18 +269,26 @@ private fun lowsText(d: HudData, size: TextUnit, accent: Color, deep: Boolean = private val GRAPH_MIN_GAP = 3.dp @Composable -private fun Graph(values: List, lo: Float, hi: Float, color: Color, modifier: Modifier) { +private fun Graph(values: List, lo: Float, hi: Float, color: Color, modifier: Modifier, end: Long = 0L) { Canvas(modifier) { if (values.size < 2 || hi <= lo) return@Canvas val stride = ceil(GRAPH_MIN_GAP.toPx() * (values.size - 1) / size.width).toInt().coerceAtLeast(1) - val points = if (stride == 1) values else values.chunked(stride) { it.average().toFloat() } - if (points.size < 2) return@Canvas + // Buckets start at multiples of stride counted from the first sample ever drawn, so a sample keeps + // its bucket as the window scrolls; counted from the window's start, every new frame re-paired them. + val skip = Math.floorMod(values.size.toLong() - end, stride.toLong()).toInt() val path = Path() - points.forEachIndexed { i, v -> - val x = i / (points.size - 1f) * size.width - val y = size.height - ((v - lo) / (hi - lo)).coerceIn(0f, 1f) * size.height - if (i == 0) path.moveTo(x, y) else path.lineTo(x, y) + var drawn = 0 + var start = skip + while (start < values.size) { + val stop = minOf(start + stride, values.size) + var sum = 0f + for (i in start until stop) sum += values[i] + val x = (start + stop - 1) / 2f / (values.size - 1f) * size.width + val y = size.height - ((sum / (stop - start) - lo) / (hi - lo)).coerceIn(0f, 1f) * size.height + if (drawn++ == 0) path.moveTo(x, y) else path.lineTo(x, y) + start = stop } + if (drawn < 2) return@Canvas drawPath(path, color.copy(alpha = 0.22f), style = Stroke(width = 6.dp.toPx(), cap = StrokeCap.Round, join = StrokeJoin.Round)) drawPath(path, color, style = Stroke(width = 2.2f.dp.toPx(), cap = StrokeCap.Round, join = StrokeJoin.Round)) } @@ -287,7 +296,7 @@ private fun Graph(values: List, lo: Float, hi: Float, color: Color, modif @Composable private fun FrameGraph(d: HudData, accent: Color, height: Dp) { - Graph(d.graph.toList(), 0f, FrameStats.GRAPH_MAX_MS, lerp(accent, Color.White, 0.3f), Modifier.fillMaxWidth().height(height)) + Graph(d.graph.toList(), 0f, FrameStats.GRAPH_MAX_MS, lerp(accent, Color.White, 0.3f), Modifier.fillMaxWidth().height(height), d.graphEnd) } @Composable @@ -589,7 +598,7 @@ private fun ColumnScope.Pacing(d: HudData, accent: Color) { drawLine(color, Offset(0f, y), Offset(size.width, y), 1.dp.toPx(), pathEffect = dash) } } - Graph(d.graph.toList(), 0f, FrameStats.GRAPH_MAX_MS, graphColor, Modifier.fillMaxSize()) + Graph(d.graph.toList(), 0f, FrameStats.GRAPH_MAX_MS, graphColor, Modifier.fillMaxSize(), d.graphEnd) for ((ms, color) in listOf(target to HudInk.dim, target * 2 to HudInk.amber)) { Small("%.1f ms · %d fps".format(ms, (1000f / ms).roundToInt()), 11.sp, color, Modifier.align(Alignment.TopEnd).offset(y = maxHeight * (1f - ms / FrameStats.GRAPH_MAX_MS) - 17.dp)) diff --git a/app/src/main/java/com/droiddeck/launcher/ui/StoreChips.kt b/app/src/main/java/com/droiddeck/launcher/ui/StoreChips.kt index 1d2aef9d6e..2fea8fc891 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/StoreChips.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/StoreChips.kt @@ -33,6 +33,8 @@ internal fun sourceColours(source: String): SourceColours = when (source) { Store.ITCH.id -> SourceColours(Color(0xFF3A1A1E), Color(0xFFFFB3B3), Color(0xFFFF5C5C)) Store.GAMEJOLT.id -> SourceColours(Color(0xFF232E00), Color(0xFFE3FF66), Color(0xFFCCFF00)) Store.BATTLENET.id -> SourceColours(Color(0xFF0A2440), Color(0xFF9DD1FF), Color(0xFF148EFF)) + Store.UBISOFT.id -> SourceColours(Color(0xFF0B1E44), Color(0xFFA8C6FF), Color(0xFF2E7DFF)) + Store.EA.id -> SourceColours(Color(0xFF3A0E12), Color(0xFFFF9A9A), Color(0xFFFF4747)) Library.SOURCE_STEAM -> SourceColours(Color(0xFF16293D), Color(0xFF7CC4FF), Color(0xFF1A9FFF)) FLATHUB -> SourceColours(Color(0xFF0B2E2B), Color(0xFF9FE3DD), FlathubTeal) else -> SourceColours(Color(0xFF1A1D22), Color(0xFF9AA3AF), Color(0xFF9AA3AF)) @@ -48,6 +50,8 @@ internal fun sourceLabel(source: String): String = when (source) { Store.ITCH.id -> Store.ITCH.label Store.GAMEJOLT.id -> Store.GAMEJOLT.label Store.BATTLENET.id -> Store.BATTLENET.label + Store.UBISOFT.id -> Store.UBISOFT.shortLabel + Store.EA.id -> Store.EA.label else -> stringResource(R.string.source_added) } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/StoresPage.kt b/app/src/main/java/com/droiddeck/launcher/ui/StoresPage.kt index c5f31f5d32..7bc7c186d0 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/StoresPage.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/StoresPage.kt @@ -1157,6 +1157,8 @@ internal fun storePalette(base: Palette, store: Store?): Palette { Store.ITCH -> Color(0xFFFF5C5C) to Color(0xFFD93B3B) Store.GAMEJOLT -> Color(0xFFCCFF00) to Color(0xFFA3CC00) Store.BATTLENET -> Color(0xFF148EFF) to Color(0xFF0B6BD3) + Store.UBISOFT -> Color(0xFF2E7DFF) to Color(0xFF1A5BD6) + Store.EA -> Color(0xFFFF4747) to Color(0xFFE03030) null -> return base } val on = if (accent.luminance() > 0.18f) Color(0xFF0B0B0D) else Color.White diff --git a/app/src/main/java/com/droiddeck/launcher/ui/Theme.kt b/app/src/main/java/com/droiddeck/launcher/ui/Theme.kt index cb6d5ed22f..2e2c1049e4 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/Theme.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/Theme.kt @@ -58,6 +58,7 @@ object Themes { const val RGB_SPEEDS = 10 const val DEFAULT_RGB_SPEED = 3 const val RGB_HUE_STEP = 3f + const val WHITE_RED = "white_red" var rgbSpeed by mutableStateOf(DEFAULT_RGB_SPEED) private set @@ -127,6 +128,13 @@ object Themes { primary = Color(0xFF2E86FF), primary2 = Color(0xFF2684FF), onPrimary = Color(0xFF03111F), signal = Color(0xFF2E86FF), good = Color(0xFF4CD37F), ), + Palette( + WHITE_RED, R.string.theme_white_red, R.string.theme_white_red_detail, + background = Color(0xFFF8F8F8), surface = Color(0xFFFFFFFF), surfaceVariant = Color(0xFFF0F0F0), line = Color(0xFFDDDDDD), line2 = Color(0xFFC8C8C8), + onBackground = Color(0xFF191919), onSurfaceVariant = Color(0xFF555555), + primary = Color(0xFFD62828), primary2 = Color(0xFFB71C1C), onPrimary = Color(0xFFFFFFFF), signal = Color(0xFFD62828), + good = Color(0xFF248548), + ), innerGamer(0f), ThemeColors.palette(DEFAULT_PRIMARY, DEFAULT_SECONDARY, R.string.theme_gradient, R.string.theme_gradient_detail), ) diff --git a/app/src/main/java/com/droiddeck/launcher/ui/UpdatesPage.kt b/app/src/main/java/com/droiddeck/launcher/ui/UpdatesPage.kt index dd73939a7d..a1af06a863 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/UpdatesPage.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/UpdatesPage.kt @@ -120,11 +120,11 @@ internal fun UpdatesPage(s: FrontEndState, a: FrontEndActions, modifier: Modifie StatusPanel(s, u, ua, me) Box(Modifier.height(18.dp)) ChannelLabel() - ChannelPicker(u, ua) + ChannelPicker(u, ua, s.sessionRunning) } else { ChannelLabel() Row(horizontalArrangement = Arrangement.spacedBy(18.dp)) { - Box(Modifier.weight(1f)) { ChannelPicker(u, ua) } + Box(Modifier.weight(1f)) { ChannelPicker(u, ua, s.sessionRunning) } Box(Modifier.weight(1.15f)) { StatusPanel(s, u, ua, me) } } } @@ -262,7 +262,7 @@ private fun ChannelLabel() { } @Composable -private fun ChannelPicker(u: UpdatesState, ua: UpdatesActions) { +private fun ChannelPicker(u: UpdatesState, ua: UpdatesActions, sessionRunning: Boolean) { val colors = MaterialTheme.colorScheme val catalog = u.catalog val tests = catalog?.tests.orEmpty() @@ -285,6 +285,7 @@ private fun ChannelPicker(u: UpdatesState, ua: UpdatesActions) { tests.forEach { t -> TestRow(t, u.follow.pr == t.pr) { ua.onFollow(Follow(Channel.TEST, t.pr)) } } } } + LabBuilds(sessionRunning) } } diff --git a/app/src/main/java/com/droiddeck/launcher/ui/WinComponentsEditor.kt b/app/src/main/java/com/droiddeck/launcher/ui/WinComponentsEditor.kt index 4dff5d4d60..3fd3c9477c 100644 --- a/app/src/main/java/com/droiddeck/launcher/ui/WinComponentsEditor.kt +++ b/app/src/main/java/com/droiddeck/launcher/ui/WinComponentsEditor.kt @@ -56,7 +56,7 @@ import java.io.File private fun installable(name: String, all: Map): String = WinComponents.installable(name, all) @Composable -private fun originName(origin: String): String = if (origin == WinCompSources.Origin.XBOX.name) "Xbox" else stringResource( +private fun originName(origin: String): String = if (origin == WinCompSources.Origin.XBOX.name) "Xbox" else if (origin == WinCompSources.Origin.UBISOFT.name) "Ubisoft Connect" else stringResource( when (origin) { WinCompSources.Origin.GOG.name -> R.string.wincomp_src_gog WinCompSources.Origin.EPIC.name -> R.string.wincomp_src_epic @@ -71,6 +71,7 @@ private fun autoReason(r: WinComponents.AutoReason): String = when (r.kind) { WinCompSources.Origin.GOG.name -> stringResource(R.string.wincomp_auto_gog) WinCompSources.Origin.EPIC.name -> stringResource(R.string.wincomp_auto_epic) WinCompSources.Origin.AMAZON.name -> stringResource(R.string.wincomp_auto_amazon) + WinCompSources.Origin.UBISOFT.name -> "From Ubisoft's install steps for this game" WinCompSources.Origin.XBOX.name -> "Xbox games install it with the game (${r.args.getOrElse(0) { "VC14" }})" else -> "" } diff --git a/app/src/main/res/values-ar/strings.xml b/app/src/main/res/values-ar/strings.xml index c38bcb03a5..573c669b9d 100644 --- a/app/src/main/res/values-ar/strings.xml +++ b/app/src/main/res/values-ar/strings.xml @@ -1259,7 +1259,6 @@ يد التحكّم عصا التحكّم لوحة اللمس - التبديل بين عصا التحكّم ولوحة اللمس إغلاق عناصر التحكّم على الشاشة الثانية فتح قائمة Steam لوحة اللمس اليمنى @@ -1874,13 +1873,6 @@ جارٍ تنزيل ذاكرة المظلِّلات المؤقتة متوقف مؤقتًا بانتظار البدء - الإشعارات - الشاشة السفلية لـ DroidDeck - اعرض الرسائل والإشعارات الأخرى هنا أثناء اللعب. تبقى على هذه الشاشة فقط ولا تُحفظ. يطلب Android الإذن مرة واحدة: تُفتح صفحة الوصول إلى الإشعارات على هذه الشاشة؛ فعِّل DroidDeck هناك وستعود هذه الصفحة تلقائيًا. - السماح بالوصول إلى الإشعارات - لا توجد إشعارات. - الإشعارات: %1$d - مسح لقطات الشاشة يتطلب FPS تشغيل واجهة الأداء السرعة @@ -2984,6 +2976,8 @@ أعلى أسفل الوسط (افتراضي) + يسار + يمين التخزين جارٍ قياس التخزين… يستغرق القياس الأول بضع ثوانٍ. @@ -3817,4 +3811,7 @@ إعادة تعيين المواضع إظهار التسمية تعذّر استيراد هذا التخطيط + + ثلج قرمزي + diff --git a/app/src/main/res/values-b+es+419/strings.xml b/app/src/main/res/values-b+es+419/strings.xml index 2155082ebb..f38bdcee46 100644 --- a/app/src/main/res/values-b+es+419/strings.xml +++ b/app/src/main/res/values-b+es+419/strings.xml @@ -1308,7 +1308,6 @@ Control Stick Trackpad - Cambiar entre stick y trackpad Cerrar controles de la segunda pantalla Abrir menú de Steam Trackpad derecho @@ -1866,13 +1865,6 @@ Descargando caché de shaders En pausa Esperando para empezar - Notificaciones - DroidDeck – pantalla inferior - Muestra aquí los mensajes y otras notificaciones mientras juegas. Solo permanecen en esta pantalla y no se guardan. Android lo pregunta una vez: su página de acceso a notificaciones se abre en esta pantalla; activa DroidDeck ahí y esta página volverá sola. - Permitir acceso a notificaciones - No hay notificaciones. - %1$d notificaciones - Borrar Capturas de pantalla Los FPS requieren el HUD activado Velocidad @@ -2836,6 +2828,8 @@ Arriba Abajo Centro (predeterminado) + Izquierda + Derecha Almacenamiento Midiendo el almacenamiento… La primera vez tarda unos segundos. @@ -3673,4 +3667,6 @@ Restablecer posiciones Mostrar etiqueta No se pudo importar esta disposición + Nieve escarlata + Superficies blancas con acentos rojos. diff --git a/app/src/main/res/values-bg/strings.xml b/app/src/main/res/values-bg/strings.xml index a0ac9d2e73..36751e5311 100644 --- a/app/src/main/res/values-bg/strings.xml +++ b/app/src/main/res/values-bg/strings.xml @@ -1231,7 +1231,6 @@ Геймпад Стик Тракпад - Превключване между стик и тракпад Затваряне на контролите за втория екран Отваряне на менюто на Steam Десен тракпад @@ -1778,13 +1777,6 @@ Изтегляне на кеша на шейдърите На пауза Изчаква стартиране - Известия - Долен екран на DroidDeck - Показвайте тук съобщения и други известия, докато играете. Те остават само на този екран и не се запазват. Android пита веднъж: страницата за достъп до известията се отваря на този екран; включете DroidDeck там и тази страница ще се върне сама. - Разрешаване на достъпа до известията - Няма известия. - Известия: %1$d - Изчисти Екранни снимки За FPS трябва HUD да е включен Скорост @@ -2868,6 +2860,8 @@ Горе Долу В средата (по подразбиране) + Наляво + Надясно Съхранение Измерване на съхранението… Първият път отнема няколко секунди. @@ -3661,4 +3655,7 @@ Нулиране на позициите Показване на етикета Това разположение не можа да бъде импортирано + + Ален сняг + diff --git a/app/src/main/res/values-cs/strings.xml b/app/src/main/res/values-cs/strings.xml index fb1143eb5b..010374a13e 100644 --- a/app/src/main/res/values-cs/strings.xml +++ b/app/src/main/res/values-cs/strings.xml @@ -1245,7 +1245,6 @@ Gamepad Páčka Trackpad - Přepnout mezi páčkou a trackpadem Zavřít ovládání druhé obrazovky Otevřít nabídku Steamu Pravý trackpad @@ -1826,13 +1825,6 @@ Stahování mezipaměti shaderů Pozastaveno Čeká na spuštění - Oznámení - Spodní obrazovka DroidDeck - Zobrazujte zde zprávy a další oznámení během hraní. Zůstávají jen na této obrazovce a neukládají se. Android se zeptá jednou: na této obrazovce se otevře jeho stránka přístupu k oznámením; zapněte tam DroidDeck a tato stránka se sama vrátí. - Povolit přístup k oznámením - Žádná oznámení. - Oznámení: %1$d - Vymazat Snímky obrazovky FPS vyžaduje zapnutý HUD Rychlost @@ -2926,6 +2918,8 @@ Nahoře Dole Uprostřed (výchozí) + Vlevo + Vpravo Úložiště Měření úložiště… Poprvé to trvá pár sekund. @@ -3739,4 +3733,7 @@ Obnovit pozice Zobrazit popisek Toto rozložení nelze importovat + + Šarlatový sníh + diff --git a/app/src/main/res/values-da/strings.xml b/app/src/main/res/values-da/strings.xml index e0ae298979..f0c0527365 100644 --- a/app/src/main/res/values-da/strings.xml +++ b/app/src/main/res/values-da/strings.xml @@ -1231,7 +1231,6 @@ Gamepad Stick Trackpad - Skift mellem stick og trackpad Luk kontrollerne til den anden skærm Åbn Steam-menuen Højre trackpad @@ -1778,13 +1777,6 @@ Downloader shader-cache På pause Venter på at starte - Notifikationer - DroidDecks nederste skærm - Vis beskeder og andre notifikationer her, mens du spiller. De bliver kun på denne skærm og gemmes ikke. Android spørger én gang: siden for notifikationsadgang åbnes på denne skærm; slå DroidDeck til der, så vender denne side selv tilbage. - Tillad notifikationsadgang - Ingen notifikationer. - %1$d notifikationer - Ryd Skærmbilleder FPS kræver, at HUD er slået til Hastighed @@ -2868,6 +2860,8 @@ Øverst Nederst Midten (standard) + Venstre + Højre Lager Måler lager… Første gang tager et par sekunder. @@ -3661,4 +3655,7 @@ Nulstil placeringer Vis etiket Dette layout kunne ikke importeres + + Skarlagensne + diff --git a/app/src/main/res/values-de/strings.xml b/app/src/main/res/values-de/strings.xml index 80891d10b1..ad656b8bb8 100644 --- a/app/src/main/res/values-de/strings.xml +++ b/app/src/main/res/values-de/strings.xml @@ -1223,7 +1223,6 @@ Gamepad Stick Trackpad - Zwischen Stick und Trackpad wechseln Steuerung auf dem Zweitbildschirm schließen Steam-Menü öffnen Rechtes Trackpad @@ -1770,13 +1769,6 @@ Shader-Cache wird heruntergeladen Pausiert Wartet auf Start - Benachrichtigungen - DroidDeck – unterer Bildschirm - Zeigt Nachrichten und andere Benachrichtigungen hier an, während du spielst. Sie bleiben nur auf diesem Bildschirm und werden nicht gespeichert. Android fragt einmal: Die Seite für den Benachrichtigungszugriff öffnet sich auf diesem Bildschirm; aktiviere dort DroidDeck, dann kehrt diese Seite von selbst zurück. - Benachrichtigungszugriff erlauben - Keine Benachrichtigungen. - %1$d Benachrichtigungen - Löschen Screenshots FPS benötigt das aktive HUD Geschwindigkeit @@ -2868,6 +2860,8 @@ Oben Unten Mitte (Standard) + Links + Rechts Speicher Speicher wird erfasst… Die erste Erfassung dauert ein paar Sekunden. @@ -3661,4 +3655,7 @@ Positionen zurücksetzen Beschriftung anzeigen Dieses Layout konnte nicht importiert werden + + Scharlachroter Schnee + diff --git a/app/src/main/res/values-el/strings.xml b/app/src/main/res/values-el/strings.xml index db27823f4b..0d7d8e1c91 100644 --- a/app/src/main/res/values-el/strings.xml +++ b/app/src/main/res/values-el/strings.xml @@ -1231,7 +1231,6 @@ Χειριστήριο Μοχλός Πινακίδα αφής - Εναλλαγή μεταξύ μοχλού και πινακίδας αφής Κλείσιμο χειριστηρίων δεύτερης οθόνης Άνοιγμα μενού Steam Δεξιά πινακίδα αφής @@ -1778,13 +1777,6 @@ Λήψη cache shader Σε παύση Αναμονή για έναρξη - Ειδοποιήσεις - DroidDeck – κάτω οθόνη - Εμφάνιση μηνυμάτων και άλλων ειδοποιήσεων εδώ ενώ παίζετε. Παραμένουν μόνο σε αυτή την οθόνη και δεν αποθηκεύονται. Το Android ρωτά μία φορά: η σελίδα πρόσβασης ειδοποιήσεων ανοίγει σε αυτή την οθόνη· ενεργοποιήστε εκεί το DroidDeck και αυτή η σελίδα επιστρέφει μόνη της. - Αποδοχή πρόσβασης ειδοποιήσεων - Δεν υπάρχουν ειδοποιήσεις. - %1$d ειδοποιήσεις - Απαλοιφή Στιγμιότυπα οθόνης Τα FPS απαιτούν ενεργό HUD Ταχύτητα @@ -2868,6 +2860,8 @@ Πάνω Κάτω Κέντρο (προεπιλογή) + Αριστερά + Δεξιά Αποθήκευση Μέτρηση αποθήκευσης… Την πρώτη φορά παίρνει λίγα δευτερόλεπτα. @@ -3661,4 +3655,7 @@ Επαναφορά θέσεων Εμφάνιση ετικέτας Δεν ήταν δυνατή η εισαγωγή αυτής της διάταξης + + Κατακόκκινο χιόνι + diff --git a/app/src/main/res/values-es/strings.xml b/app/src/main/res/values-es/strings.xml index 0fc4b7f2ec..1e7fb4865a 100644 --- a/app/src/main/res/values-es/strings.xml +++ b/app/src/main/res/values-es/strings.xml @@ -1238,7 +1238,6 @@ Mando Stick Trackpad - Cambiar entre stick y trackpad Cerrar controles de la segunda pantalla Abrir menú de Steam Trackpad derecho @@ -1802,13 +1801,6 @@ Descargando caché de shaders En pausa Esperando para empezar - Notificaciones - DroidDeck – pantalla inferior - Muestra aquí los mensajes y otras notificaciones mientras juegas. Solo permanecen en esta pantalla y no se guardan. Android lo pregunta una vez: su página de acceso a notificaciones se abre en esta pantalla; activa DroidDeck ahí y esta página volverá sola. - Permitir acceso a notificaciones - No hay notificaciones. - %1$d notificaciones - Borrar Capturas de pantalla Los FPS requieren el HUD activado Velocidad @@ -2897,6 +2889,8 @@ Arriba Abajo Centro (predeterminado) + Izquierda + Derecha Almacenamiento Midiendo el almacenamiento… La primera vez tarda unos segundos. @@ -3700,4 +3694,7 @@ Restablecer posiciones Mostrar etiqueta No se ha podido importar esta disposición + + Nieve escarlata + diff --git a/app/src/main/res/values-fi/strings.xml b/app/src/main/res/values-fi/strings.xml index e42ff509f1..ba86de4422 100644 --- a/app/src/main/res/values-fi/strings.xml +++ b/app/src/main/res/values-fi/strings.xml @@ -1231,7 +1231,6 @@ Peliohjain Tatti Kosketuslevy - Vaihda tatin ja kosketuslevyn välillä Sulje toisen näytön ohjaimet Avaa Steam-valikko Oikea kosketuslevy @@ -1778,13 +1777,6 @@ Ladataan sävytinvälimuistia Keskeytetty Odottaa alkamista - Ilmoitukset - DroidDeckin alanäyttö - Näytä viestit ja muut ilmoitukset täällä pelatessasi. Ne näkyvät vain tällä näytöllä, eikä niitä tallenneta. Android kysyy kerran: sen ilmoitusten käyttöoikeussivu avautuu tälle näytölle; kytke DroidDeck siellä päälle, niin tämä sivu palaa itsestään. - Salli ilmoitusten käyttö - Ei ilmoituksia. - Ilmoituksia: %1$d - Tyhjennä Kuvakaappaukset FPS vaatii HUD:n päälle Nopeus @@ -2868,6 +2860,8 @@ Ylhäällä Alhaalla Keskellä (oletus) + Vasen + Oikea Tallennustila Mitataan tallennustilaa… Ensimmäisellä kerralla kestää muutaman sekunnin. @@ -3661,4 +3655,7 @@ Palauta sijainnit Näytä nimi Tätä asettelua ei voitu tuoda + + Helakanpunainen lumi + diff --git a/app/src/main/res/values-fr/strings.xml b/app/src/main/res/values-fr/strings.xml index b45dd39619..02c4953bfb 100644 --- a/app/src/main/res/values-fr/strings.xml +++ b/app/src/main/res/values-fr/strings.xml @@ -1238,7 +1238,6 @@ Manette Joystick Pavé tactile - Basculer entre joystick et pavé tactile Fermer les commandes du deuxième écran Ouvrir le menu Steam Pavé tactile droit @@ -1802,13 +1801,6 @@ Téléchargement du cache de shaders En pause En attente de démarrage - Notifications - Écran inférieur DroidDeck - Affichez ici les messages et autres notifications pendant que vous jouez. Ils restent uniquement sur cet écran et ne sont pas enregistrés. Android ne le demande qu\'une fois : sa page d\'accès aux notifications s\'ouvre sur cet écran ; activez-y DroidDeck et cette page reviendra d\'elle-même. - Autoriser l\'accès aux notifications - Aucune notification. - %1$d notifications - Effacer Captures d\'écran Les FPS nécessitent d\'activer le HUD Vitesse @@ -2897,6 +2889,8 @@ Haut Bas Centre (par défaut) + Gauche + Droite Stockage Mesure du stockage… Cela prend quelques secondes la première fois. @@ -3700,4 +3694,7 @@ Réinitialiser les positions Afficher le libellé Impossible d’importer cette disposition + + Neige écarlate + diff --git a/app/src/main/res/values-hi/strings.xml b/app/src/main/res/values-hi/strings.xml index 1e6de113d2..cdacc2c56d 100644 --- a/app/src/main/res/values-hi/strings.xml +++ b/app/src/main/res/values-hi/strings.xml @@ -1231,7 +1231,6 @@ गेमपैड स्टिक ट्रैकपैड - स्टिक और ट्रैकपैड के बीच बदलें दूसरी स्क्रीन के कंट्रोल बंद करें Steam मेनू खोलें दायां ट्रैकपैड @@ -1778,13 +1777,6 @@ शेडर कैश डाउनलोड हो रहा है रुका हुआ शुरू होने का इंतज़ार - नोटिफ़िकेशन - DroidDeck नीचे की स्क्रीन - खेलते समय मैसेज और अन्य नोटिफ़िकेशन यहां दिखाएं। वे सिर्फ़ इसी स्क्रीन पर रहते हैं और सेव नहीं होते। Android एक बार पूछता है: उसका नोटिफ़िकेशन ऐक्सेस पेज इसी स्क्रीन पर खुलता है; वहां DroidDeck चालू करें और यह पेज अपने-आप वापस आ जाएगा। - नोटिफ़िकेशन ऐक्सेस की अनुमति दें - कोई नोटिफ़िकेशन नहीं। - %1$d नोटिफ़िकेशन - साफ़ करें स्क्रीनशॉट FPS के लिए HUD चालू होना चाहिए स्पीड @@ -2868,6 +2860,8 @@ ऊपर नीचे बीच में (डिफ़ॉल्ट) + बाएँ + दाएँ स्टोरेज स्टोरेज मापा जा रहा है… पहली बार कुछ सेकंड लगते हैं। @@ -3661,4 +3655,7 @@ स्थितियाँ रीसेट करें लेबल दिखाएँ यह लेआउट इम्पोर्ट नहीं किया जा सका + + किरमिज़ी बर्फ + diff --git a/app/src/main/res/values-hu/strings.xml b/app/src/main/res/values-hu/strings.xml index 43ff4e40a1..3743a26364 100644 --- a/app/src/main/res/values-hu/strings.xml +++ b/app/src/main/res/values-hu/strings.xml @@ -1231,7 +1231,6 @@ Kontroller Kar Érintőpad - Váltás a kar és az érintőpad között Második képernyős vezérlők bezárása Steam-menü megnyitása Jobb érintőpad @@ -1778,13 +1777,6 @@ Shader-gyorsítótár letöltése Szüneteltetve Indításra vár - Értesítések - DroidDeck alsó képernyő - Itt jelenítheti meg az üzeneteket és más értesítéseket játék közben. Csak ezen a képernyőn láthatók, és nem kerülnek mentésre. Az Android egyszer kérdez rá: az értesítési hozzáférés oldala ezen a képernyőn nyílik meg; kapcsolja be ott a DroidDecket, és ez az oldal magától visszatér. - Értesítési hozzáférés engedélyezése - Nincsenek értesítések. - %1$d értesítés - Törlés Képernyőképek Az FPS-hez be kell kapcsolni a HUD-ot Sebesség @@ -2868,6 +2860,8 @@ Fent Lent Középen (alapértelmezett) + Bal + Jobb Tárhely Tárhely mérése… Első alkalommal pár másodpercig tart. @@ -3661,4 +3655,7 @@ Pozíciók visszaállítása Címke megjelenítése Ez az elrendezés nem importálható + + Skarlátvörös hó + diff --git a/app/src/main/res/values-in/strings.xml b/app/src/main/res/values-in/strings.xml index 7e12156173..395b199251 100644 --- a/app/src/main/res/values-in/strings.xml +++ b/app/src/main/res/values-in/strings.xml @@ -1224,7 +1224,6 @@ Gamepad Stik Trackpad - Beralih antara stik dan trackpad Tutup kontrol layar kedua Buka menu Steam Trackpad kanan @@ -1754,13 +1753,6 @@ Mengunduh cache shader Dijeda Menunggu dimulai - Notifikasi - Layar bawah DroidDeck - Tampilkan pesan dan notifikasi lain di sini saat Anda bermain. Notifikasi hanya muncul di layar ini dan tidak disimpan. Android hanya meminta sekali: halaman akses notifikasinya terbuka di layar ini; aktifkan DroidDeck di sana dan halaman ini akan kembali dengan sendirinya. - Izinkan akses notifikasi - Tidak ada notifikasi. - %1$d notifikasi - Hapus Tangkapan layar FPS memerlukan HUD aktif Kecepatan @@ -2839,6 +2831,8 @@ Atas Bawah Tengah (bawaan) + Kiri + Kanan Penyimpanan Mengukur penyimpanan… Butuh beberapa detik pada kali pertama. @@ -3631,4 +3625,7 @@ Atur ulang posisi Tampilkan label Tata letak ini tidak dapat diimpor + + Salju Kirmizi + diff --git a/app/src/main/res/values-it/strings.xml b/app/src/main/res/values-it/strings.xml index d631138736..9d7e3392bf 100644 --- a/app/src/main/res/values-it/strings.xml +++ b/app/src/main/res/values-it/strings.xml @@ -1230,7 +1230,6 @@ Gamepad Levetta Trackpad - Alterna tra levetta e trackpad Chiudi i controlli sul secondo schermo Apri il menu Steam Trackpad destro @@ -1794,13 +1793,6 @@ Download della cache degli shader In pausa In attesa di avvio - Notifiche - Schermo inferiore DroidDeck - Mostra qui messaggi e altre notifiche mentre giochi. Restano solo su questo schermo e non vengono salvate. Android lo chiede una sola volta: la sua pagina di accesso alle notifiche si apre su questo schermo; attiva DroidDeck lì e questa pagina torna da sola. - Consenti accesso alle notifiche - Nessuna notifica. - %1$d notifiche - Cancella Screenshot Gli FPS richiedono l\'HUD attivo Velocità @@ -2897,6 +2889,8 @@ In alto In basso Centro (predefinito) + Sinistra + Destra Archiviazione Misurazione dell\'archiviazione… La prima volta richiede qualche secondo. @@ -3700,4 +3694,7 @@ Ripristina posizioni Mostra etichetta Impossibile importare questo layout + + Neve scarlatta + diff --git a/app/src/main/res/values-ja/strings.xml b/app/src/main/res/values-ja/strings.xml index 25b9c5092a..2be588f1c8 100644 --- a/app/src/main/res/values-ja/strings.xml +++ b/app/src/main/res/values-ja/strings.xml @@ -1224,7 +1224,6 @@ ゲームパッド スティック トラックパッド - スティックとトラックパッドを切り替え セカンドスクリーンコントロールを閉じる Steamメニューを開く 右トラックパッド @@ -1754,13 +1753,6 @@ シェーダーキャッシュをダウンロード中 一時停止中 開始待ち - 通知 - DroidDeck下部画面 - プレイ中、メッセージなどの通知をここに表示します。通知はこの画面にのみ表示され、保存されません。Androidによる確認は一度だけです。この画面に通知へのアクセスのページが開くので、そこでDroidDeckをオンにすると、このページに自動的に戻ります。 - 通知へのアクセスを許可 - 通知はありません。 - %1$d件の通知 - クリア スクリーンショット FPSの表示にはHUDをオンにする必要があります 速度 @@ -2839,6 +2831,8 @@ 上 下 中央(既定) + 左 + 右 ストレージ ストレージを集計しています… 初回の集計には数秒かかります。 @@ -3631,4 +3625,7 @@ 位置をリセット ラベルを表示 このレイアウトをインポートできませんでした + + 緋色の雪 + diff --git a/app/src/main/res/values-ko/strings.xml b/app/src/main/res/values-ko/strings.xml index 0e2fa19eca..457511bbde 100644 --- a/app/src/main/res/values-ko/strings.xml +++ b/app/src/main/res/values-ko/strings.xml @@ -1224,7 +1224,6 @@ 게임패드 스틱 터치패드 - 스틱과 터치패드 간 전환 보조 화면 컨트롤 닫기 Steam 메뉴 열기 오른쪽 터치패드 @@ -1754,13 +1753,6 @@ 셰이더 캐시 다운로드 중 일시 중지됨 시작 대기 중 - 알림 - DroidDeck 하단 화면 - 플레이하는 동안 메시지와 기타 알림을 여기에 표시합니다. 알림은 이 화면에만 표시되며 저장되지 않습니다. Android에서 한 번만 묻습니다. 이 화면에 알림 접근 권한 페이지가 열리면 DroidDeck을 켜세요. 그러면 이 페이지로 자동으로 돌아옵니다. - 알림 접근 허용 - 알림이 없습니다. - 알림 %1$d개 - 지우기 스크린샷 FPS를 보려면 HUD를 켜야 합니다 속도 @@ -2839,6 +2831,8 @@ 위 아래 가운데(기본) + 왼쪽 + 오른쪽 저장 공간 저장 공간 계산 중… 처음 계산할 때는 몇 초 걸립니다. @@ -3631,4 +3625,7 @@ 위치 초기화 라벨 표시 이 레이아웃을 가져올 수 없습니다 + + 진홍빛 눈 + diff --git a/app/src/main/res/values-ms/strings.xml b/app/src/main/res/values-ms/strings.xml index f7c1a4a9a5..10524febe1 100644 --- a/app/src/main/res/values-ms/strings.xml +++ b/app/src/main/res/values-ms/strings.xml @@ -1224,7 +1224,6 @@ Gamepad Stik Trackpad - Tukar antara stik dan trackpad Tutup kawalan skrin kedua Buka menu Steam Trackpad kanan @@ -1754,13 +1753,6 @@ Memuat turun cache shader Dijeda Menunggu untuk bermula - Pemberitahuan - Skrin bawah DroidDeck - Paparkan mesej dan pemberitahuan lain di sini semasa anda bermain. Ia hanya kekal pada skrin ini dan tidak disimpan. Android bertanya sekali sahaja: halaman akses pemberitahuannya dibuka pada skrin ini; hidupkan DroidDeck di sana dan halaman ini akan kembali dengan sendirinya. - Benarkan akses pemberitahuan - Tiada pemberitahuan. - %1$d pemberitahuan - Kosongkan Tangkapan skrin FPS memerlukan HUD dihidupkan Kelajuan @@ -2839,6 +2831,8 @@ Atas Bawah Tengah (lalai) + Kiri + Kanan Storan Mengukur storan… Mengambil beberapa saat pada kali pertama. @@ -3631,4 +3625,7 @@ Tetapkan semula kedudukan Tunjukkan label Susun atur ini tidak dapat diimport + + Salji Merah Skarlet + diff --git a/app/src/main/res/values-nb/strings.xml b/app/src/main/res/values-nb/strings.xml index 66e52aafd2..8ac2561bab 100644 --- a/app/src/main/res/values-nb/strings.xml +++ b/app/src/main/res/values-nb/strings.xml @@ -1231,7 +1231,6 @@ Kontroller Stikke Styreflate - Bytt mellom stikke og styreflate Lukk kontroller for andre skjerm Åpne Steam-menyen Høyre styreflate @@ -1778,13 +1777,6 @@ Laster ned shaderbuffer Pauset Venter på å starte - Varslinger - DroidDeck nedre skjerm - Vis meldinger og andre varslinger her mens du spiller. De vises bare på denne skjermen og lagres ikke. Android spør én gang: siden for varseltilgang åpnes på denne skjermen; slå på DroidDeck der, så kommer denne siden tilbake av seg selv. - Tillat varseltilgang - Ingen varslinger. - %1$d varslinger - Fjern Skjermbilder FPS krever at HUD-en er på Fart @@ -2868,6 +2860,8 @@ Øverst Nederst Midten (standard) + Venstre + Høyre Lagring Måler lagring… Første gang tar noen sekunder. @@ -3661,4 +3655,7 @@ Tilbakestill plasseringer Vis etikett Kunne ikke importere dette oppsettet + + Skarlagenssnø + diff --git a/app/src/main/res/values-nl/strings.xml b/app/src/main/res/values-nl/strings.xml index 3c95abdec0..a7bd52c016 100644 --- a/app/src/main/res/values-nl/strings.xml +++ b/app/src/main/res/values-nl/strings.xml @@ -1231,7 +1231,6 @@ Gamepad Stick Trackpad - Wisselen tussen stick en trackpad Bediening op tweede scherm sluiten Steam-menu openen Rechtertrackpad @@ -1778,13 +1777,6 @@ Shadercache downloaden Gepauzeerd Wacht om te starten - Meldingen - DroidDeck onderste scherm - Toon berichten en andere meldingen hier terwijl je speelt. Ze blijven alleen op dit scherm en worden niet opgeslagen. Android vraagt dit één keer: de pagina voor meldingstoegang opent op dit scherm; zet DroidDeck daar aan en deze pagina komt vanzelf terug. - Meldingstoegang toestaan - Geen meldingen. - %1$d meldingen - Wissen Screenshots Voor FPS moet de HUD aan staan Snelheid @@ -2868,6 +2860,8 @@ Boven Onder Midden (standaard) + Links + Rechts Opslag Opslag meten… De eerste keer duurt een paar seconden. @@ -3661,4 +3655,7 @@ Posities herstellen Label tonen Deze indeling kan niet worden geïmporteerd + + Scharlakenrode sneeuw + diff --git a/app/src/main/res/values-pl/strings.xml b/app/src/main/res/values-pl/strings.xml index 50a12cc923..4d00ba2ee8 100644 --- a/app/src/main/res/values-pl/strings.xml +++ b/app/src/main/res/values-pl/strings.xml @@ -1245,7 +1245,6 @@ Gamepad Gałka Trackpad - Przełącz między gałką a trackpadem Zamknij sterowanie na drugim ekranie Otwórz menu Steam Prawy trackpad @@ -1826,13 +1825,6 @@ Pobieranie pamięci podręcznej shaderów Wstrzymano Oczekuje na rozpoczęcie - Powiadomienia - Dolny ekran DroidDeck - Wyświetlaj tu wiadomości i inne powiadomienia podczas gry. Pozostają tylko na tym ekranie i nie są zapisywane. Android zapyta raz: na tym ekranie otworzy się jego strona dostępu do powiadomień; włącz tam DroidDeck, a ta strona wróci sama. - Zezwól na dostęp do powiadomień - Brak powiadomień. - Powiadomienia: %1$d - Wyczyść Zrzuty ekranu FPS wymaga włączonego HUD Prędkość @@ -2926,6 +2918,8 @@ Góra Dół Środek (domyślnie) + Lewo + Prawo Pamięć Mierzenie pamięci… Pierwszy raz trwa kilka sekund. @@ -3739,4 +3733,7 @@ Resetuj położenie Pokaż etykietę Nie można zaimportować tego układu + + Szkarłatny śnieg + diff --git a/app/src/main/res/values-pt-rPT/strings.xml b/app/src/main/res/values-pt-rPT/strings.xml index 6155586865..17ff8cbac3 100644 --- a/app/src/main/res/values-pt-rPT/strings.xml +++ b/app/src/main/res/values-pt-rPT/strings.xml @@ -1230,7 +1230,6 @@ Comando Joystick Trackpad - Alternar entre joystick e trackpad Fechar controlos do segundo ecrã Abrir menu Steam Trackpad direito @@ -1794,13 +1793,6 @@ A transferir a cache de shaders Em pausa A aguardar início - Notificações - Ecrã inferior do DroidDeck - Mostre aqui mensagens e outras notificações enquanto joga. Ficam apenas neste ecrã e não são guardadas. O Android pergunta uma vez: a página de acesso às notificações abre neste ecrã; ative lá o DroidDeck e esta página volta automaticamente. - Permitir acesso às notificações - Sem notificações. - %1$d notificações - Limpar Capturas de ecrã O FPS requer o HUD ativado Velocidade @@ -2895,6 +2887,8 @@ Espaço livre desconhecido Posição da imagem Topo + Esquerda + Direita Fundo Centro (predefinido) Armazenamento @@ -3700,4 +3694,7 @@ Repor posições Mostrar etiqueta Não foi possível importar este esquema + + Neve Escarlate + diff --git a/app/src/main/res/values-pt/strings.xml b/app/src/main/res/values-pt/strings.xml index 6844f0614f..73d1a4c4c9 100644 --- a/app/src/main/res/values-pt/strings.xml +++ b/app/src/main/res/values-pt/strings.xml @@ -1230,7 +1230,6 @@ Controle Analógico Trackpad - Alternar entre analógico e trackpad Fechar controles da segunda tela Abrir o menu Steam Trackpad direito @@ -1794,13 +1793,6 @@ Baixando o cache de shaders Pausado Aguardando para começar - Notificações - Tela inferior do DroidDeck - Mostre aqui mensagens e outras notificações enquanto você joga. Elas ficam só nesta tela e não são salvas. O Android pergunta uma vez: a página de acesso a notificações dele abre nesta tela; ative o DroidDeck lá e esta página volta sozinha. - Permitir acesso a notificações - Nenhuma notificação. - %1$d notificações - Limpar Capturas de tela O FPS precisa do HUD ativado Velocidade @@ -2895,6 +2887,8 @@ Espaço livre desconhecido Posição da imagem Topo + Esquerda + Direita Base Centro (padrão) Armazenamento @@ -3700,4 +3694,7 @@ Redefinir posições Mostrar rótulo Não foi possível importar este layout + + Neve Escarlate + diff --git a/app/src/main/res/values-ro/strings.xml b/app/src/main/res/values-ro/strings.xml index adacea847a..d3b8b9269b 100644 --- a/app/src/main/res/values-ro/strings.xml +++ b/app/src/main/res/values-ro/strings.xml @@ -1238,7 +1238,6 @@ Gamepad Manșă Trackpad - Comută între manșă și trackpad Închide comenzile celui de-al doilea ecran Deschide meniul Steam Trackpad-ul drept @@ -1802,13 +1801,6 @@ Se descarcă cache-ul de shadere Întrerupt Așteaptă să înceapă - Notificări - Ecranul de jos DroidDeck - Afișează aici mesajele și alte notificări în timp ce te joci. Rămân doar pe acest ecran și nu sunt salvate. Android întreabă o singură dată: pagina sa de acces la notificări se deschide pe acest ecran; activează DroidDeck acolo, iar această pagină revine singură. - Permite accesul la notificări - Nicio notificare. - Notificări: %1$d - Șterge Capturi de ecran FPS necesită HUD-ul activat Viteză @@ -2897,6 +2889,8 @@ Sus Jos Centru (implicit) + Stânga + Dreapta Stocare Se măsoară stocarea… Prima dată durează câteva secunde. @@ -3700,4 +3694,7 @@ Resetează pozițiile Afișează eticheta Acest aranjament nu a putut fi importat + + Zăpadă stacojie + diff --git a/app/src/main/res/values-ru/strings.xml b/app/src/main/res/values-ru/strings.xml index bf5f9f5c3a..89dc1b2d78 100644 --- a/app/src/main/res/values-ru/strings.xml +++ b/app/src/main/res/values-ru/strings.xml @@ -1282,7 +1282,6 @@ Геймпад Стик Тачпад - Переключение между стиком и тачпадом Закрыть управление вторым экраном Открыть меню Steam Правый тачпад @@ -1889,13 +1888,6 @@ Загрузка кэша шейдеров Приостановлено Ожидает начала - Уведомления - Нижний экран DroidDeck - Показывает сообщения и другие уведомления здесь, пока вы играете. Они отображаются только на этом экране и не сохраняются. Android спросит один раз: на этом экране откроется страница доступа к уведомлениям; включите там DroidDeck, и эта страница вернется сама. - Разрешить доступ к уведомлениям - Нет уведомлений. - Уведомлений: %1$d - Очистить Скриншоты Для FPS нужно включить HUD Скорость @@ -3009,6 +3001,8 @@ Сверху Снизу По центру (по умолчанию) + Слева + Справа Хранилище Измерение хранилища… В первый раз занимает несколько секунд. @@ -3822,4 +3816,7 @@ Сбросить положение Показывать подпись Не удалось импортировать эту раскладку + + Алый снег + diff --git a/app/src/main/res/values-sv/strings.xml b/app/src/main/res/values-sv/strings.xml index ea17595fcd..c8a3088a00 100644 --- a/app/src/main/res/values-sv/strings.xml +++ b/app/src/main/res/values-sv/strings.xml @@ -1231,7 +1231,6 @@ Handkontroll Styrspak Styrplatta - Växla mellan styrspak och styrplatta Stäng kontrollerna på andra skärmen Öppna Steam-menyn Höger styrplatta @@ -1778,13 +1777,6 @@ Laddar ned shadercache Pausad Väntar på att starta - Aviseringar - DroidDecks nedre skärm - Visa meddelanden och andra aviseringar här medan du spelar. De visas bara på den här skärmen och sparas inte. Android frågar en gång: sidan för aviseringsåtkomst öppnas på den här skärmen; slå på DroidDeck där så kommer den här sidan tillbaka av sig själv. - Tillåt aviseringsåtkomst - Inga aviseringar. - %1$d aviseringar - Rensa Skärmbilder FPS kräver att HUD:en är på Hastighet @@ -2868,6 +2860,8 @@ Överst Nederst Mitten (standard) + Vänster + Höger Lagring Mäter lagring… Första gången tar några sekunder. @@ -3661,4 +3655,7 @@ Återställ positioner Visa etikett Det gick inte att importera layouten + + Scharlakansröd snö + diff --git a/app/src/main/res/values-th/strings.xml b/app/src/main/res/values-th/strings.xml index 7ba21346d9..4bbe6cf467 100644 --- a/app/src/main/res/values-th/strings.xml +++ b/app/src/main/res/values-th/strings.xml @@ -1224,7 +1224,6 @@ เกมแพด สติ๊ก แทร็กแพด - สลับระหว่างสติ๊กและแทร็กแพด ปิดการควบคุมหน้าจอที่สอง เปิดเมนู Steam แทร็กแพดขวา @@ -1754,13 +1753,6 @@ กำลังดาวน์โหลดแคชเชเดอร์ หยุดชั่วคราว กำลังรอเริ่ม - การแจ้งเตือน - หน้าจอล่างของ DroidDeck - แสดงข้อความและการแจ้งเตือนอื่นๆ ที่นี่ขณะที่คุณเล่น การแจ้งเตือนจะแสดงบนหน้าจอนี้เท่านั้นและจะไม่ถูกบันทึก Android จะถามเพียงครั้งเดียว: หน้าการเข้าถึงการแจ้งเตือนจะเปิดขึ้นบนหน้าจอนี้ เปิด DroidDeck ที่นั่น แล้วหน้านี้จะกลับมาเอง - อนุญาตการเข้าถึงการแจ้งเตือน - ไม่มีการแจ้งเตือน - การแจ้งเตือน %1$d รายการ - ล้าง ภาพหน้าจอ ต้องเปิด HUD เพื่อแสดง FPS ความเร็ว @@ -2839,6 +2831,8 @@ บน ล่าง กลาง (ค่าเริ่มต้น) + ซ้าย + ขวา พื้นที่จัดเก็บ กำลังวัดพื้นที่… ครั้งแรกใช้เวลาสองสามวินาที @@ -3631,4 +3625,7 @@ รีเซ็ตตำแหน่ง แสดงป้ายกำกับ ไม่สามารถนำเข้าการจัดวางนี้ได้ + + หิมะสีแดงชาด + diff --git a/app/src/main/res/values-tr/strings.xml b/app/src/main/res/values-tr/strings.xml index 32bd1a0c6d..1d53a2d478 100644 --- a/app/src/main/res/values-tr/strings.xml +++ b/app/src/main/res/values-tr/strings.xml @@ -1223,7 +1223,6 @@ Oyun kolu Çubuk Dokunmatik yüzey - Çubuk ile dokunmatik yüzey arasında geçiş yap İkinci ekran kontrollerini kapat Steam menüsünü aç Sağ dokunmatik yüzey @@ -1770,13 +1769,6 @@ Gölgelendirici önbelleği indiriliyor Duraklatıldı Başlamayı bekliyor - Bildirimler - DroidDeck alt ekranı - Oynarken mesajları ve diğer bildirimleri burada görün. Yalnızca bu ekranda kalırlar ve kaydedilmezler. Android bunu bir kez sorar: bildirim erişimi sayfası bu ekranda açılır; orada DroidDeck\'i açın, bu sayfa kendiliğinden geri gelir. - Bildirim erişimine izin ver - Bildirim yok. - %1$d bildirim - Temizle Ekran görüntüleri FPS için HUD açık olmalı Hız @@ -2868,6 +2860,8 @@ Üst Alt Orta (varsayılan) + Sol + Sağ Depolama Depolama ölçülüyor… İlk seferde birkaç saniye sürer. @@ -3661,4 +3655,7 @@ Konumları sıfırla Etiketi göster Bu düzen içe aktarılamadı + + Kızıl Kar + diff --git a/app/src/main/res/values-uk/strings.xml b/app/src/main/res/values-uk/strings.xml index 8990fa9770..79eb4138e0 100644 --- a/app/src/main/res/values-uk/strings.xml +++ b/app/src/main/res/values-uk/strings.xml @@ -1245,7 +1245,6 @@ Геймпад Стік Трекпад - Перемкнути між стіком і трекпадом Закрити керування на другому екрані Відкрити меню Steam Правий трекпад @@ -1826,13 +1825,6 @@ Завантаження кешу шейдерів Призупинено Очікує початку - Сповіщення - Нижній екран DroidDeck - Показуйте тут повідомлення та інші сповіщення під час гри. Вони лишаються лише на цьому екрані й не зберігаються. Android запитає один раз: сторінка доступу до сповіщень відкриється на цьому екрані; увімкніть там DroidDeck, і ця сторінка повернеться сама. - Дозволити доступ до сповіщень - Немає сповіщень. - Сповіщень: %1$d - Очистити Знімки екрана Для FPS потрібно ввімкнути HUD Швидкість @@ -2926,6 +2918,8 @@ Угорі Унизу По центру (типово) + Ліворуч + Праворуч Сховище Вимірювання сховища… Уперше триває кілька секунд. @@ -3739,4 +3733,7 @@ Скинути розташування Показувати підпис Не вдалося імпортувати цю розкладку + + Багряний сніг + diff --git a/app/src/main/res/values-vi/strings.xml b/app/src/main/res/values-vi/strings.xml index 24455764a2..537168797a 100644 --- a/app/src/main/res/values-vi/strings.xml +++ b/app/src/main/res/values-vi/strings.xml @@ -1224,7 +1224,6 @@ Tay cầm Cần Trackpad - Chuyển giữa cần và trackpad Đóng điều khiển màn hình phụ Mở menu Steam Trackpad phải @@ -1754,13 +1753,6 @@ Đang tải bộ nhớ đệm shader Đã tạm dừng Đang chờ bắt đầu - Thông báo - Màn hình dưới DroidDeck - Hiển thị tin nhắn và các thông báo khác ở đây khi bạn chơi. Chúng chỉ ở trên màn hình này và không được lưu. Android chỉ hỏi một lần: trang quyền truy cập thông báo sẽ mở trên màn hình này; hãy bật DroidDeck ở đó và trang này sẽ tự quay lại. - Cho phép truy cập thông báo - Không có thông báo. - %1$d thông báo - Xóa Ảnh chụp màn hình Cần bật HUD để xem FPS Tốc độ @@ -2839,6 +2831,8 @@ Trên Dưới Giữa (mặc định) + Trái + Phải Lưu trữ Đang đo dung lượng… Lần đầu mất vài giây. @@ -3631,4 +3625,7 @@ Đặt lại vị trí Hiện nhãn Không thể nhập bố cục này + + Tuyết đỏ thẫm + diff --git a/app/src/main/res/values-zh-rCN/strings.xml b/app/src/main/res/values-zh-rCN/strings.xml index 02430fafc8..8f0ab9c57b 100644 --- a/app/src/main/res/values-zh-rCN/strings.xml +++ b/app/src/main/res/values-zh-rCN/strings.xml @@ -1308,7 +1308,6 @@ 手柄 摇杆 触控板 - 在摇杆与触控板之间切换 关闭副屏控制 打开 Steam 菜单 右触控板 @@ -1832,13 +1831,6 @@ 正在下载着色器缓存 已暂停 等待开始 - 通知 - DroidDeck 底部屏幕 - 在游戏时于此处显示消息和其他通知。通知只显示在此屏幕上,不会被保存。Android 只会询问一次:其通知使用权页面会在此屏幕上打开,在那里开启 DroidDeck 后,会自动返回此页面。 - 允许通知使用权 - 没有通知。 - %1$d 条通知 - 清除 截图 显示 FPS 需要开启 HUD 速度 @@ -2843,6 +2835,8 @@ 置顶 置底 居中(默认) + 左侧 + 右侧 存储 正在统计存储… 首次统计需要几秒钟。 @@ -3635,4 +3629,7 @@ 重置位置 显示标签 无法导入此布局 + + 猩红之雪 + diff --git a/app/src/main/res/values-zh-rHK/strings.xml b/app/src/main/res/values-zh-rHK/strings.xml index bb6092f6ff..b8d2bf0846 100644 --- a/app/src/main/res/values-zh-rHK/strings.xml +++ b/app/src/main/res/values-zh-rHK/strings.xml @@ -1224,7 +1224,6 @@ 控制器 搖桿 觸控板 - 在搖桿和觸控板之間切換 關閉第二螢幕控制 開啟 Steam 選單 右側觸控板 @@ -1754,13 +1753,6 @@ 正在下載著色器快取 已暫停 等待開始 - 通知 - DroidDeck 下方螢幕 - 在遊玩時於此處顯示訊息和其他通知。通知只會顯示在這個螢幕上,不會儲存。Android 只會詢問一次:通知存取權頁面會在這個螢幕上開啟,在那裡開啟 DroidDeck 後,就會自動回到此頁面。 - 允許通知存取權 - 沒有通知。 - %1$d 則通知 - 清除 螢幕截圖 顯示 FPS 需要開啟 HUD 速度 @@ -2839,6 +2831,8 @@ 置頂 置底 置中(預設) + 左側 + 右側 儲存空間 正在統計儲存空間… 首次統計需要幾秒鐘。 @@ -3634,4 +3628,7 @@ 重設位置 顯示標籤 無法匯入此佈局 + + 緋紅之雪 + diff --git a/app/src/main/res/values-zh-rTW/strings.xml b/app/src/main/res/values-zh-rTW/strings.xml index cc4f1f2340..8b883d4a89 100644 --- a/app/src/main/res/values-zh-rTW/strings.xml +++ b/app/src/main/res/values-zh-rTW/strings.xml @@ -1224,7 +1224,6 @@ 手把 搖桿 觸控板 - 在搖桿與觸控板之間切換 關閉第二螢幕控制 開啟 Steam 選單 右側觸控板 @@ -1754,13 +1753,6 @@ 正在下載著色器快取 已暫停 等待開始 - 通知 - DroidDeck 底部螢幕 - 在遊玩時於此處顯示訊息和其他通知。通知只會顯示在這個螢幕上,不會儲存。Android 只會詢問一次:通知存取權頁面會在這個螢幕上開啟,在那裡開啟 DroidDeck 後,就會自動回到此頁面。 - 允許通知存取權 - 沒有通知。 - %1$d 則通知 - 清除 螢幕擷取畫面 顯示 FPS 需要開啟 HUD 速度 @@ -2839,6 +2831,8 @@ 置頂 置底 置中(預設) + 左側 + 右側 儲存空間 正在統計儲存空間… 首次統計需要幾秒鐘。 @@ -3634,4 +3628,7 @@ 重設位置 顯示標籤 無法匯入此版面配置 + + 緋紅之雪 + diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml index 857185f8b1..309d3e4154 100644 --- a/app/src/main/res/values/strings.xml +++ b/app/src/main/res/values/strings.xml @@ -648,7 +648,10 @@ Disables Proton\'s gamepad navigation helper, which costs CPU in every game. Run proot without seccomp May fix missing-syscall errors on some kernels. Can reduce performance. + Run without proot (experimental) + Starts the Linux side directly on Android. Applies to the next session. Turn off if something fails to start. proot fast path + Not used without proot. Needs proot\'s seccomp filter. Faster file lookups and less stutter. Turn off if a program can\'t find its files. Draw the cursor inside gamescope @@ -1118,6 +1121,29 @@ Test builds Try a fix before it\'s released None right now + Lab build + Lab builds + In use + Paused after Android re-optimized DroidDeck + Not loaded: %1$s + Waiting for a restart + Kept + For another version + Rebuild + Deletes this build from the device + Restart on it + Turn off + Use + Delete + Delete now + Could not prepare the restart: %1$s. Pair wireless debugging in Setup and try again. + Lab build installed + DroidDeck restarted on %1$s + Lab build paused + Android re-optimized DroidDeck, so %1$s is not loaded. Open Updates to restart on it. + Lab build turned off + It was built for another version of DroidDeck. It is kept in Updates. + DroidDeck did not start on it twice PR #%1$d Not built for this copy of DroidDeck Updated %1$s @@ -1382,7 +1408,6 @@ Gamepad Stick Trackpad - Switch between stick and trackpad Close second-screen controls Open Steam menu Right trackpad @@ -1966,13 +1991,6 @@ Downloading shader cache Paused Waiting to start - Notifications - DroidDeck bottom screen - Show messages and other notifications here while you play. They stay on this screen only and are not saved. Android asks once: its notification access page opens on this screen; turn DroidDeck on there and this page comes back by itself. - Allow notification access - No notifications. - %1$d notifications - Clear Screenshots FPS needs the HUD on Speed @@ -3114,6 +3132,8 @@ Experimental Pro 2 head tracking. Brightness, volume, and display switching are not supported yet. Picture position Top + Left + Right Bottom Center (default) 6DoF virtual screen @@ -3822,4 +3842,7 @@ Reset positions Show label Could not import this layout + + Scarlet Snow + White surfaces with red accents. diff --git a/app/src/main/resources/ea/graphql/GameImages.gql b/app/src/main/resources/ea/graphql/GameImages.gql new file mode 100644 index 0000000000..92d8a50b87 --- /dev/null +++ b/app/src/main/resources/ea/graphql/GameImages.gql @@ -0,0 +1,69 @@ +query GameImages($gameSlug: String!, $locale: Locale!) { + game(slug: $gameSlug, locale: $locale) { + id + slug + title + keyArt { + ...imageRenditionData + __typename + } + packArt { + ...PackArt + __typename + } + ...PrimaryLogo + __typename + } +} + +fragment imageRenditionData on ImageRendition { + path + aspect9x16Image { + path + __typename + } + aspect16x9Image { + path + __typename + } + aspect1x1Image { + path + __typename + } + largestImage { + path + __typename + } + rawImages { + path + __typename + } + __typename +} + +fragment PrimaryLogo on GameV2 { + primaryLogo(uiClientContexts: ["juno-web-game-tile"]) { + path + title + largestImage { + path + width + height + __typename + } + __typename + } + __typename +} + +fragment PackArt on ImageRendition { + aspect2x1Image { + path + __typename + } + aspect9x16Image { + path + __typename + } + __typename +} diff --git a/app/src/main/resources/ea/graphql/GetUserPlayer.gql b/app/src/main/resources/ea/graphql/GetUserPlayer.gql new file mode 100644 index 0000000000..4094c264ab --- /dev/null +++ b/app/src/main/resources/ea/graphql/GetUserPlayer.gql @@ -0,0 +1,49 @@ +query GetUserPlayer { + me { + id: pd + pd + player { + ...Player + __typename + } + __typename + } +} + +fragment Player on Player { + id: pd + pd + psd + displayName + uniqueName + nickname + avatar { + ...Avatar + __typename + } + relationship + __typename +} + +fragment Avatar on AvatarList { + large { + ...image + __typename + } + medium { + ...image + __typename + } + small { + ...image + __typename + } + __typename +} + +fragment image on Image { + height + width + path + __typename +} diff --git a/app/src/main/resources/ea/graphql/availableBuilds.gql b/app/src/main/resources/ea/graphql/availableBuilds.gql new file mode 100644 index 0000000000..b410f0a7f9 --- /dev/null +++ b/app/src/main/resources/ea/graphql/availableBuilds.gql @@ -0,0 +1,9 @@ +query availableBuilds($offerId: String!) { + availableBuilds(offerId: $offerId) { + buildId + downloadType + gameVersion + buildLiveDate + __typename + } +} diff --git a/app/src/main/resources/ea/graphql/downloadUrl.gql b/app/src/main/resources/ea/graphql/downloadUrl.gql new file mode 100644 index 0000000000..0110c64f93 --- /dev/null +++ b/app/src/main/resources/ea/graphql/downloadUrl.gql @@ -0,0 +1,7 @@ +query downloadUrl($offerId: String!, $buildId: String) { + downloadUrl(offerId: $offerId, buildId: $buildId) { + url + syncUrl + __typename + } +} diff --git a/app/src/main/resources/ea/graphql/getLegacyCatalogDefs.gql b/app/src/main/resources/ea/graphql/getLegacyCatalogDefs.gql new file mode 100644 index 0000000000..6d3da0d9f8 --- /dev/null +++ b/app/src/main/resources/ea/graphql/getLegacyCatalogDefs.gql @@ -0,0 +1,66 @@ +query getLegacyCatalogDefs($offerIds: [String!]!, $locale: Locale) { + legacyOffers(offerIds: $offerIds, locale: $locale) { + offerId: id + contentId + basePlatform + primaryMasterTitleId + mdmProjectNumber + achievementSetOverride + gameLauncherURL + gameLauncherURLClientID + stagingKeyPath + mdmTitleIds + multiplayerId + executePathOverride + installationDirectory + installCheckOverride + monitorPlay + displayName + displayType + igoBrowserDefaultUrl + executeParameters + softwareLocales + dipManifestRelativePath + metadataInstallLocation + distributionSubType + downloads { + igoApiEnabled + downloadType + version + executeElevated + buildReleaseVersion + buildLiveDate + buildMetaData + gameVersion + treatUpdatesAsMandatory + enableDifferentialUpdate + __typename + } + locale + greyMarketControls + isDownloadable + isPreviewDownload + downloadStartDate + releaseDate + useEndDate + subscriptionUnlockDate + subscriptionUseEndDate + softwarePlatform + softwareId + downloadPackageType + installerPath + processorArchitecture + macBundleID + gameEditionTypeFacetKeyRankDesc + appliedCountryCode + cloudSaveConfigurationOverride + firstParties{ + partner + partnerId + partnerIdType + __typename + } + suppressedOfferIds + __typename + } +} diff --git a/app/src/main/resources/ea/graphql/getLegacyEntitlements.gql b/app/src/main/resources/ea/graphql/getLegacyEntitlements.gql new file mode 100644 index 0000000000..d4a6de1012 --- /dev/null +++ b/app/src/main/resources/ea/graphql/getLegacyEntitlements.gql @@ -0,0 +1,33 @@ +query getLegacyEntitlements($limit: Int, $next: String, $storeFronts: [UserLegacyEntitlementStorefront!]!) { + me { + legacyEntitlements( + paging: {limit: $limit, next: $next}, + storefronts: $storeFronts, + status: [ACTIVE, DISABLED] + ) { + next + items { + cdKey + entitlementTag + entitlementType + externalType + grantDate + groupName + id + isSubscription + isSubscriptionExpired + lastModifiedDate + originPermissions + productId + status + statusReasonCode + terminationDate + trialTimeRemainingSeconds + useCount + version + __typename + } + __typename + } + } +} \ No newline at end of file diff --git a/app/src/main/resources/ea/graphql/getPreloadedOwnedGames.gql b/app/src/main/resources/ea/graphql/getPreloadedOwnedGames.gql new file mode 100644 index 0000000000..b3a5a488eb --- /dev/null +++ b/app/src/main/resources/ea/graphql/getPreloadedOwnedGames.gql @@ -0,0 +1,69 @@ +query getPreloadedOwnedGames($next: String, $locale: Locale, $limit: Int, $type: [GameProductType!]!, $entitlementEnabled: Boolean, $isMac: Boolean = false, $storefronts: [UserGameProductStorefront!], $ownershipMethods: [OwnershipMethod!], $processorArchitectures: [ProcessorArchitecture!], $platforms: [GamePlatform!]!) { + me { + id: pd + ownedGameProducts(storefronts: $storefronts, locale: $locale, paging: {limit: $limit, next: $next}, productFound: true, orderBy: {field: NAME, direction: ASC}, ownershipMethod: $ownershipMethods, processorArchitectures: $processorArchitectures, type: $type, downloadableOnly: false, entitlementEnabled: $entitlementEnabled, platforms: $platforms) { + next + totalCount + items { + ...userGameProductFragment + __typename + } + __typename + } + __typename + } +} + +fragment userGameProductFragment on UserGameProduct { + id: originOfferId + originOfferId + status + product { + ...OwnedGameProductFragment + __typename + } + __typename +} + +fragment OwnedGameProductFragment on GameProduct { + id + name + downloadable + gameSlug + trialDetails { + trialType + __typename + } + baseItem(availabilities: [VISIBLE]) { + title + id + baseGameSlug + gameType + __typename + } + gamePlatformDetails @include(if: $isMac) { + gamePlatform + __typename + } + processorArchitectureDetails @include(if: $isMac) { + processorArchitecture + platform + __typename + } + gameProductUser(storefronts: $storefronts) { + ownershipMethods + initialEntitlementDate + entitlementId + gameProductUserTrial { + trialTimeRemainingSeconds + __typename + } + status + __typename + } + purchaseStatus { + repurchasable + __typename + } + __typename +} diff --git a/app/src/main/resources/ea/graphql/sdkEntitlements.gql b/app/src/main/resources/ea/graphql/sdkEntitlements.gql new file mode 100644 index 0000000000..df6613663e --- /dev/null +++ b/app/src/main/resources/ea/graphql/sdkEntitlements.gql @@ -0,0 +1,27 @@ +query sdkEntitlements($productIds: [String!]!, $includeChildGroups: Boolean!, $groupNames: [String!]!, $entitlementTag: String!, $pageSize: Int!, $pageNumber: Int!) { + me { + sdkEntitlements( + productIds: $productIds, + includeChildGroups: $includeChildGroups, + groupNames: $groupNames, + entitlementTag: $entitlementTag, + paging: { + pageSize: $pageSize, pageNumber: $pageNumber + } + ) { + entitlements { + entitlementTag + entitlementType + grantDate + groupName + id + productId + terminationDate + useCount + version + __typename + } + __typename + } + } +} diff --git a/app/src/main/rust/stores/Cargo.lock b/app/src/main/rust/stores/Cargo.lock index 2fac37c5aa..6a470b3bea 100644 --- a/app/src/main/rust/stores/Cargo.lock +++ b/app/src/main/rust/stores/Cargo.lock @@ -195,10 +195,13 @@ dependencies = [ "libc", "lzma-rs", "reqwest", + "ruzstd", "serde_json", "sha1", "sha2", "tokio", + "tokio-rustls", + "webpki-roots", ] [[package]] @@ -897,6 +900,15 @@ version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d" +[[package]] +name = "ruzstd" +version = "0.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a7c1c839d570d835527c9a5e4db7cb2198683a988cb9d7293fc8674e6bd58fc8" +dependencies = [ + "twox-hash", +] + [[package]] name = "ryu" version = "1.0.23" @@ -1243,6 +1255,12 @@ version = "0.2.5" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" +[[package]] +name = "twox-hash" +version = "2.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "86a801b3cea342a06d468c8710662aa29e5e05e4f5c0d62f00bbb7f2ad7941c2" + [[package]] name = "typenum" version = "1.20.0" diff --git a/app/src/main/rust/stores/Cargo.toml b/app/src/main/rust/stores/Cargo.toml index 61d121a22a..97a27659a1 100644 --- a/app/src/main/rust/stores/Cargo.toml +++ b/app/src/main/rust/stores/Cargo.toml @@ -15,11 +15,14 @@ libc = "0.2" lzma-rs = { version = "0.3", default-features = false } flate2 = { version = "1", default-features = false, features = ["rust_backend"] } reqwest = { version = "0.12", default-features = false, features = ["rustls-tls", "gzip"] } -tokio = { version = "1", default-features = false, features = ["rt", "net", "time", "sync"] } +tokio = { version = "1", default-features = false, features = ["rt", "net", "time", "sync", "io-util"] } futures-util = { version = "0.3", default-features = false, features = ["std"] } serde_json = { version = "1", features = ["preserve_order"] } sha1 = "0.10" sha2 = "0.10" +tokio-rustls = { version = "0.26", default-features = false, features = ["ring", "tls12"] } +webpki-roots = "1" +ruzstd = "0.8" [build-dependencies] cc = "1" diff --git a/app/src/main/rust/stores/src/ea/ffi.rs b/app/src/main/rust/stores/src/ea/ffi.rs new file mode 100644 index 0000000000..7656c6b33e --- /dev/null +++ b/app/src/main/rust/stores/src/ea/ffi.rs @@ -0,0 +1,207 @@ +use std::panic::{catch_unwind, AssertUnwindSafe}; +use std::sync::atomic::{AtomicBool, Ordering}; +use std::sync::Arc; + +use jni::objects::{GlobalRef, JClass, JObject, JString, JValue}; +use jni::sys::{jlong, jstring, JNI_FALSE, JNI_TRUE}; +use jni::{JNIEnv, JavaVM}; +use serde_json::json; + +use super::install; +use crate::amazon::install::{Events, Stop}; + +fn read_string(env: &mut JNIEnv, value: &JString) -> String { + if value.is_null() { + return String::new(); + } + env.get_string(value).map(|s| s.to_string_lossy().into_owned()).unwrap_or_default() +} + +fn new_string(env: &mut JNIEnv, text: &str) -> jstring { + env.new_string(text).map(|s| s.into_raw()).unwrap_or(std::ptr::null_mut()) +} + +fn call(op: &str, request: &str) -> String { + let parsed: serde_json::Value = serde_json::from_str(request).unwrap_or(serde_json::Value::Null); + let url = parsed.get("url").and_then(|v| v.as_str()).unwrap_or(""); + let answer = match op { + "zip.size" => install::size(url).unwrap_or_else(|e| json!({ "error": e })), + _ => json!({ "error": format!("unknown operation {op}") }), + }; + answer.to_string() +} + +#[no_mangle] +pub extern "system" fn Java_com_droiddeck_launcher_stores_ea_EaNative_nativeCall( + mut env: JNIEnv, + _class: JClass, + op: JString, + request: JString, +) -> jstring { + let op = read_string(&mut env, &op); + let request = read_string(&mut env, &request); + match catch_unwind(AssertUnwindSafe(|| call(&op, &request))) { + Ok(text) => new_string(&mut env, &text), + Err(_) => std::ptr::null_mut(), + } +} + +struct Listener { + vm: JavaVM, + target: GlobalRef, +} + +impl Listener { + fn with_env(&self, fallback: R, f: impl FnOnce(&mut JNIEnv) -> R) -> R { + let Ok(mut env) = self.vm.attach_current_thread_as_daemon() else { + return fallback; + }; + let out = f(&mut env); + if env.exception_check().unwrap_or(false) { + let _ = env.exception_clear(); + } + out + } + + fn text(&self, method: &str, text: &str) { + self.with_env((), |env| { + let Ok(s) = env.new_string(text) else { return }; + let s = JObject::from(s); + let _ = env.call_method(self.target.as_obj(), method, "(Ljava/lang/String;)V", &[JValue::Object(&s)]); + let _ = env.delete_local_ref(s); + }); + } + + fn counts(&self, method: &str, a: u64, b: u64, c: u32, d: u32) { + self.with_env((), |env| { + let _ = env.call_method( + self.target.as_obj(), + method, + "(JJII)V", + &[ + JValue::Long(a.min(i64::MAX as u64) as i64), + JValue::Long(b.min(i64::MAX as u64) as i64), + JValue::Int(c.min(i32::MAX as u32) as i32), + JValue::Int(d.min(i32::MAX as u32) as i32), + ], + ); + }); + } + + fn complete(&self, success: bool, cancelled: bool, error: &str, result: &str) { + self.with_env((), |env| { + let (Ok(e), Ok(r)) = (env.new_string(error), env.new_string(result)) else { return }; + let (e, r) = (JObject::from(e), JObject::from(r)); + let _ = env.call_method( + self.target.as_obj(), + "onComplete", + "(ZZLjava/lang/String;Ljava/lang/String;)V", + &[ + JValue::Bool(if success { JNI_TRUE } else { JNI_FALSE }), + JValue::Bool(if cancelled { JNI_TRUE } else { JNI_FALSE }), + JValue::Object(&e), + JValue::Object(&r), + ], + ); + let _ = env.delete_local_ref(e); + let _ = env.delete_local_ref(r); + }); + } +} + +impl Events for Listener { + fn log(&self, line: &str) { + self.text("onLog", &crate::amazon::net::scrub_urls(line)); + } + + fn status(&self, text: &str) { + self.text("onStatus", text); + } + + fn checking(&self, done_bytes: u64, total_bytes: u64, files: u32, files_total: u32) { + self.counts("onCheck", done_bytes, total_bytes, files, files_total); + } + + fn sizes(&self, pending_bytes: u64, total_bytes: u64) { + self.with_env((), |env| { + let _ = env.call_method( + self.target.as_obj(), + "onSizes", + "(JJ)V", + &[ + JValue::Long(pending_bytes.min(i64::MAX as u64) as i64), + JValue::Long(total_bytes.min(i64::MAX as u64) as i64), + ], + ); + }); + } + + fn progress(&self, done: u64, total: u64, files: u32, files_total: u32) { + self.counts("onProgress", done, total, files, files_total); + } + + fn before_replace(&self) -> bool { + self.with_env(false, |env| match env.call_method(self.target.as_obj(), "beforeReplace", "()Z", &[]) { + Ok(v) => v.z().unwrap_or(false), + Err(_) => false, + }) + } +} + +#[no_mangle] +pub extern "system" fn Java_com_droiddeck_launcher_stores_ea_EaNative_nativeInstall( + mut env: JNIEnv, + _class: JClass, + request: JString, + listener: JObject, +) -> jlong { + if listener.is_null() { + return 0; + } + let Ok(vm) = env.get_java_vm() else { return 0 }; + let Ok(target) = env.new_global_ref(&listener) else { return 0 }; + let listener = Listener { vm, target }; + let text = read_string(&mut env, &request); + let parsed = serde_json::from_str::(&text) + .map_err(|_| "The install request could not be read".to_string()) + .and_then(|v| install::Request::from_json(&v)); + let request = match parsed { + Ok(r) => r, + Err(e) => { + listener.complete(false, false, &e, ""); + return 0; + } + }; + let cancel = Arc::new(AtomicBool::new(false)); + let worker_cancel = Arc::clone(&cancel); + let spawned = std::thread::Builder::new().name("ea-install".into()).spawn(move || { + crate::priority::background(); + let result = catch_unwind(AssertUnwindSafe(|| install::run(&request, &worker_cancel, &listener))) + .unwrap_or_else(|_| Err(Stop::Failed("The EA install stopped on an internal error".into()))); + match result { + Ok(done) => listener.complete(true, false, "", &done.to_json().to_string()), + Err(Stop::Cancelled) => listener.complete(false, true, "cancelled", ""), + Err(Stop::Failed(e)) => listener.complete(false, false, &e, ""), + } + }); + if spawned.is_err() { + return 0; + } + Box::into_raw(Box::new(cancel)) as jlong +} + +#[no_mangle] +pub extern "system" fn Java_com_droiddeck_launcher_stores_ea_EaNative_nativeCancel(_env: JNIEnv, _class: JClass, handle: jlong) { + let ptr = handle as *const Arc; + if let Some(cancel) = unsafe { ptr.as_ref() } { + cancel.store(true, Ordering::SeqCst); + } +} + +#[no_mangle] +pub extern "system" fn Java_com_droiddeck_launcher_stores_ea_EaNative_nativeRelease(_env: JNIEnv, _class: JClass, handle: jlong) { + let ptr = handle as *mut Arc; + if !ptr.is_null() { + drop(unsafe { Box::from_raw(ptr) }); + } +} diff --git a/app/src/main/rust/stores/src/ea/install.rs b/app/src/main/rust/stores/src/ea/install.rs new file mode 100644 index 0000000000..fb2cd80ef5 --- /dev/null +++ b/app/src/main/rust/stores/src/ea/install.rs @@ -0,0 +1,850 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +//! Installs or updates an EA game from its build archive: files whose size and CRC already match +//! are kept, everything else is fetched entry by entry with ranged reads and inflated in place. + +use std::collections::{HashMap, HashSet}; +use std::fs::{self, File, OpenOptions}; +use std::io::{Read, Write}; +use std::os::unix::fs::FileExt; +use std::path::{Path, PathBuf}; +use std::sync::atomic::{AtomicBool, AtomicU64, AtomicUsize, Ordering}; +use std::sync::Mutex; +use std::time::{Duration, Instant, UNIX_EPOCH}; + +use flate2::{Crc, Decompress, FlushDecompress, Status}; +use serde_json::{json, Value}; + +use super::net; +use super::zip::{self, Entry}; +use crate::amazon::install::check::{free_bytes, space_problem}; +use crate::amazon::install::{Events, ReplaceGate, Stop}; +use crate::fetch_core::{distinct_host_count, run_fetch, FetchItem, FetchOptions, FetchSink, SinkError}; + +pub const LEDGER: &str = ".droiddeck-ea-files"; +pub const IN_PROGRESS_MARKER: &str = ".droiddeck-ea-downloading"; +const TEMP_SUFFIX: &str = ".ddpart"; +const PROGRESS_EVERY_MS: u64 = 50; +const CHECK_REPORT_EVERY: Duration = Duration::from_millis(200); +const REQUEST_TIMEOUT: Duration = Duration::from_secs(120); +const INFLATE_BUFFER: usize = 256 * 1024; +/// Records larger than this are fetched as parallel ranges into a scratch file, then inflated, +/// so one big file does not ride a single connection. +pub const PART_BYTES: u64 = 16 * 1024 * 1024; +const SPLIT_SUFFIX: &str = ".ddzip"; + +struct Split { + tmp: PathBuf, + file: Mutex>, + received: Vec, + left: AtomicUsize, +} + +#[derive(Clone, Copy)] +enum Work { + Whole(usize), + Part { job: usize, part: usize, start: u64, len: u64 }, +} + +/// The fetches for each job: whole records, or byte ranges of one when it is large. +fn works(jobs: &[&Planned], part_bytes: u64) -> Vec { + let mut out = Vec::new(); + for (i, p) in jobs.iter().enumerate() { + let span = p.range_end - p.entry.local_offset + 1; + if span <= part_bytes * 2 { + out.push(Work::Whole(i)); + continue; + } + let mut start = 0; + let mut part = 0; + while start < span { + let len = part_bytes.min(span - start); + out.push(Work::Part { job: i, part, start, len }); + start += len; + part += 1; + } + } + out +} +pub const REPLACE_REFUSED: &str = "The install record could not be switched to updating; nothing was replaced"; + +pub struct Request { + pub url: String, + pub game_dir: PathBuf, + pub max_workers: usize, + pub process_workers: usize, + pub ca_bundle: String, + pub part_bytes: u64, +} + +impl Request { + pub fn from_json(v: &Value) -> Result { + let text = |k: &str| v.get(k).and_then(|x| x.as_str()).unwrap_or("").to_string(); + let game_dir = text("gameDir"); + if game_dir.is_empty() || !game_dir.starts_with('/') { + return Err("No install folder was given".into()); + } + let url = text("url"); + if !url.starts_with("https://") && !url.starts_with("http://") { + return Err("EA gave no download for this game".into()); + } + Ok(Request { + url, + game_dir: PathBuf::from(game_dir), + max_workers: v.get("maxWorkers").and_then(|n| n.as_u64()).unwrap_or(8) as usize, + process_workers: v.get("processWorkers").and_then(|n| n.as_u64()).unwrap_or(2) as usize, + ca_bundle: text("caBundle"), + part_bytes: v.get("partBytes").and_then(|n| n.as_u64()).filter(|n| *n > 0).unwrap_or(PART_BYTES), + }) + } +} + +#[derive(Debug, Default)] +pub struct Finished { + pub total_bytes: u64, + pub download_bytes: u64, + pub file_count: usize, + pub files_written: usize, + pub bytes_written: u64, + pub removed: usize, +} + +impl Finished { + pub fn to_json(&self) -> Value { + json!({ + "totalBytes": self.total_bytes, + "downloadBytes": self.download_bytes, + "fileCount": self.file_count, + "filesWritten": self.files_written, + "bytesWritten": self.bytes_written, + "removed": self.removed, + }) + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +struct Known { + crc: u32, + size: u64, + modified: u64, +} + +fn modified_ms(path: &Path) -> u64 { + fs::metadata(path) + .and_then(|m| m.modified()) + .ok() + .and_then(|t| t.duration_since(UNIX_EPOCH).ok()) + .map(|d| d.as_millis() as u64) + .unwrap_or(0) +} + +fn read_ledger(dir: &Path) -> HashMap { + let Ok(text) = fs::read_to_string(dir.join(LEDGER)) else { return HashMap::new() }; + let mut out = HashMap::new(); + for line in text.lines() { + let mut parts = line.splitn(4, '\t'); + let (Some(crc), Some(size), Some(modified), Some(path)) = (parts.next(), parts.next(), parts.next(), parts.next()) else { + continue; + }; + let (Ok(crc), Ok(size), Ok(modified)) = (u32::from_str_radix(crc, 16), size.parse(), modified.parse()) else { + continue; + }; + out.insert(path.to_string(), Known { crc, size, modified }); + } + out +} + +fn ledger_line(path: &str, k: Known) -> String { + format!("{:08x}\t{}\t{}\t{path}\n", k.crc, k.size, k.modified) +} + +fn crc_of(path: &Path, cancel: &AtomicBool) -> Result, ()> { + let Ok(mut f) = File::open(path) else { return Ok(None) }; + let mut crc = Crc::new(); + let mut buf = vec![0u8; 1024 * 1024]; + loop { + if cancel.load(Ordering::Relaxed) { + return Err(()); + } + match f.read(&mut buf) { + Ok(0) => return Ok(Some(crc.sum())), + Ok(n) => crc.update(&buf[..n]), + Err(e) if e.kind() == std::io::ErrorKind::Interrupted => {} + Err(_) => return Ok(None), + } + } +} + +/// Whether two paths name one file, as they do for a case-only rename on case-insensitive storage. +fn same_file(a: &Path, b: &Path) -> bool { + use std::os::unix::fs::MetadataExt; + match (fs::metadata(a), fs::metadata(b)) { + (Ok(x), Ok(y)) => x.dev() == y.dev() && x.ino() == y.ino(), + _ => false, + } +} + +fn temp_path(dest: &Path) -> PathBuf { + let mut name = dest.as_os_str().to_owned(); + name.push(TEMP_SUFFIX); + PathBuf::from(name) +} + +pub struct Planned { + pub entry: Entry, + pub path: String, + pub range_end: u64, +} + +/// Every file entry with its safe path and the last byte its local record can occupy. +pub fn plan(entries: &[Entry], directory_offset: u64) -> Result, String> { + let mut offsets: Vec = entries.iter().map(|e| e.local_offset).collect(); + offsets.push(directory_offset); + offsets.sort_unstable(); + offsets.dedup(); + let mut seen = HashSet::new(); + let mut out = Vec::new(); + for e in entries.iter().filter(|e| !e.is_dir()) { + if e.method != zip::STORED && e.method != zip::DEFLATED { + return Err(format!("{} uses an unsupported compression method ({})", e.name, e.method)); + } + let path = zip::safe_path(&e.name).ok_or_else(|| format!("The archive names a file outside the game folder: {}", e.name))?; + if !seen.insert(path.to_lowercase()) { + continue; + } + let at = offsets.partition_point(|&o| o <= e.local_offset); + let next = offsets.get(at).copied().unwrap_or(directory_offset); + let minimum = e.local_offset + zip::LOCAL_FIXED as u64 + e.compressed; + if next < minimum { + return Err(format!("{} overlaps the next record in the archive", e.name)); + } + out.push(Planned { entry: e.clone(), path, range_end: next - 1 }); + } + Ok(out) +} + +struct Slot { + header: Vec, + payload_from: Option, + consumed: u64, + file: File, + tmp: PathBuf, + crc: Crc, + written: u64, + inflate: Option, + buffer: Vec, +} + +struct Placer<'a> { + jobs: &'a [&'a Planned], + game_dir: &'a Path, + slots: Vec>>, + splits: Vec>, + works: Vec, + placed: Vec, + ledger: Mutex>, + events: &'a dyn Events, + gate: &'a ReplaceGate, + stop: &'a AtomicBool, + failure: Mutex>, + base_done: u64, + base_files: u32, + total: u64, + total_files: u32, + placed_bytes: AtomicU64, + in_flight: AtomicU64, + shown: AtomicU64, + bytes_written: AtomicU64, + files_placed: AtomicUsize, + last_emit: AtomicU64, + started: Instant, +} + +fn discard(slot: Slot) { + drop(slot.file); + let _ = fs::remove_file(&slot.tmp); +} + +impl Placer<'_> { + fn fail(&self, message: String) -> String { + let mut slot = self.failure.lock().expect("failure lock"); + if slot.is_none() { + *slot = Some(message.clone()); + } + drop(slot); + self.stop.store(true, Ordering::SeqCst); + message + } + + fn emit(&self, force: bool) { + let now = self.started.elapsed().as_millis() as u64; + let last = self.last_emit.load(Ordering::Relaxed); + if !force && now < last + PROGRESS_EVERY_MS { + return; + } + if !force && self.last_emit.compare_exchange(last, now, Ordering::Relaxed, Ordering::Relaxed).is_err() { + return; + } + self.last_emit.store(now, Ordering::Relaxed); + let value = self.base_done + self.placed_bytes.load(Ordering::Relaxed) + self.in_flight.load(Ordering::Relaxed); + let shown = self.shown.fetch_max(value, Ordering::Relaxed).max(value); + self.events.progress( + shown.min(self.total), + self.total, + self.base_files + self.files_placed.load(Ordering::Relaxed) as u32, + self.total_files, + ); + } + + fn open(&self, job: &Planned) -> Result { + let dest = self.game_dir.join(&job.path); + if let Some(parent) = dest.parent() { + fs::create_dir_all(parent).map_err(|e| format!("Could not create the folder for {}: {e}", job.path))?; + } + let tmp = temp_path(&dest); + let file = File::create(&tmp).map_err(|e| format!("Could not write {}: {e}", job.path))?; + Ok(Slot { + header: Vec::new(), + payload_from: None, + consumed: 0, + file, + tmp, + crc: Crc::new(), + written: 0, + inflate: (job.entry.method == zip::DEFLATED).then(|| Decompress::new(false)), + buffer: Vec::new(), + }) + } + + fn write_out(&self, job: &Planned, slot: &mut Slot, data: &[u8]) -> Result<(), SinkError> { + if slot.written + data.len() as u64 > job.entry.size { + return Err(SinkError::Retry(format!("{}: more data than the archive lists", job.path))); + } + slot.file + .write_all(data) + .map_err(|e| SinkError::Fatal(self.fail(format!("Could not write {}: {e}", job.path))))?; + slot.crc.update(data); + slot.written += data.len() as u64; + self.bytes_written.fetch_add(data.len() as u64, Ordering::Relaxed); + Ok(()) + } + + fn feed(&self, job: &Planned, slot: &mut Slot, payload: &[u8], finish: bool) -> Result<(), SinkError> { + let Some(mut inflate) = slot.inflate.take() else { + return self.write_out(job, slot, payload); + }; + let mut out = std::mem::take(&mut slot.buffer); + out.resize(INFLATE_BUFFER, 0); + let result = self.inflate_into(job, slot, &mut inflate, &mut out, payload, finish); + slot.inflate = Some(inflate); + slot.buffer = out; + result + } + + fn inflate_into(&self, job: &Planned, slot: &mut Slot, inflate: &mut Decompress, out: &mut [u8], mut input: &[u8], finish: bool) -> Result<(), SinkError> { + let mode = if finish { FlushDecompress::Finish } else { FlushDecompress::None }; + loop { + let (in_before, out_before) = (inflate.total_in(), inflate.total_out()); + let status = inflate + .decompress(input, out, mode) + .map_err(|e| SinkError::Retry(format!("{}: the compressed data is damaged ({e})", job.path)))?; + let used = (inflate.total_in() - in_before) as usize; + let produced = (inflate.total_out() - out_before) as usize; + input = &input[used..]; + if produced > 0 { + self.write_out(job, slot, &out[..produced])?; + } + if status == Status::StreamEnd || (used == 0 && produced == 0) { + return Ok(()); + } + if input.is_empty() && !finish && produced < out.len() { + return Ok(()); + } + } + } + + fn piece(&self, i: usize, offset: u64, data: &[u8]) -> Result<(), SinkError> { + let job = self.jobs[i]; + let mut guard = self.slots[i].lock().expect("slot lock"); + if offset == 0 { + if let Some(old) = guard.take() { + self.in_flight.fetch_sub(old.consumed, Ordering::Relaxed); + discard(old); + } + *guard = Some(self.open(job).map_err(|e| SinkError::Fatal(self.fail(e)))?); + } + let Some(slot) = guard.as_mut() else { + return Err(SinkError::Retry(format!("{}: data arrived before the start of the record", job.path))); + }; + self.consume(job, slot, data) + } + + fn consume(&self, job: &Planned, slot: &mut Slot, data: &[u8]) -> Result<(), SinkError> { + if slot.payload_from.is_none() { + slot.header.extend_from_slice(data); + match zip::local_header_len(&slot.header) { + None => return Ok(()), + Some(Err(e)) => return Err(SinkError::Retry(format!("{}: {e}", job.path))), + Some(Ok(len)) if slot.header.len() < len => return Ok(()), + Some(Ok(len)) => { + slot.payload_from = Some(len); + let header = std::mem::take(&mut slot.header); + let rest = header[len..].to_vec(); + return self.payload(job, slot, &rest); + } + } + } + self.payload(job, slot, data) + } + + fn payload(&self, job: &Planned, slot: &mut Slot, data: &[u8]) -> Result<(), SinkError> { + let left = job.entry.compressed.saturating_sub(slot.consumed); + let take = &data[..(left.min(data.len() as u64) as usize)]; + if take.is_empty() { + return Ok(()); + } + slot.consumed += take.len() as u64; + self.in_flight.fetch_add(take.len() as u64, Ordering::Relaxed); + self.feed(job, slot, take, false)?; + self.emit(false); + Ok(()) + } + + fn finish(&self, i: usize) -> Result { + let job = self.jobs[i]; + let taken = self.slots[i].lock().expect("slot lock").take(); + let Some(slot) = taken else { + return Err(SinkError::Retry(format!("{}: the record arrived empty", job.path))); + }; + self.complete(i, slot) + } + + fn complete(&self, i: usize, mut slot: Slot) -> Result { + let job = self.jobs[i]; + self.in_flight.fetch_sub(slot.consumed, Ordering::Relaxed); + if slot.consumed != job.entry.compressed { + let got = slot.consumed; + discard(slot); + return Err(SinkError::Retry(format!("{}: {got} of {} compressed bytes arrived", job.path, job.entry.compressed))); + } + if slot.inflate.is_some() { + if let Err(e) = self.feed(job, &mut slot, &[], true) { + discard(slot); + return Err(e); + } + } + if slot.written != job.entry.size || slot.crc.sum() != job.entry.crc32 { + let got = slot.written; + discard(slot); + return Err(SinkError::Retry(format!("{}: {got} bytes inflated with a CRC mismatch", job.path))); + } + let Slot { file, tmp, .. } = slot; + if let Err(e) = file.sync_all() { + drop(file); + let _ = fs::remove_file(&tmp); + return Err(SinkError::Fatal(self.fail(format!("Could not write {}: {e}", job.path)))); + } + drop(file); + if self.stop.load(Ordering::SeqCst) { + let _ = fs::remove_file(&tmp); + return Ok(0); + } + if !self.gate.allow(self.events) { + let _ = fs::remove_file(&tmp); + return Err(SinkError::Fatal(self.fail(REPLACE_REFUSED.into()))); + } + let dest = self.game_dir.join(&job.path); + if let Err(e) = fs::rename(&tmp, &dest) { + let _ = fs::remove_file(&tmp); + return Err(SinkError::Fatal(self.fail(format!("Could not put {} in place: {e}", job.path)))); + } + self.record(job, &dest); + self.placed[i].store(true, Ordering::SeqCst); + self.placed_bytes.fetch_add(job.entry.compressed, Ordering::Relaxed); + self.files_placed.fetch_add(1, Ordering::Relaxed); + self.emit(true); + Ok(0) + } + + fn part_chunk(&self, i: usize, part: usize, start: u64, offset: u64, data: &[u8]) -> Result<(), SinkError> { + let job = self.jobs[i]; + let Some(split) = self.splits[i].as_ref() else { + return Err(SinkError::Fatal(format!("{}: no split state", job.path))); + }; + let mut file = split.file.lock().expect("split lock"); + if file.is_none() { + let dest = self.game_dir.join(&job.path); + if let Some(parent) = dest.parent() { + fs::create_dir_all(parent).map_err(|e| SinkError::Fatal(self.fail(format!("Could not create the folder for {}: {e}", job.path))))?; + } + *file = Some(File::create(&split.tmp).map_err(|e| SinkError::Fatal(self.fail(format!("Could not write {}: {e}", job.path))))?); + } + let handle = file.as_ref().expect("split file"); + if offset == 0 { + let old = split.received[part].swap(0, Ordering::Relaxed); + self.in_flight.fetch_sub(old, Ordering::Relaxed); + } + handle + .write_all_at(data, start + offset) + .map_err(|e| SinkError::Fatal(self.fail(format!("Could not write {}: {e}", job.path))))?; + drop(file); + split.received[part].fetch_add(data.len() as u64, Ordering::Relaxed); + self.in_flight.fetch_add(data.len() as u64, Ordering::Relaxed); + self.emit(false); + Ok(()) + } + + fn part_finish(&self, i: usize, part: usize, len: u64) -> Result { + let job = self.jobs[i]; + let Some(split) = self.splits[i].as_ref() else { + return Err(SinkError::Fatal(format!("{}: no split state", job.path))); + }; + let got = split.received[part].load(Ordering::Relaxed); + if got != len { + return Err(SinkError::Retry(format!("{}: part {part} got {got} of {len} bytes", job.path))); + } + if split.left.fetch_sub(1, Ordering::SeqCst) != 1 { + return Ok(0); + } + let received: u64 = split.received.iter().map(|r| r.swap(0, Ordering::Relaxed)).sum(); + self.in_flight.fetch_sub(received, Ordering::Relaxed); + let result = self.assemble(i, split); + let _ = fs::remove_file(&split.tmp); + *split.file.lock().expect("split lock") = None; + result.map_err(|e| match e { + SinkError::Retry(m) => SinkError::Fatal(self.fail(m)), + fatal => fatal, + }) + } + + fn assemble(&self, i: usize, split: &Split) -> Result { + let job = self.jobs[i]; + let mut source = File::open(&split.tmp).map_err(|e| SinkError::Fatal(self.fail(format!("Could not read {}: {e}", job.path))))?; + let mut slot = self.open(job).map_err(|e| SinkError::Fatal(self.fail(e)))?; + let mut buf = vec![0u8; 1024 * 1024]; + loop { + if self.stop.load(Ordering::Relaxed) { + self.in_flight.fetch_sub(slot.consumed, Ordering::Relaxed); + discard(slot); + return Ok(0); + } + let n = match source.read(&mut buf) { + Ok(0) => break, + Ok(n) => n, + Err(e) if e.kind() == std::io::ErrorKind::Interrupted => continue, + Err(e) => { + self.in_flight.fetch_sub(slot.consumed, Ordering::Relaxed); + discard(slot); + return Err(SinkError::Fatal(self.fail(format!("Could not read {}: {e}", job.path)))); + } + }; + if let Err(e) = self.consume(job, &mut slot, &buf[..n]) { + self.in_flight.fetch_sub(slot.consumed, Ordering::Relaxed); + discard(slot); + return Err(e); + } + if slot.consumed >= job.entry.compressed { + break; + } + } + self.complete(i, slot) + } + + fn record(&self, job: &Planned, dest: &Path) { + let known = Known { crc: job.entry.crc32, size: job.entry.size, modified: modified_ms(dest) }; + if let Some(file) = self.ledger.lock().expect("ledger lock").as_mut() { + let _ = file.write_all(ledger_line(&job.path, known).as_bytes()); + } + } +} + +struct Sink<'p, 'a>(&'p Placer<'a>); + +impl FetchSink for Sink<'_, '_> { + fn process(&self, item: &FetchItem, _body: Vec) -> Result { + Err(SinkError::Fatal(format!("item {} arrived whole; streaming was expected", item.id))) + } + + fn on_chunk(&self, item: &FetchItem, offset: u64, data: &[u8]) -> Result<(), SinkError> { + match self.0.works[item.id as usize] { + Work::Whole(i) => self.0.piece(i, offset, data), + Work::Part { job, part, start, .. } => self.0.part_chunk(job, part, start, offset, data), + } + } + + fn on_finish(&self, item: &FetchItem, _total_len: u64) -> Result { + match self.0.works[item.id as usize] { + Work::Whole(i) => self.0.finish(i), + Work::Part { job, part, len, .. } => self.0.part_finish(job, part, len), + } + } +} + +fn origin(url: &str) -> String { + let after = url.find("://").map(|i| i + 3).unwrap_or(0); + let end = url[after..].find('/').map(|i| after + i).unwrap_or(url.len()); + url[..end].to_string() +} + +fn cancelled(cancel: &AtomicBool) -> Result<(), Stop> { + if cancel.load(Ordering::SeqCst) { + Err(Stop::Cancelled) + } else { + Ok(()) + } +} + +pub fn run(req: &Request, cancel: &AtomicBool, ev: &dyn Events) -> Result { + let failed = Stop::Failed; + let started = Instant::now(); + fs::create_dir_all(&req.game_dir).map_err(|e| failed(format!("Could not create the install folder: {e}")))?; + let _ = File::create(req.game_dir.join(IN_PROGRESS_MARKER)); + + ev.status("Reading the build…"); + let archive = net::read_archive(&req.url).map_err(|e| { + ev.log(&format!("archive: {e}")); + failed(format!("The EA build could not be read: {e}")) + })?; + cancelled(cancel)?; + let planned = plan(&archive.entries, archive.directory.offset).map_err(failed)?; + let total_size: u64 = planned.iter().map(|p| p.entry.size).sum(); + let total_compressed: u64 = planned.iter().map(|p| p.entry.compressed).sum(); + ev.log(&format!( + "archive bytes={} entries={} files={} size={total_size} compressed={total_compressed}", + archive.total, + archive.entries.len(), + planned.len() + )); + + for p in &planned { + let dest = req.game_dir.join(&p.path); + let _ = fs::remove_file(temp_path(&dest)); + let mut split = dest.into_os_string(); + split.push(SPLIT_SUFFIX); + let _ = fs::remove_file(split); + } + + ev.status("Checking files…"); + let mut ledger = read_ledger(&req.game_dir); + let mut pending: Vec<&Planned> = Vec::new(); + let mut kept: Vec<(String, Known)> = Vec::new(); + let mut checked = 0u64; + let mut last_report = Instant::now(); + for (n, p) in planned.iter().enumerate() { + let dest = req.game_dir.join(&p.path); + let size_ok = fs::symlink_metadata(&dest).map(|m| m.is_file() && m.len() == p.entry.size).unwrap_or(false); + let mut complete = false; + if size_ok { + let modified = modified_ms(&dest); + let known = ledger.get(&p.path).copied(); + if known == Some(Known { crc: p.entry.crc32, size: p.entry.size, modified }) { + complete = true; + } else { + match crc_of(&dest, cancel) { + Err(()) => return Err(Stop::Cancelled), + Ok(Some(crc)) if crc == p.entry.crc32 => { + complete = true; + kept.push((p.path.clone(), Known { crc, size: p.entry.size, modified })); + } + Ok(_) => {} + } + } + } + if !complete { + pending.push(p); + } + checked += p.entry.size; + if last_report.elapsed() >= CHECK_REPORT_EVERY || n + 1 == planned.len() { + ev.checking(checked, total_size, (n + 1) as u32, planned.len() as u32); + last_report = Instant::now(); + } + cancelled(cancel)?; + } + for (path, known) in kept { + ledger.insert(path, known); + } + + let pending_size: u64 = pending.iter().map(|p| p.entry.size).sum(); + let pending_compressed: u64 = pending.iter().map(|p| p.entry.compressed).sum(); + ev.log(&format!( + "resume kept_files={} pending_files={} pending_bytes={pending_size} pending_download={pending_compressed}", + planned.len() - pending.len(), + pending.len() + )); + ev.sizes(pending_size, total_size); + if let Some(message) = space_problem(pending_size, free_bytes(&req.game_dir)) { + return Err(failed(message)); + } + + let gate = ReplaceGate::new(); + let (empty, remote): (Vec<&Planned>, Vec<&Planned>) = pending.into_iter().partition(|p| p.entry.size == 0 && p.entry.crc32 == 0); + for p in &empty { + let dest = req.game_dir.join(&p.path); + if let Some(parent) = dest.parent() { + fs::create_dir_all(parent).map_err(|e| failed(format!("Could not create the folder for {}: {e}", p.path)))?; + } + if !gate.allow(ev) { + return Err(failed(REPLACE_REFUSED.into())); + } + File::create(&dest).map_err(|e| failed(format!("Could not write {}: {e}", p.path)))?; + ledger.insert(p.path.clone(), Known { crc: 0, size: 0, modified: modified_ms(&dest) }); + } + + let mut text = String::new(); + for (path, known) in &ledger { + text.push_str(&ledger_line(path, *known)); + } + fs::write(req.game_dir.join(LEDGER), text).map_err(|e| failed(format!("Could not write the install record: {e}")))?; + let ledger_file = OpenOptions::new().append(true).open(req.game_dir.join(LEDGER)).ok(); + + let host = origin(&req.url); + let works = works(&remote, req.part_bytes); + let splits: Vec> = remote + .iter() + .enumerate() + .map(|(i, p)| { + let parts = works.iter().filter(|w| matches!(w, Work::Part { job, .. } if *job == i)).count(); + (parts > 0).then(|| { + let mut name = req.game_dir.join(&p.path).into_os_string(); + name.push(SPLIT_SUFFIX); + Split { + tmp: PathBuf::from(name), + file: Mutex::new(None), + received: (0..parts).map(|_| AtomicU64::new(0)).collect(), + left: AtomicUsize::new(parts), + } + }) + }) + .collect(); + let placer = Placer { + jobs: &remote, + game_dir: &req.game_dir, + slots: remote.iter().map(|_| Mutex::new(None)).collect(), + splits, + works: works.clone(), + placed: remote.iter().map(|_| AtomicBool::new(false)).collect(), + ledger: Mutex::new(ledger_file), + events: ev, + gate: &gate, + stop: cancel, + failure: Mutex::new(None), + base_done: total_compressed - pending_compressed, + base_files: (planned.len() - remote.len()) as u32, + total: total_compressed, + total_files: planned.len() as u32, + placed_bytes: AtomicU64::new(0), + in_flight: AtomicU64::new(0), + shown: AtomicU64::new(0), + bytes_written: AtomicU64::new(0), + files_placed: AtomicUsize::new(0), + last_emit: AtomicU64::new(0), + started: Instant::now(), + }; + let cores = std::thread::available_parallelism().map(|n| n.get()).unwrap_or(2); + let window = req.max_workers.clamp(1, 64); + let hosts = vec![host.clone()]; + let options = FetchOptions { + max_workers: window, + per_host_cap: window, + timeout: REQUEST_TIMEOUT, + headers: vec![("User-Agent".to_string(), net::user_agent())], + ca_bundle_path: req.ca_bundle.clone(), + process_workers: req.process_workers.max(cores / 2).max(1), + label: "ea".to_string(), + stream: true, + }; + let items: Vec = works + .iter() + .enumerate() + .map(|(n, w)| { + let range = match *w { + Work::Whole(i) => (remote[i].entry.local_offset, remote[i].range_end), + Work::Part { job, start, len, .. } => { + let at = remote[job].entry.local_offset + start; + (at, at + len - 1) + } + }; + FetchItem { id: n as u64, urls: vec![req.url.clone()], reserve: 0, range: Some(range) } + }) + .collect(); + ev.status("Downloading…"); + ev.log(&format!("engine files={} requests={} window={window} hosts={}", remote.len(), items.len(), distinct_host_count(&hosts))); + placer.emit(true); + let log = |line: &str| ev.log(line); + let outcome = if items.is_empty() { + None + } else { + Some(run_fetch(items, &hosts, &options, &Sink(&placer), cancel, &|_: u64, _: u64| {}, &log)) + }; + for slot in &placer.slots { + if let Some(active) = slot.lock().expect("slot lock").take() { + discard(active); + } + } + for split in placer.splits.iter().flatten() { + *split.file.lock().expect("split lock") = None; + let _ = fs::remove_file(&split.tmp); + } + placer.emit(true); + let placed_all = placer.placed.iter().all(|p| p.load(Ordering::SeqCst)); + let bytes_written = placer.bytes_written.load(Ordering::Relaxed); + let files_written = placer.files_placed.load(Ordering::Relaxed) + empty.len(); + let elapsed = started.elapsed().as_secs_f64().max(0.001); + ev.log(&format!( + "summary files_written={files_written} bytes_written={bytes_written} elapsed_s={elapsed:.1} avg_mbps={:.1}", + bytes_written as f64 / 1_048_576.0 / elapsed + )); + if let Some(message) = placer.failure.lock().expect("failure lock").take() { + return Err(Stop::Failed(message)); + } + if !placed_all { + if let Some(error) = outcome.as_ref().and_then(|o| o.error.clone()) { + ev.log(&format!("download failed: {error}")); + return Err(Stop::Failed("A file failed to download".into())); + } + if cancel.load(Ordering::SeqCst) { + return Err(Stop::Cancelled); + } + return Err(Stop::Failed("The download ended before every file was written".into())); + } + + let wanted: HashSet<&str> = planned.iter().map(|p| p.path.as_str()).collect(); + let by_case: HashMap = planned.iter().map(|p| (p.path.to_lowercase(), p.path.as_str())).collect(); + let mut removed = 0; + let current = read_ledger(&req.game_dir); + let mut text = String::new(); + for (path, known) in ¤t { + if wanted.contains(path.as_str()) { + text.push_str(&ledger_line(path, *known)); + } else if by_case.get(&path.to_lowercase()).is_some_and(|kept| same_file(&req.game_dir.join(kept), &req.game_dir.join(path))) { + continue; + } else if zip::safe_path(path).as_deref() == Some(path.as_str()) && fs::remove_file(req.game_dir.join(path)).is_ok() { + removed += 1; + } + } + let _ = fs::write(req.game_dir.join(LEDGER), text); + if removed > 0 { + ev.log(&format!("removed {removed} files the new build no longer has")); + } + let _ = fs::remove_file(req.game_dir.join(IN_PROGRESS_MARKER)); + Ok(Finished { + total_bytes: total_size, + download_bytes: total_compressed, + file_count: planned.len(), + files_written, + bytes_written, + removed, + }) +} + +pub fn size(url: &str) -> Result { + let archive = net::read_archive(url)?; + let planned = plan(&archive.entries, archive.directory.offset)?; + Ok(json!({ + "totalBytes": planned.iter().map(|p| p.entry.size).sum::(), + "downloadBytes": planned.iter().map(|p| p.entry.compressed).sum::(), + "fileCount": planned.len(), + })) +} + +#[cfg(test)] +mod tests; diff --git a/app/src/main/rust/stores/src/ea/install/tests.rs b/app/src/main/rust/stores/src/ea/install/tests.rs new file mode 100644 index 0000000000..baf15a4345 --- /dev/null +++ b/app/src/main/rust/stores/src/ea/install/tests.rs @@ -0,0 +1,258 @@ +use std::io::{BufRead, BufReader, Write}; +use std::net::{TcpListener, TcpStream}; +use std::sync::atomic::{AtomicBool, AtomicUsize}; +use std::sync::{Arc, Mutex}; + +use flate2::write::DeflateEncoder; +use flate2::Compression; + +use super::*; + +struct Built { + bytes: Vec, +} + +fn build_zip(files: &[(&str, Vec, bool)]) -> Built { + let mut out = Vec::new(); + let mut central = Vec::new(); + for (name, data, deflate) in files { + let mut crc = Crc::new(); + crc.update(data); + let body = if *deflate { + let mut enc = DeflateEncoder::new(Vec::new(), Compression::default()); + enc.write_all(data).unwrap(); + enc.finish().unwrap() + } else { + data.clone() + }; + let method: u16 = if *deflate { 8 } else { 0 }; + let offset = out.len() as u32; + let extra = [0xAAu8, 0xBB, 2, 0, 1, 2]; + out.extend_from_slice(&0x0403_4b50u32.to_le_bytes()); + out.extend_from_slice(&[20, 0, 0, 0]); + out.extend_from_slice(&method.to_le_bytes()); + out.extend_from_slice(&[0, 0, 0, 0]); + out.extend_from_slice(&crc.sum().to_le_bytes()); + out.extend_from_slice(&(body.len() as u32).to_le_bytes()); + out.extend_from_slice(&(data.len() as u32).to_le_bytes()); + out.extend_from_slice(&(name.len() as u16).to_le_bytes()); + out.extend_from_slice(&(extra.len() as u16).to_le_bytes()); + out.extend_from_slice(name.as_bytes()); + out.extend_from_slice(&extra); + out.extend_from_slice(&body); + + central.extend_from_slice(&0x0201_4b50u32.to_le_bytes()); + central.extend_from_slice(&[20, 0, 20, 0, 0, 0]); + central.extend_from_slice(&method.to_le_bytes()); + central.extend_from_slice(&[0, 0, 0, 0]); + central.extend_from_slice(&crc.sum().to_le_bytes()); + central.extend_from_slice(&(body.len() as u32).to_le_bytes()); + central.extend_from_slice(&(data.len() as u32).to_le_bytes()); + central.extend_from_slice(&(name.len() as u16).to_le_bytes()); + central.extend_from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]); + central.extend_from_slice(&offset.to_le_bytes()); + central.extend_from_slice(name.as_bytes()); + } + let cd_offset = out.len() as u32; + let count = files.len() as u16; + out.extend_from_slice(¢ral); + out.extend_from_slice(&0x0605_4b50u32.to_le_bytes()); + out.extend_from_slice(&[0, 0, 0, 0]); + out.extend_from_slice(&count.to_le_bytes()); + out.extend_from_slice(&count.to_le_bytes()); + out.extend_from_slice(&(central.len() as u32).to_le_bytes()); + out.extend_from_slice(&cd_offset.to_le_bytes()); + out.extend_from_slice(&[0, 0]); + Built { bytes: out } +} + +struct Server { + url: String, + requests: Arc, +} + +fn serve(body: Vec) -> Server { + let listener = TcpListener::bind("127.0.0.1:0").unwrap(); + let addr = listener.local_addr().unwrap(); + let body = Arc::new(body); + let requests = Arc::new(AtomicUsize::new(0)); + let counter = Arc::clone(&requests); + std::thread::spawn(move || { + for stream in listener.incoming() { + let Ok(stream) = stream else { continue }; + let body = Arc::clone(&body); + counter.fetch_add(1, Ordering::SeqCst); + std::thread::spawn(move || answer(stream, &body)); + } + }); + Server { url: format!("http://{addr}/build/game.zip?sig=abc"), requests } +} + +fn answer(mut stream: TcpStream, body: &[u8]) { + let mut reader = BufReader::new(stream.try_clone().unwrap()); + let mut first = String::new(); + if reader.read_line(&mut first).is_err() { + return; + } + let mut range = None; + loop { + let mut line = String::new(); + match reader.read_line(&mut line) { + Ok(0) | Err(_) => break, + Ok(_) if line == "\r\n" => break, + Ok(_) => { + if let Some(v) = line.to_ascii_lowercase().strip_prefix("range: bytes=") { + range = Some(v.trim().to_string()); + } + } + } + } + let total = body.len() as u64; + let Some(range) = range else { + let _ = stream.write_all(format!("HTTP/1.1 200 OK\r\nContent-Length: {total}\r\nConnection: close\r\n\r\n").as_bytes()); + let _ = stream.write_all(body); + return; + }; + let (a, b) = range.split_once('-').unwrap(); + let (start, end) = if a.is_empty() { + let n: u64 = b.parse().unwrap(); + (total.saturating_sub(n), total - 1) + } else { + let start: u64 = a.parse().unwrap(); + let end = if b.is_empty() { total - 1 } else { b.parse::().unwrap().min(total - 1) }; + (start, end) + }; + let slice = &body[start as usize..=end as usize]; + let head = format!( + "HTTP/1.1 206 Partial Content\r\nContent-Length: {}\r\nContent-Range: bytes {start}-{end}/{total}\r\nConnection: close\r\n\r\n", + slice.len() + ); + let _ = stream.write_all(head.as_bytes()); + let _ = stream.write_all(slice); +} + +#[derive(Default)] +struct Recorder { + logs: Mutex>, + gates: AtomicUsize, + last: Mutex<(u64, u64)>, +} + +impl Events for Recorder { + fn log(&self, line: &str) { + self.logs.lock().unwrap().push(line.to_string()); + } + fn status(&self, _text: &str) {} + fn checking(&self, _d: u64, _t: u64, _f: u32, _ft: u32) {} + fn sizes(&self, _pending: u64, _total: u64) {} + fn progress(&self, done: u64, total: u64, _files: u32, _files_total: u32) { + *self.last.lock().unwrap() = (done, total); + } + fn before_replace(&self) -> bool { + self.gates.fetch_add(1, Ordering::SeqCst); + true + } +} + +fn sample() -> Vec<(&'static str, Vec, bool)> { + let mut seed = 0x1234_5678u32; + let big: Vec = (0..900_000u32).map(|_| { seed = seed.wrapping_mul(1_103_515_245).wrapping_add(12_345); (seed >> 16) as u8 }).collect(); + vec![ + ("__Installer/installerdata.xml", b"".to_vec(), true), + ("Game.exe", big, true), + ("Data\\stored.bin", vec![9u8; 4096], false), + ("Data/", Vec::new(), false), + ("empty.txt", Vec::new(), false), + ] +} + +fn request(url: &str, dir: &Path) -> Request { + Request { url: url.to_string(), game_dir: dir.to_path_buf(), max_workers: 4, process_workers: 2, ca_bundle: String::new(), part_bytes: 64 * 1024 } +} + +fn temp_dir(name: &str) -> PathBuf { + let dir = std::env::temp_dir().join(format!("droiddeck-ea-{name}-{}", std::process::id())); + let _ = fs::remove_dir_all(&dir); + fs::create_dir_all(&dir).unwrap(); + dir +} + +#[test] +fn installs_every_file_and_keeps_them_on_the_next_run() { + let files = sample(); + let zip = build_zip(&files); + let server = serve(zip.bytes); + let dir = temp_dir("install"); + let ev = Recorder::default(); + let done = run(&request(&server.url, &dir), &AtomicBool::new(false), &ev).unwrap(); + assert_eq!(done.file_count, 4); + assert_eq!(fs::read(dir.join("Game.exe")).unwrap(), files[1].1); + assert_eq!(fs::read(dir.join("Data/stored.bin")).unwrap(), vec![9u8; 4096]); + assert!(dir.join("empty.txt").is_file()); + assert!(dir.join("__Installer/installerdata.xml").is_file()); + assert!(!dir.join(IN_PROGRESS_MARKER).exists()); + let (shown, total) = *ev.last.lock().unwrap(); + assert_eq!(shown, total); + + let before = server.requests.load(Ordering::SeqCst); + let again = run(&request(&server.url, &dir), &AtomicBool::new(false), &Recorder::default()).unwrap(); + assert_eq!(again.files_written, 0); + assert!(server.requests.load(Ordering::SeqCst) - before <= 2); + let _ = fs::remove_dir_all(&dir); +} + +#[test] +fn an_update_replaces_changed_files_and_drops_removed_ones() { + let dir = temp_dir("update"); + let first = serve(build_zip(&sample()).bytes); + run(&request(&first.url, &dir), &AtomicBool::new(false), &Recorder::default()).unwrap(); + + let mut next = sample(); + next[1].1[10] ^= 0xFF; + next.retain(|f| f.0 != "Data\\stored.bin"); + let second = serve(build_zip(&next).bytes); + let ev = Recorder::default(); + let done = run(&request(&second.url, &dir), &AtomicBool::new(false), &ev).unwrap(); + assert_eq!(done.files_written, 1); + assert_eq!(done.removed, 1); + assert_eq!(fs::read(dir.join("Game.exe")).unwrap(), next[1].1); + assert!(!dir.join("Data/stored.bin").exists()); + assert_eq!(ev.gates.load(Ordering::SeqCst), 1); + let _ = fs::remove_dir_all(&dir); +} + +#[test] +fn a_damaged_file_on_disk_is_downloaded_again() { + let dir = temp_dir("repair"); + let server = serve(build_zip(&sample()).bytes); + run(&request(&server.url, &dir), &AtomicBool::new(false), &Recorder::default()).unwrap(); + let mut data = fs::read(dir.join("Game.exe")).unwrap(); + data[5] ^= 1; + fs::write(dir.join("Game.exe"), &data).unwrap(); + let done = run(&request(&server.url, &dir), &AtomicBool::new(false), &Recorder::default()).unwrap(); + assert_eq!(done.files_written, 1); + assert_eq!(fs::read(dir.join("Game.exe")).unwrap(), sample()[1].1); + let _ = fs::remove_dir_all(&dir); +} + +#[test] +fn reports_the_archive_size() { + let server = serve(build_zip(&sample()).bytes); + let answer = size(&server.url).unwrap(); + assert_eq!(answer["fileCount"], 4); + let expected: usize = sample().iter().map(|f| f.1.len()).sum(); + assert_eq!(answer["totalBytes"], expected as u64); +} + +#[test] +fn large_records_arrive_in_parallel_parts() { + let dir = temp_dir("parts"); + let server = serve(build_zip(&sample()).bytes); + let before = server.requests.load(Ordering::SeqCst); + let done = run(&request(&server.url, &dir), &AtomicBool::new(false), &Recorder::default()).unwrap(); + assert_eq!(done.files_written, 4); + assert!(server.requests.load(Ordering::SeqCst) - before > 6); + assert_eq!(fs::read(dir.join("Game.exe")).unwrap(), sample()[1].1); + assert!(fs::read_dir(&dir).unwrap().all(|e| !e.unwrap().file_name().to_string_lossy().ends_with(".ddzip"))); + let _ = fs::remove_dir_all(&dir); +} diff --git a/app/src/main/rust/stores/src/ea/mod.rs b/app/src/main/rust/stores/src/ea/mod.rs new file mode 100644 index 0000000000..73ccb48ad4 --- /dev/null +++ b/app/src/main/rust/stores/src/ea/mod.rs @@ -0,0 +1,4 @@ +pub mod ffi; +pub mod install; +pub mod net; +pub mod zip; diff --git a/app/src/main/rust/stores/src/ea/net.rs b/app/src/main/rust/stores/src/ea/net.rs new file mode 100644 index 0000000000..8b31895472 --- /dev/null +++ b/app/src/main/rust/stores/src/ea/net.rs @@ -0,0 +1,98 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +//! Ranged reads of EA's build archives. + +use std::time::Duration; + +use super::zip::{self, Directory, Entry}; + +const CONNECT_TIMEOUT: Duration = Duration::from_secs(30); +const READ_TIMEOUT: Duration = Duration::from_secs(60); +const MAX_DIRECTORY: u64 = 512 * 1024 * 1024; + +pub fn user_agent() -> String { + crate::amazon::net::user_agent() +} + +pub struct Ranged { + pub body: Vec, + pub start: u64, + pub total: u64, +} + +fn content_range(value: &str) -> Option<(u64, u64)> { + let rest = value.trim().strip_prefix("bytes")?.trim_start(); + let (span, total) = rest.split_once('/')?; + let start = span.split_once('-')?.0.trim().parse().ok()?; + Some((start, total.trim().parse().ok()?)) +} + +pub fn get_range(url: &str, range: &str) -> Result { + let runtime = tokio::runtime::Builder::new_current_thread() + .enable_all() + .build() + .map_err(|e| format!("runtime: {e}"))?; + runtime.block_on(async { + let client = reqwest::Client::builder() + .user_agent(user_agent()) + .connect_timeout(CONNECT_TIMEOUT) + .read_timeout(READ_TIMEOUT) + .build() + .map_err(|e| format!("http client: {}", e.without_url()))?; + let response = client + .get(url) + .header(reqwest::header::RANGE, format!("bytes={range}")) + .send() + .await + .map_err(|e| format!("request failed: {}", e.without_url()))?; + let status = response.status().as_u16(); + if status == 403 || status == 404 { + return Err(format!("the download link was refused ({status})")); + } + if status != 206 { + return Err(format!("the server did not answer a ranged read ({status})")); + } + let (start, total) = response + .headers() + .get(reqwest::header::CONTENT_RANGE) + .and_then(|v| v.to_str().ok()) + .and_then(content_range) + .ok_or("the server gave no content range")?; + let body = response.bytes().await.map_err(|e| format!("answer could not be read: {}", e.without_url()))?.to_vec(); + Ok(Ranged { body, start, total }) + }) +} + +pub struct Archive { + pub total: u64, + pub directory: Directory, + pub entries: Vec, +} + +pub fn read_archive(url: &str) -> Result { + let tail = get_range(url, &format!("-{}", zip::TAIL_LEN))?; + let directory = zip::locate(&tail.body, tail.start)?; + if directory.size > MAX_DIRECTORY || directory.offset + directory.size > tail.total { + return Err("The archive directory is out of bounds".into()); + } + let bytes = if directory.offset >= tail.start { + let at = (directory.offset - tail.start) as usize; + let end = at + directory.size as usize; + tail.body.get(at..end).ok_or("The archive directory is cut short")?.to_vec() + } else { + let end = directory.offset + directory.size - 1; + get_range(url, &format!("{}-{end}", directory.offset))?.body + }; + let entries = zip::parse(&bytes, directory.entries)?; + Ok(Archive { total: tail.total, directory, entries }) +} + +#[cfg(test)] +mod tests { + use super::content_range; + + #[test] + fn reads_content_range() { + assert_eq!(content_range("bytes 100-199/5000"), Some((100, 5000))); + assert_eq!(content_range("bytes */5000"), None); + } +} diff --git a/app/src/main/rust/stores/src/ea/zip.rs b/app/src/main/rust/stores/src/ea/zip.rs new file mode 100644 index 0000000000..d7a8203e73 --- /dev/null +++ b/app/src/main/rust/stores/src/ea/zip.rs @@ -0,0 +1,288 @@ +// SPDX-License-Identifier: GPL-3.0-or-later +//! The central directory of a remote ZIP archive, which is how EA publishes a game build. + +const EOCD: u32 = 0x0605_4b50; +const EOCD64: u32 = 0x0606_4b50; +const EOCD64_LOCATOR: u32 = 0x0706_4b50; +const CENTRAL: u32 = 0x0201_4b50; +const LOCAL: u32 = 0x0403_4b50; +const EOCD_LEN: usize = 22; +const LOCATOR_LEN: usize = 20; +const EOCD64_LEN: usize = 56; +pub const LOCAL_FIXED: usize = 30; +pub const TAIL_LEN: u64 = 128 * 1024; + +pub const STORED: u16 = 0; +pub const DEFLATED: u16 = 8; + +#[derive(Clone, Debug, PartialEq, Eq)] +pub struct Entry { + pub name: String, + pub crc32: u32, + pub method: u16, + pub compressed: u64, + pub size: u64, + pub local_offset: u64, +} + +impl Entry { + pub fn is_dir(&self) -> bool { + self.name.ends_with('/') || self.name.ends_with('\\') + } +} + +#[derive(Clone, Copy, Debug, PartialEq, Eq)] +pub struct Directory { + pub offset: u64, + pub size: u64, + pub entries: u64, +} + +fn u16_at(b: &[u8], at: usize) -> Option { + b.get(at..at + 2).map(|s| u16::from_le_bytes([s[0], s[1]])) +} + +fn u32_at(b: &[u8], at: usize) -> Option { + b.get(at..at + 4).map(|s| u32::from_le_bytes([s[0], s[1], s[2], s[3]])) +} + +fn u64_at(b: &[u8], at: usize) -> Option { + b.get(at..at + 8).map(|s| u64::from_le_bytes(s.try_into().unwrap_or([0; 8]))) +} + +/// Finds the central directory from the last bytes of the archive. `tail_start` is where `tail` +/// begins in the whole file. +pub fn locate(tail: &[u8], tail_start: u64) -> Result { + if tail.len() < EOCD_LEN { + return Err("The archive is too short to be a ZIP".into()); + } + let mut at = tail.len() - EOCD_LEN; + let found = loop { + if u32_at(tail, at) == Some(EOCD) { + let comment = u16_at(tail, at + 20).unwrap_or(0) as usize; + if at + EOCD_LEN + comment <= tail.len() { + break at; + } + } + if at == 0 { + return Err("The archive has no end of central directory".into()); + } + at -= 1; + }; + let entries = u16_at(tail, found + 10).unwrap_or(0) as u64; + let size = u32_at(tail, found + 12).unwrap_or(0) as u64; + let offset = u32_at(tail, found + 16).unwrap_or(0) as u64; + let wide = entries == 0xFFFF || size == 0xFFFF_FFFF || offset == 0xFFFF_FFFF; + if !wide { + return Ok(Directory { offset, size, entries }); + } + let locator = found.checked_sub(LOCATOR_LEN).filter(|&l| u32_at(tail, l) == Some(EOCD64_LOCATOR)); + let Some(locator) = locator else { + return Err("The archive needs ZIP64 but has no ZIP64 locator".into()); + }; + let record_at = u64_at(tail, locator + 8).unwrap_or(0); + let Some(rel) = record_at.checked_sub(tail_start).map(|r| r as usize) else { + return Err("The ZIP64 directory record lies before the fetched tail".into()); + }; + if u32_at(tail, rel) != Some(EOCD64) || rel + EOCD64_LEN > tail.len() { + return Err("The ZIP64 directory record is damaged".into()); + } + Ok(Directory { + entries: u64_at(tail, rel + 32).unwrap_or(0), + size: u64_at(tail, rel + 40).unwrap_or(0), + offset: u64_at(tail, rel + 48).unwrap_or(0), + }) +} + +fn wide_values(extra: &[u8], need_size: bool, need_compressed: bool, need_offset: bool) -> (Option, Option, Option) { + let mut at = 0; + while at + 4 <= extra.len() { + let id = u16_at(extra, at).unwrap_or(0); + let len = u16_at(extra, at + 2).unwrap_or(0) as usize; + let body = &extra[(at + 4).min(extra.len())..(at + 4 + len).min(extra.len())]; + if id == 0x0001 { + let mut p = 0; + let mut take = |want: bool| { + if !want { + return None; + } + let v = u64_at(body, p); + p += 8; + v + }; + let size = take(need_size); + let compressed = take(need_compressed); + let offset = take(need_offset); + return (size, compressed, offset); + } + at += 4 + len; + } + (None, None, None) +} + +pub fn parse(directory: &[u8], expected: u64) -> Result, String> { + let mut entries = Vec::with_capacity(expected.min(1 << 20) as usize); + let mut at = 0usize; + while at + 46 <= directory.len() { + if u32_at(directory, at) != Some(CENTRAL) { + break; + } + let flags = u16_at(directory, at + 8).unwrap_or(0); + let method = u16_at(directory, at + 10).unwrap_or(0); + let crc32 = u32_at(directory, at + 16).unwrap_or(0); + let compressed32 = u32_at(directory, at + 20).unwrap_or(0); + let size32 = u32_at(directory, at + 24).unwrap_or(0); + let name_len = u16_at(directory, at + 28).unwrap_or(0) as usize; + let extra_len = u16_at(directory, at + 30).unwrap_or(0) as usize; + let comment_len = u16_at(directory, at + 32).unwrap_or(0) as usize; + let offset32 = u32_at(directory, at + 42).unwrap_or(0); + let name_at = at + 46; + let end = name_at + name_len + extra_len + comment_len; + if end > directory.len() { + return Err("The archive directory is cut short".into()); + } + let raw = &directory[name_at..name_at + name_len]; + let name = if flags & 0x0800 != 0 { + String::from_utf8_lossy(raw).into_owned() + } else { + raw.iter().map(|&b| b as char).collect() + }; + let extra = &directory[name_at + name_len..name_at + name_len + extra_len]; + let (size, compressed, offset) = + wide_values(extra, size32 == 0xFFFF_FFFF, compressed32 == 0xFFFF_FFFF, offset32 == 0xFFFF_FFFF); + if flags & 0x0001 != 0 { + return Err(format!("{name} is encrypted")); + } + entries.push(Entry { + name, + crc32, + method, + compressed: compressed.unwrap_or(compressed32 as u64), + size: size.unwrap_or(size32 as u64), + local_offset: offset.unwrap_or(offset32 as u64), + }); + at = end; + } + if expected != 0 && entries.len() as u64 != expected { + return Err(format!("The archive directory lists {} of {expected} entries", entries.len())); + } + Ok(entries) +} + +/// Bytes before the compressed data of an entry, read from its local header. +pub fn local_header_len(header: &[u8]) -> Option> { + if header.len() < LOCAL_FIXED { + return None; + } + if u32_at(header, 0) != Some(LOCAL) { + return Some(Err("An entry has no local header where the directory points".into())); + } + let name = u16_at(header, 26).unwrap_or(0) as usize; + let extra = u16_at(header, 28).unwrap_or(0) as usize; + Some(Ok(LOCAL_FIXED + name + extra)) +} + +/// A relative path inside the install folder, or None for names that would leave it. +pub fn safe_path(name: &str) -> Option { + let unified = name.replace('\\', "/"); + if unified.starts_with('/') || unified.contains(':') || unified.contains('\0') { + return None; + } + let parts: Vec<&str> = unified.split('/').filter(|p| !p.is_empty() && *p != ".").collect(); + if parts.is_empty() || parts.iter().any(|p| *p == "..") { + return None; + } + Some(parts.join("/")) +} + +#[cfg(test)] +mod tests { + use super::*; + + fn central(name: &str, method: u16, crc: u32, compressed: u32, size: u32, offset: u32, extra: &[u8]) -> Vec { + let mut v = Vec::new(); + v.extend_from_slice(&CENTRAL.to_le_bytes()); + v.extend_from_slice(&[20, 0, 20, 0, 0, 0]); + v.extend_from_slice(&method.to_le_bytes()); + v.extend_from_slice(&[0, 0, 0, 0]); + v.extend_from_slice(&crc.to_le_bytes()); + v.extend_from_slice(&compressed.to_le_bytes()); + v.extend_from_slice(&size.to_le_bytes()); + v.extend_from_slice(&(name.len() as u16).to_le_bytes()); + v.extend_from_slice(&(extra.len() as u16).to_le_bytes()); + v.extend_from_slice(&[0, 0, 0, 0, 0, 0, 0, 0, 0, 0]); + v.extend_from_slice(&offset.to_le_bytes()); + v.extend_from_slice(name.as_bytes()); + v.extend_from_slice(extra); + v + } + + #[test] + fn reads_a_plain_directory() { + let mut dir = central("Game.exe", DEFLATED, 7, 10, 20, 0, &[]); + dir.extend(central("__Installer/", STORED, 0, 0, 0, 40, &[])); + let mut tail = vec![0u8; 5]; + tail.extend_from_slice(&dir); + let cd_size = dir.len() as u32; + tail.extend_from_slice(&EOCD.to_le_bytes()); + tail.extend_from_slice(&[0, 0, 0, 0, 2, 0, 2, 0]); + tail.extend_from_slice(&cd_size.to_le_bytes()); + tail.extend_from_slice(&1000u32.to_le_bytes()); + tail.extend_from_slice(&[0, 0]); + let found = locate(&tail, 995).unwrap(); + assert_eq!(found, Directory { offset: 1000, size: cd_size as u64, entries: 2 }); + let entries = parse(&dir, 2).unwrap(); + assert_eq!(entries[0].name, "Game.exe"); + assert_eq!(entries[0].size, 20); + assert!(entries[1].is_dir()); + } + + #[test] + fn reads_zip64_values() { + let mut extra = vec![1, 0, 24, 0]; + extra.extend_from_slice(&6_000_000_000u64.to_le_bytes()); + extra.extend_from_slice(&5_000_000_000u64.to_le_bytes()); + extra.extend_from_slice(&7_000_000_000u64.to_le_bytes()); + let dir = central("big.pak", DEFLATED, 1, 0xFFFF_FFFF, 0xFFFF_FFFF, 0xFFFF_FFFF, &extra); + let e = &parse(&dir, 1).unwrap()[0]; + assert_eq!((e.size, e.compressed, e.local_offset), (6_000_000_000, 5_000_000_000, 7_000_000_000)); + + let mut tail = Vec::new(); + let record_at = 9_000_000_000u64; + tail.extend_from_slice(&EOCD64.to_le_bytes()); + tail.extend_from_slice(&44u64.to_le_bytes()); + tail.extend_from_slice(&[45, 0, 45, 0, 0, 0, 0, 0, 0, 0, 0, 0]); + tail.extend_from_slice(&3u64.to_le_bytes()); + tail.extend_from_slice(&3u64.to_le_bytes()); + tail.extend_from_slice(&500u64.to_le_bytes()); + tail.extend_from_slice(&8_000_000_000u64.to_le_bytes()); + tail.extend_from_slice(&EOCD64_LOCATOR.to_le_bytes()); + tail.extend_from_slice(&0u32.to_le_bytes()); + tail.extend_from_slice(&record_at.to_le_bytes()); + tail.extend_from_slice(&1u32.to_le_bytes()); + tail.extend_from_slice(&EOCD.to_le_bytes()); + tail.extend_from_slice(&[0, 0, 0, 0, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0, 0]); + let found = locate(&tail, record_at).unwrap(); + assert_eq!(found, Directory { offset: 8_000_000_000, size: 500, entries: 3 }); + } + + #[test] + fn refuses_paths_that_leave_the_folder() { + assert_eq!(safe_path("Data\\Win32\\a.big").as_deref(), Some("Data/Win32/a.big")); + assert_eq!(safe_path("./x//y").as_deref(), Some("x/y")); + assert!(safe_path("../evil").is_none()); + assert!(safe_path("/etc/passwd").is_none()); + assert!(safe_path("C:/x").is_none()); + assert!(safe_path("a/../../b").is_none()); + } + + #[test] + fn local_header_length_counts_name_and_extra() { + let mut h = LOCAL.to_le_bytes().to_vec(); + h.extend_from_slice(&[0u8; 22]); + h.extend_from_slice(&5u16.to_le_bytes()); + h.extend_from_slice(&9u16.to_le_bytes()); + assert_eq!(local_header_len(&h), Some(Ok(44))); + assert_eq!(local_header_len(&h[..10]), None); + } +} diff --git a/app/src/main/rust/stores/src/lib.rs b/app/src/main/rust/stores/src/lib.rs index 87d278ab06..12a351138f 100644 --- a/app/src/main/rust/stores/src/lib.rs +++ b/app/src/main/rust/stores/src/lib.rs @@ -3,6 +3,8 @@ #![allow(clippy::missing_safety_doc, clippy::result_large_err)] pub mod amazon; +pub mod ubisoft; +pub mod ea; pub mod epic; pub mod fetch_core; pub mod fetch_tuning; diff --git a/app/src/main/rust/stores/src/ubisoft/demux.rs b/app/src/main/rust/stores/src/ubisoft/demux.rs new file mode 100644 index 0000000000..b54fee4430 --- /dev/null +++ b/app/src/main/rust/stores/src/ubisoft/demux.rs @@ -0,0 +1,154 @@ +use std::sync::Arc; +use std::time::Duration; + +use tokio::io::{AsyncReadExt, AsyncWriteExt}; +use tokio::net::TcpStream; +use tokio_rustls::client::TlsStream; +use tokio_rustls::rustls::{self, pki_types::ServerName, ClientConfig, RootCertStore}; +use tokio_rustls::TlsConnector; + +use super::pb::{self, Msg}; + +const HOST: &str = "dmx.upc.ubisoft.com"; +const PORT: u16 = 443; +const CLIENT_ID: &str = "uplay_pc"; +/// The Connect build number Demux expects first on a socket; older ones get ClientOutdatedPush and a closed socket. +pub const CLIENT_VERSION: u32 = 13247; +const READ_TIMEOUT: Duration = Duration::from_secs(20); +const MAX_FRAME: usize = 64 << 20; + +pub struct Demux { + tls: TlsStream, + next_id: u32, +} + +impl Demux { + pub async fn connect(ticket: &str) -> Result { + let mut roots = RootCertStore::empty(); + roots.extend(webpki_roots::TLS_SERVER_ROOTS.iter().cloned()); + let provider = Arc::new(rustls::crypto::ring::default_provider()); + let config = ClientConfig::builder_with_provider(provider) + .with_safe_default_protocol_versions() + .map_err(|e| format!("TLS setup: {e}"))? + .with_root_certificates(roots) + .with_no_client_auth(); + let tcp = tokio::time::timeout(READ_TIMEOUT, TcpStream::connect((HOST, PORT))) + .await + .map_err(|_| "Ubisoft's download service did not answer".to_string())? + .map_err(|e| format!("Could not reach Ubisoft's download service: {e}"))?; + let name = ServerName::try_from(HOST).map_err(|e| e.to_string())?.to_owned(); + let tls = TlsConnector::from(Arc::new(config)) + .connect(name, tcp) + .await + .map_err(|e| format!("TLS with Ubisoft's download service failed: {e}"))?; + let mut d = Demux { tls, next_id: 1 }; + d.send(Msg::new().msg(2, Msg::new().msg(4, Msg::new().uint(1, CLIENT_VERSION as u64)))).await?; + let id = d.id(); + let auth = Msg::new().uint(1, id as u64).msg( + 2, + Msg::new() + .msg(1, Msg::new().text(3, ticket)) + .text(2, CLIENT_ID) + .flag(4, false), + ); + d.send(Msg::new().msg(1, auth)).await?; + let rsp = d.response(id).await?; + let a = pb::fields(pb::sub(&pb::fields(&rsp)?, 2).ok_or("Ubisoft did not answer the sign-in")?)?; + if pb::num(&a, 1) != Some(1) { + let expired = pb::num(&a, 2) == Some(1); + return Err(if expired { "The Ubisoft sign-in expired".into() } else { "Ubisoft refused the sign-in".into() }); + } + Ok(d) + } + + fn id(&mut self) -> u32 { + let id = self.next_id; + self.next_id += 1; + id + } + + async fn send(&mut self, up: Msg) -> Result<(), String> { + let len = (up.0.len() as u32).to_be_bytes(); + self.tls.write_all(&len).await.map_err(|e| e.to_string())?; + self.tls.write_all(&up.0).await.map_err(|e| e.to_string())?; + self.tls.flush().await.map_err(|e| e.to_string()) + } + + async fn frame(&mut self) -> Result, String> { + let read = async { + let mut len = [0u8; 4]; + self.tls.read_exact(&mut len).await.map_err(|e| format!("Ubisoft closed the connection: {e}"))?; + let n = u32::from_be_bytes(len) as usize; + if n > MAX_FRAME { + return Err(format!("Ubisoft sent a {n}-byte frame")); + } + let mut body = vec![0u8; n]; + self.tls.read_exact(&mut body).await.map_err(|e| e.to_string())?; + Ok(body) + }; + tokio::time::timeout(READ_TIMEOUT, read).await.map_err(|_| "Ubisoft's download service stopped answering".to_string())? + } + + fn check_push(down: &[(u32, pb::Value<'_>)]) -> Result<(), String> { + if let Some(push) = pb::sub(down, 2) { + let p = pb::fields(push)?; + if pb::first(&p, 5).is_some() { + return Err("Ubisoft says this client version is outdated".into()); + } + } + Ok(()) + } + + async fn response(&mut self, id: u32) -> Result, String> { + for _ in 0..64 { + let frame = self.frame().await?; + let down = pb::fields(&frame)?; + Self::check_push(&down)?; + if let Some(rsp) = pb::sub(&down, 1) { + if pb::num(&pb::fields(rsp)?, 1) == Some(id as u64) { + return Ok(rsp.to_vec()); + } + } + } + Err("Ubisoft never answered the request".into()) + } + + pub async fn open(&mut self, service: &str) -> Result { + let id = self.id(); + self.send(Msg::new().msg(1, Msg::new().uint(1, id as u64).msg(3, Msg::new().text(2, service)))).await?; + let rsp = self.response(id).await?; + let o = pb::fields(pb::sub(&pb::fields(&rsp)?, 3).ok_or("no connection answer")?)?; + if pb::num(&o, 2) != Some(1) { + return Err(format!("Ubisoft refused the {service} connection")); + } + pb::num(&o, 1).map(|c| c as u32).ok_or_else(|| "no connection id".into()) + } + + /// One service request on a connection; the payload is length-prefixed inside the DataMessage both ways. + pub async fn call(&mut self, connection: u32, payload: Msg) -> Result, String> { + let mut framed = (payload.0.len() as u32).to_be_bytes().to_vec(); + framed.extend_from_slice(&payload.0); + self.send(Msg::new().msg(2, Msg::new().msg(1, Msg::new().uint(1, connection as u64).bytes(2, &framed)))).await?; + for _ in 0..64 { + let frame = self.frame().await?; + let down = pb::fields(&frame)?; + Self::check_push(&down)?; + let Some(push) = pb::sub(&down, 2) else { continue }; + let p = pb::fields(push)?; + if let Some(closed) = pb::sub(&p, 2) { + let c = pb::fields(closed)?; + if pb::num(&c, 1) == Some(connection as u64) { + return Err(format!("Ubisoft closed the service connection (code {})", pb::num(&c, 2).unwrap_or(0))); + } + } + let Some(data) = pb::sub(&p, 1) else { continue }; + let d = pb::fields(data)?; + if pb::num(&d, 1) != Some(connection as u64) { + continue; + } + let body = pb::sub(&d, 2).unwrap_or_default(); + return Ok(if body.len() >= 4 { body[4..].to_vec() } else { body.to_vec() }); + } + Err("Ubisoft never answered the service request".into()) + } +} diff --git a/app/src/main/rust/stores/src/ubisoft/ffi.rs b/app/src/main/rust/stores/src/ubisoft/ffi.rs new file mode 100644 index 0000000000..30df1ccd4f --- /dev/null +++ b/app/src/main/rust/stores/src/ubisoft/ffi.rs @@ -0,0 +1,269 @@ +use std::panic::{catch_unwind, AssertUnwindSafe}; +use std::sync::atomic::{AtomicBool, Ordering}; +use std::sync::Arc; + +use jni::objects::{GlobalRef, JClass, JObject, JString, JValue}; +use jni::sys::{jlong, jstring, JNI_FALSE, JNI_TRUE}; +use jni::{JNIEnv, JavaVM}; +use serde_json::json; + +use super::install; +use crate::amazon::install::{Events, Stop}; + +fn read_string(env: &mut JNIEnv, value: &JString) -> String { + if value.is_null() { + return String::new(); + } + env.get_string(value).map(|s| s.to_string_lossy().into_owned()).unwrap_or_default() +} + +fn new_string(env: &mut JNIEnv, text: &str) -> jstring { + env.new_string(text).map(|s| s.into_raw()).unwrap_or(std::ptr::null_mut()) +} + +fn owned(ticket: &str, session: &str) -> Result { + let rt = tokio::runtime::Builder::new_current_thread().enable_all().build().map_err(|e| e.to_string())?; + rt.block_on(async { + let mut d = super::demux::Demux::connect(ticket).await?; + let (mut ownership, mut games) = super::service::Ownership::open(&mut d, ticket, session).await?; + let missing: Vec = games.iter().filter(|g| g.owned && g.product_type == 0 && g.manifest.is_empty()).map(|g| g.product_id).collect(); + let (found, manifest_error) = match ownership.latest_manifests(&mut d, &missing).await { + Ok(m) => (m, String::new()), + Err(e) => (Vec::new(), e), + }; + for (product, manifest) in &found { + if let Some(g) = games.iter_mut().find(|g| g.product_id == *product) { + g.manifest = manifest.clone(); + } + } + Ok(json!({ "games": games.iter().map(|g| g.to_json()).collect::>(), + "manifestsAsked": missing.len(), "manifestsFound": found.len(), "manifestError": manifest_error })) + }) +} + +fn launch(ticket: &str, session: &str, product: u32) -> Result { + let rt = tokio::runtime::Builder::new_current_thread().enable_all().build().map_err(|e| e.to_string())?; + rt.block_on(async { + let mut d = super::demux::Demux::connect(ticket).await?; + let (mut ownership, games) = super::service::Ownership::open(&mut d, ticket, session).await?; + if !games.iter().any(|g| g.product_id == product && g.owned) { + return Err("Ubisoft says this account does not own the game".into()); + } + let pc_ticket = ownership.pc_ticket(&mut d, product, ticket, session).await?; + let owned: Vec = games.iter().filter(|g| g.in_session()).map(|g| g.product_id).collect(); + let products: Vec<_> = games.iter().filter(|g| g.in_session()).map(|g| json!({ "id": g.product_id, "type": g.product_type })).collect(); + Ok(json!({ "ticket": pc_ticket, "owned": owned, "products": products })) + }) +} + +fn unhex(s: &str) -> Result, String> { + if s.len() % 2 != 0 { + return Err("odd hex length".into()); + } + (0..s.len()).step_by(2).map(|i| u8::from_str_radix(&s[i..i + 2], 16).map_err(|e| e.to_string())).collect() +} + +fn denuvo(ticket: &str, session: &str, product: u32, challenge: &str) -> Result { + let challenge = unhex(challenge).map_err(|e| format!("challenge: {e}"))?; + let rt = tokio::runtime::Builder::new_current_thread().enable_all().build().map_err(|e| e.to_string())?; + rt.block_on(async { + let mut d = super::demux::Demux::connect(ticket).await?; + let (mut ownership, _) = super::service::Ownership::open(&mut d, ticket, session).await?; + let token = ownership.token(&mut d, product).await?; + let game = super::service::denuvo_token(&mut d, &token, &challenge).await?; + Ok(json!({ "token": game.iter().map(|b| format!("{b:02x}")).collect::() })) + }) +} + +fn call(op: &str, request: &str) -> String { + let parsed: serde_json::Value = serde_json::from_str(request).unwrap_or(serde_json::Value::Null); + let s = |k: &str| parsed.get(k).and_then(|v| v.as_str()).unwrap_or("").to_string(); + let answer = match op { + "owned" => owned(&s("ticket"), &s("sessionId")).unwrap_or_else(|e| json!({ "error": e })), + "denuvo" => denuvo(&s("ticket"), &s("sessionId"), parsed.get("productId").and_then(|v| v.as_u64()).unwrap_or(0) as u32, &s("challenge")) + .unwrap_or_else(|e| json!({ "error": e })), + "chunks" => install::Request::from_json(&parsed) + .and_then(|r| install::chunks(&r)) + .map(|m| json!({ "chunks": install::chunks_json(&m.chunks), "setup": install::setup_json(&m) })) + .unwrap_or_else(|e| json!({ "error": e })), + "launch" => launch(&s("ticket"), &s("sessionId"), parsed.get("productId").and_then(|v| v.as_u64()).unwrap_or(0) as u32) + .unwrap_or_else(|e| json!({ "error": e })), + _ => json!({ "error": format!("unknown operation {op}") }), + }; + answer.to_string() +} + +#[no_mangle] +pub extern "system" fn Java_com_droiddeck_launcher_stores_ubisoft_UbisoftNative_nativeCall( + mut env: JNIEnv, + _class: JClass, + op: JString, + request: JString, +) -> jstring { + let op = read_string(&mut env, &op); + let request = read_string(&mut env, &request); + match catch_unwind(AssertUnwindSafe(|| call(&op, &request))) { + Ok(text) => new_string(&mut env, &text), + Err(_) => std::ptr::null_mut(), + } +} + +struct Listener { + vm: JavaVM, + target: GlobalRef, +} + +impl Listener { + fn with_env(&self, fallback: R, f: impl FnOnce(&mut JNIEnv) -> R) -> R { + let Ok(mut env) = self.vm.attach_current_thread_as_daemon() else { + return fallback; + }; + let out = f(&mut env); + if env.exception_check().unwrap_or(false) { + let _ = env.exception_clear(); + } + out + } + + fn text(&self, method: &str, text: &str) { + self.with_env((), |env| { + let Ok(s) = env.new_string(text) else { return }; + let s = JObject::from(s); + let _ = env.call_method(self.target.as_obj(), method, "(Ljava/lang/String;)V", &[JValue::Object(&s)]); + let _ = env.delete_local_ref(s); + }); + } + + fn counts(&self, method: &str, a: u64, b: u64, c: u32, d: u32) { + self.with_env((), |env| { + let _ = env.call_method( + self.target.as_obj(), + method, + "(JJII)V", + &[ + JValue::Long(a.min(i64::MAX as u64) as i64), + JValue::Long(b.min(i64::MAX as u64) as i64), + JValue::Int(c.min(i32::MAX as u32) as i32), + JValue::Int(d.min(i32::MAX as u32) as i32), + ], + ); + }); + } + + fn complete(&self, success: bool, cancelled: bool, error: &str, result: &str) { + self.with_env((), |env| { + let (Ok(e), Ok(r)) = (env.new_string(error), env.new_string(result)) else { return }; + let (e, r) = (JObject::from(e), JObject::from(r)); + let _ = env.call_method( + self.target.as_obj(), + "onComplete", + "(ZZLjava/lang/String;Ljava/lang/String;)V", + &[ + JValue::Bool(if success { JNI_TRUE } else { JNI_FALSE }), + JValue::Bool(if cancelled { JNI_TRUE } else { JNI_FALSE }), + JValue::Object(&e), + JValue::Object(&r), + ], + ); + let _ = env.delete_local_ref(e); + let _ = env.delete_local_ref(r); + }); + } +} + +impl Events for Listener { + fn log(&self, line: &str) { + self.text("onLog", &crate::amazon::net::scrub_urls(line)); + } + + fn status(&self, text: &str) { + self.text("onStatus", text); + } + + fn checking(&self, done_bytes: u64, total_bytes: u64, files: u32, files_total: u32) { + self.counts("onCheck", done_bytes, total_bytes, files, files_total); + } + + fn sizes(&self, pending_bytes: u64, total_bytes: u64) { + self.with_env((), |env| { + let _ = env.call_method( + self.target.as_obj(), + "onSizes", + "(JJ)V", + &[ + JValue::Long(pending_bytes.min(i64::MAX as u64) as i64), + JValue::Long(total_bytes.min(i64::MAX as u64) as i64), + ], + ); + }); + } + + fn progress(&self, done: u64, total: u64, files: u32, files_total: u32) { + self.counts("onProgress", done, total, files, files_total); + } + + fn before_replace(&self) -> bool { + self.with_env(false, |env| match env.call_method(self.target.as_obj(), "beforeReplace", "()Z", &[]) { + Ok(v) => v.z().unwrap_or(false), + Err(_) => false, + }) + } +} + +#[no_mangle] +pub extern "system" fn Java_com_droiddeck_launcher_stores_ubisoft_UbisoftNative_nativeInstall( + mut env: JNIEnv, + _class: JClass, + request: JString, + listener: JObject, +) -> jlong { + if listener.is_null() { + return 0; + } + let Ok(vm) = env.get_java_vm() else { return 0 }; + let Ok(target) = env.new_global_ref(&listener) else { return 0 }; + let listener = Listener { vm, target }; + let text = read_string(&mut env, &request); + let parsed = serde_json::from_str::(&text) + .map_err(|_| "The install request could not be read".to_string()) + .and_then(|v| install::Request::from_json(&v)); + let request = match parsed { + Ok(r) => r, + Err(e) => { + listener.complete(false, false, &e, ""); + return 0; + } + }; + let cancel = Arc::new(AtomicBool::new(false)); + let worker_cancel = Arc::clone(&cancel); + let spawned = std::thread::Builder::new().name("ubisoft-install".into()).spawn(move || { + crate::priority::background(); + let result = catch_unwind(AssertUnwindSafe(|| install::run(&request, &worker_cancel, &listener))) + .unwrap_or_else(|_| Err(Stop::Failed("The Ubisoft install stopped on an internal error".into()))); + match result { + Ok(done) => listener.complete(true, false, "", &done.to_json().to_string()), + Err(Stop::Cancelled) => listener.complete(false, true, "cancelled", ""), + Err(Stop::Failed(e)) => listener.complete(false, false, &e, ""), + } + }); + if spawned.is_err() { + return 0; + } + Box::into_raw(Box::new(cancel)) as jlong +} + +#[no_mangle] +pub extern "system" fn Java_com_droiddeck_launcher_stores_ubisoft_UbisoftNative_nativeCancel(_env: JNIEnv, _class: JClass, handle: jlong) { + let ptr = handle as *const Arc; + if let Some(cancel) = unsafe { ptr.as_ref() } { + cancel.store(true, Ordering::SeqCst); + } +} + +#[no_mangle] +pub extern "system" fn Java_com_droiddeck_launcher_stores_ubisoft_UbisoftNative_nativeRelease(_env: JNIEnv, _class: JClass, handle: jlong) { + let ptr = handle as *mut Arc; + if !ptr.is_null() { + drop(unsafe { Box::from_raw(ptr) }); + } +} diff --git a/app/src/main/rust/stores/src/ubisoft/install.rs b/app/src/main/rust/stores/src/ubisoft/install.rs new file mode 100644 index 0000000000..fdb4357fab --- /dev/null +++ b/app/src/main/rust/stores/src/ubisoft/install.rs @@ -0,0 +1,408 @@ +use std::collections::HashMap; +use std::io::{Read, Seek, SeekFrom, Write}; +use std::path::{Component, Path, PathBuf}; +use std::sync::atomic::{AtomicBool, AtomicU64, Ordering}; +use std::sync::Mutex; +use std::time::{Duration, Instant}; + +use futures_util::stream::{self, StreamExt}; +use serde_json::{json, Value as Json}; +use sha1::{Digest, Sha1}; + +use super::demux::Demux; +use super::manifest::{self, File}; +use super::service::{Downloads, Ownership}; +use crate::amazon::install::{Events, Stop}; + +const SIGN_BATCH: usize = 200; +const WINDOW: usize = 16; +const TRIES: usize = 4; + +pub struct Request { + pub ticket: String, + pub session_id: String, + pub product_id: u32, + pub manifest: String, + pub folder: PathBuf, + pub language: String, +} + +impl Request { + pub fn from_json(v: &Json) -> Result { + let s = |k: &str| v.get(k).and_then(|x| x.as_str()).unwrap_or("").to_string(); + let product_id = v.get("productId").and_then(|x| x.as_u64()).ok_or("no product id")? as u32; + let folder = PathBuf::from(s("folder")); + if s("ticket").is_empty() || folder.as_os_str().is_empty() { + return Err("The install request is incomplete".into()); + } + Ok(Request { ticket: s("ticket"), session_id: s("sessionId"), product_id, manifest: s("manifest"), folder, language: s("language") }) + } +} + +pub struct Done { + pub files: usize, + pub bytes: u64, + pub chunks: Vec, + pub setup: Json, +} + +pub fn chunks_json(chunks: &[manifest::Chunk]) -> Json { + Json::Array(chunks.iter().map(|c| json!({ "id": c.id, "tags": c.tags })).collect()) +} + +pub fn setup_json(m: &manifest::Manifest) -> Json { + json!({ + "installRuns": m.install_runs.iter().map(|(exe, args, what)| json!({ "exe": exe, "arguments": args, "description": what })).collect::>(), + "registry": m.registry.iter().map(|(key, values)| json!({ "key": key, "values": values.iter().map(|(n, v)| json!({ "name": n, "value": v })).collect::>() })).collect::>(), + }) +} + +impl Done { + pub fn to_json(&self) -> Json { + json!({ "files": self.files, "bytes": self.bytes, "chunks": chunks_json(&self.chunks), "setup": self.setup.clone() }) + } +} + +pub fn safe_path(root: &Path, name: &str) -> Result { + let rel = Path::new(name.trim_start_matches('/')); + if rel.components().any(|c| !matches!(c, Component::Normal(_))) { + return Err(format!("The manifest names an unsafe path: {name}")); + } + Ok(root.join(rel)) +} + +fn sha1(b: &[u8]) -> Vec { + Sha1::digest(b).to_vec() +} + +/// The slice as served and as unpacked must both match the manifest, so a bad proxy or a truncated body never lands in the game. +pub fn checked(method: u64, raw: &[u8], s: &manifest::Slice) -> Result, String> { + if let Some(n) = s.download_size { + if raw.len() as u32 != n { + return Err(format!("a slice is {} bytes, the manifest says {n}", raw.len())); + } + } + if !s.download_sha1.is_empty() && sha1(raw) != s.download_sha1 { + return Err("a slice failed its download checksum".into()); + } + let out = manifest::decompress(method, raw)?; + if s.size != 0 && out.len() as u32 != s.size { + return Err(format!("a slice unpacked to {} bytes, the manifest says {}", out.len(), s.size)); + } + if s.content_sha1.len() == 20 && sha1(&out) != s.content_sha1 { + return Err("a slice failed its content checksum".into()); + } + Ok(out) +} + +/// Whether a file of the right size already holds every slice the manifest lists for it; a file that cannot be checked is fetched again. +fn already_installed(path: &Path, f: &File) -> bool { + if f.slices.iter().any(|s| s.content_sha1.len() != 20 || s.size == 0) { + return false; + } + let Ok(mut file) = std::fs::File::open(path) else { return false }; + let mut buf = Vec::new(); + f.slices.iter().all(|s| { + buf.resize(s.size as usize, 0); + file.seek(SeekFrom::Start(s.offset)).is_ok() && file.read_exact(&mut buf).is_ok() && sha1(&buf) == s.content_sha1 + }) +} + +fn slice_hash(s: &manifest::Slice) -> String { + manifest::hex_upper(if s.download_sha1.is_empty() { &s.content_sha1 } else { &s.download_sha1 }) +} + +struct Job { + file: usize, + slice: usize, + path: String, +} + +async fn fetch(client: &reqwest::Client, urls: &[String]) -> Result, String> { + let mut last = String::from("no URL"); + for attempt in 0..TRIES { + for u in urls { + match client.get(u).send().await { + Ok(r) if r.status().is_success() => match r.bytes().await { + Ok(b) => return Ok(b.to_vec()), + Err(e) => last = e.to_string(), + }, + Ok(r) => last = format!("HTTP {}", r.status().as_u16()), + Err(e) => last = e.to_string(), + } + } + tokio::time::sleep(Duration::from_millis(500 << attempt)).await; + } + Err(format!("a slice could not be downloaded ({last})")) +} + +/// A Demux login holding a download_service connection for one product. Ubisoft drops idle sockets +/// while slices download, so signing reconnects and retries when the connection is gone. +struct Session { + d: Demux, + dl: Downloads, +} + +const RECONNECTS: usize = 4; + +impl Session { + /// Opens a session, retrying a few times: Demux drops a connection now and then right after another closes. + async fn open(req: &Request) -> Result<(Self, Vec), String> { + let mut last = String::new(); + for attempt in 0..3u32 { + if attempt > 0 { + tokio::time::sleep(Duration::from_secs(2 << attempt)).await; + } + match Self::open_once(req).await { + Ok(s) => return Ok(s), + Err(e) => last = e, + } + } + Err(last) + } + + async fn open_once(req: &Request) -> Result<(Self, Vec), String> { + let mut d = Demux::connect(&req.ticket).await?; + let (mut own, owned) = Ownership::open(&mut d, &req.ticket, &req.session_id).await?; + let token = own.token(&mut d, req.product_id).await?; + let dl = Downloads::open(&mut d, &token).await?; + Ok((Session { d, dl }, owned)) + } + + async fn sign(&mut self, req: &Request, paths: &[String], events: &dyn Events) -> Result>, String> { + let mut last = String::new(); + for attempt in 0..=RECONNECTS { + if attempt > 0 { + events.log(&format!("ubisoft: reconnecting after: {last}")); + tokio::time::sleep(Duration::from_millis(500 << attempt.min(4))).await; + match Session::open(req).await { + Ok((fresh, _)) => *self = fresh, + Err(e) => { + last = e; + continue; + } + } + } + match self.dl.sign(&mut self.d, req.product_id, paths).await { + Ok(urls) => return Ok(urls), + Err(e) if e.contains("does not own") => return Err(e), + Err(e) => last = e, + } + } + Err(last) + } +} + +/// The manifest of an install, without downloading the game. +pub fn chunks(req: &Request) -> Result { + let rt = tokio::runtime::Builder::new_current_thread().enable_all().build().map_err(|e| e.to_string())?; + rt.block_on(async { + let (mut sess, owned) = Session::open(req).await?; + let manifest_id = if req.manifest.is_empty() { + owned.iter().find(|o| o.product_id == req.product_id).map(|o| o.manifest.clone()).unwrap_or_default() + } else { + req.manifest.clone() + }; + if manifest_id.is_empty() { + return Err("Ubisoft lists no download for this game".to_string()); + } + let client = reqwest::Client::builder().timeout(Duration::from_secs(120)).build().map_err(|e| e.to_string())?; + struct Quiet; + impl Events for Quiet { + fn log(&self, _: &str) {} + fn status(&self, _: &str) {} + fn checking(&self, _: u64, _: u64, _: u32, _: u32) {} + fn sizes(&self, _: u64, _: u64) {} + fn progress(&self, _: u64, _: u64, _: u32, _: u32) {} + fn before_replace(&self) -> bool { false } + } + let urls = sess.sign(req, &[format!("manifests/{manifest_id}.manifest")], &Quiet).await?; + let raw = fetch(&client, urls.first().map(|v| v.as_slice()).unwrap_or_default()).await?; + let language = if req.language.is_empty() { "en-US" } else { req.language.as_str() }; + let mut owned_ids: Vec = owned.iter().filter(|o| o.owned).map(|o| o.product_id).collect(); + owned_ids.push(req.product_id); + Ok(manifest::parse_owned(&manifest::decode(&raw)?, language, &owned_ids)?) + }) +} + +pub fn run(req: &Request, cancel: &AtomicBool, events: &dyn Events) -> Result { + let rt = tokio::runtime::Builder::new_current_thread().enable_all().build().map_err(|e| Stop::Failed(e.to_string()))?; + rt.block_on(install(req, cancel, events)) +} + +async fn install(req: &Request, cancel: &AtomicBool, events: &dyn Events) -> Result { + let fail = Stop::Failed; + events.status("Connecting to Ubisoft"); + let (mut sess, owned) = Session::open(req).await.map_err(fail)?; + let manifest_id = if req.manifest.is_empty() { + owned.iter().find(|o| o.product_id == req.product_id).map(|o| o.manifest.clone()).unwrap_or_default() + } else { + req.manifest.clone() + }; + if manifest_id.is_empty() { + return Err(Stop::Failed("Ubisoft lists no download for this game".into())); + } + let client = reqwest::Client::builder().timeout(Duration::from_secs(120)).build().map_err(|e| Stop::Failed(e.to_string()))?; + + events.status("Reading the game's file list"); + let urls = sess.sign(req, &[format!("manifests/{manifest_id}.manifest")], events).await.map_err(fail)?; + let raw = fetch(&client, urls.first().map(|v| v.as_slice()).unwrap_or_default()).await.map_err(fail)?; + let decoded = manifest::decode(&raw).map_err(fail)?; + let language = if req.language.is_empty() { "en-US" } else { req.language.as_str() }; + let mut owned_ids: Vec = owned.iter().filter(|o| o.owned).map(|o| o.product_id).collect(); + owned_ids.push(req.product_id); + let m = manifest::parse_owned(&decoded, language, &owned_ids).map_err(fail)?; + events.log(&format!("ubisoft: manifest {manifest_id} files={} chunks={} skipped={} compression={}", m.files.len(), m.chunks.len(), m.skipped.len(), m.compression)); + for name in &m.skipped { + if let Ok(path) = safe_path(&req.folder, name) { + if path.is_file() && std::fs::remove_file(&path).is_ok() { + events.log(&format!("ubisoft: removed {name}, which this install leaves out")); + } + } + } + + std::fs::create_dir_all(&req.folder).map_err(|e| Stop::Failed(format!("Could not create the game folder: {e}")))?; + let total: u64 = m.files.iter().map(|f| f.size).sum(); + let files_total = m.files.len() as u32; + let mut pending: Vec = Vec::new(); + let mut done_bytes = 0u64; + let mut done_files = 0u32; + for (i, f) in m.files.iter().enumerate() { + let path = safe_path(&req.folder, &f.name).map_err(fail)?; + if f.dir { + std::fs::create_dir_all(&path).map_err(|e| Stop::Failed(e.to_string()))?; + done_files += 1; + continue; + } + if std::fs::metadata(&path).map(|md| md.len() == f.size).unwrap_or(false) && already_installed(&path, f) { + done_bytes += f.size; + done_files += 1; + continue; + } + pending.push(i); + } + let pending_bytes: u64 = pending.iter().map(|&i| m.files[i].size).sum(); + events.sizes(pending_bytes, total); + events.log(&format!("ubisoft: {} of {} files to fetch, {pending_bytes} bytes", pending.len(), m.files.len())); + + let bucketed = match pending.iter().flat_map(|&i| m.files[i].slices.first()).next() { + None => true, + Some(s) => { + let h = slice_hash(s); + let probe = sess.sign(req, &[manifest::slice_path(true, &h), manifest::slice_path(false, &h)], events).await.map_err(fail)?; + let mut v3 = true; + for (layout, list) in [true, false].into_iter().zip(probe.iter()) { + if let Some(u) = list.first() { + if client.get(u).send().await.map(|r| r.status().is_success()).unwrap_or(false) { + v3 = layout; + break; + } + } + } + v3 + } + }; + + let mut parts: HashMap> = HashMap::new(); + let mut remaining: HashMap = HashMap::new(); + let mut jobs = Vec::new(); + for &i in &pending { + let f: &File = &m.files[i]; + let path = safe_path(&req.folder, &f.name).map_err(fail)?; + if let Some(parent) = path.parent() { + std::fs::create_dir_all(parent).map_err(|e| Stop::Failed(e.to_string()))?; + } + let part = path.with_extension(format!("{}part", path.extension().map(|e| format!("{}.", e.to_string_lossy())).unwrap_or_default())); + let file = std::fs::File::create(&part).map_err(|e| Stop::Failed(format!("Could not write {}: {e}", f.name)))?; + file.set_len(f.size).map_err(|e| Stop::Failed(e.to_string()))?; + parts.insert(i, Mutex::new(file)); + remaining.insert(i, f.slices.len()); + for (si, s) in f.slices.iter().enumerate() { + jobs.push(Job { file: i, slice: si, path: manifest::slice_path(bucketed, &slice_hash(s)) }); + } + } + + let progress = AtomicU64::new(done_bytes); + let mut finished_files = done_files; + let mut last_report = Instant::now(); + events.status("Downloading"); + for batch in jobs.chunks(SIGN_BATCH) { + if cancel.load(Ordering::SeqCst) { + return Err(Stop::Cancelled); + } + let paths: Vec = batch.iter().map(|j| j.path.clone()).collect(); + let signed = sess.sign(req, &paths, events).await.map_err(fail)?; + let mut slices = stream::iter(batch.iter().zip(signed.into_iter())) + .map(|(job, urls)| { + let client = &client; + let m = &m; + async move { + let s = &m.files[job.file].slices[job.slice]; + let raw = fetch(client, &urls).await?; + let out = checked(m.compression, &raw, s).map_err(|e| format!("{}: {e}", m.files[job.file].name))?; + Ok::<_, String>((job.file, job.slice, out)) + } + }) + .buffer_unordered(WINDOW); + while let Some(r) = slices.next().await { + if cancel.load(Ordering::SeqCst) { + return Err(Stop::Cancelled); + } + let (fi, si, data) = r.map_err(fail)?; + let s = &m.files[fi].slices[si]; + { + let mut f = parts[&fi].lock().unwrap(); + f.seek(SeekFrom::Start(s.offset)).and_then(|_| f.write_all(&data)).map_err(|e| Stop::Failed(format!("Could not write {}: {e}", m.files[fi].name)))?; + } + progress.fetch_add(data.len() as u64, Ordering::Relaxed); + let left = remaining.get_mut(&fi).unwrap(); + *left -= 1; + if *left == 0 { + let f = parts.remove(&fi).unwrap().into_inner().unwrap(); + f.sync_all().map_err(|e| Stop::Failed(e.to_string()))?; + drop(f); + let path = safe_path(&req.folder, &m.files[fi].name).map_err(fail)?; + let part = path.with_extension(format!("{}part", path.extension().map(|e| format!("{}.", e.to_string_lossy())).unwrap_or_default())); + std::fs::rename(&part, &path).map_err(|e| Stop::Failed(format!("Could not finish {}: {e}", m.files[fi].name)))?; + finished_files += 1; + } + if last_report.elapsed() > Duration::from_millis(250) { + events.progress(progress.load(Ordering::Relaxed), total, finished_files, files_total); + last_report = Instant::now(); + } + } + } + for i in pending.iter().copied().filter(|i| m.files[*i].slices.is_empty()) { + let path = safe_path(&req.folder, &m.files[i].name).map_err(fail)?; + parts.remove(&i); + let part = path.with_extension(format!("{}part", path.extension().map(|e| format!("{}.", e.to_string_lossy())).unwrap_or_default())); + std::fs::rename(&part, &path).map_err(|e| Stop::Failed(e.to_string()))?; + finished_files += 1; + } + events.progress(total, total, finished_files, files_total); + Ok(Done { files: m.files.len(), bytes: total, chunks: m.chunks.clone(), setup: setup_json(&m) }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn refuses_paths_that_leave_the_folder() { + let root = Path::new("/games/x"); + assert!(safe_path(root, "../evil").is_err()); + assert!(safe_path(root, "a/../../evil").is_err()); + assert_eq!(safe_path(root, "/bin/game.exe").unwrap(), root.join("bin/game.exe")); + } + + #[test] + fn checks_a_slice_as_served_and_unpacked() { + let data = b"slice".to_vec(); + let ok = manifest::Slice { size: 5, download_size: Some(5), download_sha1: sha1(&data), content_sha1: Vec::new(), offset: 0 }; + assert_eq!(checked(0, &data, &ok).unwrap(), data); + let bad = manifest::Slice { download_sha1: vec![0; 20], ..ok.clone() }; + assert!(checked(0, &data, &bad).is_err()); + let short = manifest::Slice { download_size: Some(4), ..ok }; + assert!(checked(0, &data, &short).is_err()); + } +} diff --git a/app/src/main/rust/stores/src/ubisoft/manifest.rs b/app/src/main/rust/stores/src/ubisoft/manifest.rs new file mode 100644 index 0000000000..0487a58564 --- /dev/null +++ b/app/src/main/rust/stores/src/ubisoft/manifest.rs @@ -0,0 +1,230 @@ +use std::io::Read; + +use super::pb; + +/// Bytes Ubisoft prepends to a downloaded `.manifest` before the zlib stream. +pub const HEADER: usize = 356; +pub const DEFLATE: u64 = 1; +pub const ZSTD: u64 = 3; + +#[derive(Clone, Debug, PartialEq)] +pub struct Slice { + pub size: u32, + pub download_size: Option, + pub download_sha1: Vec, + pub content_sha1: Vec, + pub offset: u64, +} + +#[derive(Clone, Debug, PartialEq)] +pub struct File { + pub name: String, + pub size: u64, + pub dir: bool, + pub slices: Vec, +} + +/// A chunk the install keeps, as the game's launcher session reports it. +#[derive(Clone, Debug, PartialEq)] +pub struct Chunk { + pub id: u32, + pub tags: String, +} + +#[derive(Debug)] +pub struct Manifest { + pub compression: u64, + pub files: Vec, + pub chunks: Vec, + /// Files of chunks left out: other languages, and add-ons the account does not own. + pub skipped: Vec, + /// Prerequisite installers Connect runs after an install: exe, arguments, description. + pub install_runs: Vec<(String, String, String)>, + /// Registry keys Connect writes for the game, with their string values as (name, value). + pub registry: Vec<(String, Vec<(String, String)>)>, +} + +fn file(b: &[u8]) -> Result { + let f = pb::fields(b)?; + let hashes = pb::subs(&f, 4); + let mut offset = 0u64; + let mut slices = Vec::new(); + for (i, s) in pb::subs(&f, 7).into_iter().enumerate() { + let s = pb::fields(s)?; + let size = pb::num(&s, 1).unwrap_or(0) as u32; + let at = pb::num(&s, 4).unwrap_or(offset); + slices.push(Slice { + size, + download_size: pb::num(&s, 2).map(|v| v as u32), + download_sha1: pb::sub(&s, 3).unwrap_or_default().to_vec(), + content_sha1: hashes.get(i).map(|h| h.to_vec()).unwrap_or_default(), + offset: at, + }); + offset = at + size as u64; + } + if slices.is_empty() { + for h in &hashes { + slices.push(Slice { size: 0, download_size: None, download_sha1: Vec::new(), content_sha1: h.to_vec(), offset: 0 }); + } + } + Ok(File { + name: pb::string(&f, 1).unwrap_or_default().replace('\\', "/"), + size: pb::num(&f, 2).unwrap_or(0), + dir: pb::num(&f, 3) == Some(1), + slices, + }) +} + +/// Files of the chunks to install: those for every language plus the language asked for, of the +/// game itself or an optional add-on in `owned` (every add-on when `owned` is empty). +pub fn parse(decoded: &[u8], language: &str) -> Result { + parse_owned(decoded, language, &[]) +} + +pub fn parse_owned(decoded: &[u8], language: &str, owned: &[u32]) -> Result { + let m = pb::fields(decoded)?; + let wanted = language.to_ascii_lowercase(); + let prefix = wanted.split(['-', '_']).next().unwrap_or("").to_string(); + let mut files = Vec::new(); + let mut chunks = Vec::new(); + let mut skipped = Vec::new(); + for c in pb::subs(&m, 4) { + let c = pb::fields(c)?; + let lang = pb::string(&c, 5).unwrap_or_default().to_ascii_lowercase(); + let mut products: Vec = c.iter().filter_map(|(n, v)| match v { pb::Value::Varint(x) if *n == 8 => Some(*x as u32), _ => None }).collect(); + products.extend(pb::num(&c, 4).map(|v| v as u32)); + let in_language = lang.is_empty() || lang == wanted || (!prefix.is_empty() && lang.split(['-', '_']).next() == Some(prefix.as_str())); + let optional = pb::num(&c, 2) == Some(1); + let owned_product = !optional || owned.is_empty() || products.is_empty() || products.iter().any(|p| owned.contains(p)); + if !(in_language && owned_product) { + for f in pb::subs(&c, 3) { + skipped.push(file(f)?.name); + } + continue; + } + chunks.push(Chunk { id: pb::num(&c, 1).unwrap_or(0) as u32, tags: pb::string(&c, 7).unwrap_or_default() }); + for f in pb::subs(&c, 3) { + files.push(file(f)?); + } + } + let kept: std::collections::HashSet<&str> = files.iter().map(|f| f.name.as_str()).collect(); + skipped.retain(|n| !kept.contains(n.as_str())); + let mut install_runs = Vec::new(); + for r in pb::subs(&m, 2) { + let r = pb::fields(r)?; + install_runs.push((pb::string(&r, 1).unwrap_or_default(), pb::string(&r, 3).unwrap_or_default(), pb::string(&r, 4).unwrap_or_default())); + } + let mut registry = Vec::new(); + for r in pb::subs(&m, 5) { + let r = pb::fields(r)?; + let mut values = Vec::new(); + for e in pb::subs(&r, 3) { + let e = pb::fields(e)?; + values.push((pb::string(&e, 1).unwrap_or_default(), pb::string(&e, 2).unwrap_or_default())); + } + registry.push((pb::string(&r, 1).unwrap_or_default(), values)); + } + Ok(Manifest { compression: pb::num(&m, 21).unwrap_or(0), files, chunks, skipped, install_runs, registry }) +} + +pub fn decode(downloaded: &[u8]) -> Result, String> { + if downloaded.len() <= HEADER { + return Err(format!("the manifest is only {} bytes", downloaded.len())); + } + let mut out = Vec::new(); + flate2::read::ZlibDecoder::new(&downloaded[HEADER..]).read_to_end(&mut out).map_err(|e| format!("the manifest did not inflate: {e}"))?; + Ok(out) +} + +pub fn hex_upper(b: &[u8]) -> String { + b.iter().map(|x| format!("{x:02X}")).collect() +} + +/// The CDN bucket of a slice: the first byte of its hash with nibbles swapped, mapped onto base32. +pub fn bucket(hash_upper: &str) -> char { + const BASE32: &[u8; 32] = b"0123456789abcdefghijklmnopqrstuv"; + let b = hash_upper.as_bytes(); + let swapped = format!("{}{}", *b.get(1).unwrap_or(&b'0') as char, *b.first().unwrap_or(&b'0') as char); + let v = u8::from_str_radix(&swapped, 16).unwrap_or(0); + BASE32[(v / 16) as usize + if v % 2 == 0 { 0 } else { 16 }] as char +} + +pub fn slice_path(bucketed: bool, hash_upper: &str) -> String { + if bucketed { format!("slices_v3/{}/{}", bucket(hash_upper), hash_upper) } else { format!("slices/{hash_upper}") } +} + +pub fn decompress(method: u64, data: &[u8]) -> Result, String> { + match method { + ZSTD => { + let mut out = Vec::new(); + ruzstd::decoding::StreamingDecoder::new(data).map_err(|e| format!("zstd: {e}"))?.read_to_end(&mut out).map_err(|e| format!("zstd: {e}"))?; + Ok(out) + } + DEFLATE => { + let zlib = data.len() >= 2 && data[0] == 0x78; + let inflate = |z: bool| { + let mut out = Vec::new(); + let r = if z { flate2::read::ZlibDecoder::new(data).read_to_end(&mut out) } else { flate2::read::DeflateDecoder::new(data).read_to_end(&mut out) }; + r.map(|_| out) + }; + inflate(zlib).or_else(|_| inflate(!zlib)).map_err(|e| format!("deflate: {e}")) + } + _ => Ok(data.to_vec()), + } +} + +#[cfg(test)] +mod tests { + use super::super::pb::Msg; + use super::*; + + #[test] + fn buckets_follow_the_swapped_first_byte() { + assert_eq!(bucket("10ABCDEF"), 'g'); + assert_eq!(bucket("01ABCDEF"), '1'); + assert_eq!(slice_path(true, "01AB"), "slices_v3/1/01AB"); + assert_eq!(slice_path(false, "01AB"), "slices/01AB"); + } + + #[test] + fn keeps_shared_and_wanted_language_chunks() { + let f = |name: &str| Msg::new().text(1, name).uint(2, 10).flag(3, false) + .bytes(4, &[0xAA]).msg(7, Msg::new().uint(1, 10).uint(2, 4).bytes(3, &[0xBB])); + let m = Msg::new() + .msg(4, Msg::new().uint(1, 1).uint(2, 0).msg(3, f("Game\\game.exe"))) + .msg(4, Msg::new().uint(1, 2).uint(2, 1).msg(3, f("en.pak")).text(5, "en-US")) + .msg(4, Msg::new().uint(1, 3).uint(2, 1).msg(3, f("fr.pak")).text(5, "fr-FR")) + .uint(21, ZSTD); + let parsed = parse(&m.0, "en-US").unwrap(); + let names: Vec<_> = parsed.files.iter().map(|f| f.name.as_str()).collect(); + assert_eq!(names, ["Game/game.exe", "en.pak"]); + assert_eq!(parsed.compression, ZSTD); + assert_eq!(parsed.files[0].slices[0], Slice { size: 10, download_size: Some(4), download_sha1: vec![0xBB], content_sha1: vec![0xAA], offset: 0 }); + } + + #[test] + fn leaves_out_add_ons_the_account_does_not_own() { + let f = |name: &str| Msg::new().text(1, name).uint(2, 10).flag(3, false); + let m = Msg::new() + .msg(4, Msg::new().uint(1, 1).uint(2, 0).msg(3, f("base.forge")).uint(4, 9999)) + .msg(4, Msg::new().uint(1, 2).uint(2, 1).msg(3, f("dlc_24/east.forge")).uint(4, 5450)) + .msg(4, Msg::new().uint(1, 3).uint(2, 1).msg(3, f("dlc_25/west.forge")).uint(8, 5451).uint(8, 5452)) + .uint(21, ZSTD); + let parsed = parse_owned(&m.0, "en-US", &[5405, 5452]).unwrap(); + let names: Vec<_> = parsed.files.iter().map(|f| f.name.as_str()).collect(); + assert_eq!(names, ["base.forge", "dlc_25/west.forge"]); + assert_eq!(parsed.skipped, ["dlc_24/east.forge"]); + assert_eq!(parsed.chunks.iter().map(|c| c.id).collect::>(), [1, 3]); + } + + #[test] + fn inflates_both_deflate_framings() { + use std::io::Write; + let mut z = flate2::write::ZlibEncoder::new(Vec::new(), flate2::Compression::default()); + z.write_all(b"hello").unwrap(); + assert_eq!(decompress(DEFLATE, &z.finish().unwrap()).unwrap(), b"hello"); + let mut r = flate2::write::DeflateEncoder::new(Vec::new(), flate2::Compression::default()); + r.write_all(b"hello").unwrap(); + assert_eq!(decompress(DEFLATE, &r.finish().unwrap()).unwrap(), b"hello"); + } +} diff --git a/app/src/main/rust/stores/src/ubisoft/mod.rs b/app/src/main/rust/stores/src/ubisoft/mod.rs new file mode 100644 index 0000000000..eff0a806f0 --- /dev/null +++ b/app/src/main/rust/stores/src/ubisoft/mod.rs @@ -0,0 +1,6 @@ +pub mod demux; +pub mod ffi; +pub mod install; +pub mod manifest; +pub mod pb; +pub mod service; diff --git a/app/src/main/rust/stores/src/ubisoft/pb.rs b/app/src/main/rust/stores/src/ubisoft/pb.rs new file mode 100644 index 0000000000..f967cb60ca --- /dev/null +++ b/app/src/main/rust/stores/src/ubisoft/pb.rs @@ -0,0 +1,104 @@ +pub use crate::amazon::proto::{Fields, Value}; + +#[derive(Default)] +pub struct Msg(pub Vec); + +impl Msg { + pub fn new() -> Self { + Msg(Vec::new()) + } + + fn varint(&mut self, mut v: u64) { + loop { + let b = (v & 0x7f) as u8; + v >>= 7; + if v == 0 { + self.0.push(b); + return; + } + self.0.push(b | 0x80); + } + } + + fn key(&mut self, field: u32, wire: u8) { + self.varint((field as u64) << 3 | wire as u64); + } + + pub fn uint(mut self, field: u32, v: u64) -> Self { + self.key(field, 0); + self.varint(v); + self + } + + pub fn flag(self, field: u32, v: bool) -> Self { + self.uint(field, v as u64) + } + + pub fn bytes(mut self, field: u32, data: &[u8]) -> Self { + self.key(field, 2); + self.varint(data.len() as u64); + self.0.extend_from_slice(data); + self + } + + pub fn text(self, field: u32, s: &str) -> Self { + self.bytes(field, s.as_bytes()) + } + + pub fn msg(self, field: u32, m: Msg) -> Self { + self.bytes(field, &m.0) + } +} + +/// Every field of a message, in wire order; repeated fields appear once per value. +pub fn fields(data: &[u8]) -> Result)>, String> { + let mut out = Vec::new(); + let mut f = Fields::new(data); + while let Some(v) = f.next_field()? { + out.push(v); + } + Ok(out) +} + +pub fn first<'a>(all: &[(u32, Value<'a>)], field: u32) -> Option> { + all.iter().find(|(n, _)| *n == field).map(|(_, v)| *v) +} + +pub fn sub<'a>(all: &[(u32, Value<'a>)], field: u32) -> Option<&'a [u8]> { + match first(all, field) { + Some(Value::Bytes(b)) => Some(b), + _ => None, + } +} + +pub fn subs<'a>(all: &[(u32, Value<'a>)], field: u32) -> Vec<&'a [u8]> { + all.iter().filter_map(|(n, v)| match (n, v) { (n, Value::Bytes(b)) if *n == field => Some(*b), _ => None }).collect() +} + +pub fn num(all: &[(u32, Value<'_>)], field: u32) -> Option { + match first(all, field) { + Some(Value::Varint(v)) | Some(Value::Fixed64(v)) => Some(v), + Some(Value::Fixed32(v)) => Some(v as u64), + _ => None, + } +} + +pub fn string(all: &[(u32, Value<'_>)], field: u32) -> Option { + sub(all, field).map(|b| String::from_utf8_lossy(b).into_owned()) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn round_trips_nested_messages() { + let m = Msg::new().uint(1, 300).msg(2, Msg::new().text(1, "a").text(1, "b")).flag(3, true); + let all = fields(&m.0).unwrap(); + assert_eq!(num(&all, 1), Some(300)); + assert_eq!(num(&all, 3), Some(1)); + let inner = fields(sub(&all, 2).unwrap()).unwrap(); + let texts: Vec<_> = subs(&inner, 1).iter().map(|b| String::from_utf8_lossy(b).into_owned()).collect(); + assert_eq!(texts, ["a", "b"]); + } +} diff --git a/app/src/main/rust/stores/src/ubisoft/service.rs b/app/src/main/rust/stores/src/ubisoft/service.rs new file mode 100644 index 0000000000..bfdddc29a9 --- /dev/null +++ b/app/src/main/rust/stores/src/ubisoft/service.rs @@ -0,0 +1,206 @@ +use serde_json::{json, Value as Json}; + +use super::demux::Demux; +use super::pb::{self, Msg}; + +pub struct Owned { + pub product_id: u32, + pub space_id: String, + pub manifest: String, + pub product_type: u32, + pub state: u32, + pub owned: bool, + pub configuration: String, + pub app_id: String, + pub partner: u32, + pub activation: u32, + pub locked_by_subscription: bool, + pub associations: Vec, + pub download_id: u32, +} + +impl Owned { + /// Whether Connect lists the product among the session's owned ids: owned games and add-ons that are released. + pub fn in_session(&self) -> bool { + self.owned && self.product_type <= 1 && (self.state == 0 || self.state == 3) + } + + pub fn to_json(&self) -> Json { + json!({ + "productId": self.product_id, "spaceId": self.space_id, "manifest": self.manifest, + "productType": self.product_type, "state": self.state, "owned": self.owned, + "configuration": self.configuration, "appId": self.app_id, + "partner": self.partner, "activation": self.activation, "lockedBySubscription": self.locked_by_subscription, + "associations": self.associations, "downloadId": self.download_id, + }) + } +} + +pub struct Ownership { + conn: u32, + next: u64, +} + +fn owned_game(b: &[u8]) -> Result { + let f = pb::fields(b)?; + Ok(Owned { + product_id: pb::num(&f, 1).unwrap_or(0) as u32, + space_id: pb::string(&f, 30).unwrap_or_default(), + manifest: pb::string(&f, 21).unwrap_or_default(), + product_type: pb::num(&f, 8).unwrap_or(0) as u32, + state: pb::num(&f, 13).unwrap_or(0) as u32, + owned: pb::num(&f, 20).map(|v| v == 1).unwrap_or(true), + configuration: pb::string(&f, 17).unwrap_or_default(), + app_id: pb::string(&f, 31).unwrap_or_default(), + partner: pb::num(&f, 38).unwrap_or(0) as u32, + activation: pb::num(&f, 36).unwrap_or(0) as u32, + locked_by_subscription: pb::num(&f, 37) == Some(1), + associations: f.iter().filter_map(|(n, v)| match v { pb::Value::Varint(x) if *n == 16 => Some(*x as u32), _ => None }).collect(), + download_id: pb::num(&f, 5).unwrap_or(0) as u32, + }) +} + +impl Ownership { + /// Opens ownership_service and initializes it, which also returns the account's products. + pub async fn open(d: &mut Demux, ticket: &str, session_id: &str) -> Result<(Self, Vec), String> { + let conn = d.open("ownership_service").await?; + let init = Msg::new().flag(2, true).uint(3, 7); + let mut req = Msg::new().uint(1, 1).msg(2, init).text(30, ticket); + if !session_id.is_empty() { + req = req.text(31, session_id); + } + let raw = d.call(conn, Msg::new().msg(1, req)).await?; + let rsp = pb::fields(pb::sub(&pb::fields(&raw)?, 1).ok_or("no ownership answer")?)?; + let init = pb::fields(pb::sub(&rsp, 2).ok_or("no ownership initialize answer")?)?; + if pb::num(&init, 1) != Some(1) { + return Err("Ubisoft would not list the account's games".into()); + } + let mut games = Vec::new(); + if let Some(list) = pb::sub(&init, 2) { + for g in pb::subs(&pb::fields(list)?, 1) { + games.push(owned_game(g)?); + } + } + Ok((Ownership { conn, next: 2 }, games)) + } + + /// The latest manifest of each product that has one, for games whose ownership entry leaves it out. + pub async fn latest_manifests(&mut self, d: &mut Demux, products: &[u32]) -> Result, String> { + if products.is_empty() { + return Ok(Vec::new()); + } + let id = self.next; + self.next += 1; + let mut req = Msg::new(); + for p in products { + req = req.uint(1, *p as u64); + } + let raw = d.call(self.conn, Msg::new().msg(1, Msg::new().uint(1, id).msg(10, req))).await?; + let rsp = pb::fields(pb::sub(&pb::fields(&raw)?, 1).ok_or("no ownership answer")?)?; + let m = pb::fields(pb::sub(&rsp, 10).ok_or("no manifest answer")?)?; + if pb::num(&m, 1) != Some(1) { + return Err("Ubisoft would not list the latest manifests".into()); + } + let mut out = Vec::new(); + for entry in pb::subs(&m, 2) { + let e = pb::fields(entry)?; + if pb::num(&e, 1) != Some(1) { + continue; + } + if let (Some(product), Some(manifest)) = (pb::num(&e, 2), pb::string(&e, 3).filter(|s| !s.is_empty())) { + out.push((product as u32, manifest)); + } + } + Ok(out) + } + + /// The ticket a game receives in its launcher session (`GetUplayPCTicket`). + pub async fn pc_ticket(&mut self, d: &mut Demux, product_id: u32, ticket: &str, session_id: &str) -> Result { + let id = self.next; + self.next += 1; + let info = Msg::new().uint(1, product_id as u64).uint(2, 0).uint(3, product_id as u64); + let mut req = Msg::new().uint(1, id).msg(14, info).text(30, ticket); + if !session_id.is_empty() { + req = req.text(31, session_id); + } + let raw = d.call(self.conn, Msg::new().msg(1, req)).await?; + let rsp = pb::fields(pb::sub(&pb::fields(&raw)?, 1).ok_or("no ownership answer")?)?; + let t = pb::fields(pb::sub(&rsp, 13).ok_or("no game ticket answer")?)?; + if pb::num(&t, 1) != Some(1) { + return Err(format!("Ubisoft would not issue a game ticket (code {})", pb::num(&t, 3).unwrap_or(0))); + } + pb::string(&t, 2).filter(|s| !s.is_empty()).ok_or_else(|| "Ubisoft sent an empty game ticket".into()) + } + + pub async fn token(&mut self, d: &mut Demux, product_id: u32) -> Result { + let id = self.next; + self.next += 1; + let raw = d.call(self.conn, Msg::new().msg(1, Msg::new().uint(1, id).msg(28, Msg::new().uint(1, product_id as u64)))).await?; + let rsp = pb::fields(pb::sub(&pb::fields(&raw)?, 1).ok_or("no ownership answer")?)?; + let t = pb::fields(pb::sub(&rsp, 27).ok_or("no ownership token answer")?)?; + if pb::num(&t, 1) != Some(1) { + return Err("Ubisoft says this account does not own the game".into()); + } + pb::string(&t, 2).filter(|s| !s.is_empty()).ok_or_else(|| "Ubisoft sent an empty ownership token".into()) + } +} + +pub struct Downloads { + conn: u32, + next: u64, +} + +impl Downloads { + pub async fn open(d: &mut Demux, ownership_token: &str) -> Result { + let conn = d.open("download_service").await?; + let raw = d.call(conn, Msg::new().msg(1, Msg::new().uint(1, 1).msg(2, Msg::new().text(5, ownership_token)))).await?; + let rsp = pb::fields(pb::sub(&pb::fields(&raw)?, 1).ok_or("no download service answer")?)?; + let ok = pb::sub(&rsp, 2).map(pb::fields).transpose()?.and_then(|i| pb::num(&i, 1)) == Some(1); + if !ok { + return Err("Ubisoft's download service refused the ownership token".into()); + } + Ok(Downloads { conn, next: 2 }) + } + + /// Signed CDN URLs for paths under the product's download root, in request order; empty where none was given. + pub async fn sign(&mut self, d: &mut Demux, product_id: u32, paths: &[String]) -> Result>, String> { + let id = self.next; + self.next += 1; + let mut request = Msg::new().uint(1, product_id as u64); + for p in paths { + request = request.text(2, p); + } + let raw = d.call(self.conn, Msg::new().msg(1, Msg::new().uint(1, id).msg(3, Msg::new().msg(1, request)))).await?; + let rsp = pb::fields(pb::sub(&pb::fields(&raw)?, 1).ok_or("no download service answer")?)?; + let urls = pb::fields(pb::sub(&rsp, 3).ok_or("no signed URLs")?)?; + let mut out = Vec::new(); + for r in pb::subs(&urls, 1) { + let r = pb::fields(r)?; + if pb::num(&r, 1).unwrap_or(0) != 0 { + return Err("Ubisoft says this account does not own the game".into()); + } + for group in pb::subs(&r, 2) { + out.push(pb::subs(&pb::fields(group)?, 1).iter().map(|u| String::from_utf8_lossy(u).into_owned()).collect()); + } + } + if out.len() != paths.len() { + return Err(format!("Ubisoft signed {} of {} paths", out.len(), paths.len())); + } + Ok(out) + } +} + +/// Denuvo's activation for a game the account owns: the game's challenge and the product's ownership +/// token go to `denuvo_service`, which answers with the game token the game's aux DLL waits for. +pub async fn denuvo_token(d: &mut Demux, ownership_token: &str, challenge: &[u8]) -> Result, String> { + let conn = d.open("denuvo_service").await?; + let req = Msg::new().uint(1, 1).msg(2, Msg::new().text(1, ownership_token).bytes(2, challenge)); + let raw = d.call(conn, Msg::new().msg(1, req)).await?; + let rsp = pb::fields(pb::sub(&pb::fields(&raw)?, 1).ok_or("no denuvo answer")?)?; + let result = pb::num(&rsp, 2).unwrap_or(0); + if result != 0 { + return Err(format!("Ubisoft's activation service refused the game (result {result})")); + } + let t = pb::fields(pb::sub(&rsp, 3).ok_or("no game token answer")?)?; + pb::sub(&t, 1).filter(|b| !b.is_empty()).map(<[u8]>::to_vec).ok_or_else(|| "Ubisoft sent an empty game token".into()) +} diff --git a/app/src/test/java/com/droiddeck/launcher/DriverMenusAutoTest.kt b/app/src/test/java/com/droiddeck/launcher/DriverMenusAutoTest.kt index 0e15c04dba..923c1f41fd 100644 --- a/app/src/test/java/com/droiddeck/launcher/DriverMenusAutoTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/DriverMenusAutoTest.kt @@ -7,6 +7,7 @@ import android.os.Looper import com.droiddeck.launcher.session.QuestExperimental import com.droiddeck.launcher.session.SessionPrefs import com.droiddeck.launcher.gpu.TpUbwcHint +import com.droiddeck.launcher.gpu.TurnipDriver import org.junit.Assert.assertEquals import org.junit.Assert.assertFalse import org.junit.Assert.assertNull @@ -34,6 +35,31 @@ class DriverMenusAutoTest { ShadowBuild.setDevice("eureka") } + @Test fun pickingTheAutoDisplayHandsBothHalvesToAuto() { + val activity = Robolectric.buildActivity(Activity::class.java).setup().get() + SessionPrefs.setGpuDriverMode(activity, SessionPrefs.GPU_DRIVERS_MIX) + SessionPrefs.setAndroidDriver(activity, "chosen-display") + SessionPrefs.setLinuxDriver(activity, "chosen-linux") + val menus = DriverMenus(activity, Handler(Looper.getMainLooper())) + menus.selectDriver(TurnipDriver.AUTO, linux = false) + assertEquals(SessionPrefs.GPU_DRIVERS_AUTO, SessionPrefs.gpuDriverMode(activity)) + assertEquals(QuestExperimental.DRIVER, SessionPrefs.androidDriver(activity)) + assertEquals("", SessionPrefs.linuxDriver(activity)) + } + + @Test fun pickingTheAutoDisplayWithNoPairForTheGpuStillPutsTheDisplayOnAuto() { + ShadowBuild.setModel("Generic phone") + ShadowBuild.setDevice("generic") + val activity = Robolectric.buildActivity(Activity::class.java).setup().get() + SessionPrefs.setGpuDriverMode(activity, SessionPrefs.GPU_DRIVERS_MIX) + SessionPrefs.setAndroidDriver(activity, "chosen-display") + SessionPrefs.setLinuxDriver(activity, "chosen-linux") + DriverMenus(activity, Handler(Looper.getMainLooper())).selectDriver(TurnipDriver.AUTO, linux = false) + assertEquals(SessionPrefs.GPU_DRIVERS_AUTO, SessionPrefs.gpuDriverMode(activity)) + assertEquals(TurnipDriver.AUTO, SessionPrefs.androidDriver(activity)) + assertEquals("chosen-linux", SessionPrefs.linuxDriver(activity)) + } + @Test fun selectingAutoUsesTheQuestPairWithoutStartingADownload() { val activity = Robolectric.buildActivity(Activity::class.java).setup().get() SessionPrefs.setGpuDriverMode(activity, SessionPrefs.GPU_DRIVERS_MANUAL) diff --git a/app/src/test/java/com/droiddeck/launcher/ProtonMenuAutoTest.kt b/app/src/test/java/com/droiddeck/launcher/ProtonMenuAutoTest.kt index 7aff486917..14dbdb8338 100644 --- a/app/src/test/java/com/droiddeck/launcher/ProtonMenuAutoTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/ProtonMenuAutoTest.kt @@ -83,7 +83,9 @@ class ProtonMenuAutoTest { private fun install(name: String): File = File(root, "root/.local/share/Steam/compatibilitytools.d/$name").apply { mkdirs() - File(this, "toolmanifest.vdf").writeText("manifest") + File(this, "toolmanifest.vdf").writeText("\"manifest\" { \"commandline\" \"/proton %verb%\" }") + File(this, "compatibilitytool.vdf").writeText("\"from_oslist\" \"windows\"") + File(this, "proton").apply { writeText(""); setExecutable(true) } } private fun waitUntil(done: () -> Boolean) { diff --git a/app/src/test/java/com/droiddeck/launcher/frontend/LibraryShortcutsLastPlayedTest.kt b/app/src/test/java/com/droiddeck/launcher/frontend/LibraryShortcutsLastPlayedTest.kt index cc9a1ac7df..baacb804e3 100644 --- a/app/src/test/java/com/droiddeck/launcher/frontend/LibraryShortcutsLastPlayedTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/frontend/LibraryShortcutsLastPlayedTest.kt @@ -45,6 +45,30 @@ class LibraryShortcutsLastPlayedTest { assertEquals(mapOf(3388195926L to 1792931476L, 1234L to 1700000000L), Library.shortcutsLastPlayed(root)) } + @Test fun aLaunchedAddedGameRemembersItsPlayTime() { + val context = org.robolectric.RuntimeEnvironment.getApplication() + val added = Library.SteamGame(-1, "World of Warcraft", null, Library.ADDED, gameId = 0xC0FFEE0002000000uL.toLong()) + val steam = Library.SteamGame(570, "Dota 2", null, "/steam") + assertEquals(0L, Library.recordedPlay(context, added.gameId)) + val before = System.currentTimeMillis() / 1000 + Library.recordPlayed(context, added) + Library.recordPlayed(context, steam) + assert(Library.recordedPlay(context, added.gameId) >= before) + assertEquals(0L, Library.recordedPlay(context, steam.gameId)) + } + + @Test fun anAddedGameBuiltAgainKeepsItsRecordedPlayTime() { + val context = org.robolectric.RuntimeEnvironment.getApplication() + val dir = tmp.newFolder("Celeste") + val exe = File(dir, "Celeste.exe").apply { writeText("x") } + val g = AddedGames.Game(dir, "Celeste", exe, "/g/Celeste.exe", "/g", 0x82000003L, 0x82000003L, emptyList()) + val shown = Library.addedGame(context, g, emptyList()) + assertEquals(0L, shown.lastPlayed) + Library.recordPlayed(context, shown) + assertEquals(Library.recordedPlay(context, g.gameId), Library.addedGame(context, g, emptyList()).lastPlayed) + assertEquals(1900000000L, Library.addedGame(context, g, emptyList(), lastPlayed = 1900000000L).lastPlayed) + } + @Test fun missingOrBrokenShortcutsGiveNothing() { val root = steamRoot() assertEquals(emptyMap(), Library.shortcutsLastPlayed(root)) diff --git a/app/src/test/java/com/droiddeck/launcher/gpu/DriverBundleTest.kt b/app/src/test/java/com/droiddeck/launcher/gpu/DriverBundleTest.kt index b9c0ce819b..24d47f60e4 100644 --- a/app/src/test/java/com/droiddeck/launcher/gpu/DriverBundleTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/gpu/DriverBundleTest.kt @@ -101,6 +101,33 @@ class DriverBundleTest { assertTrue(DriverBundle.all(context).isEmpty()) } + @Test fun aDisplayPickedAwayFromABundleTakesItsRuntimeHalfWithIt() { + val b = DriverBundle.install(context, bundle()) + DriverBundle.select(context, b) + DriverBundle.selectDisplay(context, TurnipDriver.AUTO) + assertEquals(TurnipDriver.AUTO, SessionPrefs.androidDriver(context)) + assertEquals("", SessionPrefs.linuxDriver(context)) + assertNull(DriverBundle.active(context)) + + DriverBundle.select(context, b) + DriverBundle.selectDisplay(context, "turnip25.1.0") + assertEquals("turnip25.1.0", SessionPrefs.androidDriver(context)) + assertEquals("", SessionPrefs.linuxDriver(context)) + } + + @Test fun aDisplayPickOutsideABundleKeepsTheChosenRuntime() { + SessionPrefs.setLinuxDriver(context, "my-linux-driver") + SessionPrefs.setAndroidDriver(context, "turnip25.1.0") + DriverBundle.selectDisplay(context, TurnipDriver.AUTO) + assertEquals(TurnipDriver.AUTO, SessionPrefs.androidDriver(context)) + assertEquals("my-linux-driver", SessionPrefs.linuxDriver(context)) + + val b = DriverBundle.install(context, bundle()) + DriverBundle.select(context, b) + DriverBundle.selectDisplay(context, b.androidId) + assertEquals(b.linuxId, SessionPrefs.linuxDriver(context)) + } + @Test fun aRefusedHalfLeavesNothingInstalled() { try { DriverBundle.install(context, bundle(linuxLibc = "libc.so")) diff --git a/app/src/test/java/com/droiddeck/launcher/gpu/SystemVulkanPruneAbsentRuntimeTest.kt b/app/src/test/java/com/droiddeck/launcher/gpu/SystemVulkanPruneAbsentRuntimeTest.kt new file mode 100644 index 0000000000..8a740f1681 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/gpu/SystemVulkanPruneAbsentRuntimeTest.kt @@ -0,0 +1,26 @@ +package com.droiddeck.launcher.gpu + +import android.content.Context +import java.io.File +import org.junit.Assert.assertTrue +import org.junit.Test +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment +import org.robolectric.annotation.Config + +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [28], manifest = Config.NONE) +class SystemVulkanPruneAbsentRuntimeTest { + @Test fun pruningWithoutTheRuntimeDoesNotThrowAndLeavesFilesAlone() { + val context: Context = RuntimeEnvironment.getApplication() + val base = File(context.filesDir, "system_vulkan").apply { mkdirs() } + val stage = File(base, ".stage-" + java.util.UUID.randomUUID()).apply { mkdir() } + val version = File(base, "a".repeat(64)).apply { mkdir() } + + SystemVulkanDriver.pruneUnused(context, true) + + assertTrue(stage.exists()) + assertTrue(version.exists()) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/input/BottomScreenGuestsTest.kt b/app/src/test/java/com/droiddeck/launcher/input/BottomScreenGuestsTest.kt index d9c959dae9..3bc8e76afa 100644 --- a/app/src/test/java/com/droiddeck/launcher/input/BottomScreenGuestsTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/input/BottomScreenGuestsTest.kt @@ -48,6 +48,17 @@ class BottomScreenGuestsTest { assertEquals(null, BottomScreenGuests.holder(null, null, homes)) } + @Test fun anAppThatArrivedBeforeDroidDeckCoveredTheScreenAgainNoLongerHoldsIt() { + assertFalse(BottomScreenGuests.current(arrivedAt = 1_000, ownShownAt = 2_000)) + assertTrue(BottomScreenGuests.current(arrivedAt = 3_000, ownShownAt = 2_000)) + assertTrue(BottomScreenGuests.current(arrivedAt = 2_000, ownShownAt = 2_000)) + assertTrue(BottomScreenGuests.current(arrivedAt = 1_000, ownShownAt = null)) + fun holder(arrivedAt: Long, ownShownAt: Long) = BottomScreenGuests.holder(null, + "com.android.chrome".takeIf { BottomScreenGuests.current(arrivedAt, ownShownAt) }, homes) + assertEquals(null, holder(arrivedAt = 1_000, ownShownAt = 2_000)) + assertEquals("com.android.chrome", holder(arrivedAt = 3_000, ownShownAt = 2_000)) + } + @Test fun keyboardsAndOverlaysNeverTakeTheScreen() { assertTrue(BottomScreenGuests.ignorable(AccessibilityWindowInfo.TYPE_INPUT_METHOD)) assertTrue(BottomScreenGuests.ignorable(AccessibilityWindowInfo.TYPE_ACCESSIBILITY_OVERLAY)) diff --git a/app/src/test/java/com/droiddeck/launcher/input/DirectTouchHoldTest.kt b/app/src/test/java/com/droiddeck/launcher/input/DirectTouchHoldTest.kt index 9ef44f3607..20c7fe451f 100644 --- a/app/src/test/java/com/droiddeck/launcher/input/DirectTouchHoldTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/input/DirectTouchHoldTest.kt @@ -141,6 +141,26 @@ class DirectTouchHoldTest { assertEquals(listOf("true at 40.0,30.0", "false at 40.0,30.0"), buttons) } + @Test fun cancelTouchEndsALiveTouchAndKeepsAHeldButton() { + touch(MotionEvent.ACTION_DOWN) + touch(MotionEvent.ACTION_MOVE, 60f) + hold.cancelTouch() + assertEquals(listOf("down 0 at 40.0,30.0", "move 0 at 60.0,30.0", "cancel"), touches) + assertTrue(buttons.isEmpty()) + + touches.clear() + hold.configure(TouchGestureConfig(longPressDelay = 500, + directHoldBehavior = TouchGestureConfig.MOUSE_BEHAVIOR_HOLD)) + touch(MotionEvent.ACTION_DOWN) + advance(500) + hold.cancelTouch() + advance(1000) + assertEquals(listOf("true at 40.0,30.0"), buttons) + assertTrue(touches.isEmpty()) + touch(MotionEvent.ACTION_UP) + assertEquals(listOf("true at 40.0,30.0", "false at 40.0,30.0"), buttons) + } + @Test fun cancelForwardsACancelWhenTheTouchIsLive() { touch(MotionEvent.ACTION_DOWN) touch(MotionEvent.ACTION_MOVE, 60f) diff --git a/app/src/test/java/com/droiddeck/launcher/input/GesturePrefsTest.kt b/app/src/test/java/com/droiddeck/launcher/input/GesturePrefsTest.kt index 9f03811123..a00594f781 100644 --- a/app/src/test/java/com/droiddeck/launcher/input/GesturePrefsTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/input/GesturePrefsTest.kt @@ -17,6 +17,19 @@ class GesturePrefsTest { assertEquals(TouchGestureConfig.RELATIVE_MOUSE_AUTO, TouchGestureConfig.fromJson("{}").relativeMouseMode) } + @Test fun autoNeverGoesRelativeForDirectTouchWithoutAMouse() { + val auto = TouchGestureConfig.RELATIVE_MOUSE_AUTO + assertEquals(TouchGestureConfig.RELATIVE_MOUSE_OFF, TouchGestureConfig.gamescopeRelativeMouse(auto, mouseAttached = false, touchpad = false)) + assertEquals(auto, TouchGestureConfig.gamescopeRelativeMouse(auto, mouseAttached = true, touchpad = false)) + assertEquals(auto, TouchGestureConfig.gamescopeRelativeMouse(auto, mouseAttached = false, touchpad = true)) + } + + @Test fun aChosenRelativeMouseModeIsSentAsIs() { + for (mode in listOf(TouchGestureConfig.RELATIVE_MOUSE_ON, TouchGestureConfig.RELATIVE_MOUSE_OFF)) + for (mouse in listOf(false, true)) for (pad in listOf(false, true)) + assertEquals(mode, TouchGestureConfig.gamescopeRelativeMouse(mode, mouse, pad)) + } + @Test fun removedOptionsAreIgnoredWhenLoadingExistingSettings() { val old = """{"holdMouseButtonWhileTouchingEnabled":true,"holdMouseButtonWhileTouchingAction":"right_click", "showClickHighlight":true,"showCursorInTouchscreenMode":true,"tapAction":"key_E","longPressDelay":650}""" diff --git a/app/src/test/java/com/droiddeck/launcher/input/MouseBackInputTest.kt b/app/src/test/java/com/droiddeck/launcher/input/MouseBackInputTest.kt index 625f93e7cf..ba7e666c6c 100644 --- a/app/src/test/java/com/droiddeck/launcher/input/MouseBackInputTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/input/MouseBackInputTest.kt @@ -8,6 +8,7 @@ import org.junit.Test import org.junit.runner.RunWith import org.robolectric.RobolectricTestRunner import org.robolectric.annotation.Config +import org.robolectric.shadows.InputDeviceBuilder @RunWith(RobolectricTestRunner::class) @Config(sdk = [34], manifest = Config.NONE) @@ -151,4 +152,47 @@ class MouseBackInputTest { assertFalse(input.onKeyEvent(key(KeyEvent.ACTION_UP), toGuest = true)) assertTrue(presses.isEmpty()) } + + private fun device(name: String, sources: Int, external: Boolean = true, virtual: Boolean = false) = + InputDeviceBuilder.newBuilder().setId(if (virtual) -1 else 11).setName(name).setDescriptor(name) + .setExternal(external).setSources(sources).build() + + @Test fun anExternalMouseCounts() { + assertTrue(MouseBackInput.isExternalMouse(device("USB mouse", InputDevice.SOURCE_MOUSE))) + assertTrue(MouseBackInput.isExternalMouse(device("Bluetooth mouse", InputDevice.SOURCE_MOUSE_RELATIVE))) + } + + @Test fun theLoggedControllerDeviceDoesNotCountAsAnExternalMouse() { + val odinController = device("Odin Controller", 0x1000511) + assertTrue(PadBridge.isFromController(odinController)) + assertFalse(MouseBackInput.isExternalMouse(odinController)) + } + + @Test fun virtualTouchpadTouchscreenUinputAndNonMouseDevicesDoNotCount() { + assertFalse(MouseBackInput.isExternalMouse(device("virtual mouse", InputDevice.SOURCE_MOUSE, virtual = true))) + assertFalse(MouseBackInput.isExternalMouse(device("touchpad", InputDevice.SOURCE_MOUSE or InputDevice.SOURCE_TOUCHPAD))) + assertFalse(MouseBackInput.isExternalMouse(device("touchscreen", InputDevice.SOURCE_MOUSE or InputDevice.SOURCE_TOUCHSCREEN))) + assertFalse(MouseBackInput.isExternalMouse(device("uinput-mouse", InputDevice.SOURCE_MOUSE))) + assertFalse(MouseBackInput.isExternalMouse(device("gamepad", InputDevice.SOURCE_GAMEPAD))) + assertFalse(MouseBackInput.isExternalMouse(null)) + } + + @Test fun aMouseThatNamesItselfVirtualDoesNotCount() { + assertFalse(MouseBackInput.isExternalMouse(device("ODIN Station Virtual Mouse", 0x20004))) + assertFalse(MouseBackInput.isExternalMouse(device("VIRTUAL pointer", InputDevice.SOURCE_MOUSE))) + assertTrue(MouseBackInput.isExternalMouse(device("Virtuality Pro Mouse", InputDevice.SOURCE_MOUSE))) + assertTrue(MouseBackInput.isExternalMouse(device("Logitech MX Master 3", InputDevice.SOURCE_MOUSE))) + } + + @Test fun injectedBackIsLeftAloneWithoutAnExternalMouse() { + val odinController = device("Odin Controller", 0x1000511) + val controllerOnly = MouseBackInput(presses::add) { MouseBackInput.isExternalMouse(odinController) } + assertFalse(controllerOnly.onKeyEvent(injected(KeyEvent.ACTION_DOWN), toGuest = true)) + assertTrue(presses.isEmpty()) + val external = MouseBackInput(presses::add) { + MouseBackInput.isExternalMouse(device("USB mouse", InputDevice.SOURCE_MOUSE)) + } + assertTrue(external.onKeyEvent(injected(KeyEvent.ACTION_DOWN), toGuest = true)) + assertEquals(listOf(true), presses) + } } diff --git a/app/src/test/java/com/droiddeck/launcher/input/OnScreenControlsTest.kt b/app/src/test/java/com/droiddeck/launcher/input/OnScreenControlsTest.kt index 1aa7c9e20f..2c9745693e 100644 --- a/app/src/test/java/com/droiddeck/launcher/input/OnScreenControlsTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/input/OnScreenControlsTest.kt @@ -205,6 +205,28 @@ class OnScreenControlsTest { assertFalse(view.isQuickHidden) } + @Test fun hidingTheGamepadKeepsAlwaysShownKeysDrawnAndTouchable() { + val key = InputSurfaceElement(InputControl.A, .45f, .1f, .1f, .1f, "imported:0", name = "Find", alwaysShown = true) + view.updateLayout(SavedInputLayout("test", "Test", listOf(left, button, key), aspect = ASPECT)) + measure(view) + assertTrue(view.hasPinned) + view.setPinnedOnly(true) + measure(view) + assertTrue(view.takesTouchAt(500f, 90f)) + assertFalse(view.takesTouchAt(800f, 250f)) + assertFalse(view.takesTouchAt(200f, 300f)) + view.setPinnedOnly(false) + measure(view) + assertTrue(view.takesTouchAt(800f, 250f)) + assertTrue(view.takesTouchAt(500f, 90f)) + view.setQuickHidden(true) + measure(view) + assertTrue(view.takesTouchAt(500f, 90f)) + assertFalse(view.takesTouchAt(800f, 250f)) + view.updateLayout(SavedInputLayout("test", "Test", listOf(left, button), aspect = ASPECT)) + assertFalse(view.hasPinned) + } + private companion object { const val ASPECT = 1000f / 600f } private fun touch(action: Int, vararg pointers: Pair>, flags: Int = 0): Boolean { diff --git a/app/src/test/java/com/droiddeck/launcher/input/OnScreenLayoutTest.kt b/app/src/test/java/com/droiddeck/launcher/input/OnScreenLayoutTest.kt index 8c137fbf2a..0a95382937 100644 --- a/app/src/test/java/com/droiddeck/launcher/input/OnScreenLayoutTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/input/OnScreenLayoutTest.kt @@ -19,7 +19,7 @@ class OnScreenLayoutTest { private val density get() = context.resources.displayMetrics.density @Before fun reset() { - for (name in listOf("input-profiles", "input-surfaces", "controller")) context.getSharedPreferences(name, Context.MODE_PRIVATE).edit().clear().commit() + for (name in listOf("input-profiles", "input-surfaces", "controller", "session")) context.getSharedPreferences(name, Context.MODE_PRIVATE).edit().clear().commit() } private fun gamepad() = InputLibraries.read(context).layouts.first { it.id == InputLibraries.OVERLAY } @@ -188,4 +188,105 @@ class OnScreenLayoutTest { val selected = old.selectProfile(false, "migrated.screenkeys.0").selectProfile(true, "migrated.screenkeys.0") assertEquals(selected, LegacyScreenKeyMigration.merge(selected, shown)) } + + @Test fun alwaysShownKeysStayInButtonsOnlyModeAndLeaveTheUnfoldedStrip() { + val key = InputSurfaceElement(InputControl.A, .45f, .1f, .1f, .1f, "imported:0", name = "Find", alwaysShown = true) + val plain = InputSurfaceElement(InputControl.A, .45f, .4f, .1f, .1f, "imported:1", name = "Jump") + val layout = gamepad().let { it.copy(elements = it.elements + key + plain) } + val buttons = OnScreenLayout.elements(context, layout, 1000, 500, Rect(), buttonsOnly = true) + assertTrue(buttons.any { it.id == key.id }) + assertFalse(buttons.any { it.id == plain.id }) + assertEquals(OnScreenLayout.elements(context, gamepad(), 1000, 500, Rect(), buttonsOnly = true), buttons.filterNot { it.id == key.id }) + val strip = OnScreenLayout.elements(context, layout, 2208, 800, Rect(), dock = OnScreenLayout.Dock(false, grips = false)) + assertFalse(strip.any { it.id == key.id }) + assertTrue(strip.any { it.id == plain.id }) + assertTrue(OnScreenLayout.elements(context, layout, 1000, 500, Rect()).map { it.id }.containsAll(listOf(key.id, plain.id))) + } + + @Test fun migratedScreenKeysAreAlwaysShownButOtherElementsAreNot() { + prefs.edit().clear().commit() + ControllerPrefs.prefs(context).edit().putString("screenKeys", legacyKeys).commit() + val migrated = InputLibraries.read(context) + assertTrue(importedOn(migrated).all { it.alwaysShown }) + assertTrue(migrated.layouts.first { it.id == "migrated.screenkeys.0.layout" }.elements.all { it.alwaysShown }) + assertTrue(migrated.layouts.flatMap { it.elements }.filterNot { it.id.startsWith("imported:") }.none { it.alwaysShown }) + assertFalse(LegacyScreenKeyMigration.convert(context, legacyKeys, 1000, 500, 2f).any { it.first.alwaysShown }) + } + + @Test fun keysMergedByAnEarlierVersionBecomeAlwaysShownOnUpgrade() { + val fresh = InputLibraries.read(context) + val backup = JSONObject().put("screenKeys", legacyKeys).toString() + val unpinned = LegacyScreenKeyMigration.merge(LegacyScreenKeyMigration.migrate(context, fresh, backup), backup).let { library -> + library.copy(layouts = library.layouts.map { l -> l.copy(elements = l.elements.map { it.copy(alwaysShown = false) }) }) + } + val other = SavedInputLayout("user.keys", "Mine", listOf(InputSurfaceElement(InputControl.A, .1f, .1f, .1f, .1f, "imported:0", name = "Other"))) + val stored = unpinned.withLayout(other) + prefs.edit().putString("library", JSONObject(InputLibraries.encode(stored)).put("version", 12).toString()) + .putString(LegacyScreenKeyMigration.BACKUP, backup).putBoolean(LegacyScreenKeyMigration.MERGED, true).commit() + val upgraded = InputLibraries.read(context) + assertEquals(1, importedOn(upgraded).size) + assertTrue(importedOn(upgraded).single().alwaysShown) + assertTrue(upgraded.layouts.first { it.id == "migrated.screenkeys.0.layout" }.elements.all { it.alwaysShown }) + assertFalse(upgraded.layouts.first { it.id == "user.keys" }.elements.single().alwaysShown) + assertEquals(stored.layouts.map { l -> l.elements.map { it.copy(alwaysShown = false) } }, upgraded.layouts.filter { l -> stored.layouts.any { it.id == l.id } } + .map { l -> l.elements.map { it.copy(alwaysShown = false) } }) + } + + @Test fun aDeckStripPutsTheDeckGamepadSurfacesInTheStickSlotsAndOtherPadsKeepSticks() { + val stock = InputStockLayouts.layouts().first { it.id == DeckPanel.GAMEPAD.layout } + val deck = OnScreenLayout.Dock.deck(false, stock) + assertEquals(OnScreenLayout.Dock(false, true, InputControl.LS, InputControl.RIGHT_PAD), deck) + assertEquals(deck, OnScreenLayout.Dock.deck(false, null)) + val (w, h) = 2208 to 800 + val boxes = GamepadGeometry.layout(w.toFloat(), h.toFloat(), density, false) + val placed = OnScreenLayout.elements(context, gamepad(), w, h, Rect(), dock = deck) + val pad = placed.single { it.control == InputControl.RIGHT_PAD } + assertEquals(InputElementKind.TRACKPAD, pad.kind) + assertEquals(boxes.getValue(GamepadGeometry.Slot.RIGHT_MAIN).left, pad.x * w, 1f) + assertNull(placed.firstOrNull { it.control == InputControl.RS }) + assertTrue(placed.any { it.control == InputControl.LS }) + val plain = OnScreenLayout.elements(context, gamepad(), w, h, Rect(), dock = OnScreenLayout.Dock(false, false)) + assertTrue(plain.any { it.control == InputControl.RS }) + assertNull(plain.firstOrNull { it.kind == InputElementKind.TRACKPAD }) + val swapped = stock.copy(elements = stock.elements.map { + when (it.control) { + InputControl.LS -> it.copy(control = InputControl.LEFT_PAD, id = "legacy:left-pad", kind = InputElementKind.TRACKPAD) + InputControl.RIGHT_PAD -> it.copy(control = InputControl.RS, id = "legacy:rs", kind = InputElementKind.STICK) + else -> it + } + }) + assertEquals(OnScreenLayout.Dock(false, true, InputControl.LEFT_PAD, InputControl.RS), OnScreenLayout.Dock.deck(false, swapped)) + } + + private fun deckGamepad(library: InputLibrary) = library.layouts.first { it.id == DeckPanel.GAMEPAD.layout } + + private fun upgradeWithSurfaces(left: String?, right: String?, change: (InputLibrary) -> InputLibrary = { it }): InputLibrary { + val stored = change(InputLibraries.read(context)) + context.getSharedPreferences("session", Context.MODE_PRIVATE).edit().putString("gamepadLeft", left).putString("gamepadRight", right).commit() + prefs.edit().putString("library", JSONObject(InputLibraries.encode(stored)).put("version", 13).toString()).commit() + return InputLibraries.read(context) + } + + @Test fun theSavedDeckGamepadStickOrTrackpadChoiceMovesIntoTheUntouchedDeckGamepadOnce() { + val upgraded = upgradeWithSurfaces("trackpad", "stick") + val elements = deckGamepad(upgraded).elements + assertEquals(InputStockLayouts.gamepad(leftPad = true, rightStick = true), elements) + assertEquals(InputElementKind.TRACKPAD, elements.single { it.control == InputControl.LEFT_PAD }.kind) + assertEquals(InputElementKind.STICK, elements.single { it.control == InputControl.RS }.kind) + assertNull(elements.firstOrNull { it.control == InputControl.LS || it.control == InputControl.RIGHT_PAD }) + assertEquals(OnScreenLayout.Dock(false, true, InputControl.LEFT_PAD, InputControl.RS), OnScreenLayout.Dock.deck(false, deckGamepad(upgraded))) + assertEquals(upgraded, InputLibraries.read(context)) + } + + @Test fun theDefaultDeckGamepadChoiceOrAnEditedDeckGamepadIsLeftAlone() { + val stock = InputStockLayouts.layouts().first { it.id == DeckPanel.GAMEPAD.layout } + assertEquals(stock.elements, deckGamepad(upgradeWithSurfaces(null, null)).elements) + assertEquals(stock.elements, deckGamepad(upgradeWithSurfaces("stick", "trackpad")).elements) + val moved = stock.elements.map { if (it.control == InputControl.A) it.copy(x = .7f) else it } + val edited = upgradeWithSurfaces("trackpad", "stick") { it.withLayout(deckGamepad(it).copy(elements = moved)) } + assertEquals(moved, deckGamepad(edited).elements) + val others = InputLibraries.read(context).layouts.filter { it.id != DeckPanel.GAMEPAD.layout } + assertEquals(InputStockLayouts.layouts().filter { it.id != DeckPanel.GAMEPAD.layout }.map { it.elements }, + others.filter { l -> InputStockLayouts.layouts().any { it.id == l.id } }.map { it.elements }) + } } diff --git a/app/src/test/java/com/droiddeck/launcher/input/SecondScreenModeTest.kt b/app/src/test/java/com/droiddeck/launcher/input/SecondScreenModeTest.kt index 3da439ee5c..9956f1aa6d 100644 --- a/app/src/test/java/com/droiddeck/launcher/input/SecondScreenModeTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/input/SecondScreenModeTest.kt @@ -64,4 +64,13 @@ class SecondScreenModeTest { assertEquals(SecondScreenMode.TERMINAL, SecondScreenMode.opening("terminal", deckPad, dashboard, desktopSession = true)) } } + + @Test fun theEditorOpensOnTheChosenBottomScreenUnlessAnotherAppHoldsIt() { + val free = { _: Int -> false } + assertEquals(listOf(2, 3), SecondScreenDisplays.editorCandidates(2, listOf(2, 3), free)) + assertEquals(listOf(3, 2), SecondScreenDisplays.editorCandidates(3, listOf(2, 3), free)) + assertEquals(listOf(-1, 2), SecondScreenDisplays.editorCandidates(-1, listOf(2), free)) + assertEquals(listOf(3), SecondScreenDisplays.editorCandidates(2, listOf(2, 3)) { it == 2 }) + assertEquals(emptyList(), SecondScreenDisplays.editorCandidates(2, listOf(2)) { it == 2 }) + } } diff --git a/app/src/test/java/com/droiddeck/launcher/input/TouchRouterTest.kt b/app/src/test/java/com/droiddeck/launcher/input/TouchRouterTest.kt new file mode 100644 index 0000000000..38b270e090 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/input/TouchRouterTest.kt @@ -0,0 +1,23 @@ +package com.droiddeck.launcher.input + +import com.droiddeck.launcher.session.SessionPrefs +import org.junit.Assert.assertEquals +import org.junit.Test + +class TouchRouterTest { + @Test fun gesturesAndOffAreNotTouchpadRoutes() { + for (mode in listOf(SessionPrefs.TOUCH_GESTURES, SessionPrefs.TOUCH_OFF)) { + assertEquals(TouchRouter.Route.GESTURES.takeIf { mode == SessionPrefs.TOUCH_GESTURES } ?: TouchRouter.Route.OFF, + TouchRouter.decide(TouchRouter.Snapshot(false, mode, false, false, false))) + assertEquals(TouchRouter.Route.GESTURES.takeIf { mode == SessionPrefs.TOUCH_GESTURES } ?: TouchRouter.Route.OFF, + TouchRouter.decide(TouchRouter.Snapshot(false, mode, false, true, true))) + } + } + + @Test fun autoUsesTouchpadOnlyWhenRouterSelectsTouchpad() { + assertEquals(TouchRouter.Route.TOUCHPAD, + TouchRouter.decide(TouchRouter.Snapshot(false, SessionPrefs.TOUCH_AUTO, false, false, false))) + assertEquals(TouchRouter.Route.DIRECT, + TouchRouter.decide(TouchRouter.Snapshot(false, SessionPrefs.TOUCH_AUTO, false, true, false))) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/lab/LabOverlayTest.kt b/app/src/test/java/com/droiddeck/launcher/lab/LabOverlayTest.kt new file mode 100644 index 0000000000..ee60999fbc --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/lab/LabOverlayTest.kt @@ -0,0 +1,154 @@ +package com.droiddeck.launcher.lab + +import android.app.Application +import com.droiddeck.launcher.BuildConfig +import org.junit.After +import org.junit.Assert.assertEquals +import org.junit.Assert.assertFalse +import org.junit.Assert.assertNotNull +import org.junit.Assert.assertNull +import org.junit.Assert.assertTrue +import org.junit.Before +import org.junit.Test +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import org.robolectric.RuntimeEnvironment +import org.robolectric.annotation.Config +import java.io.File + +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [33], manifest = Config.NONE) +class LabOverlayTest { + private lateinit var app: Application + private lateinit var root: File + private val injected = mutableListOf() + private val originalInject = LabOverlay.injectDex + private val originalResources = LabOverlay.openResources + + @Before fun prepare() { + app = RuntimeEnvironment.getApplication() + app.applicationInfo.sourceDir = "/data/app/~~test==/com.droiddeck.launcher-test==/base.apk" + root = LabOverlay.root(app).apply { deleteRecursively(); mkdirs() } + LabOverlay.injectDex = { _, apk -> injected += apk } + LabOverlay.openResources = { null } + } + + @After fun restore() { + LabOverlay.injectDex = originalInject + LabOverlay.openResources = originalResources + root.deleteRecursively() + } + + private fun stage(dir: String, commit: String = BuildConfig.SOURCE_COMMIT, apk: String = app.applicationInfo.sourceDir) = + File(root, dir).apply { + mkdirs() + File(this, "overlay.apk").writeText("dex") + File(this, "overlay.json").writeText("""{"label":"feat/x @ abc1234","baseCommit":"$commit","baseApk":"$apk"}""") + } + + @Test fun aBuildForThisInstallIsLoaded() { + stage("active") + LabOverlay.load(app, mainProcess = true) + assertEquals("feat/x @ abc1234", LabOverlay.active?.label) + assertEquals(listOf(File(root, "active/overlay.apk")), injected) + assertEquals(1, LabOverlay.failedStarts(root)) + } + + @Test fun aStagedBuildIsPromotedAtStart() { + stage("next") + File(root, "starts").writeText("2") + LabOverlay.load(app, mainProcess = true) + assertFalse(File(root, "next").exists()) + assertNotNull(LabOverlay.active) + assertEquals(1, LabOverlay.failedStarts(root)) + } + + @Test fun aBuildForAnotherInstallIsTurnedOff() { + stage("active", commit = "0000000") + LabOverlay.load(app, mainProcess = true) + assertNull(LabOverlay.active) + assertTrue(injected.isEmpty()) + assertFalse(File(root, "active").exists()) + assertEquals("OTHER_INSTALL", File(root, "last-off-reason").readText()) + } + + @Test fun aBuildForAnEarlierInstallOfTheSameCommitIsTurnedOff() { + stage("active", apk = "/data/app/old/base.apk") + LabOverlay.load(app, mainProcess = true) + assertNull(LabOverlay.active) + assertEquals("OTHER_INSTALL", File(root, "last-off-reason").readText()) + } + + @Test fun aBuildThatKeepsFailingToStartIsTurnedOff() { + stage("active") + File(root, "starts").writeText("2") + LabOverlay.load(app, mainProcess = true) + assertNull(LabOverlay.active) + assertEquals("DID_NOT_START", File(root, "last-off-reason").readText()) + } + + @Test fun otherProcessesLoadWithoutCountingStarts() { + stage("active") + LabOverlay.load(app, mainProcess = false) + assertNotNull(LabOverlay.active) + assertEquals(0, LabOverlay.failedStarts(root)) + } + + @Test fun noBuildMeansNothingIsLoaded() { + LabOverlay.load(app, mainProcess = true) + assertNull(LabOverlay.active) + assertTrue(injected.isEmpty()) + assertFalse(LabOverlay.promoted) + } + + @Test fun aNewBuildKeepsTheOneItReplaces() { + stage("active") + stage("next") + LabOverlay.load(app, mainProcess = true) + assertTrue(LabOverlay.promoted) + val saved = LabOverlay.saved(app).single() + assertEquals(LabOverlay.Reason.REPLACED, saved.reason) + assertTrue(saved.usable) + } + + @Test fun aRefusedBuildIsKeptButNotUsable() { + stage("active", commit = "0000000") + LabOverlay.load(app, mainProcess = true) + val saved = LabOverlay.saved(app).single() + assertEquals(LabOverlay.Reason.OTHER_INSTALL, saved.reason) + assertFalse(saved.usable) + } + + @Test fun aKeptBuildCanBeStagedAgain() { + stage("active", commit = "0000000") + LabOverlay.load(app, mainProcess = true) + stage("active") + LabOverlay.archive(root, File(root, "active"), LabOverlay.Reason.TURNED_OFF) + val usable = LabOverlay.saved(app).first { it.usable } + LabOverlay.stage(app, usable) + assertNotNull(LabOverlay.pending(app)) + assertEquals(1, LabOverlay.saved(app).size) + LabOverlay.load(app, mainProcess = true) + assertTrue(LabOverlay.promoted) + assertNotNull(LabOverlay.active) + } + + @Test fun stagingAKeptBuildKeepsTheOneThatWasWaiting() { + stage("builds/1") + stage("next") + File(root, "next/overlay.json").writeText("""{"label":"feat/y @ def5678","baseCommit":"${BuildConfig.SOURCE_COMMIT}","baseApk":"${app.applicationInfo.sourceDir}"}""") + LabOverlay.stage(app, LabOverlay.saved(app).single()) + assertEquals("feat/x @ abc1234", LabOverlay.pending(app)?.label) + val kept = LabOverlay.saved(app).single() + assertEquals("feat/y @ def5678", kept.info?.label) + assertEquals(LabOverlay.Reason.REPLACED, kept.reason) + } + + @Test fun onlyTheNewestBuildsAreKept() { + repeat(15) { + stage("active") + LabOverlay.archive(root, File(root, "active"), LabOverlay.Reason.TURNED_OFF) + } + assertEquals(12, LabOverlay.saved(app).size) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/runtime/BwrapSpawnerTest.kt b/app/src/test/java/com/droiddeck/launcher/runtime/BwrapSpawnerTest.kt index a71063bf35..23db657ed5 100644 --- a/app/src/test/java/com/droiddeck/launcher/runtime/BwrapSpawnerTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/runtime/BwrapSpawnerTest.kt @@ -55,6 +55,26 @@ class BwrapSpawnerTest { assertTrue(Bind("/rootfs/etc/droiddeck/proc/stat", "/newproc/stat") in binds) } + @Test fun theSessionsRootfsSettingsStayOutOfTheSandbox() { + val rootfs = "/data/app/linuxfs" + val env = mutableMapOf( + "DDNATV_ROOT" to rootfs, "DDNATV_BINDS" to "/dev:/dev", "HOME" to "/root", + "SPA_PLUGIN_DIR" to "/usr/local/lib/droiddeck-pipewire/lib/spa-0.2", + "LD_PRELOAD" to "/run/droiddeck-preload/libblsession.so:$rootfs/usr/local/lib/libblsession.so:$rootfs/usr/lib/libddnatv-hook.so", + ) + BwrapSpawner.withoutRootfsSettings(env, rootfs) + assertEquals(mapOf("HOME" to "/root", "LD_PRELOAD" to "/run/droiddeck-preload/libblsession.so"), env) + val onlySession = mutableMapOf("LD_PRELOAD" to "$rootfs/usr/lib/libddnatv-hook.so") + BwrapSpawner.withoutRootfsSettings(onlySession, rootfs) + assertTrue(onlySession.isEmpty()) + val wayland = mutableMapOf("SDL_VIDEODRIVER" to "x11", "WAYLAND_DISPLAY" to "wayland-0") + BwrapSpawner.withoutRootfsSettings(wayland, rootfs) + assertEquals(mapOf("WAYLAND_DISPLAY" to "wayland-0"), wayland) + val x11 = mutableMapOf("SDL_VIDEODRIVER" to "x11", "WAYLAND_DISPLAY" to "wayland-0", "DISPLAY" to ":99") + BwrapSpawner.withoutRootfsSettings(x11, rootfs) + assertEquals("x11", x11["SDL_VIDEODRIVER"]) + } + @Test fun normalizeResolvesDotsLexically() { assertEquals("/usr/lib/x", BwrapSpawner.normalize("/usr/lib/GL/../x")) assertEquals("/", BwrapSpawner.normalize("/../..")) diff --git a/app/src/test/java/com/droiddeck/launcher/runtime/ElfSeccompPatchTest.kt b/app/src/test/java/com/droiddeck/launcher/runtime/ElfSeccompPatchTest.kt new file mode 100644 index 0000000000..386017d154 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/runtime/ElfSeccompPatchTest.kt @@ -0,0 +1,53 @@ +package com.droiddeck.launcher.runtime + +import java.nio.ByteBuffer +import java.nio.ByteOrder +import org.junit.Assert.assertEquals +import org.junit.Test + +class ElfSeccompPatchTest { + private fun elfWith(vararg words: Int): ByteArray { + val data = ByteArray(0x200) + val b = ByteBuffer.wrap(data).order(ByteOrder.LITTLE_ENDIAN) + b.put(0, 0x7f); b.put(1, 'E'.code.toByte()); b.put(2, 'L'.code.toByte()); b.put(3, 'F'.code.toByte()) + b.put(4, 2); b.put(5, 1) + b.putShort(18, 183) + b.putLong(32, 64) + b.putShort(54, 56); b.putShort(56, 1) + b.putInt(64, 1); b.putInt(68, 5) + b.putLong(72, 0x100); b.putLong(96, 0x100) + words.forEachIndexed { i, w -> b.putInt(0x100 + i * 4, w) } + return data + } + + @Test + fun theSvcAfterEachBlockedCallIsAnsweredInPlace() { + val svc = 0xd4000001.toInt() + val data = elfWith(0xd2800c68.toInt(), 0xaa0003e1.toInt(), svc, 0xd28024a8.toInt(), svc, 0xd2803668.toInt(), svc) + assertEquals(3, ElfSeccompPatch.patch(data)) + val b = ByteBuffer.wrap(data).order(ByteOrder.LITTLE_ENDIAN) + assertEquals(0xd503201f.toInt(), b.getInt(0x108)) + assertEquals(0x928004a0.toInt(), b.getInt(0x110)) + assertEquals(0x928004a0.toInt(), b.getInt(0x118)) + assertEquals(0, ElfSeccompPatch.patch(data)) + } + + @Test + fun aSecondRunLeavesTheNextCallAlone() { + val svc = 0xd4000001.toInt() + val exit = 0xd2800ba8.toInt() + for (blocked in listOf(0xd2803668.toInt(), 0xd2800c68.toInt())) { + val data = elfWith(blocked, svc, 0xaa1303e0.toInt(), exit, svc) + assertEquals(1, ElfSeccompPatch.patch(data)) + assertEquals(0, ElfSeccompPatch.patch(data)) + assertEquals(svc, ByteBuffer.wrap(data).order(ByteOrder.LITTLE_ENDIAN).getInt(0x110)) + } + } + + @Test + fun otherSystemCallsAreLeftAlone() { + val svc = 0xd4000001.toInt() + val data = elfWith(0xd2800ba8.toInt(), svc) + assertEquals(0, ElfSeccompPatch.patch(data)) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/runtime/LegacyNamesTest.kt b/app/src/test/java/com/droiddeck/launcher/runtime/LegacyNamesTest.kt index 82487c6a1e..a921259b16 100644 --- a/app/src/test/java/com/droiddeck/launcher/runtime/LegacyNamesTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/runtime/LegacyNamesTest.kt @@ -79,4 +79,18 @@ class LegacyNamesTest { assertEquals("Exec=/usr/local/bin/bannerlator-steam-launch\n", File(root, "usr/local/share/applications/firefox.desktop").readText()) } + + @Test fun catalogAppImageMenusStartThroughTheSharedLauncher() { + write("usr/share/applications/droiddeck-rpcs3.desktop", + "[Desktop Entry]\nName=RPCS3\nExec=env APPIMAGE_EXTRACT_AND_RUN=1 /opt/appimages/rpcs3.AppImage\nCategories=Emulator;\n") + write("usr/share/applications/droiddeck-steam-x64.desktop", "[Desktop Entry]\nExec=droiddeck-steam-x64\n") + write("usr/share/applications/other.desktop", "Exec=env APPIMAGE_EXTRACT_AND_RUN=1 /opt/appimages/other.AppImage\n") + LegacyNames.migrateRootfs(root) + LegacyNames.migrateRootfs(root) + assertEquals("[Desktop Entry]\nName=RPCS3\nExec=/usr/local/bin/droiddeck-appimage-exec /opt/appimages/rpcs3.AppImage\nCategories=Emulator;\n", + File(root, "usr/share/applications/droiddeck-rpcs3.desktop").readText()) + assertEquals("[Desktop Entry]\nExec=droiddeck-steam-x64\n", File(root, "usr/share/applications/droiddeck-steam-x64.desktop").readText()) + assertEquals("Exec=env APPIMAGE_EXTRACT_AND_RUN=1 /opt/appimages/other.AppImage\n", + File(root, "usr/share/applications/other.desktop").readText()) + } } diff --git a/app/src/test/java/com/droiddeck/launcher/runtime/LinuxFexTest.kt b/app/src/test/java/com/droiddeck/launcher/runtime/LinuxFexTest.kt index e63bbcef53..139eb330d8 100644 --- a/app/src/test/java/com/droiddeck/launcher/runtime/LinuxFexTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/runtime/LinuxFexTest.kt @@ -64,4 +64,36 @@ class LinuxFexTest { assertEquals("App-x86_64.AppImage", UserApps.pickAsset(listOf("App-x86_64.AppImage", "App-armhf.AppImage", "notes.txt"))) assertNull(UserApps.pickAsset(listOf("App-armhf.AppImage", "App-i686.AppImage"))) } + + @Test fun aLinkedAssetPicksTheSameVariantInEveryRelease() { + val link = "https://github.com/Djihads80/Eglantine/releases/download/build-129/eglantine-a407703f6d29a5ab73328b4ededb12cf29b2758d-linux-aarch64.AppImage" + val wanted = UserApps.githubAsset(link) + assertEquals("eglantine-a407703f6d29a5ab73328b4ededb12cf29b2758d-linux-aarch64.AppImage", wanted) + assertEquals("Djihads80/Eglantine", UserApps.githubRepo(link)) + val build = listOf("eglantine-a407703f6d29a5ab73328b4ededb12cf29b2758d-linux-aarch64-pgo.AppImage", + "eglantine-a407703f6d29a5ab73328b4ededb12cf29b2758d-linux-aarch64.AppImage") + assertEquals(build[1], UserApps.pickAsset(build, wanted)) + val daily = listOf("eglantine-linux-aarch64-pgo.AppImage", "eglantine-linux-aarch64.AppImage", "eglantine-linux-x86_64.AppImage") + assertEquals("eglantine-linux-aarch64.AppImage", UserApps.pickAsset(daily, wanted)) + assertEquals("eglantine-linux-aarch64-pgo.AppImage", UserApps.pickAsset(daily, "eglantine-0f3c2a91-linux-aarch64-pgo.AppImage")) + assertEquals("eglantine-linux-aarch64-pgo.AppImage", UserApps.pickAsset(daily, "Other-v2.1-x86_64.AppImage")) + assertEquals("eglantine-linux-aarch64-pgo.AppImage", UserApps.pickAsset(daily)) + } + + @Test fun onlyReleaseDownloadLinksNameAnAsset() { + assertNull(UserApps.githubAsset("https://github.com/Djihads80/Eglantine")) + assertNull(UserApps.githubAsset("Djihads80/Eglantine")) + assertNull(UserApps.githubAsset("https://github.com/o/r/releases/download/v1/notes.txt")) + assertEquals("My App-1.0-arm64.AppImage", UserApps.githubAsset("https://github.com/o/r/releases/download/v1.0/My%20App-1.0-arm64.AppImage")) + assertEquals("App-arm64.AppImage", UserApps.githubAsset("https://github.com/o/r/releases/latest/download/App-arm64.AppImage")) + assertEquals("o/r", UserApps.githubRepo("https://github.com/o/r/releases/latest/download/App-arm64.AppImage")) + assertNull(UserApps.githubAsset("https://github.com/o/r/releases/download/v1/bad%ZZ.AppImage")) + } + + @Test fun theLinkedArchitectureWidthIsKept() { + val release = listOf("App-2.0-x86-32.AppImage", "App-2.0-x86_64.AppImage", "App-2.0-i686.AppImage") + assertEquals("App-2.0-x86_64.AppImage", UserApps.pickAsset(release, "App-1.0-x86_64.AppImage")) + assertEquals("App-2.0-x86-32.AppImage", UserApps.pickAsset(release, "App-1.0-x86-32.AppImage")) + assertEquals("App-2.0-amd64.AppImage", UserApps.pickAsset(listOf("App-2.0-i386.AppImage", "App-2.0-amd64.AppImage"), "App-1.0-x86_64.AppImage")) + } } diff --git a/app/src/test/java/com/droiddeck/launcher/runtime/NativeGuestTest.kt b/app/src/test/java/com/droiddeck/launcher/runtime/NativeGuestTest.kt new file mode 100644 index 0000000000..3188eb4e62 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/runtime/NativeGuestTest.kt @@ -0,0 +1,99 @@ +package com.droiddeck.launcher.runtime + +import java.io.File +import java.nio.file.Files +import org.junit.Assert.assertEquals +import org.junit.Assert.assertTrue +import org.junit.Test + +class NativeGuestTest { + private fun rootWithLoader(): File = Files.createTempDirectory("native-root").toFile().also { + File(it, "usr/lib").mkdirs() + File(it, "usr/lib/ld-linux-aarch64.so.1").writeText("") + } + + @Test + fun theSeccompSwitchNamesAHelperAndItsArgumentsInTheRootfs() { + val root = Files.createTempDirectory("rootfs").toFile() + assertEquals(null, NativeGuest.simulator(root)) + File(root, "usr/local/bin").mkdirs() + File(root, "usr/local/bin/seccomp-sim").writeText("") + File(root, "etc/droiddeck").mkdirs() + File(root, "etc/droiddeck/seccomp-sim").writeText("/usr/local/bin/seccomp-sim -f /etc/droiddeck/app.bpf\n") + assertEquals(listOf(File(root, "usr/local/bin/seccomp-sim").path, "-f", File(root, "etc/droiddeck/app.bpf").path), + NativeGuest.simulator(root)) + File(root, "etc/droiddeck/seccomp-sim").writeText("/usr/local/bin/missing") + assertEquals(null, NativeGuest.simulator(root)) + } + + @Test + fun aWorkingDirectoryInAMountIsItsSource() { + val root = Files.createTempDirectory("rootfs").toFile() + val storage = Files.createTempDirectory("storage").toFile() + File(root, "root").mkdirs() + // a mount spec is "src:dst"; Windows' drive letters cannot be written in one + org.junit.Assume.assumeFalse(storage.path.contains(':')) + val binds = listOf("${storage.path}:/root/Storage", "/proc") + assertEquals(storage, NativeGuest.workingDirectory(root, binds, "/root/Storage")) + assertEquals(File(root, "root"), NativeGuest.workingDirectory(root, binds, "/root")) + assertEquals(root, NativeGuest.workingDirectory(root, binds, "/nowhere")) + } + + @Test + fun commandRunsTheProgramThroughTheRootfsLoader() { + val root = rootWithLoader() + val command = NativeGuest.command(root, "/usr/bin/env", listOf("-i", "A=1")) + assertEquals(File(root, "usr/lib/ld-linux-aarch64.so.1").path, command[0]) + assertEquals(listOf("--argv0", "env", File(root, "usr/bin/env").path, "-i", "A=1"), command.drop(1)) + } + + @Test + fun mountsWithoutADestinationMapToThemselves() { + val root = rootWithLoader() + val env = NativeGuest.sessionEnvironment(root, listOf("/dev", "/a:/b")) + assertEquals("/dev:/dev|/a:/b", env["DDNATV_BINDS"]) + assertEquals(root.path, env["DDNATV_ROOT"]) + assertTrue(env.getValue("LD_PRELOAD").replace(File.separatorChar, '/').endsWith("usr/lib/libddnatv-hook.so")) + } + + private val linkRoot = "/data/user/0/app/files/linuxfs" + private val sdBinds = listOf( + "/mnt/media_rw/CARD/files/steam:/mnt/droiddeck-sd", + "/data/user/0/app/files/steam-libraries/x/steamapps/compatdata:/mnt/droiddeck-sd/steamapps/compatdata", + "/storage/emulated/0", + ) + + @Test + fun aDriveLinkToTheCardGetsItsGuestPathBack() { + assertEquals("/mnt/droiddeck-sd", NativeGuest.guestLinkTarget("/mnt/media_rw/CARD/files/steam", linkRoot, sdBinds)) + assertEquals("/mnt/droiddeck-sd/steamapps/compatdata/1", + NativeGuest.guestLinkTarget("/data/user/0/app/files/steam-libraries/x/steamapps/compatdata/1", linkRoot, sdBinds)) + } + + @Test + fun aDriveLinkIntoTheRootfsGetsItsGuestPathBack() { + assertEquals("/", NativeGuest.guestLinkTarget(linkRoot, linkRoot, sdBinds)) + assertEquals("/root/Games", NativeGuest.guestLinkTarget("$linkRoot/root/Games", linkRoot, sdBinds)) + } + + @Test + fun guestPathsStayAsTheyAre() { + assertEquals(null, NativeGuest.guestLinkTarget("/mnt/droiddeck-sd", linkRoot, sdBinds)) + assertEquals(null, NativeGuest.guestLinkTarget("/", linkRoot, sdBinds)) + assertEquals(null, NativeGuest.guestLinkTarget("../drive_c", linkRoot, sdBinds)) + assertEquals(null, NativeGuest.guestLinkTarget("/storage/emulated/0/Games", linkRoot, sdBinds)) + } + + @Test + fun aSiblingOfAMountSourceIsNotPartOfIt() { + assertEquals(null, NativeGuest.guestLinkTarget("/mnt/media_rw/CARD/files/steamx", linkRoot, sdBinds)) + assertEquals(null, NativeGuest.guestLinkTarget("${linkRoot}x/root", linkRoot, sdBinds)) + } + + @Test + fun theFirstOfMountsSharingASourceIsTheGuestPath() { + val binds = sdBinds + "/data/user/0/app/files/steam-libraries/x/steamapps/compatdata:/mnt/bannerlator-sd/steamapps/compatdata" + assertEquals("/mnt/droiddeck-sd/steamapps/compatdata/2", + NativeGuest.guestLinkTarget("/data/user/0/app/files/steam-libraries/x/steamapps/compatdata/2", linkRoot, binds)) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/runtime/ProotFastPathTest.kt b/app/src/test/java/com/droiddeck/launcher/runtime/ProotFastPathTest.kt index 12fb45bf91..f413618942 100644 --- a/app/src/test/java/com/droiddeck/launcher/runtime/ProotFastPathTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/runtime/ProotFastPathTest.kt @@ -33,4 +33,8 @@ class ProotFastPathTest { assertFalse(ProotFastPath.allows(preference = false, noSeccomp = false, source = LinuxRuntime.PROOT_PACK)) assertFalse(ProotFastPath.allows(preference = true, noSeccomp = true, source = LinuxRuntime.PROOT_PACK)) } + + @Test fun fastPathStaysOffWithoutProot() { + assertFalse(ProotFastPath.allows(preference = true, noSeccomp = false, source = LinuxRuntime.PROOT_PACK, nativeUserland = true)) + } } diff --git a/app/src/test/java/com/droiddeck/launcher/session/BottomNotificationsTest.kt b/app/src/test/java/com/droiddeck/launcher/session/BottomNotificationsTest.kt deleted file mode 100644 index 19046dc27b..0000000000 --- a/app/src/test/java/com/droiddeck/launcher/session/BottomNotificationsTest.kt +++ /dev/null @@ -1,38 +0,0 @@ -package com.droiddeck.launcher.session - -import org.junit.Assert.assertEquals -import org.junit.Assert.assertFalse -import org.junit.Assert.assertTrue -import org.junit.Test - -class BottomNotificationsTest { - private val own = "com.droiddeck.launcher" - - @Test fun messagesFromOtherAppsAreKept() { - assertTrue(BottomNotifications.keep(own, "com.discord", ongoing = false, groupSummary = false, title = "Kurt", text = "ready?")) - } - - @Test fun ownOngoingSummaryAndEmptyNotificationsAreSkipped() { - assertFalse(BottomNotifications.keep(own, own, ongoing = false, groupSummary = false, title = "Session", text = "running")) - assertFalse(BottomNotifications.keep(own, "com.spotify", ongoing = true, groupSummary = false, title = "Song", text = "Artist")) - assertFalse(BottomNotifications.keep(own, "com.discord", ongoing = false, groupSummary = true, title = "2 messages", text = "")) - assertFalse(BottomNotifications.keep(own, "com.discord", ongoing = false, groupSummary = false, title = " ", text = "")) - } - - @Test fun anUpdatedNotificationMovesToTheTopOnce() { - val list = mutableListOf( - BottomNotification("a", "App", "one", "", 1L), - BottomNotification("b", "App", "two", "", 2L), - ) - BottomNotifications.add(list, BottomNotification("b", "App", "two again", "", 3L)) - assertEquals(listOf("b", "a"), list.map { it.key }) - assertEquals("two again", list.first().title) - } - - @Test fun theListKeepsTheNewestThirty() { - val list = mutableListOf() - repeat(35) { BottomNotifications.add(list, BottomNotification("k$it", "App", "t$it", "", it.toLong())) } - assertEquals(30, list.size) - assertEquals("k34", list.first().key) - } -} diff --git a/app/src/test/java/com/droiddeck/launcher/session/GameStorageTest.kt b/app/src/test/java/com/droiddeck/launcher/session/GameStorageTest.kt index d6913ed5d3..b5060392a5 100644 --- a/app/src/test/java/com/droiddeck/launcher/session/GameStorageTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/session/GameStorageTest.kt @@ -95,6 +95,14 @@ class GameStorageTest { assertFalse(GameStorage.attached(File("/mnt/media_rw/B2BD-BCFC/STEAM GAMES")) { null }) } + @Test fun aSavedFolderThatIsThereIsAttachedWhateverItsVolumeReports() { + val folder = tmp.newFolder("card", "STEAM GAMES") + listOf(Environment.MEDIA_UNKNOWN, Environment.MEDIA_UNMOUNTED, Environment.MEDIA_REMOVED, null).forEach { + assertTrue(GameStorage.attached(folder, it, externalStoragePath = true)) + } + assertTrue(GameStorage.attached(folder) { Environment.MEDIA_UNKNOWN }) + } + @Test fun onlyASavedDriveThatIsMissingCountsAsDisconnected() { SessionPrefs.setGameStorage(app, "", "") assertFalse(GameStorage.disconnected(app)) diff --git a/app/src/test/java/com/droiddeck/launcher/session/ProtonExtrasTest.kt b/app/src/test/java/com/droiddeck/launcher/session/ProtonExtrasTest.kt index 411268ef69..43571a3ff0 100644 --- a/app/src/test/java/com/droiddeck/launcher/session/ProtonExtrasTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/session/ProtonExtrasTest.kt @@ -44,6 +44,8 @@ class ProtonExtrasTest { private fun installTool(parent: File, name: String) = File(parent, name).apply { mkdirs() File(this, "toolmanifest.vdf").writeText("\"manifest\" { \"commandline\" \"/proton %verb%\" }") + File(this, "compatibilitytool.vdf").writeText("\"from_oslist\" \"windows\"") + File(this, "proton").apply { writeText(""); setExecutable(true) } } @Test @@ -120,6 +122,17 @@ class ProtonExtrasTest { assertEquals(emptyList(), ProtonExtras.installedIn(File(tools, "missing"), tool("ge"))) } + @Test + fun interruptedBuildsAreNotReportedAsInstalled() { + val tools = temp.newFolder("compatibilitytools.d") + installTool(tools, "GE-Proton11-10") + File(tools, "GE-Proton11-11").apply { + mkdirs() + File(this, "toolmanifest.vdf").writeText("\"manifest\" { \"commandline\" \"/proton %verb%\" }") + } + assertEquals(listOf("GE-Proton11-10"), ProtonExtras.installedIn(tools, tool("ge"))) + } + @Test fun anUpdateIsANewerReleaseThanTheNewestInstalledBuild() { assertEquals("DroidDeck-Proton-11-7.6", ProtonExtras.updateFor(listOf("DroidDeck-Proton 11-7.5"), "DroidDeck-Proton-11-7.6")) diff --git a/app/src/test/java/com/droiddeck/launcher/session/SessionDisplayTest.kt b/app/src/test/java/com/droiddeck/launcher/session/SessionDisplayTest.kt index 82512c0b91..7f3eec4092 100644 --- a/app/src/test/java/com/droiddeck/launcher/session/SessionDisplayTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/session/SessionDisplayTest.kt @@ -60,6 +60,13 @@ class SessionDisplayTest { assertEquals(864, SessionDisplay.unfoldedGameHeight(1920, 1080)) } + @Test fun aTabRowUnderTheBarComesOutOfTheGameNotTheControls() { + assertEquals(1376, SessionDisplay.unfoldedGameHeight(2448, 1848, 0)) + assertEquals(1240, SessionDisplay.unfoldedGameHeight(2448, 1848, 136)) + assertEquals(1376, SessionDisplay.unfoldedGameHeight(2448, 1848, -20)) + assertEquals(0, SessionDisplay.unfoldedGameHeight(200, 100, 500)) + } + private fun unfoldedWanted( enabled: Boolean = true, controller: Boolean = false, diff --git a/app/src/test/java/com/droiddeck/launcher/session/SessionLoadingDecisionTest.kt b/app/src/test/java/com/droiddeck/launcher/session/SessionLoadingDecisionTest.kt new file mode 100644 index 0000000000..bdfd2fb5f9 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/session/SessionLoadingDecisionTest.kt @@ -0,0 +1,53 @@ +package com.droiddeck.launcher.session + +import android.content.Intent +import org.junit.After +import org.junit.Assert.assertEquals +import org.junit.Assert.assertNull +import org.junit.Before +import org.junit.Test + +class SessionLoadingDecisionTest { + private var previousSessionId: String? = null + private var previousRelaunch: Intent? = null + + @Before + fun setUp() { + previousSessionId = SessionState.sessionId + previousRelaunch = SessionState.relaunch + SessionState.clearRelaunch() + } + + @After + fun tearDown() { + SessionState.sessionId = previousSessionId + SessionState.relaunch = previousRelaunch + SessionState.clearRelaunch() + if (previousRelaunch != null) SessionState.queueRelaunch(previousRelaunch!!) + } + + @Test + fun loadingTimesOutOnlyWhenNoSessionStarted() { + assertEquals(false, SessionLoadingDecision.shouldReturnToLauncher(100L, 10_099L, false, SessionPhase.IDLE)) + assertEquals(true, SessionLoadingDecision.shouldReturnToLauncher(100L, 10_100L, false, SessionPhase.IDLE)) + assertEquals(false, SessionLoadingDecision.shouldReturnToLauncher(100L, 10_100L, true, SessionPhase.IDLE)) + assertEquals(false, SessionLoadingDecision.shouldReturnToLauncher(100L, 10_100L, false, SessionPhase.PREPARING)) + } + + @Test + fun relaunchRequiresTheCurrentSessionToHaveRequestedTheStop() { + SessionState.sessionId = "session-a" + val next = Intent().apply { action = "next" } + SessionState.queueRelaunch(next) + assertNull(SessionState.takeRelaunch()) + SessionState.queueRelaunch(next) + SessionState.confirmRelaunchStop() + assertEquals(next, SessionState.takeRelaunch()) + assertNull(SessionState.takeRelaunch()) + + SessionState.queueRelaunch(next) + SessionState.confirmRelaunchStop() + SessionState.sessionId = "session-b" + assertNull(SessionState.takeRelaunch()) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/stores/SortCatalogItemsTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/SortCatalogItemsTest.kt index 8a315f3a1a..23a0c16dec 100644 --- a/app/src/test/java/com/droiddeck/launcher/stores/SortCatalogItemsTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/stores/SortCatalogItemsTest.kt @@ -20,6 +20,14 @@ class SortCatalogItemsTest { assertEquals(listOf("Zelda", "Beta", "alpha"), sortCatalogItems(items, "titleDesc").map { it.title }) } + @Test fun anEntryTimeFallsBackWhenTheFirstSourceHasNone() { + assertEquals(30L, entryTime(30L, 20L)) + assertEquals(20L, entryTime(0L, 20L)) + assertEquals(20L, entryTime(null, 20L)) + assertEquals(0L, entryTime(0L, null)) + assertEquals(0L, entryTime(null, 0L)) + } + @Test fun playedAndInstalledComeFirstWithTitlesBreakingTies() { val items = listOf(item("1", "Zelda"), item("2", "alpha"), item("3", "Beta")) val played = mapOf("gog:3" to 900L, "gog:1" to 900L) diff --git a/app/src/test/java/com/droiddeck/launcher/stores/ea/EaTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/ea/EaTest.kt new file mode 100644 index 0000000000..a52485035e --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/stores/ea/EaTest.kt @@ -0,0 +1,323 @@ +package com.droiddeck.launcher.stores.ea + +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreGameSidecar +import com.droiddeck.launcher.stores.StoreLaunch +import org.json.JSONObject +import org.junit.Assert.assertEquals +import org.junit.Assert.assertFalse +import org.junit.Assert.assertNotNull +import org.junit.Assert.assertNull +import org.junit.Assert.assertTrue +import org.junit.Test +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import java.io.File +import java.nio.file.Files +import java.time.LocalDate + +@RunWith(RobolectricTestRunner::class) +class EaTest { + private val wine = EaOoa.Hardware( + boardManufacturer = "Wine", boardSerial = "None", biosManufacturer = "The Wine Project", biosSerial = "0", + osInstallDate = "20240101000000.000000+000", osSerial = "12345-OEM", volumeSerial = "43000000", + gpuPnpId = "PCI\\VEN_5143&DEV_0001&SUBSYS_00000000&REV_00\\0&DEADBEEF&0&DEAD", + cpuVendor = "GenuineIntel", cpuEdx = "BFEBFBFF", cpuEax = "000906EA", cpuEcx = "7ffafbbf", brand = "FEX CPU", hostname = "myhost", + ) + + @Test fun machineHashFollowsTheActivationVersion() { + assertEquals("01804062be939efcd4462c65de292af3a56359b5", EaOoa.machineHash(wine, 4)) + assertEquals("41fa9c614390c5a82534becd338b798197cc5b", EaOoa.machineHash(wine, 3)) + } + + @Test fun launchCodeAndSessionKeyMatchTheProtocol() { + assertEquals(1196115787L, EaCrypto.rtpCode(LocalDate.of(2026, 11, 7))) + assertEquals("f057eb86a0bf8c57537b1aa6b98c6495", EaCrypto.hex(EaCrypto.lsxKey(0x6162))) + assertEquals(EaCrypto.hex(EaCrypto.LSX_DEFAULT_KEY), EaCrypto.hex(EaCrypto.lsxKey(0))) + val answer = EaCrypto.challengeAnswer("abc") + assertEquals("abc", String(EaCrypto.ecbDecrypt(EaCrypto.unhex(answer), EaCrypto.LSX_DEFAULT_KEY))) + assertEquals((answer[0].code shl 8) or answer[1].code, EaCrypto.challengeSeed("3", answer)) + assertNull(EaCrypto.challengeSeed("9", answer)) + } + + @Test fun licenceRoundTripsThroughTheFileFormat() { + val xml = "kh" + + "12349tokgsn" + val l = EaOoa.parseLicense(xml, "c2ln") + assertEquals("tok", l.gameToken) + assertEquals("1234", l.contentId) + val blob = EaOoa.licenseBlob(l, encoded = true) + assertEquals("c2ln", String(blob.copyOfRange(0, 4))) + assertEquals(0, blob[64].toInt()) + val back = String(EaCrypto.licenseDecrypt(blob.copyOfRange(65, blob.size))) + assertTrue(back.contains("tok")) + assertEquals("sig", String(EaOoa.licenseBlob(l, encoded = false).copyOfRange(0, 3))) + } + + @Test fun readsTheVersionOfTheActivationLibrary() { + val pe = ByteArray(64) + val fixed = byteArrayOf(0xBD.toByte(), 0x04, 0xEF.toByte(), 0xFE.toByte(), 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 7, 0, 4, 0, 0, 0, 6, 0) + System.arraycopy(fixed, 0, pe, 10, fixed.size) + assertEquals(Triple(4, 7, 6), EaOoa.productVersion(pe)) + } + + @Test fun manifestNamesTheLauncherAndTouchup() { + val xml = """ + + + + [HKEY_LOCAL_MACHINE\SOFTWARE\EA Games\Game\Install Dir]trial.exetrue + [HKEY_LOCAL_MACHINE\SOFTWARE\EA Games\Game\Install Dir]bin\Game.exe-dx12false + + /__Installer/Touchup.exe-locale {locale} -installPath "{installLocation}" + """ + val m = EaManifest.parse(xml) + assertEquals("1.0.64.43203", m.version) + assertEquals("bin/Game.exe", EaPaths.relative(m.launcher()!!.path)) + assertEquals("-dx12", m.launcher()!!.parameters) + assertEquals("/__Installer/Touchup.exe", m.touchupPath) + val r = EaPaths.registered(m.launcher()!!.path)!! + assertEquals("HKEY_LOCAL_MACHINE\\SOFTWARE\\EA Games\\Game", r.key) + assertEquals("Install Dir", r.value) + val utf16 = byteArrayOf(0xFF.toByte(), 0xFE.toByte()) + "".toByteArray(Charsets.UTF_16LE) + assertEquals("1.0", EaManifest.parse(EaManifest.decode(utf16)).version) + } + + @Test fun findsFilesWhateverTheirCase() { + val dir = Files.createTempDirectory("ea").toFile() + File(dir, "Bin").mkdirs() + File(dir, "Bin/GAME.exe").writeText("x") + assertEquals("Bin/GAME.exe", EaPaths.relativeOnDisk(dir, "bin/game.exe")) + assertNull(EaPaths.relativeOnDisk(dir, "bin/other.exe")) + assertEquals(listOf("-a", "two words", "-c"), EaPaths.splitArgs("-a \"two words\" -c")) + dir.deleteRecursively() + } + + @Test fun lsxRequestsAreParsed() { + val m = EaLsx.parse("")!! + assertEquals("GetSetting", m.name) + assertEquals("4", m.id) + assertEquals("ENVIRONMENT", m.attrs["SettingId"]) + val c = EaLsx.parse("1Game")!! + assertEquals(listOf("ContentId" to "1", "Title" to "Game"), c.children) + assertNull(EaLsx.parse("")) + } + + @Test fun socketOwnerIsReadFromTheProcTable() { + val rows = listOf( + " sl local_address rem_address st tx_queue rx_queue tr tm->when retrnsmt uid timeout inode", + " 0: 0100007F:C350 0100007F:0C90 01 00000000:00000000 00:00000000 00000000 10234 0 1 1 0", + ) + assertEquals(10234, EaLsx.owner(rows, 0xC350)) + assertNull(EaLsx.owner(rows, 1234)) + assertNull(EaLsx.owner(emptyList(), 0xC350)) + } + + @Test fun rapidConnectionsNeverPassTheClientCap() { + fun session() = EaLsx.Session(java.net.Socket(), java.io.ByteArrayOutputStream(), false) + EaLsx.sessions.clear() + val first = (1..8).map { session().also { s -> assertTrue(EaLsx.admit(s)) } } + first[0].claimed = true + repeat(20) { assertTrue(EaLsx.admit(session())) } + assertEquals(8, EaLsx.sessions.count { !it.evicted }) + assertFalse(first[0].evicted) + EaLsx.sessions.forEach { it.trusted = true } + assertFalse(EaLsx.admit(session())) + EaLsx.sessions.clear() + } + + @Test fun anEvictedSessionCannotBecomeTrusted() { + val s = EaLsx.Session(java.net.Socket(), java.io.ByteArrayOutputStream(), true) + s.evicted = true + EaLsx.promote(s, true) + assertFalse(s.trusted) + val ok = EaLsx.Session(java.net.Socket(), java.io.ByteArrayOutputStream(), true) + EaLsx.promote(ok, true) + assertTrue(ok.trusted) + EaLsx.stop() + } + + @Test fun aPeerAndroidCannotNameIsTrustedOnlyForTheClaimedGame() { + val hidden = EaLsx.Session(java.net.Socket(), java.io.ByteArrayOutputStream(), false, unverifiable = true) + assertFalse(hidden.mayTrust) + hidden.claimed = true + assertTrue(hidden.mayTrust) + val other = EaLsx.Session(java.net.Socket(), java.io.ByteArrayOutputStream(), false) + other.claimed = true + assertFalse(other.mayTrust) + } + + @Test fun aSessionFromAnOlderLaunchCannotBecomeTrusted() { + val old = EaLsx.Session(java.net.Socket(), java.io.ByteArrayOutputStream(), true) + EaLsx.generation++ + EaLsx.promote(old, true) + assertFalse(old.trusted) + EaLsx.stop() + } + + @Test fun lateExitDoesNotStopANewerLaunch() { + val game = EaLsx.Game("Origin.OFR.2", "2", "Two", "1", "en_US", null, 0) + EaLsx.game = game + EaLsx.stop("Origin.OFR.1") + assertEquals(game, EaLsx.game) + EaLsx.stop("Origin.OFR.2") + assertNull(EaLsx.game) + } + + @Test fun redirectCarriesTheCode() { + assertEquals("QUOX", EaAuth.redirectValue("qrc:///html/login_successful.html?code=QUOX&state=1", "code")) + assertEquals("tok", EaAuth.redirectValue("qrc:/html/login_successful.html#access_token=tok&token_type=Bearer", "access_token")) + assertNull(EaAuth.redirectValue("https://signin.ea.com/p/x", "code")) + } + + @Test fun pcSignIsSigned() { + val sign = EaAuth.pcSign("ab12", java.util.Date(0), "v1") + val (payload, signature) = sign.split('.') + val json = JSONObject(String(java.util.Base64.getUrlDecoder().decode(payload))) + assertEquals("v1", json.getString("sv")) + assertEquals("1970-01-01 00:00:00:000", json.getString("ts")) + assertEquals(EaCrypto.base64Url(EaCrypto.hmacSha256("ISa3dpGOc8wW7Adn4auACSQmaccrOyR2".toByteArray(), payload.toByteArray())), signature) + } + + @Test fun libraryKeepsOneEntryPerGame() { + fun owned(id: String, slug: String, base: String = "", type: String = "BASE_GAME", trial: Boolean = false) = + EaApi.OwnedProduct(id, "p$id", "Game $id", slug, base, type, true, trial, emptyList()) + fun offer(id: String, type: String = "FullGame") = EaApi.Offer(id, "c$id", "", type, true, "", "", "", "", "", "1.0", "", emptyList()) + val list = listOf(owned("1", "game"), owned("2", "game-deluxe", base = "game"), owned("3", "other"), owned("4", "trial", trial = true), owned("5", "dlc", type = "EXTRA_CONTENT")) + val picked = EaLibrary.pick(list, list.associate { it.offerId to offer(it.offerId) }) + assertEquals(listOf("1", "3"), picked.map { it.first.offerId }) + } + + @Test fun ownedPageParses() { + val page = JSONObject( + """{"me":{"ownedGameProducts":{"next":"100","items":[{"originOfferId":"Origin.OFR.50.0001","product":{"id":"x","name":"N","downloadable":true,"gameSlug":"titanfall-2", + "baseItem":{"title":"Titanfall 2","gameType":"BASE_GAME","baseGameSlug":null},"gameProductUser":{"ownershipMethods":["PURCHASE"]}}}]}}}""", + ) + val (items, next) = EaApi.parseOwned(page) + assertEquals("100", next) + assertEquals("Titanfall 2", items.single().name) + assertEquals("", items.single().baseSlug) + val offers = EaApi.parseOffers(JSONObject("""{"legacyOffers":[{"offerId":"Origin.OFR.50.0001","contentId":"1035052","displayType":"FullGame","isDownloadable":true, + "downloads":[{"downloadType":"LIVE","gameVersion":"2.0.11.0"}],"softwareLocales":["en_US","fr_FR"],"executeParameters":null}]}""")) + assertEquals("2.0.11.0", offers.single().gameVersion) + assertEquals("", offers.single().executeParameters) + assertNotNull(EaApi.query("getPreloadedOwnedGames")) + } + + @Test fun launcherReadsTheSessionFileOnce() { + val text = StoreLaunch.launcherText(StoreGameSidecar(Store.EA, "Origin.OFR.1", "Game", exe = "bin/Game.exe", args = listOf("-dx12"))) + assertTrue(text.contains("for /f \"usebackq tokens=1,* delims==\" %%a in (\"%~dp0.droiddeck-ea-env\") do set \"%%a=%%b\"")) + assertTrue(text.contains("del \"%~dp0.droiddeck-ea-env\"")) + assertTrue(text.contains("start \"\" \"${StoreLaunch.EA_ORIGIN}\"\r\n\"%~dp0bin\\Game.exe\" -dx12\r\n")) + assertTrue(text.trimEnd().endsWith("taskkill /f /im Origin.exe >nul 2>&1")) + } + + @Test fun environmentCarriesTheSession() { + val account = EaAuth.Account("a", "r", 0, "1001", "2002", "Name", "EaId") + val env = EaLaunch.environment("Origin.OFR.1", "1035052", "fr_FR", "generic", "jwt", "opaque", account, "session") + assertEquals("generic", env["EAGenericAuthToken"]) + assertEquals("jwt", env["EAAccessTokenJWS"]) + assertEquals("3216", env["EALsxPort"]) + assertEquals("opaque", env["EALaunchUserAuthToken"]) + assertEquals("EaId", env["EALaunchEAID"]) + assertEquals("1035052", env["ContentId"]) + assertEquals("fr_FR", env["EAGameLocale"]) + } + + @Test fun activationCoreSitsBesideTheExe() { + val dir = Files.createTempDirectory("ea").toFile() + File(dir, "Binaries/Win32/Core").mkdirs() + File(dir, "Binaries/Win32/Core/EACore.dll").writeText("x") + val core = EaOoa.coreDir(dir, "Binaries/Win32/MassEffect3.exe") + assertEquals(File(dir, "Binaries/Win32/Core").canonicalPath, core?.canonicalPath) + assertTrue(EaOoa.legacyCore(core)) + assertNull(EaOoa.coreDir(dir, "Game.exe")) + File(dir, "Core").mkdirs() + assertEquals(File(dir, "Core").canonicalPath, EaOoa.coreDir(dir, "Game.exe")?.canonicalPath) + dir.deleteRecursively() + } + + @Test fun anIncompleteProbeIsNotHashed() { + val empty = EaOoa.Hardware.fromJson(JSONObject()) + assertTrue(!empty.complete(0) && !empty.complete(4)) + val wmiOnly = EaOoa.Hardware.fromJson(JSONObject().put("boardManufacturer", "Intel Corporation").put("biosManufacturer", "The Wine Project") + .put("osSerial", "00330").put("osInstallDate", "2026").put("hostname", "DROIDDECK")) + assertTrue(wmiOnly.complete(0)) + assertTrue(!wmiOnly.complete(4)) + assertTrue(wine.complete(4)) + assertTrue(wine.complete(2)) + val noInstallDate = EaOoa.Hardware.fromJson(JSONObject().put("boardManufacturer", "Wine").put("biosManufacturer", "Wine").put("osSerial", "1") + .put("volumeSerial", "43000000").put("cpuVendor", "GenuineIntel").put("cpuEdx", "BFEBFBFF").put("cpuEax", "000906EA").put("cpuEcx", "7ffafbbf")) + assertTrue(!noInstallDate.complete(2)) + assertTrue(noInstallDate.complete(3) && noInstallDate.complete(4)) + } + + @Test fun legacyManifestNamesItsContentAndTitle() { + val xml = """7107371183 + RUMass Effect 3 + /__Installer/touchup.exeinstall -locale {locale}""" + val m = EaManifest.parse(xml) + assertEquals(listOf("71073", "71183"), m.contentIds) + assertEquals("Mass Effect 3", m.title("en_US")) + assertEquals("RU", m.title("ru_RU")) + assertEquals("Mass Effect 3", m.title("de_DE")) + assertEquals("/__Installer/touchup.exe", m.touchupPath) + } + + @Test fun aNumericTrialFlagKeepsTheTrialExeOut() { + val xml = """ + [HKEY_LOCAL_MACHINE\SOFTWARE\EA Games\Need for Speed Heat\Install Dir]NeedForSpeedHeatTrial.exe1 + [HKEY_LOCAL_MACHINE\SOFTWARE\EA Games\Need for Speed Heat\Install Dir]NeedForSpeedHeat.exe0 + """ + assertTrue(EaManifest.parse(xml).launcher()!!.path.endsWith("NeedForSpeedHeat.exe")) + } + + @Test fun aSyncRequestedWhileOneRunsIsNotLost() { + val gate = SyncGate() + assertTrue(gate.enter()) + assertTrue(!gate.enter()) + assertTrue(gate.leave()) + assertTrue(!gate.leave()) + assertTrue(gate.enter()) + assertTrue(!gate.leave()) + } + + @Test fun aRequestRacingTheRunnersExitIsPickedUpBySomeone() { + repeat(200) { + val gate = SyncGate() + val runs = java.util.concurrent.atomic.AtomicInteger() + assertTrue(gate.enter()) + val latch = java.util.concurrent.CountDownLatch(1) + val requester = Thread { latch.await(); if (gate.enter()) { runs.incrementAndGet(); while (gate.leave()) runs.incrementAndGet() } } + requester.start() + latch.countDown() + while (gate.leave()) runs.incrementAndGet() + requester.join() + assertTrue("the second request was dropped", runs.get() >= 1) + } + } + + @Test fun aSyncThatSnapshottedBeforeSignOutCannotWriteItsLibrary() { + val app = org.robolectric.RuntimeEnvironment.getApplication() + val game = EaGame("Origin.OFR.1", "1", "Old account game", "old") + val (gen, _) = EaLibrary.snapshot(app) + EaLibrary.reset(app) + assertTrue(!EaLibrary.storeCache(app, listOf(game), gen)) + assertTrue(EaLibrary.cached(app).isEmpty()) + val (fresh, cache) = EaLibrary.snapshot(app) + assertTrue(cache.isEmpty()) + assertTrue(EaLibrary.storeCache(app, listOf(game), fresh)) + assertEquals("Old account game", EaLibrary.cached(app).single().title) + EaLibrary.reset(app) + } + + @Test fun aRefreshFinishingAfterSignOutDoesNotRestoreTheSignIn() { + val app = org.robolectric.RuntimeEnvironment.getApplication() + com.droiddeck.launcher.stores.StoreAccounts.write(app, Store.EA, JSONObject().put("access_token", "old").put("refresh_token", "r").put("user_id", "1")) + assertTrue(EaAuth.storeRefreshed(app, "newer", 3600, "r2")) + assertEquals("newer", EaAuth.load(app)?.accessToken) + EaAuth.signOut(app) + assertTrue(!EaAuth.storeRefreshed(app, "late", 3600, "r3")) + assertNull(EaAuth.load(app)) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/stores/gog/GogCdnTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/gog/GogCdnTest.kt index 324338e17e..424e6a576f 100644 --- a/app/src/test/java/com/droiddeck/launcher/stores/gog/GogCdnTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/stores/gog/GogCdnTest.kt @@ -15,16 +15,12 @@ class GogCdnTest { {"endpoint_name":"lumen","url_format":"https://cdn.gog.com/{path}","parameters":{}} ]}""" - @Test fun allHostsAreParsedInOrderAndTakenInTurn() { + @Test fun allHostsAreParsedInOrder() { val all = GogDownloadManager.parseCdnUrls(answer) assertEquals(3, all.size) assertEquals("https://gog-cdn-fastly.gog.com/token=nva=1~token=t", all[0]) assertEquals("https://gog-cdn-akamai.gog.com/s", all[1]) assertEquals("https://cdn.gog.com", all[2]) - val set = all.joinToString("\n") - assertEquals(all[0], GogDownloadManager.firstCdn(set)) - val picks = (0 until 6).map { GogDownloadManager.pickCdn(set) }.toSet() - assertEquals(all.toSet(), picks) assertEquals(0, GogDownloadManager.parseCdnUrls("not json").size) } } diff --git a/app/src/test/java/com/droiddeck/launcher/stores/gog/GogListingTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/gog/GogListingTest.kt index 5aace971f6..86e54aad06 100644 --- a/app/src/test/java/com/droiddeck/launcher/stores/gog/GogListingTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/stores/gog/GogListingTest.kt @@ -24,6 +24,23 @@ class GogListingTest { assertEquals("", shadowrun.description) } + @Test + fun ownedGamesTheListingLeavesOutStayOwned() { + assertEquals(setOf("1", "2", "1086370078"), GogLibrary.ownedSet(setOf("1", "2"), listOf("2", "1086370078"))) + } + + @Test + fun withoutTheAccountListTheListingStillCounts() { + assertEquals(setOf("1", "2"), GogLibrary.ownedSet(setOf("1", "2"), null)) + assertEquals(setOf("3"), GogLibrary.ownedSet(emptySet(), listOf("3"))) + } + + @Test + fun cachedGamesStayWhenTheAccountListIsUnavailable() { + assertEquals(setOf("1", "2", "1086370078"), GogLibrary.ownedSet(setOf("1", "2"), null, setOf("1086370078"))) + assertEquals(setOf("1", "2", "3"), GogLibrary.ownedSet(setOf("1"), listOf("2", "3"), setOf("1086370078"))) + } + @Test fun moviesOtherPlatformsAndGalaxysOwnEntryAreLeftOut() { assertEquals(listOf("1207660413", "1207664663"), GogLibrary.parseListing(PAGE)!!.games.map { it.gameId }) diff --git a/app/src/test/java/com/droiddeck/launcher/stores/gog/GogMaintenanceTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/gog/GogMaintenanceTest.kt index 1d755a6db0..06c88bfd11 100644 --- a/app/src/test/java/com/droiddeck/launcher/stores/gog/GogMaintenanceTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/stores/gog/GogMaintenanceTest.kt @@ -26,6 +26,45 @@ import java.util.concurrent.atomic.AtomicBoolean class GogMaintenanceTest { @get:Rule val temporary = TemporaryFolder() + @Test fun ownedDlcDepotIsSelected() { + val allowed = GogContent.installProducts("1", JSONArray("[{\"gameIDs\":[\"2\"]}]"), emptyList(), "unused") { setOf("2") } + assertEquals(setOf("1", "2"), allowed) + } + + @Test fun unownedDlcDepotIsSkipped() { + val allowed = GogContent.installProducts("1", JSONArray("[{\"productId\":\"2\"}]"), emptyList(), "unused") { emptySet() } + assertEquals(setOf("1"), allowed) + } + + @Test fun ownershipFetchFailureFallsBackToBaseOnly() { + val allowed = GogContent.installProducts("1", JSONArray("[{\"productId\":\"2\"}]"), emptyList(), "unused") { null } + assertEquals(setOf("1"), allowed) + } + + @Test fun installManifestCredentialsAndTempExecutableAreExtractedBeforeSanitizing() { + val manifest = JSONObject("""{"clientId":"client","clientSecret":"secret","products":[{"temp_executable":"bin/game.exe"}]}""") + assertEquals("client" to "secret", GogContent.clientCredentials(manifest)) + assertEquals("bin/game.exe", GogContent.tempExecutable(GogContent.sanitize(manifest))) + assertFalse(GogContent.sanitize(manifest).toString().contains("secret")) + } + + @Test fun emptyProductIdDepotUsesBaseAndDlcFilesKeepTheirProduct() { + val build = GogBuild("1", "", 2, "", "https://example.invalid/build") + val snapshot = GogContent.snapshot(GogInstallRecord("1", "depot"), build, "unused", ownership = { setOf("2") }, metadata = { url, _ -> + when (url) { + build.link -> JSONObject("{\"depots\":[{\"gameIDs\":[\"1\"],\"manifest\":\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"},{\"gameIDs\":[\"2\"],\"manifest\":\"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"},{\"productId\":\"\",\"manifest\":\"cccccccccccccccccccccccccccccccc\"}]}") + "https://gog-cdn-fastly.gog.com/content-system/v2/meta/aa/aa/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" -> JSONObject("{\"depot\":{\"items\":[{\"path\":\"base.bin\",\"chunks\":[{\"size\":1}]}]}}") + "https://gog-cdn-fastly.gog.com/content-system/v2/meta/bb/bb/bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb" -> JSONObject("{\"depot\":{\"items\":[{\"path\":\"dlc.bin\",\"chunks\":[{\"size\":1}]}]}}") + "https://gog-cdn-fastly.gog.com/content-system/v2/meta/cc/cc/cccccccccccccccccccccccccccccccc" -> JSONObject("{\"depot\":{\"items\":[{\"path\":\"empty.bin\",\"chunks\":[{\"size\":1}]}]}}") + else -> error("Unexpected metadata: $url") + } + }) + assertEquals(setOf("1", "2"), snapshot.products.toSet()) + assertEquals("1", snapshot.files.getJSONObject(0).getString("product")) + assertEquals("2", snapshot.files.getJSONObject(1).getString("product")) + assertEquals("1", snapshot.files.getJSONObject(2).getString("product")) + } + @Test fun selectsPublicBranchAndTreatsBuildIdsAsOpaque() { val builds = JSONObject("""{"items":[ {"os":"windows","branch":"beta","build_id":"99","generation":2,"link":"https://example.invalid/beta"}, @@ -213,7 +252,7 @@ class GogMaintenanceTest { fun fixture(name: String) = JSONObject(javaClass.classLoader!!.getResource("gog/$name")!!.readText()) val build = GogBuild("3301", "", 1, "", "https://example.invalid/repository.json") val requested = ArrayList() - val snapshot = GogContent.snapshot(GogInstallRecord("1207658940", "depot"), build, "unused") { url, _ -> + val snapshot = GogContent.snapshot(GogInstallRecord("1207658940", "depot"), build, "unused", metadata = { url, _ -> requested.add(url) when { url == build.link -> fixture("rayman-gen1-repository.json") @@ -221,7 +260,7 @@ class GogMaintenanceTest { url.endsWith("ec88140c-2589-41a0-bbf3-8fc1f215fe5a.json") -> fixture("rayman-gen1-english-excerpt.json") else -> error("Unexpected metadata: $url") } - } + }) assertEquals("3301", snapshot.build) assertEquals(1, snapshot.generation) assertEquals(4, snapshot.files.length()) @@ -269,6 +308,17 @@ class GogMaintenanceTest { assertThrows(IllegalArgumentException::class.java) { GogFiles.inside(folder, "link/game.exe") } } + @Test fun resumedInstallSpaceCountsOnlyFilesStillMissing() { + val folder = temporary.newFolder() + val done = File(folder, "done.bin").apply { writeText("verified") } + val files = JSONArray() + .put(JSONObject().put("path", done.name).put("size", done.length()).put("md5", GogFiles.hash(done))) + .put(JSONObject().put("path", "missing.bin").put("size", 12L).put("md5", "0".repeat(32))) + val missingOnly = GogInstallRecord("1", "depot", files = JSONArray().put(files.getJSONObject(1))) + fun required(target: GogInstallRecord) = GogEstimate.calculate(folder, GogInstallRecord("1", "depot"), target, JSONArray(), reuseChunks = false).required + assertEquals(required(missingOnly), required(GogInstallRecord("1", "depot", files = files))) + } + @Test fun sameSizeCorruptionFailsVerificationAndLanguageVariantsRemainDistinct() { val folder = temporary.newFolder() val file = File(folder, "game.bin").apply { writeText("original") } diff --git a/app/src/test/java/com/droiddeck/launcher/stores/gog/GogResumeSpaceTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/gog/GogResumeSpaceTest.kt deleted file mode 100644 index 4934b58980..0000000000 --- a/app/src/test/java/com/droiddeck/launcher/stores/gog/GogResumeSpaceTest.kt +++ /dev/null @@ -1,43 +0,0 @@ -package com.droiddeck.launcher.stores.gog - -import java.io.File -import java.security.MessageDigest -import org.junit.Assert.assertEquals -import org.junit.Assert.assertFalse -import org.junit.Assert.assertTrue -import org.junit.Test -import org.junit.runner.RunWith -import org.robolectric.RobolectricTestRunner -import org.robolectric.RuntimeEnvironment -import org.robolectric.annotation.Config -import org.robolectric.shadows.ShadowStatFs -import com.droiddeck.launcher.stores.StoreInstallRoot - -@RunWith(RobolectricTestRunner::class) -@Config(sdk = [33]) -class GogResumeSpaceTest { - @Test fun remainingWorkRejectsMeasuredZeroButNotUnknownSpace() { - val root = File(RuntimeEnvironment.getApplication().filesDir, "gog-zero").apply { mkdirs() } - ShadowStatFs.registerStats(root.path, 1024, 0, 0) - val files = listOf(GogDownloadManager.DepotFile("missing").apply { totalSize = 4 }) - val needed = GogDownloadManager.remainingInstallBytes(files, root) - assertEquals(4L, needed) - assertTrue(StoreInstallRoot.insufficientSpace(needed, StoreInstallRoot.availableBytes(root))) - assertFalse(StoreInstallRoot.insufficientSpace(needed, StoreInstallRoot.SPACE_UNKNOWN)) - } - - @Test fun remainingSpaceExcludesVerifiedFilesButIncludesCorruptAndPartialFiles() { - val root = File(RuntimeEnvironment.getApplication().filesDir, "gog-resume").apply { mkdirs() } - val data = byteArrayOf(1, 2, 3, 4) - val hash = MessageDigest.getInstance("MD5").digest(data).joinToString("") { "%02x".format(it) } - val files = listOf("good", "corrupt", "partial", "missing").map { - GogDownloadManager.DepotFile(it).apply { totalSize = 4; md5 = hash } - } - File(root, "good").writeBytes(data) - File(root, "corrupt").writeBytes(ByteArray(4)) - File(root, "partial").writeBytes(byteArrayOf(1)) - assertEquals(12L, GogDownloadManager.remainingInstallBytes(files, root)) - for (file in files) File(root, file.relativePath).writeBytes(data) - assertEquals(0L, GogDownloadManager.remainingInstallBytes(files, root)) - } -} diff --git a/app/src/test/java/com/droiddeck/launcher/stores/ubisoft/UbisoftTest.kt b/app/src/test/java/com/droiddeck/launcher/stores/ubisoft/UbisoftTest.kt new file mode 100644 index 0000000000..58e361db81 --- /dev/null +++ b/app/src/test/java/com/droiddeck/launcher/stores/ubisoft/UbisoftTest.kt @@ -0,0 +1,60 @@ +package com.droiddeck.launcher.stores.ubisoft + +import com.droiddeck.launcher.stores.Store +import com.droiddeck.launcher.stores.StoreGameSidecar +import com.droiddeck.launcher.stores.StoreLaunch +import org.json.JSONArray +import org.json.JSONObject +import org.junit.Assert.assertArrayEquals +import org.junit.Assert.assertEquals +import org.junit.Assert.assertNull +import org.junit.Assert.assertTrue +import org.junit.Test +import org.junit.runner.RunWith +import org.robolectric.RobolectricTestRunner +import org.robolectric.annotation.Config + +@RunWith(RobolectricTestRunner::class) +@Config(sdk = [33], application = android.app.Application::class) +class UbisoftTest { + private val steamConfig = "version: 2.0\r\nroot:\r\n name: Assassin's Creed Syndicate\r\n start_game:\r\n steam:\r\n steam_app_id: 368500\r\n" + + " third_party_platform:\r\n name: Steam\r\n override_uplayid: 1875\r\n" + + @Test fun aProductUbisoftDeliversThroughSteamNamesItsSteamApp() { + assertEquals("368500", UbisoftLibrary.steamApp(steamConfig)) + assertNull(UbisoftLibrary.steamApp("root:\n start_game:\n online:\n executables:\n - path:\n relative: bin/game.exe\n")) + } + + @Test fun steamOwnedGamesAreKeyedByTheirSpace() { + val owned = JSONObject().put("games", JSONArray() + .put(JSONObject().put("productId", 1957).put("spaceId", "space-s").put("productType", 0).put("owned", true).put("configuration", steamConfig)) + .put(JSONObject().put("productId", 109).put("spaceId", "space-sc").put("productType", 0).put("owned", true).put("manifest", "AB").put("configuration", "root: {}")) + .put(JSONObject().put("productId", 1961).put("spaceId", "space-addon").put("productType", 1).put("owned", true).put("configuration", steamConfig))) + assertEquals(mapOf("space-s" to "368500"), UbisoftLibrary.steamBySpace(owned)) + assertEquals(setOf("space-sc"), UbisoftLibrary.ownedBySpace(owned).keys) + } + + @Test fun theEntitlementNamesTheGamesApplication() { + val body = JSONObject().put("items", JSONArray() + .put(JSONObject().put("productId", 82).put("applicationId", "app-82")) + .put(JSONObject().put("productId", 109).put("applicationId", "app-109"))).toString() + assertEquals("app-109", UbisoftLaunch.applicationId(body, 109)) + assertNull(UbisoftLaunch.applicationId(body, 1651)) + } + + @Test fun theLauncherStartsTheServiceOnlyWithAFreshLaunchFile() { + val text = StoreLaunch.launcherText(StoreGameSidecar(Store.UBISOFT, "space-sc", "Splinter Cell", "system/SplinterCell.exe")) + val lines = text.trimEnd().split("\r\n") + assertTrue(lines.contains("if not exist \"%~dp0.droiddeck-ubisoft.json\" goto direct")) + assertTrue(lines.contains("\"Z:\\usr\\local\\lib\\droiddeck-ubisoft\\droiddeck-upc.exe\" \"%~dp0.droiddeck-ubisoft.json\"")) + assertEquals("\"%~dp0system\\SplinterCell.exe\"", lines.last()) + assertTrue(lines.indexOf(":direct") < lines.lastIndex) + } + + @Test fun activationPayloadsSurviveTheHexHop() { + val bytes = byteArrayOf(0, 1, 0x7f, -1, -128, 42) + assertEquals("00017fff802a", UbisoftActivation.hex(bytes)) + assertArrayEquals(bytes, UbisoftActivation.unhex("00017fff802a")) + assertNull(UbisoftActivation.unhex("abc")) + } +} diff --git a/app/src/test/java/com/droiddeck/launcher/ui/BottomDashboardTest.kt b/app/src/test/java/com/droiddeck/launcher/ui/BottomDashboardTest.kt index 90f39c2c5a..4598643681 100644 --- a/app/src/test/java/com/droiddeck/launcher/ui/BottomDashboardTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/ui/BottomDashboardTest.kt @@ -16,7 +16,7 @@ class BottomDashboardTest { } @Test fun withNothingPickedTheStatsOpen() { - val ids = listOf("telemetry", "downloads", "notifications", "screenshots", "chat") + val ids = listOf("telemetry", "downloads", "screenshots", "chat") assertEquals("telemetry", pickBottomPage(null, ids)) assertEquals("telemetry", pickBottomPage("gone", ids)) assertEquals("chat", pickBottomPage("chat", ids)) diff --git a/app/src/test/java/com/droiddeck/launcher/ui/InputSettingsTest.kt b/app/src/test/java/com/droiddeck/launcher/ui/InputSettingsTest.kt index 679655d20b..8def5601a4 100644 --- a/app/src/test/java/com/droiddeck/launcher/ui/InputSettingsTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/ui/InputSettingsTest.kt @@ -383,9 +383,10 @@ class InputSettingsTest { @Test fun elementPropertiesEditOpacityLabelsAndOfferImages() { val element = mutableStateOf(InputSurfaceElement(InputControl.A, .1f, .1f, .2f, .2f, "custom", name = "Custom button")) + val action = mutableStateOf(null) compose.setContent { DroidDeckTheme { androidx.compose.foundation.layout.Column(androidx.compose.ui.Modifier.verticalScroll(androidx.compose.foundation.rememberScrollState())) { - InputElementProperties(element.value) { element.value = it } + InputElementProperties(element.value, action.value) { element.value = it } } } } compose.onNodeWithTag("setting-element-opacity").performScrollTo().performSemanticsAction(androidx.compose.ui.semantics.SemanticsActions.SetProgress) { it(60f) } @@ -399,6 +400,17 @@ class InputSettingsTest { compose.runOnIdle { element.value = InputSurfaceElement(InputControl.LEFT_PAD, .1f, .1f, .4f, .4f, "pad", InputElementKind.TRACKPAD, "Pad") } compose.onNodeWithTag("setting-element-label").assertDoesNotExist() compose.onNodeWithTag("setting-element-opacity").assertExists() + for (kind in listOf(InputElementKind.DPAD, InputElementKind.STICK)) { + compose.runOnIdle { element.value = InputSurfaceElement(kind.control, .1f, .1f, .4f, .4f, "imported:0", kind, "WASD"); action.value = InputAction.Directions(17, 32, 31, 30) } + compose.onNodeWithTag("setting-element-label").performScrollTo().performClick() + compose.runOnIdle { assertFalse(element.value.showLabel); action.value = InputAction.Native() } + compose.onNodeWithTag("setting-element-label").assertDoesNotExist() + compose.runOnIdle { action.value = InputAction.Directions(0, 0, 0, 0, listOf(16, 18, 44, 46)) } + if (kind == InputElementKind.STICK) compose.onNodeWithTag("setting-element-label").assertExists() + else compose.onNodeWithTag("setting-element-label").assertDoesNotExist() + } + compose.runOnIdle { element.value = InputSurfaceElement(InputControl.LS, .1f, .1f, .4f, .4f, "legacy:left-stick", InputElementKind.STICK, "Move") } + compose.onNodeWithTag("setting-element-label").assertExists() } @Test fun editorScalesEveryControlAndRestoresStockPositions() { @@ -421,6 +433,23 @@ class InputSettingsTest { compose.runOnIdle { assertEquals(layout.elements, InputLibraries.read(context).layouts.first { it.id == layout.id }.elements) } } + @Test fun editorSnapChoiceIsRemembered() { + com.droiddeck.launcher.input.ControllerPrefs.setSnap(context, true) + val library = InputLibraries.read(context) + val layout = library.layout("game", InputRole.SECONDARY)!! + val round = mutableStateOf(0) + compose.setContent { DroidDeckTheme { androidx.compose.runtime.key(round.value) { InputSurfaceDialog("game", {}, {}, role = InputRole.PRIMARY, + layoutId = layout.id, bindingsId = library.profile("game").binding(InputRole.SECONDARY)) } } } + val snap = isToggleable() and hasAnySibling(hasText(context.getString(R.string.ctrl_editor_snap))) + compose.onNodeWithTag("input-editor-tools").performClick() + compose.onNode(snap).performScrollTo().assertIsOn().performClick() + compose.runOnIdle { assertFalse(com.droiddeck.launcher.input.ControllerPrefs.snap(context)) } + compose.runOnIdle { round.value = 1 } + compose.onNodeWithTag("input-editor-tools").performClick() + compose.onNode(snap).performScrollTo().assertIsOff() + com.droiddeck.launcher.input.ControllerPrefs.setSnap(context, true) + } + @Test fun quickButtonTogglesHideBuiltInButtonsWithoutDeletingThem() { compose.setContent { DroidDeckTheme { InputSettingsPage({}) } } compose.onNodeWithTag("input-profile-game").performScrollTo().performClick() diff --git a/app/src/test/java/com/droiddeck/launcher/ui/InputSurfaceViewTest.kt b/app/src/test/java/com/droiddeck/launcher/ui/InputSurfaceViewTest.kt index 48616c03a5..6bf1d9ddaf 100644 --- a/app/src/test/java/com/droiddeck/launcher/ui/InputSurfaceViewTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/ui/InputSurfaceViewTest.kt @@ -58,6 +58,16 @@ class InputSurfaceViewTest { } finally { root.removeAllViews(); bridge.stop(); controller.pause().stop().destroy() } } + @Test fun keyedDirectionsAreLabelledWithTheirKeysAndOtherActionsAreNot() { + val context = RuntimeEnvironment.getApplication() + val wasd = InputAction.Directions(17, 32, 31, 30, listOf(18, 0, 0, 16)) + assertEquals(listOf((0f to -1f) to "W", (1f to 0f) to "D", (0f to 1f) to "S", (-1f to 0f) to "A"), + InputSurfaceView.directionLabels(context, wasd, cardinalOnly = true)) + assertEquals(listOf("W", "D", "S", "A", "E", "Q"), InputSurfaceView.directionLabels(context, wasd, cardinalOnly = false).map { it.second }) + assertEquals(listOf("W", "A"), InputSurfaceView.directionLabels(context, InputAction.Directions(17, 0, 0, 30), cardinalOnly = false).map { it.second }) + assertTrue(InputSurfaceView.directionLabels(context, null, cardinalOnly = false).isEmpty()) + } + @Test fun takesTouchAtMatchesWhatATouchDoes() { val directory = Files.createTempDirectory("deck-panel").toFile() try { diff --git a/app/src/test/java/com/droiddeck/launcher/ui/SecondScreenBarTest.kt b/app/src/test/java/com/droiddeck/launcher/ui/SecondScreenBarTest.kt index 8a16a55e0b..4779843153 100644 --- a/app/src/test/java/com/droiddeck/launcher/ui/SecondScreenBarTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/ui/SecondScreenBarTest.kt @@ -99,7 +99,7 @@ class SecondScreenBarTest { } finally { panel.closeControls() } } - @Test fun deckPanelHasTheBarWithSwapAndTabsAndProfileControlsStayFullScreen() { + @Test fun deckPanelHasTheBarWithSwapAndTabsAndProfileControlsKeepTheBar() { SessionState.mode = SessionService.MODE_STEAM SessionState.deckPad = true var swaps = 0 @@ -116,8 +116,14 @@ class SecondScreenBarTest { assertEquals(DeckPanel.entries.map { context.getString(it.label) }, bar.tabs!!.labels) assertEquals(DeckPanel.BOTH.ordinal, bar.tabs!!.selected) panel.showMode(SecondScreenMode.CUSTOM_CONTROLS) - assertNull(panel.barModel(SecondScreenMode.CUSTOM_CONTROLS)) - assertTrue(rootChildren(panel)[0] is InputSurfaceView) + val profile = panel.barModel(SecondScreenMode.CUSTOM_CONTROLS)!! + assertEquals(context.getString(R.string.input_profile_controls_mode), profile.title) + assertEquals(listOf(context.getString(R.string.swap_screens)), profile.extras.map { it.description }) + assertNotNull(profile.onClose); assertNotNull(profile.onMenu) + profile.extras.single().onClick() + assertEquals(2, swaps) + assertTrue(rootChildren(panel)[0] is ComposeView) + assertTrue(rootChildren(panel)[1] is InputSurfaceView) } finally { panel.closeControls() } val noSwap = presentation(swap = null) try { @@ -221,6 +227,47 @@ class SecondScreenBarTest { compose.onNodeWithTag("bottom-bar-close").assertIsDisplayed() } + @Test fun swappedTopScreenProfileControlsHaveTheBarWithSwap() { + SessionState.mode = SessionService.MODE_STEAM + val activity = Robolectric.buildActivity(SessionActivity::class.java).get() + ReflectionHelpers.getField>(activity, "secondScreenMode\$delegate").value = SecondScreenMode.CUSTOM_CONTROLS + val method = SessionActivity::class.java.getDeclaredMethod("SwappedTopPanel", androidx.compose.runtime.Composer::class.java, Int::class.javaPrimitiveType) + method.isAccessible = true + compose.setContent { DroidDeckTheme { method.invoke(activity, currentComposer, 0) } } + compose.onNodeWithText(context.getString(R.string.input_profile_controls_mode)).assertIsDisplayed() + compose.onNodeWithContentDescription(context.getString(R.string.swap_screens)).assertIsDisplayed() + compose.onNodeWithTag("bottom-bar-close").assertIsDisplayed() + } + + @Test fun theBottomPanelWaitsUnderAnOpenInputEditorAndReturnsWhenItCloses() { + SessionState.mode = SessionService.MODE_STEAM + val id = org.robolectric.shadows.ShadowDisplayManager.addDisplay("w1280dp-h960dp") + val activity = Robolectric.buildActivity(SessionActivity::class.java).get() + val displays = activity.getSystemService(DisplayManager::class.java) + org.robolectric.Shadows.shadowOf(displays.getDisplay(id)).setFlags(Display.FLAG_PRESENTATION) + ReflectionHelpers.setField(activity, "displayManager", displays) + ReflectionHelpers.setField(activity, "started", true) + ReflectionHelpers.getField>(activity, "selectedSecondScreenDisplay\$delegate").value = id + val mode = ReflectionHelpers.getField>(activity, "secondScreenMode\$delegate") + mode.value = SecondScreenMode.KEYBOARD_TRACKPAD + fun panel() = ReflectionHelpers.getField(activity, "secondScreenPresentation") + fun show() = ReflectionHelpers.callInstanceMethod(activity, "showSecondScreen", + ReflectionHelpers.ClassParameter.from(SecondScreenMode::class.java, SecondScreenMode.KEYBOARD_TRACKPAD)) + activity.inputWindowShown(Display.DEFAULT_DISPLAY) + activity.inputWindowShown(id) + activity.inputWindowShown(id) + show() + assertNull(panel()) + assertEquals(SecondScreenMode.KEYBOARD_TRACKPAD, mode.value) + activity.inputWindowClosed(id) + assertNull(panel()) + activity.inputWindowClosed(id) + try { + assertEquals(id, panel()!!.display.displayId) + assertTrue(panel()!!.isShowing) + } finally { panel()?.closeControls() } + } + @Test fun unfoldedControlsGetTheSessionBar() { SessionState.mode = SessionService.MODE_STEAM val activity = Robolectric.buildActivity(SessionActivity::class.java).get() diff --git a/app/src/test/java/com/droiddeck/launcher/ui/SessionSecondScreenTest.kt b/app/src/test/java/com/droiddeck/launcher/ui/SessionSecondScreenTest.kt index 12098a566b..dc2ff1cc6c 100644 --- a/app/src/test/java/com/droiddeck/launcher/ui/SessionSecondScreenTest.kt +++ b/app/src/test/java/com/droiddeck/launcher/ui/SessionSecondScreenTest.kt @@ -376,7 +376,7 @@ class SessionSecondScreenTest { isHomeApp = false, androidApps = emptyList(), hudOn = false, micAvailable = micAvailable, micEnabled = micEnabled, onMicEnabled = onMic, frameGen = FrameGen.Mode.OFF, lossless = Lossless.State.NONE, oscMode = "never", - onScreenButtonsVisible = false, suspendPolicy = "auto", backActionsInverted = false, + suspendPolicy = "auto", backActionsInverted = false, touchMode = "auto", touchAuto = "trackpad", fexPreset = "default", secondScreenMode = SecondScreenMode.NONE, secondScreenDisplays = displays, selectedSecondScreenDisplay = 1, onHud = {}, onFrameGenPick = {}, onImportLossless = {}, onKeyboard = {}, onHardwareKeyboard = {}, diff --git a/docs/development/ea-store.md b/docs/development/ea-store.md new file mode 100644 index 0000000000..89a345c80f --- /dev/null +++ b/docs/development/ea-store.md @@ -0,0 +1,31 @@ +# EA store + +EA games install, update and start without the EA app. The research behind it is in +[ea-ubisoft-stores.md](ea-ubisoft-stores.md). + +## Pieces + +| Piece | Where | What it does | +|---|---|---| +| Sign-in | `stores/ea/EaAuth.kt`, `EaLogin` in `EaBackend.kt` | `JUNO_PC_CLIENT` OAuth with PKCE in the store login WebView; the code comes back on EA's `qrc:///html/login_successful.html` redirect. Tokens refresh with the refresh token. | +| Library | `EaApi.kt`, `EaLibrary.kt` | Owned games (`getPreloadedOwnedGames`, EA storefront), their offers (`getLegacyCatalogDefs`) and art (`GameImages`, SteamGridDB when EA has no portrait). Editions of one game collapse onto the base offer; trials, DLC and non-downloadable offers are left out. | +| Queries | `app/src/main/resources/ea/graphql/*.gql` | EA's own query texts, byte for byte. The gateway matches persisted queries by SHA-256, so these files must not be reformatted (`-text` in `.gitattributes`). | +| Downloads | Rust `src/ea/` in `libdroiddeckstores.so`, `EaInstaller.kt` | A build is one ZIP on EA's CDN. The engine reads its central directory with ranged reads, keeps files whose size and CRC match, and streams every other entry through inflate into place. `.droiddeck-ea-files` records what it placed, so a resume or update does not re-hash those files; files a new build drops are removed. | +| Updates | `EaUpdates` in `EaBackend.kt` | The game page compares the installed version with the offer's live `gameVersion` (every 30 minutes at most). Update runs the same install, which only fetches changed files. | +| Launch, guest | `droiddeck-store-launch` (`prepare_ea`) | Creates the prefix, reads the machine as Wine reports it (`wmic`, `vol`, `hostname`; cached in `pfx/.droiddeck-ea-hw.json`), writes EA app presence keys and the game's `Install Dir` keys in both registry views, runs the build's Touchup once per installed build, then asks the app for the session and writes any licence files. | +| Launch, app | `EaLaunch.kt`, `EaOoa.kt`, `EaLsx.kt` | Answers `ea-prepare`: starts the LSX endpoint on `127.0.0.1:3216`, mints the short-lived opaque token, writes `.droiddeck-ea-env` (read once and deleted by the launcher `.bat`), and for games with a `Core` folder requests an online-activation licence for the machine hash. | +| LSX | `EaLsx.kt` | The local endpoint EA's SDK talks to instead of the EA app: challenge, AES session key, config, profile, settings, game info, auth codes for the game's own client ids, licences with Denuvo tokens, entitlements. Friends, presence and the overlay answer empty. | + +## Machine hash + +The licence names a hash of the machine the game's activation layer computes itself. The hash +version follows the activation library's product version (`Core/activation.dll` or `awc.dll`): +5.x → 4, 4.7.6+ → 3, 4.7.x → 2, 4.x → 1. Versions 2 and 3 also need CPUID leaf 1 ECX, which Wine's +WMI does not expose, so those use `00000000` unless the probe learns it. + +## Not done yet + +- Cloud saves (`cloudsync.juno.ea.com`). +- Steam copies of EA games still install the EA app (#2036). +- Pre-DiP games (no `installerdata.xml`) fall back to the exe picker. +- Javelin anti-cheat games do not run under Proton. diff --git a/docs/development/ea-ubisoft-stores.md b/docs/development/ea-ubisoft-stores.md new file mode 100644 index 0000000000..4d13710a3d --- /dev/null +++ b/docs/development/ea-ubisoft-stores.md @@ -0,0 +1,245 @@ +# EA app and Ubisoft Connect as stores: research and plan + +Research as of 2026-11-07, against `origin/main` at `914b3588e`. Nothing here is implemented yet. + +## Summary + +Both stores can follow the path Battle.net took (#979, then #1602): first the vendor client in its own +Proton prefix, then more of it done by DroidDeck itself. Unlike Battle.net, both now have open-source +clients that already handle sign-in, library and downloads without the vendor app. So the second step +can go further than Battle.net's did. + +| | EA | Ubisoft | +|---|---|---| +| Sign-in without the client | Yes: OAuth `JUNO_PC_CLIENT` in a WebView | Yes: UbiServices session (ticket + remember-me) through Ubisoft's WebAuth page | +| Owned library without the client | Yes: juno GraphQL `ownedGameProducts` | Yes: Demux ownership service (protobuf over TLS), or the GraphQL library | +| Downloads without the client | Yes: a build is one ZIP on EA's CDN, read with HTTP Range per entry (Maxima) | Yes: Demux download service → manifest → zstd/deflate slices (Optima, ubi-cli-mvp) | +| Launch without the client | **Yes, legitimately**: LSX server on `127.0.0.1:3216` plus a real OOA licence from `proxy.novafusion.ea.com` (Maxima) | **Only by replacing Ubisoft's DRM DLLs** (Optima, Re0xCat loaders). Don't ship that. Modern titles need the real Connect anyway | +| Cloud saves without the client | Yes: `cloudsync.juno.ea.com` (Maxima) | Not researched; Connect handles them | +| Effectively out of scope | Javelin kernel anti-cheat titles (Battlefield, FC, Apex) | Kernel AC and online-only titles that misbehave under Proton | + +**Recommendation** + +- **EA should go fully native in-app**: sign-in, library, downloads, launch and cloud saves in Kotlin + and Rust, with no EA app in the prefix. The EA app stays as an optional fallback, like the Epic + launcher option (`EpicClient`). The LSX and licence half also fixes Steam's EA titles, which today + install the whole EA app (#2036) just to answer `link2ea://`. +- **Ubisoft should be hybrid**: native sign-in, library and downloads in Rust, then **register the + files with the real Ubisoft Connect and launch through `uplay://`**. That means a Connect prefix + managed the way Battle.net's is. +- Ubisoft's launch step is the biggest open question (see "Unknowns"). If Connect can't be made to + adopt natively downloaded files cleanly, start with the Connect-driven download, as #979 did for + Battle.net. + +## What DroidDeck already has, and how much of it each store reuses + +| Existing piece | Where | EA | Ubisoft | +|---|---|---|---| +| `Store` enum + `StoreBackend` (signIn, syncLibrary, loadShelves, install, uninstall) | `stores/Store.kt`, `stores/StoresState.kt:355` | Reuse as is: new `EA` entry | Reuse as is: new `UBISOFT` entry | +| WebView sign-in with redirect capture (`StoreLoginActivity.Flow`) | `stores/LoginFlows.kt`, `StoreLoginActivity.kt` | Reuse: the redirect is `qrc:///html/login_successful.html?code=…`, caught in `isRedirect` | Reuse: capture the `ubi_v1` ticket from the WebAuth page, then exchange it for a full session | +| Keystore-backed account store | `stores/StoreAccounts.kt`, `CredentialCipher.kt` | Reuse | Reuse | +| Rust store engine `libdroiddeckstores.so` (JNI, `fetch_core.rs`, hand-rolled protobuf in `amazon/proto.rs`) | `app/src/main/rust/stores` | Reuse: ZIP central directory + Range fetch + inflate (`flate2` is already a dependency) | Reuse `fetch_core`. **New:** a TLS socket client for Demux, a protobuf schema, and a zstd decoder (`ruzstd` is pure Rust; the `zstd` crate needs `cc`, which the crate already has) | +| Download queue: pause, resume, cancel, tiers, Downloads tab | `stores/download/*` | Reuse | Reuse | +| Install roots: internal, other storage, Games folder | `StoreInstallRoot.kt` | Reuse | Reuse | +| Cloud saves: plan, paths, transport | `stores/CloudSaves.kt`, `CloudPlan.kt`, `CloudSavePaths.kt` | Reuse with a new EA transport | Later, or leave to Connect | +| Vendor client in its own prefix, a guest Python driver, a headless helper under gamescope, FEX choice, memory policy | `runtime/BattleNet.kt`, `tools/linuxfs/overlay/usr/local/bin/droiddeck-battlenet` | Fallback only | **Needed**: `droiddeck-ubisoft` modelled on `droiddeck-battlenet` | +| "Use the vendor launcher instead" option | `stores/epic/EpicClient*.kt` | Pattern for the EA app fallback | Pattern for "Open Ubisoft Connect" | +| Steam install-script seeding that lets EA app and Ubisoft Connect installers run | `droiddeck-seed-redists` (#1449, #2036) | Replaced by the LSX stub for Steam EA titles | Unchanged | +| Ubisoft registry handoff for Ubisoft titles bought on Epic | open PR #1445 | n/a | Same registry key (`HKLM\SOFTWARE\WOW6432Node\Ubisoft\Launcher\Installs\\InstallDir`); merge or share it | +| Library, Steam shortcuts, art, game page, sidecars | `frontend/Library.kt`, `SteamLiveShortcuts.kt`, `StoreArt.kt`, `StoreGameSidecar.kt` | Reuse | Reuse | +| Clean-room process for store modules | `docs/development/epic-cleanroom.md`, `amazon-cleanroom.md` | Use: spec from Maxima, then implement from the spec | Use: spec from Optima/ubi-cli-mvp/YoobieRE | + +Genuinely new engineering: + +1. **An LSX server (EA).** EA's local SDK protocol is XML over TCP on 3216, with a challenge handshake, + GetConfig, GetProfile, GetGameInfo, license and entitlement requests. Add a Wine-side stub registered + as the `link2ea://` / `origin2://` handler with EA app presence keys, plus OOA licence requests. + This half is new; the other EA parts are the familiar store pattern. +2. **The EA machine hash.** Licences are bound to a `machineHash` built from WMI/BIOS/disk/CPUID + values. They have to match what the game computes inside Wine under FEX on the phone. + Nobody has shown that on Android yet, so it has to be measured on device. +3. **A Demux client (Ubisoft).** This is a TLS socket to `dmx.upc.ubisoft.com` speaking protobuf, with + patch negotiation, auth, ownership tokens and download-service URL signing. No store we have uses + a socket protocol. +4. **A way for Connect to adopt files (Ubisoft).** Connect keeps its own DPAPI-encrypted sign-in, tied + to the Wine `MachineGuid`. Our session can't be handed to it (ubi-cli-mvp checked). Connect also has + to consider the game installed before `uplay://launch` works. + +## Prior art + +### EA + +| Project | Licence | State | What it gives us | +|---|---|---|---| +| [ArmchairDevelopers/Maxima](https://github.com/ArmchairDevelopers/Maxima) (Rust, `maxima-lib`) | GPL-3.0 | Pre-alpha by its own README; last commit 2026-01; open issues through 2026-11. Backs KYBER | The whole stack: OAuth (`JUNO_PC_CLIENT`, localhost 31033 redirect), juno GraphQL (`.gql` files for owned games, `downloadUrl`, `availableBuilds`, achievements), the ZIP/Range downloader, OOA licences (`ooa/mod.rs`, `machineHash`), the LSX server (`lsx/`), cloud sync, the hardware hash (`auth/hardware.rs`), Wine registry setup. Unsupported: Battlefield 3/4 (Battlelog), pre-DiP games (Dead Space 2, BFBC2), DLC installs | +| [Maxima #71](https://github.com/ArmchairDevelopers/Maxima/issues/71) | | 2026-11 | Games never connect to LSX unless `HKLM\SOFTWARE\WOW6432Node\Origin` is right, and `INSTALLED_LANGUAGE` must be answered. Check ours against it | +| [Maxima #49](https://github.com/ArmchairDevelopers/Maxima/issues/49) | | | ARM64: the hash must match what `Activation.dll` reads from CPUID under Rosetta/Box64/FEX. Directly our problem | +| unifideck `docs/feasibility/ea.md` | GPL-3.0 | 2026-07 | EA app installer runs unattended (`/quiet`), login renders on GE-Proton11-1, `origin2://game/launch?offerIds=&autoDownload=1` is the install idiom, ~2.5 GB client, aggressive self-update | +| Lutris `services/ea_app.py` | GPL-3.0 | Maintained | juno queries, `installerdata.xml` scan for installed games | +| BellezaEmporium/galaxy-integration-ead | **none** | Maintained | Facts only: OAuth params, `pc_sign` fallback | +| erri120/GameFinder wiki | GPL-3.0 | | Encrypted `IS` file format (only for reading EA app installs) | +| Heroic | | wontfix #352 | No EA support beyond Epic-hosted EA titles | + +### Ubisoft + +| Project | Licence | State | What it gives us | +|---|---|---|---| +| [xXJSONDeruloXx/ubi-cli-mvp](https://github.com/xXJSONDeruloXx/ubi-cli-mvp) (yours, TypeScript) | MIT | 2026-07 | The best-tested data plane: session login with `Ubi-Challenge` replay, `ubi_2fa_v1`, refresh; Demux ownership, ownership tokens and signed URLs; manifest decode; slice layouts (`slices_v3//` and flat `slices/`); zstd and both deflates; integrity and path safety. On the Connect side: `connect-install` (`uplay://install/`), **`connect-seed`** (let Connect start the official download, pause, exit, then fill the staging area with verified files), remembered-auth migration between prefixes, `ubi play` via `uplay://`. Docs: `research.md`, `validation.md`, `DEMUX_JOURNAL.md`, `optima-comparison.md` | +| [Starkka15/Optima](https://github.com/Starkka15/Optima) (Rust) | GPL-3.0 | 0.2.0, 2026-08 | Rust version of the same data plane (`auth.rs`, `demux.rs`, `install.rs`, `proto/*.proto`), plus launcherless launch through replacement `uplay_r1_loader` / `ubiorbitapi_r2_loader` DLLs, a self-signed certificate that mimics Ubisoft's (imported into the prefix's Root store so Watch_Dogs accepts it), and an EAX shim. Powers GameVault's Ubisoft extension | +| YoobieRE: `ubisoft-demux-node`, `ubisoft-dmx-decode`, `ubisoft-manifest-downloader`, `uplay-install-reverse`, `product-db-archive` | mixed or none | 2022–2024 | The original protocol reversing that both of the above build on | +| Re0xCat `uplay-r1-loader`, `ubiorbitapi-r2-loader` | | | The DRM-DLL replacements (see Risks) | +| [mubaraknumann/unifideck](https://github.com/mubaraknumann/unifideck) `stores/ubisoft/` | GPL-3.0 | Shipping, active | The full Connect-wrapper archetype in Python: three-prefix model (auth / template / per-game, shared `MachineGuid`), credential capture and fan-out, parsing Connect's binary `configurations` and `ownership` catalogs, leveldb `spaceId ↔ ubisoftConnectGameId`, a manual-install watcher, `uplay://launch//0`, session capture after exit. `docs/ubisoft-store-spec.md` is a good map of what breaks | +| Heroic | | | Installs Ubisoft Connect automatically for Ubisoft titles from Epic; no Ubisoft store | +| DroidDeck #1445 (open), #1449, #2286 / #2295 / #2317 / #2292 / #2050 | | | Our own Ubisoft-under-Proton knowledge: the `Installs` registry key, `UplayLaunch.exe` being a stub, the bundled `UplayInstaller.exe`, legacy installer layouts, SD-card staging, helper processes during the exit watch | + +Licences: Maxima, Optima, unifideck and Lutris are GPL-3.0, which is compatible with +DroidDeck (GPL-3.0). ubi-cli-mvp is MIT. Even so, the Epic and Amazon modules were written clean-room, +so do the same here: write the spec from these sources, implement from the spec, and credit them in +the README the way #1602 does. + +## Design + +### EA + +```text +StoreLoginActivity (OAuth JUNO_PC_CLIENT) ─► EaAccount (access + refresh token, persona) +EaLibrary ── juno GraphQL ownedGameProducts / legacyOffers ─► CatalogItem(offerId, contentId, slug) +EaInstaller (DownloadQueue job) ── downloadUrl ─► build ZIP ─► Rust: central directory, Range per entry, inflate, CRC + └─ writes __Installer/installerdata.xml as EA's own layout expects +Launch: droiddeck-ea (guest) ── registers stub for link2ea:// origin2:// + Origin/EA Desktop keys + app-side EaLsxServer on 3216 ◄── game (OriginSDK / EA SDK) + before launch: OOA licence (novafusion, machineHash) → ProgramData/Electronic Arts/EA Services/License + before/after: cloudsync pull / push through CloudSaves +``` + +- **Where the LSX server runs.** In the Android app. DroidDeck's guest shares + the network namespace, so an app-side server on 127.0.0.1:3216 is reachable from Wine. Keeping it + in Kotlin or Rust, not a guest daemon, matches how DroidDeck owns other store logic. Check this + against proot networking first. +- **The stub.** A protocol handler for `link2ea://` / `origin2://` that hands the request to DroidDeck. +- **Steam's EA titles.** Use the same stub and LSX path, keyed by `link2ea://` in the launch config, + plus entitlement refresh and Steam account linking. #2036's EA app install becomes + the fallback. +- **The EA app fallback.** Its own prefix (a `compatdata` id like Battle.net's `2596113170`), installed + with `EAappInstaller.exe /quiet`, opened from the store row. That's for titles the LSX path can't + start (pre-DiP, Battlelog) and for buying games. + +### Ubisoft + +```text +StoreLoginActivity (Ubisoft WebAuth) ─► ticket ─► full session (expiry, rememberMe); refresh ~3 h +UbisoftLibrary ── Demux ownership ─► products + config YAML (name, exe, uplay id, space id) +UbisoftInstaller (DownloadQueue job) ── Rust Demux: ownership token → download_service urlReq + → manifest (356-byte header, zlib) → slices (zstd/deflate) → files, verified +Register + launch: droiddeck-ubisoft (guest, like droiddeck-battlenet) + Connect in its own prefix, signed in once in its own window (DPAPI/MachineGuid bound) + adopt files: Installs\\InstallDir registry (+ whatever state Connect checks) + or ubi-cli-mvp's connect-seed: official download starts, pause, seed, let Connect verify + launch: upc.exe uplay://launch//0, Connect closed or minimised once the game runs (#979's 20 s rule) +``` + +- **One Connect prefix, not one per game.** unifideck uses per-game prefixes because Steam on the + Deck gives each shortcut its own. DroidDeck already runs Battle.net games inside Battle.net's prefix, + which avoids unifideck's whole credential fan-out problem. +- **Two stages, like Battle.net:** + 1. Connect in its prefix, install by `uplay://install/`, and Downloads shows an indeterminate + "Installing in Ubisoft Connect" until the folder settles. That is #979's level. + 2. Native downloads in the Rust engine with real progress, pause and resume, then Connect adopts the + files. Like #1602, but we own the transfer instead of driving the vendor's downloader. If Connect + has a scriptable local API (Battle.net's Agent had one), that's a cheaper middle stage, but none is + known. +- **Launcherless DRM shims: don't ship them.** See Risks. + +## Known + +- EA sign-in, library, downloads, licences, LSX and cloud sync all work outside the EA app on Linux + (Maxima). +- The EA app installs unattended and its login renders under GE-Proton 11 on x86 (unifideck). +- Ubisoft sign-in, refresh, Demux ownership, signed URLs, manifests and slice reconstruction work + (ubi-cli-mvp `validation.md`, Optima). A session ticket lasts about 3 hours and remember-me renews it. +- Connect's sign-in can't be created from our session. It is DPAPI-encrypted and tied to + `MachineGuid`, but it can be copied between prefixes that share that identity. +- Connect has repeatedly broken under Proton after its own updates (2023, and a single-source April 2026 + report). #1449 and the open Ubisoft PRs show the same churn here. +- Javelin titles don't run under Proton. EA's March 2026 job listing mentions future Linux/Proton work; + nothing has shipped. + +## Unknowns, in the order to settle them + +| # | Question | How to find out | Blocks | +|---|---|---|---| +| U1 | Does an EA OOA licence fetched with our `machineHash` validate inside DroidDeck-Proton under FEX on Adreno phones? Which WMI/CPUID values does the game see? | Prototype: Maxima's hash code against values read through Wine in our prefix; one DiP single-player title and one Denuvo title. | EA launch | +| U2 | Can the app-side LSX server on 127.0.0.1:3216 be reached from proot + Wine, and do games connect with our registry keys (Maxima #71)? | Spike with a Steam EA title already in the library | EA launch, Steam EA titles | +| U3 | What does EA's CDN serve for a current title: one ZIP, multiple, or delta? How do language selection and `installerdata.xml` work? | Maxima `content/` + `downloadUrl.gql`, one real download through the Rust engine | EA install | +| U4 | Does Connect accept a tree we downloaded once the `Installs` registry key is written, or does it re-verify or re-download? Does `connect-seed` work under FEX on a phone? | Spike with a small owned title (ubi-cli-mvp used Splinter Cell / product 109). #1445's registry work is the start | Ubisoft stage 2 | +| U5 | Does Ubisoft Connect (Qt + CEF) run acceptably under FEX in our prefix? How much RAM does it hold while a game runs? | Install it like Battle.net; measure with the Memory readout from #979 | Ubisoft stage 1 | +| U6 | Ubisoft's WebAuth page in an Android WebView: captcha, 2FA, `Ubi-Challenge` | Real sign-in on device | Ubisoft sign-in | +| U7 | Demux over TLS from Android (certificate pinning, patch-version negotiation drift) | Rust spike against `dmx.upc.ubisoft.com` | Ubisoft library and downloads | +| U8 | Ubisoft+ subscription entitlements in Demux ownership | Account with Ubisoft+ | Library completeness | +| U9 | EA Play subscription entitlements in `ownedGameProducts` | Account with EA Play | Library completeness | +| U10 | Ubisoft cloud saves outside Connect | Not researched; Connect handles them while it's in the path | Later | + +## Plan + +Each step is its own PR, tested on device as usual (REDMAGIC tablet, Fold7, Thor). + +### EA + +1. **Spike (no PR):** settle U1–U3 with throwaway code against one owned DiP title and one Steam EA title. +2. **Steam EA titles without the EA app:** the `link2ea` stub, app-side LSX server, OOA licence and + entitlement refresh. It replaces #2036's EA app install where it works and falls back to it otherwise. + This ships value first and proves the hard half. +3. **EA store: sign-in, library, shelves:** a `Store.EA` entry, OAuth flow, juno library, art, + a "not installable here" flag for Javelin titles. +4. **EA downloads:** a Rust `ea` module (ZIP/Range/inflate on `fetch_core`), with Downloads progress, + pause, resume, cancel, updates and uninstall. +5. **EA cloud saves** through `CloudSaves`. +6. **EA app fallback** prefix and store-row button, for pre-DiP and Battlelog titles. +7. Clean-room record: `docs/development/ea-cleanroom.md`. + +### Ubisoft + +1. **Spike (no PR):** U4, U5 and U7. +2. **Ubisoft Connect in its prefix (#979 level):** `droiddeck-ubisoft`, the store row, sign-in inside + Connect, the installed-games scan (registry `Installs` keys), Play by `uplay://launch`, Connect closed + once the game runs, install handed to Connect with indeterminate progress. Fold in #1445. +3. **Ubisoft store sign-in and library natively:** the WebAuth flow, session refresh, a Rust Demux + client, the owned library and art, without opening Connect. +4. **Native Ubisoft downloads:** a Rust `ubisoft` module (manifest, slices, zstd), then hand off to + Connect for registration (U4). Updates come from the manifest version. +5. Clean-room record: `docs/development/ubisoft-cleanroom.md`. + +The two stores share almost nothing beyond the existing store layer, so they can run in parallel. +EA step 2 has the best ratio of value to risk and could start first. + +## Risks + +- **DRM circumvention.** Optima's launcherless mode replaces Ubisoft's DRM loader DLLs, answers the + game's ownership calls itself, and installs a certificate mimicking Ubisoft's so Authenticode checks + pass. Gating it on real ownership doesn't change that it bypasses Ubisoft's access control. Keep it + out of DroidDeck. EA is different: Maxima requests real licences from EA's licence + service and speak EA's documented-by-reversing launcher protocol. Nothing is forged. +- **Terms of service.** Both publishers' terms broadly forbid unofficial clients. No bans are known + for Linux or alt-launcher users (Maxima, Lutris, unifideck, GameVault). This is the same position as + our Epic, GOG and Amazon modules. +- **Vendor churn:** juno schema changes (EA already killed the Origin-era integrations once), Demux + patch versions, and Connect or EA app updates that break under Proton. Plan for tests on recorded + responses, as Epic has. +- **Memory.** A resident Connect costs a phone RAM, so reuse #979's close-on-launch policy and zRAM work + (#1882). EA's native path avoids the client entirely. +- **FEX hardware fingerprint (EA, U1)**, if FEX's CPUID differs from what licences are bound to. +- **Kernel anti-cheat:** Javelin, and whatever Ubisoft titles use one. Flag them in the catalog + instead of letting launches fail. + +## Sources + +- DroidDeck: #979, #1602, #1610, #1611, #1662, #2087 (Battle.net); #1449, #2036 (Steam Ubisoft/EA + installers); #1445, #2050, #2286, #2292, #2295, #2317 (Ubisoft); `docs/development/epic-cleanroom.md`. +- Maxima: README, `maxima-lib/src/{core/launch.rs, core/endpoints.rs, ooa/mod.rs, core/auth/*, content/*, lsx/*}`, issues #49, #71. +- Optima: README, `TODO-hardening.md`, `src/install.rs`, `src/launch.rs`. +- ubi-cli-mvp: README, `docs/optima-comparison.md`, `research.md`, `validation.md`. +- unifideck: `docs/feasibility/{README,ea,battlenet}.md`, `docs/ubisoft-store-spec.md`. +- [Heroic: Ubisoft Connect on Linux and Mac](https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher/wiki/How-to-install-Ubisoft-Connect-on-Linux-and-Mac). +- [GamingOnLinux: EA Javelin job listing mentions Linux and Proton (2026-03)](https://gamingonlinux.com/2026/03/ea-javelin-anticheat-job-listing-mentions-future-support-for-linux-and-proton). +- [GamingOnLinux: KYBER goes open source (2026-01)](https://www.gamingonlinux.com/2026/01/star-wars-battlefront-ii-private-server-and-mod-launcher-kyber-goes-open-source). +- [PC Gamer: Ubisoft's launcher broke Steam games on Linux and Steam Deck](https://www.pcgamer.com/ubisofts-launcher-broke-steam-games-on-linux-and-steam-deck). diff --git a/docs/development/stores.md b/docs/development/stores.md index 78855ea749..278c0cbd8d 100644 --- a/docs/development/stores.md +++ b/docs/development/stores.md @@ -244,6 +244,15 @@ self-extractor stops at "Path not found", so the values it installs are applied `witcher.exe` exits during startup. The language comes from the installed product's `goggame-.info`, and a script's own `setRegistry` entries always win over the built-in table. +The script's `supportData` actions run right after: files and folders from the game folder +(`{app}`) or its support files (`{supportDir}`, `support//`) are copied to `{userdocs}` and +`{localappdata}` in the prefix, and `type: folder` without a source creates the folder. Mods such +as one-click editions ship their `Plugins.txt` and INI files this way. Paths match without regard +to case, links are copied as links, and a path outside those folders is refused. A file the +player already has is replaced only when the action says `overwrite`. `.droiddeck-gog-support` in +the prefix holds the actions' hash, so they run once per script revision and a player's later +edits stay. + A GOG game's exe comes from its own manifest first: `goggame-.info`'s play task in category `game` (`isPrimary` first), or a primary `launcher` task for launcher games, whose `path` stays inside the folder; any other `goggame-*.info` in the folder supplies the task only when the diff --git a/docs/development/ubisoft-launch.md b/docs/development/ubisoft-launch.md new file mode 100644 index 0000000000..5c18429758 --- /dev/null +++ b/docs/development/ubisoft-launch.md @@ -0,0 +1,112 @@ +# Ubisoft launch without Ubisoft Connect + +A Ubisoft game never holds its own ticket. Its DRM loader opens Ubisoft's API DLL from the Connect +folder, and that DLL asks the running launcher for the session over local named pipes. DroidDeck +answers those pipes with `droiddeck-upc.exe`, a small Windows program that runs in the game's prefix. +The game and every Ubisoft DLL stay unmodified, and there is no Connect client, CEF or background +service. The session the game receives is real: its ticket comes from Ubisoft's ownership service for +the signed-in account. + +This file is the specification `tools/ubisoft-launcher` was written from. The facts come from the +protobuf descriptors embedded in Ubisoft's own `uplay_r1.dll` (`proto_uplaydll/UplayDll.proto`) and +from the public notes in [Foxtrot47/Ubisoft-Connect-RE](https://github.com/Foxtrot47/Ubisoft-Connect-RE) +(`docs/06-launch.md`, `docs/10-denuvo.md`). No code was taken from either. + +## Pieces + +| Piece | Where | Job | +|---|---|---| +| Ubisoft runtime | `C:\Program Files (x86)\Ubisoft\Ubisoft Game Launcher\` in the shared prefix | Ubisoft's own `uplay_r1(64).dll`, `uplay_aux_r1(64).dll`, `uplay_r2(64).dll`, `ubiorbitapi_r2(64).dll`, `UbisoftGameLauncher(64).exe`, the starter's imports (`discord-rpc.x86/x64.dll`, `steam_api(64).dll`) and `overlay(64).dll`. `droiddeck-store-launch` extracts exactly these 16 files with `7z` from the official `UbisoftConnectInstaller.exe`, then deletes the installer | +| Registry | `HKLM\Software\[Wow6432Node\]Ubisoft\Launcher` | `InstallDir` points at the runtime folder in both views; `Installs\\InstallDir` points at the game, with forward slashes and a trailing slash, as Connect writes it | +| Shared prefix | `compatdata/2929927072` | Every Ubisoft game runs here (`UbisoftConnect.launchOptions` sets `STEAM_COMPAT_DATA_PATH`), so the runtime is extracted once | +| Launch file | `/.droiddeck-ubisoft.json` | Written by `droiddeck-store-launch` before every launch from the app's `ubisoft-launch` answer: the account, the owned product ids, a fresh PC ticket, the entitlement's application id and the save folder. Removed first, so a failed refresh falls back to starting the game directly | +| Launcher | `/.droiddeck-launch.bat` | Runs `Z:\usr\local\lib\droiddeck-ubisoft\droiddeck-upc.exe ` when both exist | +| Tickets | app, Rust `ubisoft/service.rs` | Demux `ownership_service`: initialize (owned products), then `GetUplayPCTicketReq` (field 14) answered in field 13 `{1: success, 2: ticket}` | + +## Pipes + +All pipes are `\\.\pipe\terminal__`, where `` is +`ProcessIdToSessionId(GetCurrentProcessId())` (1 under Wine). They are byte-mode duplex pipes with +unlimited instances, created before the game starts. Every message is a 4-byte big-endian length +followed by a proto2 message, except on `uplay_service_ipc_pipe_`. + +| Pipe | Client | Exchange | +|---|---|---| +| `game_start_ipc_pipe_` | `UbisoftGameLauncher.exe` | `game_starter.Upstream{1:{1:{1: build, 2: product, 10: exe, 11: arguments, ...}}}` → `Downstream{2:{1:{1:0 (overlay off), 2:0, 3: / + "/" + , 4: /, 8:3, 9:{1:{1,113,0,1,0} 1:{3,123,0,0,0}}}}}` | +| `uplay_api_process_ipc_pipe_` | game | `Req.initProcessReq{1: product, 2: game pid, 5: env set}` → `Rsp.initProcessRsp(13){1:1, 3:0 (overlay off), 4:3, 6:0}`. Kept open. Answering it is what releases the starter (below). Far Cry 3 Blood Dragon sends only `{2: pid, 5:1}`; a missing pid is taken from the pipe's client process | +| `uplay_ipc_pipe_` | game (`uplay_r1.dll`, `uplay_r2.dll`) | `Req.initReq(1)` → `Rsp.initRsp(1)`, answered every time it is asked. `Req.installerReq(13)` with `initInstallerReq` → `Rsp.installerRsp(10){1:{1:1, 2:"", 3: language}}`. `Req.userReq(11).getCredentialsReq(1){1: id}` → `Rsp.userRsp(8).getCredentialsRsp(1){1: id, 2: username, 3: "" (password), 4: userId, 5: email}`. `Req.streamingReq(27)` → `Rsp.streamingRsp(20){1: id, 2:1, 4:{1:0}}` for the streaming type (not streamed), `{1: id, 2:4}` for any other streaming query | +| `uplay_aux_ipc_pipe_` | `uplay_aux_r1(64).dll` (Denuvo) | `{1: rid, 2: init}` → `{1: rid, 2:{1:1, 2: pid, 3:3367, 3:3368, 3:3962}}`; `{1: rid, 3:{2:{2: challenge}}}` → `{1: rid, 3:{2:{2:1, 3:0, 4: game token, 5:""}}}` | +| `uplay_service_ipc_pipe_` | Ubisoft helpers | Server sends `{3:{1:1, 3:{1: }}}` once, then only reads, unframed | +| `orbit_ipc_pipe_` | game (`ubiorbitapi_r2.dll`) | `mg.protocol.orbitdll` from the DLL's own `proto_orbitdll/OrbitDll.proto`. `Req{1: id, 12: init{1: product}}` → `Rsp{1: id, 12:{1: save folder, 2:1}}`; `getLoginDetails(2)` → `{1: username, 2:"", 3:""}`; `getOsi(3){1: sub}` → `{2:1}` (failed, no online-services pipe) | +| `upc_api_process_ipc_pipe_standard`, `uplay_protocol_ipc_pipe_`, `uplay_overlay_ipc_pipe_`, `uplay_crash_reporter_ipc_pipe_` | — | Held open, never answered | + +### The session (`InitRsp`) + +| Field | Value | +|---|---| +| 1 result | 1 (`InitResult_Success`) | +| 2 account | `{1: userId, 2: username, 3: nameOnPlatform, 4: email, 5: "" (password), 6: country}` | +| 3 connected | 1 | +| 4 gameUplayId | the product | +| 5 uplayIds | every owned product whose ownership entry is owned, of type 0 or 1, in state 0 or 3 | +| 6 gameCdKeys | `{1: product, 2: ""}` | +| 7 isInOfflineMode | 0 | +| 8 upcTicket | the PC ticket from `GetUplayPCTicket`, never the Denuvo token | +| 11, 12, 15, 16, 18, 19, 21, 23 | the values a real launch carries (`{1:0}`, 0, overlay `{1:0, 2:3}`, hardware score `{6211, 22395, 1.0f}`, empty, `{1:1, 2:1}`, `{2:1}`, empty) | +| 14 gameInstall | `{1:1, 2: installed chunks, 3: language}` | +| 17 storage | `{1: "C:/users/steamuser/Saved Games/Ubisoft///"}`; the game appends file names directly, so the trailing slash matters | +| 22 ubiServices | `{1: applicationId}` from the account's entitlements, left out when unknown | + +### R2 titles + +`uplay_r2.dll` speaks the same `mg.protocol.uplaydll` messages (its embedded `UplayDll.proto` is identical to +`uplay_r1.dll`'s), but its `InitReq` names the subsystems the game uses: fields 4 to 11 (friend, overlay, +product, storage, install, multiplayer, store, streaming). Its `ApiContext` creates one object per requested +subsystem and copies the session into them. Friends, overlay, game session, store and crossboot are checked +for a missing object first; install and storage are not. A `gameInstall` sent to a game that did not ask for +install is copied into a null object: Prince of Persia: The Lost Crown (6145) asks for overlay, product and store +only, and crashed reading `0x68` in `uplay_r264.dll+0xaca2` two seconds after the session arrived. + +So when the request names subsystems, 14 is sent only with `subSystemInstall` (8), 17 only with +`subSystemStorage` (7), and an empty `multiplayerInit` (20) is added, which `uplay_r2.dll` asks for even when +empty. A request that names none gets the session above unchanged. The Lost Crown also opens a second context +that asks for every subsystem, and it gets the full session. + +The overlay is reported off in all three places. `uplay_r1.dll` still loads `overlay.dll` from the +runtime folder right after the session arrives, whatever the session says; without that file it gives up +with `UplayAPI [ERROR]: Startup failed: cannot load uplay library` (Assassin's Creed Chronicles: China +then sits on a black screen and aborts with code 3 after about 160 s), so the runtime includes it. + +### Orbit titles + +Older titles such as Far Cry 3 Blood Dragon (205) load `ubiorbitapi_r2.dll` next to `uplay_r1.dll` and ask +`orbit_ipc_pipe_` for `init` before anything else; unanswered, the game waits forever on a black screen. The DLL +keeps savegames itself as `*.save` files in the folder `init` returns, the same save folder as field 17 above. + +## Start sequence + +1. `droiddeck-upc.exe` creates the pipes and an auto-reset event marked inheritable, then starts the + game's own exe with handle inheritance, in the install folder, with no extra arguments. +2. The exe sees it was not started by Connect and starts `UbisoftGameLauncher.exe + -gamelauncher_wait_handle -upc_uplay_id ...` (it exits with code 3; that is normal). +3. The starter asks `game_start` and starts the real game from the reply. +4. The game announces itself on `uplay_api_process`; the answer sets the event, which lets the starter + exit. Without it the starter times out and its job object ends the game after about 15 seconds. +5. `uplay_r1.dll` asks `uplay_ipc` for the session. +6. `droiddeck-upc.exe` waits for the announced process, allows 15 s for a restart, then exits with the + game's code so Steam sees the game end. + +A log of every exchange is written to `~/.cache/droiddeck/ubisoft/upc-.log` in the guest. + +## Denuvo + +For protected titles the aux pipe carries the activation challenge. `droiddeck-upc.exe` writes it to +`~/.cache/droiddeck/ubisoft/bridge-/denuvo-.req` and waits 90 s for `.rsp`. Answering it +needs `denuvo_service` with an ownership token (`OwnershipTokenReq`, field 28) and is the next step; +titles without Denuvo never open the aux pipe. + +## Not covered yet + +- R2 titles other than The Lost Crown, and R2 requests beyond the session, credentials, product list and streaming type. +- Orbit's online-services pipe (`getOsi` is declined) and Orbit titles other than Far Cry 3 Blood Dragon. +- Achievements, friends, overlay, cloud saves. diff --git a/docs/lab-builds.md b/docs/lab-builds.md new file mode 100644 index 0000000000..4f2ddfb5f0 --- /dev/null +++ b/docs/lab-builds.md @@ -0,0 +1,63 @@ +# Lab builds + +A Lab build is DroidDeck app code and resources built on the device itself, by the on-device agent +or by hand, and loaded over the installed APK at the next start. Nothing is reinstalled or +re-signed, so a tester on a release build keeps their games, sign-ins and settings while trying a +change. + +## How it works + +- `tools/agent/dd-lab-build` builds the checkout with Gradle on the device (`processReleaseResources` + and `mergeDexRelease`), packs the linked resources and dex files into `overlay.apk`, writes + `overlay.json`, and stages both in the app's `files/lab/next`. It then recompiles the app without + an app image and restarts DroidDeck. +- Run by the app's own agent (`DD_AGENT` set), it writes `files/agent/lab-request` instead, and the + app runs the build in a process of its own, logging to `~/.cache/dd-lab-build.log`; the agent's + copy follows that log and exits with the build. A turn's processes end with the turn, so a build + started there would otherwise die when the agent stops or finishes early. +- At start, `LabOverlay` (called from `App.attachBaseContext`) promotes `next` to `active`, checks + that the build was made for this install, puts its dex files ahead of the APK's, and adds its + resources through `ResourcesLoader` to the app and every activity. Contexts made from them + (presentations on the second screen) inherit the loader. +- The watermark shows `LAB | @ `. When the app comes back on a new build it posts + a "Lab build installed" notification, so the restart does not look like a crash. +- A build that is replaced, turned off or refused is kept in `files/lab/builds` (the newest 12). + Updates lists them under Lab builds: the one in use can be turned off, one built for this + install can be used again, and any can be deleted. + +## What a Lab build cannot change + +The manifest, native code (`cpp`, `jniLibs`, Rust), Gradle files, `App`, `AppLanguage`, and `LabOverlay` itself: +they are loaded before a Lab build can be, or are not part of it. `dd-lab-build` refuses those +changes; they need a new APK. + +## Safety + +- A build is only used on the install it was built for: `overlay.json` carries the APK's commit + (`apkCommit` in `droiddeckctl state`) and the APK's path, which changes with every install and + update. A build for another install is turned off. +- Two starts in a row that do not reach a resumed activity for 10 seconds turn the build off. +- It needs Android 11 or later (`ResourcesLoader`) and no app image (classes in one load before the + Lab build). `dd-lab-build` runs `cmd package compile -m verify` before restarting. Android's + background optimization can bring an app image back; the build is then paused, a notification + says so, and Restart in Updates recompiles through the app's wireless debugging pairing. + +## Setting up a device + +From the DroidDeck terminal, in a checkout of this repository: + +```sh +tools/agent/setup +``` + +It installs Claude Code, git, gh and loopback adb, plus the build toolchain: JDK 17, the Android +SDK platform, and Google's x86-64 `aapt2` run under `qemu-user`. The first Lab build compiles the +whole app and takes about 8 minutes on a Snapdragon 865; later ones compile only what changed. +That needs the Kotlin daemon: Kotlin's in-process compiles always redo the whole app. BuildConfig +is given the installed commit, so committing a change does not change it. Setup +does that first build ahead of time with `dd-lab-build --prepare`, which compiles the installed +commit without making a Lab build. +`~/.cache/dd-lab-build.json` reports the stage, the current task, progress in thousandths and the +seconds left, estimated from how long each task took the last time (`~/.cache/dd-lab-build-times`). +`~/.cache/dd-lab-build-base` holds the installed commit the last successful build compiled, so the +Agent tab can offer to prepare again after DroidDeck updates. diff --git a/docs/releases/0.7.0.md b/docs/releases/0.7.0.md new file mode 100644 index 0000000000..c798d0d9d0 --- /dev/null +++ b/docs/releases/0.7.0.md @@ -0,0 +1,166 @@ +# DroidDeck 0.7.0 + +

+ Download DroidDeck 0.7.0 + Join the DroidDeck Discord +

+ +**DroidDeck is 100% open source. No ads. No telemetry. No proprietary components. No source withheld.** + +Since 0.6.9, **39 people** sent **194 pull requests**, and **20 of them are first-time contributors**. Our community is strongest when we can build together, and with DroidDeck 0.7.0, our community is about to get A LOT bigger! + +0.7.0 introduces preliminary support for **Mali, PowerVR and Xclipse** GPUs! In addition, we now have GameJolt library and store, dual screen game mode + KDE Desktop, Syncthing integration, improvements for devices with low ram, customizable controller profiles and presets, hardware mouse & keyboard support, live wallpapers, and even more. Click the link in the comments below to... I mean scroll down to learn more: + +### Features + +

A phone showing DroidDeck Setup with GPU via Mali bridge turned on, in front of handhelds, one of them running Steam

+ +- Initial **Mali, PowerVR and Xclipse support**. DroidDeck detects the GPU and picks a driver for it, so these devices can run sessions, with MaliBridge and Venus on Mali and open driver pairs elsewhere. (@ASEbrahim, @mr-abccc, @The412Banner, @wallentx, @Leask, @stefanz92, @DavidCimo, @maxjivi05, @K11MCH1, @xXJSONDeruloXx, [#1587](https://github.com/Droid-Deck/DroidDeck/pull/1587), [#2027](https://github.com/Droid-Deck/DroidDeck/pull/2027), [#1950](https://github.com/Droid-Deck/DroidDeck/pull/1950), [#2029](https://github.com/Droid-Deck/DroidDeck/pull/2029), [#2157](https://github.com/Droid-Deck/DroidDeck/pull/2157)) + +

A Retroid Pocket Duo with the KDE desktop on the top screen and Rayman 2 running on the bottom screen The KDE desktop on the bottom screen of an AYN Thor running fastfetch, then opening a file manager, while Steam stays on the top screen

+ + +- Added the **KDE desktop on the bottom screen** beside a Steam session or a game, next to Dashboard, Keyboard + trackpad, Terminal and Deck grips. (@xXJSONDeruloXx, [#1966](https://github.com/Droid-Deck/DroidDeck/pull/1966)) +- Added **swap screens**: play on the bottom screen while the top screen shows the Dashboard or the desktop. Use the swap button in the panel bar or **Show the game on** in the session menu. (@The412Banner, [#2006](https://github.com/Droid-Deck/DroidDeck/pull/2006)) + +

An AYN Thor with Steam's Storage page on the top screen listing internal storage, the SD card and a shared library, and the Storage Manager on the bottom screen

+ +- Added **shared Steam libraries with other pc gaming apps**. DroidDeck can now **find Steam libraries that other apps already made** on your internal storage or card and suggests them, each with its game count, so one install of a game can serve both apps. You can add up to four more libraries beside internal storage and the card, rename them, and remove them any time. (@xXJSONDeruloXx, [#1967](https://github.com/Droid-Deck/DroidDeck/pull/1967), [#2023](https://github.com/Droid-Deck/DroidDeck/pull/2023), [#2054](https://github.com/Droid-Deck/DroidDeck/pull/2054)) + +

The Game Jolt store in the Stores tab with price, platform, maturity and status filters above a grid of games

+ +- Added the **Game Jolt store**: browse, search, install, update and keep a library, in the same style as itch.io. (@FX192, [#1986](https://github.com/Droid-Deck/DroidDeck/pull/1986), [#1989](https://github.com/Droid-Deck/DroidDeck/pull/1989)) + +

The Syncthing page in Setup with Open web UI, Pause, Add folder and a Running switch

+ +- Added built-in **Syncthing**, so you can sync saves and games from DroidDeck’s own storage without another app. (@superboo07, [#1442](https://github.com/Droid-Deck/DroidDeck/pull/1442)) + +

An AYN Thor: Redout on the top screen and the Dashboard with In-game stats on the bottom screen

+ +- Added **bottom-screen Dashboard** for dual-screen handhelds like the Retroid Pocket Duo and AYN Thor: downloads, notifications, screenshots, Steam chat with voice controls, and **In-game stats** that draw a racing game’s own speed, gear, rpm and pedals from its data output. (@The412Banner, [#1920](https://github.com/Droid-Deck/DroidDeck/pull/1920), [#1933](https://github.com/Droid-Deck/DroidDeck/pull/1933), [#1968](https://github.com/Droid-Deck/DroidDeck/pull/1968)) + +

The Strip HUD across the top of Steam on an AYN Thor: FPS, frame-time graph, lows, GPU, CPU, VRAM, RAM, battery and clock

+ +

Dragging the HUD to the screen edge shrinks it into a small FPS tab, and tapping the tab opens it again

+ +- Added a **Horizontal DroidDeck HUD Style**: one line across the top or bottom edge with FPS, frame-time graph, lows, GPU, CPU, VRAM, RAM, battery and the clock. All DD HUDs can now **shrinks into its tab as you drag it off an edge** and snaps to the sides. The Strip is lighter to draw. (@xXJSONDeruloXx, @The412Banner, @KeegantheVeganat0r, [#1935](https://github.com/Droid-Deck/DroidDeck/pull/1935), [#1937](https://github.com/Droid-Deck/DroidDeck/pull/1937), [#1982](https://github.com/Droid-Deck/DroidDeck/pull/1982), [#2194](https://github.com/Droid-Deck/DroidDeck/pull/2194), [#2235](https://github.com/Droid-Deck/DroidDeck/pull/2235)) +- A **hardware mouse and keyboard work like a PC**: the camera no longer freezes in games that hide the cursor, the cursor shows in Steam sessions, and clicks land where you point. (@maxjivi05, [#2053](https://github.com/Droid-Deck/DroidDeck/pull/2053), [#2133](https://github.com/Droid-Deck/DroidDeck/pull/2133), [#2139](https://github.com/Droid-Deck/DroidDeck/pull/2139)) +

The layout editor on the second screen of a dual-screen handheld, with the right trackpad selected and its Properties, Click properties and Remove control buttons above the full-size canvas

+ +- Added **unified controller profiles** for Game and Desktop sessions: named profiles combine a physical controller layout with main and second screen layouts, with one full-size editor for both screens and a profile picker in the session menu. (@Delete228, @maxjivi05, @xXJSONDeruloXx, [#1439](https://github.com/Droid-Deck/DroidDeck/pull/1439), [#2215](https://github.com/Droid-Deck/DroidDeck/pull/2215), [#2221](https://github.com/Droid-Deck/DroidDeck/pull/2221), [#2238](https://github.com/Droid-Deck/DroidDeck/pull/2238), [#2242](https://github.com/Droid-Deck/DroidDeck/pull/2242)) +- Added **Startup** choices: Never, Steam or Desktop. (@xXJSONDeruloXx, [#1993](https://github.com/Droid-Deck/DroidDeck/pull/1993)) +- Added a **low-storage warning** switch, and an **Android keyboard for game text fields** setting for dual-screen sessions, off by default so Steam keeps its own keyboard. (@xXJSONDeruloXx, [#2244](https://github.com/Droid-Deck/DroidDeck/pull/2244), [#2236](https://github.com/Droid-Deck/DroidDeck/pull/2236)) +- Added **live wallpapers** to Android’s wallpaper picker. (@xXJSONDeruloXx, [#2012](https://github.com/Droid-Deck/DroidDeck/pull/2012)) + +### Improvements + +- **Auto picks DD-Turnip on Adreno 7xx**, and the **upstream RADV pair on Xclipse 950 and 960**. Auto follows the published table on Adreno 6xx and 8xx, and a driver source that is down no longer changes the pick. (@maxjivi05, @xXJSONDeruloXx, [#1978](https://github.com/Droid-Deck/DroidDeck/pull/1978), [#2158](https://github.com/Droid-Deck/DroidDeck/pull/2158), [#2151](https://github.com/Droid-Deck/DroidDeck/pull/2151), [#2233](https://github.com/Droid-Deck/DroidDeck/pull/2233), [#2255](https://github.com/Droid-Deck/DroidDeck/pull/2255), [#2226](https://github.com/Droid-Deck/DroidDeck/pull/2226)) +- A **configurable stick dead zone** for physical controllers, 0 to 25%. (@vitamin663-sys, [#1780](https://github.com/Droid-Deck/DroidDeck/pull/1780)) +- The drawer’s **frame limit works in desktop mode**, up to 165 fps. (@K11MCH1, [#1885](https://github.com/Droid-Deck/DroidDeck/pull/1885)) +- **Faster Steam**: compatibility mapping and app info load in batches, and Steam shows cached library art when it starts without a connection. SD and USB libraries answer missing-file checks from a directory cache. (@ddd-ms, @xXJSONDeruloXx, [#1755](https://github.com/Droid-Deck/DroidDeck/pull/1755), [#1756](https://github.com/Droid-Deck/DroidDeck/pull/1756), [#1985](https://github.com/Droid-Deck/DroidDeck/pull/1985), [#2212](https://github.com/Droid-Deck/DroidDeck/pull/2212), [#2203](https://github.com/Droid-Deck/DroidDeck/pull/2203)) +- Added **Enhanced diagnostics**, a one-session setting that bundles redacted session, graphics and game logs for bug reports, plus **session log management** in Setup. (@wallentx, @xXJSONDeruloXx, [#2129](https://github.com/Droid-Deck/DroidDeck/pull/2129), [#2099](https://github.com/Droid-Deck/DroidDeck/pull/2099), [#2131](https://github.com/Droid-Deck/DroidDeck/pull/2131)) +- Added **auto updates for FEX, DXVK and VKD3D-Proton in DroidDeck-Proton**, so it gets the newest builds without a new DroidDeck release. Other Protons keep the components they ship with, old DroidDeck-Proton builds are removed, and a game set to a removed build moves to the newest one. (@maxjivi05, @xXJSONDeruloXx, [#2156](https://github.com/Droid-Deck/DroidDeck/pull/2156), [#2190](https://github.com/Droid-Deck/DroidDeck/pull/2190), [#2193](https://github.com/Droid-Deck/DroidDeck/pull/2193), [#2223](https://github.com/Droid-Deck/DroidDeck/pull/2223)) +- An installed **DroidDeck-Proton becomes the default** for Steam games and added shortcuts when nobody picked Proton Experimental. A Proton you choose in DroidDeck or in Steam is kept, and both stay in sync. (@maxjivi05, [#2266](https://github.com/Droid-Deck/DroidDeck/pull/2266)) + +- **Little Nightmares** keeps its render thread, **+12.7% FPS** on the Retroid Pocket Duo, and **Adreno 722** has fewer DXVK stalls. (@maxjivi05, [#1930](https://github.com/Droid-Deck/DroidDeck/pull/1930), [#2066](https://github.com/Droid-Deck/DroidDeck/pull/2066)) +- A resumed session reads its memory back from zram at once, which ends minutes of stutter in heavy games like Yakuza. DroidDeck also frees launcher memory earlier under pressure, and idle game memory is compressed before low-RAM devices run out. (@l4nr3, @xXJSONDeruloXx, [#1839](https://github.com/Droid-Deck/DroidDeck/pull/1839), [#2138](https://github.com/Droid-Deck/DroidDeck/pull/2138), [#2187](https://github.com/Droid-Deck/DroidDeck/pull/2187)) +- On-screen sticks are lighter to hold, and **Low latency off** is honored. (@maxjivi05, [#2048](https://github.com/Droid-Deck/DroidDeck/pull/2048)) +- The HUD cycles colors with the Inner Gamer theme, the docked FPS tab and bottom-screen frame graph look better, and the watermark is gone with the wordmark in headers. (@xXJSONDeruloXx, [#1932](https://github.com/Droid-Deck/DroidDeck/pull/1932), [#1976](https://github.com/Droid-Deck/DroidDeck/pull/1976), [#2013](https://github.com/Droid-Deck/DroidDeck/pull/2013), [#2011](https://github.com/Droid-Deck/DroidDeck/pull/2011), [#2003](https://github.com/Droid-Deck/DroidDeck/pull/2003), [#1983](https://github.com/Droid-Deck/DroidDeck/pull/1983)) +- Every session log now records **CPU clocks, thermal status and battery temperature**, and `droiddeckctl` gained `thermal` and `wait cool`. (@angelrenefm, [#2060](https://github.com/Droid-Deck/DroidDeck/pull/2060), [#2061](https://github.com/Droid-Deck/DroidDeck/pull/2061), [#2062](https://github.com/Droid-Deck/DroidDeck/pull/2062)) +- Added games scan **one at a time and keep what they found** across launches, and imported Steam games with no known build update only when launched. (@K11MCH1, [#2067](https://github.com/Droid-Deck/DroidDeck/pull/2067), [#2064](https://github.com/Droid-Deck/DroidDeck/pull/2064)) +- Steam’s **VRAM budget** is applied through Vulkan without rejecting allocations, and the **download monitor** no longer freezes a session on slow storage. D3D12 support is detected per device. (@xXJSONDeruloXx, [#2014](https://github.com/Droid-Deck/DroidDeck/pull/2014), [#2020](https://github.com/Droid-Deck/DroidDeck/pull/2020), [#2134](https://github.com/Droid-Deck/DroidDeck/pull/2134)) +- Every bottom-screen panel now has the **same bar**, and X or Back opens the in-session menu there instead of dropping you on the Android launcher. (@xXJSONDeruloXx, [#2084](https://github.com/Droid-Deck/DroidDeck/pull/2084), [#2110](https://github.com/Droid-Deck/DroidDeck/pull/2110)) +- On the Duo and Thor, DroidDeck switches to **single-screen mode** while another window holds the bottom screen, such as Retroid’s performance panel, and back when it is free, including when docked. The trackpad and Deck panels are back on the second screen, and the bottom-screen menu and layout editor stay open when the screen turns off. (@maxjivi05, [#1979](https://github.com/Droid-Deck/DroidDeck/pull/1979), [#2232](https://github.com/Droid-Deck/DroidDeck/pull/2232), [#2229](https://github.com/Droid-Deck/DroidDeck/pull/2229), [#2247](https://github.com/Droid-Deck/DroidDeck/pull/2247)) +- The HUD shows **GPU load and clock without root** on phones where Android blocks them, such as the Retroid Pocket Duo and Adreno 8xx, and in Steam’s overlay. (@The412Banner, @angelrenefm, [#1969](https://github.com/Droid-Deck/DroidDeck/pull/1969), [#1981](https://github.com/Droid-Deck/DroidDeck/pull/1981), [#2059](https://github.com/Droid-Deck/DroidDeck/pull/2059)) +- Added independent **1% and 0.1% low** toggles to the HUD. (@KeegantheVeganat0r, [#2127](https://github.com/Droid-Deck/DroidDeck/pull/2127)) +- **EA games install the EA app** through Steam, and the EA sign-in stays in front of the launcher’s splash screen. (@K11MCH1, [#2036](https://github.com/Droid-Deck/DroidDeck/pull/2036), [#2037](https://github.com/Droid-Deck/DroidDeck/pull/2037), [#2045](https://github.com/Droid-Deck/DroidDeck/pull/2045)) +- The **desktop session follows the app language**, so Plasma and its apps are no longer English only. (@xXJSONDeruloXx, [#1971](https://github.com/Droid-Deck/DroidDeck/pull/1971)) +- The desktop shows **programs installed by Windows installers** in its menu and as icons. (@K11MCH1, [#2146](https://github.com/Droid-Deck/DroidDeck/pull/2146)) +- **Follow screen** resolution can be scaled down: ÷1.5, ÷2, ÷2.5, ÷3, ÷4 or your own factor. (@xXJSONDeruloXx, [#1964](https://github.com/Droid-Deck/DroidDeck/pull/1964)) +- Added a **Hold Back for Steam shortcuts** switch, for people who map a held Back with another app. (@xXJSONDeruloXx, [#1955](https://github.com/Droid-Deck/DroidDeck/pull/1955)) +- Added **size, opacity and hidden keys** settings for the on-screen PC keyboard. (@Dantalian-dev, [#1897](https://github.com/Droid-Deck/DroidDeck/pull/1897)) +- Added **World of Warcraft addon import** from a zip, plus **voice type and a keyboard chat bar**. Addons also download from WoWInterface, and CurseForge opens in the browser. (@maxjivi05, [#2111](https://github.com/Droid-Deck/DroidDeck/pull/2111), [#2171](https://github.com/Droid-Deck/DroidDeck/pull/2171), [#2175](https://github.com/Droid-Deck/DroidDeck/pull/2175), [#2219](https://github.com/Droid-Deck/DroidDeck/pull/2219)) +- **UBWC compatibility** moved from Components to Settings, and FEX’s **Use Default** shows which preset it resolves to. (@xXJSONDeruloXx, [#2008](https://github.com/Droid-Deck/DroidDeck/pull/2008), [#2225](https://github.com/Droid-Deck/DroidDeck/pull/2225)) +- **Steam launch options** show on the Launch tab. (@wallentx, [#2163](https://github.com/Droid-Deck/DroidDeck/pull/2163)) +- **GOG achievements** are on by default. (@xXJSONDeruloXx, [#2168](https://github.com/Droid-Deck/DroidDeck/pull/2168)) +- **Translations:** every missing string is translated, with a fresh Russian pass. (@maxjivi05, @flexeykinDev, [#1965](https://github.com/Droid-Deck/DroidDeck/pull/1965), [#2116](https://github.com/Droid-Deck/DroidDeck/pull/2116)) + +### Fixed + +- Fixed **“DroidDeck isn’t responding”** on dual-screen handhelds after the bottom screen sat idle, and opening DroidDeck from iisu on the AYN Thor no longer bounces back. (@maxjivi05, @0x1428571429, [#1917](https://github.com/Droid-Deck/DroidDeck/pull/1917), [#1901](https://github.com/Droid-Deck/DroidDeck/pull/1901)) +- Fixed **lag and heat on the Galaxy S26** from switching between display modes with the same refresh rate, which started in 0.6.7. (@maxjivi05, [#2192](https://github.com/Droid-Deck/DroidDeck/pull/2192)) +- Fixed **Steam starting on Quest 3**, and the gamescope abort at start on Quest. (@xXJSONDeruloXx, @Mi-Yomi, [#2050](https://github.com/Droid-Deck/DroidDeck/pull/2050), [#1938](https://github.com/Droid-Deck/DroidDeck/pull/1938)) +- Fixed **Steam libraries** with installs but no app manifest not being found, and **a stale session’s startup failure** stopping the newer session. (@xXJSONDeruloXx, [#2054](https://github.com/Droid-Deck/DroidDeck/pull/2054), [#1984](https://github.com/Droid-Deck/DroidDeck/pull/1984)) +- Fixed an **unplugged game drive**: installs fall back to internal storage instead of failing. (@maxjivi05, [#1913](https://github.com/Droid-Deck/DroidDeck/pull/1913)) +- Fixed **GOG**: an install launches the game and not its config tool, cloud saves upload in Galaxy’s format, and a game whose installer cannot run gets its install registry. (@moronigranja, [#1644](https://github.com/Droid-Deck/DroidDeck/pull/1644), [#1952](https://github.com/Droid-Deck/DroidDeck/pull/1952), [#2022](https://github.com/Droid-Deck/DroidDeck/pull/2022)) +- Fixed **Battle.net**: Flathub installs outside a session, World of Warcraft: Forever in the Library, the right artwork for each game, games installed inside its folder, Chinese servers and installs, and launching store games from any game page tab. Its pages no longer play videos on the CPU. (@maxjivi05, @visail, [#1923](https://github.com/Droid-Deck/DroidDeck/pull/1923), [#2018](https://github.com/Droid-Deck/DroidDeck/pull/2018), [#2092](https://github.com/Droid-Deck/DroidDeck/pull/2092), [#2087](https://github.com/Droid-Deck/DroidDeck/pull/2087), [#1660](https://github.com/Droid-Deck/DroidDeck/pull/1660), [#1662](https://github.com/Droid-Deck/DroidDeck/pull/1662), [#2185](https://github.com/Droid-Deck/DroidDeck/pull/2185), [#2195](https://github.com/Droid-Deck/DroidDeck/pull/2195)) +- Fixed **game-specific problems**: Codemasters EGO games, DOOM (2016), Project Zomboid, Supergiant games and Ubisoft Connect. (@The412Banner, @xXJSONDeruloXx, [#1936](https://github.com/Droid-Deck/DroidDeck/pull/1936), [#1987](https://github.com/Droid-Deck/DroidDeck/pull/1987), [#2016](https://github.com/Droid-Deck/DroidDeck/pull/2016), [#2143](https://github.com/Droid-Deck/DroidDeck/pull/2143), [#2090](https://github.com/Droid-Deck/DroidDeck/pull/2090)) +- Fixed the **Linux desktop** disappearing after a runtime update, language packs, a game’s window following its own window mode, and Steam’s own header moving its windows. (@maxjivi05, [#2021](https://github.com/Droid-Deck/DroidDeck/pull/2021), [#2096](https://github.com/Droid-Deck/DroidDeck/pull/2096), [#2094](https://github.com/Droid-Deck/DroidDeck/pull/2094), [#2097](https://github.com/Droid-Deck/DroidDeck/pull/2097)) +- Fixed **repaired components** not reaching prefixes that already had them, and a native-only override breaking a prefix with no native DLL. (@maxjivi05, [#2121](https://github.com/Droid-Deck/DroidDeck/pull/2121), [#2142](https://github.com/Droid-Deck/DroidDeck/pull/2142)) +- Fixed **Windows installs on a natively mounted card** asking for an administrator. (@maxjivi05, [#2100](https://github.com/Droid-Deck/DroidDeck/pull/2100)) +- Fixed the **Home screen setting** so DroidDeck stays in RedMagic Game Space, and the right click acting as Back in RedMagic cast mode. (@maxjivi05, @OmarAlTaki1, [#2083](https://github.com/Droid-Deck/DroidDeck/pull/2083), [#1870](https://github.com/Droid-Deck/DroidDeck/pull/1870)) +- Fixed **Steam’s UI crashing on PowerVR** when scrolling the Home shelf fast. (@coffeemeist3r, [#2107](https://github.com/Droid-Deck/DroidDeck/pull/2107)) +- Fixed **the side menu freezing the launcher** while moving through the Stores tab, and **controller focus** not moving into an opened folder. (@kmnkv1, @danielnoam, [#2105](https://github.com/Droid-Deck/DroidDeck/pull/2105), [#1962](https://github.com/Droid-Deck/DroidDeck/pull/1962)) +- Fixed **VPN and network** problems: links without a gateway, and network queries inside a session. (@uubooster-team, @xXJSONDeruloXx, [#2038](https://github.com/Droid-Deck/DroidDeck/pull/2038), [#2141](https://github.com/Droid-Deck/DroidDeck/pull/2141)) +- Fixed **picture-in-picture** output being cropped after a resize and not scaling to full size, and the **glasses pointer** not reaching the full screen or drawing in the picture. (@xXJSONDeruloXx, @moronigranja, [#2125](https://github.com/Droid-Deck/DroidDeck/pull/2125), [#2145](https://github.com/Droid-Deck/DroidDeck/pull/2145), [#1925](https://github.com/Droid-Deck/DroidDeck/pull/1925), [#2174](https://github.com/Droid-Deck/DroidDeck/pull/2174)) +- Fixed **World of Warcraft and other added games sorting last** in the Library. Battle.net and added games now sort by when they were played and installed, like Steam games. (@maxjivi05, [#2256](https://github.com/Droid-Deck/DroidDeck/pull/2256)) +- Fixed the **Linux runtime showing as not installed after an app update** that brings a new PRoot pack. Only the changed add-on packs download now. (@maxjivi05, [#2270](https://github.com/Droid-Deck/DroidDeck/pull/2270)) +- Fixed **desktop apps that would not start**: RPCS3 and other catalog AppImages from the desktop menu, D-Bus programs such as melonDS, x86 programs that a native script starts, and Flatpak apps that Flatpak no longer has now uninstall cleanly. Add from GitHub installs **the AppImage you linked** instead of the release’s first one. (@maxjivi05, [#2274](https://github.com/Droid-Deck/DroidDeck/pull/2274), [#2275](https://github.com/Droid-Deck/DroidDeck/pull/2275), [#2217](https://github.com/Droid-Deck/DroidDeck/pull/2217), [#2216](https://github.com/Droid-Deck/DroidDeck/pull/2216), [#2273](https://github.com/Droid-Deck/DroidDeck/pull/2273)) +- Fixed **controller navigation** across the Controller tab and profile menus. (@xXJSONDeruloXx, [#2231](https://github.com/Droid-Deck/DroidDeck/pull/2231)) +- Fixed **games listed with a bundled arm64 Linux build** defaulting to the wrong runner. They now start with FEX. (@phj1081, [#2126](https://github.com/Droid-Deck/DroidDeck/pull/2126)) +- Fixed smaller things: left adaptive stick activation at the screen edge, game buffers upscaled before composition, the Steam applying-update stage, apps pinned when all cores are selected, runtime PATH kept for guest binaries, Xwayland orphans, GPU environment values with spaces, the navigation bar staying dark, the Android pointer showing after hovering session menus, touch sticks clicking without a fast double tap, wall scrims leaving edge pixels unshaded, the PowerVR bundled PPSSPP install, L2 and R2 keys overriding analog triggers, taps outside the PC keyboard not reaching the game, direct-touch drags in games that hide the cursor, library scan and download cancel crashes on Android 10, and a Second library on a raw media path or an unmounted volume state. (@sanogueralorenzo, @cphillam, @HCOOKIEie, @w1novnik, @asdf17128, @LingWindT, @Systina12, @KirkPatrickJunsay, @realRurichan, @maxjivi05, @xXJSONDeruloXx, [#1455](https://github.com/Droid-Deck/DroidDeck/pull/1455), [#1367](https://github.com/Droid-Deck/DroidDeck/pull/1367), [#1614](https://github.com/Droid-Deck/DroidDeck/pull/1614), [#1759](https://github.com/Droid-Deck/DroidDeck/pull/1759), [#1826](https://github.com/Droid-Deck/DroidDeck/pull/1826), [#1716](https://github.com/Droid-Deck/DroidDeck/pull/1716), [#1931](https://github.com/Droid-Deck/DroidDeck/pull/1931), [#1975](https://github.com/Droid-Deck/DroidDeck/pull/1975), [#2113](https://github.com/Droid-Deck/DroidDeck/pull/2113), [#2176](https://github.com/Droid-Deck/DroidDeck/pull/2176), [#2173](https://github.com/Droid-Deck/DroidDeck/pull/2173), [#1994](https://github.com/Droid-Deck/DroidDeck/pull/1994), [#2205](https://github.com/Droid-Deck/DroidDeck/pull/2205), [#2257](https://github.com/Droid-Deck/DroidDeck/pull/2257), [#2220](https://github.com/Droid-Deck/DroidDeck/pull/2220), [#2204](https://github.com/Droid-Deck/DroidDeck/pull/2204), [#2224](https://github.com/Droid-Deck/DroidDeck/pull/2224), [#2245](https://github.com/Droid-Deck/DroidDeck/pull/2245), [#2258](https://github.com/Droid-Deck/DroidDeck/pull/2258)) + +### DroidDeck-Proton, DD-Turnip and components + +These ship on their own and update in the app, so 0.7.0 users get them too. + +- **DroidDeck-Proton 11-12** moves to GE-Proton11-12 and Valve’s newer Wine: XInput rescans only when a controller could have changed, DualSense haptics and adaptive triggers together over USB, MSFS 2024 and other intro videos play normally, an ntsync fix stops waiters blocking forever on an abandoned mutex, plus DXVK 3.1.1, VKD3D-Proton 3.1 and newer FEX. (@The412Banner, @maxjivi05, with GloriousEggroll, Valve and the GE contributors upstream) +- **Faster loads in 32-bit and ARM64EC games**: FEX keeps its translated code on empty reads and stays off Wine’s memory lock. Entering the world in Dungeons & Dragons Online went from 50 s to 4 s. (@K11MCH1, [DroidDeck-Proton#9](https://github.com/Droid-Deck/DroidDeck-Proton/pull/9)) +- **32-bit games load at the address they were built for**, so game and mod loaders that patch them at start work again. (@maxjivi05, [DroidDeck-Proton#10](https://github.com/Droid-Deck/DroidDeck-Proton/pull/10)) +- **DiRT 3 and DiRT Showdown** keep running with their telemetry on, for the In-game stats dash. (@The412Banner) +- About 3,000 system functions no longer look **hooked** to x64 games and launchers that check for that, while ARM64EC callers still skip the emulator (11-12.2). Text fields in Wine programs now tell DroidDeck when they have focus, which brings up the keyboard for World of Warcraft chat (11-12.3). (@maxjivi05) +- **DD-Turnip 0.4.0**: newer Mesa, and indirect draws no longer read their arguments too early on Adreno 8xx, which fixes the black or over-shadowed ground in **Mortal Shell 2** and other UE5 games through VKD3D-Proton. (@K11MCH1, [Drivers#14](https://github.com/Droid-Deck/Drivers/pull/14)) +- **Components**: the full Visual C++ 2010 runtime and MFC for 2015–2022 are installed, the DXVK and VKD3D-Proton nightlies are built as ARM64X, and esync packs give Windows users read access to their folders. (@xXJSONDeruloXx, @maxjivi05, [DroidDeck-Components#10](https://github.com/Droid-Deck/DroidDeck-Components/pull/10), [#11](https://github.com/Droid-Deck/DroidDeck-Components/pull/11), [#12](https://github.com/Droid-Deck/DroidDeck-Components/pull/12), [#13](https://github.com/Droid-Deck/DroidDeck-Components/pull/13)) + +### Community + +DroidDeck is built in the open by the people who use it. These are everyone whose code is in 0.7.0: + +| Contributor | Pull requests | +|---|---| +| @xXJSONDeruloXx | 65: KDE desktop on the bottom screen, more Steam libraries, HUD Strip and docking, live wallpapers, startup choice, diagnostics, PowerVR add-on pack and more | +| @maxjivi05 | 70: hardware mouse and keyboard, single-screen mode, Battle.net, desktop fixes, performance and more | +| @The412Banner | 9: bottom-screen Dashboard, swap screens, bottom-screen HUD, GPU load without root, game fixes | +| @K11MCH1 | 6: EA app, installed Windows programs, scan and frame limit fixes | +| @moronigranja | 4: GOG saves and installs, glasses cursor | +| @ASEbrahim, @mr-abccc, @The412Banner | MaliBridge for Mali GPUs ([#2027](https://github.com/Droid-Deck/DroidDeck/pull/2027), [#1950](https://github.com/Droid-Deck/DroidDeck/pull/1950)) | +| @wallentx, @Leask, @stefanz92, @DavidCimo | Non-Adreno graphics stack and diagnostics ([#2029](https://github.com/Droid-Deck/DroidDeck/pull/2029), [#2129](https://github.com/Droid-Deck/DroidDeck/pull/2129)) | +| @angelrenefm | 4: session clocks, GPU clock in Steam’s overlay, `droiddeckctl` | +| @FX192 | 2: Game Jolt store | +| @visail, @ddd-ms, @kmnkv1 | 2 each: Battle.net China, Steam speedups, Stores freeze and build fix | +| @superboo07, @vitamin663-sys, @Dantalian-dev, @KeegantheVeganat0r, @l4nr3, @phj1081, @danielnoam, @cphillam, @asdf17128, @Mi-Yomi, @LingWindT, @KirkPatrickJunsay, @0x1428571429, @OmarAlTaki1, @sanogueralorenzo, @HCOOKIEie, @w1novnik, @Systina12, @coffeemeist3r, @realRurichan, @flexeykinDev, @uubooster-team, @Delete228 | Syncthing, stick dead zone, PC keyboard settings, unified controller profiles, HUD lows, zram resume, FEX default, Stores freeze, folder focus, upscaling, PATH, Quest, Xwayland, iisu, VPN, PowerVR crash, translations and more | + +### New contributors + +- @cphillam made their first contribution in [#1367](https://github.com/Droid-Deck/DroidDeck/pull/1367). +- @sanogueralorenzo made their first contribution in [#1455](https://github.com/Droid-Deck/DroidDeck/pull/1455). +- @HCOOKIEie made their first contribution in [#1614](https://github.com/Droid-Deck/DroidDeck/pull/1614). +- @visail made their first contribution in [#1660](https://github.com/Droid-Deck/DroidDeck/pull/1660). +- @LingWindT made their first contribution in [#1716](https://github.com/Droid-Deck/DroidDeck/pull/1716). +- @w1novnik made their first contribution in [#1759](https://github.com/Droid-Deck/DroidDeck/pull/1759). +- @vitamin663-sys made their first contribution in [#1780](https://github.com/Droid-Deck/DroidDeck/pull/1780). +- @OmarAlTaki1 made their first contribution in [#1870](https://github.com/Droid-Deck/DroidDeck/pull/1870). +- @Systina12 made their first contribution in [#1931](https://github.com/Droid-Deck/DroidDeck/pull/1931). +- @Mi-Yomi made their first contribution in [#1938](https://github.com/Droid-Deck/DroidDeck/pull/1938). +- @mr-abccc made their first contribution in [#1950](https://github.com/Droid-Deck/DroidDeck/pull/1950). +- @danielnoam made their first contribution in [#1962](https://github.com/Droid-Deck/DroidDeck/pull/1962). +- @DavidCimo made their first contribution in [#2029](https://github.com/Droid-Deck/DroidDeck/pull/2029). +- @Leask made their first contribution in [#2029](https://github.com/Droid-Deck/DroidDeck/pull/2029). +- @stefanz92 made their first contribution in [#2029](https://github.com/Droid-Deck/DroidDeck/pull/2029). +- @uubooster-team made their first contribution in [#2038](https://github.com/Droid-Deck/DroidDeck/pull/2038). +- @realRurichan made their first contribution in [#2113](https://github.com/Droid-Deck/DroidDeck/pull/2113). +- @flexeykinDev made their first contribution in [#2116](https://github.com/Droid-Deck/DroidDeck/pull/2116). +- @phj1081 made their first contribution in [#2126](https://github.com/Droid-Deck/DroidDeck/pull/2126). +- @KeegantheVeganat0r made their first contribution in [#2127](https://github.com/Droid-Deck/DroidDeck/pull/2127). + +[Full changelog](https://github.com/Droid-Deck/DroidDeck/compare/0.6.9...0.7.0) diff --git a/docs/releases/0.7.1.md b/docs/releases/0.7.1.md new file mode 100644 index 0000000000..5633edbb89 --- /dev/null +++ b/docs/releases/0.7.1.md @@ -0,0 +1,55 @@ +# DroidDeck 0.7.1 + +

+ Download DroidDeck 0.7.1 + Join the DroidDeck Discord +

+ +**DroidDeck is 100% open source. No ads. No telemetry. No proprietary components. No source withheld.** + +0.7.1 is a fix release for 0.7.0. Since 0.7.0, **4 people** sent **33 pull requests**, and **2 of them are first-time contributors**. It fixes Steam launches that hung at "Processing install script", the endless loading screen after quitting a game and colour on PowerVR, plus GOG DLC and a new launcher theme. + +### Features + +- Added the **Scarlet snow** launcher theme, DroidDeck’s first light theme. (@EnzoDLofi, [#2262](https://github.com/Droid-Deck/DroidDeck/pull/2262)) +- Added **left and right picture alignment** next to top and bottom. The controller pointer and direct touch follow the moved picture, also with glasses. (@EnzoDLofi, [#2384](https://github.com/Droid-Deck/DroidDeck/pull/2384)) +- **GOG installs the DLC you own**, and the GOG search reaches GOG’s whole catalog. (@maxjivi05, [#2348](https://github.com/Droid-Deck/DroidDeck/pull/2348), [#2296](https://github.com/Droid-Deck/DroidDeck/pull/2296)) + +### Fixed + +- Fixed **Steam games stuck at “Processing install script”** or a download that never finishes, and the black screen with “Abort game” after quitting, which started in 0.7.0. (@xXJSONDeruloXx, [#2303](https://github.com/Droid-Deck/DroidDeck/pull/2303)) +- Fixed **a game launched from DroidDeck stalling at Steam’s launch screen**: DroidDeck now waits for Steam to be ready. (@maxjivi05, [#2362](https://github.com/Droid-Deck/DroidDeck/pull/2362)) +- Fixed **an endless loading screen** after a game exits back to Steam. (@maxjivi05, [#2359](https://github.com/Droid-Deck/DroidDeck/pull/2359)) +- The bottom-screen Dashboard’s **Notifications page is removed**, so DroidDeck no longer asks to read your notifications. (@xXJSONDeruloXx, [#2342](https://github.com/Droid-Deck/DroidDeck/pull/2342)) +- Fixed **grayscale Steam and games on PowerVR** (Pixel 10 Pro and Pro XL) since the Ubuntu 26.04 runtime. (@maxjivi05, [#2287](https://github.com/Droid-Deck/DroidDeck/pull/2287)) +- Fixed **games that need EasyAntiCheat** never starting: Linux-only tools such as the Proton EasyAntiCheat Runtime keep their native platform. (@maxjivi05, [#2313](https://github.com/Droid-Deck/DroidDeck/pull/2313)) +- Fixed **a Proton picked in Steam**, such as Proton Experimental, being switched back to DroidDeck-Proton, and **store apps launched before Steam opens** reporting that no Proton is installed. (@maxjivi05, [#2284](https://github.com/Droid-Deck/DroidDeck/pull/2284), [#2392](https://github.com/Droid-Deck/DroidDeck/pull/2392)) +- Fixed **games failing with `c000007b`** after an installer put an x64 system DLL into an ARM64 prefix. (@maxjivi05, [#2318](https://github.com/Droid-Deck/DroidDeck/pull/2318)) +- Fixed **emulators and other AppImage, Flatpak and Snap programs** rendering through system memory on Adreno. They get the game GPU setting, and Flatpak apps open their window instead of playing audio only. (@maxjivi05, [#2288](https://github.com/Droid-Deck/DroidDeck/pull/2288), [#2295](https://github.com/Droid-Deck/DroidDeck/pull/2295), [#2391](https://github.com/Droid-Deck/DroidDeck/pull/2391)) +- Fixed **Linux emulators that run guest code natively** hanging on launch. (@maxjivi05, [#2279](https://github.com/Droid-Deck/DroidDeck/pull/2279)) +- Fixed **Firefox tabs crashing** and the **desktop browser hanging** in the Desktop session. (@xXJSONDeruloXx, @maxjivi05, [#2360](https://github.com/Droid-Deck/DroidDeck/pull/2360), [#2304](https://github.com/Droid-Deck/DroidDeck/pull/2304)) +- Fixed **taps on pop-up dialogs** and windows away from the screen’s top-left corner doing nothing. (@maxjivi05, [#2280](https://github.com/Droid-Deck/DroidDeck/pull/2280), [#2285](https://github.com/Droid-Deck/DroidDeck/pull/2285)) +- Fixed **direct touch with Relative mouse: Auto** turning taps into small mouse movements when no mouse is connected. (@maxjivi05, [#2305](https://github.com/Droid-Deck/DroidDeck/pull/2305)) +- Fixed **the Controls below the game tabs** being cut off, which left the panel stuck on the trackpads. (@maxjivi05, [#2302](https://github.com/Droid-Deck/DroidDeck/pull/2302)) +- Fixed **GOG**: owned games missing from the library since 0.6.0 are back, and install scripts’ support files reach the prefix, so modded editions start as installed. (@maxjivi05, [#2296](https://github.com/Droid-Deck/DroidDeck/pull/2296), [#2294](https://github.com/Droid-Deck/DroidDeck/pull/2294)) +- Fixed **stutter on devices with 13 GB of RAM or less**: game memory the game reads straight back is no longer compressed again every 30 s. (@maxjivi05, [#2312](https://github.com/Droid-Deck/DroidDeck/pull/2312)) +- Fixed **the frame graph jumping around** on the bottom-screen Dashboard’s In-game stats. (@xXJSONDeruloXx, [#2345](https://github.com/Droid-Deck/DroidDeck/pull/2345)) +- Fixed smaller things: programs whose allocator calls a hooked function at startup no longer abort with the input preload, `droiddeckctl` works on shells without the `content` command such as the Retroid Pocket Duo’s, a full disk no longer crashes the app on an agent call, and ending a session without the graphics runtime pack no longer logs an error. (@xXJSONDeruloXx, @maxjivi05, [#2361](https://github.com/Droid-Deck/DroidDeck/pull/2361), [#2321](https://github.com/Droid-Deck/DroidDeck/pull/2321), [#2325](https://github.com/Droid-Deck/DroidDeck/pull/2325), [#2316](https://github.com/Droid-Deck/DroidDeck/pull/2316)) + +### Community + +These are everyone whose code is in 0.7.1: + +| Contributor | Pull requests | +|---|---| +| @maxjivi05 | 22: Steam launch readiness, PowerVR colour, GOG DLC and library, AppImage and Flatpak GPU setting, dialog taps, EasyAntiCheat and more | +| @xXJSONDeruloXx | 8: Steam session bus, notification listener removal, Firefox in the desktop, `droiddeckctl` and more | +| @EnzoDLofi | 2: Scarlet snow theme, left and right picture alignment | +| @GiovanniCarbinatti | 1: README GPU support | + +### New contributors + +- @EnzoDLofi made their first contribution in [#2262](https://github.com/Droid-Deck/DroidDeck/pull/2262). +- @GiovanniCarbinatti made their first contribution in [#2311](https://github.com/Droid-Deck/DroidDeck/pull/2311). + +[Full changelog](https://github.com/Droid-Deck/DroidDeck/compare/0.7.0...0.7.1) diff --git a/docs/releases/media/0.7.0/controller-profiles.jpg b/docs/releases/media/0.7.0/controller-profiles.jpg new file mode 100644 index 0000000000..0bb15df239 Binary files /dev/null and b/docs/releases/media/0.7.0/controller-profiles.jpg differ diff --git a/docs/releases/media/0.7.0/dashboard.jpg b/docs/releases/media/0.7.0/dashboard.jpg new file mode 100644 index 0000000000..54cf4c35e9 Binary files /dev/null and b/docs/releases/media/0.7.0/dashboard.jpg differ diff --git a/docs/releases/media/0.7.0/game-jolt.jpg b/docs/releases/media/0.7.0/game-jolt.jpg new file mode 100644 index 0000000000..7671962153 Binary files /dev/null and b/docs/releases/media/0.7.0/game-jolt.jpg differ diff --git a/docs/releases/media/0.7.0/hud-dock.gif b/docs/releases/media/0.7.0/hud-dock.gif new file mode 100644 index 0000000000..f544c65a53 Binary files /dev/null and b/docs/releases/media/0.7.0/hud-dock.gif differ diff --git a/docs/releases/media/0.7.0/hud-strip.jpg b/docs/releases/media/0.7.0/hud-strip.jpg new file mode 100644 index 0000000000..d203338441 Binary files /dev/null and b/docs/releases/media/0.7.0/hud-strip.jpg differ diff --git a/docs/releases/media/0.7.0/kde-desktop.gif b/docs/releases/media/0.7.0/kde-desktop.gif new file mode 100644 index 0000000000..fbd3543288 Binary files /dev/null and b/docs/releases/media/0.7.0/kde-desktop.gif differ diff --git a/docs/releases/media/0.7.0/mali-support.jpg b/docs/releases/media/0.7.0/mali-support.jpg new file mode 100644 index 0000000000..9f7de5d2cb Binary files /dev/null and b/docs/releases/media/0.7.0/mali-support.jpg differ diff --git a/docs/releases/media/0.7.0/steam-libraries.jpg b/docs/releases/media/0.7.0/steam-libraries.jpg new file mode 100644 index 0000000000..9fd2964757 Binary files /dev/null and b/docs/releases/media/0.7.0/steam-libraries.jpg differ diff --git a/docs/releases/media/0.7.0/swap-game-bottom.jpg b/docs/releases/media/0.7.0/swap-game-bottom.jpg new file mode 100644 index 0000000000..79560e02da Binary files /dev/null and b/docs/releases/media/0.7.0/swap-game-bottom.jpg differ diff --git a/docs/releases/media/0.7.0/syncthing.jpg b/docs/releases/media/0.7.0/syncthing.jpg new file mode 100644 index 0000000000..37de627ddc Binary files /dev/null and b/docs/releases/media/0.7.0/syncthing.jpg differ diff --git a/tools/agent/android-open b/tools/agent/android-open new file mode 100755 index 0000000000..9d8c550486 --- /dev/null +++ b/tools/agent/android-open @@ -0,0 +1,9 @@ +#!/bin/sh +# Opens a URL in Android's browser on the bottom screen. +url=$1 +[ -n "$url" ] || exit 1 +serial=${ADB_SERIAL:-127.0.0.1:5555} +adb connect "$serial" >/dev/null 2>&1 +quoted=$(printf "%s" "$url" | sed "s/'/'\\\\''/g") +adb -s "$serial" shell "am start --display 2 -a android.intent.action.VIEW -d '$quoted'" >/dev/null 2>&1 || + echo "Open this on any device: $url" >&2 diff --git a/tools/agent/dd-agent b/tools/agent/dd-agent new file mode 100755 index 0000000000..9a1b4d4132 --- /dev/null +++ b/tools/agent/dd-agent @@ -0,0 +1,5 @@ +#!/bin/sh +# Claude Code in the DroidDeck checkout, with sign-in links opened in Android's browser. +export ADB_SERIAL=${ADB_SERIAL:-127.0.0.1:5555} PATH="$HOME/.local/bin:$PATH" BROWSER="$HOME/.local/bin/android-open" +adb connect "$ADB_SERIAL" >/dev/null 2>&1 +cd "$HOME/DroidDeck" && exec claude "$@" diff --git a/tools/agent/dd-gh-login b/tools/agent/dd-gh-login new file mode 100755 index 0000000000..adf816a247 --- /dev/null +++ b/tools/agent/dd-gh-login @@ -0,0 +1,24 @@ +#!/bin/bash +# GitHub sign-in through Android's browser on the bottom screen, with the one-time code typed in. +serial=${ADB_SERIAL:-127.0.0.1:5555} +adb connect "$serial" >/dev/null 2>&1 +coproc GH { BROWSER=true gh auth login --hostname github.com --git-protocol https --web 2>&1; } +gh_pid=$GH_PID +typed= +while IFS= read -r line <&"${GH[0]}"; do + printf '%s\n' "$line" + code=$(grep -oE '[A-Z0-9]{4}-[A-Z0-9]{4}' <<<"$line" | head -1) + if [ -n "$code" ] && [ -z "$typed" ]; then + typed=1 + echo >&"${GH[1]}" + adb -s "$serial" shell "am start --display 2 -a android.intent.action.VIEW -d https://github.com/login/device" >/dev/null 2>&1 + # Chrome drops characters from `input text` and from fast key events on this page. + keys= + for ((i = 0; i < ${#code}; i++)); do + c=${code:i:1} + [ "$c" = - ] || keys+="input -d 2 keyevent KEYCODE_$c; sleep 0.4; " + done + (sleep 7; adb -s "$serial" shell "$keys" >/dev/null 2>&1) & + fi +done +wait "$gh_pid" diff --git a/tools/agent/dd-lab-build b/tools/agent/dd-lab-build new file mode 100755 index 0000000000..44b62bd6b8 --- /dev/null +++ b/tools/agent/dd-lab-build @@ -0,0 +1,226 @@ +#!/bin/bash +# Builds this checkout as a Lab build of the installed DroidDeck and restarts the app on it. +# Usage: dd-lab-build [--no-restart | --prepare] [--explain] +# --prepare compiles the installed commit without making a Lab build, so later builds only +# compile what changed. Setup runs it once; it takes the longest. +# --explain logs why each task ran and Kotlin's build report, to find out what makes a build slow. +set -euo pipefail +pkg=com.droiddeck.launcher +serial=${ADB_SERIAL:-127.0.0.1:5555} +mode=build +explain=() +for arg in "$@"; do + case $arg in + --no-restart) mode=no-restart ;; + --prepare) mode=prepare ;; + --explain) explain=(--info -Pkotlin.build.report.output=file) ;; + esac +done +started=$(date +%s) +cache=$HOME/.cache +progress_file=$cache/dd-lab-build.json +times_file=$cache/dd-lab-build-times +mkdir -p "$cache" +# The Agent tab reads this file to show how far the build has got and how long is left. +progress() { # stage [permille task done total eta] + local task=${3:-}; task=${task//\\/}; task=${task//\"/\'}; task=${task//$'\n'/ } + printf '{"stage":"%s","mode":"%s","permille":%d,"task":"%s","done":%d,"total":%d,"eta":%d,"elapsed":%d,"pid":%d}\n' \ + "$1" "$mode" "${2:-0}" "$task" "${4:-0}" "${5:-0}" "${6:--1}" $(( $(date +%s) - started )) $$ > "$progress_file.part.$BASHPID" + mv "$progress_file.part.$BASHPID" "$progress_file" +} +fail() { progress failed 0 "$*"; echo "dd-lab-build: $*" >&2; exit 1; } +trap 'progress failed 0 stopped; exit 143' INT TERM +trap 'progress failed 0 "a command failed on line $LINENO"' ERR +device() { adb -s "$serial" shell "$@" | tr -d '\r'; } + +# The app's agent loses every process it started when its turn ends, a build included, so it asks +# the app to run the build in a process of its own and follows that build here. +agent=/data/user/0/$pkg/files/agent +if [ -n "${DD_AGENT:-}" ] && [ -z "${DD_LAB_DETACHED:-}" ] && [ -d "$agent" ]; then + trap - ERR + log=$cache/dd-lab-build.log + rm -f "$progress_file" + python3 -c 'import json,os,sys; print(json.dumps({"cwd": os.getcwd(), "args": sys.argv[1:]}))' "$@" > "$agent/lab-request.part" + mv "$agent/lab-request.part" "$agent/lab-request" + echo "DroidDeck runs this build itself, so it keeps going if this turn ends. Its log follows." + for _ in $(seq 1 30); do [ -f "$progress_file" ] && break; sleep 1; done + [ -f "$progress_file" ] || { echo "dd-lab-build: DroidDeck did not start the build; is it running?" >&2; exit 1; } + tail -n +1 -F "$log" 2>/dev/null & follow=$! + result=1 + while sleep 2; do + stage=$(sed -n 's/.*"stage":"\([a-z]*\)".*/\1/p' "$progress_file") + pid=$(sed -n 's/.*"pid":\([0-9]*\).*/\1/p' "$progress_file") + case $stage in + ready|prepared) result=0; break ;; + failed) break ;; + esac + [ -n "$pid" ] && [ -d "/proc/$pid" ] || break + done + sleep 1; kill $follow 2>/dev/null || true + exit $result +fi + +progress checking +repo=$(git rev-parse --show-toplevel) || fail "run it inside the DroidDeck checkout" +cd "$repo" +adb connect "$serial" >/dev/null 2>&1 || true + +state=$(python3 tools/droiddeckctl state 2>/dev/null | sed -n '/^{/,$p') || fail "could not read DroidDeck's state; is it running and is adb connected?" +# A Lab build reports its own label, so the APK's commit comes from apkCommit when the app has it. +label=$(python3 -c 'import json,sys; s=json.load(sys.stdin); print(s.get("apkCommit") or s["build"].rsplit(" at ", 1)[-1])' <<<"$state") || + fail "DroidDeck's state did not say which build is installed" +installed_label=$(python3 -c 'import json,re,sys; print(re.sub(r"^(?:\w+ \w+ · |lab on )+", "", json.load(sys.stdin)["build"]))' <<<"$state") +if ! base=$(git rev-parse --verify --quiet "$label^{commit}"); then + progress fetching 0 "the installed commit" + git fetch --quiet --tags origin >/dev/null 2>&1 || true + git fetch --quiet origin main >/dev/null 2>&1 || true + base=$(git rev-parse --verify --quiet "$label^{commit}") || fail "the installed build ($label) is not in this checkout or on GitHub's main; fetch it first" +fi + +if [ $mode = prepare ]; then + # Compiling the installed commit itself gives later builds of branches on it incremental caches. + if ! git merge-base --is-ancestor "$base" HEAD; then + git diff --quiet && git diff --cached --quiet || fail "HEAD does not build on the installed commit and has uncommitted changes" + was=$(git branch --show-current) + git checkout --quiet --detach "$base" + echo "Checked out the installed commit ${base:0:9} to prepare it${was:+; $was is unchanged}" + fi +else + git diff --quiet && git diff --cached --quiet || fail "commit your changes first" + git merge-base --is-ancestor "$base" HEAD || fail "HEAD does not build on the installed commit ${base:0:9}; branch from it" + blocked=$(git diff --name-only "$base" HEAD | grep -E 'AndroidManifest\.xml$|/cpp/|/jniLibs/|\.rs$|(^|/)build\.gradle$|/App\.kt$|/AppLanguage\.kt$|/lab/LabOverlay\.kt$' || true) + [ -z "$blocked" ] || fail "these need a new APK, not a Lab build: $(echo $blocked)" +fi +apk=$(device pm path $pkg | sed -n 's/^package://p' | grep 'base\.apk$' | head -1) +[ -n "$apk" ] || fail "DroidDeck is not installed" + +export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-arm64 ANDROID_HOME=$HOME/android-sdk +# BuildConfig describes the installed base, not each Lab commit; its commit changing would make the +# Kotlin compile redo the whole app (the overlay's own label names the Lab build). Updates reads the +# installed variant (non-adreno) from the build label. +export DROIDDECK_SOURCE_COMMIT=$base DROIDDECK_BUILD_LABEL="lab on $installed_label" DROIDDECK_BUILD_TREE_STATE=clean GITHUB_HEAD_REF=lab +printf 'sdk.dir=%s\n' "$ANDROID_HOME" > local.properties +if [ ! -d "$ANDROID_HOME/platforms/android-34" ]; then + progress sdk + yes | "$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager" --licenses >/dev/null + "$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager" "platforms;android-34" "build-tools;35.0.0" >/dev/null +fi + +# A full Kotlin compile of the app needs about 2.5 GB of heap and Gradle about 1 GB; smaller devices get +# what they can spare. Both daemons end with this script's process when the build is done. +total_mb=$(awk '/^MemTotal:/ {print int($2 / 1024)}' /proc/meminfo) +heap=$(( total_mb / 2 )); [ $heap -gt 4096 ] && heap=4096; [ $heap -lt 2048 ] && heap=2048 +heap=${DD_LAB_HEAP_MB:-$heap} +kotlin_heap=$(( heap * 2 / 3 )); gradle_heap=$(( heap - kotlin_heap )) + +# Only the Kotlin daemon compiles incrementally; in-process compiles always redo the whole app, and the +# caches they leave behind make the daemon's first incremental compile fail. +if [ "$(cat "$cache/dd-lab-build-strategy" 2>/dev/null)" != daemon ]; then + rm -rf app/build/kotlin/compileReleaseKotlin + echo daemon > "$cache/dd-lab-build-strategy" +fi + +# Google publishes aapt2 for x86-64 Linux only; setup wraps it in qemu-user at ~/aapt2/aapt2. +gradle=(./gradlew :app:processReleaseResources :app:mergeDexRelease --max-workers=2 -PskipRust=true -x buildVkBridgeServer + -Pandroid.aapt2FromMavenOverride=$HOME/aapt2/aapt2 -Pkotlin.compiler.execution.strategy=daemon + -Pkotlin.daemon.jvmargs=-Xmx${kotlin_heap}m -Dorg.gradle.jvmargs=-Xmx${gradle_heap}m --console=plain) +progress planning +mapfile -t plan < <("${gradle[@]}" --dry-run -q 2>/dev/null | awk '/^:/ {print $1}' || true) +total=${#plan[@]} + +# Each task's estimate is how long it took last time; a full compile of the app takes about 15 minutes. +declare -A estimate +[ -f "$times_file" ] && while read -r t s; do estimate[$t]=$s; done < "$times_file" +estimate_of() { local e=${estimate[$1]:-}; [ -n "$e" ] && echo "$e" || { [[ $1 == *compileReleaseKotlin ]] && echo 900 || echo 2; }; } +planned=0 +for t in "${plan[@]}"; do planned=$(( planned + $(estimate_of "$t") )); done +[ $planned -gt 0 ] || planned=1 + +current=$(mktemp) +measured=$(mktemp) +# " " +echo "0 starting $(date +%s) 0 0" > "$current" +report() { + local n task since done_s cur_est now part permille left + read -r n task since done_s cur_est < "$current" + now=$(date +%s) + part=$(( now - since )); [ $part -gt $(( cur_est * 95 / 100 )) ] && part=$(( cur_est * 95 / 100 )) + permille=$(( (done_s + part) * 1000 / planned )); [ $permille -gt 990 ] && permille=990 + left=$(( planned - done_s - part )); [ $left -lt 0 ] && left=0 + progress building "$permille" "$task" "$n" "$total" "$left" + echo "$n $task $(( (now - started) / 60 )) $left" +} +( + beat=0 + while sleep 5; do + set -- $(report) + beat=$(( beat + 1 )) + [ $(( beat % 12 )) = 0 ] && echo "[build $1/$total] still on $2, $3m in, about $(( $4 / 60 + 1 ))m left" + done +) & +heartbeat=$! +trap 'kill $heartbeat 2>/dev/null || true; rm -f "$current" "$measured"' EXIT +set +o pipefail +"${gradle[@]}" ${explain[@]+"${explain[@]}"} 2>&1 | { + n=0 done_s=0 task="" since=0 cur_est=0 ran=0 + while IFS= read -r line; do + printf '%s\n' "$line" + case $line in + "> Task "*) + now=$(date +%s) + # A task's line comes when it starts, or when it ends for one that did no work. + if [ -n "$task" ]; then + done_s=$(( done_s + cur_est )) + [ $ran = 1 ] && echo "$task $(( now - since ))" >> "$measured" + fi + rest=${line#> Task }; task=${rest%% *} + case $rest in *" "*) ran=0 ;; *) ran=1 ;; esac + n=$((n + 1)); since=$now; cur_est=$(estimate_of "$task") + echo "$n $task $since $done_s $cur_est" > "$current" + [ $ran = 1 ] && report >/dev/null && echo "[build $n/$total] $task" ;; + esac + done + if [ -n "$task" ] && [ $ran = 1 ]; then echo "$task $(( $(date +%s) - since ))" >> "$measured"; fi +} +status=${PIPESTATUS[0]} +set -o pipefail +kill $heartbeat 2>/dev/null || true +[ "$status" = 0 ] || fail "Gradle failed (exit $status); the reason is above" +# Tasks that did no work this time keep their earlier time. +{ [ -f "$times_file" ] && cat "$times_file"; cat "$measured"; } | awk '{t[$1] = $2} END {for (k in t) print k, t[k]}' > "$times_file.part" +mv "$times_file.part" "$times_file" +# The app reads which installed commit the build caches are warm for. +echo "$base" > "$cache/dd-lab-build-base" + +if [ $mode = prepare ]; then + progress prepared 1000 + echo "Prepared: Lab builds of branches on ${base:0:9} now compile only what changed ($(( ($(date +%s) - started) / 60 ))m)" + exit 0 +fi + +progress packaging 995 +linked=$(ls app/build/intermediates/linked_resources_binary_format/release/processReleaseResources/*.ap_ | head -1) +work=$(mktemp -d) +cp "$linked" "$work/overlay.apk" +(cd app/build/intermediates/dex/release/mergeDexRelease && zip -q "$work/overlay.apk" classes*.dex) +name="$(git branch --show-current) @ $(git rev-parse --short HEAD)" +python3 -c 'import json,sys,time; print(json.dumps({"label": sys.argv[1], "baseCommit": sys.argv[2], "baseApk": sys.argv[3], "built": int(time.time())}))' \ + "$name" "$label" "$apk" > "$work/overlay.json" + +lab=/data/user/0/$pkg/files/lab +mkdir -p "$lab" +rm -rf "$lab/next.part" "$lab/next" +mv "$work" "$lab/next.part" +mv "$lab/next.part" "$lab/next" +progress ready 1000 "$name" +echo "Lab build ready: $name ($(du -h "$lab/next/overlay.apk" | cut -f1)) in $(( ($(date +%s) - started) / 60 ))m" +[ $mode = build ] || exit 0 + +# Classes in an app image load before the Lab build can, so the app is recompiled without one. +device cmd package compile -m verify -f $pkg >/dev/null +progress restarting 1000 "$name" +echo "Restarting DroidDeck on the Lab build; it shows a notification when it is back" +# The app's own agent ends with the app, so it is told to carry on once the app is back. +if [ -n "${DD_AGENT:-}" ]; then mkdir -p "/data/user/0/$pkg/files/agent" && : > "/data/user/0/$pkg/files/agent/resume"; fi +device "nohup sh -c 'sleep 3; monkey -p $pkg -c android.intent.category.LAUNCHER 1' >/dev/null 2>&1 &" +for pid in $(device pidof $pkg); do kill "$pid" 2>/dev/null || true; done diff --git a/tools/agent/setup b/tools/agent/setup new file mode 100755 index 0000000000..49dd82592a --- /dev/null +++ b/tools/agent/setup @@ -0,0 +1,76 @@ +#!/bin/bash +# Sets up the on-device agent inside DroidDeck's Linux userland: Claude Code, git and gh, loopback +# adb for droiddeckctl, and the toolchain dd-lab-build uses to build Lab builds on the device. +# Run it from the DroidDeck terminal, inside a checkout of the DroidDeck repository. +set -euo pipefail +here=$(cd "$(dirname "$0")" && pwd) +export DEBIAN_FRONTEND=noninteractive +tmp=$(mktemp -d) +trap 'rm -rf "$tmp"' EXIT + +apt-get install -y --no-install-recommends git gh adb python3 zip unzip curl openjdk-17-jdk-headless qemu-user zipalign apksigner + +command -v claude >/dev/null || [ -x "$HOME/.local/bin/claude" ] || + { curl -fsSL -o "$tmp/install-claude.sh" https://claude.ai/install.sh && bash "$tmp/install-claude.sh"; } + +mkdir -p "$HOME/.local/bin" +for tool in dd-agent dd-lab-build dd-gh-login android-open; do install -m755 "$here/$tool" "$HOME/.local/bin/$tool"; done +grep -q 'droiddeck-agent-path' "$HOME/.bashrc" 2>/dev/null || + printf '\n# droiddeck-agent-path\nexport PATH="$HOME/.local/bin:$PATH" ADB_SERIAL=127.0.0.1:5555 BROWSER="$HOME/.local/bin/android-open"\n' >> "$HOME/.bashrc" + +# Google publishes aapt2 for x86-64 Linux only; it runs here under qemu-user with Ubuntu's x86-64 runtime. +x86=$HOME/x86root +mkdir -p "$HOME/aapt2/x86" "$x86/etc" +if [ ! -x "$HOME/aapt2/x86/aapt2" ]; then + agp=$(sed -n "s/.*com.android.tools.build:gradle:\([0-9.]*\).*/\1/p" "$here/../../build.gradle" | head -1) + [ -n "$agp" ] || { echo "setup: no Android Gradle plugin version in build.gradle" >&2; exit 1; } + aapt2=$(curl -fsSL "https://dl.google.com/android/maven2/com/android/tools/build/aapt2/maven-metadata.xml" | + { grep -o "$agp-[0-9]*" || true; } | tail -1 | sed 's/<[^>]*>//g') + [ -n "$aapt2" ] || { echo "setup: Google publishes no aapt2 for AGP $agp" >&2; exit 1; } + curl -fsSL -o "$tmp/aapt2.jar" "https://dl.google.com/android/maven2/com/android/tools/build/aapt2/$aapt2/aapt2-$aapt2-linux.jar" + unzip -o -q "$tmp/aapt2.jar" aapt2 -d "$HOME/aapt2/x86" + chmod +x "$HOME/aapt2/x86/aapt2" +fi +if [ ! -e "$x86/lib64/ld-linux-x86-64.so.2" ]; then + codename=$(. /etc/os-release && echo "$VERSION_CODENAME") + curl -fsSL "https://archive.ubuntu.com/ubuntu/dists/$codename/main/binary-amd64/Packages.gz" | gunzip > "$tmp/amd64-packages" + for package in libc6 libgcc-s1 libstdc++6 zlib1g; do + read -r file sum < <(awk -v p="$package" '$0 == "Package: " p {found = 1} found && /^Filename:/ {f = $2} + found && /^SHA256:/ {s = $2} found && /^$/ {exit} END {print f, s}' "$tmp/amd64-packages") + [ -n "$sum" ] || { echo "setup: $package is not in Ubuntu $codename's amd64 index" >&2; exit 1; } + curl -fsSL -o "$tmp/$package.deb" "https://archive.ubuntu.com/ubuntu/$file" + echo "$sum $tmp/$package.deb" | sha256sum -c --quiet - + dpkg-deb -x "$tmp/$package.deb" "$x86" + done + ln -sfn usr/lib64 "$x86/lib64" + ln -sfn usr/lib "$x86/lib" + : > "$x86/etc/ld.so.preload" +fi +# AGP only accepts a custom aapt2 whose file is named aapt2. +printf '#!/bin/sh\nexec qemu-x86_64 -L %s %s/aapt2/x86/aapt2 "$@"\n' "$x86" "$HOME" > "$HOME/aapt2/aapt2" +chmod +x "$HOME/aapt2/aapt2" +"$HOME/aapt2/aapt2" version + +sdk=$HOME/android-sdk +if [ ! -x "$sdk/cmdline-tools/latest/bin/sdkmanager" ]; then + mkdir -p "$sdk/cmdline-tools" + curl -fsSL -o "$tmp/cmdline-tools.zip" https://dl.google.com/android/repository/commandlinetools-linux-13114758_latest.zip + unzip -q -o "$tmp/cmdline-tools.zip" -d "$sdk/cmdline-tools" + rm -rf "$sdk/cmdline-tools/latest" + mv "$sdk/cmdline-tools/cmdline-tools" "$sdk/cmdline-tools/latest" +fi +export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-arm64 +yes | "$sdk/cmdline-tools/latest/bin/sdkmanager" --licenses >/dev/null +"$sdk/cmdline-tools/latest/bin/sdkmanager" "platforms;android-34" "build-tools;35.0.0" >/dev/null + +adb connect 127.0.0.1:5555 || true +# The first build compiles the whole app; doing it now makes the agent's Lab builds incremental. +if [ "${DD_SKIP_PREPARE:-}" != 1 ]; then + echo "Approve the USB debugging prompt if one appears." + if timeout 120 adb -s 127.0.0.1:5555 wait-for-device; then + "$here/dd-lab-build" --prepare || echo "The first Lab build will compile the whole app" + else + echo "adb did not connect, so the first Lab build will compile the whole app" + fi +fi +echo "Done. Run dd-agent." diff --git a/tools/build_local.sh b/tools/build_local.sh index 041d6b3131..d564f1e3c0 100755 --- a/tools/build_local.sh +++ b/tools/build_local.sh @@ -133,6 +133,7 @@ docker run --rm --platform "${docker_platform}" \ aarch64-linux-gnu-gcc -shared -fPIC -O2 -Wall -pthread \ -o "$d/libblfastpath.so" tools/proot/fastpath/fastpath.c -ldl aarch64-linux-gnu-strip --strip-unneeded "$d/libblfastpath.so" + bash tools/nativeguest/build.sh "$d/libddnatv-hook.so" aarch64-linux-gnu-gcc -shared -fPIC -O2 -Wall -nostdlib -ffreestanding -fno-stack-protector \ -fno-tree-loop-distribute-patterns -Wl,-z,defs -o "$d/libblaudit.so" tools/proot/fastpath/audit.c aarch64-linux-gnu-strip --strip-unneeded "$d/libblaudit.so" @@ -424,6 +425,15 @@ if ! restore_step comet "${comet_key}" "${comet_out}"; then DROIDDECK_BUILD_IMAGE="${image_name}" bash tools/comet/build-local.sh save_step comet "${comet_key}" "${comet_out}" fi +if [[ "${DROIDDECK_SKIP_RUST:-0}" != 1 ]]; then + upc_out="${linuxfs_dir}/usr/local/lib/droiddeck-ubisoft" + upc_key=$(inputs_hash "x86_64-pc-windows-gnu" tools/ubisoft-launcher/src tools/ubisoft-launcher/Cargo.toml tools/ubisoft-launcher/Cargo.lock tools/ubisoft-launcher/build.sh) + if ! restore_step ubisoft "${upc_key}" "${upc_out}"; then + command -v x86_64-w64-mingw32-gcc >/dev/null 2>&1 || { echo "x86_64-w64-mingw32-gcc is required for the Ubisoft launcher service (droiddeck-upc.exe)." >&2; exit 1; } + CARGO_TARGET_DIR="${cache_dir}/ubisoft-target" bash tools/ubisoft-launcher/build.sh "${upc_out}" + save_step ubisoft "${upc_key}" "${upc_out}" + fi +fi python3 tools/powervr/fetch.py bash tools/packs/build.sh app/build/packs python3 tools/release/runtime_inputs.py record diff --git a/tools/ci/install-ubuntu-packages.sh b/tools/ci/install-ubuntu-packages.sh index dcccc0eb6b..d1bd5e698a 100644 --- a/tools/ci/install-ubuntu-packages.sh +++ b/tools/ci/install-ubuntu-packages.sh @@ -31,15 +31,22 @@ install_packages() { if install_packages; then exit 0 fi -echo "::warning::Runner mirror failed or timed out; retrying with the official Ubuntu mirror." [ -f "$ubuntu_sources" ] || exit 1 sources=$(mktemp --suffix=.sources) trap 'rm -f "$sources"' EXIT -mirror=https://archive.ubuntu.com/ubuntu +# The last mirror of each list is outside Canonical's network, so it still answers when runners cannot reach Canonical. +mirrors=(https://archive.ubuntu.com/ubuntu https://mirrors.edge.kernel.org/ubuntu) case "$(dpkg --print-architecture)" in - arm64) mirror=https://ports.ubuntu.com/ubuntu-ports ;; + arm64) mirrors=(https://ports.ubuntu.com/ubuntu-ports https://mirrors.ocf.berkeley.edu/ubuntu-ports) ;; esac -sed -E "s@^URIs:.*@URIs: $mirror@" "$ubuntu_sources" > "$sources" -chmod 644 "$sources" -options[1]="Dir::Etc::sourcelist=$sources" -install_packages +status=1 +for mirror in "${mirrors[@]}"; do + echo "::warning::Ubuntu mirror failed or timed out; retrying with $mirror." + sed -E "s@^URIs:.*@URIs: $mirror@" "$ubuntu_sources" > "$sources" + chmod 644 "$sources" + options[1]="Dir::Etc::sourcelist=$sources" + status=0 + install_packages || status=$? + [ "$status" = 0 ] && exit 0 +done +exit "$status" diff --git a/tools/components/build-arm64-preloads.sh b/tools/components/build-arm64-preloads.sh index a38a1edaaa..e06aa2afc1 100644 --- a/tools/components/build-arm64-preloads.sh +++ b/tools/components/build-arm64-preloads.sh @@ -12,6 +12,7 @@ aarch64-linux-gnu-strip --strip-unneeded "$D/libblsession.so" aarch64-linux-gnu-gcc -shared -fPIC -O2 -Wall -pthread \ -o "$D/libblfastpath.so" tools/proot/fastpath/fastpath.c -ldl aarch64-linux-gnu-strip --strip-unneeded "$D/libblfastpath.so" +bash tools/nativeguest/build.sh "$D/libddnatv-hook.so" aarch64-linux-gnu-gcc -shared -fPIC -O2 -Wall -nostdlib -ffreestanding -fno-stack-protector \ -fno-tree-loop-distribute-patterns -Wl,-z,defs -o "$D/libblaudit.so" tools/proot/fastpath/audit.c aarch64-linux-gnu-strip --strip-unneeded "$D/libblaudit.so" diff --git a/tools/components/preloads.py b/tools/components/preloads.py index 808d510463..36d0b3dcc8 100644 --- a/tools/components/preloads.py +++ b/tools/components/preloads.py @@ -51,6 +51,7 @@ def source_files(group, root=ROOT, commit=None, patterns=None): if not paths: raise ValueError('No preload inputs found') result = {} + listed = set(paths) pending = list(paths) while pending: path = pending.pop() @@ -58,7 +59,13 @@ def source_files(group, root=ROOT, commit=None, patterns=None): continue if path.startswith('../') or path.startswith('/'): raise ValueError('Preload include escapes repository') - content = read(path).replace(b'\r\n', b'\n') + try: + content = read(path).replace(b'\r\n', b'\n') + except (OSError, subprocess.CalledProcessError): + # a header the build generates (gosys/gosys_blob.h, included behind __has_include) + if path in listed: + raise + continue result[path] = sha(content) for include in re.findall(rb'^\s*#\s*include\s*"([^"\n]+)"', content, re.M): pending.append(posixpath.normpath(posixpath.join(posixpath.dirname(path), include.decode()))) @@ -126,13 +133,15 @@ def artifact_bytes(origin, cache): if len(names) != 1: raise ValueError('Expected one original APK') with ZipFile(io.BytesIO(archive.read(names[0]))) as apk: - return {name: apk.read('assets/linuxfs/' + name) for name in FILES} + present = set(apk.namelist()) + return {name: apk.read('assets/linuxfs/' + name) for name in FILES if 'assets/linuxfs/' + name in present} def validate_lock(data): if data.get('version') != 1 or set(data['groups']) != set(INPUTS): raise ValueError('Unsupported preload snapshot') - if set(data['outputs']) != FILES: + # A lock made before a recipe gained an output lacks it; that group is rebuilt (restore) + if not set(data['outputs']) <= FILES: raise ValueError('Unexpected preload output set') for digest in [data['archive_sha256'], *data['outputs'].values()]: if len(digest) != 64 or any(c not in '0123456789abcdef' for c in digest): @@ -160,7 +169,7 @@ def producer_sources(group, commit, root=ROOT): def prove_origin(data, cache, root=ROOT): content = artifact_bytes(data['origin'], cache) - if {name: sha(value) for name, value in content.items()} != data['outputs']: + if {name: sha(value) for name, value in content.items() if name in data['outputs']} != data['outputs']: raise ValueError('Snapshot binaries differ from the original main APK') commit = data['origin']['commit'] run('git', 'fetch', '--no-tags', 'origin', commit, root=root) @@ -183,7 +192,7 @@ def unpack(content, data): total = 0 with tarfile.open(fileobj=io.BytesIO(content), mode='r:gz') as archive: for entry in archive: - if entry.name not in FILES or entry.name in result or not entry.isfile() or entry.size > 32 * 1024 * 1024: + if entry.name not in data['outputs'] or entry.name in result or not entry.isfile() or entry.size > 32 * 1024 * 1024: raise ValueError('Unsafe or unexpected preload archive entry') total += entry.size if total > 64 * 1024 * 1024: @@ -192,7 +201,7 @@ def unpack(content, data): if sha(value) != data['outputs'][entry.name]: raise ValueError('Preload binary checksum mismatch') result[entry.name] = value - if set(result) != FILES: + if set(result) != set(data['outputs']): raise ValueError('Incomplete preload archive') return result @@ -203,6 +212,8 @@ def restore(root=ROOT): matching = {group: source_files(group, root) == data['groups'][group] for group in INPUTS} matching['arm64'] &= recipe(root) == data['arm64_recipe'] matching['x86'] &= x86_recipe(root) == data.get('x86_recipe') + for group in matching: + matching[group] &= all(name in data['outputs'] for name in OUTPUTS[group]) if os.environ.get('FORCE_PRELOAD_REBUILD') == 'true': matching = dict.fromkeys(INPUTS, False) if any(matching.values()): diff --git a/tools/components/recipes.json b/tools/components/recipes.json index b5789aa7ea..92fcc548a4 100644 --- a/tools/components/recipes.json +++ b/tools/components/recipes.json @@ -164,7 +164,8 @@ "tools/components/build-arm64-preloads.sh", "tools/linuxfs/preload", "app/src/main/cpp/fakeinput_steam.cpp", - "tools/components/recipes/arm64-preloads.sh" + "tools/components/recipes/arm64-preloads.sh", + "tools/nativeguest" ], "outputs": [ "app/src/main/assets/linuxfs/libfakeinput.so", @@ -172,7 +173,8 @@ "app/src/main/assets/linuxfs/libblfastpath.so", "app/src/main/assets/linuxfs/libblaudit.so", "app/src/main/assets/linuxfs/libssbs.so", - "app/src/main/assets/linuxfs/usr/local/bin/droiddeck-clipboard" + "app/src/main/assets/linuxfs/usr/local/bin/droiddeck-clipboard", + "app/src/main/assets/linuxfs/libddnatv-hook.so" ], "packages": [ "gcc-aarch64-linux-gnu", @@ -187,7 +189,8 @@ "tools/quest/kgsl_compat.h", "tools/proot/fastpath", "tools/linuxfs/ssbs", - "tools/linuxfs/clipboard" + "tools/linuxfs/clipboard", + "tools/nativeguest" ], "snapshot_outputs": [ "libfakeinput.so", @@ -195,7 +198,8 @@ "libblfastpath.so", "libblaudit.so", "libssbs.so", - "usr/local/bin/droiddeck-clipboard" + "usr/local/bin/droiddeck-clipboard", + "libddnatv-hook.so" ] }, "preload-snapshot": { diff --git a/tools/droiddeckctl b/tools/droiddeckctl index c9ff932c47..3e37811d28 100755 --- a/tools/droiddeckctl +++ b/tools/droiddeckctl @@ -9,6 +9,7 @@ import gzip import json import os import re +import shlex import shutil import subprocess import struct @@ -98,6 +99,33 @@ def encode_request(request: dict) -> str: return encoded +def receiver_call(adb: str, serial: str, method: str, arg: str | None, request: dict | None, timeout: float) -> dict: + """The agent bridge through a broadcast, for shells without the `content` command.""" + # Its receiver is registered by the running app; a broadcast does not start the app the way `content call` does + running = run_adb(adb, serial, "shell", f"pidof {PACKAGE}", timeout=30) + if not running.stdout.decode(errors="replace").strip(): + raise ControlError(f"{PACKAGE} is not running and this shell has no `content` command to start it; open DroidDeck once", "APP_NOT_RUNNING") + call_id = uuid.uuid4().hex[:16] + remote = f"/sdcard/Android/data/{PACKAGE}/files/agent-calls/{call_id}.json" + command = ["shell", "am", "broadcast", "-a", f"{PACKAGE}.AGENT_CALL", "-p", PACKAGE, + "--es", "method", method, "--es", "id", call_id] + if arg is not None: + command += ["--es", "arg", shlex.quote(arg)] + if request is not None: + command += ["--es", "request", encode_request(request)] + started = run_adb(adb, serial, *command, timeout=timeout + 30) + if started.returncode != 0: + raise ControlError((started.stdout + started.stderr).decode(errors="replace").strip() or "ADB broadcast failed", "ADB_FAILED") + deadline = time.monotonic() + timeout + while time.monotonic() < deadline: + result = run_adb(adb, serial, "shell", f"cat {remote} 2>/dev/null && rm -f {remote}", timeout=30) + text = result.stdout.decode(errors="replace").strip() + if result.returncode == 0 and text: + return json.loads(text) + time.sleep(0.25) + raise ControlError(f"No answer to {method} within {timeout:g} s", "TIMEOUT") + + def provider_call(adb: str, serial: str, method: str, arg: str | None = None, request: dict | None = None, timeout: float = 30) -> dict: command = ["shell", "content", "call", "--uri", AUTHORITY, "--method", method] @@ -108,6 +136,9 @@ def provider_call(adb: str, serial: str, method: str, arg: str | None = None, re command.extend(["--extra", f"request:s:{encoded}"]) result = run_adb(adb, serial, *command, timeout=timeout) output = (result.stdout + result.stderr).decode(errors="replace") + # Only the shell's own answer for a missing `content` binary, never a command's output that quotes it + if result.returncode == 127 and "Result:" not in output and "content: inaccessible or not found" in result.stderr.decode(errors="replace") + output: + return receiver_call(adb, serial, method, arg, request, timeout) response = _content_result(output) if result.returncode != 0 and response.get("ok") is not False: raise ControlError(output.strip() or "ADB content call failed", "ADB_FAILED") @@ -140,6 +171,9 @@ def start_agent_activity(adb: str, serial: str, request: dict) -> None: output = (result.stdout + result.stderr).decode(errors="replace") if result.returncode != 0 or "status: ok" not in output.lower(): raise ControlError(output.strip() or "The agent start Activity did not launch", "ACTIVITY_START_FAILED") + if "activity not started" in output.lower(): + raise ControlError("Android handed the start request to an existing DroidDeck task instead of starting it: " + + output.strip(), "ACTIVITY_START_FAILED") def confirm_start(adb: str, serial: str, request: dict, previous: dict) -> dict: @@ -237,10 +271,15 @@ def displays(adb: str, serial: str) -> list[dict]: device = re.search(r"mPrimaryDisplayDevice=(.+)", block) size = re.search(r"real (\d+) x (\d+)", block) name = device.group(1).strip() if device else None + physical = devices.get(name) if name else None + if name and not physical: + # Some ROMs (Retroid Pocket Duo) print the device as "Built-in Screen(local:)" + inline = re.search(r"\(local:(\d+)\)$", name) + physical = inline.group(1) if inline else None out.append({ "display": logical, "name": name, - "physicalId": devices.get(name) if name else None, + "physicalId": physical, "size": [int(size.group(1)), int(size.group(2))] if size else None, }) return out @@ -750,6 +789,28 @@ def execute(args: argparse.Namespace, adb: str, serial: str) -> dict: f"{(response.get('stderr') or {}).get('text', '')[-400:]}", "GUEST_EXIT") return add_serial(response, serial) + if command == "native": + argv = args.argv[1:] if args.argv[:1] == ["--"] else args.argv + if not argv: + raise ControlError("native needs a command after --", "INVALID_ARGUMENTS") + if not 0 < args.timeout <= 600: + raise ControlError("--timeout must be more than 0 and at most 600 seconds", "INVALID_ARGUMENTS") + env = {} + for item in args.env or []: + key, sep, value = item.partition("=") + if not sep: + raise ControlError(f"--env takes KEY=VALUE, not {item}", "INVALID_ARGUMENTS") + env[key] = value + request = {"argv": argv, "timeout": args.timeout, "env": env} + if args.cwd: + request["cwd"] = args.cwd + if args.stdin is not None: + request["stdin"] = args.stdin + if args.preload: + request["preload"] = args.preload + response = checked(provider_call(adb, serial, "native", request=request, timeout=args.timeout + 40), "NATIVE_FAILED") + return add_serial(response, serial) + if command == "cdp": if args.cdp_op == "targets": request = {"op": "targets"} @@ -984,6 +1045,14 @@ def build_parser() -> argparse.ArgumentParser: guest.add_argument("--check", action="store_true", help="fail unless the command exits 0") guest.add_argument("argv", nargs=argparse.REMAINDER) + native = commands.add_parser("native", help="run a command in the rootfs without proot (debugging tools)") + native.add_argument("--timeout", type=float, default=30) + native.add_argument("--env", action="append", metavar="KEY=VALUE") + native.add_argument("--cwd") + native.add_argument("--stdin") + native.add_argument("--preload", action="append", help="guest path of another library to preload before the hook") + native.add_argument("argv", nargs=argparse.REMAINDER) + cdp = commands.add_parser("cdp", help="the Steam client's DevTools (debugging tools)") cdp_ops = cdp.add_subparsers(dest="cdp_op", required=True) cdp_ops.add_parser("targets", help="list DevTools targets") diff --git a/tools/gamescope/PATCHES.md b/tools/gamescope/PATCHES.md index 4736d32320..8608d7c260 100644 --- a/tools/gamescope/PATCHES.md +++ b/tools/gamescope/PATCHES.md @@ -302,6 +302,7 @@ For games that confine a visible cursor and warp it, which the automatic rule ca The rule only counted a lock with a cursor position hint. A game that hides the cursor and confines the pointer through a grab (Wine's ClipCursor) has a constraint with no hint, so the nested pointer stayed absolute, the constraint held the X pointer still and no raw motion was produced: the camera froze. +0133 narrows this, and the upstream hint rule, to games that hold the X pointer. ## 0129 steamcompmgr, wayland: release a pointer lock at the game's pointer @@ -326,8 +327,26 @@ each frame's motion to the X pointer itself until the game stops warping. Absolu motion, as a real compositor does, so XInput2 raw motion reaches games that read only that. A touch moves the pointer without relative motion, so tapping the screen does not turn the camera. +The X pointer is read in root coordinates and the seat position is local to the focused window, so the X pointer +is moved into the focused window's coordinates before the two are compared. Without that, any window not at the +root origin (a dialog, or a windowed program) looked like a game warping the pointer, following started, and the +pointer was pinned to the window's corner. A touch always lands where the finger is and ends following, so taps +work in every window. + ## 0132 sdl, steamcompmgr: follow a game's window mode With `--follow-game-window-mode`, the outer window of a nested SDL gamescope follows the focused game window. A window asking for `_NET_WM_STATE_FULLSCREEN`, or a Steam game covering the X screen without minimise or maximise functions or decorations in `_MOTIF_WM_HINTS`, makes the outer window fullscreen on the desktop. Anything else makes it a normal window of the game window's size, or a maximised one when that size does not fit the desktop with its title bar and panel. A change is applied only when the wanted mode changes, so a manual resize or Super+F stays. + +## 0133 steamcompmgr, wlserver: a pointer constraint is relative only while the game holds the X pointer + +A game that hides the system cursor, draws its own and grabs the pointer to its window (Stardew Valley, Balatro) gets a lock +from Xwayland, which emulates the game's warps with a cursor position hint. Upstream kept any hinted lock relative and 0128 +added every other constraint, so gamescope held the host's pointer lock and DroidDeck turned every direct touch swipe into +camera motion: dragging in those games only moved their cursor. Without relative mode such a lock still follows gamescope's +relative motion and touches still place the pointer. gamescope now compares the motion it sends (seat movement, or relative +motion while the seat is locked) with how the X pointer moves. A hinted constraint starts relative, as upstream, also when its hint arrives with the game's first warp, and is released +after 30 moving frames on which the X pointer follows. Any constraint goes relative once the X pointer moves less than a quarter +of that motion on three frames within half a second, as it does when the game recentres it or clips it to a small rectangle +(PEAK). `tools/tests/test_gamescope_pointer_hold.py` compiles the rule from this patch. diff --git a/tools/gamescope/patches/0131-follow-game-pointer-warps.patch b/tools/gamescope/patches/0131-follow-game-pointer-warps.patch index 9bbc592f54..844bb0de48 100644 --- a/tools/gamescope/patches/0131-follow-game-pointer-warps.patch +++ b/tools/gamescope/patches/0131-follow-game-pointer-warps.patch @@ -1,5 +1,5 @@ diff --git a/src/steamcompmgr.cpp b/src/steamcompmgr.cpp -index 17bae3a..c468fb3 100644 +index 17bae3a..91ec0be 100644 --- a/src/steamcompmgr.cpp +++ b/src/steamcompmgr.cpp @@ -32,6 +32,7 @@ @@ -18,7 +18,7 @@ index 17bae3a..c468fb3 100644 static bool relative_mouse_forced(); void MouseCursor::checkSuspension() -@@ -3083,12 +3085,89 @@ static gamescope::ConVar cv_relative_mouse( "relative_mouse", 0, +@@ -3083,12 +3085,101 @@ static gamescope::ConVar cv_relative_mouse( "relative_mouse", 0, "0 = Leave it to the game and the nested hints. 1 = Send host pointer motion as relative movement, for games that confine the cursor and warp it back to read movement. 2 = Never go relative." ); static bool relative_mouse_forced() { @@ -34,16 +34,28 @@ index 17bae3a..c468fb3 100644 + static double s_flLastX = 0.0; + static double s_flLastY = 0.0; + -+ int nRootX = 0; -+ int nRootY = 0; ++ int nClientX = 0; ++ int nClientY = 0; + if ( bAllowed && pFocus->cursor ) -+ pFocus->cursor->QueryRootPosition( &nRootX, &nRootY ); ++ pFocus->cursor->QueryRootPosition( &nClientX, &nClientY ); + else + bAllowed = false; + ++ steamcompmgr_win_t *pInputWindow = pFocus->inputFocusWindow; ++ if ( pInputWindow && pInputWindow->type == steamcompmgr_win_type_t::XWAYLAND ) ++ { ++ nClientX -= pInputWindow->xwayland().a.x; ++ nClientY -= pInputWindow->xwayland().a.y; ++ } ++ + wlserver_lock(); + const double flX = wlserver.mouse_surface_cursorx; + const double flY = wlserver.mouse_surface_cursory; ++ if ( s_bFollowClientPointer && !wlserver.bFollowClientPointer ) ++ { ++ s_nAwayFrames = 0; ++ s_bFollowClientPointer = false; ++ } + if ( !bAllowed ) + { + s_nAwayFrames = 0; @@ -53,7 +65,7 @@ index 17bae3a..c468fb3 100644 + else if ( !s_bFollowClientPointer ) + { + const bool bMoved = flX != s_flLastX || flY != s_flLastY; -+ if ( bMoved && ( std::abs( nRootX - flX ) > 48.0 || std::abs( nRootY - flY ) > 48.0 ) ) ++ if ( bMoved && ( std::abs( nClientX - flX ) > 48.0 || std::abs( nClientY - flY ) > 48.0 ) ) + { + const uint64_t ulNow = get_time_in_nanos(); + if ( ulNow - s_ulLastAway > 500'000'000ul ) @@ -70,12 +82,12 @@ index 17bae3a..c468fb3 100644 + wlserver.bFollowClientPointer = true; + wlserver.flFollowDX = 0.0; + wlserver.flFollowDY = 0.0; -+ wlserver_mousewarp( nRootX, nRootY, 0, true ); ++ wlserver_mousewarp( nClientX, nClientY, 0, true ); + } + } + else + { -+ const bool bWarped = std::abs( nRootX - flX ) > 2.0 || std::abs( nRootY - flY ) > 2.0; ++ const bool bWarped = std::abs( nClientX - flX ) > 2.0 || std::abs( nClientY - flY ) > 2.0; + const double flDX = std::trunc( wlserver.flFollowDX ); + const double flDY = std::trunc( wlserver.flFollowDY ); + if ( bWarped ) @@ -87,9 +99,9 @@ index 17bae3a..c468fb3 100644 + { + wlserver.flFollowDX -= flDX; + wlserver.flFollowDY -= flDY; -+ wlserver_mousewarp( nRootX, nRootY, 0, true ); ++ wlserver_mousewarp( nClientX, nClientY, 0, true ); + if ( flDX != 0.0 || flDY != 0.0 ) -+ wlserver_mousewarp( nRootX + flDX, nRootY + flDY, 0, true ); ++ wlserver_mousewarp( nClientX + flDX, nClientY + flDY, 0, true ); + } + + if ( s_nQuietFrames >= 60 ) @@ -110,7 +122,7 @@ index 17bae3a..c468fb3 100644 return true; global_focus_t *pFocus = GetCurrentFocus(); -@@ -10892,9 +10971,15 @@ steamcompmgr_main(int argc, char **argv) +@@ -10892,9 +10983,15 @@ steamcompmgr_main(int argc, char **argv) const int nRelativeMouse = cv_relative_mouse.Get(); const bool bForcedRelativeMouse = nRelativeMouse == 1 && !window_is_steam( pPaintFocus->inputFocusWindow ); @@ -128,7 +140,7 @@ index 17bae3a..c468fb3 100644 static bool s_bRelativeMouseMode = false; if ( s_bRelativeMouseMode && !bRelativeMouseMode && pPaintFocus->cursor && diff --git a/src/wlserver.cpp b/src/wlserver.cpp -index 5733871..cc75f8a 100644 +index 5733871..df23f8a 100644 --- a/src/wlserver.cpp +++ b/src/wlserver.cpp @@ -1,3 +1,4 @@ @@ -153,7 +165,7 @@ index 5733871..cc75f8a 100644 if ( !wlserver_apply_constraint( &dx, &dy ) ) { wlr_seat_pointer_notify_frame( wlserver.wlr.seat ); -@@ -3110,10 +3121,18 @@ void wlserver_mousemotion( double dx, double dy, uint32_t time ) +@@ -3110,10 +3121,22 @@ void wlserver_mousemotion( double dx, double dy, uint32_t time ) wlr_seat_pointer_notify_frame( wlserver.wlr.seat ); } @@ -163,7 +175,11 @@ index 5733871..cc75f8a 100644 assert( wlserver_is_lock_held() ); + if ( !bSynthetic && wlserver.bFollowClientPointer ) -+ return; ++ { ++ if ( !bFromTouch ) ++ return; ++ wlserver.bFollowClientPointer = false; ++ } + + const double flStepX = x - wlserver.mouse_surface_cursorx; + const double flStepY = y - wlserver.mouse_surface_cursory; @@ -173,7 +189,7 @@ index 5733871..cc75f8a 100644 wlserver.mouse_surface_cursorx = x; wlserver.mouse_surface_cursory = y; -@@ -3304,7 +3323,7 @@ void wlserver_touchmotion( double x, double y, int touch_id, uint32_t time, bool +@@ -3304,7 +3327,7 @@ void wlserver_touchmotion( double x, double y, int touch_id, uint32_t time, bool { g_bPendingTouchMovement = true; @@ -182,7 +198,7 @@ index 5733871..cc75f8a 100644 } } -@@ -3352,7 +3371,7 @@ void wlserver_touchdown( double x, double y, int touch_id, uint32_t time, gamesc +@@ -3352,7 +3375,7 @@ void wlserver_touchdown( double x, double y, int touch_id, uint32_t time, gamesc if ( eMode != gamescope::TouchClickModes::Trackpad ) { diff --git a/tools/gamescope/patches/0133-constraint-relative-when-held.patch b/tools/gamescope/patches/0133-constraint-relative-when-held.patch new file mode 100644 index 0000000000..91fa1b1ac6 --- /dev/null +++ b/tools/gamescope/patches/0133-constraint-relative-when-held.patch @@ -0,0 +1,173 @@ +diff --git a/src/steamcompmgr.cpp b/src/steamcompmgr.cpp +--- a/src/steamcompmgr.cpp ++++ b/src/steamcompmgr.cpp +@@ -3165,6 +3165,128 @@ + wlserver_unlock(); + } + ++struct PointerHold ++{ ++ int nAwayFrames = 0; ++ int nFreeFrames = 0; ++ uint64_t ulFirstAway = 0; ++ bool bHeld = false; ++}; ++ ++static bool pointer_hold_step( PointerHold &state, bool bConstrained, double flSeatDX, double flSeatDY, double flPointerDX, double flPointerDY, uint64_t ulNow ) ++{ ++ if ( !bConstrained ) ++ { ++ state = PointerHold{}; ++ return false; ++ } ++ ++ const double flSeat = std::max( std::abs( flSeatDX ), std::abs( flSeatDY ) ); ++ if ( flSeat < 4.0 ) ++ return state.bHeld; ++ ++ const double flMiss = std::max( std::abs( flSeatDX - flPointerDX ), std::abs( flSeatDY - flPointerDY ) ); ++ if ( flMiss > flSeat * 0.75 ) ++ { ++ if ( state.nAwayFrames == 0 || ulNow - state.ulFirstAway > 500'000'000ul ) ++ { ++ state.nAwayFrames = 0; ++ state.ulFirstAway = ulNow; ++ } ++ state.nFreeFrames = 0; ++ if ( ++state.nAwayFrames >= 3 ) ++ state.bHeld = true; ++ } ++ else if ( state.bHeld && ++state.nFreeFrames >= 30 ) ++ { ++ state = PointerHold{}; ++ } ++ ++ return state.bHeld; ++} ++ ++static bool s_bPointerHeld = false; ++ ++static void update_pointer_hold( global_focus_t *pFocus, bool bConstrained, bool bHinted ) ++{ ++ static PointerHold s_Hold; ++ static bool s_bTracking = false; ++ static double s_flSeatX = 0.0; ++ static double s_flSeatY = 0.0; ++ static int s_nRootX = 0; ++ static int s_nRootY = 0; ++ static bool s_bHinted = false; ++ static const steamcompmgr_win_t *s_pWindow = nullptr; ++ static const struct wlr_pointer_constraint_v1 *s_pConstraint = nullptr; ++ ++ wlserver_lock(); ++ const double flX = wlserver.mouse_surface_cursorx; ++ const double flY = wlserver.mouse_surface_cursory; ++ const double flSentX = wlserver.flSentDX; ++ const double flSentY = wlserver.flSentDY; ++ const struct wlr_pointer_constraint_v1 *pConstraint = wlserver.GetCursorConstraint(); ++ wlserver.flSentDX = 0.0; ++ wlserver.flSentDY = 0.0; ++ wlserver_unlock(); ++ ++ if ( !bConstrained || !pFocus->cursor ) ++ { ++ s_bTracking = false; ++ s_bHinted = false; ++ s_bPointerHeld = pointer_hold_step( s_Hold, false, 0.0, 0.0, 0.0, 0.0, 0 ); ++ return; ++ } ++ ++ const steamcompmgr_win_t *pWindow = pFocus->inputFocusWindow; ++ if ( pWindow != s_pWindow || pConstraint != s_pConstraint ) ++ { ++ s_bTracking = false; ++ s_bHinted = false; ++ } ++ s_pWindow = pWindow; ++ s_pConstraint = pConstraint; ++ ++ if ( s_bTracking && bHinted && !s_bHinted ) ++ { ++ s_Hold = PointerHold{}; ++ s_Hold.bHeld = true; ++ s_bPointerHeld = true; ++ } ++ s_bHinted = bHinted; ++ ++ double flDX = flX - s_flSeatX; ++ double flDY = flY - s_flSeatY; ++ if ( flDX == 0.0 && flDY == 0.0 ) ++ { ++ flDX = flSentX; ++ flDY = flSentY; ++ } ++ ++ if ( s_bTracking && flDX == 0.0 && flDY == 0.0 ) ++ return; ++ ++ int nRootX = 0; ++ int nRootY = 0; ++ pFocus->cursor->QueryRootPosition( &nRootX, &nRootY ); ++ ++ if ( s_bTracking ) ++ { ++ s_bPointerHeld = pointer_hold_step( s_Hold, true, flDX, flDY, nRootX - s_nRootX, nRootY - s_nRootY, get_time_in_nanos() ); ++ } ++ else ++ { ++ s_Hold = PointerHold{}; ++ s_Hold.bHeld = bHinted; ++ s_bPointerHeld = bHinted; ++ } ++ ++ s_bTracking = true; ++ s_flSeatX = flX; ++ s_flSeatY = flY; ++ s_nRootX = nRootX; ++ s_nRootY = nRootY; ++} ++ + bool ShouldDrawCursor() + { + if ( relative_mouse_forced() ) +@@ -11029,9 +11151,15 @@ + nRelativeMouse != 2 && !bExcludedAppId && !bHasPointerConstraint && !window_is_steam( pPaintFocus->inputFocusWindow ) ); + } + ++ if ( vblank ) ++ update_pointer_hold( pPaintFocus, bHasPointerConstraint && bImageEmpty && nRelativeMouse != 2 && !bExcludedAppId, ++ pPaintFocus->cursor && pPaintFocus->cursor->IsConstrained() ); ++ ++ const bool bGameHoldsPointer = bHasPointerConstraint && s_bPointerHeld; ++ + const bool bRelativeMouseMode = nRelativeMouse == 2 + ? false +- : ( bForcedRelativeMouse || s_bFollowClientPointer || ( bImageEmpty && bHasPointerConstraint && !bExcludedAppId ) ); ++ : ( bForcedRelativeMouse || s_bFollowClientPointer || ( bImageEmpty && bGameHoldsPointer && !bExcludedAppId ) ); + + static bool s_bRelativeMouseMode = false; + if ( s_bRelativeMouseMode && !bRelativeMouseMode && pPaintFocus->cursor && +diff --git a/src/wlserver.cpp b/src/wlserver.cpp +--- a/src/wlserver.cpp ++++ b/src/wlserver.cpp +@@ -346,6 +346,8 @@ + { + assert( wlserver_is_lock_held() ); + ++ wlserver.flSentDX += unaccel_dx; ++ wlserver.flSentDY += unaccel_dy; + wlr_relative_pointer_manager_v1_send_relative_motion( wlserver.relative_pointer_manager, wlserver.wlr.seat, 0, unaccel_dx, unaccel_dy, unaccel_dx, unaccel_dy ); + } + +diff --git a/src/wlserver.hpp b/src/wlserver.hpp +--- a/src/wlserver.hpp ++++ b/src/wlserver.hpp +@@ -171,6 +171,8 @@ + bool bFollowClientPointer = false; + double flFollowDX = 0.0; + double flFollowDY = 0.0; ++ double flSentDX = 0.0; ++ double flSentDY = 0.0; + + bool button_held[ WLSERVER_BUTTON_COUNT ]; + std::set touch_down_ids; diff --git a/tools/gamescope/release.env b/tools/gamescope/release.env index 88f8ff1cf9..bf5211b032 100644 --- a/tools/gamescope/release.env +++ b/tools/gamescope/release.env @@ -1,3 +1,3 @@ GAMESCOPE_REPO=Droid-Deck/DroidDeck-Components -GAMESCOPE_TAG=gamescope-3.16.29-p22 -GAMESCOPE_SHA256=2b7e7481df5f5f7355d224d3a0d4205557367172653dff1d7206a230b6c78b46 +GAMESCOPE_TAG=gamescope-3.16.29-p23 +GAMESCOPE_SHA256=f5f2b8f658234ad2910a1be53c238188db7e7b2a9079f8cc5fa9ea006bebbe7e diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-agent b/tools/linuxfs/overlay/usr/local/bin/droiddeck-agent index 234be2f001..5ae8031e68 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-agent +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-agent @@ -927,6 +927,33 @@ def steam_shortcut_state(agent_dir, game_id, timeout=6): time.sleep(min(0.5, max(0, deadline - time.monotonic()))) +def steam_ready(agent_dir): + expression = """(() => { + const store = globalThis.appStore; + return !!store?.m_bIsInitialized && typeof globalThis.SteamClient?.Apps?.ContinueGameAction === 'function'; + })()""" + return cdp_eval(agent_dir, expression, await_promise=False, timeout=3).get("value") is True + + +def steam_clear_pending_interstitial(agent_dir, app_id): + if not isinstance(app_id, str) or not app_id.isascii() or not app_id.isdigit() or int(app_id) <= 0: + raise AgentError("INVALID_APP_ID", "appId must be a positive decimal Steam app id") + expression = """(async () => { + const apps = globalThis.SteamClient?.Apps; + if (typeof apps?.GetActiveGameActions !== 'function' || typeof apps.ContinueGameAction !== 'function') return false; + const active = await apps.GetActiveGameActions() || []; + for (const action of active) { + const appid = String(action?.strAppID ?? action?.gameid ?? action?.nAppID ?? ''); + if (appid === %s && action?.strTaskName === 'ShowInterstitials') { + apps.ContinueGameAction(action.nGameActionID, appid, 'ShowInterstitials'); + return true; + } + } + return false; + })()""" % json.dumps(app_id) + return cdp_eval(agent_dir, expression, timeout=3).get("value") is True + + def game_pids(app_id): wanted = [("SteamAppId=%s" % app_id).encode(), ("SteamGameId=%s" % app_id).encode()] me = os.getpid() @@ -1261,6 +1288,19 @@ def main(argv): return 1 print(state) return {"ready": 0, "missing": 4, "not-shortcut": 3}.get(state, 1) + if argv and argv[0] == "--steam-ready": + try: + return 0 if steam_ready(Path(base) / "agent") else 1 + except (AgentError, OSError, ValueError): + return 1 + if argv and argv[0] == "--steam-clear-pending-interstitial": + if len(argv) != 2: + print("usage: droiddeck-agent --steam-clear-pending-interstitial ", file=sys.stderr) + return 2 + try: + return 0 if steam_clear_pending_interstitial(Path(base) / "agent", argv[1]) else 1 + except (AgentError, OSError, ValueError): + return 1 serve(Path(base) / "agent", focus="--no-focus" not in argv) return 0 diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-appimage-exec b/tools/linuxfs/overlay/usr/local/bin/droiddeck-appimage-exec new file mode 100755 index 0000000000..454333efa9 --- /dev/null +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-appimage-exec @@ -0,0 +1,16 @@ +#!/bin/bash +set -u +image=${1:?usage: droiddeck-appimage-exec [args...]} +shift +export APPIMAGE_EXTRACT_AND_RUN=1 +chmod +x "$image" 2>/dev/null +if [ -x /usr/local/bin/droiddeck-fex ]; then + case $(od -An -tu2 -j18 -N2 "$image" 2>/dev/null | tr -d ' ') in + 3|62) exec /usr/local/bin/droiddeck-fex run --mode on -- "$image" "$@" ;; + esac +fi +if [ -x /usr/local/lib/droiddeck/uruntime ]; then + export TARGET_APPIMAGE=$image + exec /usr/local/lib/droiddeck/uruntime "$@" +fi +exec "$image" "$@" diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-appimage-run b/tools/linuxfs/overlay/usr/local/bin/droiddeck-appimage-run index b23023b2e9..b4a1910f24 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-appimage-run +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-appimage-run @@ -55,6 +55,9 @@ if [ -x /usr/local/bin/droiddeck-fex ]; then *) run=(/usr/local/bin/droiddeck-fex run --mode "$fex" --for "$APPDIR" -- "$APPDIR/AppRun") ;; esac fi +gpu=("${BASH_SOURCE[0]%/*}/droiddeck-game-gpu") +[ ${#flags[@]} -gt 0 ] && gpu+=(--chromium) +run=("${gpu[@]}" -- "${run[@]}") echo "== appimage $ARGV0 ($APPDIR) ${flags[*]} FEX $fex Qt $qt${QT_QPA_PLATFORM:+ ($QT_QPA_PLATFORM)}" cd "$APPDIR" || exit 1 started=$(mktemp "${TMPDIR:-/tmp}/droiddeck-appimage.XXXXXX") diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-flatpak-run b/tools/linuxfs/overlay/usr/local/bin/droiddeck-flatpak-run index 08e6e7a265..b8210c3550 100644 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-flatpak-run +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-flatpak-run @@ -1,6 +1,7 @@ #!/bin/bash set -u export FLATPAK_BWRAP=/usr/local/bin/droiddeck-bwrap +unset MESA_LOADER_DRIVER_OVERRIDE GALLIUM_DRIVER LIBGL_KOPPER_DRI2 VK_ICD_FILENAMES VK_DRIVER_FILES case ":${XDG_DATA_DIRS:-}:" in *"/flatpak/exports/share:"*) ;; *) export XDG_DATA_DIRS=$HOME/.local/share/flatpak/exports/share:${XDG_DATA_DIRS:-/usr/local/share:/usr/share} ;; @@ -11,8 +12,16 @@ if [ -n "${BL_INSIDE:-}" ] || [ -n "${GAMESCOPE_WAYLAND_DISPLAY:-}" ]; then export XDG_SESSION_TYPE=x11 socket=(--nosocket=wayland --socket=x11) fi +app= +for arg in "$@"; do + case $arg in -*) ;; *) app=$arg; break ;; esac +done +gpu=("${BASH_SOURCE[0]%/*}/droiddeck-game-gpu") +location= +[ -n "$app" ] && location=$(flatpak info --show-location "$app" 2>/dev/null) +[ -n "$location" ] && gpu+=(--for "$location/files") echo "== flatpak run ${socket[*]} $*" if [ -z "${DBUS_SESSION_BUS_ADDRESS:-}" ] && command -v dbus-run-session >/dev/null 2>&1; then - exec dbus-run-session -- flatpak run "${socket[@]}" "$@" + exec "${gpu[@]}" -- dbus-run-session -- flatpak run "${socket[@]}" "$@" fi -exec flatpak run "${socket[@]}" "$@" +exec "${gpu[@]}" -- flatpak run "${socket[@]}" "$@" diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-env b/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-env index 9fb3c39c66..175b8d8d1c 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-env +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-env @@ -11,22 +11,43 @@ import tempfile from pathlib import Path GAME_TU_DEBUG = "DROIDDECK_GAME_TU_DEBUG" +CHROMIUM_FILES = {"chrome-sandbox", "chrome_100_percent.pak", "v8_context_snapshot.bin"} SYNC_KEYS = ("BL_SYNC", "BL_SYNC_FALLBACK", "BL_FSYNC_FIRST", "BL_SYNC_MIN_NOFILE", "PROTON_NO_ESYNC", "PROTON_NO_FSYNC", "PROTON_NO_NTSYNC", "WINEESYNC") SEED_REDISTS = "/usr/local/bin/droiddeck-seed-redists" PACK_KEYS = ("WINESERVER", "BL_SYNC_PACK", "WINEESYNC", "PROTON_NO_ESYNC", "PROTON_NO_FSYNC") +# Prefixes several games share; the game itself is the Steam app being launched. +SHARED_PREFIXES = {"2929927072"} + + +def app_number(value): + if not re.fullmatch(r"-?[0-9]+", value or ""): + return None + number = int(value) + if not -(2**31) <= number < 2**32 or number == 0: + return None + return str(number % 2**32) + + def game_id(env): prefix = env.get("STEAM_COMPAT_DATA_PATH", "").rstrip("/") if not prefix: return None - value = prefix.rsplit("/", 1)[-1] - if not re.fullmatch(r"-?[0-9]+", value): + found = app_number(prefix.rsplit("/", 1)[-1]) + if found in SHARED_PREFIXES: + return app_number(env.get("SteamAppId", "")) or shortcut_number(env.get("SteamGameId", "")) or found + return found + + +def shortcut_number(value): + """The shortcut appid inside Steam's 64-bit shortcut game id `(appid << 32) | 0x02000000`.""" + if not re.fullmatch(r"[0-9]{1,20}", value or ""): return None number = int(value) - if not -(2**31) <= number < 2**32 or number == 0: + if number >= 2**64 or number & 0xFFFFFFFF != 0x02000000: return None - return str(number % 2**32) + return app_number(str(number >> 32)) DOTNET_FEX = { @@ -332,12 +353,12 @@ def engine_fixes(exe, args): return env, extra, notes -def win_components(compat, app_id): +def win_components(compat, app_id, proton=None, env=None): if not compat: return "" try: module = runpy.run_path(str(Path(__file__).resolve().parent / "droiddeck-wincomponents")) - names, notes = module["apply"](compat.rstrip("/"), app_id) + names, notes = module["apply"](compat.rstrip("/"), app_id, proton=proton, env=env or os.environ) for note in notes: print("droiddeck-game-env: " + note, file=sys.stderr) return module["overrides_value"](names) @@ -346,11 +367,23 @@ def win_components(compat, app_id): return "" -def game_gpu(env): +def chromium_app(folder): + root = os.path.realpath(folder) + for top, dirs, files in os.walk(root): + if CHROMIUM_FILES.intersection(files) or CHROMIUM_FILES.intersection(dirs): + return True + if os.path.relpath(top, root).count(os.sep) >= 2: + dirs[:] = [] + return False + + +def game_gpu(env, keep=False): if GAME_TU_DEBUG not in env: return env result = env.copy() value = result.pop(GAME_TU_DEBUG) + if keep: + return result if value: result["TU_DEBUG"] = value else: @@ -846,6 +879,60 @@ WINE_DLL_DIRS = ("/lib/wine/i386-windows", "/lib/wine/x86_64-windows", "/lib/win "/lib/wine/fakedlls", "/lib64/wine", "/lib64/wine/fakedlls", "/lib64/wine/x86_64-windows") +FOREIGN_SUFFIX = ".foreign-arch" +PE = runpy.run_path(str(Path(__file__).resolve().parent / "droiddeck-wine-pe")) +pe_machine = PE["pe_machine"] + + +def repair_foreign_system_dlls(prefix, proton, env=None): + dist = Path(proton).parent / "files/lib/wine" + windows = Path(prefix) / "pfx/drive_c/windows" + machines_by_folder = PE["proton_pe_machines"](proton, env or {}) + if machines_by_folder is None: + return [] + repaired = [] + for folder, (libdir, machines) in machines_by_folder.items(): + builtins = dist / libdir + try: + builtin_names = {name.lower(): name for name in os.listdir(builtins)} + except OSError: + continue + try: + names = sorted(os.listdir(windows / folder)) + except OSError: + continue + for name in names: + path = windows / folder / name + builtin_name = builtin_names.get(name.lower()) + source = builtins / builtin_name if builtin_name else builtins / name + if path.is_symlink() or not name.lower().endswith(".dll") or not source.is_file() or not path.is_file(): + continue + machine = pe_machine(path) + if machine is None or PE["machine_compatible"](path, machines, machine): + continue + link = windows / folder / (name + ".bl-new") + backup = windows / folder / (name + FOREIGN_SUFFIX) + serial = 1 + while os.path.lexists(backup): + backup = windows / folder / (name + FOREIGN_SUFFIX + ".%d" % serial) + serial += 1 + try: + os.symlink(os.path.relpath(source, path.parent), link) + os.replace(path, backup) + try: + os.replace(link, path) + except OSError: + if not os.path.lexists(path) and os.path.lexists(backup): + os.replace(backup, path) + raise + except OSError: + if link.is_symlink(): + link.unlink() + continue + repaired.append("%s/%s (machine 0x%x)" % (folder, name, machine)) + return repaired + + def is_wine_dll_link(path): try: return os.path.islink(path) and os.path.dirname(os.readlink(path)).endswith(WINE_DLL_DIRS) @@ -1143,16 +1230,54 @@ def main(): env = game_gpu(os.environ.copy()) mic_enabled = env.get("BL_MIC_ENABLED") debug_dir = env.get("BL_DEBUG_DIR", "") + prefix_path = env.get("STEAM_COMPAT_DATA_PATH", "").rstrip("/") + app_id = game_id(env) + components = "" + waiting = bool(app_id and len(command) > 1 and command[1] == "waitforexitandrun") + config = {} + launch_config = None + launch_config_valid = True + effective_env = env + if waiting: + path = Path.home() / ".config/droiddeck/game-environment.json" + try: + with path.open(encoding="utf-8") as source: + config = json.load(source) + launch_config = config + except FileNotFoundError: + launch_config = {"version": 1} + except (OSError, ValueError, TypeError, AttributeError): + launch_config_valid = False + if launch_config_valid: + try: + effective_env = apply_config(env, launch_config, app_id) + except (OSError, ValueError, TypeError, AttributeError): + launch_config_valid = False + if not launch_config_valid: + print("droiddeck-game-env: invalid configuration; using inherited environment", file=sys.stderr) + if waiting: + components = win_components(prefix_path, app_id, command[0], effective_env) + if prefix_path and command: + try: + fixed = repair_foreign_system_dlls(prefix_path, command[0], effective_env) + except OSError as error: + fixed = [] + print("droiddeck-game-env: prefix system DLL check skipped (%s)" % error, file=sys.stderr) + if fixed: + print("droiddeck-game-env: replaced foreign-architecture system DLLs with this Proton's own: %s" % ", ".join(fixed), + file=sys.stderr) scripts = mark_install_scripts(command, env) if scripts and install_scripts_done(scripts, env): print("droiddeck-game-env: install scripts already run in this prefix; evaluator skipped", file=sys.stderr) return 0 + if scripts and not env.get("DBUS_SESSION_BUS_ADDRESS"): + # libdbus would autolaunch a session bus under the evaluator's reaper, which then waits for it + # forever: Steam keeps seeing the app as running and cannot move or update it + env["DBUS_SESSION_BUS_ADDRESS"] = "disabled:" try: digest = scripts_digest(scripts) if scripts else None except OSError: digest = None - app_id = game_id(env) - waiting = bool(app_id and len(command) > 1 and command[1] == "waitforexitandrun") diagnostic_app_id = app_id if waiting and os.environ.get("DROIDDECK_ENHANCED_DIAGNOSTICS") == "1" else None dirt_prefix = None if app_id: @@ -1170,7 +1295,6 @@ def main(): for note in notes: print("droiddeck-game-env: " + note, file=sys.stderr) command += extra - components = win_components(env.get("STEAM_COMPAT_DATA_PATH", ""), app_id) if components: own = fixes.get("WINEDLLOVERRIDES") fixes["WINEDLLOVERRIDES"] = components + ";" + own if own else components @@ -1178,22 +1302,21 @@ def main(): if dirt_prefix: own = fixes.get("WINEDLLOVERRIDES") fixes["WINEDLLOVERRIDES"] = own + ";ws2_32=n,b" if own else "ws2_32=n,b" - path = Path.home() / ".config/droiddeck/game-environment.json" - config = {} - try: - with path.open(encoding="utf-8") as source: - config = json.load(source) - if waiting: + if waiting: + if launch_config_valid: if "vblank_mode" in config.get("shared", {}): fixes.pop("vblank_mode", None) - env = apply_config(env, config, app_id, fixes) - else: + env = apply_config(env, launch_config, app_id, fixes) + else: + path = Path.home() / ".config/droiddeck/game-environment.json" + try: + with path.open(encoding="utf-8") as source: + config = json.load(source) env = apply_config(env, sync_config(config, app_id), app_id) - except FileNotFoundError: - if waiting: - env = apply_config(env, {"version": 1}, app_id, fixes) - except (OSError, ValueError, TypeError, AttributeError): - print("droiddeck-game-env: invalid configuration; using inherited environment", file=sys.stderr) + except FileNotFoundError: + pass + except (OSError, ValueError, TypeError, AttributeError): + print("droiddeck-game-env: invalid configuration; using inherited environment", file=sys.stderr) if waiting: before_debug = env env = apply_game_debug_logs(env, config, debug_dir) diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-gpu b/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-gpu new file mode 100755 index 0000000000..40055010d0 --- /dev/null +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-game-gpu @@ -0,0 +1,42 @@ +#!/usr/bin/python3 +import os +import runpy +import sys + +BIN_DIR = os.path.dirname(os.path.abspath(__file__)) + + +def main(argv): + keep = False + folder = None + while argv and argv[0] != "--": + if argv[0] == "--chromium": + keep = True + argv = argv[1:] + elif argv[0] == "--for" and len(argv) > 1: + folder = argv[1] + argv = argv[2:] + else: + break + if argv and argv[0] == "--": + argv = argv[1:] + if not argv: + print("usage: droiddeck-game-gpu [--chromium] [--for FOLDER] -- PROGRAM [ARGS...]", file=sys.stderr) + return 2 + env = dict(os.environ) + try: + game_env = runpy.run_path(os.path.join(BIN_DIR, "droiddeck-game-env")) + if folder and not keep: + keep = game_env["chromium_app"](folder) + env = game_env["game_gpu"](env, keep) + except Exception as error: + print("droiddeck-game-gpu: the game GPU setting was not applied (%s)" % error, file=sys.stderr) + try: + os.execvpe(argv[0], argv, env) + except OSError as error: + print("droiddeck-game-gpu: %s: %s" % (argv[0], error.strerror), file=sys.stderr) + return 127 + + +if __name__ == "__main__": + sys.exit(main(sys.argv[1:])) diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-proton-run b/tools/linuxfs/overlay/usr/local/bin/droiddeck-proton-run index 3d2b6ec6f1..164dbd0288 100644 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-proton-run +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-proton-run @@ -70,8 +70,19 @@ def mapping(root): def tools(root): + c = compat() + wrapper = os.path.join(root, "compatibilitytools.d", c["TOOL"]) + complete = os.access(os.path.join(wrapper, c["LAUNCHER"]), os.X_OK) and os.path.isfile(os.path.join(wrapper, "toolmanifest.vdf")) + if c["TOOL"].lower() not in c["local_tools"](root) or not complete: + depot = c["find_source"](root, runnable=True) + if depot is not None: + try: + c["build_tool"](wrapper, depot) + except OSError: + pass found = {} - for base in [os.path.join(root, "compatibilitytools.d")] + list(SYSTEM_TOOLS): + bases = [os.path.join(root, "compatibilitytools.d")] + list(SYSTEM_TOOLS) + for base in bases: try: entries = sorted(os.listdir(base)) except OSError: diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-session b/tools/linuxfs/overlay/usr/local/bin/droiddeck-session index c468dbf5f4..df301aadaf 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-session +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-session @@ -56,6 +56,16 @@ sync_timezone() { } 2>/dev/null sync_timezone +ensure_machine_id() { + local id= + id=$(< /etc/machine-id) + [[ $id =~ ^[0-9a-f]{32}$ && $id != 00000000000000000000000000000000 ]] && return 0 + id=$(dbus-uuidgen) || return 0 + [[ $id =~ ^[0-9a-f]{32}$ ]] || return 0 + printf '%s\n' "$id" > /etc/machine-id.droiddeck && mv -f /etc/machine-id.droiddeck /etc/machine-id +} 2>/dev/null +ensure_machine_id + write_system_bus_config() { mkdir -p /run/dbus /usr/local/share/droiddeck cat > /usr/local/share/droiddeck/system-bus.conf <<'BUSCONF' @@ -642,13 +652,7 @@ case $mode in fi case ${target,,} in *.appimage) - export APPIMAGE_EXTRACT_AND_RUN=1 - chmod +x "$target" 2>/dev/null - if [ ${#fex[@]} -eq 0 ] && [ -x /usr/local/lib/droiddeck/uruntime ]; then - export TARGET_APPIMAGE=$target - run_program /usr/local/lib/droiddeck/uruntime "$@" - fi - run_program "${fex[@]}" "$target" "$@" + run_program /usr/local/bin/droiddeck-appimage-exec "$target" "$@" ;; *.sh) if [ -x /usr/local/bin/droiddeck-fex ]; then @@ -898,21 +902,21 @@ case $mode in bl_session_pressure() { bl_memory_read [ "$_bl_game" = 1 ] && bl_low_ram && bl_memory_critical || return 0 - local _wait=$_bl_tier_backoff _urgent=0 _before _pids _targets - [ "$_bl_available" -ge $((_bl_headroom / 2)) ] || _urgent=1 _wait=30 + local _wait=$_bl_tier_backoff _before _pids _targets + [ "$_bl_available" -ge $((_bl_headroom / 2)) ] || [ "$_bl_tier_pushed" -lt 0 ] || _wait=30 [ "$_bl_tier_at" -lt 0 ] || [ $((SECONDS - _bl_tier_at)) -ge "$_wait" ] || return 0 if [ "$_bl_tier_at" -ge 0 ] && [ "$_bl_tier_pushed" -gt 0 ]; then bl_tier_readback if [ "$_bl_tier_back" -le $((_bl_tier_pushed / 2)) ]; then _bl_tier_backoff=30 - elif [ "$_urgent" = 0 ]; then + else _bl_tier_backoff=$((_bl_tier_backoff * 2 > 300 ? 300 : _bl_tier_backoff * 2)) - _bl_tier_at=$SECONDS _bl_tier_pushed=0 + _bl_tier_at=$SECONDS _bl_tier_pushed=-1 step "zRAM: the game read back most of its last page-out, next try in ${_bl_tier_backoff} s" return 0 fi fi - _bl_tier_at=$SECONDS + _bl_tier_at=$SECONDS _bl_tier_pushed=0 bl_zram_pick game bl_zram_usage "${_pids[@]}" > /dev/null [ "$_bl_rss" -ge $((256 * 1024)) ] || return 0 @@ -1240,7 +1244,14 @@ case $mode in sleep 1 done [ "${#game}" -gt 10 ] && shortcut=1 - [ -n "$shortcut" ] || sleep 4 + _bl_ready_end=$((SECONDS + 30)) + while [ "$waited" -lt 30 ] && [ "$((_bl_ready_end - SECONDS))" -gt 0 ]; do + timeout "$((_bl_ready_end - SECONDS))" /usr/local/bin/droiddeck-agent --steam-ready >/dev/null 2>&1 && break + [ "$((_bl_ready_end - SECONDS))" -gt 1 ] || break + sleep 1 + waited=$((waited + 1)) + done + waited=0 echo "== steam: interface up; launching the requested game $game" _bl_hand_off [ -n "$shortcut" ] || return 0 @@ -1260,7 +1271,9 @@ case $mode in elif _bl_starting; then echo "== steam: the requested game started while waiting; not launching again" elif [ "$(_bl_focused)" = 769 ]; then - echo "== steam: launching the requested game again $game (overview status $status)" + echo "== steam: clearing the pending launch interstitial for $game (overview status $status)" + /usr/local/bin/droiddeck-agent --steam-clear-pending-interstitial "$(((game >> 32) & 0xffffffff))" >/dev/null 2>&1 && return 0 + echo "== steam: launching the requested game again $game" _bl_hand_off else echo "== steam: the game took focus while waiting; not launching again" @@ -1334,6 +1347,23 @@ case $mode in echo "== network: no dbus-daemon or netmanager in this runtime; the client will show no connection" exit 69 fi + # Without a session bus libdbus autolaunches one under the game; it never exits and Steam's + # reaper waits on it, so the launch or exit never finishes. + if [ -z "${DBUS_SESSION_BUS_ADDRESS:-}" ]; then + _bl_bus=${XDG_RUNTIME_DIR:-/run/droiddeck}/bus + rm -f "$_bl_bus" + dbus-daemon --session --address="unix:path=$_bl_bus" --nofork --nopidfile & + for _ in $(seq 1 50); do + [ -S "$_bl_bus" ] && break + nap 0.1 + done + if [ -S "$_bl_bus" ]; then + export DBUS_SESSION_BUS_ADDRESS="unix:path=$_bl_bus" + echo "== session bus up at $_bl_bus" + else + echo "== session bus did not come up; programs may start their own" + fi + fi _bl_compat_env=(env -u LD_LIBRARY_PATH -u STEAM_RUNTIME -u STEAM_STEAMRT_RECURSION_GUARD) [ "${LD_LIBRARY_PATH+x}" ] && _bl_compat_env+=("LD_LIBRARY_PATH=$LD_LIBRARY_PATH") diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-snap-run b/tools/linuxfs/overlay/usr/local/bin/droiddeck-snap-run index 6529005a24..9e8acf9cc8 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-snap-run +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-snap-run @@ -1,11 +1,13 @@ #!/usr/bin/python3 import os import re +import runpy import shlex import sys import yaml +BIN_DIR = os.path.dirname(os.path.abspath(__file__)) SNAP_DIR = "/snap" HOST_DIRS = ("/etc", "/home", "/root", "/tmp", "/run", "/var/snap", "/var/lib/snapd", "/var/tmp", "/var/log", "/media", "/mnt", "/snap", "/usr/src", "/lib/modules") @@ -59,6 +61,15 @@ def content_binds(name, meta, env): return out +def game_gpu(env, snap): + try: + game_env = runpy.run_path(os.path.join(BIN_DIR, "droiddeck-game-env")) + return game_env["game_gpu"](env, game_env["chromium_app"](snap)) + except Exception as error: + print(f"droiddeck-snap-run: the game GPU setting was not applied ({error})", file=sys.stderr) + return env + + def main(argv): if len(argv) < 3: print("usage: droiddeck-snap-run SNAP APP [ARG...]", file=sys.stderr) @@ -72,7 +83,7 @@ def main(argv): revision = os.path.basename(os.path.realpath(f"{SNAP_DIR}/{name}/current")) home = os.environ.get("HOME", "/root") snap = f"{SNAP_DIR}/{name}/{revision}" - env = dict(os.environ) + env = game_gpu(dict(os.environ), snap) for k in ("LD_PRELOAD", "LD_LIBRARY_PATH"): env.pop(k, None) env.update({ diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-steam-compat b/tools/linuxfs/overlay/usr/local/bin/droiddeck-steam-compat index 97e2b8525b..e96ce1c553 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-steam-compat +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-steam-compat @@ -760,18 +760,50 @@ class Watcher: def __init__(self, files): self.files = files self.fd = -1 + self.libc = None + wanted = {os.path.dirname(f) for f in files} + self.missing = {d for d in wanted if not os.path.isdir(d)} + self.watched = set() try: libc = ctypes.CDLL(None, use_errno=True) fd = libc.inotify_init1(os.O_NONBLOCK | os.O_CLOEXEC) - dirs = sorted({os.path.dirname(f) for f in files if os.path.isdir(os.path.dirname(f))}) + dirs = sorted((wanted - self.missing) | {self.existing_parent(d) for d in self.missing} - {""}) if fd >= 0 and dirs and all(libc.inotify_add_watch(fd, d.encode(), self.MASK) >= 0 for d in dirs): + self.watched = set(dirs) self.fd = fd + self.libc = libc elif fd >= 0: os.close(fd) except (OSError, AttributeError): self.fd = -1 self.stamp = self.snapshot() + @staticmethod + def existing_parent(path): + while path and not os.path.isdir(path): + parent = os.path.dirname(path) + if parent == path: + return "" + path = parent + return path + + def watch_new_dirs(self): + appeared = False + progressed = True + while progressed: + progressed = False + for d in sorted(self.missing): + parent = d if os.path.isdir(d) else self.existing_parent(d) + if not parent or parent in self.watched: + continue + if self.libc.inotify_add_watch(self.fd, parent.encode(), self.MASK) >= 0: + self.watched.add(parent) + progressed = True + appeared = appeared or parent == d + for d in [d for d in self.missing if d in self.watched]: + self.missing.discard(d) + return appeared + def snapshot(self): stamp = [] for f in self.files: @@ -803,8 +835,9 @@ class Watcher: at += 16 + size except BlockingIOError: pass + appeared = self.watch_new_dirs() if self.missing else False wanted = {os.path.basename(f) for f in self.files} - return any(n in wanted or n.startswith("appmanifest_") for n in names) + return appeared or any(n in wanted or n.startswith("appmanifest_") for n in names) class XMessage(ctypes.Structure): @@ -1078,10 +1111,13 @@ class Helper: wanted = COMPAT["requested_tool"](request, catalog) newer = isinstance(request.get("seq"), int) and request["seq"] > int(state.get("applied", 0) or 0) waiting = newer and wanted is not None and wanted not in self.known - default, state = COMPAT["choose_default"](top["selected"], state, request, live, apply_request=not waiting) + listed = [t["name"] for t in live] + default, state = COMPAT["choose_default"](COMPAT["built_from"](top["selected"], catalog, listed) or top["selected"], + state, request, catalog, apply_request=not waiting, listed=listed) installed = COMPAT["installed_apps"](self.steam_root) self.installed = installed picks = COMPAT["valve_picks"](self.steam_root) + tools = COMPAT["tool_platforms"](self.steam_root) prior_auto = state.get("auto", {}) if not isinstance(prior_auto, dict): prior_auto = {} @@ -1089,7 +1125,7 @@ class Helper: native_choices = set(prior_native if isinstance(prior_native, (list, tuple, set)) else ()) picked = COMPAT["picked_apps"](state) runnable = {t["name"].lower() for t in live} - apps = sorted(set(installed) | set(picks) | set(prior_auto) | native_choices, key=COMPAT["app_order"]) + apps = sorted(set(installed) | set(picks) | set(prior_auto) | native_choices | set(tools), key=COMPAT["app_order"]) asked = [app for app, request in COMPAT["game_requests"]().items() if COMPAT["valid_game_request"](app, request)] apps = sorted(set(apps) | set(asked), key=COMPAT["app_order"]) current = dict(page.compat("many(%s)" % json.dumps(apps)) or {}) @@ -1103,6 +1139,7 @@ class Helper: if isinstance(state.get("auto"), dict): state["auto"] = prior_auto native_choices -= refused + tools = {app: platforms for app, platforms in tools.items() if app not in refused} current["0"] = top["selected"] native = COMPAT["native_targets"](self.steam_root, apps) raw_mapping = COMPAT["read_config_mapping"]( @@ -1123,13 +1160,20 @@ class Helper: current[app] = "" elif not current.get(app): current.pop(app, None) + moved = COMPAT["rebuilt_picks"](current, catalog, set(prior_auto) | picked, listed) + if moved: + following = COMPAT["followers"](state, current) + state["auto"] = {app: name for app, name in following.items() if app not in moved} if isinstance(following, dict) else {} + prior_auto = {app: name for app, name in prior_auto.items() if app not in moved} + current.update(moved) requests = COMPAT["settled_game_requests"](state, current, catalog) - overrides = COMPAT["requested_games"](requests or {}, catalog, [t["name"] for t in live]) + overrides = COMPAT["requested_games"](requests or {}, catalog, listed) overrides = {app: tool for app, tool in overrides.items() if app not in refused} changes, auto = COMPAT["plan_mapping"]( - current, installed, [t["name"] for t in live], default, + current, installed, listed, default, COMPAT["followers"](state, current), native, picks, overrides, - prior_auto.keys(), native_choices) + prior_auto.keys(), native_choices, tools) + changes = dict(moved, **changes) for app, tool in sorted(changes.items(), key=lambda item: COMPAT["app_order"](item[0])): page.compat("set(%d, %s)" % (int(app), json.dumps(tool if tool is not None else ""))) say("%s -> %s" % ("default" if app == "0" else "app %s" % app, @@ -1137,7 +1181,7 @@ class Helper: state.update( auto={app: tool for app, tool in auto.items() if tool is not COMPAT["NATIVE_CHOICE"]}, native_choices=sorted(refused_native | {app for app, tool in auto.items() if tool is COMPAT["NATIVE_CHOICE"]}), - picked=COMPAT["picked_after"](current, changes), tools=catalog, live=True, + picked=COMPAT["picked_after"](current, changes), tools=catalog, live=True, written=default, games_applied=COMPAT["applied_game_requests"](requests, overrides, state)) state.pop("native", None) if waiting: @@ -1292,7 +1336,8 @@ def main(): failures += 1 time.sleep(min(2 * max(failures, 1), 10)) os.makedirs(COMPAT["COMPAT_DIR"], exist_ok=True) - watcher = Watcher([COMPAT["state_path"]("request.json"), COMPAT["state_path"]("games.json")] + + watcher = Watcher([COMPAT["state_path"]("request.json"), COMPAT["state_path"]("games.json"), + os.path.join(steam_root, "appcache", "appinfo.vdf")] + [os.path.join(lib, "steamapps", "libraryfolders.vdf") for lib in (steam_root, COMPAT["LIBRARY"] + "-sd")]) steamos = os.environ.get("BL_STEAMDECK") == "1" and os.environ.get("BL_STEAM_UI") != "desktop" helper = Helper(steam_root, port, steamos) diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-steam-shortcuts b/tools/linuxfs/overlay/usr/local/bin/droiddeck-steam-shortcuts index 9ad14d8385..5e37501b35 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-steam-shortcuts +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-steam-shortcuts @@ -355,8 +355,9 @@ def main(): "linux_tool": "droiddeck-direct"} else: protect = compat.adopt_extras(tools) - used = compat.register_default(cfg, apps=[str(int(g["appid"]) & 0xFFFFFFFF) for g in games if g.get("exe") and not g.get("native")] + [str(appid) for appid in set(routes.values())], - protect=protect, **own) + owned = [str(int(g["appid"]) & 0xFFFFFFFF) for g in games if g.get("exe") and not g.get("native")] + used = compat.register_default(cfg, apps=owned + [str(appid) for appid in set(routes.values())], + protect=protect, owned=owned, **own) print("droiddeck-steam-shortcuts: mapped them to %s" % used) except Exception as e: print("droiddeck-steam-shortcuts: compat mapping skipped (%s)" % e) diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-store-launch b/tools/linuxfs/overlay/usr/local/bin/droiddeck-store-launch index 131c049062..ca6ddebc84 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-store-launch +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-store-launch @@ -5,6 +5,8 @@ import binascii import json import os import re +import shlex +import shutil import sys import time import subprocess @@ -275,6 +277,10 @@ def exited(argv, code=0): subprocess.run([EPIC_CLIENT, "exited", "--code", str(code)], stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL, timeout=10) except (OSError, subprocess.TimeoutExpired): pass + if found is not None and launch_dir and str(found[1].get("store")) == "ea": + ask(Path(launch_dir) / "stores", {"op": "ea-exited", "store": "ea", "id": str(found[1].get("id"))}, timeout=1.0) + log("ea %s exited" % found[1].get("id")) + return 0 if found is None or not launch_dir or not cloud_on(found[1]): return 0 store, game = str(found[1].get("store")), str(found[1].get("id")) @@ -283,6 +289,218 @@ def exited(argv, code=0): return 0 +UBISOFT_DIR = "drive_c/Program Files (x86)/Ubisoft/Ubisoft Game Launcher" +UBISOFT_WINDOWS_DIR = "C:\\Program Files (x86)\\Ubisoft\\Ubisoft Game Launcher\\" +UBISOFT_INSTALLER_URL = "https://static3.cdn.ubi.com/orbit/launcher_installer/UbisoftConnectInstaller.exe" +UBISOFT_CACHE = Path("/root/.cache/droiddeck/ubisoft") +UBISOFT_LAUNCH = ".droiddeck-ubisoft.json" +UBISOFT_SERVICE = Path("/usr/local/lib/droiddeck-ubisoft/droiddeck-upc.exe") +UBISOFT_ASK_WAIT = 45.0 +UBISOFT_EXTRACT_WAIT = 300 +# Ubisoft's own game-side runtime from the Connect installer, unmodified: the API and aux DLLs the +# game's loader opens from InstallDir, the starter it re-executes into and its imports, and the overlay +# DLLs uplay_r1.dll loads even with the overlay off (its startup fails without them). +UBISOFT_RUNTIME = ("uplay_r1.dll", "uplay_r164.dll", "uplay_aux_r1.dll", "uplay_aux_r164.dll", + "uplay_r2.dll", "uplay_r264.dll", "ubiorbitapi_r2.dll", "ubiorbitapi_r264.dll", + "UbisoftGameLauncher.exe", "UbisoftGameLauncher64.exe", "discord-rpc.x86.dll", + "discord-rpc.x64.dll", "steam_api.dll", "steam_api64.dll", "overlay.dll", "overlay64.dll") +UBISOFT_VIEWS = ("[Software\\\\Ubisoft\\\\Launcher%s]", "[Software\\\\Wow6432Node\\\\Ubisoft\\\\Launcher%s]") +MIN_INSTALLER = 1 << 20 + + +def ubisoft_runtime_dir(compat_data): + return Path(compat_data) / "pfx" / UBISOFT_DIR + + +def ubisoft_runtime_ready(compat_data): + folder = ubisoft_runtime_dir(compat_data) + return all((folder / name).is_file() for name in UBISOFT_RUNTIME) + + +def fetch_installer(url=UBISOFT_INSTALLER_URL, folder=UBISOFT_CACHE): + target = folder / "UbisoftConnectInstaller.exe" + if target.is_file() and target.stat().st_size >= MIN_INSTALLER: + return target + import urllib.request + folder.mkdir(parents=True, exist_ok=True) + part = target.with_name(target.name + ".part") + request = urllib.request.Request(url, headers={"User-Agent": "Mozilla/5.0"}) + with urllib.request.urlopen(request, timeout=60) as reply, open(part, "wb") as out: + shutil.copyfileobj(reply, out) + if part.stat().st_size < MIN_INSTALLER: + part.unlink() + raise OSError("installer too small") + os.replace(part, target) + return target + + +def install_runtime(compat_data, wait=UBISOFT_EXTRACT_WAIT): + if ubisoft_runtime_ready(compat_data): + return "present" + if not (Path(compat_data) / "pfx").is_dir(): + return "no-prefix" + try: + installer = fetch_installer() + except OSError as error: + return "download-failed-" + type(error).__name__ + target = ubisoft_runtime_dir(compat_data) + target.mkdir(parents=True, exist_ok=True) + with tempfile.TemporaryDirectory(prefix="droiddeck-ubisoft-", dir=str(UBISOFT_CACHE)) as tmp: + try: + subprocess.run(["7z", "e", "-y", "-o" + tmp, str(installer)] + list(UBISOFT_RUNTIME), stdin=subprocess.DEVNULL, + stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, timeout=wait) + except subprocess.TimeoutExpired: + return "extract-timeout" + except OSError: + return "no-7z" + missing = [name for name in UBISOFT_RUNTIME if not (Path(tmp) / name).is_file()] + if missing: + return "extract-missing-" + ",".join(missing) + for name in UBISOFT_RUNTIME: + shutil.copyfile(Path(tmp) / name, target / name) + if not ubisoft_runtime_ready(compat_data): + return "copy-failed" + try: + installer.unlink() + except OSError: + pass + return "installed" + + +def ubisoft_product(sidecar): + extra = sidecar.get("extra") if isinstance(sidecar.get("extra"), dict) else {} + try: + return int(str(extra.get("productId") or "")) + except ValueError: + return None + + +def ubisoft_install_dir(folder): + return windows_path(str(folder)).replace("\\", "/").rstrip("/") + "/" + + +def register_ubisoft(folder, product, compat_data): + reg = Path(compat_data) / "pfx" / "system.reg" + if not reg.is_file(): + return "no-registry" + if not wait_for_server(reg.parent): + return "server-running" + for view in UBISOFT_VIEWS: + set_value(reg, view % "", "InstallDir", UBISOFT_WINDOWS_DIR) + set_value(reg, view % ("\\\\Installs\\\\%d" % product), "InstallDir", ubisoft_install_dir(folder)) + return "registered %d" % product + + +UBISOFT_HIVES = {"HKEY_LOCAL_MACHINE": "system.reg", "HKEY_CURRENT_USER": "user.reg"} + + +def manifest_value(values, folder, language): + """The value Connect writes for a manifest registry entry: the install folder, the entry for the + language being played, or the only entry there is.""" + entries = [v for v in values if isinstance(v, dict)] + if not entries: + return None + names = [str(v.get("name") or "") for v in entries] + if "$INSTALL_DIR" in names: + return windows_path(str(folder)).rstrip("\\") + "\\" + for v in entries: + if str(v.get("value") or "").lower() == language.lower(): + return str(v.get("value")) + prefix = language.split("-")[0].lower() + for v in entries: + if str(v.get("value") or "").lower().split("-")[0] == prefix: + return str(v.get("value")) + return str(entries[0].get("value") or entries[0].get("name") or "") + + +def apply_manifest_registry(compat_data, registry, folder, language): + written = 0 + for item in registry or []: + if not isinstance(item, dict): + continue + path = str(item.get("key") or "").replace("/", "\\") + hive, _, rest = path.partition("\\") + target = UBISOFT_HIVES.get(hive.upper()) + if not target or "\\" not in rest: + continue + subkey, _, name = rest.rpartition("\\") + value = manifest_value(item.get("values"), folder, language) + if value is None or not name: + continue + reg = Path(compat_data) / "pfx" / target + parts = subkey.split("\\") + views = [parts] + if target == "system.reg" and len(parts) > 1 and parts[0].lower() == "software" and parts[1].lower() != "wow6432node": + views.append(parts[:1] + ["Wow6432Node"] + parts[1:]) + for view in views: + key = "[" + "\\\\".join(view) + "]" + if set_value(reg, key, name, value): + written += 1 + return written + + +def ubisoft_launch(folder, sidecar, product, compat_data, answer): + """The launch file droiddeck-upc.exe reads: the game, the account and this launch's ticket.""" + account = answer.get("account") if isinstance(answer.get("account"), dict) else {} + user = str(account.get("userId") or "user") + saves = Path(compat_data) / "pfx" / "drive_c/users/steamuser/Saved Games/Ubisoft" / user / str(product) + saves.mkdir(parents=True, exist_ok=True) + exe = str(sidecar.get("exe") or "").replace("\\", "/") + workdir = folder / str(sidecar.get("workdir")) if sidecar.get("workdir") else folder + UBISOFT_CACHE.mkdir(parents=True, exist_ok=True) + return { + "productId": product, + "exe": windows_path(str(folder / exe)), + "args": " ".join(str(a) for a in sidecar.get("args") or []), + "workdir": windows_path(str(workdir)), + "account": account, + "ticket": str(answer.get("ticket") or ""), + "owned": [int(i) for i in answer.get("owned") or [] if str(i).isdigit()], + "products": [p for p in answer.get("products") or [] if isinstance(p, dict) and isinstance(p.get("id"), int)], + "appId": str(answer.get("appId") or ""), + "chunks": [c for c in answer.get("chunks") or [] if isinstance(c, dict) and isinstance(c.get("id"), int)], + "saves": "C:/users/steamuser/Saved Games/Ubisoft/%s/%d/" % (user, product), + "language": str(answer.get("language") or "en-US"), + "bridge": windows_path(str(UBISOFT_CACHE / ("bridge-%d" % product))), + "log": windows_path(str(UBISOFT_CACHE / ("upc-%d.log" % product))), + } + + +def prepare_ubisoft(folder, sidecar, compat_data, launch_dir, proton="", ask_app=None): + launch = folder / UBISOFT_LAUNCH + try: + launch.unlink() + except OSError: + pass + if not compat_data: + return "no-prefix" + product = ubisoft_product(sidecar) + if product is None: + return "no-product" + if not UBISOFT_SERVICE.is_file(): + return "no-service" + made = create_prefix(compat_data, proton) if not (Path(compat_data) / "pfx/user.reg").is_file() else "present" + if made not in ("present", "created"): + return "prefix " + made + runtime = install_runtime(compat_data) + if not ubisoft_runtime_ready(compat_data): + return "runtime " + runtime + registry = register_ubisoft(folder, product, compat_data) + if not launch_dir: + return "runtime %s, %s, no-channel" % (runtime, registry) + answer = (ask_app or ask)(Path(launch_dir) / "stores", {"op": "ubisoft-launch", "store": "ubisoft", "id": str(sidecar.get("id"))}, + timeout=UBISOFT_ASK_WAIT) + if not isinstance(answer, dict) or not answer.get("ok") or not answer.get("ticket"): + reason = "timeout" if answer is None else str(answer.get("reason") or "refused") + return "runtime %s, %s, session %s" % (runtime, registry, reason) + written = 0 + if answer.get("registry") and wait_for_server(Path(compat_data) / "pfx"): + written = apply_manifest_registry(compat_data, answer.get("registry"), folder, str(answer.get("language") or "en-US")) + tmp = launch.with_name(launch.name + ".tmp") + tmp.write_text(json.dumps(ubisoft_launch(folder, sidecar, product, compat_data, answer))) + os.replace(tmp, launch) + return "runtime %s, %s, %d manifest value(s), session ready" % (runtime, registry, written) + COMET_DIR = Path("/usr/local/lib/droiddeck-comet") @@ -352,6 +570,7 @@ def prepare_gog(sidecar, compat_data, launch_dir): GOG_SCRIPTS = "goggame-*.script" GOG_REGISTRY_MARK = ".droiddeck-gog-registry" +GOG_SUPPORT_MARK = ".droiddeck-gog-support" GOG_ROOTS = {"HKEY_LOCAL_MACHINE": "HKEY_LOCAL_MACHINE", "HKLM": "HKEY_LOCAL_MACHINE", "HKEY_CURRENT_USER": "HKEY_CURRENT_USER", "HKCU": "HKEY_CURRENT_USER", "HKEY_CLASSES_ROOT": "HKEY_CLASSES_ROOT", "HKCR": "HKEY_CLASSES_ROOT"} @@ -611,6 +830,458 @@ def apply_gog_registry(folder, compat_data, proton, timeout=90, installation=Non return "import-failed" + note +EA_HARDWARE = ".droiddeck-ea-hw.json" +EA_CLIENT = "C:\\Program Files (x86)\\Origin\\Origin.exe" +EA_WMI = ( + ("boardManufacturer", "Win32_BaseBoard", "Manufacturer"), + ("boardSerial", "Win32_BaseBoard", "SerialNumber"), + ("biosManufacturer", "Win32_BIOS", "Manufacturer"), + ("biosSerial", "Win32_BIOS", "SerialNumber"), + ("osInstallDate", "Win32_OperatingSystem", "InstallDate"), + ("osSerial", "Win32_OperatingSystem", "SerialNumber"), + ("gpuPnpId", "Win32_VideoController", "PNPDeviceID"), + ("cpuManufacturer", "Win32_Processor", "Manufacturer"), + ("processorId", "Win32_Processor", "ProcessorId"), + ("brand", "Win32_Processor", "Name"), +) +EA_ROOTS = {"HKLM": "HKEY_LOCAL_MACHINE", "HKCU": "HKEY_CURRENT_USER"} + + +def decode_output(data): + if data[:2] in (b"\xff\xfe", b"\xfe\xff") or (len(data) > 1 and data[1:2] == b"\x00"): + return data.decode("utf-16", "replace") + return data.decode("utf-8", "replace") + + +def wmi_value(text): + rows = [row.strip() for row in text.replace("\r", "\n").split("\n") if row.strip()] + return rows[1] if len(rows) > 1 else "" + + +CPUID_LEAVES = (0, 1, 0x80000002, 0x80000003, 0x80000004) + + +def cpuid_exe(): + """A 32-bit console program that writes the raw CPUID leaves an x86 game sees under the emulator.""" + import struct + base, rva = 0x400000, 0x1000 + buf, written = base + rva + 0x180, base + rva + 0x1D0 + iat = base + rva + 0x138 + code = b"\x53\x57\xbf" + struct.pack(" "%s"' % (cls, prop, windows_path(str(folder / (key + ".txt"))))) + lines.append('vol C: > "%s"' % windows_path(str(folder / "volume.txt"))) + lines.append('hostname > "%s"' % windows_path(str(folder / "hostname.txt"))) + (folder / "cpuid.exe").write_bytes(cpuid_exe()) + lines.append('"%s" > "%s"' % (windows_path(str(folder / "cpuid.exe")), windows_path(str(folder / "cpuid.bin")))) + bat = folder / "probe.bat" + bat.write_bytes(("\r\n".join(lines) + "\r\n").encode()) + try: + subprocess.run([proton, "run", "cmd.exe", "/d", "/c", windows_path(str(bat))], stdin=subprocess.DEVNULL, + stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, timeout=timeout) + except subprocess.TimeoutExpired: + return {}, "timeout" + except OSError: + return {}, "failed" + for key, _, _ in EA_WMI: + try: + values[key] = wmi_value(decode_output((folder / (key + ".txt")).read_bytes())) + except OSError: + values[key] = "" + try: + found = re.search(r"([0-9A-Fa-f]{4})-([0-9A-Fa-f]{4})", decode_output((folder / "volume.txt").read_bytes())) + values["volumeSerial"] = (found.group(1) + found.group(2)).lower() if found else "" + except OSError: + values["volumeSerial"] = "" + try: + values["hostname"] = decode_output((folder / "hostname.txt").read_bytes()).strip().splitlines()[0].strip() + except (OSError, IndexError): + values["hostname"] = "" + try: + values.update(cpuid_values((folder / "cpuid.bin").read_bytes())) + except OSError: + pass + if probe_complete(values): + try: + cache.write_text(json.dumps(values)) + except OSError: + pass + return values, "probed" + return values, "incomplete" + + +def ea_registry_entries(folder, sidecar): + install = windows_path(str(folder)).rstrip("\\") + "\\" + extra = sidecar.get("extra") if isinstance(sidecar.get("extra"), dict) else {} + title = str(extra.get("displayName") or sidecar.get("title") or folder.name).strip() + locale = str(extra.get("locale") or "en_US") + entries = [ + ("HKEY_LOCAL_MACHINE\\SOFTWARE\\Electronic Arts\\EA Desktop", "InstallSuccessful", "true"), + ("HKEY_LOCAL_MACHINE\\SOFTWARE\\Electronic Arts\\Origin", "InstallSuccessful", "true"), + ("HKEY_LOCAL_MACHINE\\SOFTWARE\\Electronic Arts\\Origin", "ClientPath", EA_CLIENT), + ("HKEY_LOCAL_MACHINE\\SOFTWARE\\Origin", "ClientPath", EA_CLIENT), + ] + for content in [c.strip() for c in str(extra.get("contentIds") or extra.get("contentId") or "").split(",")]: + if re.fullmatch(r"[A-Za-z0-9._-]{1,64}", content): + key = "HKEY_LOCAL_MACHINE\\SOFTWARE\\Origin Games\\" + content + entries += [(key, "DisplayName", title), (key, "Install Dir", install), (key, "Locale", locale)] + try: + keys = json.loads(extra.get("registry") or "[]") + except ValueError: + keys = [] + for pair in keys if isinstance(keys, list) else []: + if not isinstance(pair, list) or len(pair) != 2: + continue + key, name = str(pair[0]), str(pair[1]) + root, _, rest = key.partition("\\") + key = EA_ROOTS.get(root.upper(), root) + ("\\" + rest if rest else "") + if key.upper().startswith(("HKEY_LOCAL_MACHINE\\", "HKEY_CURRENT_USER\\")) and name and "\n" not in key + name: + entries.append((key, name, install)) + if title: + entries.append((key, "DisplayName", title)) + entries.append((key, "Locale", locale)) + return entries + + +def ea_registry(folder, sidecar, compat_data, proton, timeout=90): + if not compat_data or not proton or not Path(proton).is_file(): + return "no-proton" + pfx = Path(compat_data) / "pfx" + text = "Windows Registry Editor Version 5.00\r\n\r\n" + "".join( + '[%s]\r\n"%s"="%s"\r\n\r\n' % (key, reg_escape(name), reg_escape(value)) for key, name, value in ea_registry_entries(folder, sidecar)) + stamp = hashlib.sha256(text.encode("utf-8")).hexdigest() + marker = pfx / (".droiddeck-ea-registry-" + re.sub(r"[^A-Za-z0-9._-]", "_", str(sidecar.get("id")))) + try: + if marker.is_file() and marker.read_text() == stamp and (pfx / "system.reg").is_file(): + return "ready" + with tempfile.TemporaryDirectory(prefix="droiddeck-ea-") as tmp: + source = Path(tmp) / "registry.reg" + source.write_bytes(b"\xff\xfe" + text.encode("utf-16-le")) + executable = pfx / "drive_c/windows/system32/reg.exe" + for view in ("/reg:32", "/reg:64"): + run = subprocess.run([proton, "run", str(executable) if executable.is_file() else "reg.exe", "import", windows_path(str(source)), view], + stdin=subprocess.DEVNULL, stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, timeout=timeout) + if run.returncode: + return "import-failed" + marker.write_text(stamp) + return "written" + except subprocess.TimeoutExpired: + return "timeout" + except OSError: + return "import-failed" + + +def find_case(folder, relative): + current = Path(folder) + for part in [p for p in relative.replace("\\", "/").split("/") if p and p != "."]: + exact = current / part + if exact.exists(): + current = exact + continue + try: + current = next(c for c in current.iterdir() if c.name.lower() == part.lower()) + except (OSError, StopIteration): + return None + return current if current != Path(folder) else None + + +def touchup_args(raw, locale, install): + raw = raw.replace("{locale}", locale) + raw = raw.replace('"{installLocation}"', '"%s"' % install).replace("{installLocation}", install) + try: + return shlex.split(raw.replace("\\", "\\\\")) + except ValueError: + return raw.split() + + +def ea_touchup(folder, sidecar, compat_data, proton, timeout=900): + extra = sidecar.get("extra") if isinstance(sidecar.get("extra"), dict) else {} + relative = str(extra.get("touchup") or "") + if not relative: + return "none" + exe = find_case(folder, relative) + if exe is None or not exe.is_file(): + return "missing" + if not compat_data or not proton or not Path(proton).is_file(): + return "no-proton" + pfx = Path(compat_data) / "pfx" + stamp = str(sidecar.get("installVersion") or "") + " " + str(sidecar.get("installedAt") or "") + marker = pfx / (".droiddeck-ea-touchup-" + re.sub(r"[^A-Za-z0-9._-]", "_", str(sidecar.get("id")))) + try: + if marker.is_file() and marker.read_text() == stamp: + return "done" + except OSError: + pass + args = touchup_args(str(extra.get("touchupArgs") or ""), str(extra.get("locale") or "en_US"), windows_path(str(folder)).rstrip("\\")) + try: + run = subprocess.run([proton, "run", str(exe)] + args, cwd=str(exe.parent), stdin=subprocess.DEVNULL, + stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL, timeout=timeout) + result = "ok" if run.returncode == 0 else "exit-%d" % run.returncode + except subprocess.TimeoutExpired: + result = "timeout" + except OSError: + return "failed" + try: + marker.write_text(stamp) + except OSError: + pass + return result + + +def write_licenses(compat_data, licenses): + if not compat_data: + return 0 + root = Path(compat_data) / "pfx/drive_c" + written = 0 + for item in licenses or []: + relative = str(item.get("path") or "") if isinstance(item, dict) else "" + if not relative or relative.startswith("/") or ".." in relative.split("/"): + continue + target = root / relative + try: + target.parent.mkdir(parents=True, exist_ok=True) + target.write_bytes(base64.b64decode(item.get("data") or "")) + written += 1 + except (OSError, binascii.Error): + pass + return written + + +def prepare_ea(folder, sidecar, compat_data, launch_dir): + game = str(sidecar.get("id")) + proton = os.environ.get("BL_STORE_PROTON", "") + made = create_prefix(compat_data, proton) + ready = made in ("present", "created") or (compat_data and (Path(compat_data) / "pfx/user.reg").is_file()) + stub = install_origin_stub(compat_data) if ready else "no-prefix" + hardware, probe = ea_hardware(compat_data, proton) if ready else ({}, "no-prefix") + answer = None + if launch_dir: + answer = ask(Path(launch_dir) / "stores", {"op": "ea-prepare", "store": "ea", "id": game, "hardware": hardware}, timeout=40.0) + sidecar = sidecar_at(Path(folder)) or sidecar + log("ea %s prefix=%s stub=%s hardware=%s registry=%s touchup=%s" % ( + game, made, stub, probe, ea_registry(folder, sidecar, compat_data, proton), ea_touchup(folder, sidecar, compat_data, proton))) + if answer is None: + log("ea %s session=no reason=%s" % (game, "timeout" if launch_dir else "no-channel")) + return + written = write_licenses(compat_data, answer.get("licenses")) + log("ea %s session=%s reason=%s lsx=%s licence=%s files=%d" % ( + game, "yes" if answer.get("ok") else "no", answer.get("reason", ""), answer.get("lsx"), answer.get("license", ""), written)) + + +def gog_support_actions(folder): + found = [] + for script in sorted(Path(folder).glob(GOG_SCRIPTS)): + product = script.name[len("goggame-"):-len(".script")] + try: + actions = json.loads(script.read_text(encoding="utf-8-sig")).get("actions") + except (OSError, ValueError, AttributeError): + continue + for action in actions if isinstance(actions, list) else []: + install = action.get("install") if isinstance(action, dict) else None + if isinstance(install, dict) and install.get("action") == "supportData" \ + and isinstance(install.get("arguments"), dict): + found.append((product, install["arguments"])) + return found + + +def gog_support_bases(folder, product, pfx): + user = Path(pfx) / "drive_c" / "users" / "steamuser" + support = Path(folder) / "support" / product + return {"app": Path(folder), "supportdir": support, "support": support, + "userdocs": user / "Documents", "localappdata": user / "AppData" / "Local"} + + +def gog_inside(path, base): + root = os.path.realpath(base) + real = os.path.realpath(path) + return real == root or real.startswith(root + os.sep) + + +def gog_support_path(text, bases): + match = re.fullmatch(r"\{(\w+)\}(.*)", text) if isinstance(text, str) else None + if not match or match.group(1).lower() not in bases: + return None + parts = [part for part in re.split(r"[\\/]+", match.group(2)) if part] + if any(part in (".", "..") for part in parts): + return None + base = bases[match.group(1).lower()] + path = base + for part in parts: + exact = path / part + if not exact.exists() and path.is_dir(): + exact = next((child for child in path.iterdir() if child.name.lower() == part.lower()), exact) + path = exact + if path != base and not gog_inside(path.parent, base): + return None + return path, base + + +def gog_copy_file(source, target, root): + if not gog_inside(target.parent, root): + raise OSError("outside " + str(root)) + target.parent.mkdir(parents=True, exist_ok=True) + if target.is_symlink(): + target.unlink() + shutil.copy2(source, target, follow_symlinks=False) + + +def gog_support_data(folder, compat_data, proton): + actions = gog_support_actions(folder) + if not actions: + return "none" + pfx = Path(compat_data) / "pfx" if compat_data else None + if not pfx or not (pfx / "drive_c" / "users" / "steamuser").is_dir(): + made = create_prefix(compat_data, proton) + if made not in ("present", "created") or not (pfx / "drive_c" / "users" / "steamuser").is_dir(): + return "no-prefix" + stamp = hashlib.sha256(json.dumps(actions, sort_keys=True).encode("utf-8")).hexdigest() + marker = pfx / GOG_SUPPORT_MARK + try: + if marker.is_file() and marker.read_text() == stamp: + return "ready" + except OSError: + pass + copied = skipped = missing = 0 + for product, arguments in actions: + bases = gog_support_bases(folder, product, pfx) + found = gog_support_path(arguments.get("target"), bases) + origin = gog_support_path(arguments["source"], bases) if "source" in arguments else None + if found is None or ("source" in arguments and origin is None): + skipped += 1 + continue + target, root = found + source = origin[0] if origin else None + try: + if source is None: + target.mkdir(parents=True, exist_ok=True) + elif not source.exists(): + missing += 1 + elif source.is_dir() and not source.is_symlink(): + for top, dirs, files in os.walk(source): + for name in sorted(files + [d for d in dirs if (Path(top) / d).is_symlink()]): + item = Path(top) / name + destination = target / item.relative_to(source) + if (destination.exists() or destination.is_symlink()) and not arguments.get("overwrite"): + continue + gog_copy_file(item, destination, root) + copied += 1 + target.mkdir(parents=True, exist_ok=True) + elif (target.exists() or target.is_symlink()) and not arguments.get("overwrite"): + continue + else: + gog_copy_file(source, target, root) + copied += 1 + except OSError: + skipped += 1 + note = "".join(" %s=%d" % (name, count) for name, count in (("skipped", skipped), ("missing", missing)) if count) + if not skipped: + try: + marker.write_text(stamp) + except OSError: + pass + return "copied=%d%s" % (copied, note) + + def main(argv): if os.environ.get("DROIDDECK_GOG_MAINTENANCE") == "1": return 0 @@ -654,6 +1325,16 @@ def main(argv): if store == "gog": prepare_gog(sidecar, compat_data, launch_dir) log("gog registry: " + apply_gog_registry(folder, compat_data, os.environ.get("BL_STORE_PROTON", ""))) + log("gog support data: " + gog_support_data(folder, compat_data, os.environ.get("BL_STORE_PROTON", ""))) + if store == "ubisoft": + try: + log("ubisoft %s: %s" % (game, prepare_ubisoft(folder, sidecar, compat_data, launch_dir, os.environ.get("BL_STORE_PROTON", "")))) + except OSError as e: + try: + (folder / UBISOFT_LAUNCH).unlink() + except OSError: + pass + log("ubisoft %s: not prepared (%s), starting directly" % (game, e)) if store == "epic": handled = os.environ.get(EPIC_HANDLED) == "1" and (folder / EPIC_ARGS).is_file() if not handled: @@ -691,6 +1372,9 @@ def main(argv): got = bool(answer.get("code")) log("epic launch id=%s code=%s reason=%s" % (game, "yes" if got else "no", answer.get("reason", ""))) log("epic prefix=%s %s" % (prefix_id or "?", provision_prefix(compat_data))) + if store == "ea": + prepare_ea(folder, sidecar, compat_data, launch_dir) + return STORE_GAME if not cloud_on(sidecar): if store in CLOUD_STORES: log("cloud %s %s down result=skipped reason=off" % (store, game)) diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-wincomponents b/tools/linuxfs/overlay/usr/local/bin/droiddeck-wincomponents index 393f971024..dde2d6e6be 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-wincomponents +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-wincomponents @@ -2,11 +2,17 @@ import json import os import re +import runpy import shutil import sys import time from pathlib import Path +PE = runpy.run_path(str(Path(__file__).resolve().parent / "droiddeck-wine-pe")) +PE_MACHINES = PE["PE_MACHINES"] +pe_machine = PE["pe_machine"] +machine_compatible = PE["machine_compatible"] + STORE = Path("/opt/droiddeck/wincomponents") SELECTION = Path.home() / ".config/droiddeck/wincomponents.json" PENDING = Path.home() / ".config/droiddeck/wincomponents-pending.json" @@ -473,6 +479,15 @@ def save_state(compat, state): os.replace(temp, compat / STATE) +def foreign_component(rel, path, machines): + parts = Path(rel).parts + folder = parts[2] if len(parts) > 2 and parts[:2] == ("drive_c", "windows") else None + if not machines or folder not in PE_MACHINES or not rel.lower().endswith(".dll"): + return False + machine = pe_machine(path) + return machine is not None and not machine_compatible(path, machines[folder][1], machine) + + def pending_for(app_id, pending=PENDING): try: with open(pending, encoding="utf-8") as source: @@ -514,7 +529,8 @@ def wait_for_pending(app_id, pending=PENDING, store=STORE, timeout=PENDING_WAIT, return "wincomp: %s waited %dms for %s" % (app_id, waited, ",".join(asked)) -def apply(compat_path, app_id, selection=SELECTION, store=STORE, pending=PENDING, wait=wait_for_pending): +def apply(compat_path, app_id, selection=SELECTION, store=STORE, pending=PENDING, wait=wait_for_pending, + proton=None, env=None): compat = Path(compat_path) pfx = compat / "pfx" waited = wait(app_id, pending, store) if wait else None @@ -527,6 +543,9 @@ def apply(compat_path, app_id, selection=SELECTION, store=STORE, pending=PENDING installed = [] values = [] held = set() + skipped = set() + placed_stems = set() + machines = PE["proton_pe_machines"](proton, env) if proton else None saved_overrides = state.get("overrides") if isinstance(state.get("overrides"), dict) else {} saved_requires = state.get("requires") if isinstance(state.get("requires"), dict) else {} recorded = [c for c in state.get("components", []) if isinstance(c, str) and valid_id(c)] @@ -566,9 +585,17 @@ def apply(compat_path, app_id, selection=SELECTION, store=STORE, pending=PENDING kept_requires[cid] = list(requires) values += [(cid, value) for value in registry] for rel, src in files: - if place(src, pfx / rel, None if rel in state["files"] else compat / BACKUP / rel): + foreign = foreign_component(rel, src, machines) + if foreign: + skipped.add(Path(rel).stem.lower()) + changed = False + else: + changed = place(src, pfx / rel, None if rel in state["files"] else compat / BACKUP / rel) + placed_stems.add(Path(rel).stem.lower()) + if changed: copied += 1 - keep[rel] = cid + if not foreign: + keep[rel] = cid removed = restored = 0 for rel, cid in state["files"].items(): if rel in keep: @@ -579,6 +606,10 @@ def apply(compat_path, app_id, selection=SELECTION, store=STORE, pending=PENDING path = existing(pfx / rel) saved = compat / BACKUP / rel if saved.is_file(): + if foreign_component(rel, saved, machines): + if path is not None and not path.is_symlink(): + path.unlink() + continue target = path or (pfx / rel) os.replace(saved, target) restored += 1 @@ -590,6 +621,14 @@ def apply(compat_path, app_id, selection=SELECTION, store=STORE, pending=PENDING (compat / "config_info").unlink() except FileNotFoundError: pass + def override_name(entry): + name = entry.partition("=")[0].strip().lower() + return name[:-4] if name.endswith(".dll") else name + + dropped = skipped - placed_stems + overrides = [entry for entry in overrides if override_name(entry) not in dropped] + for cid in kept_overrides: + kept_overrides[cid] = [entry for entry in kept_overrides[cid] if override_name(entry) not in dropped] compat.mkdir(parents=True, exist_ok=True) new_state = {"files": keep, "components": installed + sorted(held), "overrides": kept_overrides, "requires": kept_requires, "registry": state.get("registry", {})} diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-wine-pe b/tools/linuxfs/overlay/usr/local/bin/droiddeck-wine-pe new file mode 100755 index 0000000000..65c3446a2a --- /dev/null +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-wine-pe @@ -0,0 +1,103 @@ +#!/usr/bin/python3 +import re +from pathlib import Path + + +PE_MACHINES = { + "system32": ("aarch64-windows", frozenset((0xAA64, 0xA641))), + "syswow64": ("i386-windows", frozenset((0x14C,))), +} + + +def pe_machine(path): + try: + with open(path, "rb") as image: + head = image.read(64) + if head[:2] != b"MZ" or len(head) < 64: + return None + image.seek(int.from_bytes(head[60:64], "little")) + header = image.read(6) + except OSError: + return None + if header[:4] != b"PE\0\0" or len(header) < 6: + return None + return int.from_bytes(header[4:6], "little") + + +def pe_has_arm64ec_metadata(path): + try: + with open(path, "rb") as image: + image.seek(60) + raw = image.read(4) + if len(raw) != 4: + return False + pe_offset = int.from_bytes(raw, "little") + image.seek(pe_offset) + if image.read(4) != b"PE\0\0": + return False + coff = image.read(20) + if len(coff) != 20: + return False + section_count = int.from_bytes(coff[2:4], "little") + if section_count > 96: + return False + optional_size = int.from_bytes(coff[16:18], "little") + optional_offset = pe_offset + 24 + image.seek(optional_offset) + optional = image.read(optional_size) + if len(optional) != optional_size or int.from_bytes(optional[:2], "little") != 0x20B: + return False + directory_count = int.from_bytes(optional[108:112], "little") + directory_offset = 112 + 10 * 8 + if directory_count <= 10 or directory_offset + 8 > len(optional): + return False + load_config_rva = int.from_bytes(optional[directory_offset:directory_offset + 4], "little") + load_config_size = int.from_bytes(optional[directory_offset + 4:directory_offset + 8], "little") + if not load_config_rva or load_config_size < 0xD0: + return False + section_offset = optional_offset + optional_size + for index in range(section_count): + image.seek(section_offset + index * 40) + section = image.read(40) + if len(section) != 40: + return False + virtual_address = int.from_bytes(section[12:16], "little") + raw_size = int.from_bytes(section[16:20], "little") + raw_offset = int.from_bytes(section[20:24], "little") + relative = load_config_rva - virtual_address + if 0 <= relative <= raw_size - 0xD0: + image.seek(raw_offset + relative) + load_config = image.read(0xD0) + if len(load_config) != 0xD0 or int.from_bytes(load_config[:4], "little") < 0xD0: + return False + return int.from_bytes(load_config[0xC8:0xD0], "little") != 0 + except (OSError, OverflowError, ValueError): + return False + return False + + +# Only x64 code and members of the same runtime family import these, so an x64 copy loads in an +# ARM64EC prefix, and games check for a newer version than Wine's builtins report. +VC_RUNTIME = re.compile(r"(msvc[pr]\d.*|vcruntime\d.*|vcomp\d*|vcamp\d.*|vccorlib\d.*|concrt\d.*|mfcm?\d.*)\.dll", + re.IGNORECASE) + + +def machine_compatible(path, machines, machine=None): + machine = pe_machine(path) if machine is None else machine + if machine == 0x8664 and 0xA641 in machines and VC_RUNTIME.fullmatch(Path(path).name): + return True + if machine == 0x8664 and pe_has_arm64ec_metadata(path): + return 0xA641 in machines + return machine in machines + + +def proton_pe_machines(proton, env=None): + dist = Path(proton).parent / "files/lib/wine" + if (dist / "aarch64-unix").is_dir() and (env or {}).get("PROTON_USE_ARM64", "1") == "1": + return PE_MACHINES + if (dist / "x86_64-unix").is_dir(): + return { + "system32": ("x86_64-windows", frozenset((0x8664,))), + "syswow64": PE_MACHINES["syswow64"], + } + return None diff --git a/tools/linuxfs/overlay/usr/local/bin/steam-compatibility b/tools/linuxfs/overlay/usr/local/bin/steam-compatibility index 8247201a34..426b6c173b 100755 --- a/tools/linuxfs/overlay/usr/local/bin/steam-compatibility +++ b/tools/linuxfs/overlay/usr/local/bin/steam-compatibility @@ -16,6 +16,8 @@ LEGACY_LAUNCHER = "bannerlator-proton" LIBRARY = "/mnt/droiddeck" SOURCES = ("Proton Experimental (ARM64)", "Proton 11.0 (ARM64)") OWN_TOOLS = ((TOOL, SOURCES), (TOOL_11, ("Proton 11.0 (ARM64)",))) +VALVE_DEPOTS = {"proton_experimental": SOURCES[0], "proton-experimental-arm64": SOURCES[0], + "proton_11": SOURCES[1], "proton_11-arm64": SOURCES[1]} FEX_TOOL = "droiddeck-fex" FEX_LAUNCHER = "droiddeck-fex-tool" FEX_FILES = ("toolmanifest.vdf", "compatibilitytool.vdf", FEX_LAUNCHER) @@ -150,6 +152,13 @@ bl_components() { else cm_app="" fi + if [ "$cm_app" = 2929927072 ] && [[ "${SteamAppId:-}" =~ ^[0-9]{1,10}$ ]] && (( 10#$SteamAppId > 0 && 10#$SteamAppId <= 4294967295 )); then + cm_app=$((10#$SteamAppId)) + elif [ "$cm_app" = 2929927072 ] && [[ "${SteamGameId:-}" =~ ^[1-9][0-9]{9,19}$ ]] && + { [ ${#SteamGameId} -lt 20 ] || [[ ! "$SteamGameId" > 18446744073709551615 ]]; } && + (( (10#$SteamGameId & 0xFFFFFFFF) == 0x02000000 && ((10#$SteamGameId >> 32) & 0xFFFFFFFF) != 0 )); then + cm_app=$(( (10#$SteamGameId >> 32) & 0xFFFFFFFF )) + fi if [ -z "$cm_app" ]; then echo "droiddeck-proton: components: invalid game prefix, left as it is" >&2 return 0 @@ -732,6 +741,7 @@ def libraries(steam_root): def installed_apps(steam_root): + entries = appinfo_entries(os.path.join(steam_root, "appcache", "appinfo.vdf")) apps = set() for library in libraries(steam_root): steamapps = os.path.join(library, "steamapps") @@ -741,7 +751,7 @@ def installed_apps(steam_root): continue for name in names: m = re.fullmatch(r"appmanifest_(\d+)\.acf", name) - if m and m.group(1) not in NOT_GAMES: + if m and m.group(1) not in NOT_GAMES and entries.get(m.group(1), {}).get("type") != "tool": apps.add(m.group(1)) return sorted(apps, key=int) @@ -925,6 +935,12 @@ def valve_picks(steam_root): return sorted(picks, key=int) +def tool_platforms(steam_root): + entries = appinfo_entries(os.path.join(steam_root, "appcache", "appinfo.vdf")) + return {app: entry["oslist"] for app, entry in entries.items() + if entry["type"] == "tool" and entry["oslist"] & {"linux", "windows"}} + + def native_targets(steam_root, apps): wanted = {str(app) for app in apps if str(app) not in NOT_GAMES} if not wanted: @@ -1062,10 +1078,11 @@ NATIVE_CHOICE = object() def plan_mapping(current, installed, runnable, default, auto, native=None, picks=(), overrides=None, managed=None, - native_choices=()): + native_choices=(), tools=None): + tools = tools or {} runnable = {n.lower() for n in runnable} installed = set(installed) - picks = set(picks) + picks = set(picks) | {app for app, platforms in tools.items() if "linux" not in platforms} native = native or {} overrides = overrides or {} managed = set(auto) if managed is None else set(managed) @@ -1073,8 +1090,12 @@ def plan_mapping(current, installed, runnable, default, auto, native=None, picks changes, kept = {}, {} if current.get("0", "") != default: changes["0"] = default - for app in sorted((set(current) | installed | picks | set(auto) | set(overrides) | native_choices) - {"0"}, key=app_order): + for app in sorted((set(current) | installed | picks | set(auto) | set(overrides) | native_choices | set(tools)) - {"0"}, key=app_order): name = current.get(app, "") + if app in tools and "linux" in tools[app] and "windows" not in tools[app]: + if name and (name.lower() in runnable or "proton" in name.lower()): + changes[app] = None + continue if app in overrides: target = overrides[app] if target is DEFERRED_GAME_TOOL: @@ -1160,6 +1181,18 @@ def tool_catalog(steam_root, extras=None): return catalog +def built_from(name, catalog, runnable=None): + depot = VALVE_DEPOTS.get(name) + tools = [t["name"] for t in catalog if depot and t["valve"] and t["dir"] == depot and + (runnable is None or t["name"] in runnable)] + return tools[-1] if tools else None + + +def rebuilt_picks(current, catalog, known, runnable=None): + picks = {app: built_from(name, catalog, runnable) for app, name in current.items() if app in known} + return {app: tool for app, tool in picks.items() if tool} + + def requested_tool(request, catalog): name = request.get("name") if isinstance(name, str) and any(t["name"] == name for t in catalog): @@ -1307,9 +1340,13 @@ def now_ms(): return int(time.time() * 1000) -def choose_default(steam_default, state, request, catalog, adopt_steam=True, apply_request=True, now=None): +def choose_default(steam_default, state, request, catalog, adopt_steam=True, apply_request=True, now=None, listed=None): state = dict(state) names = [t["name"] for t in catalog] + listed = names if listed is None else listed + if "written" not in state and state.get("source") == "steam": + state["source"] = "fallback" + hidden = state.get("default") in names and state.get("default") not in listed seq = request.get("seq") seq = seq if isinstance(seq, int) else 0 if apply_request and seq > int(state.get("applied", 0) or 0): @@ -1321,11 +1358,12 @@ def choose_default(steam_default, state, request, catalog, adopt_steam=True, app else: print("steam-compatibility: the app asked for %s, which is not installed; kept %s" % ( request.get("name") or request.get("dir"), state.get("default") or TOOL)) - elif adopt_steam and steam_default in names and steam_default != state.get("default"): + elif adopt_steam and steam_default in names and not hidden and steam_default not in ( + state.get("default"), state.get("written", state.get("default") or TOOL)): state.update(default=steam_default, seq=now or now_ms(), source="steam") - if state.get("default") not in names: - state["default"] = TOOL - return state["default"], state + if state.get("default") not in names and state.get("default") != TOOL: + state.update(default=TOOL, source="fallback") + return state["default"] if state["default"] in listed else TOOL, state def mapping_block(tokens): @@ -1482,7 +1520,7 @@ def live_helper_running(directory=None): def register_default(config_path, apps=(), protect=(), default=None, catalog=None, directory=None, settle=False, picks=(), - linux_tool=FEX_TOOL): + linux_tool=FEX_TOOL, owned=None): with locked(directory): state = read_json(state_path("state.json", directory)) with open(config_path, encoding="utf-8", errors="replace") as f: @@ -1497,24 +1535,38 @@ def register_default(config_path, apps=(), protect=(), default=None, catalog=Non dict(protect) if isinstance(protect, dict) else {name: name for name in protect}) names = [t["name"] for t in catalog] newest, gone = own_proton_moves(state, catalog) - previous, applied, chosen = state.get("default"), state.get("applied"), state.get("seq") + previous = state.get("default") + if owned is not None: + auto = followers(state, current) + known = {app for app in state.get("owned", ()) if isinstance(app, str)} if isinstance(state.get("owned"), list) else set() + pinned = {app: current[app] for app in set(owned) - known + if current.get(app) in {TOOL, previous} | gone and app not in auto} + if pinned and isinstance(auto, dict): + state["auto"] = dict(auto, **pinned) + state["owned"] = sorted(set(owned), key=app_order) if default is None: if settle: - default, state = choose_default(current.get("0", ""), state, read_json(state_path("request.json", directory)), catalog) + default, state = choose_default(built_from(current.get("0", ""), catalog) or current.get("0", ""), state, + read_json(state_path("request.json", directory)), catalog) else: default = state.get("default") if state.get("default") in names else TOOL - if settle and newest and default == TOOL and state.get("applied") == applied and state.get("seq") == chosen and ( - previous in gone or not state.get("own_proton")): + if settle and newest and default == TOOL and state.get("source") not in ("app", "steam"): default = newest state.update(default=newest, seq=now_ms(), source="update") - if settle and newest: - state["own_proton"] = True + state.pop("own_proton", None) if newest: replacements = {app: newest for app, name in current.items() if app != "0" and name in gone} set_mappings(tokens, mapping, replacements) current.update(replacements) if isinstance(state.get("auto"), dict): state["auto"] = {app: newest if name in gone else name for app, name in state["auto"].items()} + following = followers(state, current) + following = following if isinstance(following, dict) else {} + moved = rebuilt_picks(current, catalog, set(following) | picked_apps(state)) + if moved: + state["auto"] = {app: name for app, name in following.items() if app not in moved} + set_mappings(tokens, mapping, moved) + current.update(moved) steam_root = os.path.dirname(os.path.dirname(os.path.abspath(config_path))) requests = settled_game_requests(state, current, catalog, not steam_running(), directory) overrides = requested_games(requests or {}, catalog) @@ -1527,7 +1579,7 @@ def register_default(config_path, apps=(), protect=(), default=None, catalog=Non current.setdefault(app, "") changes, auto = plan_mapping( current, apps, names, default, followers(state, current), native, picks, - overrides, managed, native_choices) + overrides, managed, native_choices, tool_platforms(steam_root)) set_mappings(tokens, mapping, changes) text = serialize(tokens) if text != serialize(tokenize(original)): @@ -1539,6 +1591,8 @@ def register_default(config_path, apps=(), protect=(), default=None, catalog=Non state.pop("native", None) state["tools"] = catalog state.setdefault("default", default) + if settle: + state["written"] = default write_json(state_path("state.json", directory), state) return default @@ -1552,10 +1606,11 @@ def depot_build(depot): return int(first[0]) if first and first[0].isdigit() else 0 -def find_source(steam_root, sources=SOURCES): +def find_source(steam_root, sources=SOURCES, runnable=False): for name in sources: found = [os.path.join(root, "steamapps", "common", name) for root in libraries(steam_root) - if os.path.isdir(os.path.join(root, "steamapps", "common", name, "files", "bin-arm64"))] + if os.path.isdir(os.path.join(root, "steamapps", "common", name, "files", "bin-arm64")) + and (not runnable or os.access(os.path.join(root, "steamapps", "common", name, "proton"), os.X_OK))] if found: return max(found, key=depot_build) return None diff --git a/tools/linuxfs/preload/binfmt.c b/tools/linuxfs/preload/binfmt.c index eb912efe11..dbe2977265 100644 --- a/tools/linuxfs/preload/binfmt.c +++ b/tools/linuxfs/preload/binfmt.c @@ -18,6 +18,8 @@ typedef int (*spawn_fn)(pid_t *, const char *, const posix_spawn_file_actions_t *, const posix_spawnattr_t *, char *const[], char *const[]); +__attribute__((visibility("hidden"))) +char *const *bl_webhelper_argv(const char *path, char *const argv[], char *const envp[]); #if defined(__aarch64__) || defined(BINFMT_TEST) @@ -141,21 +143,26 @@ __attribute__((visibility("hidden"))) int bl_binfmt_spawn(pid_t *pid, const char } int execvpe(const char *file, char *const argv[], char *const envp[]) { + char resolved[PATH_MAX]; + const char *path = lookup(file, resolved, sizeof resolved) ? resolved : file; + char *const *adjusted = bl_webhelper_argv(path, argv, envp); static int (*real)(const char *, char *const[], char *const[]); if (!real) real = (int (*)(const char *, char *const[], char *const[]))dlsym(RTLD_NEXT, "execvpe"); - bl_binfmt_before_search(file, argv, envp); - real(file, argv, envp); - return bl_binfmt_after_search(file, argv, envp, errno); + bl_binfmt_before_search(file, (char *const *)adjusted, envp); + real(file, (char *const *)adjusted, envp); + return bl_binfmt_after_search(file, (char *const *)adjusted, envp, errno); } int posix_spawnp(pid_t *pid, const char *file, const posix_spawn_file_actions_t *fa, const posix_spawnattr_t *attr, char *const argv[], char *const envp[]) { + char path[PATH_MAX]; + int found = lookup(file, path, sizeof path); + char *const *adjusted = bl_webhelper_argv(found ? path : file, argv, envp); static spawn_fn real, spawn; if (!real) real = (spawn_fn)dlsym(RTLD_NEXT, "posix_spawnp"); if (!spawn) spawn = (spawn_fn)dlsym(RTLD_NEXT, "posix_spawn"); - char path[PATH_MAX]; - if (!handing_off() || !lookup(file, path, sizeof path)) return real(pid, file, fa, attr, argv, envp); - return bl_binfmt_spawn(pid, path, fa, attr, argv, envp, spawn); + if (!handing_off() || !found) return real(pid, file, fa, attr, (char *const *)adjusted, envp); + return bl_binfmt_spawn(pid, path, fa, attr, (char *const *)adjusted, envp, spawn); } #else diff --git a/tools/linuxfs/preload/net.c b/tools/linuxfs/preload/net.c index 4946db7f9c..e45ed9c5c0 100644 --- a/tools/linuxfs/preload/net.c +++ b/tools/linuxfs/preload/net.c @@ -271,7 +271,8 @@ __attribute__((visibility("hidden"))) void bl_binfmt_before(const char *path, ch __attribute__((visibility("hidden"))) int bl_binfmt_retry(const char *path, char *const argv[], char *const envp[], int error); __attribute__((visibility("hidden"))) void bl_binfmt_before_search(const char *file, char *const argv[], char *const envp[]); __attribute__((visibility("hidden"))) int bl_binfmt_after_search(const char *file, char *const argv[], char *const envp[], int error); -__attribute__((visibility("hidden"))) char *const *bl_webhelper_argv(const char *path, char *const argv[]); +__attribute__((visibility("hidden"))) +char *const *bl_webhelper_argv(const char *path, char *const argv[], char *const envp[]); __attribute__((visibility("hidden"))) int bl_binfmt_spawn(pid_t *pid, const char *path, const posix_spawn_file_actions_t *fa, const posix_spawnattr_t *attr, char *const argv[], char *const envp[], spawn_fn real); @@ -341,7 +342,7 @@ static char **web_helper_redirect(const char *path, char *const argv[], const ch } int execve(const char *path, char *const argv_in[], char *const envp[]) { - char *const *argv = bl_webhelper_argv(path, argv_in); + char *const *argv = bl_webhelper_argv(path, argv_in, envp); static int (*real)(const char *, char *const[], char *const[]); if (!real) real = (int (*)(const char *, char *const[], char *const[]))dlsym(RTLD_NEXT, "execve"); maybe_answer_lsof(path, argv); @@ -372,7 +373,7 @@ static int answer_lsof_via_spawn(const char *path, char *const argv[], pid_t *pi } int execvp(const char *file, char *const argv_in[]) { - char *const *argv = bl_webhelper_argv(file, argv_in); + char *const *argv = bl_webhelper_argv(file, argv_in, environ); static int (*real)(const char *, char *const[]); if (!real) real = (int (*)(const char *, char *const[]))dlsym(RTLD_NEXT, "execvp"); maybe_answer_lsof(file, argv); @@ -382,7 +383,7 @@ int execvp(const char *file, char *const argv_in[]) { } int execv(const char *path, char *const argv_in[]) { - char *const *argv = bl_webhelper_argv(path, argv_in); + char *const *argv = bl_webhelper_argv(path, argv_in, environ); static int (*real)(const char *, char *const[]); if (!real) real = (int (*)(const char *, char *const[]))dlsym(RTLD_NEXT, "execv"); maybe_answer_lsof(path, argv); @@ -406,5 +407,6 @@ int posix_spawn(pid_t *pid, const char *path, const posix_spawn_file_actions_t * } static spawn_fn real; if (!real) real = (spawn_fn)dlsym(RTLD_NEXT, "posix_spawn"); - return bl_binfmt_spawn(pid, path, fa, attr, argv, envp, real); + char *const *adjusted = bl_webhelper_argv(path, argv, envp); + return bl_binfmt_spawn(pid, path, fa, attr, (char *const *)adjusted, envp, real); } diff --git a/tools/linuxfs/preload/netif.c b/tools/linuxfs/preload/netif.c index d7f56e32ab..aeeeb9eb24 100644 --- a/tools/linuxfs/preload/netif.c +++ b/tools/linuxfs/preload/netif.c @@ -29,6 +29,7 @@ #include #include #include +#include #include #include #include @@ -1655,6 +1656,7 @@ static void reply_attr(struct nl_reply *out, unsigned char *message, int type, return; } attr = (struct rtattr *) (message + offset); + memset(attr, 0, total); attr->rta_type = (unsigned short) type; attr->rta_len = (unsigned short) RTA_LENGTH(len); if (len > 0) memcpy(RTA_DATA(attr), data, len); @@ -2155,3 +2157,29 @@ ssize_t send(int fd, const void *buffer, size_t length, int flags) { } return real(fd, buffer, length, flags); } + +ssize_t write(int fd, const void *buffer, size_t length) { + static ssize_t (*real)(int, const void *, size_t); + ssize_t rc; + if (bl_nl_owns(fd) && deliver(fd, buffer, length, 0, &rc)) return rc; + if (real == NULL) real = (ssize_t (*)(int, const void *, size_t)) dlsym(RTLD_NEXT, "write"); + if (real == NULL) { + errno = ENOSYS; + return -1; + } + return real(fd, buffer, length); +} + +ssize_t writev(int fd, const struct iovec *iov, int iovcnt) { + static ssize_t (*real)(int, const struct iovec *, int); + if (iovcnt >= 0 && bl_nl_owns(fd)) { + struct msghdr msg = { .msg_iov = (struct iovec *) iov, .msg_iovlen = (size_t) iovcnt }; + return sendmsg_request(fd, &msg, 0); + } + if (real == NULL) real = (ssize_t (*)(int, const struct iovec *, int)) dlsym(RTLD_NEXT, "writev"); + if (real == NULL) { + errno = ENOSYS; + return -1; + } + return real(fd, iov, iovcnt); +} diff --git a/tools/linuxfs/preload/tracer.c b/tools/linuxfs/preload/tracer.c index 572cf13e09..7f5ac8e8cd 100644 --- a/tools/linuxfs/preload/tracer.c +++ b/tools/linuxfs/preload/tracer.c @@ -81,7 +81,10 @@ __attribute__((visibility("hidden"))) int bl_status_without_tracer(const char *p long pid; if ((flags & O_ACCMODE) != O_RDONLY || (pid = status_pid(path)) < 0 || is_web_helper(caller) || bl_from_ntdll(caller)) return -1; - int in = (int)syscall(SYS_openat, AT_FDCWD, path, O_RDONLY | O_CLOEXEC); + // through the next open(): the native userland's hook gives the app's ids as root's there + static int (*next_open)(const char *, int, ...) = NULL; + if (!next_open) next_open = (int (*)(const char *, int, ...))dlsym(RTLD_NEXT, "open"); + int in = next_open ? next_open(path, O_RDONLY | O_CLOEXEC) : (int)syscall(SYS_openat, AT_FDCWD, path, O_RDONLY | O_CLOEXEC); if (in < 0) goto done; for (;;) { ssize_t n = read(in, text + len, sizeof(text) - 1 - len); diff --git a/tools/linuxfs/preload/webhelper.c b/tools/linuxfs/preload/webhelper.c index 9494872797..7642a34632 100644 --- a/tools/linuxfs/preload/webhelper.c +++ b/tools/linuxfs/preload/webhelper.c @@ -26,6 +26,14 @@ static char *join_features(const char *have, const char *add) { return strcat(out, add); } +static int electron_node_mode(char *const envp[]) { + static const char variable[] = "ELECTRON_RUN_AS_NODE="; + for (int i = 0; envp && envp[i]; i++) + if (!strncmp(envp[i], variable, sizeof variable - 1)) + return envp[i][sizeof variable - 1] != 0; + return 0; +} + static char *const *chromium_argv(const char *path, char *const argv[]) { const char *slash = path ? strrchr(path, '/') : NULL; if (!slash || !argv || !argv[0]) return argv; @@ -48,7 +56,9 @@ static char *const *chromium_argv(const char *path, char *const argv[]) { return out; } -__attribute__((visibility("hidden"))) char *const *bl_webhelper_argv(const char *path, char *const argv[]) { +__attribute__((visibility("hidden"))) +char *const *bl_webhelper_argv(const char *path, char *const argv[], char *const envp[]) { + if (electron_node_mode(envp)) return argv; if (!is_webhelper_browser(path, argv)) return chromium_argv(path, argv); const char *spec = getenv("BL_WEBHELPER_ARGS"); if (!spec || !*spec) spec = WEBHELPER_DEFAULT; diff --git a/tools/nativeguest/LICENSE b/tools/nativeguest/LICENSE new file mode 100644 index 0000000000..d645695673 --- /dev/null +++ b/tools/nativeguest/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/tools/nativeguest/README.md b/tools/nativeguest/README.md new file mode 100644 index 0000000000..19571de96c --- /dev/null +++ b/tools/nativeguest/README.md @@ -0,0 +1,34 @@ +# Native userland (no proot) + +`libddnatv-hook.so` is an `LD_PRELOAD` library that lets the glibc rootfs run directly on Android: +it maps the guest's absolute paths into the rootfs (plus the mounts proot used to provide, from +`DDNATV_BINDS`), starts every program through the rootfs's `ld.so`, and answers the system calls +Android's seccomp policy kills a process for (`SIGSYS` handler). There is no tracer. The app side +is `runtime/NativeGuest.kt`; the setting is Performance > "Run without proot (experimental)". + +The hook is derived from the Apache-2.0 `libcortex-hook` of +[ssfuisu/cortex](https://github.com/ssfuisu/cortex) (see `LICENSE`), renamed (`cortex` -> `ddnatv`, +same length: the code compares environment names by length) and extended with: + +- `DDNATV_BINDS` mounts, `DDNATV_PRELOAD` (what `/etc/ld.so.preload` does for proot), and mapping of + guest paths inside `LD_PRELOAD`; +- POSIX `shm_open`/`shm_unlink` through `/dev/shm`; +- starting Wine without its static preloader, which opens files with raw system calls. + +Build: `tools/nativeguest/build.sh out.so` with an aarch64 glibc cross compiler. + +## Testing under Android's seccomp filter + +Some devices (eng builds, `setenforce 0` ROMs) run apps with no seccomp filter, so a hook that +passes there can still die with SIGSYS on a stock phone (`GUEST_EXIT 159`). `seccomp-sim.c` applies +a filter that answers the calls Android blocks with SIGSYS, then runs the program: + +``` +aarch64-linux-gnu-gcc -static -O2 -o seccomp-sim tools/nativeguest/seccomp-sim.c +# copy it into the rootfs, then name it for every native launch: +echo /usr/local/bin/seccomp-sim > /etc/droiddeck/seccomp-sim +``` + +`grep Seccomp: /proc//status` should then show `2` for the session's processes. Empty the file +to turn it off. `seccomp-sim -a NR,NR PROGRAM` leaves the listed calls allowed, to find which one +kills a program. diff --git a/tools/nativeguest/app-seccomp-dump.c b/tools/nativeguest/app-seccomp-dump.c new file mode 100644 index 0000000000..1ec09ea256 --- /dev/null +++ b/tools/nativeguest/app-seccomp-dump.c @@ -0,0 +1,50 @@ +// Writes the seccomp filter Android's zygote gives an app (from the device's libandroid_runtime.so) +// to a file, as the raw sock_filter array, for seccomp-sim -f on devices whose zygote skips it +// (a permissive SELinux). A bionic program, built with the NDK and run from adb shell: +// aarch64-linux-android33-clang -O2 -rdynamic -o app-seccomp-dump app-seccomp-dump.c -ldl +// app-seccomp-dump OUT +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +static const char *g_out; +static int g_dumped; + +// the runtime's own prctl() call lands here first +__attribute__((visibility("default"))) int prctl(int option, ...) { + va_list ap; + va_start(ap, option); + unsigned long a2 = va_arg(ap, unsigned long), a3 = va_arg(ap, unsigned long); + unsigned long a4 = va_arg(ap, unsigned long), a5 = va_arg(ap, unsigned long); + va_end(ap); + if (option == PR_SET_SECCOMP && a2 == SECCOMP_MODE_FILTER && g_out) { + const struct sock_fprog *prog = (const struct sock_fprog *)a3; + FILE *f = fopen(g_out, "wb"); + if (f) { + fwrite(prog->filter, sizeof(prog->filter[0]), prog->len, f); + fclose(f); + fprintf(stderr, "app-seccomp-dump: %u instructions to %s\n", prog->len, g_out); + g_dumped = 1; + } + return 0; // not installed in this process + } + return (int)syscall(SYS_prctl, option, a2, a3, a4, a5); +} + +int main(int argc, char **argv) { + if (argc != 2) { fprintf(stderr, "usage: %s OUT\n", argv[0]); return 2; } + g_out = argv[1]; + void *rt = dlopen("libandroid_runtime.so", RTLD_NOW); + if (!rt) { fprintf(stderr, "%s\n", dlerror()); return 2; } + int (*set_app_filter)(void) = (int (*)(void))dlsym(rt, "_Z22set_app_seccomp_filterv"); + if (!set_app_filter) { fprintf(stderr, "no set_app_seccomp_filter\n"); return 2; } + set_app_filter(); + return g_dumped ? 0 : 1; +} diff --git a/tools/nativeguest/build-gosys.sh b/tools/nativeguest/build-gosys.sh new file mode 100755 index 0000000000..ce05326c1e --- /dev/null +++ b/tools/nativeguest/build-gosys.sh @@ -0,0 +1,82 @@ +#!/usr/bin/env bash +# Builds the code the native userland adds to static Go programs (gosys/gosys.c) into the C header +# the hook includes (gosys/gosys_blob.h, not kept in the repository; build.sh makes it each time). +# +# The code is AArch64 whatever the machine this runs on: it is compiled freestanding with an +# aarch64 cross compiler (gcc-aarch64-linux-gnu: the one that builds the hook; or clang with lld). +# +# usage: tools/nativeguest/build-gosys.sh [output header] +set -euo pipefail + +here=$(cd "$(dirname "$0")" && pwd) +src=$here/gosys +out=${1:-$src/gosys_blob.h} + +if command -v aarch64-linux-gnu-gcc >/dev/null 2>&1; then + CC=(aarch64-linux-gnu-gcc) + LD=(aarch64-linux-gnu-ld) + OBJCOPY=(aarch64-linux-gnu-objcopy) + NM=(aarch64-linux-gnu-nm) + OBJDUMP=(aarch64-linux-gnu-objdump) +elif command -v clang >/dev/null 2>&1 && command -v ld.lld >/dev/null 2>&1; then + CC=(clang --target=aarch64-linux-gnu) + LD=(ld.lld) + OBJCOPY=(llvm-objcopy) + NM=(llvm-nm) + OBJDUMP=(llvm-objdump) +else + echo "build-gosys.sh: needs aarch64-linux-gnu-gcc (apt install gcc-aarch64-linux-gnu) or clang with lld" >&2 + exit 1 +fi + +tmp=$(mktemp -d) +trap 'rm -rf "$tmp"' EXIT + +"${CC[@]}" -std=gnu11 -O2 -Wall -Wextra -Werror \ + -ffreestanding -fno-builtin -nostdlib -fPIE -fvisibility=hidden -fno-stack-protector \ + -fno-asynchronous-unwind-tables -fno-unwind-tables -fno-tree-loop-distribute-patterns \ + -mcmodel=tiny -mgeneral-regs-only -mno-outline-atomics -ffixed-x18 -ffixed-x28 \ + -c "$src/gosys.c" -o "$tmp/gosys.o" +"${LD[@]}" -T "$src/gosys.ld" -nostdlib -o "$tmp/gosys.elf" "$tmp/gosys.o" +"${OBJCOPY[@]}" -O binary "$tmp/gosys.elf" "$tmp/gosys.bin" + +# It must stand on its own: nothing undefined, no writable data, and nothing that depends on the +# address it is loaded at (adrp assumes the page offset of the link address; adr does not) +if [ -n "$("${NM[@]}" -u "$tmp/gosys.elf")" ]; then + echo "build-gosys.sh: gosys.c needs symbols it does not define:" >&2 + "${NM[@]}" -u "$tmp/gosys.elf" >&2 + exit 1 +fi +if "${OBJDUMP[@]}" -d "$tmp/gosys.elf" | grep -q -w adrp; then + echo "build-gosys.sh: gosys.c uses adrp, which is not position-independent at any address" >&2 + exit 1 +fi +sections=$("${OBJDUMP[@]}" -h "$tmp/gosys.elf" | awk '$1 ~ /^[0-9]+$/ {print $2}' | tr '\n' ' ') +for s in $sections; do + case $s in + .hdr|.thunks|.text|.rodata|.trailer|.symtab|.strtab|.shstrtab) ;; + *) echo "build-gosys.sh: unexpected section $s in gosys.elf (sections: $sections)" >&2; exit 1 ;; + esac +done + +size=$(stat -c %s "$tmp/gosys.bin") +entry=$("${NM[@]}" "$tmp/gosys.elf" | awk '$3 == "cxgo_entry" {print $1}') +thunks=$("${NM[@]}" "$tmp/gosys.elf" | awk '$3 == "g_thunks" {print $1}') +if [ -z "$entry" ] || [ -z "$thunks" ]; then + echo "build-gosys.sh: cxgo_entry or g_thunks not found" >&2 + exit 1 +fi +[ "$(head -c 8 "$tmp/gosys.bin")" = "CXGOSYS1" ] || { echo "build-gosys.sh: the header is not first" >&2; exit 1; } +[ "$(tail -c 64 "$tmp/gosys.bin" | head -c 8)" = "CXGOEND1" ] || { echo "build-gosys.sh: the trailer is not last" >&2; exit 1; } + +{ + echo "// Generated by tools/nativeguest/build-gosys.sh from gosys/gosys.c. Do not edit." + echo "#define GOSYS_BLOB_SIZE $size" + echo "#define GOSYS_ENTRY_OFF 0x$entry" + echo "#define GOSYS_THUNKS_OFF 0x$thunks" + echo "static const unsigned char gosys_blob[GOSYS_BLOB_SIZE] = {" + od -An -v -tx1 "$tmp/gosys.bin" | sed -e 's/^ *//' -e 's/ /, 0x/g' -e 's/^/0x/' -e 's/$/,/' + echo "};" +} > "$out.tmp" +mv "$out.tmp" "$out" +echo "build-gosys.sh: $out ($size bytes, entry 0x$entry)" diff --git a/tools/nativeguest/build.sh b/tools/nativeguest/build.sh new file mode 100755 index 0000000000..46002f248c --- /dev/null +++ b/tools/nativeguest/build.sh @@ -0,0 +1,15 @@ +#!/usr/bin/env bash +# Builds libddnatv-hook.so, the library that lets the glibc rootfs run on Android without proot. +# usage: tools/nativeguest/build.sh [compiler, default aarch64-linux-gnu-gcc] +set -euo pipefail +here=$(cd "$(dirname "$0")" && pwd) +out=${1:?output path} +cc=${2:-aarch64-linux-gnu-gcc} +gen=$(mktemp -d) +trap 'rm -rf "$gen"' EXIT +mkdir -p "$gen/gosys" +bash "$here/build-gosys.sh" "$gen/gosys/gosys_blob.h" +"$cc" -std=gnu11 -shared -fPIC -O2 -fno-delete-null-pointer-checks -Wall -Wno-nonnull-compare \ + -Wno-format-truncation -Wno-stringop-truncation -Wl,-z,max-page-size=16384 -I "$gen" \ + -o "$out" "$here/ddnatv-hook.c" -ldl +"${cc%gcc}strip" --strip-unneeded "$out" diff --git a/tools/nativeguest/ddnatv-hook.c b/tools/nativeguest/ddnatv-hook.c new file mode 100644 index 0000000000..954991c261 --- /dev/null +++ b/tools/nativeguest/ddnatv-hook.c @@ -0,0 +1,87 @@ +#define _GNU_SOURCE +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#ifndef RENAME_EXCHANGE +#define RENAME_EXCHANGE (1 << 1) +#endif + +// The code that is added to static Go programs (gosys/gosys.c), built by scripts/build-gosys.sh. A +// build without it works as before, only without Go support. It is AArch64 code: the 32-bit hook +// has none (a 32-bit phone cannot run 64-bit programs). +#if defined(__has_include) && defined(__LP64__) +#if __has_include("gosys/gosys_blob.h") +#include "gosys/gosys_abi.h" +#include "gosys/gosys_blob.h" +#define DDNATV_HAVE_GOSYS 1 +#endif +#endif + +// The hook is one translation unit split into parts by topic, in this order (later parts use +// the static functions of earlier ones). +#include "hook/syscalls.c" +#include "hook/paths.c" +#include "hook/hardlinks.c" +#include "hook/signals.c" +#include "hook/setup.c" +#include "hook/files.c" +#include "hook/fileops.c" +#include "hook/identity.c" +#include "hook/privileged.c" +#include "hook/env.c" +#include "hook/exec_probe.c" +#include "hook/static_programs.c" +#include "hook/go_programs.c" +#include "hook/exec.c" +#include "hook/net.c" +#include "hook/sockets.c" +#include "hook/sysv_shm.c" +#include "hook/posix_shm.c" diff --git a/tools/nativeguest/gosys/gosys.c b/tools/nativeguest/gosys/gosys.c new file mode 100644 index 0000000000..fb8230ce4a --- /dev/null +++ b/tools/nativeguest/gosys/gosys.c @@ -0,0 +1,510 @@ +// The code The native userland adds to a static Go program so that it sees the rootfs (see gosys_abi.h). +// +// Built freestanding (scripts/build-gosys.sh) as a flat, position-independent binary with no +// writable data, no libc and no relocations: the hook copies it into the program's file. It is +// entered from the one place where Go's system calls are made, in place of the "svc #0" of +// internal/runtime/syscall.Syscall6, with the registers of that call: arguments in x0 to x5, +// the number in x8 (passed again as the eighth argument). It returns what the kernel would, and it +// may use every register but x28 (the current goroutine), x29, x30 and sp, which it keeps. +// +// It does for Go what libddnatv-hook.so does for C programs: maps absolute Ubuntu paths into the +// rootfs (the same rules as hook/paths.c), shortens the Unix socket paths that do not fit, shows +// the program the paths it expects from getcwd and /proc/self/exe, and starts Ubuntu programs +// through the rootfs's dynamic linker and env, which then go through the hook. + +#include "gosys_abi.h" + +typedef int64_t i64; +typedef uint64_t u64; +typedef uint32_t u32; +typedef uint16_t u16; + +#define AT_FDCWD (-100) +#define SLOT_PATH_A 0u +#define SLOT_PATH_B 4096u +#define SLOT_ARGV 8192u +#define SLOT_ENV 16384u +#define SLOT_PATH_CAP 4096u +#define ARGV_CAP 1000u // entries of the argv array that starts a program +#define ENV_CAP 2000u + +// The numbers of AArch64 Linux (the same for every kernel) +enum { + NR_SETXATTR = 5, NR_LSETXATTR = 6, NR_GETXATTR = 8, NR_LGETXATTR = 9, NR_LISTXATTR = 11, + NR_LLISTXATTR = 12, NR_REMOVEXATTR = 14, NR_LREMOVEXATTR = 15, NR_GETCWD = 17, + NR_INOTIFY_ADD_WATCH = 27, NR_MKNODAT = 33, NR_MKDIRAT = 34, NR_UNLINKAT = 35, NR_SYMLINKAT = 36, + NR_LINKAT = 37, NR_RENAMEAT = 38, NR_STATFS = 43, NR_TRUNCATE = 45, NR_FACCESSAT = 48, + NR_CHDIR = 49, NR_CHROOT = 51, NR_FCHMODAT = 53, NR_FCHOWNAT = 54, NR_OPENAT = 56, + NR_READLINKAT = 78, NR_NEWFSTATAT = 79, NR_UTIMENSAT = 88, NR_BIND = 200, NR_CONNECT = 203, + NR_EXECVE = 221, NR_NAME_TO_HANDLE_AT = 264, NR_RENAMEAT2 = 276, NR_STATX = 291, + NR_OPENAT2 = 437, NR_FACCESSAT2 = 439, NR_FCHMODAT2 = 452, +}; + +__attribute__((section(".hdr"), used)) +static const volatile struct gosys_hdr g_hdr = { .magic = "CXGOSYS1", .version = GOSYS_VERSION }; + +// Filled by the patcher; the instructions that connect the call site to cxgo_entry +__attribute__((section(".thunks"), used)) +static const volatile u32 g_thunks[GOSYS_THUNK_BYTES / 4]; + +__attribute__((section(".trailer"), used)) +static const volatile struct gosys_trailer g_trailer = { .magic = "CXGOEND1", .version = GOSYS_VERSION }; + +static inline const struct gosys_hdr *hdr(void) { + const struct gosys_hdr *h = (const struct gosys_hdr *)&g_hdr; + __asm__("" : "+r"(h)); // the compiler must not assume it knows the contents + return h; +} + +static inline i64 sc(i64 nr, i64 a0, i64 a1, i64 a2, i64 a3, i64 a4, i64 a5) { + register i64 x8 __asm__("x8") = nr; + register i64 x0 __asm__("x0") = a0; + register i64 x1 __asm__("x1") = a1; + register i64 x2 __asm__("x2") = a2; + register i64 x3 __asm__("x3") = a3; + register i64 x4 __asm__("x4") = a4; + register i64 x5 __asm__("x5") = a5; + __asm__ volatile("svc #0" : "+r"(x0) : "r"(x8), "r"(x1), "r"(x2), "r"(x3), "r"(x4), "r"(x5) : "memory", "cc"); + return x0; +} + +static u64 slen(const char *s) { + u64 n = 0; + while (s[n]) n++; + return n; +} + +static void mcopy(char *d, const char *s, u64 n) { + for (u64 i = 0; i < n; i++) d[i] = s[i]; +} + +// Moves n bytes down (d < s) +static void mmove_down(char *d, const char *s, u64 n) { + for (u64 i = 0; i < n; i++) d[i] = s[i]; +} + +static int pre(const char *path, const char *lit, u64 n) { + for (u64 i = 0; i < n; i++) + if (path[i] != lit[i]) return 0; + return path[n] == '/' || path[n] == '\0'; +} + +// Whether path is the rootfs or in it +static int in_root(const struct gosys_hdr *h, const char *p) { + u64 n = h->root_len; + if (n == 0) return 0; + for (u64 i = 0; i < n; i++) + if (p[i] != h->root[i]) return 0; + return p[n] == '/' || p[n] == '\0'; +} + +// Android's own mounts and files, which must never be redirected into the rootfs (hook/paths.c) +static int is_host_path(const char *path) { + switch (path[1]) { + case 'a': return pre(path, "/apex", 5); + case 'c': return pre(path, "/config", 7); + case 'd': return pre(path, "/dev", 4) || pre(path, "/d", 2) || pre(path, "/data", 5); + case 'l': return pre(path, "/linkerconfig", 13); + case 'o': return pre(path, "/odm", 4) || pre(path, "/oem", 4); + case 'p': return pre(path, "/proc", 5) || pre(path, "/product", 8); + case 's': return pre(path, "/sbin/su", 8) || pre(path, "/su", 3) || pre(path, "/sys", 4) || + pre(path, "/system", 7) || pre(path, "/system_ext", 11) || + pre(path, "/sdcard", 7) || pre(path, "/storage", 8); + case 'v': return pre(path, "/vendor", 7); + default: return 0; + } +} + +// An absolute Ubuntu path mapped into the rootfs: `path` itself when it needs no change, else buf +// (hook/paths.c rewrite_path_in_root). A result that would not fit is the path unchanged: the +// kernel then answers as it would for a path that long. +static const char *rw_path(const struct gosys_hdr *h, const char *path, char *buf, u64 cap) { + if (path[0] != '/' || h->root_len == 0) return path; + while (path[0] == '/' && path[1] == '/') path++; + while (path[0] == '/' && path[1] == '.' && (path[2] == '/' || path[2] == '\0')) { + if (path[2] == '/') { + path += 2; + } else { + path = "/"; + break; + } + } + u64 rl = h->root_len; + if (path[1] == '\0') { + mcopy(buf, h->root, rl); + buf[rl] = '\0'; + return buf; + } + if (in_root(h, path)) return path; + if (pre(path, "/dev/shm", 8)) { + u64 rest = slen(path + 8); + if (rl + 8 + rest + 1 > cap) return path; + mcopy(buf, h->root, rl); + mcopy(buf + rl, "/tmp/shm", 8); + mcopy(buf + rl + 8, path + 8, rest + 1); + return buf; + } + if (is_host_path(path)) return path; + u64 pl = slen(path); + if (rl + pl + 1 > cap) return path; + mcopy(buf, h->root, rl); + mcopy(buf + rl, path, pl + 1); + return buf; +} + +// Whether the rootfs is where the code was told it is. In root mode the program runs in a chroot of +// that very rootfs, where the real paths are the Ubuntu ones and the rootfs's own path does not +// exist: then nothing is mapped and the program works as any other. Looked at once for each process +// (the scratch memory starts as zero, and a forked child keeps what its parent found). +static int rewriting(const struct gosys_hdr *h) { + volatile u32 *mode = (volatile u32 *)((char *)h + h->scratch_rel + 4); + u32 m = *mode; + if (m == 0) { + m = sc(NR_FACCESSAT, AT_FDCWD, (i64)h->root, 0, 0, 0, 0) == 0 ? 1u : 2u; + *mode = m; + } + return m == 1; +} + +#define NO_SLOT 0xffffffffu +#define NR_SCHED_YIELD 124 + +// Who is making the call: the goroutine (x28 holds it, and the code is built not to touch x28). A +// goroutine makes one call at a time, and the vfork child that a goroutine makes runs with the same +// x28 as the goroutine does. (TPIDR_EL0 does not tell the threads of a Go program apart: its runtime +// leaves it unset without cgo.) +static inline u64 thread_tag(void) { + u64 t; + __asm__ volatile("mov %0, x28" : "=r"(t)); + return t; +} + +// How many execve calls have not returned (state area, offset 8). One that works never does: it is +// made by a vfork child, and the slot its path was in stays marked as the goroutine's, which goes on +// when the child is gone (the same x28, a call of its own). Without this, goroutines that each +// started a program held a slot each for good, and after the sixty-fourth all the others waited. +static inline u32 *execs_on_their_way(const struct gosys_hdr *h) { + return (u32 *)((char *)h + h->scratch_rel + 8); +} + +static void count_down(u32 *count) { + u32 n = __atomic_load_n(count, __ATOMIC_RELAXED); + while (n != 0 && !__atomic_compare_exchange_n(count, &n, n - 1, 0, __ATOMIC_RELAXED, __ATOMIC_RELAXED)) { + } +} + +// Gives back what this goroutine's vfork child left (see above). Every call looks at one counter +// for it; the list of slots is only looked through while an execve is on its way. +static void reclaim_left_slots(const struct gosys_hdr *h) { + u32 *count = execs_on_their_way(h); + if (__atomic_load_n(count, __ATOMIC_RELAXED) == 0) return; + u64 *owner = (u64 *)((char *)h + h->scratch_rel + 64); + u64 me = thread_tag() | 1; + for (u32 i = 0; i < GOSYS_SLOTS; i++) { + if (__atomic_load_n(&owner[i], __ATOMIC_RELAXED) != me) continue; + __atomic_store_n(&owner[i], 0, __ATOMIC_RELEASE); + count_down(count); + } +} + +// A slot for the call this goroutine is making; *held is its number, to give back when the call is +// done. Each slot has a word of its own that holds who has it (0: nobody), so that taking one is one +// compare-and-swap, and no other goroutine can ever mistake it for its own. +static char *take_slot(const struct gosys_hdr *h, u32 *held) { + char *base = (char *)h + h->scratch_rel; + u64 *owner = (u64 *)(base + 64); + u64 me = thread_tag() | 1; // never 0 + u32 mine = NO_SLOT; + // A slot of this goroutine that is still taken now (cxgo_entry gives back those of its vfork + // children) is its own again + for (u32 i = 0; i < GOSYS_SLOTS; i++) { + if (__atomic_load_n(&owner[i], __ATOMIC_RELAXED) != me) continue; + if (mine == NO_SLOT) + mine = i; + else + __atomic_store_n(&owner[i], 0, __ATOMIC_RELEASE); + } + while (mine == NO_SLOT) { + for (u32 i = 0; i < GOSYS_SLOTS && mine == NO_SLOT; i++) { + u64 none = 0; + if (__atomic_load_n(&owner[i], __ATOMIC_RELAXED) == 0 && + __atomic_compare_exchange_n(&owner[i], &none, me, 0, __ATOMIC_ACQUIRE, __ATOMIC_RELAXED)) + mine = i; + } + if (mine == NO_SLOT) sc(NR_SCHED_YIELD, 0, 0, 0, 0, 0, 0); // all taken: the others finish soon + } + *held = mine; + return base + GOSYS_STATE_SIZE + (u64)mine * GOSYS_SLOT_SIZE; +} + +static void put_slot(const struct gosys_hdr *h, u32 held) { + if (held == NO_SLOT) return; + char *base = (char *)h + h->scratch_rel; + __atomic_store_n((u64 *)(base + 64) + held, 0, __ATOMIC_RELEASE); +} + +// A path as the program expects to see it, from one of the kernel's: the rootfs prefix removed. +// Returns the new length of the n bytes at buf (a path, not NUL-terminated unless `nul`). +static i64 unmap_prefix(const struct gosys_hdr *h, char *buf, i64 n, int nul) { + u64 rl = h->root_len; + if (rl == 0 || n <= 0 || (u64)n < rl + (nul ? 1 : 0)) return n; + for (u64 i = 0; i < rl; i++) + if (buf[i] != h->root[i]) return n; + u64 end = (u64)n - (nul ? 1 : 0); // the path's own length + if (end == rl) { // exactly the rootfs + buf[0] = '/'; + if (nul) { + buf[1] = '\0'; + return 2; + } + return 1; + } + if (buf[rl] != '/') return n; + mmove_down(buf, buf + rl, (u64)n - rl); + return n - (i64)rl; +} + +// ---- Unix sockets ------------------------------------------------------------------------ + +static void put_hex16(char *out, u64 v) { + static const char digits[] = "0123456789abcdef"; + for (int i = 15; i >= 0; i--) { + out[i] = digits[v & 15]; + v >>= 4; + } +} + +// bind() and connect() of a Unix socket with a path: mapped like hook/setup.c does, and hashed +// into /tmp when it does not fit the 108 bytes of sun_path (the same name, so a Go server and a +// program using the C library find each other) +static i64 with_sockaddr(const struct gosys_hdr *h, u32 *held, i64 nr, i64 a0, i64 a1, i64 a2) { + const unsigned char *sa = (const unsigned char *)a1; + if (!sa || a2 < 4 || a2 > 128 || sa[0] != 1 /* AF_UNIX */ || sa[1] != 0 || sa[2] != '/') + return sc(nr, a0, a1, a2, 0, 0, 0); + char *slot = take_slot(h, held); + char *orig = slot + SLOT_PATH_A; + u64 max = (u64)a2 - 2; + if (max > 108) max = 108; + mcopy(orig, (const char *)sa + 2, max); + orig[max] = '\0'; + const char *rw = rw_path(h, orig, slot + SLOT_PATH_B, SLOT_PATH_CAP); + u64 rl = slen(rw); + char *out = slot + SLOT_ARGV; + out[0] = 1; + out[1] = 0; + if (rl < 108) { + mcopy(out + 2, rw, rl + 1); + return sc(nr, a0, (i64)out, (i64)(2 + rl + 1), 0, 0, 0); + } + u64 hash = 14695981039346656037ULL; + for (const char *p = rw; *p; p++) { + hash ^= (unsigned char)*p; + hash *= 1099511628211ULL; + } + u64 n = h->root_len; + if (n + 5 + 11 + 16 + 1 > 108) return sc(nr, a0, a1, a2, 0, 0, 0); + mcopy(out + 2, h->root, n); + mcopy(out + 2 + n, "/tmp/.ctx_sock_", 15); + put_hex16(out + 2 + n + 15, hash); + out[2 + n + 15 + 16] = '\0'; + return sc(nr, a0, (i64)out, (i64)(2 + n + 15 + 16 + 1), 0, 0, 0); +} + +// ---- Starting programs ------------------------------------------------------------------- + +static int starts_with(const char *s, const char *lit) { + for (u64 i = 0; lit[i]; i++) + if (s[i] != lit[i]) return 0; + return 1; +} + +// A program of Android's gets the environment it expects, as from hook/env.c clean_env_for_system(): +// without the hook and the rootfs's libraries, and with Android's directories in its PATH +static i64 exec_host(const struct gosys_hdr *h, char *slot, const char *p, i64 a1, char *const *envp) { + (void)h; + static const char android_path[] = "PATH=/system/bin:/system/xbin:/sbin:/vendor/bin"; + u32 envc = 0; + while (envp && envp[envc]) envc++; + if (envc + 2 > ENV_CAP) return sc(NR_EXECVE, (i64)p, a1, (i64)envp, 0, 0, 0); + char **ne = (char **)(slot + SLOT_ENV); + char *path_str = slot + SLOT_PATH_B; + u32 n = 0; + int has_path = 0; + for (u32 i = 0; i < envc; i++) { + char *e = envp[i]; + if (starts_with(e, "LD_PRELOAD=") || starts_with(e, "LD_LIBRARY_PATH=") || starts_with(e, "GLIBC_TUNABLES=")) + continue; + if (starts_with(e, "PATH=")) { + u64 len = slen(e); + has_path = 1; + if (len + sizeof(android_path) + 1 < SLOT_PATH_CAP) { + mcopy(path_str, android_path, sizeof(android_path) - 1); + path_str[sizeof(android_path) - 1] = ':'; + mcopy(path_str + sizeof(android_path), e + 5, len - 5 + 1); + ne[n++] = path_str; + continue; + } + } + ne[n++] = e; + } + if (!has_path) ne[n++] = (char *)android_path; + ne[n] = 0; + return sc(NR_EXECVE, (i64)p, a1, (i64)ne, 0, 0, 0); +} + +// execve(): a program of the rootfs is started as +// --preload --library-path -c 'exec -a "$0" "$@"' ... +// so that bash, a program of the rootfs with the hook loaded, starts it the way every program of +// The native userland is started (Ubuntu's dynamic programs through ld.so, scripts through their interpreter, +// static programs patched first), with the argv[0] the caller chose. Without bash it is env, +// which cannot set argv[0]. The path is passed as the caller wrote it. +static i64 with_execve(const struct gosys_hdr *h, u32 *held, i64 a0, i64 a1, i64 a2) { + const char *path = (const char *)a0; + char *const *argv = (char *const *)a1; + char *const *envp = (char *const *)a2; + if (!path || path[0] == '\0') return sc(NR_EXECVE, a0, a1, a2, 0, 0, 0); + + char *slot = take_slot(h, held); + const char *p = path[0] == '/' ? rw_path(h, path, slot + SLOT_PATH_A, SLOT_PATH_CAP) : path; + int wrap = h->ldso_len != 0 && h->runner_len != 0 && (path[0] != '/' || in_root(h, p)); + if (!wrap) { + if (path[0] == '/' && !in_root(h, p)) return exec_host(h, slot, p, a1, envp); + return sc(NR_EXECVE, (i64)p, a1, a2, 0, 0, 0); + } + + // A program that is not there is reported to the caller, as execve() does + i64 r = sc(NR_FACCESSAT, AT_FDCWD, (i64)p, 0, 0, 0, 0); + if (r < 0) return r; + + u32 argc = 0; + while (argv && argv[argc]) argc++; + if (argc + 12 > ARGV_CAP) return sc(NR_EXECVE, (i64)p, a1, a2, 0, 0, 0); + + // DDNATV_ROOT must reach env even when the caller built an environment of its own + char *const *env = envp; + u32 envc = 0; + int has_root = 0; + while (envp && envp[envc]) { + const char *e = envp[envc]; + if (e[0] == 'D' && e[1] == 'D' && e[2] == 'N' && e[3] == 'A' && e[4] == 'T' && e[5] == 'V' && + e[6] == '_' && e[7] == 'R' && e[8] == 'O' && e[9] == 'O' && e[10] == 'T' && e[11] == '=') + has_root = 1; + envc++; + } + if (!has_root) { + if (envc + 2 > ENV_CAP) return sc(NR_EXECVE, (i64)p, a1, a2, 0, 0, 0); + char **ne = (char **)(slot + SLOT_ENV); + char *kv = slot + SLOT_PATH_B; + mcopy(kv, "DDNATV_ROOT=", 12); + mcopy(kv + 12, h->root, h->root_len + 1); + for (u32 i = 0; i < envc; i++) ne[i] = envp[i]; + ne[envc] = kv; + ne[envc + 1] = 0; + env = ne; + } + + char **v = (char **)(slot + SLOT_ARGV); + u32 n = 0; + v[n++] = (char *)h->ldso; + if (h->hook_len) { + v[n++] = (char *)"--preload"; + v[n++] = (char *)h->hook; + } + v[n++] = (char *)"--library-path"; + v[n++] = (char *)h->libs; + v[n++] = (char *)h->runner; + if (h->flags & GOSYS_FLAG_RUNNER_IS_BASH) { + v[n++] = (char *)"-c"; + v[n++] = (char *)"exec -a \"$0\" \"$@\""; + v[n++] = (argc > 0 && argv[0]) ? argv[0] : (char *)path; + } else { + v[n++] = (char *)"--"; + } + v[n++] = (char *)path; + for (u32 i = 1; i < argc; i++) v[n++] = argv[i]; + v[n] = 0; + return sc(NR_EXECVE, (i64)h->ldso, (i64)v, (i64)env, 0, 0, 0); +} + +// ---- The entry --------------------------------------------------------------------------- + +// Rewrites the path arguments `i1` and `i2` (an index into a[], -1: none) that are absolute, makes +// the call, and shows the program the paths it expects in what the call returns. +static i64 with_paths(const struct gosys_hdr *h, u32 *held, i64 nr, i64 *a, int i1, int i2) { + char *slot = 0; + int proc_link = 0; + int idx[2] = { i1, i2 }; + for (int k = 0; k < 2; k++) { + int i = idx[k]; + if (i < 0) continue; + const char *p = (const char *)a[i]; + if (!p || p[0] != '/') continue; + if (!slot) slot = take_slot(h, held); + if (nr == NR_READLINKAT && k == 0 && pre(p, "/proc", 5)) proc_link = 1; + a[i] = (i64)rw_path(h, p, slot + (k ? SLOT_PATH_B : SLOT_PATH_A), SLOT_PATH_CAP); + } + i64 r = sc(nr, a[0], a[1], a[2], a[3], a[4], a[5]); + if (proc_link && r > 0) r = unmap_prefix(h, (char *)a[2], r, 0); + return r; +} + +// The call itself; a slot that it takes is given back by cxgo_entry +static i64 handle(const struct gosys_hdr *h, u32 *held, i64 nr, i64 a0, i64 a1, i64 a2, i64 a3, i64 a4, i64 a5) { + i64 a[6] = { a0, a1, a2, a3, a4, a5 }; + switch (nr) { + case NR_OPENAT: case NR_FACCESSAT: case NR_FACCESSAT2: case NR_FCHMODAT: case NR_FCHMODAT2: + case NR_FCHOWNAT: case NR_NEWFSTATAT: case NR_STATX: case NR_READLINKAT: case NR_MKDIRAT: + case NR_MKNODAT: case NR_UNLINKAT: case NR_UTIMENSAT: case NR_OPENAT2: case NR_NAME_TO_HANDLE_AT: + case NR_INOTIFY_ADD_WATCH: case NR_CHDIR: case NR_CHROOT: case NR_STATFS: case NR_TRUNCATE: + case NR_SETXATTR: case NR_LSETXATTR: case NR_GETXATTR: case NR_LGETXATTR: case NR_LISTXATTR: + case NR_LLISTXATTR: case NR_REMOVEXATTR: case NR_LREMOVEXATTR: case NR_RENAMEAT: case NR_RENAMEAT2: + case NR_LINKAT: case NR_SYMLINKAT: case NR_GETCWD: case NR_BIND: case NR_CONNECT: case NR_EXECVE: + // The calls that carry paths: not mapped where the rootfs is not in its own place (above) + if (!rewriting(h)) return sc(nr, a0, a1, a2, a3, a4, a5); + break; + default: + return sc(nr, a0, a1, a2, a3, a4, a5); + } + switch (nr) { + case NR_OPENAT: case NR_FACCESSAT: case NR_FACCESSAT2: case NR_FCHMODAT: case NR_FCHMODAT2: + case NR_FCHOWNAT: case NR_NEWFSTATAT: case NR_STATX: case NR_READLINKAT: case NR_MKDIRAT: + case NR_MKNODAT: case NR_UNLINKAT: case NR_UTIMENSAT: case NR_OPENAT2: case NR_NAME_TO_HANDLE_AT: + case NR_INOTIFY_ADD_WATCH: + return with_paths(h, held, nr, a, 1, -1); + case NR_CHDIR: case NR_CHROOT: case NR_STATFS: case NR_TRUNCATE: case NR_SETXATTR: + case NR_LSETXATTR: case NR_GETXATTR: case NR_LGETXATTR: case NR_LISTXATTR: case NR_LLISTXATTR: + case NR_REMOVEXATTR: case NR_LREMOVEXATTR: + return with_paths(h, held, nr, a, 0, -1); + case NR_RENAMEAT: case NR_RENAMEAT2: case NR_LINKAT: + return with_paths(h, held, nr, a, 1, 3); + case NR_SYMLINKAT: // the target is data, only the link is a path + return with_paths(h, held, nr, a, 2, -1); + case NR_GETCWD: { + i64 r = sc(nr, a0, a1, 0, 0, 0, 0); + return r > 0 ? unmap_prefix(h, (char *)a0, r, 1) : r; + } + case NR_BIND: case NR_CONNECT: + return with_sockaddr(h, held, nr, a0, a1, a2); + case NR_EXECVE: { + // Counted while it is on its way: when it works it does not return (see execs_on_their_way) + u32 *count = execs_on_their_way(h); + __atomic_fetch_add(count, 1, __ATOMIC_RELAXED); + i64 r = with_execve(h, held, a0, a1, a2); + count_down(count); // it did return: it failed, and cxgo_entry gives its slot back + return r; + } + default: + return sc(nr, a0, a1, a2, a3, a4, a5); + } +} + +__attribute__((section(".text.cxgo_entry"), used, noinline)) +i64 cxgo_entry(i64 a0, i64 a1, i64 a2, i64 a3, i64 a4, i64 a5, i64 unused, i64 nr) { + (void)unused; + const struct gosys_hdr *h = hdr(); + u32 held = NO_SLOT; + reclaim_left_slots(h); + i64 r = handle(h, &held, nr, a0, a1, a2, a3, a4, a5); + put_slot(h, held); + return r; +} diff --git a/tools/nativeguest/gosys/gosys.ld b/tools/nativeguest/gosys/gosys.ld new file mode 100644 index 0000000000..ba5a6ba34f --- /dev/null +++ b/tools/nativeguest/gosys/gosys.ld @@ -0,0 +1,14 @@ +/* The layout of gosys.c's flat binary: the header at 0 (the patcher fills it in), the room for the + call site's connecting code, the code with its entry first, read-only data, the trailer last. */ +OUTPUT_FORMAT(elf64-littleaarch64) +ENTRY(cxgo_entry) +SECTIONS +{ + . = 0; + .hdr : { KEEP(*(.hdr)) } + .thunks : { . = ALIGN(16); KEEP(*(.thunks)) } + .text : { . = ALIGN(16); KEEP(*(.text.cxgo_entry)) *(.text .text.*) } + .rodata : { . = ALIGN(16); *(.rodata .rodata.*) } + .trailer : { . = ALIGN(64); KEEP(*(.trailer)) } + /DISCARD/ : { *(.comment) *(.note*) *(.eh_frame*) *(.gnu*) *(.interp) } +} diff --git a/tools/nativeguest/gosys/gosys_abi.h b/tools/nativeguest/gosys/gosys_abi.h new file mode 100644 index 0000000000..e0c4807d34 --- /dev/null +++ b/tools/nativeguest/gosys/gosys_abi.h @@ -0,0 +1,79 @@ +// What the hook and the code it adds to a static Go program (gosys.c) agree on. +// +// A Go program built without cgo makes its system calls itself, so the preloaded hook never sees +// them and Ubuntu's paths (/etc/resolv.conf, /usr/bin/git, ...) mean nothing to it. Before such a +// program starts, the hook adds a small piece of position-independent code to its file (see +// go_programs.c): the program's one system call function, internal/runtime/syscall.Syscall6, jumps +// to it, and it maps paths into the rootfs like the hook does, then makes the call. +// +// This header has no dependencies beyond , so that the freestanding code and the hook, +// which are built with different flags, can both include it. + +#ifndef DDNATV_GOSYS_ABI_H +#define DDNATV_GOSYS_ABI_H + +#include + +#ifndef GOSYS_VERSION +#define GOSYS_VERSION 3u // raised when the code or its header changes: patched programs are patched again +#endif + +// The scratch memory for rewritten paths: a small state area and 64 slots, in zero-filled memory the +// patcher appends to the program's data segment (so nothing is allocated per call). A slot belongs to +// the thread that took it until its call is over: a word in the state area for each slot says +// which goroutine (x28) has it. A slot that a vfork child kept by a successful execve is given back +// at the next call of the goroutine that made the child (the state area counts the execve calls +// that have not returned, [8]). +// (A ring of slots shared by every call was tried first: a thread that was descheduled for a +// moment between taking a slot and the call let sixteen others go round the ring and overwrite its +// path, so a Go program opened another file than it asked for.) +#define GOSYS_SLOTS 64u +#define GOSYS_SLOT_SIZE 32768u // two paths (4K each), an argv array (8K), an environment array (16K) +#define GOSYS_STATE_SIZE 1024u // [4] rewriting mode, [8] execve calls on their way, [64 + 8 * slot] who has the slot (0: nobody) +#define GOSYS_SCRATCH_SIZE (GOSYS_STATE_SIZE + GOSYS_SLOTS * GOSYS_SLOT_SIZE) + +#define GOSYS_THUNK_BYTES 256u // room for the small code that connects a call site to the code + +#define GOSYS_ROOT_MAX 448 +#define GOSYS_PATH_MAX 448 +#define GOSYS_LIBS_MAX 1024 + +struct gosys_hdr { + char magic[8]; // "CXGOSYS1" + uint32_t version; // GOSYS_VERSION + uint32_t flags; + int64_t scratch_rel; // scratch memory, relative to this header (the same in any load address) + uint32_t root_len; // the rootfs, as Android sees it + uint32_t ldso_len; // the rootfs's dynamic linker + uint32_t hook_len; // libddnatv-hook.so; 0: none + uint32_t libs_len; // the rootfs's library directories, ':' separated + uint32_t runner_len; // the rootfs's bash, or env without it; 0: Ubuntu programs cannot be started + uint32_t reserved; + char root[GOSYS_ROOT_MAX]; + char ldso[GOSYS_PATH_MAX]; + char hook[GOSYS_PATH_MAX]; + char libs[GOSYS_LIBS_MAX]; + char runner[GOSYS_PATH_MAX]; +}; + +#define GOSYS_FLAG_RUNNER_IS_BASH 1u // gosys_hdr.flags + +// The last 64 bytes of the added code: where it is, and what the patcher changed to add it. +struct gosys_trailer { + char magic[8]; // "CXGOEND1" + uint32_t version; + uint32_t total_size; // the added code, header to trailer + uint64_t text_orig_filesz; // the segment that holds it: its size before + uint64_t rw_orig_memsz; // the data segment: its size before + uint32_t text_index; // their numbers in the program header table + uint32_t rw_index; + uint32_t text_orig_flags; + uint32_t reserved; + uint64_t site_file_off; // the instruction that was replaced (a "svc #0") + uint64_t reserved2; +}; + +_Static_assert(sizeof(struct gosys_trailer) == 64, "the trailer is 64 bytes"); +_Static_assert(sizeof(struct gosys_hdr) % 16 == 0, "the header keeps the code after it aligned"); + +#endif diff --git a/tools/nativeguest/hook/env.c b/tools/nativeguest/hook/env.c new file mode 100644 index 0000000000..e95083c25e --- /dev/null +++ b/tools/nativeguest/hook/env.c @@ -0,0 +1,309 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// The environment of started programs: Android programs get it without the hook, rootfs +// programs with it. + +#ifndef DDNATV_HOST_TEST + +static const char *ddnatv_hook_library(char *buf, size_t bufsz); + +static char **clean_env_for_system(char *const envp[]) { + int count = 0; + while (envp && envp[count]) count++; + char **new_env = calloc(count + 3, sizeof(char *)); + int dst = 0; + int has_path = 0; + for (int i = 0; i < count; i++) { + char first = envp[i][0]; + if (!((first == 'L' && (strncmp(envp[i], "LD_PRELOAD=", 11) == 0 || + strncmp(envp[i], "LD_LIBRARY_PATH=", 16) == 0)) || + (first == 'G' && strncmp(envp[i], "GLIBC_TUNABLES=", 15) == 0))) { + if (first == 'P' && strncmp(envp[i], "PATH=", 5) == 0) { + has_path = 1; + size_t plen = strlen(envp[i]); + char *new_path = malloc(plen + 64); + if (new_path) { + snprintf(new_path, plen + 64, "PATH=/system/bin:/system/xbin:/sbin:/vendor/bin:%s", envp[i] + 5); + new_env[dst++] = new_path; + } else { + new_env[dst++] = envp[i]; + } + } else { + new_env[dst++] = envp[i]; + } + } + } + if (!has_path) { + new_env[dst++] = strdup("PATH=/system/bin:/system/xbin:/sbin:/vendor/bin"); + } + new_env[dst] = NULL; + return new_env; +} + +// LD_PRELOAD with every absolute path that is not in the rootfs yet mapped into it. Entries are +// separated by ':' or ' '. free() the result. +static char *map_preload_paths(const char *value) { + if (!value) return NULL; + size_t cap = strlen(value) + (g_ddnatv_root_len + 1) * 16 + 16; + char *out = malloc(cap); + if (!out) return NULL; + size_t used = 0; + out[0] = '\0'; + const char *p = value; + while (*p) { + size_t len = strcspn(p, ": "); + if (len > 0 && len < PATH_MAX) { + char entry[PATH_MAX]; + memcpy(entry, p, len); + entry[len] = '\0'; + char buf[PATH_MAX]; + const char *mapped = entry[0] == '/' ? rewrite_path_in_root(entry, buf, sizeof(buf)) : entry; + size_t mlen = strlen(mapped); + if (used + mlen + 2 >= cap) break; + if (used) out[used++] = ':'; + memcpy(out + used, mapped, mlen); + used += mlen; + out[used] = '\0'; + } + p += len; + if (*p) p++; + } + return out; +} + +static char **prepare_ddnatv_env(char *const envp[], const char *real_exe) { + init_ddnatv_hook(); + int count = 0; + int has_preload = 0; + int has_ld_library_path = 0; + int has_root = 0; + int has_tunables = 0; + int has_path = 0; + int has_tmp = 0; + int has_threads_max = 0; + int has_xz_opt = 0; + int has_xz_defaults = 0; + int has_frontend = 0; + int has_debconf_frontend = 0; + int has_debconf_seen = 0; + + const char *chosen_real_exe = (real_exe && real_exe[0] != '\0') ? real_exe : (g_real_exe[0] != '\0' ? g_real_exe : NULL); + + // Every variable is looked at on every exec, so only the names that start with its first letter + // are compared (this was 13 strncmp() calls for each of the 30 or so variables) + int has_nt = 0; + int has_binds = 0; + int has_hostname = 0; + int has_link_root = 0; + int has_preload_list = 0; + const char *preload_value = NULL; + while (envp && envp[count]) { + const char *e = envp[count]; + switch (e[0]) { + case 'L': + if (strncmp(e, "LD_PRELOAD=", 11) == 0) { has_preload = 1; preload_value = e + 11; } + else if (strncmp(e, "LD_LIBRARY_PATH=", 16) == 0) has_ld_library_path = 1; + break; + case 'G': + if (strncmp(e, "GLIBC_TUNABLES=", 15) == 0) has_tunables = 1; + break; + case 'P': + if (strncmp(e, "PATH=", 5) == 0) has_path = 1; + break; + case 'T': + if (strncmp(e, "TMPDIR=", 7) == 0) has_tmp = 1; + break; + case 'X': + if (strncmp(e, "XZ_OPT=", 7) == 0) has_xz_opt = 1; + else if (strncmp(e, "XZ_DEFAULTS=", 12) == 0) has_xz_defaults = 1; + break; + case 'D': + if (strncmp(e, "DDNATV_ROOT=", 12) == 0) has_root = 1; + else if (strncmp(e, "DDNATV_NT=", 10) == 0) has_nt = 1; + else if (strncmp(e, "DDNATV_BINDS=", 13) == 0) has_binds = 1; + else if (strncmp(e, "DDNATV_PRELOAD=", 15) == 0) has_preload_list = 1; + else if (strncmp(e, "DDNATV_HOSTNAME=", 16) == 0) has_hostname = 1; + else if (strncmp(e, "DDNATV_LINK_ROOT=", 17) == 0) has_link_root = 1; + else if (strncmp(e, "DPKG_DEB_THREADS_MAX=", 21) == 0) has_threads_max = 1; + else if (strncmp(e, "DEBIAN_FRONTEND=", 16) == 0) has_frontend = 1; + else if (strncmp(e, "DEBCONF_FRONTEND=", 17) == 0) has_debconf_frontend = 1; + else if (strncmp(e, "DEBCONF_NONINTERACTIVE_SEEN=", 28) == 0) has_debconf_seen = 1; + break; + default: + break; + } + count++; + } + + char **new_env = calloc(count + 24, sizeof(char *)); + int dst = 0; + for (int i = 0; i < count; i++) { + if (has_preload && envp[i][0] == 'L' && strncmp(envp[i], "LD_PRELOAD=", 11) == 0) { + // ld.so opens these itself: the guest's paths are mapped to the rootfs, and the libraries every + // program loads (DDNATV_PRELOAD) come first + char *mapped = map_preload_paths(preload_value); + if (mapped) { + size_t chain = g_preload_host ? strlen(g_preload_host) : 0; + int has_chain = chain > 0 && strstr(mapped, g_preload_host) != NULL; + size_t len = 11 + chain + 1 + strlen(mapped) + 1; + char *str = malloc(len); + if (str) { + if (chain > 0 && !has_chain) snprintf(str, len, "LD_PRELOAD=%s:%s", g_preload_host, mapped); + else snprintf(str, len, "LD_PRELOAD=%s", mapped); + new_env[dst++] = str; + free(mapped); + continue; + } + free(mapped); + } + } + // If we have an explicit real executable, drop the inherited entry to replace with the fresh target + if (chosen_real_exe && envp[i][0] == 'D' && strncmp(envp[i], "DDNATV_REAL_EXE=", 16) == 0) { + continue; + } + new_env[dst++] = envp[i]; + } + + // Exact-size strings: this runs before every exec, often in a freshly forked child where each + // newly touched page is a copy-on-write fault. + if (chosen_real_exe) { + size_t len = strlen(chosen_real_exe); + char *str = malloc(16 + len + 1); + if (str) { + memcpy(str, "DDNATV_REAL_EXE=", 16); + memcpy(str + 16, chosen_real_exe, len + 1); + new_env[dst++] = str; + } + } + + char hook_buf[PATH_MAX]; + const char *hook = (!has_preload && g_ddnatv_root[0] != '\0') ? ddnatv_hook_library(hook_buf, sizeof(hook_buf)) : NULL; + if (hook) { + size_t hook_len = strlen(hook); + size_t host_len = g_preload_host ? strlen(g_preload_host) + 1 : 0; + size_t size = 11 + host_len + hook_len + 1; + char *str = malloc(size); + if (str) { + size_t n = ddnatv_append(str, size, 0, "LD_PRELOAD=", 11); + if (host_len) { + n = ddnatv_append(str, size, n, g_preload_host, host_len - 1); + n = ddnatv_append(str, size, n, ":", 1); + } + ddnatv_append(str, size, n, hook, hook_len); + new_env[dst++] = str; + } + } + if (!has_preload_list && g_preload_guest) { + size_t len = strlen(g_preload_guest); + char *str = malloc(15 + len + 1); + if (str) { + memcpy(str, "DDNATV_PRELOAD=", 15); + memcpy(str + 15, g_preload_guest, len + 1); + new_env[dst++] = str; + } + } + if (!has_ld_library_path && g_ddnatv_root[0] != '\0') { + size_t size = 16 + 1; + for (size_t i = 0; i < sizeof(k_rootfs_lib_dirs) / sizeof(k_rootfs_lib_dirs[0]); i++) { + char dir[PATH_MAX]; + size += 1 + strlen(rewrite_path_in_root(k_rootfs_lib_dirs[i], dir, sizeof(dir))); + } + char *str = malloc(size); + if (str) { + size_t n = ddnatv_append(str, size, 0, "LD_LIBRARY_PATH=", 16); + append_rootfs_lib_dirs(str, size, n, 0); + new_env[dst++] = str; + } + } + if (!has_root && g_ddnatv_root[0] != '\0') { + char *str = malloc(PATH_MAX + 16); + if (str) { + snprintf(str, PATH_MAX + 16, "DDNATV_ROOT=%s", g_ddnatv_root); + new_env[dst++] = str; + } + } + if (!has_link_root && g_link_root_len) { + char *str = malloc(17 + g_link_root_len + 1); + if (str) { + memcpy(str, "DDNATV_LINK_ROOT=", 17); + memcpy(str + 17, g_link_root, g_link_root_len + 1); + new_env[dst++] = str; + } + } + if (!has_hostname && g_hostname[0]) { + char *str = malloc(16 + sizeof(g_hostname)); + if (str) { + snprintf(str, 16 + sizeof(g_hostname), "DDNATV_HOSTNAME=%s", g_hostname); + new_env[dst++] = str; + } + } + if (!has_binds && g_binds_raw) { + size_t len = strlen(g_binds_raw); + char *str = malloc(13 + len + 1); + if (str) { + memcpy(str, "DDNATV_BINDS=", 13); + memcpy(str + 13, g_binds_raw, len + 1); + new_env[dst++] = str; + } + } + // This process looked for the ARM translator's files and found none: the programs it starts + // need not look again (it takes a look at /proc/self/fd in each of them, see privileged.c) + if (!has_nt && g_no_translator) { + new_env[dst++] = strdup("DDNATV_NT=0"); + } + if (!has_tunables) { + new_env[dst++] = strdup("GLIBC_TUNABLES=glibc.pthread.rseq=0"); + } + if (!has_path) { + new_env[dst++] = strdup("PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"); + } + if (!has_tmp && g_ddnatv_root[0] != '\0') { + char *str = malloc(PATH_MAX + 16); + if (str) { + snprintf(str, PATH_MAX + 16, "TMPDIR=%s/tmp", g_ddnatv_root); + new_env[dst++] = str; + } + } + if (!has_threads_max) { + new_env[dst++] = strdup("DPKG_DEB_THREADS_MAX=1"); + } + if (!has_xz_opt) { + new_env[dst++] = strdup("XZ_OPT=-T1"); + } + if (!has_xz_defaults) { + new_env[dst++] = strdup("XZ_DEFAULTS=-T1"); + } + if (!has_frontend) { + new_env[dst++] = strdup("DEBIAN_FRONTEND=noninteractive"); + } + if (!has_debconf_frontend) { + new_env[dst++] = strdup("DEBCONF_FRONTEND=noninteractive"); + } + if (!has_debconf_seen) { + new_env[dst++] = strdup("DEBCONF_NONINTERACTIVE_SEEN=true"); + } + new_env[dst] = NULL; + return new_env; +} + +static void free_modified_env(char **modified_env, char *const orig_env[]) { + if (!modified_env) return; + for (int i = 0; modified_env[i] != NULL; i++) { + int is_orig = 0; + if (orig_env) { + for (int j = 0; orig_env[j] != NULL; j++) { + if (modified_env[i] == orig_env[j]) { + is_orig = 1; + break; + } + } + } + if (!is_orig) { + free(modified_env[i]); + } + } + free(modified_env); +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/exec.c b/tools/nativeguest/hook/exec.c new file mode 100644 index 0000000000..90df96f8fe --- /dev/null +++ b/tools/nativeguest/hook/exec.c @@ -0,0 +1,1127 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// execve() and posix_spawn(): rootfs programs through ld.so with the hook, scripts through their +// interpreter, Android programs with Android's environment. + +#ifndef DDNATV_HOST_TEST + +// Runs before every exec, mostly in a child a shell has just forked: the copies write only the +// string (ddnatv_copy_cstr), not the whole PATH_MAX buffer, since each page written there is a +// copy-on-write fault. +static void resolve_symlinks(const char *path, char *out, size_t out_size, int depth) { + if (!path || !out || out_size == 0) return; + ddnatv_copy_cstr(out, out_size, path); + if (depth > 8) return; + + char link_target[PATH_MAX]; + ssize_t len = readlink(path, link_target, sizeof(link_target) - 1); + if (len < 0) return; + link_target[len] = '\0'; + + char next_path[PATH_MAX]; + if (link_target[0] == '/') { + char rw_buf[PATH_MAX]; + const char *rewritten = rewrite_path(link_target, rw_buf, sizeof(rw_buf)); + ddnatv_copy_cstr(next_path, sizeof(next_path), rewritten); + } else { + const char *slash = strrchr(path, '/'); + if (slash) { + size_t dir_len = (size_t)(slash - path); + if (dir_len > sizeof(next_path) - 1) dir_len = sizeof(next_path) - 1; + memcpy(next_path, path, dir_len); + next_path[dir_len] = '\0'; + size_t n = ddnatv_append(next_path, sizeof(next_path), dir_len, "/", 1); + ddnatv_append(next_path, sizeof(next_path), n, link_target, (size_t)len); + } else { + ddnatv_copy_cstr(next_path, sizeof(next_path), link_target); + } + } + // proot's link2symlink leaves hard links as ".l2s.*" files that programs must not see by name + const char *next_base = strrchr(next_path, '/'); + next_base = next_base ? next_base + 1 : next_path; + if (strncmp(next_base, ".l2s.", 5) == 0) return; + resolve_symlinks(next_path, out, out_size, depth + 1); +} + +static char **ensure_hook_in_envp(char *const envp[], const char *real_exe) { + return prepare_ddnatv_env(envp, real_exe); +} + +// The file whose header decides how to start `target`: the symlink-resolved ELF (so ld.so and +// /proc/self/exe see the real program, as with the kernel), else `target` itself (scripts, +// links to ld.so). `probe` describes the returned file. +static const char *select_exec_target(const char *target, char *resolved, size_t resolved_size, struct exec_probe *probe) { + resolve_symlinks(target, resolved, resolved_size, 0); + probe_exec_file(resolved, probe); + if (probe->is_elf && !is_ld_linux(resolved)) return resolved; + if (strcmp(resolved, target) != 0) probe_exec_file(target, probe); + return target; +} + +// The library children get with --preload: the one this process runs from, so that a program +// always starts with the same build as its parent, else the first of usr/lib and lib that exists; +// NULL if neither does. +// The path dladdr() finds is kept (it does not change): set once, read by every later exec, and +// set before a fork by prepare_exec_in_parent() so that the children only read it. +static char g_hook_library[PATH_MAX]; +static int g_hook_library_known = 0; + +static const char *ddnatv_hook_library(char *buf, size_t bufsz) { + static const char usr_lib[] = "/usr/lib/libddnatv-hook.so"; + static const char lib[] = "/lib/libddnatv-hook.so"; + if (__atomic_load_n(&g_hook_library_known, __ATOMIC_ACQUIRE)) return g_hook_library; + Dl_info info; + if (dladdr((void *)ddnatv_hook_library, &info) && info.dli_fname && info.dli_fname[0] == '/' && + strlen(info.dli_fname) < sizeof(g_hook_library)) { + // loaded from there, so it exists + ddnatv_copy_cstr(g_hook_library, sizeof(g_hook_library), info.dli_fname); + __atomic_store_n(&g_hook_library_known, 1, __ATOMIC_RELEASE); + return g_hook_library; + } + size_t n = ddnatv_append(buf, bufsz, 0, g_ddnatv_root, g_ddnatv_root_len); + ddnatv_append(buf, bufsz, n, usr_lib, sizeof(usr_lib) - 1); + if (access(buf, F_OK) == 0) return buf; + n = ddnatv_append(buf, bufsz, 0, g_ddnatv_root, g_ddnatv_root_len); + ddnatv_append(buf, bufsz, n, lib, sizeof(lib) - 1); + return access(buf, F_OK) == 0 ? buf : NULL; +} + +// ld.so does not need the exec bit on the program it loads, but other tools look at it: set +// it as the old access(X_OK)/chmod() pair did, using the mode the probe already has. +static void ensure_exec_bit(const char *path, mode_t mode) { + if (S_ISDIR(mode) || (mode & 0111) != 0) return; + if (strstr(path, "/bin/") || strstr(path, "/sbin/")) return; + chmod(path, 0755); +} + +// Rootfs path of a "#!" interpreter; a missing /bin/sh falls back to Android's shell. +static const char *shebang_interpreter(const char *interp, char *buf, size_t bufsz) { + const char *rewritten = rewrite_path(interp, buf, bufsz); + if (strcmp(interp, "/bin/sh") == 0 && access(rewritten, F_OK) != 0 && access("/system/bin/sh", X_OK) == 0) { + return "/system/bin/sh"; + } + return rewritten; +} + +static const char *exec_prog_name(const char *target) { + const char *slash = strrchr(target, '/'); + return slash ? slash + 1 : target; +} + +// Hook execve +typedef int (*orig_execve_f_type)(const char *filename, char *const argv[], char *const envp[]); + +// glibc's execve(), looked up once (also by prepare_exec_in_parent() before a fork) +static orig_execve_f_type g_orig_execve = NULL; + +static orig_execve_f_type real_execve(void) { + orig_execve_f_type f = __atomic_load_n(&g_orig_execve, __ATOMIC_RELAXED); + if (!f) { + f = (orig_execve_f_type)dlsym(RTLD_NEXT, "execve"); + __atomic_store_n(&g_orig_execve, f, __ATOMIC_RELAXED); + } + return f; +} + +// prepare_exec_in_parent() rehearses an exec in the parent: everything up to the execve() itself, +// which this then skips. Only in the thread that rehearses: another thread's exec at that moment +// is a real one. +static int g_exec_rehearsal = 0; +static pthread_t g_exec_rehearsal_thread; + +static int in_exec_rehearsal(void) { + return __atomic_load_n(&g_exec_rehearsal, __ATOMIC_ACQUIRE) && + pthread_equal(pthread_self(), g_exec_rehearsal_thread); +} + +static int run_execve(orig_execve_f_type f, const char *path, char *const argv[], char *const envp[]) { + if (in_exec_rehearsal()) { + errno = 0; + return 0; + } + return f(path, argv, envp); +} + +// ldconfig does nothing in The native userland (its cache is for paths that ld.so opens without the hook), but the +// exec code reads /etc/ld.so.conf(.d) again when /etc/ld.so.cache changes: "sudo ldconfig" after an +// edit of a .conf file marks it changed, as the real ldconfig would by writing it. A cache asked +// for with -C is made (empty): Flatpak mounts the one it generates over /etc/ld.so.cache. +static void ldconfig_mark_cache(char *const argv[]) { + if (g_ddnatv_root[0] == '\0') return; + char path[PATH_MAX]; + const char *cache = NULL; + for (int i = 1; argv && argv[i]; i++) { + if (strcmp(argv[i], "-C") == 0 && argv[i + 1]) cache = argv[++i]; + else if (strncmp(argv[i], "-C", 2) == 0 && argv[i][2] != '\0') cache = argv[i] + 2; + } + const char *target = path; + if (cache) { + target = rewrite_path_in_root(cache, path, sizeof(path)); + } else { + size_t n = ddnatv_append(path, sizeof(path), 0, g_ddnatv_root, g_ddnatv_root_len); + ddnatv_append(path, sizeof(path), n, "/etc/ld.so.cache", 16); + } + int fd = (int)syscall(SYS_openat, AT_FDCWD, target, O_WRONLY | O_CREAT | O_CLOEXEC, 0644); + if (fd < 0) return; + syscall(SYS_utimensat, fd, NULL, NULL, 0); + syscall(SYS_close, fd); +} + +static int is_ldconfig_name(const char *name) { + return strcmp(name, "ldconfig") == 0 || strcmp(name, "ldconfig.real") == 0; +} + +static int ddnatv_execve(const char *filename, char *const argv[], char *const envp[], int depth) { + orig_execve_f_type orig_execve = real_execve(); + if (!orig_execve) { + errno = ENOSYS; + return -1; + } + + // Scripts get the path exactly as the caller wrote it ("./x.sh" stays "./x.sh" in $0), + // like the kernel would pass it; routing below uses the absolute form. + const char *caller_path = filename; + char abs_buf[PATH_MAX]; + filename = absolutize_exec_path(filename, abs_buf, sizeof(abs_buf)); + + char buf[PATH_MAX]; + const char *target = rewrite_path(filename, buf, sizeof(buf)); + + init_ddnatv_hook(); + + const char *f_base = (filename != NULL) ? strrchr(filename, '/') : NULL; + f_base = (f_base != NULL) ? f_base + 1 : (filename != NULL ? filename : ""); + + const char *prog_name = strrchr(target, '/'); + prog_name = (prog_name != NULL) ? prog_name + 1 : target; + + // Wine's preloader is a static program that opens the program and the dynamic linker it loads with + // system calls of its own, which no hook can map, to reserve address ranges before the linker runs. + // The program is started without it: its libc and ntdll reserve what Wine needs themselves. + if ((strcmp(prog_name, "wine-preloader") == 0 || strcmp(prog_name, "wine64-preloader") == 0) && + argv && argv[0] && argv[1] && depth < DDNATV_MAX_SHEBANG_DEPTH) { + return ddnatv_execve(argv[1], argv + 1, envp, depth + 1); + } + + // Intercept utilities that fail or cause issues in unprivileged Android environment + if (strcmp(f_base, "ldconfig") == 0 || + strcmp(f_base, "ldconfig.real") == 0 || + strcmp(f_base, "systemd-machine-id-setup") == 0 || + strcmp(f_base, "systemd-sysusers") == 0 || + strcmp(f_base, "systemd-tmpfiles") == 0 || + strcmp(f_base, "start-stop-daemon") == 0 || + strcmp(f_base, "mandb") == 0 || + strcmp(f_base, "mandb.real") == 0 || + strcmp(f_base, "update-mime-database") == 0 || + strcmp(f_base, "update-desktop-database") == 0 || + strcmp(f_base, "install-info") == 0 || + strcmp(f_base, "install-sgmlcatalog") == 0 || + strcmp(prog_name, "ldconfig") == 0 || + strcmp(prog_name, "ldconfig.real") == 0 || + strcmp(prog_name, "systemd-machine-id-setup") == 0 || + strcmp(prog_name, "systemd-sysusers") == 0 || + strcmp(prog_name, "systemd-tmpfiles") == 0 || + strcmp(prog_name, "start-stop-daemon") == 0 || + strcmp(prog_name, "mandb") == 0 || + strcmp(prog_name, "mandb.real") == 0 || + strcmp(prog_name, "update-mime-database") == 0 || + strcmp(prog_name, "update-desktop-database") == 0 || + strcmp(prog_name, "install-info") == 0 || + strcmp(prog_name, "install-sgmlcatalog") == 0) { + if (is_ldconfig_name(f_base) || is_ldconfig_name(prog_name)) ldconfig_mark_cache(argv); + _exit(0); + } + if (strcmp(f_base, "mountpoint") == 0 || strcmp(prog_name, "mountpoint") == 0) { + int is_virtual_fs = 0; + for (int i = 1; argv && argv[i]; i++) { + if (strcmp(argv[i], "/proc") == 0 || strcmp(argv[i], "/proc/") == 0 || + strcmp(argv[i], "/sys") == 0 || strcmp(argv[i], "/sys/") == 0 || + strcmp(argv[i], "/dev") == 0 || strcmp(argv[i], "/dev/") == 0 || + strcmp(argv[i], "/dev/pts") == 0) { + is_virtual_fs = 1; + break; + } + } + if (is_virtual_fs) { + _exit(0); + } + } + if (strcmp(f_base, "policy-rc.d") == 0 || strcmp(prog_name, "policy-rc.d") == 0) { + _exit(101); + } + + // A static program inside the rootfs, to be made safe to start (prepare_static_program) + const char *static_elf = NULL; + char resolved_target[PATH_MAX]; + + // Only intercept binaries/scripts within DDNATV_ROOT + if ((g_ddnatv_root[0] != '\0' && strncmp(target, g_ddnatv_root, g_ddnatv_root_len) == 0) || is_mapped_guest_path(filename)) { + struct exec_probe probe; + const char *elf_target = select_exec_target(target, resolved_target, sizeof(resolved_target), &probe); + if (probe.is_elf && !probe.is_dynamic) static_elf = elf_target; + // A Go program built for Android asks for Android's linker, so it is started like the dynamic + // ones, but it makes its own system calls: it gets the code of the static Go programs (#42) + if (probe.is_dynamic && probe.android_interp) prepare_static_program_ex(elf_target, 1); + + // 1. Transparently route dynamically linked glibc ELF binaries through ld.so + // Note: Statically linked binaries (PT_INTERP absent, e.g. Meta Muse Code) must execute directly! + if (probe.is_dynamic) { + char ld_so[PATH_MAX]; + ld_so[0] = '\0'; + if (find_dynamic_linker_for_machine(g_ddnatv_root, probe.e_machine, ld_so, sizeof(ld_so)) && strcmp(elf_target, ld_so) != 0) { + ensure_exec_bit(elf_target, probe.mode); + + if (!in_exec_rehearsal()) ddnatv_copy_cstr(g_real_exe, sizeof(g_real_exe), elf_target); + + char hook_buf[PATH_MAX]; + const char *hook_so = ddnatv_hook_library(hook_buf, sizeof(hook_buf)); + char ld_lib_path[PATH_MAX * 6]; + build_ld_library_path(envp, probe.runpath, probe.runpath_is_rpath, elf_target, ld_lib_path, sizeof(ld_lib_path)); + char **new_argv = build_ldso_argv(ld_so, hook_so, ld_lib_path, elf_target, exec_prog_name(target), argv); + if (!new_argv) { + errno = ENOMEM; + return -1; + } + char **new_env = ensure_hook_in_envp(envp, elf_target); + int ret = run_execve(orig_execve, ld_so, new_argv, new_env); + if (errno == EACCES && chmod(ld_so, 0755) == 0) { + // ld.so without its exec bit (an unusual restore): fix it once and retry + ret = run_execve(orig_execve, ld_so, new_argv, new_env); + } + int saved_errno = errno; + free(new_argv); + free_modified_env(new_env, envp); + errno = saved_errno; + return ret; + } + } + + // ld.so started directly (ldd, "ld.so --list PROGRAM", "ld.so PROGRAM"): the program it loads + // gets the --library-path a start of its own gets, or ldd reports its libraries as not found, + // and its path mapped into the rootfs, since ld.so opens it without the hook + if (probe.is_elf && !probe.is_dynamic && is_ld_linux(elf_target)) { + int caller_lib_path = 0; + int pi = ldso_program_index(argv, &caller_lib_path); + if (pi > 0 && caller_lib_path) { + // the caller's own --library-path stays as it is; only the program is mapped (when it is + // in the rootfs: a caller can also name a file by its real path) + char prog_buf[PATH_MAX]; + const char *prog = argv[pi]; + if (prog[0] == '/') { + const char *mapped = rewrite_path(prog, prog_buf, sizeof(prog_buf)); + int fd = mapped != prog ? (int)syscall(SYS_openat, AT_FDCWD, mapped, O_PATH | O_CLOEXEC) : -1; + if (fd >= 0) { + syscall(SYS_close, fd); + prog = mapped; + } + } + int argc = 0; + while (argv[argc]) argc++; + char **new_argv = (char **)malloc(sizeof(char *) * (size_t)(argc + 1)); + if (!new_argv) { + errno = ENOMEM; + return -1; + } + for (int i = 0; i <= argc; i++) new_argv[i] = argv[i]; + new_argv[pi] = (char *)prog; + prepare_static_program(static_elf); // ld.so is a static program itself + char **ddnatv_env = prepare_ddnatv_env(envp, target); + int ret = run_execve(orig_execve, target, new_argv, ddnatv_env); + int saved_errno = errno; + free_modified_env(ddnatv_env, envp); + free(new_argv); + errno = saved_errno; + return ret; + } + if (pi > 0) { + char prog_buf[PATH_MAX]; + const char *prog = argv[pi][0] == '/' ? rewrite_path(argv[pi], prog_buf, sizeof(prog_buf)) : argv[pi]; + struct exec_probe prog_probe; + probe_exec_file(prog, &prog_probe); + char ld_lib_path[PATH_MAX * 6]; + build_ld_library_path(envp, prog_probe.runpath, prog_probe.runpath_is_rpath, + prog[0] == '/' ? prog : NULL, ld_lib_path, sizeof(ld_lib_path)); + int argc = 0; + while (argv[argc]) argc++; + char **new_argv = (char **)malloc(sizeof(char *) * (size_t)(argc + 3)); + if (!new_argv) { + errno = ENOMEM; + return -1; + } + new_argv[0] = argv[0]; + new_argv[1] = (char *)"--library-path"; + new_argv[2] = ld_lib_path; + for (int i = 1; i <= argc; i++) new_argv[i + 2] = argv[i]; + new_argv[pi + 2] = (char *)prog; // ld.so opens it itself: "ldd /usr/bin/adb" as well + prepare_static_program(static_elf); // ld.so is a static program itself + char **ddnatv_env = prepare_ddnatv_env(envp, target); + int ret = run_execve(orig_execve, target, new_argv, ddnatv_env); + int saved_errno = errno; + free_modified_env(ddnatv_env, envp); + free(new_argv); + errno = saved_errno; + return ret; + } + } + + // 2. Handle scripts with shebang lines (e.g., #!/bin/sh, #!/usr/bin/perl) + if (!probe.is_elf && probe.n >= 2 && probe.hdr[0] == '#' && probe.hdr[1] == '!') { + char *interp; + char *interp_arg; + parse_shebang(probe.hdr, &interp, &interp_arg); + char interp_buf[PATH_MAX]; + const char *rewritten_interp = shebang_interpreter(interp, interp_buf, sizeof(interp_buf)); + const char *script = (caller_path && caller_path[0] != '/') ? caller_path : target; + char **new_argv = build_script_argv(rewritten_interp, interp_arg, script, argv); + if (!new_argv) { + errno = ENOMEM; + return -1; + } + int ret; + if (is_host_interpreter(rewritten_interp)) { + char **sys_env = clean_env_for_system(envp); + ret = run_execve(orig_execve, rewritten_interp, new_argv, sys_env); + int saved_errno = errno; + free_modified_env(sys_env, envp); + errno = saved_errno; + } else if (depth >= DDNATV_MAX_SHEBANG_DEPTH) { + errno = ELOOP; + ret = -1; + } else { + char **ddnatv_env = prepare_ddnatv_env(envp, NULL); + ret = ddnatv_execve(rewritten_interp, new_argv, ddnatv_env, depth + 1); + int saved_errno = errno; + free_modified_env(ddnatv_env, envp); + errno = saved_errno; + } + free(new_argv); + return ret; + } + } else { + // Any binary outside DDNATV_ROOT is an Android host binary (e.g. /system/bin/su, /sbin/su, /data/adb/...) + char **sys_env = clean_env_for_system(envp); + int ret = run_execve(orig_execve, target, argv, sys_env); + int saved_errno = errno; + free_modified_env(sys_env, envp); + errno = saved_errno; + return ret; + } + + if (static_elf) prepare_static_program(static_elf); + char **ddnatv_env = prepare_ddnatv_env(envp, target); + int ret = run_execve(orig_execve, target, argv, ddnatv_env); + int saved_errno = errno; + free_modified_env(ddnatv_env, envp); + errno = saved_errno; + return ret; +} + +int execve(const char *filename, char *const argv[], char *const envp[]) { + return ddnatv_execve(filename, argv, envp, 0); +} + +// ---- fork() --------------------------------------------------------------------------------- +// A shell (and make, dpkg, perl, ...) starts a program with fork() and then execve() in the child. +// What the exec code above needs for the first time in a process (glibc's execve, fstat and readlink +// behind the hooks, the rootfs' ld.so, the path of this library) it found in the child, where every +// page it writes is a copy of the parent's: some 40 copy-on-write faults before each program even +// started, where a shell's child without the hook has fewer than ten. Now the parent finds them at +// its first fork(), and the children inherit them and only read them. At its eighth fork() the +// parent also rehearses an exec (everything but the execve() itself), which binds the calls the +// exec code makes and touches the code it runs. That costs about as much as it saves in four +// children, so only a process that keeps forking (a shell running a loop or a long script, make, +// dpkg) does it; one that forks a few times (sh -c with a pipe) does not pay for it. +#define DDNATV_FORKS_BEFORE_REHEARSAL 8 +static int g_exec_prepared = 0; // 1 after the first fork(), 2 after the rehearsal +static pthread_mutex_t g_exec_prepare_lock = PTHREAD_MUTEX_INITIALIZER; + +static void rehearse_exec(void) { + static const char rehearsal_target[] = "/usr/bin/true"; + char target_buf[PATH_MAX]; + const char *target = rewrite_path(rehearsal_target, target_buf, sizeof(target_buf)); + struct exec_probe probe; + // A dynamic program only: it takes the one way through ddnatv_execve() that ends in run_execve() + probe_exec_file(target, &probe); + if (!probe.is_elf || !probe.is_dynamic) return; + extern char **environ; + char *rehearsal_argv[] = { (char *)"true", NULL }; + g_exec_rehearsal_thread = pthread_self(); + __atomic_store_n(&g_exec_rehearsal, 1, __ATOMIC_RELEASE); + ddnatv_execve(rehearsal_target, rehearsal_argv, environ, 0); + __atomic_store_n(&g_exec_rehearsal, 0, __ATOMIC_RELEASE); +} + +static void prepare_exec_in_parent(int level) { + // One thread prepares (two rehearsing at once would take each other for the other's thread). + // Not waiting for the lock: a signal handler that forks while its thread is preparing would wait + // for itself; a busy lock leaves the preparation to a later fork(). + if (pthread_mutex_trylock(&g_exec_prepare_lock) != 0) return; + int done = __atomic_load_n(&g_exec_prepared, __ATOMIC_ACQUIRE); + if (done >= level) { + pthread_mutex_unlock(&g_exec_prepare_lock); + return; + } + int saved_errno = errno; + init_ddnatv_hook(); + real_execve(); + if (g_ddnatv_root[0] != '\0') { + if (done < 1) { + char ld_so[PATH_MAX]; +#if defined(__aarch64__) + uint16_t machine = 183; +#elif defined(__arm__) + uint16_t machine = 40; +#elif defined(__x86_64__) + uint16_t machine = 62; +#else + uint16_t machine = 0; +#endif + if (machine && find_dynamic_linker_for_machine(g_ddnatv_root, machine, ld_so, sizeof(ld_so))) { + // readlink(), open(), read() and close() behind the hooks, as the probe calls them + char resolved[PATH_MAX]; + struct exec_probe probe; + resolve_symlinks(ld_so, resolved, sizeof(resolved), 0); + probe_exec_file(ld_so, &probe); + } + char hook_buf[PATH_MAX]; + ddnatv_hook_library(hook_buf, sizeof(hook_buf)); + struct stat st; + probe_fstat(-1, &st); // looks fstat() up; -1 only fails with EBADF + char conf[PATH_MAX * 2]; + ldconf_dirs(conf, sizeof(conf)); // ld.so.conf read here, so the children only compare times + } + if (level >= 2) rehearse_exec(); + } + __atomic_store_n(&g_exec_prepared, level, __ATOMIC_RELEASE); + pthread_mutex_unlock(&g_exec_prepare_lock); + errno = saved_errno; +} + +pid_t fork(void) { + static pid_t (*orig_fork)(void) = NULL; + if (!orig_fork) orig_fork = (pid_t (*)(void))dlsym(RTLD_NEXT, "fork"); + if (!orig_fork) { + errno = ENOSYS; + return -1; + } + int done = __atomic_load_n(&g_exec_prepared, __ATOMIC_ACQUIRE); + if (done < 2) { + static int forks = 0; + int n = __atomic_add_fetch(&forks, 1, __ATOMIC_RELAXED); + if (n == 1 || n >= DDNATV_FORKS_BEFORE_REHEARSAL) prepare_exec_in_parent(n >= DDNATV_FORKS_BEFORE_REHEARSAL ? 2 : 1); + } + pid_t pid = orig_fork(); + // A child forked from a signal handler that interrupted a rehearsal is not rehearsing: its + // execve() is a real one (only read in the usual case, so no page is copied for it) + if (pid == 0 && __atomic_load_n(&g_exec_rehearsal, __ATOMIC_RELAXED)) __atomic_store_n(&g_exec_rehearsal, 0, __ATOMIC_RELAXED); + return pid; +} + +extern char **environ; + +int execv(const char *path, char *const argv[]) { + return execve(path, argv, environ); +} + +int execl(const char *path, const char *arg0, ...) { + va_list args; + va_start(args, arg0); + int count = (arg0 != NULL) ? 1 : 0; + if (arg0 != NULL) { + while (va_arg(args, const char *) != NULL) { + count++; + } + } + va_end(args); + + char **argv = (char **)calloc(count + 1, sizeof(char *)); + if (!argv) { + errno = ENOMEM; + return -1; + } + if (count > 0) { + argv[0] = (char *)arg0; + va_start(args, arg0); + for (int i = 1; i < count; i++) { + argv[i] = va_arg(args, char *); + } + va_end(args); + } + argv[count] = NULL; + int ret = execv(path, argv); + free(argv); + return ret; +} + +int execlp(const char *file, const char *arg0, ...) { + va_list args; + va_start(args, arg0); + int count = (arg0 != NULL) ? 1 : 0; + if (arg0 != NULL) { + while (va_arg(args, const char *) != NULL) { + count++; + } + } + va_end(args); + + char **argv = (char **)calloc(count + 1, sizeof(char *)); + if (!argv) { + errno = ENOMEM; + return -1; + } + if (count > 0) { + argv[0] = (char *)arg0; + va_start(args, arg0); + for (int i = 1; i < count; i++) { + argv[i] = va_arg(args, char *); + } + va_end(args); + } + argv[count] = NULL; + int ret = execvp(file, argv); + free(argv); + return ret; +} + +int execle(const char *path, const char *arg0, ...) { + va_list args; + va_start(args, arg0); + int count = (arg0 != NULL) ? 1 : 0; + if (arg0 != NULL) { + while (va_arg(args, const char *) != NULL) { + count++; + } + } + char *const *envp = va_arg(args, char *const *); + va_end(args); + + char **argv = (char **)calloc(count + 1, sizeof(char *)); + if (!argv) { + errno = ENOMEM; + return -1; + } + if (count > 0) { + argv[0] = (char *)arg0; + va_start(args, arg0); + for (int i = 1; i < count; i++) { + argv[i] = va_arg(args, char *); + } + va_end(args); + } + argv[count] = NULL; + int ret = execve(path, argv, (char *const *)envp); + free(argv); + return ret; +} + +int execvp(const char *file, char *const argv[]) { + if (!file || !*file) { + errno = ENOENT; + return -1; + } + if (strchr(file, '/')) { + return execve(file, argv, environ); + } + const char *path_env = getenv("PATH"); + if (!path_env) path_env = "/usr/bin:/bin"; + char path_copy[4096]; + strncpy(path_copy, path_env, sizeof(path_copy) - 1); + path_copy[sizeof(path_copy) - 1] = '\0'; + char *saveptr = NULL; + char *token = strtok_r(path_copy, ":", &saveptr); + while (token) { + char candidate[PATH_MAX]; + snprintf(candidate, sizeof(candidate), "%s/%s", token, file); + if (access(candidate, F_OK) == 0) { + return execve(candidate, argv, environ); + } + token = strtok_r(NULL, ":", &saveptr); + } + const char *standard_paths[] = {"/usr/bin", "/bin", "/usr/sbin", "/sbin", "/usr/local/bin", NULL}; + for (int i = 0; standard_paths[i] != NULL; i++) { + char candidate[PATH_MAX]; + snprintf(candidate, sizeof(candidate), "%s/%s", standard_paths[i], file); + if (access(candidate, F_OK) == 0) { + return execve(candidate, argv, environ); + } + } + return execve(file, argv, environ); +} + +int execvpe(const char *file, char *const argv[], char *const envp[]) { + if (!file || !*file) { + errno = ENOENT; + return -1; + } + if (strchr(file, '/')) { + return execve(file, argv, envp); + } + const char *path_env = NULL; + if (envp) { + for (char *const *ep = envp; *ep; ep++) { + if (strncmp(*ep, "PATH=", 5) == 0) { + path_env = *ep + 5; + break; + } + } + } + if (!path_env) path_env = getenv("PATH"); + if (!path_env) path_env = "/usr/bin:/bin"; + char path_copy[4096]; + strncpy(path_copy, path_env, sizeof(path_copy) - 1); + path_copy[sizeof(path_copy) - 1] = '\0'; + char *saveptr = NULL; + char *token = strtok_r(path_copy, ":", &saveptr); + while (token) { + char candidate[PATH_MAX]; + snprintf(candidate, sizeof(candidate), "%s/%s", token, file); + if (access(candidate, F_OK) == 0) { + return execve(candidate, argv, envp); + } + token = strtok_r(NULL, ":", &saveptr); + } + const char *standard_paths[] = {"/usr/bin", "/bin", "/usr/sbin", "/sbin", "/usr/local/bin", NULL}; + for (int i = 0; standard_paths[i] != NULL; i++) { + char candidate[PATH_MAX]; + snprintf(candidate, sizeof(candidate), "%s/%s", standard_paths[i], file); + if (access(candidate, F_OK) == 0) { + return execve(candidate, argv, envp); + } + } + return execve(file, argv, envp); +} + +typedef int (*orig_posix_spawn_f_type)(pid_t *, const char *, const posix_spawn_file_actions_t *, + const posix_spawnattr_t *, char *const [], char *const []); + +static orig_posix_spawn_f_type real_posix_spawn(void) { + static orig_posix_spawn_f_type orig_posix_spawn = NULL; + if (!orig_posix_spawn) orig_posix_spawn = (orig_posix_spawn_f_type)dlsym(RTLD_NEXT, "posix_spawn"); + return orig_posix_spawn; +} + +static int ddnatv_posix_spawn(pid_t *pid, const char *path, + const posix_spawn_file_actions_t *file_actions, + const posix_spawnattr_t *attrp, + char *const argv[], char *const envp[], int depth); + +// A rootfs script: start its interpreter with the same file actions and attributes. Handing the +// script to the kernel resolves "#!/bin/sh" to Android's own shell, which crashed on the glibc +// hook in LD_PRELOAD (and "#!/usr/bin/env" etc. used to fall back to fork() + execve(), which +// dropped the file actions). +static int spawn_script(pid_t *pid, const char *script, struct exec_probe *probe, + const posix_spawn_file_actions_t *file_actions, const posix_spawnattr_t *attrp, + char *const argv[], char *const envp[], int depth) { + char *interp; + char *interp_arg; + parse_shebang(probe->hdr, &interp, &interp_arg); + char interp_buf[PATH_MAX]; + const char *rewritten_interp = shebang_interpreter(interp, interp_buf, sizeof(interp_buf)); + char **new_argv = build_script_argv(rewritten_interp, interp_arg, script, argv); + if (!new_argv) return ENOMEM; + int ret; + if (is_host_interpreter(rewritten_interp)) { + orig_posix_spawn_f_type orig_posix_spawn = real_posix_spawn(); + char **sys_env = clean_env_for_system(envp); + ret = orig_posix_spawn ? orig_posix_spawn(pid, rewritten_interp, file_actions, attrp, new_argv, sys_env) : ENOSYS; + free_modified_env(sys_env, envp); + } else { + ret = ddnatv_posix_spawn(pid, rewritten_interp, file_actions, attrp, new_argv, envp, depth + 1); + } + free(new_argv); + return ret; +} + +static int ddnatv_posix_spawn(pid_t *pid, const char *path, + const posix_spawn_file_actions_t *file_actions, + const posix_spawnattr_t *attrp, + char *const argv[], char *const envp[], int depth) { + orig_posix_spawn_f_type orig_posix_spawn = real_posix_spawn(); + + const char *caller_path = path; + char abs_buf[PATH_MAX]; + path = absolutize_exec_path(path, abs_buf, sizeof(abs_buf)); + + char buf[PATH_MAX]; + const char *target = rewrite_path(path, buf, sizeof(buf)); + + init_ddnatv_hook(); + + const char *f_base = (path != NULL) ? strrchr(path, '/') : NULL; + f_base = (f_base != NULL) ? f_base + 1 : (path != NULL ? path : ""); + + const char *prog_name = exec_prog_name(target); + + if (strcmp(f_base, "ldconfig") == 0 || + strcmp(f_base, "ldconfig.real") == 0 || + strcmp(f_base, "systemd-machine-id-setup") == 0 || + strcmp(f_base, "systemd-sysusers") == 0 || + strcmp(f_base, "systemd-tmpfiles") == 0 || + strcmp(f_base, "start-stop-daemon") == 0 || + strcmp(prog_name, "ldconfig") == 0 || + strcmp(prog_name, "ldconfig.real") == 0 || + strcmp(prog_name, "systemd-machine-id-setup") == 0 || + strcmp(prog_name, "systemd-sysusers") == 0 || + strcmp(prog_name, "systemd-tmpfiles") == 0 || + strcmp(prog_name, "start-stop-daemon") == 0) { + pid_t child = fork(); + if (child == 0) { + if (is_ldconfig_name(f_base) || is_ldconfig_name(prog_name)) ldconfig_mark_cache(argv); + _exit(0); + } else if (child > 0) { + if (pid) *pid = child; + return 0; + } + return errno; + } + if (strcmp(f_base, "mountpoint") == 0 || strcmp(prog_name, "mountpoint") == 0) { + int is_virtual_fs = 0; + for (int i = 1; argv && argv[i]; i++) { + if (strcmp(argv[i], "/proc") == 0 || strcmp(argv[i], "/proc/") == 0 || + strcmp(argv[i], "/sys") == 0 || strcmp(argv[i], "/sys/") == 0 || + strcmp(argv[i], "/dev") == 0 || strcmp(argv[i], "/dev/") == 0 || + strcmp(argv[i], "/dev/pts") == 0) { + is_virtual_fs = 1; + break; + } + } + if (is_virtual_fs) { + pid_t child = fork(); + if (child == 0) { + _exit(0); + } else if (child > 0) { + if (pid) *pid = child; + return 0; + } + return errno; + } + } + if (strcmp(f_base, "policy-rc.d") == 0 || strcmp(prog_name, "policy-rc.d") == 0) { + pid_t child = fork(); + if (child == 0) { + _exit(101); + } else if (child > 0) { + if (pid) *pid = child; + return 0; + } + return errno; + } + + char *const *orig_ep = envp ? envp : environ; + int in_root = (g_ddnatv_root[0] != '\0' && strncmp(target, g_ddnatv_root, g_ddnatv_root_len) == 0) || is_mapped_guest_path(path); + + struct exec_probe probe; + char resolved_target[PATH_MAX]; + const char *elf_target = target; + if (in_root) { + elf_target = select_exec_target(target, resolved_target, sizeof(resolved_target), &probe); + if (!probe.is_elf && probe.n >= 2 && probe.hdr[0] == '#' && probe.hdr[1] == '!') { + // Like the kernel, give up after a few nested "#!" interpreters. + if (depth >= DDNATV_MAX_SHEBANG_DEPTH) return ELOOP; + const char *script = (caller_path && caller_path[0] != '/') ? caller_path : target; + return spawn_script(pid, script, &probe, file_actions, attrp, argv, orig_ep, depth); + } + } else { + probe.hdr[0] = '\0'; + probe.n = -1; + probe.is_elf = 0; + probe.is_dynamic = 0; + probe.android_interp = 0; + probe.e_machine = 0; + probe.mode = 0; + probe.runpath[0] = '\0'; + probe.runpath_is_rpath = 0; + } + + char ld_so[PATH_MAX]; + ld_so[0] = '\0'; + int has_ld_so = probe.is_dynamic ? find_dynamic_linker_for_machine(g_ddnatv_root, probe.e_machine, ld_so, sizeof(ld_so)) : 0; + + // Android programs get Android's environment, as execve() gives them: the glibc hook in + // LD_PRELOAD crashes them. + char **new_envp = in_root ? ensure_hook_in_envp(orig_ep, elf_target) : clean_env_for_system(orig_ep); + + int ret = -1; + if (has_ld_so && strcmp(elf_target, ld_so) != 0) { + ensure_exec_bit(elf_target, probe.mode); + if (probe.android_interp) prepare_static_program_ex(elf_target, 1); // a Go program built for Android (#42) + + char hook_buf[PATH_MAX]; + const char *hook_so = ddnatv_hook_library(hook_buf, sizeof(hook_buf)); + char ld_lib_path[PATH_MAX * 6]; + build_ld_library_path(orig_ep, probe.runpath, probe.runpath_is_rpath, elf_target, ld_lib_path, sizeof(ld_lib_path)); + char **new_argv = build_ldso_argv(ld_so, hook_so, ld_lib_path, elf_target, prog_name, argv); + if (!new_argv) { + ret = ENOMEM; + } else { + if (orig_posix_spawn) { + ret = orig_posix_spawn(pid, ld_so, file_actions, attrp, new_argv, new_envp); + if (ret == EACCES && chmod(ld_so, 0755) == 0) { + // ld.so without its exec bit (an unusual restore): fix it once and retry + ret = orig_posix_spawn(pid, ld_so, file_actions, attrp, new_argv, new_envp); + } + } + free(new_argv); + } + } else { + if (in_root && probe.is_elf && !probe.is_dynamic) prepare_static_program(elf_target); + if (orig_posix_spawn) { + ret = orig_posix_spawn(pid, target, file_actions, attrp, argv, new_envp); + } + } + + if (!orig_posix_spawn) { + pid_t child = fork(); + if (child < 0) { + free_modified_env(new_envp, orig_ep); + return errno; + } else if (child == 0) { + execve(target, argv, new_envp); + _exit(127); + } else { + if (pid) *pid = child; + free_modified_env(new_envp, orig_ep); + return 0; + } + } + free_modified_env(new_envp, orig_ep); + return ret; +} + +static int apply_closefrom(posix_spawn_file_actions_t *actions); + +int posix_spawn(pid_t *pid, const char *path, + const posix_spawn_file_actions_t *file_actions, + const posix_spawnattr_t *attrp, + char *const argv[], char *const envp[]) { + if (file_actions) { + int bad = apply_closefrom((posix_spawn_file_actions_t *)file_actions); + if (bad) return bad; + } + posix_spawnattr_t sanitized; + return ddnatv_posix_spawn(pid, path, file_actions, spawn_attr_for_android(attrp, &sanitized), argv, envp, 0); +} + +int posix_spawnp(pid_t *pid, const char *file, + const posix_spawn_file_actions_t *file_actions, + const posix_spawnattr_t *attrp, + char *const argv[], char *const envp[]) { + if (!file || !*file) { + return ENOENT; + } + if (strchr(file, '/')) { + return posix_spawn(pid, file, file_actions, attrp, argv, envp); + } + const char *path_env = NULL; + if (envp) { + for (char *const *ep = envp; *ep; ep++) { + if (strncmp(*ep, "PATH=", 5) == 0) { + path_env = *ep + 5; + break; + } + } + } + if (!path_env) path_env = getenv("PATH"); + if (!path_env) path_env = "/usr/bin:/bin"; + char path_copy[4096]; + strncpy(path_copy, path_env, sizeof(path_copy) - 1); + path_copy[sizeof(path_copy) - 1] = '\0'; + char *saveptr = NULL; + char *token = strtok_r(path_copy, ":", &saveptr); + while (token) { + char candidate[PATH_MAX]; + snprintf(candidate, sizeof(candidate), "%s/%s", token, file); + if (access(candidate, F_OK) == 0) { + return posix_spawn(pid, candidate, file_actions, attrp, argv, envp); + } + token = strtok_r(NULL, ":", &saveptr); + } + const char *standard_paths[] = {"/usr/bin", "/bin", "/usr/sbin", "/sbin", "/usr/local/bin", NULL}; + for (int i = 0; standard_paths[i] != NULL; i++) { + char candidate[PATH_MAX]; + snprintf(candidate, sizeof(candidate), "%s/%s", standard_paths[i], file); + if (access(candidate, F_OK) == 0) { + return posix_spawn(pid, candidate, file_actions, attrp, argv, envp); + } + } + // If not found in PATH or standard paths, return ENOENT without spawning zombie + return ENOENT; +} + +// ---- system(), popen() and pclose() --------------------------------------------------------- +// glibc starts the shell of system() and popen() from inside the C library (its own posix_spawn and +// execve), where the hook's execve() is not called: the kernel ran the machine's /bin/sh, which on +// Android is the system's own shell, and that one failed to link against Ubuntu's libraries +// ("CANNOT LINK EXECUTABLE sh: ...libc.so has bad ELF magic", #49). They start Ubuntu's /bin/sh here. + +extern char **environ; + +static pid_t start_shell(const char *command, int child_fd, int target_fd, const sigset_t *mask, + const struct sigaction *intr, const struct sigaction *quit, int close_popen_streams); + +// While system() waits, SIGINT and SIGQUIT are ignored; with several threads in system() at once, the +// first one in saves the dispositions and the last one out puts them back (as glibc does) +static pthread_mutex_t g_system_lock = PTHREAD_MUTEX_INITIALIZER; +static int g_system_waiting; +static struct sigaction g_system_intr, g_system_quit; + +// system(3) as POSIX describes it: SIGINT and SIGQUIT ignored and SIGCHLD blocked while it waits +int system(const char *command) { + if (!command) return access("/bin/sh", X_OK) == 0; // whether there is a shell (Ubuntu's) + pthread_mutex_lock(&g_system_lock); + if (g_system_waiting++ == 0) { + struct sigaction ignore; + memset(&ignore, 0, sizeof(ignore)); + ignore.sa_handler = SIG_IGN; + sigemptyset(&ignore.sa_mask); + sigaction(SIGINT, &ignore, &g_system_intr); + sigaction(SIGQUIT, &ignore, &g_system_quit); + } + struct sigaction intr = g_system_intr, quit = g_system_quit; + pthread_mutex_unlock(&g_system_lock); + sigset_t block, old; + sigemptyset(&block); + sigaddset(&block, SIGCHLD); + sigprocmask(SIG_BLOCK, &block, &old); + + int status = -1; + pid_t pid = start_shell(command, -1, -1, &old, &intr, &quit, 0); + if (pid > 0) { + while (waitpid(pid, &status, 0) < 0) { + if (errno != EINTR) { + status = -1; + break; + } + } + } + int saved = errno; + pthread_mutex_lock(&g_system_lock); + if (--g_system_waiting == 0) { + sigaction(SIGINT, &g_system_intr, NULL); + sigaction(SIGQUIT, &g_system_quit, NULL); + } + pthread_mutex_unlock(&g_system_lock); + sigprocmask(SIG_SETMASK, &old, NULL); + errno = saved; + return status; +} + +// The streams popen() made, with their shells: pclose() waits for the one of its stream +struct ddnatv_popen { + FILE *fp; + pid_t pid; + struct ddnatv_popen *next; +}; +static struct ddnatv_popen *g_popen_streams; +static pthread_mutex_t g_popen_lock = PTHREAD_MUTEX_INITIALIZER; + +static pid_t start_shell(const char *command, int child_fd, int target_fd, const sigset_t *mask, + const struct sigaction *intr, const struct sigaction *quit, int close_popen_streams) { + pid_t pid = fork(); + if (pid != 0) return pid; + if (intr) sigaction(SIGINT, intr, NULL); + if (quit) sigaction(SIGQUIT, quit, NULL); + if (mask) sigprocmask(SIG_SETMASK, mask, NULL); + if (child_fd >= 0) { + if (child_fd == target_fd) { + fcntl(target_fd, F_SETFD, 0); + } else if (dup2(child_fd, target_fd) < 0) { + _exit(127); + } + } + // POSIX: the streams of earlier popen() calls are not open in the new shell + if (close_popen_streams) { + for (struct ddnatv_popen *p = g_popen_streams; p; p = p->next) { + int fd = fileno(p->fp); + if (fd >= 0 && fd != target_fd) close(fd); + } + } + char *const argv[] = { (char *)"sh", (char *)"-c", (char *)command, NULL }; + ddnatv_execve("/bin/sh", argv, environ, 0); + _exit(127); +} + +FILE *popen(const char *command, const char *type) { + if (!command || !type || (type[0] != 'r' && type[0] != 'w')) { + errno = EINVAL; + return NULL; + } + int reading = type[0] == 'r'; + int keep_on_exec = strchr(type, 'e') == NULL; + int fds[2]; + if (pipe2(fds, O_CLOEXEC) != 0) return NULL; + int parent_end = reading ? fds[0] : fds[1]; + int child_end = reading ? fds[1] : fds[0]; + struct ddnatv_popen *entry = (struct ddnatv_popen *)malloc(sizeof(*entry)); + if (!entry) { + close(fds[0]); + close(fds[1]); + errno = ENOMEM; + return NULL; + } + pthread_mutex_lock(&g_popen_lock); + pid_t pid = start_shell(command, child_end, reading ? STDOUT_FILENO : STDIN_FILENO, NULL, NULL, NULL, 1); + int saved = errno; + close(child_end); + FILE *fp = NULL; + if (pid > 0) { + if (keep_on_exec) fcntl(parent_end, F_SETFD, 0); + fp = fdopen(parent_end, reading ? "r" : "w"); + saved = errno; + } + if (!fp) { + close(parent_end); + pthread_mutex_unlock(&g_popen_lock); + free(entry); + if (pid > 0) { + // A shell nobody will read or write: it is not left to run (or waited for while it does) + kill(pid, SIGKILL); + while (waitpid(pid, NULL, 0) < 0 && errno == EINTR) {} + } + errno = saved; + return NULL; + } + entry->fp = fp; + entry->pid = pid; + entry->next = g_popen_streams; + g_popen_streams = entry; + pthread_mutex_unlock(&g_popen_lock); + return fp; +} + +int pclose(FILE *stream) { + struct ddnatv_popen *found = NULL; + pthread_mutex_lock(&g_popen_lock); + for (struct ddnatv_popen **p = &g_popen_streams; *p; p = &(*p)->next) { + if ((*p)->fp == stream) { + found = *p; + *p = found->next; + break; + } + } + // Closed before the lock is let go: a popen() in between would fork a shell that keeps this pipe open, + // and the shell of this stream would wait for its end of it + if (found) fclose(stream); + pthread_mutex_unlock(&g_popen_lock); + if (!found) { + // Not one of ours: glibc's own + static int (*orig_pclose)(FILE *) = NULL; + if (!orig_pclose) orig_pclose = (int (*)(FILE *))dlsym(RTLD_NEXT, "pclose"); + if (!orig_pclose) { + errno = ECHILD; + return -1; + } + return orig_pclose(stream); + } + pid_t pid = found->pid; + free(found); + int status = -1; + pid_t r; + do { + r = waitpid(pid, &status, 0); + } while (r < 0 && errno == EINTR); + return r < 0 ? -1 : status; +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/exec_probe.c b/tools/nativeguest/hook/exec_probe.c new file mode 100644 index 0000000000..f877175e58 --- /dev/null +++ b/tools/nativeguest/hook/exec_probe.c @@ -0,0 +1,1027 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// What execve() and posix_spawn() need to know about a program: its ld.so, whether it is a +// dynamic ELF, a script and its interpreter, and the argument lists built from that. + +// Relative exec paths ("./configure", "bin/tool", "../x.sh") must go through the same +// DDNATV_ROOT routing as absolute ones. Without this they were mistaken for Android host +// binaries and handed to the kernel unchanged, which then resolved "#!/bin/bash" (or a glibc +// PT_INTERP) literally and failed with "bad interpreter: No such file or directory". +// getcwd() is not virtualised, so cwd + path is a real path that starts with DDNATV_ROOT. +static const char *absolutize_exec_path(const char *path, char *buffer, size_t bufsize) { + if (!path || path[0] == '\0' || path[0] == '/') return path; + char cwd[PATH_MAX]; + static char *(*real_getcwd)(char *, size_t) = NULL; + if (!real_getcwd) real_getcwd = (char *(*)(char *, size_t))dlsym(RTLD_NEXT, "getcwd"); + if (!real_getcwd || !real_getcwd(cwd, sizeof(cwd))) return path; + + while (path[0] == '.' && path[1] == '/') { + path += 2; + while (path[0] == '/') path++; + } + if (path[0] == '\0' || strcmp(path, ".") == 0) return path; + + size_t cwd_len = strlen(cwd); + while (cwd_len > 1 && cwd[cwd_len - 1] == '/') cwd[--cwd_len] = '\0'; + int n = snprintf(buffer, bufsize, "%s%s%s", cwd, (cwd_len == 1 && cwd[0] == '/') ? "" : "/", path); + if (n < 0 || (size_t)n >= bufsize) return path; + return buffer; +} + +static char s_cached_ld_so[PATH_MAX] = {0}; +static char s_cached_ld_root[PATH_MAX] = {0}; +static uint16_t s_cached_e_machine = 0; + +// ld.so inside `ddnatv_root` for an ELF with machine type `e_machine` (0 when unknown). +static int find_dynamic_linker_for_machine(const char *ddnatv_root, uint16_t e_machine, char *out_ld_so, size_t max_len) { + if (!ddnatv_root || ddnatv_root[0] == '\0' || !out_ld_so || max_len == 0) return 0; + + if (s_cached_ld_so[0] != '\0' && strcmp(s_cached_ld_root, ddnatv_root) == 0 && + e_machine != 0 && e_machine == s_cached_e_machine) { + ddnatv_copy_cstr(out_ld_so, max_len, s_cached_ld_so); + return 1; + } + + const char *aarch64_cands[] = { + "/usr/lib/aarch64-linux-gnu/ld-linux-aarch64.so.1", + "/usr/lib/aarch64-linux-gnu/ld-2.39.so", + "/lib/ld-linux-aarch64.so.1", + "/lib/aarch64-linux-gnu/ld-linux-aarch64.so.1", + "/usr/lib/ld-linux-aarch64.so.1", + "/usr/lib64/ld-linux-aarch64.so.1", + "/lib64/ld-linux-aarch64.so.1", + "/lib/aarch64-linux-gnu/ld-2.39.so", + NULL + }; + + const char *armhf_cands[] = { + "/usr/lib/arm-linux-gnueabihf/ld-linux-armhf.so.3", + "/usr/lib/arm-linux-gnueabihf/ld-2.39.so", + "/lib/ld-linux-armhf.so.3", + "/lib/arm-linux-gnueabihf/ld-linux-armhf.so.3", + "/usr/lib/ld-linux-armhf.so.3", + "/lib/arm-linux-gnueabihf/ld-2.39.so", + "/usr/lib/arm-linux-gnueabi/ld-linux.so.3", + "/lib/arm-linux-gnueabi/ld-linux.so.3", + NULL + }; + + const char *x86_64_cands[] = { + "/lib64/ld-linux-x86-64.so.2", + "/usr/lib/x86_64-linux-gnu/ld-linux-x86-64.so.2", + "/usr/lib/x86_64-linux-gnu/ld-2.39.so", + "/lib/x86_64-linux-gnu/ld-linux-x86-64.so.2", + NULL + }; + + const char **primary = NULL; + const char **secondary = NULL; + + if (e_machine == 183) { // EM_AARCH64 + primary = aarch64_cands; + secondary = NULL; + } else if (e_machine == 40) { // EM_ARM + primary = armhf_cands; + secondary = NULL; + } else if (e_machine == 62) { // EM_X86_64 + primary = x86_64_cands; + secondary = NULL; + } else if (e_machine == 3) { // EM_386 + primary = NULL; + secondary = NULL; + } else { + #if defined(__aarch64__) + primary = aarch64_cands; + secondary = armhf_cands; + #elif defined(__arm__) + primary = armhf_cands; + secondary = aarch64_cands; + #else + primary = x86_64_cands; + #endif + } + + if (primary) { + for (int i = 0; primary[i] != NULL; i++) { + snprintf(out_ld_so, max_len, "%s%s", ddnatv_root, primary[i]); + if (access(out_ld_so, F_OK) == 0) { + if (e_machine != 0) { + ddnatv_copy_cstr(s_cached_ld_so, sizeof(s_cached_ld_so), out_ld_so); + ddnatv_copy_cstr(s_cached_ld_root, sizeof(s_cached_ld_root), ddnatv_root); + s_cached_e_machine = e_machine; + } + return 1; + } + } + } + if (secondary) { + for (int i = 0; secondary[i] != NULL; i++) { + snprintf(out_ld_so, max_len, "%s%s", ddnatv_root, secondary[i]); + if (access(out_ld_so, F_OK) == 0) { + if (e_machine != 0) { + ddnatv_copy_cstr(s_cached_ld_so, sizeof(s_cached_ld_so), out_ld_so); + ddnatv_copy_cstr(s_cached_ld_root, sizeof(s_cached_ld_root), ddnatv_root); + s_cached_e_machine = e_machine; + } + return 1; + } + } + } + + return 0; +} + +#ifdef DDNATV_HOST_TEST +// Test entry point taking a program instead of its machine type (ddnatv-pty.c, which the tests +// include too, has a find_dynamic_linker of its own). +static int hook_find_dynamic_linker(const char *ddnatv_root, const char *cmd, char *out_ld_so, size_t max_len) { + if (!ddnatv_root || ddnatv_root[0] == '\0' || !out_ld_so || max_len == 0) return 0; + + uint16_t e_machine = 0; + if (cmd && cmd[0] != '\0') { + int fd = open(cmd, O_RDONLY); + if (fd >= 0) { + unsigned char ehdr[20]; + ssize_t n = read(fd, ehdr, sizeof(ehdr)); + close(fd); + if (n >= 20 && ehdr[0] == 0x7f && ehdr[1] == 'E' && ehdr[2] == 'L' && ehdr[3] == 'F') { + e_machine = (uint16_t)(ehdr[18] | (ehdr[19] << 8)); + } + } + } + return find_dynamic_linker_for_machine(ddnatv_root, e_machine, out_ld_so, max_len); +} +#endif + +static int check_elf_dynamic(int fd, const unsigned char *ehdr, ssize_t n) { + if (n < 52 || ehdr[0] != 0x7f || ehdr[1] != 'E' || ehdr[2] != 'L' || ehdr[3] != 'F') { + return 0; + } + if ((ehdr[4] != 1 && ehdr[4] != 2) || ehdr[5] != 1 /* ELFDATA2LSB */) { + return 0; + } + int is_64 = (ehdr[4] == 2); + uint64_t phoff = 0; + uint16_t phentsize = 0; + uint16_t phnum = 0; + if (is_64) { + if (n < 64) return 0; + memcpy(&phoff, ehdr + 32, sizeof(uint64_t)); + memcpy(&phentsize, ehdr + 54, sizeof(uint16_t)); + memcpy(&phnum, ehdr + 56, sizeof(uint16_t)); + } else { + uint32_t phoff32 = 0; + memcpy(&phoff32, ehdr + 28, sizeof(uint32_t)); + phoff = phoff32; + memcpy(&phentsize, ehdr + 42, sizeof(uint16_t)); + memcpy(&phnum, ehdr + 44, sizeof(uint16_t)); + } + uint16_t min_phentsize = is_64 ? 56 : 32; + if (phoff == 0 || phentsize < min_phentsize || phentsize > 4096 || phnum == 0) { + return 0; + } + if ((off_t)phoff < 0 || (uint64_t)(off_t)phoff != phoff) { + return 0; + } + if (lseek(fd, (off_t)phoff, SEEK_SET) < 0) { + return 0; + } + for (int i = 0; i < phnum && i < 128; i++) { + uint32_t p_type = 0; + if (read(fd, &p_type, sizeof(p_type)) != sizeof(p_type)) break; + if (p_type == 3 /* PT_INTERP */) { + return 1; + } + if (lseek(fd, (off_t)(phentsize - sizeof(p_type)), SEEK_CUR) < 0) break; + } + return 0; +} + +// check_elf_dynamic() on the bytes already read: 1 or 0, or -1 when a program header lies past +// the buffer and the file has to be read after all. Program headers normally follow the ELF +// header directly, so this saves the lseek()/read() pairs. +static int elf_interp_in_buffer(const unsigned char *ehdr, ssize_t n) { + if (n < 52 || ehdr[0] != 0x7f || ehdr[1] != 'E' || ehdr[2] != 'L' || ehdr[3] != 'F') { + return 0; + } + if ((ehdr[4] != 1 && ehdr[4] != 2) || ehdr[5] != 1 /* ELFDATA2LSB */) { + return 0; + } + int is_64 = (ehdr[4] == 2); + uint64_t phoff = 0; + uint16_t phentsize = 0; + uint16_t phnum = 0; + if (is_64) { + if (n < 64) return 0; + memcpy(&phoff, ehdr + 32, sizeof(uint64_t)); + memcpy(&phentsize, ehdr + 54, sizeof(uint16_t)); + memcpy(&phnum, ehdr + 56, sizeof(uint16_t)); + } else { + uint32_t phoff32 = 0; + memcpy(&phoff32, ehdr + 28, sizeof(uint32_t)); + phoff = phoff32; + memcpy(&phentsize, ehdr + 42, sizeof(uint16_t)); + memcpy(&phnum, ehdr + 44, sizeof(uint16_t)); + } + uint16_t min_phentsize = is_64 ? 56 : 32; + if (phoff == 0 || phentsize < min_phentsize || phentsize > 4096 || phnum == 0) { + return 0; + } + if ((off_t)phoff < 0 || (uint64_t)(off_t)phoff != phoff) { + return 0; + } + for (int i = 0; i < phnum && i < 128; i++) { + uint64_t off = phoff + (uint64_t)i * phentsize; + if (off > (uint64_t)n || (uint64_t)n - off < sizeof(uint32_t)) return -1; + uint32_t p_type = 0; + memcpy(&p_type, ehdr + off, sizeof(p_type)); + if (p_type == 3 /* PT_INTERP */) { + return 1; + } + } + return 0; +} + +// Whether the interpreter of a 64-bit ELF is Android's own linker (/system/bin/linker64). A Go +// program built with GOOS=android is a PIE that asks for it, so it has a PT_INTERP and looks like a +// dynamic program, but it has no C library and makes its own system calls like every Go program +// (#42). `h` holds the `n` first bytes of the file; the program headers usually are among them. +static int elf_interp_is_android(int fd, const unsigned char *h, ssize_t n) { + if (n < 64 || h[4] != 2) return 0; + uint64_t phoff = 0; + uint16_t phentsize = 0, phnum = 0; + memcpy(&phoff, h + 32, sizeof(phoff)); + memcpy(&phentsize, h + 54, sizeof(phentsize)); + memcpy(&phnum, h + 56, sizeof(phnum)); + if (phoff == 0 || phoff > (1ULL << 40) || phentsize < 56 || phentsize > 4096 || phnum == 0) return 0; + for (int i = 0; i < phnum && i < 128; i++) { + unsigned char e[56]; + uint64_t off = phoff + (uint64_t)i * phentsize; + if (off + sizeof(e) <= (uint64_t)n) { + memcpy(e, h + off, sizeof(e)); + } else if (pread(fd, e, sizeof(e), (off_t)off) != (ssize_t)sizeof(e)) { + return 0; + } + uint32_t p_type = 0; + memcpy(&p_type, e, sizeof(p_type)); + if (p_type != 3 /* PT_INTERP */) continue; + uint64_t p_offset = 0, p_filesz = 0; + memcpy(&p_offset, e + 8, sizeof(p_offset)); + memcpy(&p_filesz, e + 32, sizeof(p_filesz)); + char interp[48]; + size_t want = p_filesz < sizeof(interp) - 1 ? (size_t)p_filesz : sizeof(interp) - 1; + if (want == 0 || p_offset > (1ULL << 40)) return 0; + ssize_t got = pread(fd, interp, want, (off_t)p_offset); + if (got <= 0) return 0; + interp[got] = '\0'; + return strncmp(interp, "/system/bin/linker", 18) == 0; + } + return 0; +} + +// The kernel follows at most four nested "#!" interpreters, then fails with ELOOP. +#define DDNATV_MAX_SHEBANG_DEPTH 4 + +// What execve()/posix_spawn() need to know about the file they are about to start, from a +// single open()/read() (they used to open it up to three times). +struct exec_probe { + char hdr[256]; // first bytes of the file, NUL-terminated for "#!" parsing + ssize_t n; // bytes read; -1 when the file could not be opened + int is_elf; + int is_dynamic; // ELF with PT_INTERP: has to be started through ld.so + int android_interp; // AArch64 ELF whose PT_INTERP is Android's linker (a Go program for GOOS=android) + uint16_t e_machine; + mode_t mode; // st_mode, filled in for dynamic ELF files only + int runpath_is_rpath; // runpath holds a DT_RPATH (searched before LD_LIBRARY_PATH), not a DT_RUNPATH + char runpath[1024]; // DT_RUNPATH (else DT_RPATH) of a dynamic ELF as written in it, or "" +}; + +// The DT_RUNPATH of a dynamic ELF (its DT_RPATH when it has none, as ld.so does) into `out`, as +// written in the file. ld.so looks for the program's libraries there, but it opens those +// directories itself, without the hook: an absolute one such as /usr/lib/aarch64-linux-gnu/android +// (Ubuntu's adb and fastboot keep their own libbase, liblog, libssl... there) is looked for in +// Android's tree and the program does not start. The exec adds the rootfs copies to the +// --library-path it gives ld.so (build_ld_library_path). Returns 1 for a DT_RUNPATH, 2 for a +// DT_RPATH, 0 when there is neither. The headers are read in pieces, so that their number does +// not matter; a list longer than `out` keeps its first whole entries (ld.so still has the rest). +static int elf_read_dynamic(int fd, const unsigned char *h, ssize_t n, char *out, size_t outsz, + char *needed, size_t needed_size, int *needed_count); + +static int elf_read_runpath(int fd, const unsigned char *h, ssize_t n, char *out, size_t outsz) { + return elf_read_dynamic(fd, h, n, out, outsz, NULL, 0, NULL); +} + +// elf_read_runpath(), and with `needed` the DT_NEEDED names too: one after the other, each ended by a +// NUL, their number in *needed_count (as many as fit). +#define ELF_MAX_NEEDED 128 +static int elf_read_dynamic(int fd, const unsigned char *h, ssize_t n, char *out, size_t outsz, + char *needed, size_t needed_size, int *needed_count) { + if (needed_count) *needed_count = 0; + if (!out || outsz < 2) return 0; + out[0] = '\0'; + if (n < 52 || h[0] != 0x7f || h[1] != 'E' || h[2] != 'L' || h[3] != 'F' || h[5] != 1 /* LSB */) return 0; + int is_64 = (h[4] == 2); + if (!is_64 && h[4] != 1) return 0; + if (is_64 && n < 64) return 0; + uint64_t phoff = 0; + uint16_t phentsize = 0, phnum = 0; + if (is_64) { + memcpy(&phoff, h + 32, 8); + memcpy(&phentsize, h + 54, 2); + memcpy(&phnum, h + 56, 2); + } else { + uint32_t off32 = 0; + memcpy(&off32, h + 28, 4); + phoff = off32; + memcpy(&phentsize, h + 42, 2); + memcpy(&phnum, h + 44, 2); + } + size_t ph_size = is_64 ? 56 : 32; + if (phoff == 0 || phoff > (1ULL << 40) || phentsize < ph_size || phentsize > 1024 || phnum == 0) return 0; + + // PT_DYNAMIC, and the PT_LOAD segments that map an address of the file to its offset + unsigned char buf[2048]; + uint64_t dyn_off = 0, dyn_size = 0; + uint64_t load_vaddr[16], load_off[16], load_size[16]; + int loads = 0; + size_t per_read = sizeof(buf) / phentsize; + for (size_t first = 0; first < phnum; first += per_read) { + size_t count = phnum - first < per_read ? phnum - first : per_read; + size_t bytes = count * phentsize; + if (pread(fd, buf, bytes, (off_t)(phoff + first * phentsize)) != (ssize_t)bytes) return 0; + for (size_t i = 0; i < count; i++) { + const unsigned char *e = buf + i * phentsize; + uint32_t type = 0; + memcpy(&type, e, 4); + uint64_t off = 0, vaddr = 0, filesz = 0; + if (is_64) { + memcpy(&off, e + 8, 8); + memcpy(&vaddr, e + 16, 8); + memcpy(&filesz, e + 32, 8); + } else { + uint32_t v = 0; + memcpy(&v, e + 4, 4); off = v; + memcpy(&v, e + 8, 4); vaddr = v; + memcpy(&v, e + 16, 4); filesz = v; + } + if (type == 2 /* PT_DYNAMIC */) { + dyn_off = off; + dyn_size = filesz; + } else if (type == 1 /* PT_LOAD */ && loads < 16) { + load_vaddr[loads] = vaddr; + load_off[loads] = off; + load_size[loads] = filesz; + loads++; + } + } + } + if (dyn_size == 0 || dyn_off > (1ULL << 40)) return 0; + if (dyn_size > (1u << 20)) dyn_size = 1u << 20; + + size_t ent = is_64 ? 16 : 8; + uint64_t strtab = 0, runpath = 0, rpath = 0; + int has_strtab = 0, has_runpath = 0, has_rpath = 0, done = 0; + uint64_t needed_at[ELF_MAX_NEEDED]; + int nneeded = 0; + for (uint64_t at = 0; at + ent <= dyn_size && !done;) { + size_t want = dyn_size - at < sizeof(buf) ? (size_t)(dyn_size - at) : sizeof(buf); + want -= want % ent; + ssize_t got = pread(fd, buf, want, (off_t)(dyn_off + at)); + if (got < (ssize_t)ent) break; + for (size_t i = 0; i + ent <= (size_t)got; i += ent) { + int64_t tag = 0; + uint64_t val = 0; + if (is_64) { + memcpy(&tag, buf + i, 8); + memcpy(&val, buf + i + 8, 8); + } else { + int32_t tv = 0; + uint32_t vv = 0; + memcpy(&tv, buf + i, 4); + memcpy(&vv, buf + i + 4, 4); + tag = tv; + val = vv; + } + if (tag == 0 /* DT_NULL */) { done = 1; break; } + if (tag == 5 /* DT_STRTAB */) { strtab = val; has_strtab = 1; } + else if (tag == 29 /* DT_RUNPATH */) { runpath = val; has_runpath = 1; } + else if (tag == 15 /* DT_RPATH */) { rpath = val; has_rpath = 1; } + else if (tag == 1 /* DT_NEEDED */ && needed && nneeded < ELF_MAX_NEEDED) needed_at[nneeded++] = val; + } + at += (uint64_t)got - (uint64_t)got % ent; + } + if (!has_strtab || (!has_runpath && !has_rpath)) return 0; + uint64_t str_index = has_runpath ? runpath : rpath; + + // DT_STRTAB is an address: the file offset is that of the PT_LOAD segment holding it + uint64_t strtab_off = 0; + int mapped = 0; + for (int i = 0; i < loads; i++) { + if (strtab >= load_vaddr[i] && strtab - load_vaddr[i] < load_size[i]) { + strtab_off = load_off[i] + (strtab - load_vaddr[i]); + mapped = 1; + break; + } + } + if (!mapped || str_index > (1ULL << 32)) return 0; + if (needed && needed_count && needed_size > 0) { + size_t used = 0; + for (int i = 0; i < nneeded; i++) { + char name[256]; + ssize_t got = pread(fd, name, sizeof(name) - 1, (off_t)(strtab_off + needed_at[i])); + if (got <= 0) continue; + name[got] = '\0'; + size_t len = strnlen(name, (size_t)got); + if (len == 0 || len == (size_t)got || used + len + 1 > needed_size) continue; + memcpy(needed + used, name, len + 1); + used += len + 1; + (*needed_count)++; + } + } + ssize_t len = pread(fd, out, outsz - 1, (off_t)(strtab_off + str_index)); + if (len <= 0) { + out[0] = '\0'; + return 0; + } + out[len] = '\0'; + if (strnlen(out, (size_t)len) == (size_t)len) { + // Longer than `out`: its whole entries up to there + char *last = strrchr(out, ':'); + if (!last) { + out[0] = '\0'; + return 0; + } + *last = '\0'; + } + if (out[0] == '\0') return 0; + return has_runpath ? 1 : 2; +} + +// Appends dir[0..len) to the ':'-separated out_buf[0..used) unless it is there already. +static size_t append_lib_dir(char *out_buf, size_t out_size, size_t used, const char *dir, size_t len) { + if (len == 0 || lib_dir_list_has(out_buf, dir, len)) return used; + size_t need = (used > 0 ? 1 : 0) + len; + if (used + need >= out_size) return used; + if (used > 0) out_buf[used++] = ':'; + memcpy(out_buf + used, dir, len); + used += len; + out_buf[used] = '\0'; + return used; +} + +// The directories of `runpath` (a DT_RUNPATH or DT_RPATH), in their order, appended to +// out_buf[0..used): the absolute ones that lie in the rootfs mapped into it, and those that start +// with $ORIGIN with it replaced by the directory of `exe` (the program's real path, in the rootfs +// already), so that both keep their places. ld.so opens them itself, without the hook, so +// /usr/lib/aarch64-linux-gnu/android would be looked for in Android's tree. Others ($LIB, +// $PLATFORM, directories outside the rootfs) are left to ld.so. Returns the new length. +static size_t append_runpath_dirs(char *out_buf, size_t out_size, size_t used, const char *runpath, const char *exe) { + size_t origin_len = 0; + if (exe) { + const char *slash = strrchr(exe, '/'); + if (slash) origin_len = slash > exe ? (size_t)(slash - exe) : 1; + } + for (const char *p = runpath; p && *p;) { + const char *end = strchr(p, ':'); + size_t len = end ? (size_t)(end - p) : strlen(p); + if (len > 0 && len < PATH_MAX) { + char tok[PATH_MAX]; + memcpy(tok, p, len); + tok[len] = '\0'; + size_t skip = 0; + if (strncmp(tok, "$ORIGIN", 7) == 0) skip = 7; + else if (strncmp(tok, "${ORIGIN}", 9) == 0) skip = 9; + if (skip && (tok[skip] == '\0' || tok[skip] == '/') && origin_len > 0 && !strchr(tok + skip, '$')) { + char full[PATH_MAX]; + size_t rest = len - skip; + if (origin_len + rest < sizeof(full)) { + memcpy(full, exe, origin_len); + memcpy(full + origin_len, tok + skip, rest); + full[origin_len + rest] = '\0'; + used = append_lib_dir(out_buf, out_size, used, full, origin_len + rest); + } + } else if (tok[0] == '/' && len > 1 && !strchr(tok, '$')) { + char rw_buf[PATH_MAX]; + const char *rw = rewrite_path_in_root(tok, rw_buf, sizeof(rw_buf)); + if (strcmp(rw, tok) != 0) used = append_lib_dir(out_buf, out_size, used, rw, strlen(rw)); + } + } + if (!end) break; + p = end + 1; + } + return used; +} + +// Whether dir[0..len) is one of the rootfs library directories The native userland adds itself (also what its +// shells export in LD_LIBRARY_PATH). +static int is_rootfs_default_lib_dir(const char *dir, size_t len) { + if (len <= g_ddnatv_root_len || memcmp(dir, g_ddnatv_root, g_ddnatv_root_len) != 0) return 0; + const char *rel = dir + g_ddnatv_root_len; + size_t rel_len = len - g_ddnatv_root_len; + for (size_t i = 0; i < sizeof(k_rootfs_lib_dirs) / sizeof(k_rootfs_lib_dirs[0]); i++) { + if (strlen(k_rootfs_lib_dirs[i]) == rel_len && memcmp(k_rootfs_lib_dirs[i], rel, rel_len) == 0) return 1; + } + return 0; +} + +// Where the program is among the arguments of ld.so started directly (ldd runs "ld.so PROGRAM" with +// LD_TRACE_LOADED_OBJECTS set; "ld.so --list PROGRAM" and "ld.so --verify PROGRAM" are the same): its +// index, or -1 when there is none; *has_library_path says whether the caller gives --library-path itself. +static int ldso_program_index(char *const argv[], int *has_library_path) { + if (has_library_path) *has_library_path = 0; + if (!argv || !argv[0]) return -1; + static const char *const with_value[] = { "--library-path", "--preload", "--argv0", "--inhibit-rpath", "--audit", + "--glibc-hwcaps-prepend", "--glibc-hwcaps-mask" }; + for (int i = 1; argv[i]; i++) { + const char *a = argv[i]; + if (strcmp(a, "--library-path") == 0 && has_library_path) *has_library_path = 1; + if (a[0] != '-' || a[1] != '-') return i; + if (a[2] == '\0') return argv[i + 1] ? i + 1 : -1; + int takes_value = 0; + for (size_t k = 0; k < sizeof(with_value) / sizeof(with_value[0]); k++) { + if (strcmp(a, with_value[k]) == 0) takes_value = 1; + } + if (takes_value) { + if (!argv[i + 1]) return -1; + i++; + } + } + return -1; +} + +// ---- dlopen() of a library with a RUNPATH --------------------------------------------------- +// A library that a program loads with dlopen() looks for its own dependencies in its RUNPATH, which ld.so +// opens without the hook: PulseAudio's modules (RUNPATH /usr/lib/aarch64-linux-gnu/pulseaudio) and many +// plugins did not load. Before the real dlopen(), the dependencies found in the rootfs copies of those +// directories are loaded by their full path, depth first; ld.so then finds them loaded, by their name. +#define DLOPEN_PRELOAD_DEPTH 6 + +static int dlopen_preload_deps(const char *path, void *(*orig_dlopen)(const char *, int), int depth) { + if (depth > DLOPEN_PRELOAD_DEPTH || !path || path[0] != '/') return 0; + int fd = (int)syscall(SYS_openat, AT_FDCWD, path, O_RDONLY | O_CLOEXEC); + if (fd < 0) return 0; + unsigned char hdr[64]; + ssize_t n = pread(fd, hdr, sizeof(hdr), 0); + char runpath[1024]; + char needed[4096]; + int count = 0; + int kind = n > 0 ? elf_read_dynamic(fd, hdr, n, runpath, sizeof(runpath), needed, sizeof(needed), &count) : 0; + syscall(SYS_close, fd); + if (!kind || count == 0) return 0; + // the RUNPATH's directories, mapped into the rootfs ($ORIGIN from this library's own place) + char dirs[PATH_MAX * 2]; + dirs[0] = '\0'; + size_t used = append_runpath_dirs(dirs, sizeof(dirs), 0, runpath, path); + if (used == 0) return 0; + int loaded = 0; + const char *name = needed; + for (int i = 0; i < count; i++, name += strlen(name) + 1) { + if (strchr(name, '/')) continue; + void *already = orig_dlopen(name, RTLD_LAZY | RTLD_NOLOAD); + if (already) { + dlclose(already); + continue; + } + for (const char *p = dirs; *p;) { + const char *end = strchr(p, ':'); + size_t len = end ? (size_t)(end - p) : strlen(p); + char candidate[PATH_MAX]; + if (len + 1 + strlen(name) < sizeof(candidate)) { + memcpy(candidate, p, len); + candidate[len] = '/'; + strcpy(candidate + len + 1, name); + int probe_fd = (int)syscall(SYS_openat, AT_FDCWD, candidate, O_PATH | O_CLOEXEC); + if (probe_fd >= 0) { + syscall(SYS_close, probe_fd); + dlopen_preload_deps(candidate, orig_dlopen, depth + 1); + if (orig_dlopen(candidate, RTLD_LAZY | RTLD_LOCAL)) loaded++; + break; + } + } + if (!end) break; + p = end + 1; + } + } + return loaded; +} + +// ---- /etc/ld.so.conf ------------------------------------------------------------------------- +// The library directories of /etc/ld.so.conf and the files it includes (/etc/ld.so.conf.d/*.conf), +// mapped into the rootfs. On Linux, ldconfig turns them into /etc/ld.so.cache, which ld.so reads. +// Here ld.so would read Android's /etc/ld.so.cache, and the paths in the cache are not mapped into +// the rootfs either, so the exec hands the directories to ld.so in --library-path instead. They are +// read again only when /etc/ld.so.conf, /etc/ld.so.conf.d or /etc/ld.so.cache changes: a .conf file +// added or removed counts at once, an edit of one after ldconfig, as on Linux. +#define LDCONF_MAX_DEPTH 4 +#define LDCONF_MAX_INCLUDES 64 + +struct ldconf_sig { + int64_t t[6]; // mtimes (seconds, nanoseconds) of ld.so.conf, ld.so.conf.d and ld.so.cache; 0 if missing +}; + +static struct { + int valid; + struct ldconf_sig sig; + char root[PATH_MAX]; + char dirs[PATH_MAX * 2]; +} g_ldconf; +static pthread_mutex_t g_ldconf_lock = PTHREAD_MUTEX_INITIALIZER; + +// fstatat() behind the hook's stat emulation (which would map the hard link table in a child that is +// about to exec): only the times are wanted. +static int ldconf_stat_time(const char *real, int64_t *sec, int64_t *nsec) { + static int (*f)(int, const char *, struct stat64 *, int) = NULL; + int (*fn)(int, const char *, struct stat64 *, int) = __atomic_load_n(&f, __ATOMIC_RELAXED); + if (!fn) { + fn = (int (*)(int, const char *, struct stat64 *, int))dlsym(RTLD_NEXT, "fstatat64"); + if (!fn) return -1; + __atomic_store_n(&f, fn, __ATOMIC_RELAXED); + } + struct stat64 st; + if (fn(AT_FDCWD, real, &st, 0) != 0) return -1; + *sec = (int64_t)st.st_mtim.tv_sec; + *nsec = (int64_t)st.st_mtim.tv_nsec; + return 0; +} + +static void ldconf_signature(struct ldconf_sig *sig) { + static const char *const files[3] = { "/etc/ld.so.conf", "/etc/ld.so.conf.d", "/etc/ld.so.cache" }; + for (int i = 0; i < 3; i++) { + char path[PATH_MAX]; + size_t n = ddnatv_append(path, sizeof(path), 0, g_ddnatv_root, g_ddnatv_root_len); + ddnatv_append(path, sizeof(path), n, files[i], strlen(files[i])); + if (ldconf_stat_time(path, &sig->t[i * 2], &sig->t[i * 2 + 1]) != 0) { + sig->t[i * 2] = 0; + sig->t[i * 2 + 1] = 0; + } + } +} + +// The whole of the rootfs file `logical` (an absolute path inside Ubuntu) into buf, NUL-terminated. +static ssize_t ldconf_read(const char *logical, char *buf, size_t bufsz) { + char rw_buf[PATH_MAX]; + const char *real = rewrite_path_in_root(logical, rw_buf, sizeof(rw_buf)); + int fd = (int)syscall(SYS_openat, AT_FDCWD, real, O_RDONLY | O_CLOEXEC); + if (fd < 0) return -1; + size_t got = 0; + while (got + 1 < bufsz) { + ssize_t n = (ssize_t)syscall(SYS_read, fd, buf + got, bufsz - 1 - got); + if (n <= 0) break; + got += (size_t)n; + } + syscall(SYS_close, fd); + buf[got] = '\0'; + return (ssize_t)got; +} + +static int ldconf_name_cmp(const void *a, const void *b) { + return strcmp(*(const char *const *)a, *(const char *const *)b); +} + +static void ldconf_parse_file(const char *logical, char *out, size_t outsz, size_t *used, int depth, int *includes); + +// include PATTERN: the files of one directory that match a shell pattern, in name order (as glob()). +// Patterns in the directory part are not supported (Ubuntu uses /etc/ld.so.conf.d/*.conf). +static void ldconf_include(const char *pattern, char *out, size_t outsz, size_t *used, int depth, int *includes) { + const char *slash = strrchr(pattern, '/'); + if (!slash || slash == pattern) return; + size_t dir_len = (size_t)(slash - pattern); + if (dir_len >= PATH_MAX || memchr(pattern, '*', dir_len) || memchr(pattern, '?', dir_len) || memchr(pattern, '[', dir_len)) return; + char dir[PATH_MAX]; + memcpy(dir, pattern, dir_len); + dir[dir_len] = '\0'; + const char *name_pattern = slash + 1; + if (!strpbrk(name_pattern, "*?[")) { + ldconf_parse_file(pattern, out, outsz, used, depth + 1, includes); + return; + } + char rw_buf[PATH_MAX]; + const char *real = rewrite_path_in_root(dir, rw_buf, sizeof(rw_buf)); + int fd = (int)syscall(SYS_openat, AT_FDCWD, real, O_RDONLY | O_DIRECTORY | O_CLOEXEC); + if (fd < 0) return; + char names_buf[4096]; + char *names[LDCONF_MAX_INCLUDES]; + int count = 0; + size_t names_used = 0; + char dents[4096]; + for (;;) { + long n = syscall(SYS_getdents64, fd, dents, sizeof(dents)); + if (n <= 0) break; + for (long at = 0; at < n;) { + unsigned short reclen; + memcpy(&reclen, dents + at + 16, sizeof(reclen)); + const char *name = dents + at + 19; + if (reclen == 0) break; + size_t len = strnlen(name, (size_t)reclen - 19); + if (count < LDCONF_MAX_INCLUDES && names_used + len + 1 <= sizeof(names_buf) && + fnmatch(name_pattern, name, FNM_PERIOD) == 0) { + memcpy(names_buf + names_used, name, len + 1); + names[count++] = names_buf + names_used; + names_used += len + 1; + } + at += reclen; + } + } + syscall(SYS_close, fd); + qsort(names, (size_t)count, sizeof(names[0]), ldconf_name_cmp); + for (int i = 0; i < count; i++) { + char file[PATH_MAX]; + if (dir_len + 1 + strlen(names[i]) >= sizeof(file)) continue; + snprintf(file, sizeof(file), "%s/%s", dir, names[i]); + ldconf_parse_file(file, out, outsz, used, depth + 1, includes); + } +} + +// One ld.so.conf-style file: a directory per line, "include PATTERN..." (relative to the file's own +// directory), "#" comments, and the old "hwcap" lines, which are skipped as glibc does. +static void ldconf_parse_file(const char *logical, char *out, size_t outsz, size_t *used, int depth, int *includes) { + if (depth > LDCONF_MAX_DEPTH || ++*includes > LDCONF_MAX_INCLUDES) return; + char text[8192]; + if (ldconf_read(logical, text, sizeof(text)) < 0) return; + for (char *line = text; line && *line;) { + char *next = strchr(line, '\n'); + if (next) *next++ = '\0'; + char *hash = strchr(line, '#'); + if (hash) *hash = '\0'; + while (*line == ' ' || *line == '\t' || *line == '\r') line++; + size_t len = strlen(line); + while (len > 0 && (line[len - 1] == ' ' || line[len - 1] == '\t' || line[len - 1] == '\r')) line[--len] = '\0'; + if (len == 0) { + line = next; + continue; + } + if (strncmp(line, "include", 7) == 0 && (line[7] == ' ' || line[7] == '\t')) { + for (char *p = line + 8; *p;) { + while (*p == ' ' || *p == '\t') p++; + if (!*p) break; + char *end = p; + while (*end && *end != ' ' && *end != '\t') end++; + char saved = *end; + *end = '\0'; + char pattern[PATH_MAX]; + if (p[0] == '/') { + snprintf(pattern, sizeof(pattern), "%s", p); + } else { + const char *slash = strrchr(logical, '/'); + int base = slash ? (int)(slash - logical) : 0; + snprintf(pattern, sizeof(pattern), "%.*s/%s", base, logical, p); + } + ldconf_include(pattern, out, outsz, used, depth, includes); + *end = saved; + p = end; + } + } else if (strncmp(line, "hwcap", 5) == 0 && (line[5] == ' ' || line[5] == '\t')) { + // ignored by ldconfig since glibc 2.37 + } else if (line[0] == '/') { + // "DIR" or the old "DIR=TYPE" / "DIR TYPE" + size_t dlen = strcspn(line, "= \t"); + while (dlen > 1 && line[dlen - 1] == '/') dlen--; + if (dlen > 0 && dlen < PATH_MAX) { + char dir[PATH_MAX]; + memcpy(dir, line, dlen); + dir[dlen] = '\0'; + char rw_buf[PATH_MAX]; + const char *rw = rewrite_path_in_root(dir, rw_buf, sizeof(rw_buf)); + if (strcmp(rw, dir) != 0) *used = append_lib_dir(out, outsz, *used, rw, strlen(rw)); + } + } + line = next; + } +} + +static void ldconf_parse(char *out, size_t outsz) { + out[0] = '\0'; + size_t used = 0; + int includes = 0; + ldconf_parse_file("/etc/ld.so.conf", out, outsz, &used, 0, &includes); +} + +// The ld.so.conf directories into out (':'-separated, "" when there are none). Uses the copy of an +// earlier call while the files have not changed: the parent finds it when it first forks, and its +// children only compare the three times. Never waits for the lock: a child forked while another +// thread held it reads the files itself. +static void ldconf_dirs(char *out, size_t outsz) { + if (!out || outsz == 0) return; + out[0] = '\0'; + if (g_ddnatv_root[0] == '\0') return; + struct ldconf_sig sig; + ldconf_signature(&sig); + if (sig.t[0] == 0 && sig.t[1] == 0) return; // neither ld.so.conf nor ld.so.conf.d + if (pthread_mutex_trylock(&g_ldconf_lock) != 0) { + ldconf_parse(out, outsz); + return; + } + if (!g_ldconf.valid || memcmp(&g_ldconf.sig, &sig, sizeof(sig)) != 0 || strcmp(g_ldconf.root, g_ddnatv_root) != 0) { + ldconf_parse(g_ldconf.dirs, sizeof(g_ldconf.dirs)); + g_ldconf.sig = sig; + snprintf(g_ldconf.root, sizeof(g_ldconf.root), "%s", g_ddnatv_root); + g_ldconf.valid = 1; + } + snprintf(out, outsz, "%s", g_ldconf.dirs); + pthread_mutex_unlock(&g_ldconf_lock); +} + +// The --library-path ld.so is given for the rootfs program `exe`, in the order ld.so searches on +// Linux: the program's RPATH, the caller's LD_LIBRARY_PATH (the rootfs paths in it mapped), its +// RUNPATH, the directories of /etc/ld.so.conf (ld.so's cache), and the rootfs defaults last. The native userland's +// shells export the defaults in LD_LIBRARY_PATH too, where Linux has none; when there is anything to +// put before them they move to the end, so that a library the program keeps for itself wins over +// one of the same name in /usr/lib. Runs after the hook's setup, so the +// rewrites are those of rewrite_path(). +static void build_ld_library_path(char *const envp[], const char *runpath, int is_rpath, const char *exe, + char *out_buf, size_t out_size) { + if (!out_buf || out_size == 0) return; + out_buf[0] = '\0'; + + const char *caller_ld = NULL; + if (envp) { + for (int i = 0; envp[i] != NULL; i++) { + if (envp[i][0] == 'L' && strncmp(envp[i], "LD_LIBRARY_PATH=", 16) == 0) { + caller_ld = envp[i] + 16; + break; + } + } + } + if (!caller_ld) { + caller_ld = getenv("LD_LIBRARY_PATH"); + } + int has_runpath = runpath && runpath[0]; + char conf[PATH_MAX * 2]; + ldconf_dirs(conf, sizeof(conf)); + // The rootfs defaults that The native userland's shells export in LD_LIBRARY_PATH go to the end, after the + // program's and ld.so.conf's own directories, as on Linux (where LD_LIBRARY_PATH has none of them) + int move_defaults = has_runpath || conf[0] != '\0'; + + size_t used = 0; + if (has_runpath && is_rpath) used = append_runpath_dirs(out_buf, out_size, used, runpath, exe); + + // The caller's directories (those inside the rootfs rewritten), written straight into out_buf: + // this runs in nearly every child a shell forks, where two 8 KB copies of the list on the stack + // were pages more to copy before the exec. + size_t cap = used + PATH_MAX * 2 < out_size ? used + PATH_MAX * 2 : out_size; // the caller's part, as before + for (const char *p = caller_ld; p && *p;) { + const char *end = strchr(p, ':'); + size_t len = end ? (size_t)(end - p) : strlen(p); + if (len > 0 && len < PATH_MAX) { + char tok[PATH_MAX]; + memcpy(tok, p, len); + tok[len] = '\0'; + char rw_buf[PATH_MAX]; + const char *rw = (tok[0] == '/') ? rewrite_path_in_root(tok, rw_buf, sizeof(rw_buf)) : tok; + size_t rw_len = strlen(rw); + size_t need = (used > 0 ? 1 : 0) + rw_len; + if (move_defaults && is_rootfs_default_lib_dir(rw, rw_len)) { + // after the program's own directories, with the other defaults + } else if (used + need < cap) { + if (used > 0) out_buf[used++] = ':'; + memcpy(out_buf + used, rw, rw_len); + used += rw_len; + out_buf[used] = '\0'; + } + } + if (!end) break; + p = end + 1; + } + if (has_runpath && !is_rpath) used = append_runpath_dirs(out_buf, out_size, used, runpath, exe); + // ld.so.conf, as ld.so's cache: after LD_LIBRARY_PATH and RUNPATH, before the default directories + for (const char *p = conf; *p;) { + const char *end = strchr(p, ':'); + size_t len = end ? (size_t)(end - p) : strlen(p); + used = append_lib_dir(out_buf, out_size, used, p, len); + if (!end) break; + p = end + 1; + } + append_rootfs_lib_dirs_missing_from(out_buf, out_size, used, used > 0, out_buf); +} + +// fstat() without the hook's stat emulation: the probe wants the mode bits only, and the +// emulation would map the hard link table and look up the app's ids in a child that is about to +// exec (new pages there, each a copy-on-write fault). Resolved by prepare_exec_in_parent() when the +// process forks, so that its children find it set. +static int (*g_probe_fstat)(int, struct stat *) = NULL; + +static int probe_fstat(int fd, struct stat *st) { + int (*f)(int, struct stat *) = __atomic_load_n(&g_probe_fstat, __ATOMIC_RELAXED); + if (!f) { + f = (int (*)(int, struct stat *))dlsym(RTLD_NEXT, "fstat"); + if (!f) return fstat(fd, st); + __atomic_store_n(&g_probe_fstat, f, __ATOMIC_RELAXED); + } + return f(fd, st); +} + +static void probe_exec_file(const char *path, struct exec_probe *p) { + p->hdr[0] = '\0'; + p->n = -1; + p->is_elf = 0; + p->is_dynamic = 0; + p->android_interp = 0; + p->e_machine = 0; + p->mode = 0; + p->runpath[0] = '\0'; + p->runpath_is_rpath = 0; + if (!path || path[0] == '\0') return; + int fd = open(path, O_RDONLY | O_CLOEXEC); + if (fd < 0) return; + ssize_t n = read(fd, p->hdr, sizeof(p->hdr) - 1); + p->n = n; + p->hdr[n > 0 ? n : 0] = '\0'; + const unsigned char *h = (const unsigned char *)p->hdr; + if (n >= 4 && h[0] == 0x7f && h[1] == 'E' && h[2] == 'L' && h[3] == 'F') { + p->is_elf = 1; + if (n >= 20) p->e_machine = (uint16_t)(h[18] | (h[19] << 8)); + int dynamic = elf_interp_in_buffer(h, n); + if (dynamic < 0) dynamic = check_elf_dynamic(fd, h, n); + p->is_dynamic = dynamic; + if (dynamic && p->e_machine == 183 /* EM_AARCH64 */) p->android_interp = elf_interp_is_android(fd, h, n); + if (dynamic && !p->android_interp) p->runpath_is_rpath = elf_read_runpath(fd, h, n, p->runpath, sizeof(p->runpath)) == 2; + struct stat st; + if (dynamic && probe_fstat(fd, &st) == 0) p->mode = st.st_mode; + } + close(fd); +} + +static int is_ld_linux(const char *path) { + if (!path) return 0; + const char *base = strrchr(path, '/'); + base = base ? base + 1 : path; + return (strncmp(base, "ld-linux", 8) == 0 || strncmp(base, "ld-2.", 5) == 0); +} + +// Splits a "#!" line (NUL-terminated `hdr`, modified in place) into the interpreter and its +// optional argument, the way execve() always has. +static void parse_shebang(char *hdr, char **interp, char **interp_arg) { + char *newline = strchr(hdr, '\n'); + if (newline) *newline = '\0'; + char *p = hdr + 2; + while (*p == ' ' || *p == '\t') p++; + char *arg = strchr(p, ' '); + if (arg) { + *arg = '\0'; + arg++; + while (*arg == ' ' || *arg == '\t') arg++; + } + *interp = p; + *interp_arg = arg; +} + +// Interpreters outside the rootfs (Android's /system/bin/sh) run with Android's environment. +static int is_host_interpreter(const char *interp) { + return strncmp(interp, "/system", 7) == 0 || + (g_ddnatv_root[0] != '\0' && strncmp(interp, g_ddnatv_root, g_ddnatv_root_len) != 0); +} + +// argv for running `script` with its interpreter: interp [arg] script args... (the script's own +// argv[0] is dropped, as the kernel does). free() the result. +static char **build_script_argv(const char *interp, const char *interp_arg, const char *script, char *const argv[]) { + int argc = 0; + while (argv && argv[argc]) argc++; + int has_arg = (interp_arg && *interp_arg) ? 1 : 0; + char **v = (char **)calloc(argc + has_arg + 3, sizeof(char *)); + if (!v) return NULL; + int n = 0; + v[n++] = (char *)interp; + if (has_arg) v[n++] = (char *)interp_arg; + v[n++] = (char *)script; + for (int i = 1; i < argc; i++) v[n++] = argv[i]; + v[n] = NULL; + return v; +} + +// argv for "ld.so [--preload hook] --library-path dirs --argv0 name program args...". +// free() the result; the strings stay owned by the caller. +static char **build_ldso_argv(const char *ld_so, const char *hook, const char *lib_path, + const char *program, const char *prog_name, char *const argv[]) { + int argc = 0; + while (argv && argv[argc]) argc++; + char **v = (char **)calloc(argc + 16, sizeof(char *)); + if (!v) return NULL; + int n = 0; + v[n++] = (char *)ld_so; + if (hook) { + v[n++] = (char *)"--preload"; + v[n++] = (char *)hook; + } + v[n++] = (char *)"--library-path"; + v[n++] = (char *)lib_path; + v[n++] = (char *)"--argv0"; + v[n++] = (char *)((argc > 0 && argv[0]) ? argv[0] : prog_name); + v[n++] = (char *)program; + for (int i = 1; i < argc; i++) v[n++] = argv[i]; + v[n] = NULL; + return v; +} + +// POSIX_SPAWN_RESETIDS makes glibc's spawn child call setresuid() and setresgid() after it has reset +// every signal handler to its default, which includes the SIGSYS handler that emulates the calls +// Android's seccomp filter blocks, so the child died of SIGSYS (GNU make asks for the flag on every +// command it starts). The native userland shows one fixed user id and never runs set-user-id programs: there is +// no id to reset, so the flag is left out and everything else is passed on. +static const posix_spawnattr_t *spawn_attr_for_android(const posix_spawnattr_t *attrp, posix_spawnattr_t *copy) { + short flags = 0; + if (!attrp || posix_spawnattr_getflags(attrp, &flags) != 0 || !(flags & POSIX_SPAWN_RESETIDS)) return attrp; + memcpy(copy, attrp, sizeof(*copy)); + posix_spawnattr_setflags(copy, (short)(flags & ~POSIX_SPAWN_RESETIDS)); + return copy; +} diff --git a/tools/nativeguest/hook/fileops.c b/tools/nativeguest/hook/fileops.c new file mode 100644 index 0000000000..9d0ff7cf9d --- /dev/null +++ b/tools/nativeguest/hook/fileops.c @@ -0,0 +1,805 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Other file operations: access, chmod, unlink, mkdir, rename, readlink, extended attributes, +// links, times, truncate, statfs, the working directory, realpath and scandir. + +#ifndef DDNATV_HOST_TEST + +// Hook faccessat +int faccessat(int dirfd, const char *pathname, int mode, int flags) { + init_ddnatv_hook(); + if (!pathname) { + errno = EFAULT; + return -1; + } + DDNATV_AT_REMAP(dirfd, pathname); + + struct stat st; + int stat_flags = (flags & AT_SYMLINK_NOFOLLOW) ? AT_SYMLINK_NOFOLLOW : 0; + if (fstatat(dirfd, pathname, &st, stat_flags) != 0) { + return -1; + } + + if (mode == F_OK) { + return 0; + } + + if (mode & X_OK) { + if (S_ISDIR(st.st_mode)) return 0; + if ((st.st_mode & 0111) != 0) return 0; + if (strstr(pathname, "/bin/") || strstr(pathname, "/sbin/")) return 0; + errno = EACCES; + return -1; + } + + return 0; +} + +int faccessat2(int dirfd, const char *pathname, int mode, int flags) { + return faccessat(dirfd, pathname, mode, flags); +} + +// Hook access +int access(const char *pathname, int mode) { + return faccessat(AT_FDCWD, pathname, mode, 0); +} + +// Hook euidaccess and eaccess +int euidaccess(const char *pathname, int mode) { + return faccessat(AT_FDCWD, pathname, mode, AT_EACCESS); +} + +int eaccess(const char *pathname, int mode) { + return faccessat(AT_FDCWD, pathname, mode, AT_EACCESS); +} + +// Hook chmod +int chmod(const char *pathname, mode_t mode) { + static int (*orig_chmod)(const char *, mode_t) = NULL; + if (!orig_chmod) orig_chmod = (int (*)(const char *, mode_t))dlsym(RTLD_NEXT, "chmod"); + if (!orig_chmod) return -1; + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(pathname, buf, sizeof(buf)); + int ret = orig_chmod(target, mode); + if (ret != 0 && ((mode & 06000) != 0 || errno == EPERM || errno == EACCES || errno == ENOSYS)) { + ret = orig_chmod(target, mode & 01777); + } + if (ret != 0 && (errno == EPERM || errno == EACCES)) { + errno = 0; + return 0; + } + return ret; +} + +// Hook fchmod +int fchmod(int fd, mode_t mode) { + static int (*orig_fchmod)(int, mode_t) = NULL; + if (!orig_fchmod) orig_fchmod = (int (*)(int, mode_t))dlsym(RTLD_NEXT, "fchmod"); + if (!orig_fchmod) return -1; + int ret = orig_fchmod(fd, mode); + if (ret != 0 && ((mode & 06000) != 0 || errno == EPERM || errno == EACCES || errno == ENOSYS)) { + ret = orig_fchmod(fd, mode & 01777); + } + if (ret != 0 && (errno == EPERM || errno == EACCES)) { + errno = 0; + return 0; + } + return ret; +} + +// Hook fchmodat +int fchmodat(int dirfd, const char *pathname, mode_t mode, int flags) { + static int (*orig_fchmodat)(int, const char *, mode_t, int) = NULL; + if (!orig_fchmodat) orig_fchmodat = (int (*)(int, const char *, mode_t, int))dlsym(RTLD_NEXT, "fchmodat"); + if (!orig_fchmodat) return -1; + DDNATV_AT_REMAP(dirfd, pathname); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + int ret = orig_fchmodat(dirfd, target, mode, flags); + if (ret != 0 && ((mode & 06000) != 0 || errno == EPERM || errno == EACCES || errno == ENOSYS)) { + ret = orig_fchmodat(dirfd, target, mode & 01777, flags); + } + if (ret != 0 && (errno == EPERM || errno == EACCES)) { + errno = 0; + return 0; + } + return ret; +} + +// Hook unlink +int unlink(const char *pathname) { + static int (*orig_unlink)(const char *) = NULL; + if (!orig_unlink) orig_unlink = (int (*)(const char *))dlsym(RTLD_NEXT, "unlink"); + char buf[PATH_MAX]; + const char *target = rewrite_path(pathname, buf, sizeof(buf)); + unlink_mapped_unix_socket(target); + dev_t hl_dev = 0; + ino_t hl_ino = 0; + int hardlinked = lookup_emulated_hardlink_at(AT_FDCWD, target, &hl_dev, &hl_ino); + int ret = orig_unlink(target); + if (ret != 0 && refused_in_repaired_dir(AT_FDCWD, target)) { + // The name could not be looked up while its directory was closed + hardlinked = lookup_emulated_hardlink_at(AT_FDCWD, target, &hl_dev, &hl_ino); + ret = orig_unlink(target); + } + if (ret == 0 && hardlinked) unregister_emulated_hardlink(hl_dev, hl_ino); + return ret; +} + +// Hook unlinkat +int unlinkat(int dirfd, const char *pathname, int flags) { + static int (*orig_unlinkat)(int, const char *, int) = NULL; + if (!orig_unlinkat) orig_unlinkat = (int (*)(int, const char *, int))dlsym(RTLD_NEXT, "unlinkat"); + DDNATV_AT_REMAP(dirfd, pathname); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + dev_t hl_dev = 0; + ino_t hl_ino = 0; + int hardlinked = 0; + if (target) { + unlink_mapped_unix_socket(target); + hardlinked = lookup_emulated_hardlink_at(dirfd, target, &hl_dev, &hl_ino); + } + int ret = orig_unlinkat ? orig_unlinkat(dirfd, target, flags) : -1; + if (ret != 0 && orig_unlinkat && refused_in_repaired_dir(dirfd, target)) { + hardlinked = target ? lookup_emulated_hardlink_at(dirfd, target, &hl_dev, &hl_ino) : 0; + ret = orig_unlinkat(dirfd, target, flags); + } + if (ret == 0 && hardlinked) unregister_emulated_hardlink(hl_dev, hl_ino); + return ret; +} + +// Hook rmdir +int rmdir(const char *pathname) { + static int (*orig_rmdir)(const char *) = NULL; + if (!orig_rmdir) orig_rmdir = (int (*)(const char *))dlsym(RTLD_NEXT, "rmdir"); + char buf[PATH_MAX]; + const char *target = rewrite_path(pathname, buf, sizeof(buf)); + int ret = orig_rmdir(target); + if (ret != 0 && refused_in_repaired_dir(AT_FDCWD, target)) ret = orig_rmdir(target); + return ret; +} + +// glibc's remove() calls its internal unlinkat, which no preload can see: GLib's g_file_delete() +// got ENOENT for every guest path, and Flatpak could not replace an app's "current" link +int remove(const char *pathname) { + if (unlink(pathname) == 0) return 0; + if (errno != EISDIR) return -1; + return rmdir(pathname); +} + +// glob() and nftw() walk directories with glibc's internal calls too. glob() is given the hook's +// own through GLOB_ALTDIRFUNC; nftw() walks the mapped directory and its callback is given guest paths. +static int glob_alt_stat(const char *path, void *st) { return stat(path, (struct stat *)st); } +static int glob_alt_lstat(const char *path, void *st) { return lstat(path, (struct stat *)st); } +static void *glob_alt_opendir(const char *path) { return opendir(path); } +static void *glob_alt_readdir(void *dir) { return readdir((DIR *)dir); } +static void glob_alt_closedir(void *dir) { closedir((DIR *)dir); } + +int glob(const char *pattern, int flags, int (*errfunc)(const char *, int), glob_t *pglob) { + static int (*orig_glob)(const char *, int, int (*)(const char *, int), glob_t *) = NULL; + if (!orig_glob) orig_glob = (int (*)(const char *, int, int (*)(const char *, int), glob_t *))dlsym(RTLD_NEXT, "glob"); + if (pglob && !(flags & GLOB_ALTDIRFUNC)) { + init_ddnatv_hook(); + pglob->gl_closedir = glob_alt_closedir; + pglob->gl_readdir = (struct dirent *(*)(void *))glob_alt_readdir; + pglob->gl_opendir = glob_alt_opendir; + pglob->gl_lstat = (int (*)(const char *, struct stat *))glob_alt_lstat; + pglob->gl_stat = (int (*)(const char *, struct stat *))glob_alt_stat; + flags |= GLOB_ALTDIRFUNC; + } + return orig_glob ? orig_glob(pattern, flags, errfunc, pglob) : GLOB_NOSPACE; +} + +int glob64(const char *pattern, int flags, int (*errfunc)(const char *, int), glob64_t *pglob) { + return glob(pattern, flags, errfunc, (glob_t *)pglob); +} + +static __thread struct { + const char *host, *guest; + size_t host_len, guest_len; + int (*nftw_fn)(const char *, const struct stat *, int, struct FTW *); + int (*ftw_fn)(const char *, const struct stat *, int); +} t_walk; + +static const char *walk_guest_path(const char *path, char *buf, size_t size, int *base) { + if (!t_walk.host || strncmp(path, t_walk.host, t_walk.host_len) != 0) return path; + const char *rest = path + t_walk.host_len; + if (*rest != '\0' && *rest != '/') return path; + // a walk of "/" gives "/etc", not "//etc" + size_t guest_len = (t_walk.guest_len == 1 && *rest == '/') ? 0 : t_walk.guest_len; + size_t n = ddnatv_append(buf, size, 0, t_walk.guest, guest_len); + ddnatv_append(buf, size, n, rest, strlen(rest)); + if (base) *base = *base - (int)t_walk.host_len + (int)guest_len; + return buf; +} + +static int walk_nftw_cb(const char *path, const struct stat *st, int type, struct FTW *ftwbuf) { + char buf[PATH_MAX]; + struct FTW guest_ftw = *ftwbuf; + return t_walk.nftw_fn(walk_guest_path(path, buf, sizeof(buf), &guest_ftw.base), st, type, &guest_ftw); +} + +static int walk_ftw_cb(const char *path, const struct stat *st, int type) { + char buf[PATH_MAX]; + return t_walk.ftw_fn(walk_guest_path(path, buf, sizeof(buf), NULL), st, type); +} + +int nftw(const char *dir, int (*fn)(const char *, const struct stat *, int, struct FTW *), int fds, int flags) { + static int (*orig_nftw)(const char *, int (*)(const char *, const struct stat *, int, struct FTW *), int, int) = NULL; + if (!orig_nftw) orig_nftw = (int (*)(const char *, int (*)(const char *, const struct stat *, int, struct FTW *), int, int))dlsym(RTLD_NEXT, "nftw"); + if (!orig_nftw) { errno = ENOSYS; return -1; } + char buf[PATH_MAX]; + const char *target = rewrite_path(dir, buf, sizeof(buf)); + if (target == dir || !fn) return orig_nftw(dir, fn, fds, flags); + __typeof__(t_walk) saved = t_walk; + t_walk.host = target; t_walk.host_len = strlen(target); + while (t_walk.host_len > 1 && target[t_walk.host_len - 1] == '/') t_walk.host_len--; + t_walk.guest = dir; t_walk.guest_len = strlen(dir); + while (t_walk.guest_len > 1 && dir[t_walk.guest_len - 1] == '/') t_walk.guest_len--; + t_walk.nftw_fn = fn; + int ret = orig_nftw(target, walk_nftw_cb, fds, flags); + t_walk = saved; + return ret; +} + +int nftw64(const char *dir, int (*fn)(const char *, const struct stat64 *, int, struct FTW *), int fds, int flags) { + return nftw(dir, (int (*)(const char *, const struct stat *, int, struct FTW *))fn, fds, flags); +} + +int ftw(const char *dir, int (*fn)(const char *, const struct stat *, int), int fds) { + static int (*orig_ftw)(const char *, int (*)(const char *, const struct stat *, int), int) = NULL; + if (!orig_ftw) orig_ftw = (int (*)(const char *, int (*)(const char *, const struct stat *, int), int))dlsym(RTLD_NEXT, "ftw"); + if (!orig_ftw) { errno = ENOSYS; return -1; } + char buf[PATH_MAX]; + const char *target = rewrite_path(dir, buf, sizeof(buf)); + if (target == dir || !fn) return orig_ftw(dir, fn, fds); + __typeof__(t_walk) saved = t_walk; + t_walk.host = target; t_walk.host_len = strlen(target); + while (t_walk.host_len > 1 && target[t_walk.host_len - 1] == '/') t_walk.host_len--; + t_walk.guest = dir; t_walk.guest_len = strlen(dir); + while (t_walk.guest_len > 1 && dir[t_walk.guest_len - 1] == '/') t_walk.guest_len--; + t_walk.ftw_fn = fn; + int ret = orig_ftw(target, walk_ftw_cb, fds); + t_walk = saved; + return ret; +} + +int ftw64(const char *dir, int (*fn)(const char *, const struct stat64 *, int), int fds) { + return ftw(dir, (int (*)(const char *, const struct stat *, int))fn, fds); +} + +// The app is root for the programs it runs, and root enters and writes every directory whatever its +// mode; the app does not. dpkg makes each new directory with mode 0 and sets the mode a moment later, +// and a chmod that fails is reported as done (see chmod), which left directories nobody could put a +// file in: "Permission denied" in /usr/share/applications and others (#44). So a directory always +// keeps its owner's read, write and search rights. +#define NEW_DIR_OWNER_RIGHTS S_IRWXU + +// Hook mkdir +int mkdir(const char *pathname, mode_t mode) { + static int (*orig_mkdir)(const char *, mode_t) = NULL; + if (!orig_mkdir) orig_mkdir = (int (*)(const char *, mode_t))dlsym(RTLD_NEXT, "mkdir"); + char buf[PATH_MAX]; + const char *target = rewrite_path(pathname, buf, sizeof(buf)); + int ret = orig_mkdir(target, mode | NEW_DIR_OWNER_RIGHTS); + if (ret != 0 && refused_in_repaired_dir(AT_FDCWD, target)) ret = orig_mkdir(target, mode | NEW_DIR_OWNER_RIGHTS); + return ret; +} + +// Hook mkdirat +int mkdirat(int dirfd, const char *pathname, mode_t mode) { + static int (*orig_mkdirat)(int, const char *, mode_t) = NULL; + if (!orig_mkdirat) orig_mkdirat = (int (*)(int, const char *, mode_t))dlsym(RTLD_NEXT, "mkdirat"); + DDNATV_AT_REMAP(dirfd, pathname); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + int ret = orig_mkdirat(dirfd, target, mode | NEW_DIR_OWNER_RIGHTS); + if (ret != 0 && refused_in_repaired_dir(dirfd, target)) ret = orig_mkdirat(dirfd, target, mode | NEW_DIR_OWNER_RIGHTS); + return ret; +} + +static void ensure_dir_exists(const char *path) { + if (!path || path[0] == '\0') return; + char tmp[PATH_MAX]; + strncpy(tmp, path, sizeof(tmp) - 1); + tmp[sizeof(tmp) - 1] = '\0'; + for (char *p = tmp + 1; *p; p++) { + if (*p == '/') { + *p = '\0'; + mkdir(tmp, 0755); + *p = '/'; + } + } + mkdir(tmp, 0755); +} + +// Hook inotify_add_watch +int inotify_add_watch(int fd, const char *pathname, uint32_t mask) { + static int (*orig_inotify_add_watch)(int, const char *, uint32_t) = NULL; + if (!orig_inotify_add_watch) orig_inotify_add_watch = (int (*)(int, const char *, uint32_t))dlsym(RTLD_NEXT, "inotify_add_watch"); + if (!pathname) return -1; + char buf[PATH_MAX]; + const char *target = rewrite_path(pathname, buf, sizeof(buf)); + if (!orig_inotify_add_watch) return -1; + int wd = orig_inotify_add_watch(fd, target, mask); + if (wd < 0 && errno == ENOENT && (mask & IN_ONLYDIR)) { + ensure_dir_exists(target); + wd = orig_inotify_add_watch(fd, target, mask); + } + return wd; +} + +// Hook rename +int rename(const char *oldpath, const char *newpath) { + static int (*orig_rename)(const char *, const char *) = NULL; + if (!orig_rename) orig_rename = (int (*)(const char *, const char *))dlsym(RTLD_NEXT, "rename"); + char buf1[PATH_MAX]; + char buf2[PATH_MAX]; + const char *target_old = rewrite_path(oldpath, buf1, sizeof(buf1)); + const char *target_new = rewrite_path(newpath, buf2, sizeof(buf2)); + dev_t hl_dev = 0; + ino_t hl_ino = 0; + int hardlinked = lookup_emulated_hardlink_at(AT_FDCWD, target_new, &hl_dev, &hl_ino); + int ret = orig_rename(target_old, target_new); + if (ret != 0 && errno == EACCES) { + // Both directories: the old name is taken out of one, the new put in the other + int refused = errno; + int fixed_old = refused_in_repaired_dir(AT_FDCWD, target_old); + errno = refused; + int fixed_new = refused_in_repaired_dir(AT_FDCWD, target_new); + if (fixed_old || fixed_new) { + hardlinked = lookup_emulated_hardlink_at(AT_FDCWD, target_new, &hl_dev, &hl_ino); + ret = orig_rename(target_old, target_new); + } + } + if (ret == 0 && hardlinked) unregister_emulated_hardlink(hl_dev, hl_ino); + return ret; +} + +// Hook renameat +int renameat(int olddirfd, const char *oldpath, int newdirfd, const char *newpath) { + static int (*orig_renameat)(int, const char *, int, const char *) = NULL; + if (!orig_renameat) orig_renameat = (int (*)(int, const char *, int, const char *))dlsym(RTLD_NEXT, "renameat"); + DDNATV_AT_REMAP_NAMED(olddirfd, oldpath, ddnatv_at_old); + DDNATV_AT_REMAP_NAMED(newdirfd, newpath, ddnatv_at_new); + char buf1[PATH_MAX]; + char buf2[PATH_MAX]; + const char *target_old = (oldpath && oldpath[0] == '/') ? rewrite_path(oldpath, buf1, sizeof(buf1)) : oldpath; + const char *target_new = (newpath && newpath[0] == '/') ? rewrite_path(newpath, buf2, sizeof(buf2)) : newpath; + dev_t hl_dev = 0; + ino_t hl_ino = 0; + int hardlinked = lookup_emulated_hardlink_at(newdirfd, target_new, &hl_dev, &hl_ino); + int ret = orig_renameat(olddirfd, target_old, newdirfd, target_new); + if (ret != 0 && errno == EACCES) { + int refused = errno; + int fixed_old = refused_in_repaired_dir(olddirfd, target_old); + errno = refused; + int fixed_new = refused_in_repaired_dir(newdirfd, target_new); + if (fixed_old || fixed_new) { + hardlinked = lookup_emulated_hardlink_at(newdirfd, target_new, &hl_dev, &hl_ino); + ret = orig_renameat(olddirfd, target_old, newdirfd, target_new); + } + } + if (ret == 0 && hardlinked) unregister_emulated_hardlink(hl_dev, hl_ino); + return ret; +} + +// Hook renameat2 +int renameat2(int olddirfd, const char *oldpath, int newdirfd, const char *newpath, unsigned int flags) { + static int (*orig_renameat2)(int, const char *, int, const char *, unsigned int) = NULL; + if (!orig_renameat2) { + orig_renameat2 = (int (*)(int, const char *, int, const char *, unsigned int))dlsym(RTLD_NEXT, "renameat2"); + if (!orig_renameat2) return renameat(olddirfd, oldpath, newdirfd, newpath); + } + DDNATV_AT_REMAP_NAMED(olddirfd, oldpath, ddnatv_at_old); + DDNATV_AT_REMAP_NAMED(newdirfd, newpath, ddnatv_at_new); + char buf1[PATH_MAX]; + char buf2[PATH_MAX]; + const char *target_old = (oldpath && oldpath[0] == '/') ? rewrite_path(oldpath, buf1, sizeof(buf1)) : oldpath; + const char *target_new = (newpath && newpath[0] == '/') ? rewrite_path(newpath, buf2, sizeof(buf2)) : newpath; + dev_t hl_dev = 0; + ino_t hl_ino = 0; + // RENAME_EXCHANGE keeps both files, so nothing is replaced. + int hardlinked = !(flags & RENAME_EXCHANGE) && lookup_emulated_hardlink_at(newdirfd, target_new, &hl_dev, &hl_ino); + int ret = orig_renameat2(olddirfd, target_old, newdirfd, target_new, flags); + if (ret != 0 && errno == EACCES) { + int refused = errno; + int fixed_old = refused_in_repaired_dir(olddirfd, target_old); + errno = refused; + int fixed_new = refused_in_repaired_dir(newdirfd, target_new); + if (fixed_old || fixed_new) { + hardlinked = !(flags & RENAME_EXCHANGE) && lookup_emulated_hardlink_at(newdirfd, target_new, &hl_dev, &hl_ino); + ret = orig_renameat2(olddirfd, target_old, newdirfd, target_new, flags); + } + } + if (ret == 0 && hardlinked) unregister_emulated_hardlink(hl_dev, hl_ino); + return ret; +} + +// Hook readlink +ssize_t readlink(const char *pathname, char *buf, size_t bufsiz) { + if (is_proc_self_exe(pathname)) { + ssize_t exe_len = handle_proc_self_exe(buf, bufsiz); + if (exe_len >= 0) return exe_len; + } + static ssize_t (*orig_readlink)(const char *, char *, size_t) = NULL; + if (!orig_readlink) orig_readlink = (ssize_t (*)(const char *, char *, size_t))dlsym(RTLD_NEXT, "readlink"); + char pbuf[PATH_MAX]; + const char *target = rewrite_path(pathname, pbuf, sizeof(pbuf)); + ssize_t ret = orig_readlink ? orig_readlink(target, buf, bufsiz) : -1; + if (ret < 0 && errno == ENOENT) { + char alt[PATH_MAX]; + const char *retry = usrmerge_retry_path(target, alt, sizeof(alt)); + if (retry) ret = orig_readlink(retry, buf, bufsiz); + } + return postprocess_readlink(pathname, buf, ret, bufsiz); +} + +// Hook readlinkat +ssize_t readlinkat(int dirfd, const char *pathname, char *buf, size_t bufsiz) { + static ssize_t (*orig_readlinkat)(int, const char *, char *, size_t) = NULL; + if (!orig_readlinkat) orig_readlinkat = (ssize_t (*)(int, const char *, char *, size_t))dlsym(RTLD_NEXT, "readlinkat"); + DDNATV_AT_REMAP(dirfd, pathname); + // after the remap: "proc/self/exe" relative to a descriptor for "/" is /proc/self/exe as well + if (is_proc_self_exe(pathname)) { + ssize_t exe_len = handle_proc_self_exe(buf, bufsiz); + if (exe_len >= 0) return exe_len; + } + char pbuf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? rewrite_path(pathname, pbuf, sizeof(pbuf)) : pathname; + ssize_t ret = orig_readlinkat ? orig_readlinkat(dirfd, target, buf, bufsiz) : -1; + if (ret < 0 && errno == ENOENT && pathname && pathname[0] == '/') { + char alt[PATH_MAX]; + const char *retry = usrmerge_retry_path(target, alt, sizeof(alt)); + if (retry) ret = orig_readlinkat(dirfd, retry, buf, bufsiz); + } + return postprocess_readlink(pathname, buf, ret, bufsiz); +} + +// Fortified readlink variants used by dpkg / update-alternatives +ssize_t __readlink_chk(const char *pathname, char *buf, size_t bufsiz, size_t buflen) { + return readlink(pathname, buf, bufsiz); +} + +ssize_t __readlinkat_chk(int dirfd, const char *pathname, char *buf, size_t bufsiz, size_t buflen) { + return readlinkat(dirfd, pathname, buf, bufsiz); +} + +// Ubuntu's programs find Android's SELinux (enforcing) through libselinux and then ask its policy +// questions it has no answers for. The one that mattered: PAM's pam_rootok, which lets root +// change its own entries, asks "may this user be root" and was refused, so chfn, chsh and +// `adduser --gecos` (the installation of PostgreSQL) failed with "PAM: Authentication failure". +// Ubuntu does not use SELinux, so for its programs it is off, as its labels are hidden below. +int is_selinux_enabled(void) { return 0; } + +// Extended attributes take the same paths as stat(). Without these hooks coreutils read +// security.selinux with the Ubuntu path itself: `ls -l` printed an error line for every file +// Android lacks (/etc/os-release) and showed Android's own label for the ones it has +// (/etc/passwd). Ubuntu does not use SELinux, so its label is hidden altogether: `ls -l` looks as +// on Ubuntu and cp/tar/rsync do not try to copy Android's labels. +ssize_t getxattr(const char *path, const char *name, void *value, size_t size) { + static ssize_t (*orig_getxattr)(const char *, const char *, void *, size_t) = NULL; + if (!orig_getxattr) orig_getxattr = (ssize_t (*)(const char *, const char *, void *, size_t))dlsym(RTLD_NEXT, "getxattr"); + if (is_selinux_xattr(name)) { + errno = ENODATA; + return -1; + } + char pbuf[PATH_MAX]; + return orig_getxattr ? orig_getxattr(rewrite_path_follow(path, pbuf, sizeof(pbuf)), name, value, size) : -1; +} + +ssize_t lgetxattr(const char *path, const char *name, void *value, size_t size) { + static ssize_t (*orig_lgetxattr)(const char *, const char *, void *, size_t) = NULL; + if (!orig_lgetxattr) orig_lgetxattr = (ssize_t (*)(const char *, const char *, void *, size_t))dlsym(RTLD_NEXT, "lgetxattr"); + if (is_selinux_xattr(name)) { + errno = ENODATA; + return -1; + } + char pbuf[PATH_MAX]; + return orig_lgetxattr ? orig_lgetxattr(rewrite_path(path, pbuf, sizeof(pbuf)), name, value, size) : -1; +} + +ssize_t listxattr(const char *path, char *list, size_t size) { + static ssize_t (*orig_listxattr)(const char *, char *, size_t) = NULL; + if (!orig_listxattr) orig_listxattr = (ssize_t (*)(const char *, char *, size_t))dlsym(RTLD_NEXT, "listxattr"); + char pbuf[PATH_MAX]; + ssize_t ret = orig_listxattr ? orig_listxattr(rewrite_path_follow(path, pbuf, sizeof(pbuf)), list, size) : -1; + return size > 0 ? drop_selinux_xattr(list, ret) : ret; +} + +ssize_t llistxattr(const char *path, char *list, size_t size) { + static ssize_t (*orig_llistxattr)(const char *, char *, size_t) = NULL; + if (!orig_llistxattr) orig_llistxattr = (ssize_t (*)(const char *, char *, size_t))dlsym(RTLD_NEXT, "llistxattr"); + char pbuf[PATH_MAX]; + ssize_t ret = orig_llistxattr ? orig_llistxattr(rewrite_path(path, pbuf, sizeof(pbuf)), list, size) : -1; + return size > 0 ? drop_selinux_xattr(list, ret) : ret; +} + +ssize_t fgetxattr(int fd, const char *name, void *value, size_t size) { + static ssize_t (*orig_fgetxattr)(int, const char *, void *, size_t) = NULL; + if (!orig_fgetxattr) orig_fgetxattr = (ssize_t (*)(int, const char *, void *, size_t))dlsym(RTLD_NEXT, "fgetxattr"); + if (is_selinux_xattr(name)) { + errno = ENODATA; + return -1; + } + return orig_fgetxattr ? orig_fgetxattr(fd, name, value, size) : -1; +} + +ssize_t flistxattr(int fd, char *list, size_t size) { + static ssize_t (*orig_flistxattr)(int, char *, size_t) = NULL; + if (!orig_flistxattr) orig_flistxattr = (ssize_t (*)(int, char *, size_t))dlsym(RTLD_NEXT, "flistxattr"); + ssize_t ret = orig_flistxattr ? orig_flistxattr(fd, list, size) : -1; + return size > 0 ? drop_selinux_xattr(list, ret) : ret; +} + +int setxattr(const char *path, const char *name, const void *value, size_t size, int flags) { + static int (*orig_setxattr)(const char *, const char *, const void *, size_t, int) = NULL; + if (!orig_setxattr) orig_setxattr = (int (*)(const char *, const char *, const void *, size_t, int))dlsym(RTLD_NEXT, "setxattr"); + char pbuf[PATH_MAX]; + return orig_setxattr ? orig_setxattr(rewrite_path_follow(path, pbuf, sizeof(pbuf)), name, value, size, flags) : -1; +} + +int lsetxattr(const char *path, const char *name, const void *value, size_t size, int flags) { + static int (*orig_lsetxattr)(const char *, const char *, const void *, size_t, int) = NULL; + if (!orig_lsetxattr) orig_lsetxattr = (int (*)(const char *, const char *, const void *, size_t, int))dlsym(RTLD_NEXT, "lsetxattr"); + char pbuf[PATH_MAX]; + return orig_lsetxattr ? orig_lsetxattr(rewrite_path(path, pbuf, sizeof(pbuf)), name, value, size, flags) : -1; +} + +int removexattr(const char *path, const char *name) { + static int (*orig_removexattr)(const char *, const char *) = NULL; + if (!orig_removexattr) orig_removexattr = (int (*)(const char *, const char *))dlsym(RTLD_NEXT, "removexattr"); + char pbuf[PATH_MAX]; + return orig_removexattr ? orig_removexattr(rewrite_path(path, pbuf, sizeof(pbuf)), name) : -1; +} + +int lremovexattr(const char *path, const char *name) { + static int (*orig_lremovexattr)(const char *, const char *) = NULL; + if (!orig_lremovexattr) orig_lremovexattr = (int (*)(const char *, const char *))dlsym(RTLD_NEXT, "lremovexattr"); + char pbuf[PATH_MAX]; + return orig_lremovexattr ? orig_lremovexattr(rewrite_path(path, pbuf, sizeof(pbuf)), name) : -1; +} + +// Hook symlink +int symlink(const char *target, const char *linkpath) { + static int (*orig_symlink)(const char *, const char *) = NULL; + if (!orig_symlink) orig_symlink = (int (*)(const char *, const char *))dlsym(RTLD_NEXT, "symlink"); + char pbuf[PATH_MAX], tbuf[PATH_MAX]; + const char *newlink = rewrite_path(linkpath, pbuf, sizeof(pbuf)); + const char *newtarget = (target && target[0] == '/') ? rewrite_path(target, tbuf, sizeof(tbuf)) : target; + int ret = orig_symlink ? orig_symlink(newtarget, newlink) : -1; + if (ret != 0 && orig_symlink && refused_in_repaired_dir(AT_FDCWD, newlink)) ret = orig_symlink(newtarget, newlink); + return ret; +} + +// Hook symlinkat +int symlinkat(const char *target, int newdirfd, const char *linkpath) { + static int (*orig_symlinkat)(const char *, int, const char *) = NULL; + if (!orig_symlinkat) orig_symlinkat = (int (*)(const char *, int, const char *))dlsym(RTLD_NEXT, "symlinkat"); + DDNATV_AT_REMAP(newdirfd, linkpath); + char pbuf[PATH_MAX], tbuf[PATH_MAX]; + const char *newlink = (linkpath && linkpath[0] == '/') ? rewrite_path(linkpath, pbuf, sizeof(pbuf)) : linkpath; + const char *newtarget = (target && target[0] == '/') ? rewrite_path(target, tbuf, sizeof(tbuf)) : target; + int ret = orig_symlinkat ? orig_symlinkat(newtarget, newdirfd, newlink) : -1; + if (ret != 0 && orig_symlinkat && refused_in_repaired_dir(newdirfd, newlink)) ret = orig_symlinkat(newtarget, newdirfd, newlink); + return ret; +} + +// Hook linkat +int linkat(int olddirfd, const char *oldpath, int newdirfd, const char *newpath, int flags) { + static int (*orig_linkat)(int, const char *, int, const char *, int) = NULL; + if (!orig_linkat) orig_linkat = (int (*)(int, const char *, int, const char *, int))dlsym(RTLD_NEXT, "linkat"); + DDNATV_AT_REMAP_NAMED(olddirfd, oldpath, ddnatv_at_old); + DDNATV_AT_REMAP_NAMED(newdirfd, newpath, ddnatv_at_new); + char obuf[PATH_MAX], nbuf[PATH_MAX]; + const char *rold = (oldpath && oldpath[0] == '/') ? rewrite_path(oldpath, obuf, sizeof(obuf)) : oldpath; + const char *rnew = (newpath && newpath[0] == '/') ? rewrite_path(newpath, nbuf, sizeof(nbuf)) : newpath; + int ret = orig_linkat ? orig_linkat(olddirfd, rold, newdirfd, rnew, flags) : -1; + if (ret != 0 && orig_linkat && refused_in_repaired_dir(newdirfd, rnew)) ret = orig_linkat(olddirfd, rold, newdirfd, rnew, flags); + if (ret != 0 && (errno == EXDEV || errno == EPERM || errno == EACCES || errno == ENOTSUP || errno == ENOSYS)) { + ret = ddnatv_emulate_hardlinkat(olddirfd, rold, newdirfd, rnew); + } + return ret; +} + +// Hook link +int link(const char *oldpath, const char *newpath) { + return linkat(AT_FDCWD, oldpath, AT_FDCWD, newpath, 0); +} + +// Hook utime / utimes / lutimes / futimesat / utimensat +int utime(const char *filename, const struct utimbuf *times) { + static int (*orig_utime)(const char *, const struct utimbuf *) = NULL; + if (!orig_utime) orig_utime = (int (*)(const char *, const struct utimbuf *))dlsym(RTLD_NEXT, "utime"); + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(filename, buf, sizeof(buf)); + return orig_utime ? orig_utime(target, times) : -1; +} + +int utimes(const char *filename, const struct timeval times[2]) { + static int (*orig_utimes)(const char *, const struct timeval[2]) = NULL; + if (!orig_utimes) orig_utimes = (int (*)(const char *, const struct timeval[2]))dlsym(RTLD_NEXT, "utimes"); + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(filename, buf, sizeof(buf)); + return orig_utimes ? orig_utimes(target, times) : -1; +} + +int lutimes(const char *filename, const struct timeval times[2]) { + static int (*orig_lutimes)(const char *, const struct timeval[2]) = NULL; + if (!orig_lutimes) orig_lutimes = (int (*)(const char *, const struct timeval[2]))dlsym(RTLD_NEXT, "lutimes"); + char buf[PATH_MAX]; + const char *target = rewrite_path(filename, buf, sizeof(buf)); + return orig_lutimes ? orig_lutimes(target, times) : -1; +} + +int futimesat(int dirfd, const char *pathname, const struct timeval times[2]) { + static int (*orig_futimesat)(int, const char *, const struct timeval[2]) = NULL; + if (!orig_futimesat) orig_futimesat = (int (*)(int, const char *, const struct timeval[2]))dlsym(RTLD_NEXT, "futimesat"); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + return orig_futimesat ? orig_futimesat(dirfd, target, times) : -1; +} + +int utimensat(int dirfd, const char *pathname, const struct timespec times[2], int flags) { + static int (*orig_utimensat)(int, const char *, const struct timespec[2], int) = NULL; + if (!orig_utimensat) orig_utimensat = (int (*)(int, const char *, const struct timespec[2], int))dlsym(RTLD_NEXT, "utimensat"); + DDNATV_AT_REMAP(dirfd, pathname); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + return orig_utimensat ? orig_utimensat(dirfd, target, times, flags) : -1; +} + +// Hook truncate +int truncate(const char *path, off_t length) { + static int (*orig_truncate)(const char *, off_t) = NULL; + if (!orig_truncate) orig_truncate = (int (*)(const char *, off_t))dlsym(RTLD_NEXT, "truncate"); + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(path, buf, sizeof(buf)); + return orig_truncate(target, length); +} + +// Hook statfs / statfs64 / statvfs / statvfs64 +int statfs(const char *path, struct statfs *buf) { + static int (*orig_statfs)(const char *, struct statfs *) = NULL; + if (!orig_statfs) orig_statfs = (int (*)(const char *, struct statfs *))dlsym(RTLD_NEXT, "statfs"); + char pbuf[PATH_MAX]; + const char *target = rewrite_path_follow(path, pbuf, sizeof(pbuf)); + return orig_statfs ? orig_statfs(target, buf) : -1; +} + +int statvfs(const char *path, struct statvfs *buf) { + static int (*orig_statvfs)(const char *, struct statvfs *) = NULL; + if (!orig_statvfs) orig_statvfs = (int (*)(const char *, struct statvfs *))dlsym(RTLD_NEXT, "statvfs"); + char pbuf[PATH_MAX]; + const char *target = rewrite_path_follow(path, pbuf, sizeof(pbuf)); + return orig_statvfs ? orig_statvfs(target, buf) : -1; +} + +// Hook chdir +int chdir(const char *path) { + static int (*orig_chdir)(const char *) = NULL; + if (!orig_chdir) orig_chdir = (int (*)(const char *))dlsym(RTLD_NEXT, "chdir"); + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(path, buf, sizeof(buf)); + return orig_chdir ? orig_chdir(target) : -1; +} + +// Hook fchdir +int fchdir(int fd) { + static int (*orig_fchdir)(int) = NULL; + if (!orig_fchdir) orig_fchdir = (int (*)(int))dlsym(RTLD_NEXT, "fchdir"); + return orig_fchdir ? orig_fchdir(fd) : -1; +} + +// Hook getcwd +char *getcwd(char *buf, size_t size) { + static char *(*orig_getcwd)(char *, size_t) = NULL; + if (!orig_getcwd) orig_getcwd = (char *(*)(char *, size_t))dlsym(RTLD_NEXT, "getcwd"); + char *res = orig_getcwd ? orig_getcwd(buf, size) : NULL; + if (res) { + size_t len = strlen(res); + guest_path_of_mount_source(res, len, buf ? size : len + 1); + } + return res; +} + +extern void __chk_fail(void) __attribute__((__noreturn__)); +char *__getcwd_chk(char *buf, size_t size, size_t buflen) { + if (size > buflen) __chk_fail(); + return getcwd(buf, size); +} + +// Hook realpath and canonicalize_file_name +char *realpath(const char *path, char *resolved_path) { + static char *(*orig_realpath)(const char *, char *) = NULL; + if (!orig_realpath) orig_realpath = (char *(*)(const char *, char *))dlsym(RTLD_NEXT, "realpath"); + if (!path) { + errno = EINVAL; + return NULL; + } + init_ddnatv_hook(); + if (is_proc_self_exe(path)) { + char tmp[PATH_MAX]; + ssize_t n = handle_proc_self_exe(tmp, sizeof(tmp) - 1); + if (n > 0) { + tmp[n] = '\0'; + if (resolved_path) { + strncpy(resolved_path, tmp, PATH_MAX - 1); + resolved_path[PATH_MAX - 1] = '\0'; + return resolved_path; + } else { + return strdup(tmp); + } + } + } + char pbuf[PATH_MAX]; + const char *target = rewrite_path(path, pbuf, sizeof(pbuf)); + char *res = orig_realpath ? orig_realpath(target, resolved_path) : NULL; + if (res && g_ddnatv_root[0] != '\0') { + size_t rlen = g_ddnatv_root_len; + if (strncmp(res, g_ddnatv_root, rlen) == 0 && (res[rlen] == '/' || res[rlen] == '\0')) { + size_t rem_len = strlen(res + rlen); + if (rem_len == 0) { + res[0] = '/'; + res[1] = '\0'; + } else { + memmove(res, res + rlen, rem_len + 1); + } + } + } + if (res) guest_path_of_mount_source(res, strlen(res), resolved_path ? PATH_MAX : strlen(res) + 1); + return res; +} + +char *__realpath_chk(const char *path, char *resolved_path, size_t resolved_len) { + return realpath(path, resolved_path); +} + +char *canonicalize_file_name(const char *path) { + return realpath(path, NULL); +} + +// Hook scandir and scandir64 +int scandir(const char *dirp, struct dirent ***namelist, + int (*filter)(const struct dirent *), + int (*compar)(const struct dirent **, const struct dirent **)) { + static int (*orig_scandir)(const char *, struct dirent ***, + int (*)(const struct dirent *), + int (*)(const struct dirent **, const struct dirent **)) = NULL; + if (!orig_scandir) orig_scandir = (int (*)(const char *, struct dirent ***, + int (*)(const struct dirent *), + int (*)(const struct dirent **, const struct dirent **)))dlsym(RTLD_NEXT, "scandir"); + char buf[PATH_MAX]; + const char *target = rewrite_path(dirp, buf, sizeof(buf)); + return orig_scandir ? orig_scandir(target, namelist, filter, compar) : -1; +} + +#if defined(__LP64__) +// Export 64-bit Large File Support (LFS) symbol aliases on 64-bit platforms so that +// calls from libraries compiled with LFS (such as libstdc++ calling fopen64) are intercepted. +__asm__( + ".globl open64\n" ".set open64, open\n" + ".globl openat64\n" ".set openat64, openat\n" + ".globl __open64_2\n" ".set __open64_2, __open_2\n" + ".globl __openat64_2\n" ".set __openat64_2, __openat_2\n" + ".globl creat64\n" ".set creat64, creat\n" + ".globl fopen64\n" ".set fopen64, fopen\n" + ".globl freopen64\n" ".set freopen64, freopen\n" + ".globl stat64\n" ".set stat64, stat\n" + ".globl lstat64\n" ".set lstat64, lstat\n" + ".globl fstatat64\n" ".set fstatat64, fstatat\n" + ".globl truncate64\n" ".set truncate64, truncate\n" + ".globl statfs64\n" ".set statfs64, statfs\n" + ".globl statvfs64\n" ".set statvfs64, statvfs\n" + ".globl scandir64\n" ".set scandir64, scandir\n" + ".globl mkstemp64\n" ".set mkstemp64, mkstemp\n" + ".globl mkostemp64\n" ".set mkostemp64, mkostemp\n" + ".globl mkstemps64\n" ".set mkstemps64, mkstemps\n" + ".globl mkostemps64\n" ".set mkostemps64, mkostemps\n" + ".globl tmpfile64\n" ".set tmpfile64, tmpfile\n" +); +#endif + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/files.c b/tools/nativeguest/hook/files.c new file mode 100644 index 0000000000..6c52f70adf --- /dev/null +++ b/tools/nativeguest/hook/files.c @@ -0,0 +1,813 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Opening, creating and inspecting files: open, fopen, temporary files, directories, the stat family. + +#ifndef DDNATV_HOST_TEST + +#ifndef O_TMPFILE +#define O_TMPFILE (020000000 | 00200000) +#endif + +static inline int open_needs_mode(int flags) { +#ifdef O_TMPFILE + return ((flags & O_CREAT) != 0) || ((flags & O_TMPFILE) == O_TMPFILE); +#else + return (flags & O_CREAT) != 0; +#endif +} + +// The app is root for the programs it runs, and root puts names in every directory and takes them out +// whatever the mode of the directory; the app does not. A directory that is the app's own can have lost +// its owner's rights: an earlier version left the directories dpkg makes (with mode 0) at mode 0 when the +// chmod that follows did not take effect, and a package can ship a read-only one (#44). When a call that +// makes or removes a name is refused in such a directory, the directory is given its owner's rights and the +// call is made once more. Returns 1 when the directory was repaired (the call can be made again). +static int give_dir_owner_rights(int dirfd, const char *name) { + static int (*orig_fchmodat)(int, const char *, mode_t, int) = NULL; + if (!name || !*name) return 0; + char parent[PATH_MAX]; + size_t len = strlen(name); + if (len >= sizeof(parent)) return 0; + memcpy(parent, name, len + 1); + while (len > 1 && parent[len - 1] == '/') parent[--len] = '\0'; + char *slash = strrchr(parent, '/'); + if (!slash) { + strcpy(parent, "."); + } else if (slash == parent) { + parent[1] = '\0'; + } else { + *slash = '\0'; + } + struct stat st; + if (real_fstatat(dirfd, parent, &st, 0) != 0 || !S_ISDIR(st.st_mode)) return 0; + if (__atomic_load_n(&g_app_uid, __ATOMIC_RELAXED) == (uid_t)-1) load_app_ids(); + if (st.st_uid != __atomic_load_n(&g_app_uid, __ATOMIC_RELAXED)) return 0; + if ((st.st_mode & 0700) == 0700) return 0; + if (!orig_fchmodat) orig_fchmodat = (int (*)(int, const char *, mode_t, int))dlsym(RTLD_NEXT, "fchmodat"); + return orig_fchmodat && orig_fchmodat(dirfd, parent, (st.st_mode | 0700) & 07777, 0) == 0; +} + +// For the calls that were refused (EACCES): whether the directory of `name` was repaired, so that the call +// can be made again. errno stays what the call left when it was not. +static int refused_in_repaired_dir(int dirfd, const char *name) { + if (errno != EACCES) return 0; + int saved = errno; + int fixed = give_dir_owner_rights(dirfd, name); + if (!fixed) errno = saved; + return fixed; +} + +static int dlopen_preload_deps(const char *path, void *(*orig_dlopen)(const char *, int), int depth); + +// Hook dlopen and dlmopen +void *dlopen(const char *filename, int flags) { + static void *(*orig_dlopen)(const char *, int) = NULL; + if (!orig_dlopen) orig_dlopen = (void *(*)(const char *, int))dlsym(RTLD_NEXT, "dlopen"); + if (!filename) return orig_dlopen ? orig_dlopen(NULL, flags) : NULL; + if (!orig_dlopen) return NULL; + + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(filename, buf, sizeof(buf)); + void *handle = orig_dlopen(target, flags); + if (!handle && target[0] == '/' && !(flags & RTLD_NOLOAD)) { + // Its dependencies may be in its RUNPATH, which ld.so looked for outside the rootfs + int saved = errno; + if (dlopen_preload_deps(target, orig_dlopen, 0) > 0) handle = orig_dlopen(target, flags); + if (!handle) errno = saved; + } + return handle; +} + +void *dlmopen(Lmid_t lmid, const char *filename, int flags) { + static void *(*orig_dlmopen)(Lmid_t, const char *, int) = NULL; + if (!orig_dlmopen) orig_dlmopen = (void *(*)(Lmid_t, const char *, int))dlsym(RTLD_NEXT, "dlmopen"); + if (!filename) return orig_dlmopen ? orig_dlmopen(lmid, NULL, flags) : NULL; + + char buf[PATH_MAX]; + const char *target = rewrite_path(filename, buf, sizeof(buf)); + return orig_dlmopen ? orig_dlmopen(lmid, target, flags) : NULL; +} + +// /proc//status (and a thread's) give the app's own ids, which every other call presents as +// root: process monitors comparing them with getuid() showed none of the session's processes. Only +// such tools are given root's there: Chromium (Steam's web helper) checks the ids of the processes it +// sandboxes in those files, and with them all 0 every helper exited and Steam never drew a frame. +static int reader_compares_process_ids(void) { + static const char *const k_readers[] = { + "ps", "top", "htop", "btop", "atop", "pgrep", "pkill", "pidof", "pstree", "w", "glances", + "ksystemstats", "plasma-systemmonitor", "ksysguard", "ksysguardd", "kinfocenter", "gnome-system-monitor", + }; + const char *me = program_invocation_short_name; + if (!me) return 0; + for (size_t i = 0; i < sizeof(k_readers) / sizeof(k_readers[0]); i++) { + if (strcmp(me, k_readers[i]) == 0) return 1; + } + return 0; +} + +static int is_proc_status_path(const char *p) { + if (!p || strncmp(p, "/proc/", 6) != 0) return 0; + p += 6; + if (strncmp(p, "self/", 5) == 0) p += 5; + else if (strncmp(p, "thread-self/", 12) == 0) p += 12; + else { + if (*p < '0' || *p > '9') return 0; + while (*p >= '0' && *p <= '9') p++; + if (*p++ != '/') return 0; + if (strncmp(p, "task/", 5) == 0) { + p += 5; + if (*p < '0' || *p > '9') return 0; + while (*p >= '0' && *p <= '9') p++; + if (*p++ != '/') return 0; + } + } + return strcmp(p, "status") == 0; +} + +static void proc_status_root_ids(char *text, size_t len, const char *field, unsigned long id) { + size_t flen = strlen(field); + for (size_t at = 0; at + flen <= len; at++) { + if ((at != 0 && text[at - 1] != '\n') || memcmp(text + at, field, flen) != 0) continue; + char *p = text + at + flen; + char *end = memchr(p, '\n', len - (size_t)(p - text)); + if (!end) end = text + len; + char out[128]; + size_t used = 0; + while (p < end && used + 24 < sizeof(out)) { + while (p < end && (*p == '\t' || *p == ' ')) out[used++] = *p++; + char *num = p; + while (p < end && *p >= '0' && *p <= '9') p++; + if (p == num) break; + unsigned long v = strtoul(num, NULL, 10); + used += (size_t)snprintf(out + used, sizeof(out) - used, "%lu", v == id ? 0UL : v); + } + if (p != end) return; + // the line shrinks or stays (an id becomes 0), so it is rewritten in place + size_t old_len = (size_t)(end - (text + at + flen)); + if (used > old_len) return; + memcpy(text + at + flen, out, used); + memmove(text + at + flen + used, end, len - (size_t)(end - text) + 1); + return; + } +} + +// The status file with the app's ids as root's, in a memory file; -2 when `path` is no such file +// or is opened for writing. +static int open_proc_status(const char *path, int flags) { + if ((flags & O_ACCMODE) != O_RDONLY || !is_proc_status_path(path) || !reader_compares_process_ids()) return -2; + int fd = (int)syscall(SYS_openat, AT_FDCWD, path, O_RDONLY | O_CLOEXEC); + if (fd < 0) return -1; + char text[16384]; + size_t len = 0; + for (;;) { + ssize_t n = (ssize_t)syscall(SYS_read, fd, text + len, sizeof(text) - 1 - len); + if (n <= 0) break; + len += (size_t)n; + if (len >= sizeof(text) - 1) break; + } + syscall(SYS_close, fd); + text[len] = '\0'; + if (__atomic_load_n(&g_app_uid, __ATOMIC_RELAXED) == (uid_t)-1) load_app_ids(); + proc_status_root_ids(text, len, "Uid:", (unsigned long)__atomic_load_n(&g_app_uid, __ATOMIC_RELAXED)); + len = strlen(text); + proc_status_root_ids(text, len, "Gid:", (unsigned long)__atomic_load_n(&g_app_gid, __ATOMIC_RELAXED)); + len = strlen(text); + int mfd = (int)syscall(SYS_memfd_create, "status", (flags & O_CLOEXEC) ? MFD_CLOEXEC : 0); + if (mfd < 0) return (int)syscall(SYS_openat, AT_FDCWD, path, flags, 0); + size_t written = 0; + while (written < len) { + ssize_t n = (ssize_t)syscall(SYS_write, mfd, text + written, len - written); + if (n <= 0) break; + written += (size_t)n; + } + syscall(SYS_lseek, mfd, 0, SEEK_SET); + return mfd; +} + +// openat(dirfd, "status") with dirfd on /proc/ or a thread of it +static int open_proc_status_at(int dirfd, const char *name, int flags) { + if (dirfd < 0 || !name || strcmp(name, "status") != 0 || (flags & O_ACCMODE) != O_RDONLY) return -2; + char link[48], dir[PATH_MAX]; + snprintf(link, sizeof(link), "/proc/self/fd/%d", dirfd); + long n = syscall(SYS_readlinkat, AT_FDCWD, link, dir, sizeof(dir) - 8); + if (n <= 0) return -2; + dir[n] = '\0'; + memcpy(dir + n, "/status", 8); + return open_proc_status(dir, flags); +} + +// Hook open +int open(const char *pathname, int flags, ...) { + static int (*orig_open)(const char *, int, ...) = NULL; + if (!orig_open) orig_open = (int (*)(const char *, int, ...))dlsym(RTLD_NEXT, "open"); + init_ddnatv_hook(); + char exe_buf[PATH_MAX]; + if (is_proc_self_exe(pathname)) { + if (g_real_exe[0] != '\0') { + pathname = g_real_exe; + } else if (handle_proc_self_exe(exe_buf, sizeof(exe_buf)) > 0) { + pathname = exe_buf; + } + } + int status_fd = open_proc_status(pathname, flags); + if (status_fd != -2) return status_fd; + char buf[PATH_MAX]; + const char *target = ((flags & O_NOFOLLOW) ? rewrite_path : rewrite_path_follow)(pathname, buf, sizeof(buf)); + if (open_needs_mode(flags)) { + va_list args; + va_start(args, flags); + mode_t mode = va_arg(args, mode_t); + va_end(args); + int fd = orig_open(target, flags, mode); + if (fd < 0 && (flags & O_CREAT) && refused_in_repaired_dir(AT_FDCWD, target)) fd = orig_open(target, flags, mode); + return fd; + } + return orig_open(target, flags); +} + +// Hook openat +int openat(int dirfd, const char *pathname, int flags, ...) { + static int (*orig_openat)(int, const char *, int, ...) = NULL; + if (!orig_openat) orig_openat = (int (*)(int, const char *, int, ...))dlsym(RTLD_NEXT, "openat"); + init_ddnatv_hook(); + DDNATV_AT_REMAP(dirfd, pathname); + char exe_buf[PATH_MAX]; + if (is_proc_self_exe(pathname)) { + if (g_real_exe[0] != '\0') { + pathname = g_real_exe; + } else if (handle_proc_self_exe(exe_buf, sizeof(exe_buf)) > 0) { + pathname = exe_buf; + } + } + int status_fd = (pathname && pathname[0] == '/') ? open_proc_status(pathname, flags) : open_proc_status_at(dirfd, pathname, flags); + if (status_fd != -2) return status_fd; + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? ((flags & O_NOFOLLOW) ? rewrite_path : rewrite_path_follow)(pathname, buf, sizeof(buf)) : pathname; + if (open_needs_mode(flags)) { + va_list args; + va_start(args, flags); + mode_t mode = va_arg(args, mode_t); + va_end(args); + int fd = orig_openat(dirfd, target, flags, mode); + if (fd < 0 && (flags & O_CREAT) && refused_in_repaired_dir(dirfd, target)) fd = orig_openat(dirfd, target, flags, mode); + return fd; + } + return orig_openat(dirfd, target, flags); +} + +// Hook creat +int creat(const char *pathname, mode_t mode) { + return open(pathname, O_CREAT | O_WRONLY | O_TRUNC, mode); +} + +// Fortified open variants used by GNU tar and other coreutils compiled with _FORTIFY_SOURCE=2/3 +int __open_2(const char *pathname, int flags) { + return open(pathname, flags); +} + +int __openat_2(int dirfd, const char *pathname, int flags) { + return openat(dirfd, pathname, flags); +} + +// openat2/open_how local definition: avoids depending on , +// which old NDK/cross headers may lack. Layout matches UAPI ver0 +// (flags, mode, resolve = 3 x __u64); extra fields are never read here. +struct ddnatv_open_how { + uint64_t flags; + uint64_t mode; + uint64_t resolve; +}; +#ifndef RESOLVE_BENEATH +#define RESOLVE_BENEATH 0x08 +#endif +#ifndef __NR_openat2 +#define __NR_openat2 437 +#endif +#ifndef __NR_fchmodat2 +#define __NR_fchmodat2 452 +#endif + +static long call_orig_syscall(long number, unsigned long a1, unsigned long a2, unsigned long a3, unsigned long a4, unsigned long a5, unsigned long a6) { + static long (*orig_syscall)(long, unsigned long, unsigned long, unsigned long, unsigned long, unsigned long, unsigned long) = NULL; + if (!orig_syscall) { + orig_syscall = (long (*)(long, unsigned long, unsigned long, unsigned long, unsigned long, unsigned long, unsigned long))dlsym(RTLD_NEXT, "syscall"); + } + return orig_syscall ? orig_syscall(number, a1, a2, a3, a4, a5, a6) : syscall(number, a1, a2, a3, a4, a5, a6); +} + +// Hook openat2 (used by GNU tar 1.35+/gnulib for RESOLVE_BENEATH traversal). +// Rewrites absolute paths like openat, then delegates; on ENOSYS (kernels +// without openat2, e.g. Android < 5.6) emulates with plain openat instead of +// trusting every caller to implement the fallback itself. +int openat2(int dirfd, const char *pathname, struct ddnatv_open_how *how, size_t usize) { + static int (*orig_openat2)(int, const char *, struct ddnatv_open_how *, size_t) = NULL; + if (!orig_openat2) orig_openat2 = (int (*)(int, const char *, struct ddnatv_open_how *, size_t))dlsym(RTLD_NEXT, "openat2"); + if (!pathname) { + errno = EFAULT; + return -1; + } + const char *given = pathname; + DDNATV_AT_REMAP(dirfd, pathname); + // a remapped path is absolute, which RESOLVE_BENEATH and the like refuse: the caller walks it itself + if (pathname != given && how && how->resolve != 0) { + errno = ENOSYS; + return -1; + } + char exe_buf[PATH_MAX]; + if (is_proc_self_exe(pathname)) { + if (g_real_exe[0] != '\0') { + pathname = g_real_exe; + } else if (handle_proc_self_exe(exe_buf, sizeof(exe_buf)) > 0) { + pathname = exe_buf; + } + } + char buf[PATH_MAX]; + const char *target = (pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + if (orig_openat2) { + int ret = orig_openat2(dirfd, target, how, usize); + if (ret >= 0 || errno != ENOSYS) return ret; + } +#ifdef __NR_openat2 + long sret = call_orig_syscall(__NR_openat2, (unsigned long)dirfd, (unsigned long)target, (unsigned long)how, (unsigned long)usize, 0, 0); + if (sret >= 0 || errno != ENOSYS) { + return (int)sret; + } +#endif + if (!how || usize < 16) { + errno = EINVAL; + return -1; + } + int flags = (int)(how->flags & 0xffffffffu); + mode_t mode = (mode_t)(how->mode & 07777u); + + // RESOLVE_BENEATH, RESOLVE_NO_SYMLINKS and the other resolve flags restrict every component of + // the path, which a plain openat() cannot do (a symlink in the middle would still be followed). + // Say so: callers such as gnulib's openat2 (GNU tar) then walk the path safely themselves. + if (how->resolve != 0) { + errno = ENOSYS; + return -1; + } + + if (open_needs_mode(flags)) { + return openat(dirfd, target, flags, mode); + } + return openat(dirfd, target, flags); +} + +// Hook fchmodat2 (used by GNU tar for lchmod-style symlink chmod). +// Delegates when the libc symbol exists, otherwise emulates: symlinks cannot +// be chmod'ed without kernel support, so skip them (return 0) like gnulib, +// and route everything else through fchmodat. +int fchmodat2(int dirfd, const char *pathname, mode_t mode, int flags) { + static int (*orig_fchmodat2)(int, const char *, mode_t, int) = NULL; + if (!orig_fchmodat2) orig_fchmodat2 = (int (*)(int, const char *, mode_t, int))dlsym(RTLD_NEXT, "fchmodat2"); + if (!pathname) { + errno = EFAULT; + return -1; + } + char buf[PATH_MAX]; + const char *target = (pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + if (orig_fchmodat2) { + int ret = orig_fchmodat2(dirfd, target, mode, flags); + if (ret == 0 || errno != ENOSYS) return ret; + } + if ((flags & AT_SYMLINK_NOFOLLOW) != 0) { + struct stat st; + if (fstatat(dirfd, target, &st, AT_SYMLINK_NOFOLLOW) == 0 && S_ISLNK(st.st_mode)) { + return 0; + } + } + return fchmodat(dirfd, target, mode, 0); +} + + +// Hook fopen +FILE *fopen(const char *pathname, const char *mode) { + static FILE *(*orig_fopen)(const char *, const char *) = NULL; + if (!orig_fopen) orig_fopen = (FILE *(*)(const char *, const char *))dlsym(RTLD_NEXT, "fopen"); + if (mode && mode[0] == 'r' && !strchr(mode, '+')) { + int status_fd = open_proc_status(pathname, O_RDONLY | (strchr(mode, 'e') ? O_CLOEXEC : 0)); + if (status_fd >= 0) return fdopen(status_fd, mode); + if (status_fd == -1) return NULL; + } + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(pathname, buf, sizeof(buf)); + return orig_fopen(target, mode); +} + +// Hook freopen +FILE *freopen(const char *pathname, const char *mode, FILE *stream) { + static FILE *(*orig_freopen)(const char *, const char *, FILE *) = NULL; + if (!orig_freopen) orig_freopen = (FILE *(*)(const char *, const char *, FILE *))dlsym(RTLD_NEXT, "freopen"); + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(pathname, buf, sizeof(buf)); + return orig_freopen(target, mode, stream); +} + +// Hook write +ssize_t write(int fd, const void *buf, size_t count) { + static ssize_t (*orig_write)(int, const void *, size_t) = NULL; + if (!orig_write) orig_write = (ssize_t (*)(int, const void *, size_t))dlsym(RTLD_NEXT, "write"); + return orig_write ? orig_write(fd, buf, count) : -1; +} + +// Hook mkstemp +int mkstemp(char *template) { + static int (*orig_mkstemp)(char *) = NULL; + if (!orig_mkstemp) orig_mkstemp = (int (*)(char *))dlsym(RTLD_NEXT, "mkstemp"); + if (!template) { errno = EINVAL; return -1; } + + char buf[PATH_MAX]; + const char *target = rewrite_path(template, buf, sizeof(buf)); + if (target == template) { + return orig_mkstemp ? orig_mkstemp(template) : -1; + } + + char tmp_buf[PATH_MAX]; + strncpy(tmp_buf, target, sizeof(tmp_buf) - 1); + tmp_buf[sizeof(tmp_buf) - 1] = '\0'; + + int fd = orig_mkstemp ? orig_mkstemp(tmp_buf) : -1; + if (fd >= 0) { + size_t orig_len = strlen(template); + size_t tmp_len = strlen(tmp_buf); + if (orig_len >= 6 && tmp_len >= 6) { + memcpy(template + orig_len - 6, tmp_buf + tmp_len - 6, 6); + } + } + return fd; +} + +// Hook mkostemp +int mkostemp(char *template, int flags) { + static int (*orig_mkostemp)(char *, int) = NULL; + if (!orig_mkostemp) orig_mkostemp = (int (*)(char *, int))dlsym(RTLD_NEXT, "mkostemp"); + if (!template) { errno = EINVAL; return -1; } + + char buf[PATH_MAX]; + const char *target = rewrite_path(template, buf, sizeof(buf)); + if (target == template) { + return orig_mkostemp ? orig_mkostemp(template, flags) : -1; + } + + char tmp_buf[PATH_MAX]; + strncpy(tmp_buf, target, sizeof(tmp_buf) - 1); + tmp_buf[sizeof(tmp_buf) - 1] = '\0'; + + int fd = orig_mkostemp ? orig_mkostemp(tmp_buf, flags) : -1; + if (fd >= 0) { + size_t orig_len = strlen(template); + size_t tmp_len = strlen(tmp_buf); + if (orig_len >= 6 && tmp_len >= 6) { + memcpy(template + orig_len - 6, tmp_buf + tmp_len - 6, 6); + } + } + return fd; +} + +// Hook mkstemps +int mkstemps(char *template, int suffixlen) { + static int (*orig_mkstemps)(char *, int) = NULL; + if (!orig_mkstemps) orig_mkstemps = (int (*)(char *, int))dlsym(RTLD_NEXT, "mkstemps"); + if (!template) { errno = EINVAL; return -1; } + + char buf[PATH_MAX]; + const char *target = rewrite_path(template, buf, sizeof(buf)); + if (target == template) { + return orig_mkstemps ? orig_mkstemps(template, suffixlen) : -1; + } + + char tmp_buf[PATH_MAX]; + strncpy(tmp_buf, target, sizeof(tmp_buf) - 1); + tmp_buf[sizeof(tmp_buf) - 1] = '\0'; + + int fd = orig_mkstemps ? orig_mkstemps(tmp_buf, suffixlen) : -1; + if (fd >= 0) { + size_t orig_len = strlen(template); + size_t tmp_len = strlen(tmp_buf); + if (orig_len >= (size_t)(suffixlen + 6) && tmp_len >= (size_t)(suffixlen + 6)) { + memcpy(template + orig_len - suffixlen - 6, tmp_buf + tmp_len - suffixlen - 6, 6); + } + } + return fd; +} + +// Hook mkostemps +int mkostemps(char *template, int suffixlen, int flags) { + static int (*orig_mkostemps)(char *, int, int) = NULL; + if (!orig_mkostemps) orig_mkostemps = (int (*)(char *, int, int))dlsym(RTLD_NEXT, "mkostemps"); + if (!template) { errno = EINVAL; return -1; } + + char buf[PATH_MAX]; + const char *target = rewrite_path(template, buf, sizeof(buf)); + if (target == template) { + return orig_mkostemps ? orig_mkostemps(template, suffixlen, flags) : -1; + } + + char tmp_buf[PATH_MAX]; + strncpy(tmp_buf, target, sizeof(tmp_buf) - 1); + tmp_buf[sizeof(tmp_buf) - 1] = '\0'; + + int fd = orig_mkostemps ? orig_mkostemps(tmp_buf, suffixlen, flags) : -1; + if (fd >= 0) { + size_t orig_len = strlen(template); + size_t tmp_len = strlen(tmp_buf); + if (orig_len >= (size_t)(suffixlen + 6) && tmp_len >= (size_t)(suffixlen + 6)) { + memcpy(template + orig_len - suffixlen - 6, tmp_buf + tmp_len - suffixlen - 6, 6); + } + } + return fd; +} + +// Hook mkdtemp +char *mkdtemp(char *template) { + static char *(*orig_mkdtemp)(char *) = NULL; + if (!orig_mkdtemp) orig_mkdtemp = (char *(*)(char *))dlsym(RTLD_NEXT, "mkdtemp"); + if (!template) { errno = EINVAL; return NULL; } + + char buf[PATH_MAX]; + const char *target = rewrite_path(template, buf, sizeof(buf)); + if (target == template) { + return orig_mkdtemp ? orig_mkdtemp(template) : NULL; + } + + char tmp_buf[PATH_MAX]; + strncpy(tmp_buf, target, sizeof(tmp_buf) - 1); + tmp_buf[sizeof(tmp_buf) - 1] = '\0'; + + char *res = orig_mkdtemp ? orig_mkdtemp(tmp_buf) : NULL; + if (res) { + size_t orig_len = strlen(template); + size_t tmp_len = strlen(tmp_buf); + if (orig_len >= 6 && tmp_len >= 6) { + memcpy(template + orig_len - 6, tmp_buf + tmp_len - 6, 6); + } + return template; + } + return NULL; +} + +// Hook tmpfile +FILE *tmpfile(void) { + init_ddnatv_hook(); + char template_buf[PATH_MAX]; + if (g_ddnatv_root[0] != '\0') { + snprintf(template_buf, sizeof(template_buf), "%s/tmp/tmpfile.XXXXXX", g_ddnatv_root); + } else { + snprintf(template_buf, sizeof(template_buf), "/tmp/tmpfile.XXXXXX"); + } + int fd = mkstemp(template_buf); + if (fd < 0) return NULL; + unlink(template_buf); + FILE *f = fdopen(fd, "w+b"); + if (!f) { + int saved_errno = errno; + close(fd); + errno = saved_errno; + } + return f; +} + +#ifndef __USE_FILE_OFFSET64 +// Programs built with _LARGEFILE64_SOURCE call this name. With _FILE_OFFSET_BITS=64 (the 32-bit ARM +// build) the headers already export the definition above as tmpfile64. +FILE *tmpfile64(void) { + return tmpfile(); +} +#endif + +// Hook opendir +DIR *opendir(const char *name) { + static DIR *(*orig_opendir)(const char *) = NULL; + if (!orig_opendir) orig_opendir = (DIR *(*)(const char *))dlsym(RTLD_NEXT, "opendir"); + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(name, buf, sizeof(buf)); + return orig_opendir(target); +} + +// Hook stat +int stat(const char *pathname, struct stat *statbuf) { + static int (*orig_stat)(const char *, struct stat *) = NULL; + if (!orig_stat) orig_stat = (int (*)(const char *, struct stat *))dlsym(RTLD_NEXT, "stat"); + char buf[PATH_MAX]; + const char *target = rewrite_path_follow(pathname, buf, sizeof(buf)); + int ret = orig_stat ? orig_stat(target, statbuf) : -1; + if (ret != 0 && errno == ENOENT) { + char alt[PATH_MAX]; + const char *retry = usrmerge_retry_path(target, alt, sizeof(alt)); + if (retry) ret = orig_stat(retry, statbuf); + } + if (ret == 0) apply_stat_emulation(statbuf); + return ret; +} + +// Hook lstat +int lstat(const char *pathname, struct stat *statbuf) { + static int (*orig_lstat)(const char *, struct stat *) = NULL; + if (!orig_lstat) orig_lstat = (int (*)(const char *, struct stat *))dlsym(RTLD_NEXT, "lstat"); + char buf[PATH_MAX]; + const char *target = rewrite_path(pathname, buf, sizeof(buf)); + int ret = orig_lstat ? orig_lstat(target, statbuf) : -1; + char alt[PATH_MAX]; + if (ret != 0 && errno == ENOENT) { + const char *retry = usrmerge_retry_path(target, alt, sizeof(alt)); + if (retry) { + ret = orig_lstat(retry, statbuf); + if (ret == 0) target = retry; + } + } + if (ret == 0 && statbuf && S_ISLNK(statbuf->st_mode) && g_ddnatv_root[0] != '\0' && target && + readlink_result_may_change(pathname, (long long)statbuf->st_size)) { + char link_buf[PATH_MAX]; + static ssize_t (*orig_readlink)(const char *, char *, size_t) = NULL; + if (!orig_readlink) orig_readlink = (ssize_t (*)(const char *, char *, size_t))dlsym(RTLD_NEXT, "readlink"); + ssize_t llen = orig_readlink ? orig_readlink(target, link_buf, sizeof(link_buf) - 1) : -1; + if (llen > 0) { + ssize_t post_len = postprocess_readlink(pathname, link_buf, llen, sizeof(link_buf)); + if (post_len > 0) { + statbuf->st_size = post_len; + } + } + } + if (ret == 0) apply_stat_emulation(statbuf); + return ret; +} + +// Hook fstatat +int fstatat(int dirfd, const char *pathname, struct stat *statbuf, int flags) { + static int (*orig_fstatat)(int, const char *, struct stat *, int) = NULL; + if (!orig_fstatat) orig_fstatat = (int (*)(int, const char *, struct stat *, int))dlsym(RTLD_NEXT, "fstatat"); + DDNATV_AT_REMAP(dirfd, pathname); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? ((flags & AT_SYMLINK_NOFOLLOW) ? rewrite_path : rewrite_path_follow)(pathname, buf, sizeof(buf)) : pathname; + int ret = orig_fstatat ? orig_fstatat(dirfd, target, statbuf, flags) : -1; + char alt[PATH_MAX]; + if (ret != 0 && errno == ENOENT && pathname && pathname[0] == '/') { + const char *retry = usrmerge_retry_path(target, alt, sizeof(alt)); + if (retry) { + ret = orig_fstatat(dirfd, retry, statbuf, flags); + if (ret == 0) target = retry; + } + } + if (ret == 0 && statbuf && (flags & AT_SYMLINK_NOFOLLOW) && S_ISLNK(statbuf->st_mode) && g_ddnatv_root[0] != '\0' && target && + readlink_result_may_change(pathname, (long long)statbuf->st_size)) { + char link_buf[PATH_MAX]; + static ssize_t (*orig_readlinkat)(int, const char *, char *, size_t) = NULL; + if (!orig_readlinkat) orig_readlinkat = (ssize_t (*)(int, const char *, char *, size_t))dlsym(RTLD_NEXT, "readlinkat"); + ssize_t llen = orig_readlinkat ? orig_readlinkat(dirfd, target, link_buf, sizeof(link_buf) - 1) : -1; + if (llen > 0) { + ssize_t post_len = postprocess_readlink(pathname, link_buf, llen, sizeof(link_buf)); + if (post_len > 0) { + statbuf->st_size = post_len; + } + } + } + if (ret == 0) apply_stat_emulation(statbuf); + return ret; +} + +// Hook fstat +int fstat(int fd, struct stat *statbuf) { + static int (*orig_fstat)(int, struct stat *) = NULL; + if (!orig_fstat) orig_fstat = (int (*)(int, struct stat *))dlsym(RTLD_NEXT, "fstat"); + int ret = orig_fstat ? orig_fstat(fd, statbuf) : -1; + if (ret == 0) apply_stat_emulation(statbuf); + return ret; +} + +// Glibc __xstat compatibility hooks, what programs built against glibc before 2.33 call (Firefox): +// they present owners like stat() does, or Firefox saw $HOME owned by the app's uid while geteuid() +// said 0 and refused to start ("as root in a regular user's session"). +int __xstat(int ver, const char *pathname, struct stat *statbuf) { + static int (*orig___xstat)(int, const char *, struct stat *) = NULL; + if (!orig___xstat) orig___xstat = (int (*)(int, const char *, struct stat *))dlsym(RTLD_NEXT, "__xstat"); + if (!orig___xstat) return stat(pathname, statbuf); + char buf[PATH_MAX]; + int ret = orig___xstat(ver, rewrite_path_follow(pathname, buf, sizeof(buf)), statbuf); + if (ret == 0) apply_stat_emulation(statbuf); + return ret; +} + +int __xstat64(int ver, const char *pathname, struct stat64 *statbuf) { + static int (*orig___xstat64)(int, const char *, struct stat64 *) = NULL; + if (!orig___xstat64) orig___xstat64 = (int (*)(int, const char *, struct stat64 *))dlsym(RTLD_NEXT, "__xstat64"); + if (!orig___xstat64) return stat(pathname, (struct stat *)statbuf); + char buf[PATH_MAX]; + int ret = orig___xstat64(ver, rewrite_path_follow(pathname, buf, sizeof(buf)), statbuf); + if (ret == 0) apply_stat_emulation((struct stat *)statbuf); + return ret; +} + +int __lxstat(int ver, const char *pathname, struct stat *statbuf) { + static int (*orig___lxstat)(int, const char *, struct stat *) = NULL; + if (!orig___lxstat) orig___lxstat = (int (*)(int, const char *, struct stat *))dlsym(RTLD_NEXT, "__lxstat"); + if (!orig___lxstat) return lstat(pathname, statbuf); + char buf[PATH_MAX]; + int ret = orig___lxstat(ver, rewrite_path(pathname, buf, sizeof(buf)), statbuf); + if (ret == 0) apply_stat_emulation(statbuf); + return ret; +} + +int __lxstat64(int ver, const char *pathname, struct stat64 *statbuf) { + static int (*orig___lxstat64)(int, const char *, struct stat64 *) = NULL; + if (!orig___lxstat64) orig___lxstat64 = (int (*)(int, const char *, struct stat64 *))dlsym(RTLD_NEXT, "__lxstat64"); + if (!orig___lxstat64) return lstat(pathname, (struct stat *)statbuf); + char buf[PATH_MAX]; + int ret = orig___lxstat64(ver, rewrite_path(pathname, buf, sizeof(buf)), statbuf); + if (ret == 0) apply_stat_emulation((struct stat *)statbuf); + return ret; +} + +int __fxstat(int ver, int fd, struct stat *statbuf) { + static int (*orig___fxstat)(int, int, struct stat *) = NULL; + if (!orig___fxstat) orig___fxstat = (int (*)(int, int, struct stat *))dlsym(RTLD_NEXT, "__fxstat"); + if (!orig___fxstat) return fstat(fd, statbuf); + int ret = orig___fxstat(ver, fd, statbuf); + if (ret == 0) apply_stat_emulation(statbuf); + return ret; +} + +int __fxstat64(int ver, int fd, struct stat64 *statbuf) { + static int (*orig___fxstat64)(int, int, struct stat64 *) = NULL; + if (!orig___fxstat64) orig___fxstat64 = (int (*)(int, int, struct stat64 *))dlsym(RTLD_NEXT, "__fxstat64"); + if (!orig___fxstat64) return fstat(fd, (struct stat *)statbuf); + int ret = orig___fxstat64(ver, fd, statbuf); + if (ret == 0) apply_stat_emulation((struct stat *)statbuf); + return ret; +} + +int __fxstatat(int ver, int dirfd, const char *pathname, struct stat *statbuf, int flags) { + static int (*orig___fxstatat)(int, int, const char *, struct stat *, int) = NULL; + if (!orig___fxstatat) orig___fxstatat = (int (*)(int, int, const char *, struct stat *, int))dlsym(RTLD_NEXT, "__fxstatat"); + if (!orig___fxstatat) return fstatat(dirfd, pathname, statbuf, flags); + DDNATV_AT_REMAP(dirfd, pathname); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? ((flags & AT_SYMLINK_NOFOLLOW) ? rewrite_path : rewrite_path_follow)(pathname, buf, sizeof(buf)) : pathname; + int ret = orig___fxstatat(ver, dirfd, target, statbuf, flags); + if (ret == 0) apply_stat_emulation(statbuf); + return ret; +} + +int __fxstatat64(int ver, int dirfd, const char *pathname, struct stat64 *statbuf, int flags) { + static int (*orig___fxstatat64)(int, int, const char *, struct stat64 *, int) = NULL; + if (!orig___fxstatat64) orig___fxstatat64 = (int (*)(int, int, const char *, struct stat64 *, int))dlsym(RTLD_NEXT, "__fxstatat64"); + if (!orig___fxstatat64) return fstatat(dirfd, pathname, (struct stat *)statbuf, flags); + DDNATV_AT_REMAP(dirfd, pathname); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? ((flags & AT_SYMLINK_NOFOLLOW) ? rewrite_path : rewrite_path_follow)(pathname, buf, sizeof(buf)) : pathname; + int ret = orig___fxstatat64(ver, dirfd, target, statbuf, flags); + if (ret == 0) apply_stat_emulation((struct stat *)statbuf); + return ret; +} + +// Hook statx +int statx(int dirfd, const char *pathname, int flags, unsigned int mask, struct statx *statxbuf) { + // Rust's standard library asks whether statx exists by calling it with a NULL path and buffer + // (EFAULT means it does). glibc's header declares both as nonnull, so the compiler would drop + // the NULL check below and read the path: every Rust program (rg, rustc, cargo...) crashed. + __asm__ volatile("" : "+r"(pathname), "+r"(statxbuf)); + static int (*orig_statx)(int, const char *, int, unsigned int, struct statx *) = NULL; + if (!orig_statx) orig_statx = (int (*)(int, const char *, int, unsigned int, struct statx *))dlsym(RTLD_NEXT, "statx"); + DDNATV_AT_REMAP(dirfd, pathname); + char buf[PATH_MAX]; + const char *target = (pathname && pathname[0] == '/') ? ((flags & AT_SYMLINK_NOFOLLOW) ? rewrite_path : rewrite_path_follow)(pathname, buf, sizeof(buf)) : pathname; + int ret = orig_statx ? orig_statx(dirfd, target, flags, mask, statxbuf) : -1; + if (ret == 0 && statxbuf && hardlinks_maybe_any()) { + const unsigned int needed = STATX_INO | STATX_NLINK | STATX_MTIME; + struct statx full; + const struct statx *sx = statxbuf; + if ((statxbuf->stx_mask & needed) != needed) { + // The caller asked for less ("stat -c %h" for the link count only): what an emulated + // link is recognized by + int saved_errno = errno; + sx = orig_statx(dirfd, target, flags, needed, &full) == 0 && (full.stx_mask & needed) == needed ? &full : NULL; + errno = saved_errno; + } + if (sx) { + struct stat st; + memset(&st, 0, sizeof(st)); + st.st_dev = makedev(sx->stx_dev_major, sx->stx_dev_minor); + st.st_ino = sx->stx_ino; + st.st_nlink = sx->stx_nlink; + st.st_mtim.tv_sec = sx->stx_mtime.tv_sec; + st.st_mtim.tv_nsec = sx->stx_mtime.tv_nsec; + apply_emulated_hardlink(&st); + if (st.st_ino != sx->stx_ino || st.st_nlink != sx->stx_nlink) { + statxbuf->stx_ino = st.st_ino; + statxbuf->stx_nlink = st.st_nlink; + statxbuf->stx_mask |= STATX_INO | STATX_NLINK; + } + } + } + if (ret == 0 && statxbuf) { + uid_t uid = (uid_t)statxbuf->stx_uid; + gid_t gid = (gid_t)statxbuf->stx_gid; + present_owner_as_root((statxbuf->stx_mask & STATX_UID) ? &uid : NULL, (statxbuf->stx_mask & STATX_GID) ? &gid : NULL); + statxbuf->stx_uid = (uint32_t)uid; + statxbuf->stx_gid = (uint32_t)gid; + } + return ret; +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/go_programs.c b/tools/nativeguest/hook/go_programs.c new file mode 100644 index 0000000000..987d0132ee --- /dev/null +++ b/tools/nativeguest/hook/go_programs.c @@ -0,0 +1,465 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Static Go programs: they make their system calls themselves, so Ubuntu's paths mean nothing to +// them. The code of gosys/gosys.c is added to their file. + +// ---- Static Go programs ------------------------------------------------------------------- +// A Go program built without cgo (all of Ubuntu's, and the single files downloaded from a project's +// releases) has no C library: the preloaded hook is never loaded into it, so "/etc/resolv.conf" is +// a file of Android's that does not exist, and so is every program it starts. Go makes all of its +// system calls but a few of its runtime's in one assembly function, internal/runtime/syscall. +// Syscall6, which loads the number and the arguments from the stack and executes "svc #0". +// +// Before such a program (AArch64, Go 1.19 or newer) starts, The native userland changes its file in place, once: +// - the code of gosys/gosys.c is put after the program's code, in the zero padding that the Go +// linker leaves between its segments (the segment is made longer, and executable if it only +// was readable), +// - zero-filled memory for it is added to the end of the program's data segment, +// - the "svc #0" of Syscall6 becomes a branch to a few instructions in that code, which call it +// and go back to the instruction after the "svc". +// The code maps the paths of the calls into the rootfs, as the hook does for C programs, and starts +// the programs of the rootfs through the hook. The file keeps its size, its times and its mode; +// only the program headers, the padding and one instruction differ. The file is changed back and +// patched again when the code of a newer The native userland differs (the trailer says what to undo). + +#ifdef DDNATV_HAVE_GOSYS + +#define GO_MAX_PH 32 +#define GO_PF_X 1u +#define GO_PF_W 2u +#define GO_ET_EXEC 2 +#define GO_ET_DYN 3 + +struct go_ph { + uint32_t type, flags; + uint64_t offset, vaddr, filesz, memsz; + uint64_t pos; // where the entry is in the file +}; + +static uint64_t go_rd64(const unsigned char *p) { return (uint64_t)rd32(p) | ((uint64_t)rd32(p + 4) << 32); } +static void go_wr64(unsigned char *p, uint64_t v) { wr32(p, (uint32_t)v); wr32(p + 4, (uint32_t)(v >> 32)); } + +// The program headers of a 64-bit little-endian ELF; their number, or -1 +static int go_read_phdrs(int fd, struct go_ph *ph, uint16_t *etype, uint16_t *machine) { + unsigned char eh[64]; + if (pread(fd, eh, sizeof(eh), 0) != (ssize_t)sizeof(eh) || memcmp(eh, "\x7f" "ELF", 4) != 0 || eh[4] != 2 || eh[5] != 1) + return -1; + *etype = rd16(eh + 16); + *machine = rd16(eh + 18); + uint64_t phoff = go_rd64(eh + 32); + uint16_t phentsize = rd16(eh + 54), phnum = rd16(eh + 56); + if (phentsize != 56 || phnum == 0 || phnum > GO_MAX_PH) return -1; + for (int i = 0; i < phnum; i++) { + unsigned char e[56]; + uint64_t pos = phoff + (uint64_t)i * 56; + if (pread(fd, e, sizeof(e), (off_t)pos) != (ssize_t)sizeof(e)) return -1; + ph[i].type = rd32(e); + ph[i].flags = rd32(e + 4); + ph[i].offset = go_rd64(e + 8); + ph[i].vaddr = go_rd64(e + 16); + ph[i].filesz = go_rd64(e + 32); + ph[i].memsz = go_rd64(e + 40); + ph[i].pos = pos; + } + return phnum; +} + +// The instructions of Syscall6 up to its system call: x8 and x0 to x5 loaded from the stack +// (ldr x8, [sp, #8]; ldr x0, [sp, #16] ... ldr x5, [sp, #56]), then "svc #0" and "cmn x0, #4095" +static const uint32_t k_go_syscall6[7] = { + 0xf94007e8u, 0xf9400be0u, 0xf9400fe1u, 0xf94013e2u, 0xf94017e3u, 0xf9401be4u, 0xf9401fe5u, +}; +#define GO_SVC 0xd4000001u +#define GO_CMN_X0_4095 0xb13ffc1fu + +// Where Syscall6 makes its call: the file offset of the instruction after the seven loads (the +// "svc #0", or the branch that replaced it). *found counts the places; the first is returned. +static int64_t go_find_syscall6(int fd, const struct go_ph *ph, int n, int *found) { + int64_t first = -1; + *found = 0; + enum { CHUNK = 1 << 20, KEEP = 36 }; + unsigned char *buf = (unsigned char *)malloc(CHUNK + KEEP); + if (!buf) return -1; + for (int i = 0; i < n; i++) { + if (ph[i].type != 1 /* PT_LOAD */ || !(ph[i].flags & GO_PF_X) || ph[i].filesz == 0) continue; + uint64_t pos = 0; + while (pos < ph[i].filesz) { + uint64_t want = ph[i].filesz - pos; + if (want > CHUNK + KEEP) want = CHUNK + KEEP; + ssize_t got = pread(fd, buf, (size_t)want, (off_t)(ph[i].offset + pos)); + if (got <= KEEP) break; + for (ssize_t o = 0; o + 36 <= got; o += 4) { + if (rd32(buf + o) != k_go_syscall6[0]) continue; + int same = 1; + for (int k = 1; k < 7 && same; k++) same = rd32(buf + o + 4 * k) == k_go_syscall6[k]; + if (!same || rd32(buf + o + 32) != GO_CMN_X0_4095) continue; + if (*found == 0) first = (int64_t)(ph[i].offset + pos + (uint64_t)o + 28); + (*found)++; + } + if (pos + (uint64_t)got >= ph[i].filesz) break; + pos += (uint64_t)got - (KEEP - 4); // the next chunk starts where the last place of this could begin, no place is split or counted twice + } + } + free(buf); + return first; +} + +// "b " / "bl " for a distance in bytes, or 0 when it does not fit +static uint32_t go_branch(uint32_t base, int64_t delta) { + if ((delta & 3) != 0 || delta >= (1LL << 27) || delta < -(1LL << 27)) return 0; + return base | (uint32_t)((delta >> 2) & 0x3ffffff); +} + +static uint64_t go_align_up(uint64_t v, uint64_t a) { return (v + a - 1) & ~(a - 1); } + +// The strings the added code needs, as they are now +static int go_make_header(struct gosys_hdr *h) { + if (g_ddnatv_root_len == 0 || g_ddnatv_root_len >= GOSYS_ROOT_MAX) return -1; + memcpy(h->root, g_ddnatv_root, g_ddnatv_root_len); + h->root_len = (uint32_t)g_ddnatv_root_len; + + char buf[PATH_MAX]; + if (find_dynamic_linker_for_machine(g_ddnatv_root, EM_AARCH64, buf, sizeof(buf)) && strlen(buf) < GOSYS_PATH_MAX) { + h->ldso_len = (uint32_t)strlen(buf); + memcpy(h->ldso, buf, h->ldso_len); + } + static const char *const hooks[] = { "/usr/lib/libddnatv-hook.so", "/lib/libddnatv-hook.so" }; + for (size_t i = 0; i < sizeof(hooks) / sizeof(hooks[0]); i++) { + size_t n = ddnatv_append(buf, sizeof(buf), 0, g_ddnatv_root, g_ddnatv_root_len); + n = ddnatv_append(buf, sizeof(buf), n, hooks[i], strlen(hooks[i])); + if (n < GOSYS_PATH_MAX && access(buf, F_OK) == 0) { + h->hook_len = (uint32_t)n; + memcpy(h->hook, buf, n); + break; + } + } + // The program that starts the others: bash, which can give them the argv[0] they are asked for + static const char *const runners[] = { "/usr/bin/bash", "/bin/bash", "/usr/bin/env", "/bin/env" }; + for (size_t i = 0; i < sizeof(runners) / sizeof(runners[0]); i++) { + size_t n = ddnatv_append(buf, sizeof(buf), 0, g_ddnatv_root, g_ddnatv_root_len); + n = ddnatv_append(buf, sizeof(buf), n, runners[i], strlen(runners[i])); + if (n < GOSYS_PATH_MAX && access(buf, F_OK) == 0) { + h->runner_len = (uint32_t)n; + memcpy(h->runner, buf, n); + if (i < 2) h->flags |= GOSYS_FLAG_RUNNER_IS_BASH; + break; + } + } + // The directories the programs of an AArch64 rootfs load their libraries from + static const int dirs[] = { 0, 1, 4, 5, 6 }; + size_t used = 0; + for (size_t i = 0; i < sizeof(dirs) / sizeof(dirs[0]); i++) { + const char *d = k_rootfs_lib_dirs[dirs[i]]; + if (i > 0) used = ddnatv_append(buf, sizeof(buf), used, ":", 1); + used = ddnatv_append(buf, sizeof(buf), used, g_ddnatv_root, g_ddnatv_root_len); + used = ddnatv_append(buf, sizeof(buf), used, d, strlen(d)); + } + if (used < GOSYS_LIBS_MAX) { + h->libs_len = (uint32_t)used; + memcpy(h->libs, buf, used); + } + if (h->ldso_len == 0 || h->runner_len == 0) h->runner_len = 0; // Ubuntu programs cannot be started + return 0; +} + +static int go_pwrite_all(int fd, const void *buf, size_t len, uint64_t off) { + return pwrite(fd, buf, len, (off_t)off) == (ssize_t)len ? 0 : -1; +} + +static int go_open_for_write(int fd, const struct stat *st, const char *path, int *made_writable) { + int wfd = open(path, O_WRONLY | O_CLOEXEC); + if (wfd < 0 && errno == EACCES && fchmod(fd, (st->st_mode | S_IWUSR) & 07777) == 0) { + *made_writable = 1; + wfd = open(path, O_WRONLY | O_CLOEXEC); + } + return wfd; // ETXTBSY: the program is running right now, patched at its next start +} + +// The bytes of the added code for a given place: the code with its header (the strings, and where +// the scratch memory is), the instructions that connect the call site to it, and the trailer that +// says what was changed to put it there. +static void go_build_image(unsigned char *img, const struct gosys_hdr *strings, uint64_t cave_v, uint64_t scratch_v, + uint32_t to_entry, uint32_t back, const struct gosys_trailer *info) { + memcpy(img, gosys_blob, GOSYS_BLOB_SIZE); + struct gosys_hdr h = *strings; + h.scratch_rel = (int64_t)scratch_v - (int64_t)cave_v; + memcpy(img, &h, sizeof(h)); + unsigned char *th = img + GOSYS_THUNKS_OFF; + wr32(th + 0, 0xd10043ffu); // sub sp, sp, #16 + wr32(th + 4, 0xf90003feu); // str x30, [sp] + wr32(th + 8, 0xaa0803e7u); // mov x7, x8 (the number is the eighth argument) + wr32(th + 12, to_entry); // bl entry + wr32(th + 16, 0xf94003feu); // ldr x30, [sp] + wr32(th + 20, 0x910043ffu); // add sp, sp, #16 + wr32(th + 24, back); // b + struct gosys_trailer t; + memcpy(&t, img + GOSYS_BLOB_SIZE - sizeof(t), sizeof(t)); + t.version = GOSYS_VERSION; + t.total_size = GOSYS_BLOB_SIZE; + t.text_orig_filesz = info->text_orig_filesz; + t.text_orig_flags = info->text_orig_flags; + t.rw_orig_memsz = info->rw_orig_memsz; + t.text_index = info->text_index; + t.rw_index = info->rw_index; + t.site_file_off = info->site_file_off; + memcpy(img + GOSYS_BLOB_SIZE - sizeof(t), &t, sizeof(t)); +} + +// A short fingerprint of the added code, so that a program patched by an older The native userland is looked at +// again (the marker of a prepared program has it) +static uint32_t go_blob_fingerprint(void) { + static uint32_t fp; + if (fp == 0) { + uint32_t h = 2166136261u; + for (size_t i = 0; i < GOSYS_BLOB_SIZE; i++) h = (h ^ gosys_blob[i]) * 16777619u; + fp = h ? h : 1; + } + return fp; +} + +// Gives the program its old segments and call back: the added code is zeroed, the data segment +// is shortened, the instruction is a "svc #0" again. +static int go_undo(int wfd, struct go_ph *ph, int cave_seg, const struct gosys_trailer *tr, int64_t site_off) { + uint64_t cave_off = ph[cave_seg].offset + ph[cave_seg].filesz - tr->total_size; + unsigned char word[4]; + wr32(word, GO_SVC); + if (go_pwrite_all(wfd, word, 4, (uint64_t)site_off) != 0) return -1; + unsigned char sz[16]; + go_wr64(sz, tr->text_orig_filesz); + go_wr64(sz + 8, tr->text_orig_filesz); + if (go_pwrite_all(wfd, sz, 16, ph[cave_seg].pos + 32) != 0) return -1; + wr32(word, tr->text_orig_flags); + if (go_pwrite_all(wfd, word, 4, ph[cave_seg].pos + 4) != 0) return -1; + if (tr->rw_index < GO_MAX_PH) { + unsigned char mem[8]; + go_wr64(mem, tr->rw_orig_memsz); + if (go_pwrite_all(wfd, mem, 8, ph[tr->rw_index].pos + 40) != 0) return -1; + } + unsigned char *zero = (unsigned char *)calloc(1, tr->total_size); + if (!zero) return -1; + int rc = go_pwrite_all(wfd, zero, tr->total_size, cave_off); + free(zero); + return rc; +} + +// DDNATV_NO_GOSYS=1 (any value but empty or 0): no code is added to Go programs, and the code that is +// in one is taken out again, so that a program can be run as it was built, to see whether a fault +// is the program's or the code's. The marker of a prepared program says it (static_marker). +static int go_disabled(void) { + const char *v = getenv("DDNATV_NO_GOSYS"); + return v && v[0] != '\0' && strcmp(v, "0") != 0; +} + +// The three branches that connect the call site and the code: site -> thunk, thunk -> entry (bl), +// thunk -> the instruction after the site. 0 when one of them is too far. +static int go_branches(uint64_t cave_v, uint64_t site_v, uint32_t *to_thunk, uint32_t *to_entry, uint32_t *back) { + uint64_t thunk_v = cave_v + GOSYS_THUNKS_OFF; + *to_thunk = go_branch(0x14000000u, (int64_t)thunk_v - (int64_t)site_v); + *to_entry = go_branch(0x94000000u, (int64_t)(cave_v + GOSYS_ENTRY_OFF) - (int64_t)(thunk_v + 12)); + *back = go_branch(0x14000000u, (int64_t)(site_v + 4) - (int64_t)(thunk_v + 24)); + return *to_thunk && *to_entry && *back; +} + +// Adds the code to the program, or brings it up to date. Returns 1 when it changed the file, 0 when +// there was nothing to do (not a Go program of a kind the code can serve, or already done), -1 when +// the file could not be changed (it is started as it is). +static int prepare_go_program(int fd, const char *path, const struct stat *st) { + struct go_ph ph[GO_MAX_PH]; + uint16_t etype = 0, machine = 0; + int n = go_read_phdrs(fd, ph, &etype, &machine); + if (n < 0) return -1; + if (machine != EM_AARCH64 || (etype != GO_ET_EXEC && etype != GO_ET_DYN)) return 0; + + int found = 0; + int64_t site_off = go_find_syscall6(fd, ph, n, &found); + if (found != 1) return 0; // not a Go of 1.19 or newer (or its function is not there once) + + // The loadable segments, by address + int order[GO_MAX_PH], nl = 0; + for (int i = 0; i < n; i++) { + if (ph[i].type != 1 /* PT_LOAD */) continue; + int k = nl++; + while (k > 0 && ph[order[k - 1]].vaddr > ph[i].vaddr) { + order[k] = order[k - 1]; + k--; + } + order[k] = i; + } + if (nl < 2) return 0; + + // The call site must be in a segment that is mapped as code + uint64_t site_v = 0; + for (int i = 0; i < nl; i++) { + const struct go_ph *s = &ph[order[i]]; + if ((s->flags & GO_PF_X) && (uint64_t)site_off >= s->offset && (uint64_t)site_off < s->offset + s->filesz) + site_v = s->vaddr + ((uint64_t)site_off - s->offset); + } + if (site_v == 0) return 0; + + struct gosys_hdr strings; + memset(&strings, 0, sizeof(strings)); + memcpy(strings.magic, "CXGOSYS1", 8); + strings.version = GOSYS_VERSION; + if (go_make_header(&strings) != 0) return 0; + + unsigned char *img = (unsigned char *)malloc(GOSYS_BLOB_SIZE); + unsigned char *have = (unsigned char *)malloc(GOSYS_BLOB_SIZE); + if (!img || !have) { + free(img); + free(have); + return -1; + } + int wfd = -1, made_writable = 0, changed = 0, rc = 0; + unsigned char word[4]; + + // An earlier run's code: it ends the segment it is in, and says what it changed + int cave_seg = -1; + struct gosys_trailer tr; + memset(&tr, 0, sizeof(tr)); + for (int i = 0; i < nl && cave_seg < 0; i++) { + const struct go_ph *s = &ph[order[i]]; + if (s->filesz < sizeof(tr) + sizeof(struct gosys_hdr)) continue; + struct gosys_trailer t; + if (pread(fd, &t, sizeof(t), (off_t)(s->offset + s->filesz - sizeof(t))) != (ssize_t)sizeof(t)) continue; + if (memcmp(t.magic, "CXGOEND1", 8) != 0 || t.total_size > s->filesz || t.total_size < sizeof(t) + sizeof(struct gosys_hdr)) continue; + tr = t; + cave_seg = order[i]; + } + + if (go_disabled()) { + if (cave_seg >= 0) { + wfd = go_open_for_write(fd, st, path, &made_writable); + if (wfd < 0) { + rc = -1; + } else { + rc = go_undo(wfd, ph, cave_seg, &tr, site_off); + changed = rc == 0; + } + } + goto done; + } + + if (cave_seg >= 0) { + uint64_t cave_off = ph[cave_seg].offset + ph[cave_seg].filesz - tr.total_size; + uint64_t cave_v = ph[cave_seg].vaddr + (cave_off - ph[cave_seg].offset); + int same = 0, site_ok = 0; + uint32_t to_thunk = 0, to_entry = 0, back = 0; + // Is it what would be put there now? (the code of an older The native userland differs) + if (tr.total_size == GOSYS_BLOB_SIZE && tr.rw_index < (uint32_t)n && ph[tr.rw_index].type == 1 && + go_branches(cave_v, site_v, &to_thunk, &to_entry, &back)) { + uint64_t scratch_v = go_align_up(ph[tr.rw_index].vaddr + tr.rw_orig_memsz, 64); + go_build_image(img, &strings, cave_v, scratch_v, to_entry, back, &tr); + same = pread(fd, have, GOSYS_BLOB_SIZE, (off_t)cave_off) == (ssize_t)GOSYS_BLOB_SIZE && + memcmp(have, img, GOSYS_BLOB_SIZE) == 0 && + ph[tr.rw_index].memsz == scratch_v - ph[tr.rw_index].vaddr + GOSYS_SCRATCH_SIZE; + } + unsigned char cur[4]; + site_ok = same && pread(fd, cur, 4, (off_t)site_off) == 4 && rd32(cur) == to_thunk; + if (same && site_ok) goto done; + + wfd = go_open_for_write(fd, st, path, &made_writable); + if (wfd < 0) { + rc = -1; + goto done; + } + if (same) { + // The code is there, only the branch is not (a patch that was cut short) + wr32(word, to_thunk); + rc = go_pwrite_all(wfd, word, 4, (uint64_t)site_off); + changed = rc == 0; + goto done; + } + // An older code, or other strings: back to the plain program, then patch again + if (go_undo(wfd, ph, cave_seg, &tr, site_off) != 0) { + rc = -1; + goto done; + } + close(wfd); + wfd = -1; + if (made_writable) fchmod(fd, st->st_mode & 07777); + free(img); + free(have); + return prepare_go_program(fd, path, st); + } + + // A place for the code: the end of a segment that is followed by padding up to the next one + uint64_t total = GOSYS_BLOB_SIZE; + int text = -1; + uint64_t cave_v = 0, cave_off = 0; + for (int pass = 0; pass < 2 && text < 0; pass++) { + for (int k = 0; k + 1 < nl && text < 0; k++) { + const struct go_ph *s = &ph[order[k]], *nx = &ph[order[k + 1]]; + if (pass == 0 ? !(s->flags & GO_PF_X) : (s->flags & GO_PF_W)) continue; + if (s->memsz != s->filesz || s->filesz == 0) continue; + uint64_t v = go_align_up(s->vaddr + s->filesz, 64); + uint64_t off = s->offset + (v - s->vaddr); + if (v + total > nx->vaddr || (nx->vaddr & 0x3fff) != 0) continue; + if (off + total > nx->offset || off + total > (uint64_t)st->st_size) continue; + // Only padding may be written over + uint64_t pad_from = s->offset + s->filesz, pad_len = off + total - pad_from; + unsigned char *pad = (unsigned char *)malloc(pad_len); + if (!pad) continue; + int zero = pread(fd, pad, pad_len, (off_t)pad_from) == (ssize_t)pad_len; + for (uint64_t i = 0; zero && i < pad_len; i++) zero = pad[i] == 0; + free(pad); + if (!zero) continue; + text = order[k]; + cave_v = v; + cave_off = off; + } + } + int rw = order[nl - 1]; + uint32_t to_thunk = 0, to_entry = 0, back = 0; + if (text < 0 || !(ph[rw].flags & GO_PF_W) || rw == text || !go_branches(cave_v, site_v, &to_thunk, &to_entry, &back)) goto done; + + uint64_t scratch_v = go_align_up(ph[rw].vaddr + ph[rw].memsz, 64); + struct gosys_trailer info; + memset(&info, 0, sizeof(info)); + info.text_orig_filesz = ph[text].filesz; + info.text_orig_flags = ph[text].flags; + info.rw_orig_memsz = ph[rw].memsz; + info.text_index = (uint32_t)text; + info.rw_index = (uint32_t)rw; + info.site_file_off = (uint64_t)site_off; + go_build_image(img, &strings, cave_v, scratch_v, to_entry, back, &info); + + wfd = go_open_for_write(fd, st, path, &made_writable); + if (wfd < 0) { + rc = -1; + goto done; + } + // The code first and the call site last: whatever is cut short leaves a program that runs + unsigned char sz[16]; + unsigned char mem[8]; + go_wr64(mem, scratch_v - ph[rw].vaddr + GOSYS_SCRATCH_SIZE); + go_wr64(sz, cave_v + GOSYS_BLOB_SIZE - ph[text].vaddr); + go_wr64(sz + 8, cave_v + GOSYS_BLOB_SIZE - ph[text].vaddr); + rc = go_pwrite_all(wfd, img, GOSYS_BLOB_SIZE, cave_off); + if (rc == 0) rc = go_pwrite_all(wfd, mem, 8, ph[rw].pos + 40); + if (rc == 0) rc = go_pwrite_all(wfd, sz, 16, ph[text].pos + 32); + if (rc == 0 && !(ph[text].flags & GO_PF_X)) { + wr32(word, ph[text].flags | GO_PF_X); + rc = go_pwrite_all(wfd, word, 4, ph[text].pos + 4); + } + if (rc == 0) { + wr32(word, to_thunk); + rc = go_pwrite_all(wfd, word, 4, (uint64_t)site_off); + } + changed = rc == 0; + +done: + free(img); + free(have); + if (wfd >= 0) { + // Keep the times: make and friends must not see a rebuilt program. + const struct timespec times[2] = { st->st_atim, st->st_mtim }; + futimens(wfd, times); + close(wfd); + } + if (made_writable) fchmod(fd, st->st_mode & 07777); + if (rc != 0) return -1; + return changed ? 1 : 0; +} + +#endif /* DDNATV_HAVE_GOSYS */ diff --git a/tools/nativeguest/hook/hardlinks.c b/tools/nativeguest/hook/hardlinks.c new file mode 100644 index 0000000000..ed8a32f7b2 --- /dev/null +++ b/tools/nativeguest/hook/hardlinks.c @@ -0,0 +1,628 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Hard links: link() falls back to a copy that reports the link count of a real link, in every +// process of the rootfs. + +// Emulated hard links. Android does not let apps create hard links, so link() falls back to a copy +// (ddnatv_emulate_hardlinkat). Programs that check the result through the link count, such as the +// lock files of shadow (link(file.PID, file.lock), then stat(file.PID).st_nlink == 2), and those +// that look for files linked to each other (tar, rsync -H, du, find -samefile), are shown what a +// real link would give: every copy of one emulated link reports the inode number of the original +// and the number of copies as its link count. +// +// The copies are recorded in a table that every process of the rootfs maps +// ($DDNATV_ROOT/var/lib/ddnatv/hardlinks), so "ln a b" in one process and "stat a" in the next +// agree, also after the app restarts. Copies are recorded by device and inode, so a relative name, +// an absolute name and an open descriptor of the same file all match, and with their modification +// time: a copy written to since (it no longer shares the original's content) or a new file that got +// the inode number of a removed copy (removed outside the hook, e.g. in root mode) do not match. +// +// Readers (every stat) take no lock: a sequence number that writers make odd while they change the +// table tells them to read again. Writers (link, unlink, rename) take an fcntl lock on the file. +// Without a rootfs (or when the file cannot be made) the table is private to the process and its +// children, as it was before. + +#define DDNATV_HL_MAGIC 0x6b6e6c43u // "Clnk" +#define DDNATV_HL_VERSION 1u +#define DDNATV_HL_SLOTS 8192u // a power of two +#define DDNATV_HL_MAX_USED 6144u // at most 3/4 full, so that lookups stay short +#define DDNATV_HL_EMPTY 0u +#define DDNATV_HL_USED 1u +#define DDNATV_HL_DELETED 2u + +typedef struct { + uint64_t dev, ino; // this copy + int64_t mtime_sec, mtime_nsec; // its modification time when it was linked (compared in whole + // seconds: stat() and statx() need not agree on the fraction) + uint64_t group_dev, group_ino; // the original, whose inode number every copy reports + uint32_t state; + uint32_t nlink; // copies in the group + uint32_t pad[2]; +} ddnatv_hl_slot_t; + +typedef struct { + uint32_t magic, version; + uint32_t seq; // odd while a writer changes the table + uint32_t used, deleted; + uint32_t pad[11]; + ddnatv_hl_slot_t slots[DDNATV_HL_SLOTS]; +} ddnatv_hl_table_t; + +// The file and the mapping, in whole 64 KB: a size that is a multiple of every page size +#define DDNATV_HL_MAP_SIZE ((sizeof(ddnatv_hl_table_t) + 0xffff) & ~(size_t)0xffff) + +static ddnatv_hl_table_t *g_hl_table = NULL; // set once, then never changed (until a test resets it) +static int g_hl_shared = 0; // mapped from the rootfs' file +static long g_hl_next_try = 0; // when to look for the file again (monotonic seconds) +static pthread_mutex_t g_hardlinks_lock = PTHREAD_MUTEX_INITIALIZER; + +#ifndef DDNATV_HOST_TEST +static void init_ddnatv_hook(void); +#endif + +static size_t hl_table_path(char *buf, size_t size) { +#ifndef DDNATV_HOST_TEST + // The rootfs is known once a path was rewritten; "ln a b" or "stat a" name only relative ones + init_ddnatv_hook(); +#endif + if (g_ddnatv_root_len == 0) return 0; + size_t n = ddnatv_append(buf, size, 0, g_ddnatv_root, g_ddnatv_root_len); + static const char rel[] = "/var/lib/ddnatv/hardlinks"; + n = ddnatv_append(buf, size, n, rel, sizeof(rel) - 1); + return n == g_ddnatv_root_len + sizeof(rel) - 1 ? n : 0; +} + +static long hl_now_seconds(void) { + struct timespec ts; +#ifdef CLOCK_MONOTONIC_COARSE + if (clock_gettime(CLOCK_MONOTONIC_COARSE, &ts) == 0) return (long)ts.tv_sec; +#endif + if (clock_gettime(CLOCK_MONOTONIC, &ts) == 0) return (long)ts.tv_sec; + return 0; +} + +static int hl_open_file(const char *path, int create) { + return (int)syscall(SYS_openat, AT_FDCWD, path, O_RDWR | O_CLOEXEC | (create ? O_CREAT : 0), 0600); +} + +// Takes the writers' lock on the table's file (blocking); -1 when there is no file to lock. +static int hl_lock_file(void) { + if (!g_hl_shared) return -1; + char path[PATH_MAX]; + if (!hl_table_path(path, sizeof(path))) return -1; + int fd = hl_open_file(path, 0); + if (fd < 0) return -1; + struct flock fl; + memset(&fl, 0, sizeof(fl)); + fl.l_type = F_WRLCK; + fl.l_whence = SEEK_SET; + while (fcntl(fd, F_SETLKW, &fl) != 0 && errno == EINTR) { + } + return fd; +} + +static void hl_unlock_file(int fd) { + if (fd >= 0) syscall(SYS_close, fd); // closing the file drops the lock +} + +static void hl_init_header(ddnatv_hl_table_t *t) { + memset(t, 0, sizeof(*t)); + t->version = DDNATV_HL_VERSION; + __atomic_store_n(&t->magic, DDNATV_HL_MAGIC, __ATOMIC_RELEASE); +} + +// The size of an open file. Not fstat(): this library's own fstat() looks into the table, which +// would wait for the lock that the caller holds. +static off_t hl_file_size(int fd) { + return lseek(fd, 0, SEEK_END); +} + +// Maps the table. Readers (create = 0) get NULL while no process has made the file yet, and look +// for it again a second later; writers make it, or fall back to a table of this process. Readers +// never wait for the lock (a stat() while it is held, or in a child forked while another thread +// held it, would wait forever): they find no table then. +static ddnatv_hl_table_t *hl_table(int create) { + ddnatv_hl_table_t *t = __atomic_load_n(&g_hl_table, __ATOMIC_ACQUIRE); + if (t) return t; + if (!create && __atomic_load_n(&g_hl_next_try, __ATOMIC_RELAXED) > hl_now_seconds()) return NULL; + int saved_errno = errno; + if (create) { + pthread_mutex_lock(&g_hardlinks_lock); + } else if (pthread_mutex_trylock(&g_hardlinks_lock) != 0) { + errno = saved_errno; + return NULL; + } + t = g_hl_table; + if (!t) { + char path[PATH_MAX]; + path[0] = '\0'; + int have_path = hl_table_path(path, sizeof(path)) != 0; + int fd = have_path ? hl_open_file(path, 0) : -1; + if (fd < 0 && create && path[0]) { + // var/lib/ddnatv may not exist yet + char dir[PATH_MAX]; + size_t n = ddnatv_append(dir, sizeof(dir), 0, path, strlen(path) - strlen("/hardlinks")); + if (n > 0) syscall(SYS_mkdirat, AT_FDCWD, dir, 0700); + fd = hl_open_file(path, 1); + } + if (fd >= 0) { + off_t size = hl_file_size(fd); + int ok = size >= 0; + if (ok && (size_t)size < DDNATV_HL_MAP_SIZE) { + // New (or an older, shorter format): made by a writer, under the lock + ok = 0; + if (create) { + struct flock fl; + memset(&fl, 0, sizeof(fl)); + fl.l_type = F_WRLCK; + fl.l_whence = SEEK_SET; + while (fcntl(fd, F_SETLKW, &fl) != 0 && errno == EINTR) { + } + size = hl_file_size(fd); + ok = size >= 0 && + ((size_t)size >= DDNATV_HL_MAP_SIZE || ftruncate(fd, DDNATV_HL_MAP_SIZE) == 0); + } + } + if (ok) { + void *m = mmap(NULL, DDNATV_HL_MAP_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0); + if (m != MAP_FAILED) { + t = (ddnatv_hl_table_t *)m; + if (t->magic != DDNATV_HL_MAGIC || t->version != DDNATV_HL_VERSION) { + if (create) { + // Still under the lock taken above when the file was new; otherwise take it + struct flock fl; + memset(&fl, 0, sizeof(fl)); + fl.l_type = F_WRLCK; + fl.l_whence = SEEK_SET; + while (fcntl(fd, F_SETLKW, &fl) != 0 && errno == EINTR) { + } + if (t->magic != DDNATV_HL_MAGIC || t->version != DDNATV_HL_VERSION) hl_init_header(t); + } else { + munmap(m, DDNATV_HL_MAP_SIZE); + t = NULL; + } + } + if (t) g_hl_shared = 1; + } + } + syscall(SYS_close, fd); // the mapping stays; also drops the lock + } + if (!t && create) { + // No rootfs file: this process and its children share a table + void *m = mmap(NULL, DDNATV_HL_MAP_SIZE, PROT_READ | PROT_WRITE, MAP_SHARED | MAP_ANONYMOUS, -1, 0); + if (m != MAP_FAILED) { + t = (ddnatv_hl_table_t *)m; + hl_init_header(t); + g_hl_shared = 0; + } + } + if (t) { + __atomic_store_n(&g_hl_table, t, __ATOMIC_RELEASE); + } else if (have_path) { + // No table yet: looked for again a second later (without a rootfs there is none to wait for) + __atomic_store_n(&g_hl_next_try, hl_now_seconds() + 1, __ATOMIC_RELAXED); + } + } + pthread_mutex_unlock(&g_hardlinks_lock); + errno = saved_errno; + return t; +} + +// Whether any emulated link may exist; what the stat() hooks check first. +static inline int hardlinks_maybe_any(void) { + ddnatv_hl_table_t *t = hl_table(0); + return t && __atomic_load_n(&t->used, __ATOMIC_RELAXED) > 0; +} + +static inline uint32_t hl_hash(uint64_t dev, uint64_t ino) { + uint64_t h = ino * 0x9E3779B97F4A7C15ull ^ (dev + 0x632BE59BD9B4E019ull) * 0xC2B2AE3D27D4EB4Full; + return (uint32_t)(h >> 40) & (DDNATV_HL_SLOTS - 1); +} + +// The slot of a copy, or -1. Writers only (under the locks). +static long hl_find_locked(ddnatv_hl_table_t *t, uint64_t dev, uint64_t ino) { + uint32_t i = hl_hash(dev, ino); + for (uint32_t n = 0; n < DDNATV_HL_SLOTS; n++, i = (i + 1) & (DDNATV_HL_SLOTS - 1)) { + ddnatv_hl_slot_t *s = &t->slots[i]; + if (s->state == DDNATV_HL_EMPTY) return -1; + if (s->state == DDNATV_HL_USED && s->ino == ino && s->dev == dev) return (long)i; + } + return -1; +} + +// Writers: the process' mutex, the file's lock, then the sequence number made odd. +static int hl_write_begin(ddnatv_hl_table_t *t) { + pthread_mutex_lock(&g_hardlinks_lock); + int fd = hl_lock_file(); + uint32_t seq = __atomic_load_n(&t->seq, __ATOMIC_RELAXED); + // An odd number left by a writer that died: the lock was given up with it + if (!(seq & 1)) seq++; + __atomic_store_n(&t->seq, seq, __ATOMIC_RELAXED); + __atomic_thread_fence(__ATOMIC_RELEASE); + return fd; +} + +static void hl_write_end(ddnatv_hl_table_t *t, int fd) { + __atomic_store_n(&t->seq, __atomic_load_n(&t->seq, __ATOMIC_RELAXED) + 1, __ATOMIC_RELEASE); + hl_unlock_file(fd); + pthread_mutex_unlock(&g_hardlinks_lock); +} + +// Rebuilds the table without the slots of removed copies, which make every lookup longer. +static void hl_compact_locked(ddnatv_hl_table_t *t) { + ddnatv_hl_slot_t *keep = (ddnatv_hl_slot_t *)malloc(sizeof(ddnatv_hl_slot_t) * DDNATV_HL_MAX_USED); + if (!keep) return; + uint32_t n = 0; + for (uint32_t i = 0; i < DDNATV_HL_SLOTS && n < DDNATV_HL_MAX_USED; i++) { + if (t->slots[i].state == DDNATV_HL_USED) keep[n++] = t->slots[i]; + } + memset(t->slots, 0, sizeof(t->slots)); + for (uint32_t k = 0; k < n; k++) { + uint32_t i = hl_hash(keep[k].dev, keep[k].ino); + while (t->slots[i].state != DDNATV_HL_EMPTY) i = (i + 1) & (DDNATV_HL_SLOTS - 1); + t->slots[i] = keep[k]; + } + t->used = n; + t->deleted = 0; + free(keep); +} + +static int hl_put_locked(ddnatv_hl_table_t *t, const struct stat *st, uint64_t group_dev, uint64_t group_ino) { + long i = hl_find_locked(t, st->st_dev, st->st_ino); + if (i < 0) { + if (t->used >= DDNATV_HL_MAX_USED) return -1; + if (t->used + t->deleted >= DDNATV_HL_SLOTS - DDNATV_HL_SLOTS / 8) hl_compact_locked(t); + uint32_t j = hl_hash(st->st_dev, st->st_ino); + while (t->slots[j].state == DDNATV_HL_USED) j = (j + 1) & (DDNATV_HL_SLOTS - 1); + if (t->slots[j].state == DDNATV_HL_DELETED) t->deleted--; + i = (long)j; + t->used++; + } + ddnatv_hl_slot_t *s = &t->slots[i]; + s->dev = st->st_dev; + s->ino = st->st_ino; + s->mtime_sec = st->st_mtim.tv_sec; + s->mtime_nsec = st->st_mtim.tv_nsec; + s->group_dev = group_dev; + s->group_ino = group_ino; + s->nlink = 1; + s->state = DDNATV_HL_USED; + return 0; +} + +static void hl_remove_locked(ddnatv_hl_table_t *t, long i) { + t->slots[i].state = DDNATV_HL_DELETED; + t->used--; + t->deleted++; +} + +// Gives every copy of a group its size; a group of one is a plain file again. +static void hl_update_group_locked(ddnatv_hl_table_t *t, uint64_t group_dev, uint64_t group_ino) { + uint32_t n = 0; + long last = -1; + for (uint32_t i = 0; i < DDNATV_HL_SLOTS; i++) { + ddnatv_hl_slot_t *s = &t->slots[i]; + if (s->state == DDNATV_HL_USED && s->group_ino == group_ino && s->group_dev == group_dev) { + n++; + last = (long)i; + } + } + if (n == 1) { + hl_remove_locked(t, last); + return; + } + for (uint32_t i = 0; i < DDNATV_HL_SLOTS && n > 1; i++) { + ddnatv_hl_slot_t *s = &t->slots[i]; + if (s->state == DDNATV_HL_USED && s->group_ino == group_ino && s->group_dev == group_dev) s->nlink = n; + } +} + +// Removes the copy in slot i. A group reports the inode number of one of its copies (the original); +// when that copy goes, the group reports another one's: the number of a removed file can be given to +// a new file, which must not show up as linked to the copies that are left. +static void hl_remove_copy_locked(ddnatv_hl_table_t *t, long i) { + uint64_t group_dev = t->slots[i].group_dev, group_ino = t->slots[i].group_ino; + int reported = t->slots[i].dev == group_dev && t->slots[i].ino == group_ino; + hl_remove_locked(t, i); + if (reported) { + uint64_t new_dev = 0, new_ino = 0; + int found = 0; + for (uint32_t j = 0; j < DDNATV_HL_SLOTS; j++) { + ddnatv_hl_slot_t *s = &t->slots[j]; + if (s->state != DDNATV_HL_USED || s->group_ino != group_ino || s->group_dev != group_dev) continue; + if (!found) { + new_dev = s->dev; + new_ino = s->ino; + found = 1; + } + s->group_dev = new_dev; + s->group_ino = new_ino; + } + if (found) { + group_dev = new_dev; + group_ino = new_ino; + } + } + hl_update_group_locked(t, group_dev, group_ino); +} + +// Records that the file [copy] is an emulated hard link of [old]. +static void register_emulated_hardlink(const struct stat *old, const struct stat *copy) { + ddnatv_hl_table_t *t = hl_table(1); + if (!t) return; + int saved_errno = errno; + int fd = hl_write_begin(t); + uint64_t group_dev = old->st_dev, group_ino = old->st_ino; + long i = hl_find_locked(t, old->st_dev, old->st_ino); + if (i >= 0 && t->slots[i].mtime_sec == old->st_mtim.tv_sec) { + // Linking a copy again: the new copy joins the same group + group_dev = t->slots[i].group_dev; + group_ino = t->slots[i].group_ino; + } else { + // A stale slot of an earlier file with this inode number + if (i >= 0) hl_remove_copy_locked(t, i); + hl_put_locked(t, old, group_dev, group_ino); + } + if (hl_put_locked(t, copy, group_dev, group_ino) == 0 || hl_find_locked(t, old->st_dev, old->st_ino) >= 0) { + hl_update_group_locked(t, group_dev, group_ino); + } + hl_write_end(t, fd); + errno = saved_errno; +} + +// Forgets a copy whose name was removed; the last copy of a group goes back to a plain file. +static void unregister_emulated_hardlink(dev_t dev, ino_t ino) { + ddnatv_hl_table_t *t = hl_table(0); + if (!t || __atomic_load_n(&t->used, __ATOMIC_RELAXED) == 0) return; + int saved_errno = errno; + int fd = hl_write_begin(t); + long i = hl_find_locked(t, dev, ino); + if (i >= 0) hl_remove_copy_locked(t, i); + hl_write_end(t, fd); + errno = saved_errno; +} + +// Reads the slot of a copy without a lock: 1 and [out] when there is one. +static int hl_read(ddnatv_hl_table_t *t, uint64_t dev, uint64_t ino, ddnatv_hl_slot_t *out) { + for (int tries = 0; tries < 64; tries++) { + uint32_t seq = __atomic_load_n(&t->seq, __ATOMIC_ACQUIRE); + if (seq & 1) { + sched_yield(); + continue; + } + int found = 0; + uint32_t i = hl_hash(dev, ino); + for (uint32_t n = 0; n < DDNATV_HL_SLOTS; n++, i = (i + 1) & (DDNATV_HL_SLOTS - 1)) { + const volatile ddnatv_hl_slot_t *s = &t->slots[i]; + uint32_t state = s->state; + if (state == DDNATV_HL_EMPTY) break; + if (state == DDNATV_HL_USED && s->ino == ino && s->dev == dev) { + memcpy(out, (const void *)s, sizeof(*out)); + found = 1; + break; + } + } + __atomic_thread_fence(__ATOMIC_ACQUIRE); + if (__atomic_load_n(&t->seq, __ATOMIC_RELAXED) == seq) return found; + } + return 0; // a writer that does not finish: as if there were no links +} + +// Makes a stat() result of an emulated hard link look like a real one: the inode number of the +// original and the number of copies as the link count. +static void apply_emulated_hardlink(struct stat *st) { + if (!st || !hardlinks_maybe_any()) return; + ddnatv_hl_slot_t s; + if (!hl_read(g_hl_table, st->st_dev, st->st_ino, &s)) return; + if (s.mtime_sec != (int64_t)st->st_mtim.tv_sec) return; + if (s.nlink > (uint32_t)st->st_nlink) st->st_nlink = (nlink_t)s.nlink; + st->st_ino = (ino_t)s.group_ino; +} + +// The app's own user and group, which the hook presents as root: getuid() and getpwuid() say so, +// and stat() does as well, so that a program that compares a file's owner with getuid() sees the +// files it made as its own (git's "dubious ownership", sshd's /run/sshd, tmux's socket directory, +// ssh's ~/.ssh/config). -1 until known; a test sets them. +static uid_t g_app_uid = (uid_t)-1; +static gid_t g_app_gid = (gid_t)-1; + +static void load_app_ids(void) { +#ifdef DDNATV_HOST_TEST + uid_t uid = getuid(); + gid_t gid = getgid(); +#else + // The real ones (getuid() and syscall() are the hook's own, which answer 0) + static uid_t (*orig_getuid)(void) = NULL; + static gid_t (*orig_getgid)(void) = NULL; + if (!orig_getuid) orig_getuid = (uid_t (*)(void))dlsym(RTLD_NEXT, "getuid"); + if (!orig_getgid) orig_getgid = (gid_t (*)(void))dlsym(RTLD_NEXT, "getgid"); + if (!orig_getuid || !orig_getgid) return; + uid_t uid = orig_getuid(); + gid_t gid = orig_getgid(); +#endif + __atomic_store_n(&g_app_gid, gid, __ATOMIC_RELAXED); + __atomic_store_n(&g_app_uid, uid, __ATOMIC_RELAXED); +} + +static void present_owner_as_root(uid_t *uid, gid_t *gid) { + if (__atomic_load_n(&g_app_uid, __ATOMIC_RELAXED) == (uid_t)-1) load_app_ids(); + uid_t app_uid = __atomic_load_n(&g_app_uid, __ATOMIC_RELAXED); + gid_t app_gid = __atomic_load_n(&g_app_gid, __ATOMIC_RELAXED); + if (app_uid == (uid_t)-1) return; + if (uid && *uid == app_uid) *uid = 0; + if (gid && *gid == app_gid) *gid = 0; +} + +// What the stat() family returns: emulated hard links as real ones, the app's files as root's. +static void apply_stat_emulation(struct stat *st) { + if (!st) return; + apply_emulated_hardlink(st); + present_owner_as_root(&st->st_uid, &st->st_gid); +} + +static int real_fstatat(int dirfd, const char *path, struct stat *st, int flags) { +#ifdef DDNATV_HOST_TEST + return fstatat(dirfd, path, st, flags); +#else + static int (*orig_fstatat)(int, const char *, struct stat *, int) = NULL; + if (!orig_fstatat) orig_fstatat = (int (*)(int, const char *, struct stat *, int))dlsym(RTLD_NEXT, "fstatat"); + return orig_fstatat ? orig_fstatat(dirfd, path, st, flags) : fstatat(dirfd, path, st, flags); +#endif +} + +// Before a name is removed or replaced (unlink, rename over it): whether it is an emulated hard +// link, and which. Costs nothing until the process has made one. +static int lookup_emulated_hardlink_at(int dirfd, const char *path, dev_t *dev, ino_t *ino) { + if (!path || !hardlinks_maybe_any()) return 0; + int saved_errno = errno; + struct stat st; + int found = 0; + if (real_fstatat(dirfd, path, &st, AT_SYMLINK_NOFOLLOW) == 0) { + ddnatv_hl_slot_t s; + found = hl_read(g_hl_table, st.st_dev, st.st_ino, &s); + *dev = st.st_dev; + *ino = st.st_ino; + } + errno = saved_errno; + return found; +} + +static int ddnatv_emulate_hardlinkat(int olddirfd, const char *rold, int newdirfd, const char *rnew) { + if (!rold || !rnew) { + errno = EINVAL; + return -1; + } + struct stat st; +#ifdef DDNATV_HOST_TEST + if (fstatat(olddirfd, rold, &st, 0) != 0) { + return -1; + } +#else + static int (*orig_fstatat)(int, const char *, struct stat *, int) = NULL; + if (!orig_fstatat) orig_fstatat = (int (*)(int, const char *, struct stat *, int))dlsym(RTLD_NEXT, "fstatat"); + if (orig_fstatat) { + if (orig_fstatat(olddirfd, rold, &st, 0) != 0) return -1; + } else { + if (fstatat(olddirfd, rold, &st, 0) != 0) return -1; + } +#endif + if (S_ISDIR(st.st_mode)) { + errno = EPERM; + return -1; + } + + // Clean up stale dangling symlink or stale dead-process lock file at rnew +#ifndef DDNATV_HOST_TEST + struct stat lst; + int have_lst = 0; + if (orig_fstatat) { + if (orig_fstatat(newdirfd, rnew, &lst, AT_SYMLINK_NOFOLLOW) == 0) have_lst = 1; + } else { + if (fstatat(newdirfd, rnew, &lst, AT_SYMLINK_NOFOLLOW) == 0) have_lst = 1; + } + if (have_lst) { + if (S_ISLNK(lst.st_mode)) { + unlinkat(newdirfd, rnew, 0); + } else if (strstr(rnew, ".lock")) { + static int (*orig_openat)(int, const char *, int, ...) = NULL; + if (!orig_openat) orig_openat = (int (*)(int, const char *, int, ...))dlsym(RTLD_NEXT, "openat"); + int rfd = orig_openat ? orig_openat(newdirfd, rnew, O_RDONLY | O_CLOEXEC) + : openat(newdirfd, rnew, O_RDONLY | O_CLOEXEC); + if (rfd >= 0) { + char pbuf[32] = {0}; + ssize_t pr = read(rfd, pbuf, sizeof(pbuf) - 1); + close(rfd); + if (pr > 0) { + pid_t lpid = (pid_t)atoi(pbuf); + if (lpid > 0 && kill(lpid, 0) == -1 && errno == ESRCH) { + unlinkat(newdirfd, rnew, 0); + } + } else { + unlinkat(newdirfd, rnew, 0); + } + } + } + } +#endif + +#ifdef DDNATV_HOST_TEST + int fd_new = openat(newdirfd, rnew, O_WRONLY | O_CREAT | O_EXCL | O_CLOEXEC, st.st_mode & 0777); + if (fd_new < 0) return -1; + int fd_old = openat(olddirfd, rold, O_RDONLY | O_CLOEXEC); +#else + static int (*orig_openat)(int, const char *, int, ...) = NULL; + if (!orig_openat) orig_openat = (int (*)(int, const char *, int, ...))dlsym(RTLD_NEXT, "openat"); + int fd_new = orig_openat ? orig_openat(newdirfd, rnew, O_WRONLY | O_CREAT | O_EXCL | O_CLOEXEC, st.st_mode & 0777) + : openat(newdirfd, rnew, O_WRONLY | O_CREAT | O_EXCL | O_CLOEXEC, st.st_mode & 0777); + if (fd_new < 0) return -1; + int fd_old = orig_openat ? orig_openat(olddirfd, rold, O_RDONLY | O_CLOEXEC) + : openat(olddirfd, rold, O_RDONLY | O_CLOEXEC); +#endif + if (fd_old < 0) { + int err = errno; + close(fd_new); + unlinkat(newdirfd, rnew, 0); + errno = err; + return -1; + } + + ssize_t sent = 0; + int copy_failed = 0; + while (sent < st.st_size) { + ssize_t s = sendfile(fd_new, fd_old, NULL, (size_t)(st.st_size - sent)); + if (s > 0) { + sent += s; + } else { + break; + } + } + if (sent < st.st_size) { + char cbuf[16384]; + ssize_t nread; + while ((nread = read(fd_old, cbuf, sizeof(cbuf))) > 0) { + ssize_t nwritten = 0; + while (nwritten < nread) { + ssize_t w = write(fd_new, cbuf + nwritten, nread - nwritten); + if (w < 0) { + copy_failed = 1; + break; + } + nwritten += w; + } + if (copy_failed) break; + } + if (nread < 0) copy_failed = 1; + } + + fchmod(fd_new, st.st_mode & 0777); + // A hard link shares the times of the original (tar, dpkg and make compare them). + const struct timespec times[2] = { st.st_atim, st.st_mtim }; + futimens(fd_new, times); + struct stat st_new; + memset(&st_new, 0, sizeof(st_new)); +#ifndef DDNATV_HOST_TEST + static int (*orig_fstat)(int, struct stat *) = NULL; + if (!orig_fstat) orig_fstat = (int (*)(int, struct stat *))dlsym(RTLD_NEXT, "fstat"); + if (orig_fstat) orig_fstat(fd_new, &st_new); + else fstat(fd_new, &st_new); +#else + fstat(fd_new, &st_new); +#endif + + close(fd_old); + close(fd_new); + + if (copy_failed) { + unlinkat(newdirfd, rnew, 0); + errno = EIO; + return -1; + } + + register_emulated_hardlink(&st, &st_new); + return 0; +} + +static inline int ddnatv_emulate_hardlink(const char *rold, const char *rnew) { + return ddnatv_emulate_hardlinkat(AT_FDCWD, rold, AT_FDCWD, rnew); +} diff --git a/tools/nativeguest/hook/identity.c b/tools/nativeguest/hook/identity.c new file mode 100644 index 0000000000..9599d7e0b2 --- /dev/null +++ b/tools/nativeguest/hook/identity.c @@ -0,0 +1,838 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Fake root: user and group ids, the shadow lock, and passwd/group lookups from the rootfs. + +#ifndef DDNATV_HOST_TEST + +// Fakeroot identity hooks for APT and DPKG to operate without superuser restrictions +uid_t getuid(void) { return 0; } +uid_t geteuid(void) { return 0; } +gid_t getgid(void) { return 0; } +gid_t getegid(void) { return 0; } + +int setuid(uid_t uid) { (void)uid; return 0; } +int seteuid(uid_t uid) { (void)uid; return 0; } +int setgid(gid_t gid) { (void)gid; return 0; } +int setegid(gid_t gid) { (void)gid; return 0; } +int setreuid(uid_t ruid, uid_t euid) { (void)ruid; (void)euid; return 0; } +int setregid(gid_t rgid, gid_t egid) { (void)rgid; (void)egid; return 0; } +int setresuid(uid_t ruid, uid_t euid, uid_t suid) { (void)ruid; (void)euid; (void)suid; return 0; } +int setresgid(gid_t rgid, gid_t egid, gid_t sgid) { (void)rgid; (void)egid; (void)sgid; return 0; } + +int getgroups(int size, gid_t list[]) { + if (size > 0 && list != NULL) list[0] = 0; + return 1; +} +// What programs built with _FORTIFY_SOURCE call when the buffer's size is known (the check is +// glibc's): without it the count came from the hook (1) and the list from the kernel (the app's +// groups, more than one), and sshd ended the login on "getgroups: Invalid argument" +extern void __chk_fail(void) __attribute__((__noreturn__)); +int __getgroups_chk(int size, gid_t list[], size_t listlen) { + if (size > 0 && (size_t)size * sizeof(gid_t) > listlen) __chk_fail(); + return getgroups(size, list); +} +int setgroups(size_t size, const gid_t *list) { (void)size; (void)list; return 0; } +int initgroups(const char *user, gid_t group) { (void)user; (void)group; return 0; } + +int getgrouplist(const char *user, gid_t group, gid_t *groups, int *ngroups) { + (void)user; + if (!ngroups) { + errno = EINVAL; + return -1; + } + if (*ngroups > 0 && groups) { + groups[0] = group; + *ngroups = 1; + return 1; + } + // Too small (a caller asking for the size first): -1 and the number needed, as glibc does. + *ngroups = 1; + return -1; +} + +// The session's host name, as proot's --kernel-release gave it: Steam names the device after it +int uname(struct utsname *buf) { + static int (*orig_uname)(struct utsname *) = NULL; + if (!orig_uname) orig_uname = (int (*)(struct utsname *))dlsym(RTLD_NEXT, "uname"); + int ret = orig_uname ? orig_uname(buf) : -1; + if (ret == 0 && buf && g_hostname[0]) { + ddnatv_copy_cstr(buf->nodename, sizeof(buf->nodename), g_hostname); + ddnatv_copy_cstr(buf->domainname, sizeof(buf->domainname), "localdomain"); + } + return ret; +} + +int gethostname(char *name, size_t len) { + static int (*orig_gethostname)(char *, size_t) = NULL; + if (!orig_gethostname) orig_gethostname = (int (*)(char *, size_t))dlsym(RTLD_NEXT, "gethostname"); + if (!g_hostname[0]) return orig_gethostname ? orig_gethostname(name, len) : -1; + size_t n = strlen(g_hostname) + 1; + if (!name || n > len) { + if (name && len) memcpy(name, g_hostname, len); + errno = ENAMETOOLONG; + return -1; + } + memcpy(name, g_hostname, n); + return 0; +} + +#endif /* !DDNATV_HOST_TEST */ + +static uid_t real_uid(void) { +#ifdef DDNATV_HOST_TEST + return 10000; +#else + static uid_t (*orig_getuid)(void) = NULL; + if (!orig_getuid) orig_getuid = (uid_t (*)(void))dlsym(RTLD_NEXT, "getuid"); + return orig_getuid ? orig_getuid() : 0; +#endif +} + +static gid_t real_gid(void) { +#ifdef DDNATV_HOST_TEST + return 10000; +#else + static gid_t (*orig_getgid)(void) = NULL; + if (!orig_getgid) orig_getgid = (gid_t (*)(void))dlsym(RTLD_NEXT, "getgid"); + return orig_getgid ? orig_getgid() : 0; +#endif +} + +#ifdef DDNATV_HOST_TEST +#define DDNATV_NSS_SYM(name) hook_##name +#define DDNATV_SHADOW_SYM(name) hook_##name +static int g_test_orig_nss_r_ret = 0; +static int g_test_orig_nss_r_found = 0; + +int hook_link(const char *oldpath, const char *newpath) { + int ret = link(oldpath, newpath); + if (ret != 0 && (errno == EXDEV || errno == EPERM || errno == EACCES || errno == ENOTSUP || errno == ENOSYS)) { + ret = ddnatv_emulate_hardlink(oldpath, newpath); + } + return ret; +} + +int hook_linkat(int olddirfd, const char *oldpath, int newdirfd, const char *newpath, int flags) { + int ret = linkat(olddirfd, oldpath, newdirfd, newpath, flags); + if (ret != 0 && (errno == EXDEV || errno == EPERM || errno == EACCES || errno == ENOTSUP || errno == ENOSYS)) { + ret = ddnatv_emulate_hardlinkat(olddirfd, oldpath, newdirfd, newpath); + } + return ret; +} + +int hook_stat(const char *path, struct stat *st) { + int ret = stat(path, st); + if (ret == 0) apply_stat_emulation(st); + return ret; +} + +int hook_unlink(const char *path) { + dev_t hl_dev = 0; + ino_t hl_ino = 0; + int hardlinked = lookup_emulated_hardlink_at(AT_FDCWD, path, &hl_dev, &hl_ino); + int ret = unlink(path); + if (ret == 0 && hardlinked) unregister_emulated_hardlink(hl_dev, hl_ino); + return ret; +} +#else +#define DDNATV_NSS_SYM(name) name +#define DDNATV_SHADOW_SYM(name) name +#endif + +// Hook lckpwdf and ulckpwdf (shadow password database locking) +// In glibc, lckpwdf() attempts to open /etc/.pwd.lock directly using internal syscalls +// which fails with EROFS on Android because host /etc is mounted read-only. +static int g_pwd_lock_fd = -1; +static pthread_mutex_t g_pwd_lock_mutex = PTHREAD_MUTEX_INITIALIZER; + +int DDNATV_SHADOW_SYM(lckpwdf)(void) { +#ifndef DDNATV_HOST_TEST + init_ddnatv_hook(); + pthread_mutex_lock(&g_pwd_lock_mutex); + if (g_pwd_lock_fd != -1) { + pthread_mutex_unlock(&g_pwd_lock_mutex); + return 0; // Already locked + } + char buf[PATH_MAX]; + const char *target = rewrite_path("/etc/.pwd.lock", buf, sizeof(buf)); + static int (*orig_open)(const char *, int, ...) = NULL; + if (!orig_open) orig_open = (int (*)(const char *, int, ...))dlsym(RTLD_NEXT, "open"); + if (orig_open && target) { + g_pwd_lock_fd = orig_open(target, O_WRONLY | O_CREAT | O_CLOEXEC, 0600); + if (g_pwd_lock_fd >= 0) { + struct flock fl; + memset(&fl, 0, sizeof(fl)); + fl.l_type = F_WRLCK; + fl.l_whence = SEEK_SET; + if (fcntl(g_pwd_lock_fd, F_SETLK, &fl) != 0) { + int saved = errno; + close(g_pwd_lock_fd); + g_pwd_lock_fd = -1; + pthread_mutex_unlock(&g_pwd_lock_mutex); + errno = saved; + return -1; + } + } + } + if (g_pwd_lock_fd < 0) { + g_pwd_lock_fd = -2; // In-memory lock held + } + pthread_mutex_unlock(&g_pwd_lock_mutex); +#endif + return 0; +} + +int DDNATV_SHADOW_SYM(ulckpwdf)(void) { +#ifndef DDNATV_HOST_TEST + pthread_mutex_lock(&g_pwd_lock_mutex); + if (g_pwd_lock_fd >= 0) { + close(g_pwd_lock_fd); + } + g_pwd_lock_fd = -1; + pthread_mutex_unlock(&g_pwd_lock_mutex); +#endif + return 0; +} + + +// Group lookup helper: reads $DDNATV_ROOT/etc/group or falls back to known entries +static int ddnatv_lookup_group(const char *search_name, gid_t search_gid, int by_name, + struct group *grp, char *buf, size_t buflen) { + if (!grp || !buf || buflen < 64) { + return ERANGE; + } + + int found = 0; + char found_name[64] = {0}; + char found_pass[32] = {0}; + gid_t found_gid = 0; + char found_members[256] = {0}; + + // 1. Try reading /etc/group from The native userland rootfs +#ifndef DDNATV_HOST_TEST + char path_buf[PATH_MAX]; + const char *grp_path = rewrite_path("/etc/group", path_buf, sizeof(path_buf)); + static int (*orig_open)(const char *, int, ...) = NULL; + if (!orig_open) orig_open = (int (*)(const char *, int, ...))dlsym(RTLD_NEXT, "open"); + int fd = (orig_open && grp_path) ? orig_open(grp_path, O_RDONLY | O_CLOEXEC) : -1; + if (fd >= 0) { + char file_buf[8192]; + ssize_t n = read(fd, file_buf, sizeof(file_buf) - 1); + close(fd); + if (n > 0) { + file_buf[n] = '\0'; + char *line = file_buf; + while (*line && !found) { + char *next_line = strchr(line, '\n'); + if (next_line) { + *next_line = '\0'; + } + size_t llen = strlen(line); + if (llen > 0 && line[llen - 1] == '\r') line[llen - 1] = '\0'; + + // format: name:pass:gid:members + char *p1 = strchr(line, ':'); + if (p1) { + *p1 = '\0'; + char *p2 = strchr(p1 + 1, ':'); + if (p2) { + *p2 = '\0'; + char *p3 = strchr(p2 + 1, ':'); + if (p3) { + *p3 = '\0'; + const char *gname = line; + const char *gpass = p1 + 1; + gid_t ggid = (gid_t)strtoul(p2 + 1, NULL, 10); + const char *gmem = p3 + 1; + + if (by_name && search_name && strcmp(gname, search_name) == 0) { + snprintf(found_name, sizeof(found_name), "%s", gname); + snprintf(found_pass, sizeof(found_pass), "%s", gpass); + found_gid = ggid; + snprintf(found_members, sizeof(found_members), "%s", gmem); + found = 1; + } else if (!by_name && ggid == search_gid) { + snprintf(found_name, sizeof(found_name), "%s", gname); + snprintf(found_pass, sizeof(found_pass), "%s", gpass); + found_gid = ggid; + snprintf(found_members, sizeof(found_members), "%s", gmem); + found = 1; + } + } + } + } + if (!next_line) break; + line = next_line + 1; + } + } + } +#endif + + // 2. Fallbacks for well-known groups if absent from file + if (!found) { + if (by_name) { + if (!search_name) return ENOENT; + if (strcmp(search_name, "root") == 0 || strcmp(search_name, "ddnatv") == 0) { + snprintf(found_name, sizeof(found_name), "%s", search_name); + snprintf(found_pass, sizeof(found_pass), "x"); + found_gid = 0; + snprintf(found_members, sizeof(found_members), "%s", search_name); + found = 1; + } else if (strcmp(search_name, "_ssh") == 0) { + snprintf(found_name, sizeof(found_name), "_ssh"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_gid = 100; + found = 1; + } else if (strcmp(search_name, "ssh") == 0) { + snprintf(found_name, sizeof(found_name), "ssh"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_gid = 101; + found = 1; + } else if (strcmp(search_name, "nogroup") == 0 || strcmp(search_name, "nobody") == 0) { + snprintf(found_name, sizeof(found_name), "%s", search_name); + snprintf(found_pass, sizeof(found_pass), "x"); + found_gid = 65534; + found = 1; + } + } else { + if (search_gid == 0 || search_gid == real_gid()) { + snprintf(found_name, sizeof(found_name), "root"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_gid = search_gid; + snprintf(found_members, sizeof(found_members), "root"); + found = 1; + } + } + } + + if (!found) { + return ENOENT; + } + + // 3. Assemble struct group into caller's buf + size_t mem_ptr_count = 1; + char *m_copy = found_members; + while (*m_copy) { + if (*m_copy == ',') mem_ptr_count++; + m_copy++; + } + if (found_members[0] != '\0') mem_ptr_count++; + + size_t mem_array_bytes = (mem_ptr_count + 1) * sizeof(char *); + mem_array_bytes = (mem_array_bytes + sizeof(void *) - 1) & ~(sizeof(void *) - 1); + + size_t name_len = strlen(found_name) + 1; + size_t pass_len = strlen(found_pass) + 1; + size_t mem_str_len = strlen(found_members) + 1; + + if (mem_array_bytes + name_len + pass_len + mem_str_len > buflen) { + return ERANGE; + } + + char **mem_array = (char **)buf; + char *str_cursor = buf + mem_array_bytes; + + grp->gr_name = str_cursor; + memcpy(str_cursor, found_name, name_len); + str_cursor += name_len; + + grp->gr_passwd = str_cursor; + memcpy(str_cursor, found_pass, pass_len); + str_cursor += pass_len; + + grp->gr_gid = found_gid; + + size_t m_idx = 0; + if (found_members[0] != '\0') { + char *m_tok = str_cursor; + memcpy(str_cursor, found_members, mem_str_len); + str_cursor += mem_str_len; + + char *curr = m_tok; + while (curr && *curr) { + char *comma = strchr(curr, ','); + if (comma) { + *comma = '\0'; + } + if (*curr) { + mem_array[m_idx++] = curr; + } + curr = comma ? comma + 1 : NULL; + } + } + mem_array[m_idx] = NULL; + grp->gr_mem = mem_array; + + return 0; +} + +// Passwd lookup helper: reads $DDNATV_ROOT/etc/passwd or falls back to known entries +static int ddnatv_lookup_passwd(const char *search_name, uid_t search_uid, int by_name, + struct passwd *pwd, char *buf, size_t buflen) { + if (!pwd || !buf || buflen < 128) { + return ERANGE; + } + + int found = 0; + char found_name[64] = {0}; + char found_pass[32] = {0}; + uid_t found_uid = 0; + gid_t found_gid = 0; + char found_gecos[64] = {0}; + char found_dir[128] = {0}; + char found_shell[64] = {0}; + + // 1. Try reading /etc/passwd from The native userland rootfs +#ifndef DDNATV_HOST_TEST + char path_buf[PATH_MAX]; + const char *pwd_path = rewrite_path("/etc/passwd", path_buf, sizeof(path_buf)); + static int (*orig_open)(const char *, int, ...) = NULL; + if (!orig_open) orig_open = (int (*)(const char *, int, ...))dlsym(RTLD_NEXT, "open"); + int fd = (orig_open && pwd_path) ? orig_open(pwd_path, O_RDONLY | O_CLOEXEC) : -1; + if (fd >= 0) { + char file_buf[8192]; + ssize_t n = read(fd, file_buf, sizeof(file_buf) - 1); + close(fd); + if (n > 0) { + file_buf[n] = '\0'; + char *line = file_buf; + while (*line && !found) { + char *next_line = strchr(line, '\n'); + if (next_line) { + *next_line = '\0'; + } + size_t llen = strlen(line); + if (llen > 0 && line[llen - 1] == '\r') line[llen - 1] = '\0'; + + // format: name:pass:uid:gid:gecos:dir:shell + char *f[7] = {0}; + char *curr = line; + int f_idx = 0; + while (curr && f_idx < 7) { + f[f_idx++] = curr; + char *col = strchr(curr, ':'); + if (col && f_idx < 7) { + *col = '\0'; + curr = col + 1; + } else { + break; + } + } + if (f_idx >= 7) { + const char *uname = f[0]; + const char *upass = f[1]; + uid_t uuid = (uid_t)strtoul(f[2], NULL, 10); + gid_t ugid = (gid_t)strtoul(f[3], NULL, 10); + const char *ugecos = f[4]; + const char *udir = f[5]; + const char *ushell = f[6]; + + if (by_name && search_name && strcmp(uname, search_name) == 0) { + snprintf(found_name, sizeof(found_name), "%s", uname); + snprintf(found_pass, sizeof(found_pass), "%s", upass); + found_uid = uuid; + found_gid = ugid; + snprintf(found_gecos, sizeof(found_gecos), "%s", ugecos); + snprintf(found_dir, sizeof(found_dir), "%s", udir); + snprintf(found_shell, sizeof(found_shell), "%s", ushell); + found = 1; + } else if (!by_name && uuid == search_uid) { + snprintf(found_name, sizeof(found_name), "%s", uname); + snprintf(found_pass, sizeof(found_pass), "%s", upass); + found_uid = uuid; + found_gid = ugid; + snprintf(found_gecos, sizeof(found_gecos), "%s", ugecos); + snprintf(found_dir, sizeof(found_dir), "%s", udir); + snprintf(found_shell, sizeof(found_shell), "%s", ushell); + found = 1; + } + } + if (!next_line) break; + line = next_line + 1; + } + } + } +#endif + + // 2. Fallbacks for well-known users if absent from file + if (!found) { + if (by_name) { + if (!search_name) return ENOENT; + if (strcmp(search_name, "root") == 0) { + snprintf(found_name, sizeof(found_name), "root"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_uid = 0; + found_gid = 0; + snprintf(found_gecos, sizeof(found_gecos), "root"); + snprintf(found_dir, sizeof(found_dir), "/root"); + snprintf(found_shell, sizeof(found_shell), "/bin/bash"); + found = 1; + } else if (strcmp(search_name, "ddnatv") == 0) { + snprintf(found_name, sizeof(found_name), "ddnatv"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_uid = 0; + found_gid = 0; + snprintf(found_gecos, sizeof(found_gecos), "The native userland"); + snprintf(found_dir, sizeof(found_dir), "/home/ddnatv"); + snprintf(found_shell, sizeof(found_shell), "/bin/bash"); + found = 1; + } else if (strcmp(search_name, "_ssh") == 0) { + snprintf(found_name, sizeof(found_name), "_ssh"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_uid = 100; + found_gid = 100; + snprintf(found_gecos, sizeof(found_gecos), "OpenSSH daemon"); + snprintf(found_dir, sizeof(found_dir), "/run/sshd"); + snprintf(found_shell, sizeof(found_shell), "/usr/sbin/nologin"); + found = 1; + } else if (strcmp(search_name, "sshd") == 0) { + snprintf(found_name, sizeof(found_name), "sshd"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_uid = 101; + found_gid = 101; + snprintf(found_gecos, sizeof(found_gecos), "Privilege-separated SSH"); + snprintf(found_dir, sizeof(found_dir), "/run/sshd"); + snprintf(found_shell, sizeof(found_shell), "/usr/sbin/nologin"); + found = 1; + } else if (strcmp(search_name, "nobody") == 0) { + snprintf(found_name, sizeof(found_name), "nobody"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_uid = 65534; + found_gid = 65534; + snprintf(found_gecos, sizeof(found_gecos), "nobody"); + snprintf(found_dir, sizeof(found_dir), "/nonexistent"); + snprintf(found_shell, sizeof(found_shell), "/usr/sbin/nologin"); + found = 1; + } + } else { + if (search_uid == 0 || search_uid == real_uid()) { + snprintf(found_name, sizeof(found_name), "root"); + snprintf(found_pass, sizeof(found_pass), "x"); + found_uid = search_uid; + found_gid = 0; + snprintf(found_gecos, sizeof(found_gecos), "root"); + snprintf(found_dir, sizeof(found_dir), "/home"); + snprintf(found_shell, sizeof(found_shell), "/bin/bash"); + found = 1; + } + } + } + + if (!found) { + return ENOENT; + } + + // 3. Assemble struct passwd into caller's buf + size_t name_len = strlen(found_name) + 1; + size_t pass_len = strlen(found_pass) + 1; + size_t gecos_len = strlen(found_gecos) + 1; + size_t dir_len = strlen(found_dir) + 1; + size_t shell_len = strlen(found_shell) + 1; + + size_t total_str_bytes = name_len + pass_len + gecos_len + dir_len + shell_len; + if (total_str_bytes > buflen) { + return ERANGE; + } + + char *str_cursor = buf; + + pwd->pw_name = str_cursor; + memcpy(str_cursor, found_name, name_len); + str_cursor += name_len; + + pwd->pw_passwd = str_cursor; + memcpy(str_cursor, found_pass, pass_len); + str_cursor += pass_len; + + pwd->pw_uid = found_uid; + pwd->pw_gid = found_gid; + + pwd->pw_gecos = str_cursor; + memcpy(str_cursor, found_gecos, gecos_len); + str_cursor += gecos_len; + + pwd->pw_dir = str_cursor; + memcpy(str_cursor, found_dir, dir_len); + str_cursor += dir_len; + + pwd->pw_shell = str_cursor; + memcpy(str_cursor, found_shell, shell_len); + str_cursor += shell_len; + + return 0; +} + +#ifndef DDNATV_HOST_TEST +// The shadow database (/etc/shadow) of the rootfs. libc reads the real /etc/shadow of the machine, +// which Android does not have: pam_unix's account check for root found no entry and answered +// "Authentication failure", so chfn, chsh and `adduser --gecos` (the installation of PostgreSQL) +// failed. The fields are "name:hash:lastchange:min:max:warn:inactive:expire:flag", numbers empty +// when unset (libc stores -1 then). +static int ddnatv_lookup_shadow(const char *name, struct spwd *sp, char *buf, size_t buflen) { + if (!name || !sp || !buf) return EINVAL; + char path_buf[PATH_MAX]; + const char *path = rewrite_path("/etc/shadow", path_buf, sizeof(path_buf)); + static int (*orig_open)(const char *, int, ...) = NULL; + if (!orig_open) orig_open = (int (*)(const char *, int, ...))dlsym(RTLD_NEXT, "open"); + int fd = (orig_open && path) ? orig_open(path, O_RDONLY | O_CLOEXEC) : -1; + if (fd < 0) return ENOENT; + FILE *f = fdopen(fd, "r"); + if (!f) { + close(fd); + return ENOENT; + } + size_t name_len = strlen(name); + char line[1024]; + int err = ENOENT; + while (fgets(line, sizeof(line), f)) { + if (strncmp(line, name, name_len) != 0 || line[name_len] != ':') continue; + line[strcspn(line, "\r\n")] = '\0'; + char *fields[9] = {0}; + int n = 0; + char *cursor = line; + while (n < 9) { + fields[n++] = cursor; + char *colon = strchr(cursor, ':'); + if (!colon) break; + *colon = '\0'; + cursor = colon + 1; + } + size_t need = strlen(fields[0]) + 1 + strlen(fields[1] ? fields[1] : "") + 1; + if (n < 2 || need > buflen) { + err = n < 2 ? ENOENT : ERANGE; + break; + } + char *out = buf; + sp->sp_namp = out; + memcpy(out, fields[0], strlen(fields[0]) + 1); + out += strlen(fields[0]) + 1; + sp->sp_pwdp = out; + memcpy(out, fields[1], strlen(fields[1]) + 1); + long number[6]; + for (int i = 0; i < 6; i++) { + const char *v = (2 + i < n) ? fields[2 + i] : NULL; + number[i] = (v && v[0] != '\0') ? strtol(v, NULL, 10) : -1; + } + sp->sp_lstchg = number[0]; + sp->sp_min = number[1]; + sp->sp_max = number[2]; + sp->sp_warn = number[3]; + sp->sp_inact = number[4]; + sp->sp_expire = number[5]; + sp->sp_flag = (8 < n && fields[8][0] != '\0') ? strtoul(fields[8], NULL, 10) : (unsigned long)-1; + err = 0; + break; + } + fclose(f); + return err; +} + +int getspnam_r(const char *name, struct spwd *spbuf, char *buf, size_t buflen, struct spwd **result) { + static int (*orig_getspnam_r)(const char *, struct spwd *, char *, size_t, struct spwd **) = NULL; + if (!orig_getspnam_r) orig_getspnam_r = (int (*)(const char *, struct spwd *, char *, size_t, struct spwd **))dlsym(RTLD_NEXT, "getspnam_r"); + int ret = ENOENT; + if (orig_getspnam_r) { + ret = orig_getspnam_r(name, spbuf, buf, buflen, result); + if ((ret == 0 && result && *result) || ret == ERANGE) return ret; + } + int err = ddnatv_lookup_shadow(name, spbuf, buf, buflen); + if (err == 0) { + if (result) *result = spbuf; + return 0; + } + if (result) *result = NULL; + return err == ENOENT ? (ret != 0 ? ret : ENOENT) : err; +} + +struct spwd *getspnam(const char *name) { + static struct spwd entry; + static char entry_buf[1024]; + struct spwd *found = NULL; + int err = getspnam_r(name, &entry, entry_buf, sizeof(entry_buf), &found); + if (err != 0) { + errno = err; + return NULL; + } + return found; +} +#endif /* !DDNATV_HOST_TEST */ + +static struct group s_grp_storage; +static char s_grp_buf[2048]; +static struct passwd s_pwd_storage; +static char s_pwd_buf[2048]; + +struct group *DDNATV_NSS_SYM(getgrgid)(gid_t gid) { +#ifndef DDNATV_HOST_TEST + static struct group *(*orig_getgrgid)(gid_t) = NULL; + if (!orig_getgrgid) orig_getgrgid = (struct group *(*)(gid_t))dlsym(RTLD_NEXT, "getgrgid"); + struct group *res = orig_getgrgid ? orig_getgrgid(gid) : NULL; + if (res) return res; +#endif + + int err = ddnatv_lookup_group(NULL, gid, 0, &s_grp_storage, s_grp_buf, sizeof(s_grp_buf)); + if (err == 0) return &s_grp_storage; + return NULL; +} + +struct group *DDNATV_NSS_SYM(getgrnam)(const char *name) { +#ifndef DDNATV_HOST_TEST + static struct group *(*orig_getgrnam)(const char *) = NULL; + if (!orig_getgrnam) orig_getgrnam = (struct group *(*)(const char *))dlsym(RTLD_NEXT, "getgrnam"); + struct group *res = orig_getgrnam ? orig_getgrnam(name) : NULL; + if (res) return res; +#endif + + int err = ddnatv_lookup_group(name, 0, 1, &s_grp_storage, s_grp_buf, sizeof(s_grp_buf)); + if (err == 0) return &s_grp_storage; + return NULL; +} + +int DDNATV_NSS_SYM(getgrgid_r)(gid_t gid, struct group *grp, char *buf, size_t buflen, struct group **result) { +#ifndef DDNATV_HOST_TEST + static int (*orig_getgrgid_r)(gid_t, struct group *, char *, size_t, struct group **) = NULL; + if (!orig_getgrgid_r) orig_getgrgid_r = (int (*)(gid_t, struct group *, char *, size_t, struct group **))dlsym(RTLD_NEXT, "getgrgid_r"); + int ret = orig_getgrgid_r ? orig_getgrgid_r(gid, grp, buf, buflen, result) : ENOENT; +#else + int ret = g_test_orig_nss_r_ret; + if (result) *result = (ret == 0 && g_test_orig_nss_r_found) ? grp : NULL; +#endif + if (ret == 0 && result && *result != NULL) return 0; + if (ret != 0 && ret != ENOENT) { + if (result) *result = NULL; + return ret; + } + + int err = ddnatv_lookup_group(NULL, gid, 0, grp, buf, buflen); + if (err == 0) { + if (result) *result = grp; + return 0; + } + if (result) *result = NULL; + return (err == ERANGE) ? ERANGE : 0; +} + +int DDNATV_NSS_SYM(getgrnam_r)(const char *name, struct group *grp, char *buf, size_t buflen, struct group **result) { +#ifndef DDNATV_HOST_TEST + static int (*orig_getgrnam_r)(const char *, struct group *, char *, size_t, struct group **) = NULL; + if (!orig_getgrnam_r) orig_getgrnam_r = (int (*)(const char *, struct group *, char *, size_t, struct group **))dlsym(RTLD_NEXT, "getgrnam_r"); + int ret = orig_getgrnam_r ? orig_getgrnam_r(name, grp, buf, buflen, result) : ENOENT; +#else + int ret = g_test_orig_nss_r_ret; + if (result) *result = (ret == 0 && g_test_orig_nss_r_found) ? grp : NULL; +#endif + if (ret == 0 && result && *result != NULL) return 0; + if (ret != 0 && ret != ENOENT) { + if (result) *result = NULL; + return ret; + } + + int err = ddnatv_lookup_group(name, 0, 1, grp, buf, buflen); + if (err == 0) { + if (result) *result = grp; + return 0; + } + if (result) *result = NULL; + return (err == ERANGE) ? ERANGE : 0; +} + +// sshd's privilege-separated user is root's ids: The native userland cannot drop privileges (setuid() and +// setgid() only pretend to), and sshd's unprivileged part checks after dropping them that it cannot +// take them back, which ended it ("permanently_set_uid: was able to restore old [e]gid"). Like apt's +// sandbox user (APT::Sandbox::User "root"), it then runs as the rest does. +// +// The app's own ids are root's as well: the rootfs lists root with them for proot, and a server +// that allows "localuser:root" compares getpwnam("root") with a peer's credentials, which the hook +// reports as 0. Xwayland refused gamescope's own connection when the two disagreed. +static struct passwd *present_privsep_user_as_root(struct passwd *pwd) { + if (pwd && pwd->pw_name && strcmp(pwd->pw_name, "sshd") == 0) { + pwd->pw_uid = 0; + pwd->pw_gid = 0; + } + if (pwd && pwd->pw_uid == real_uid()) pwd->pw_uid = 0; + if (pwd && pwd->pw_gid == real_gid()) pwd->pw_gid = 0; + return pwd; +} + +struct passwd *DDNATV_NSS_SYM(getpwuid)(uid_t uid) { +#ifndef DDNATV_HOST_TEST + static struct passwd *(*orig_getpwuid)(uid_t) = NULL; + if (!orig_getpwuid) orig_getpwuid = (struct passwd *(*)(uid_t))dlsym(RTLD_NEXT, "getpwuid"); + struct passwd *res = orig_getpwuid ? orig_getpwuid(uid) : NULL; + if (res) return present_privsep_user_as_root(res); +#endif + + int err = ddnatv_lookup_passwd(NULL, uid, 0, &s_pwd_storage, s_pwd_buf, sizeof(s_pwd_buf)); + if (err == 0) return present_privsep_user_as_root(&s_pwd_storage); + return NULL; +} + +struct passwd *DDNATV_NSS_SYM(getpwnam)(const char *name) { +#ifndef DDNATV_HOST_TEST + static struct passwd *(*orig_getpwnam)(const char *) = NULL; + if (!orig_getpwnam) orig_getpwnam = (struct passwd *(*)(const char *))dlsym(RTLD_NEXT, "getpwnam"); + struct passwd *res = orig_getpwnam ? orig_getpwnam(name) : NULL; + if (res) return present_privsep_user_as_root(res); +#endif + + int err = ddnatv_lookup_passwd(name, 0, 1, &s_pwd_storage, s_pwd_buf, sizeof(s_pwd_buf)); + if (err == 0) return present_privsep_user_as_root(&s_pwd_storage); + return NULL; +} + +int DDNATV_NSS_SYM(getpwuid_r)(uid_t uid, struct passwd *pwd, char *buf, size_t buflen, struct passwd **result) { +#ifndef DDNATV_HOST_TEST + static int (*orig_getpwuid_r)(uid_t, struct passwd *, char *, size_t, struct passwd **) = NULL; + if (!orig_getpwuid_r) orig_getpwuid_r = (int (*)(uid_t, struct passwd *, char *, size_t, struct passwd **))dlsym(RTLD_NEXT, "getpwuid_r"); + int ret = orig_getpwuid_r ? orig_getpwuid_r(uid, pwd, buf, buflen, result) : ENOENT; +#else + int ret = g_test_orig_nss_r_ret; + if (result) *result = (ret == 0 && g_test_orig_nss_r_found) ? pwd : NULL; +#endif + if (ret == 0 && result && *result != NULL) { + present_privsep_user_as_root(*result); + return 0; + } + if (ret != 0 && ret != ENOENT) { + if (result) *result = NULL; + return ret; + } + + int err = ddnatv_lookup_passwd(NULL, uid, 0, pwd, buf, buflen); + if (err == 0) { + present_privsep_user_as_root(pwd); + if (result) *result = pwd; + return 0; + } + if (result) *result = NULL; + return (err == ERANGE) ? ERANGE : 0; +} + +int DDNATV_NSS_SYM(getpwnam_r)(const char *name, struct passwd *pwd, char *buf, size_t buflen, struct passwd **result) { +#ifndef DDNATV_HOST_TEST + static int (*orig_getpwnam_r)(const char *, struct passwd *, char *, size_t, struct passwd **) = NULL; + if (!orig_getpwnam_r) orig_getpwnam_r = (int (*)(const char *, struct passwd *, char *, size_t, struct passwd **))dlsym(RTLD_NEXT, "getpwnam_r"); + int ret = orig_getpwnam_r ? orig_getpwnam_r(name, pwd, buf, buflen, result) : ENOENT; +#else + int ret = g_test_orig_nss_r_ret; + if (result) *result = (ret == 0 && g_test_orig_nss_r_found) ? pwd : NULL; +#endif + if (ret == 0 && result && *result != NULL) { + present_privsep_user_as_root(*result); + return 0; + } + if (ret != 0 && ret != ENOENT) { + if (result) *result = NULL; + return ret; + } + + int err = ddnatv_lookup_passwd(name, 0, 1, pwd, buf, buflen); + if (err == 0) { + present_privsep_user_as_root(pwd); + if (result) *result = pwd; + return 0; + } + if (result) *result = NULL; + return (err == ERANGE) ? ERANGE : 0; +} diff --git a/tools/nativeguest/hook/net.c b/tools/nativeguest/hook/net.c new file mode 100644 index 0000000000..19424c5796 --- /dev/null +++ b/tools/nativeguest/hook/net.c @@ -0,0 +1,1054 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Name resolution: DNS packets, the network's DNS servers, the fallback resolver, getaddrinfo() +// and the resolver state, and DNS queries to loopback redirected to a real server. + +// ---- DNS packets and servers ------------------------------------------------------------- +// Pure functions (no syscalls apart from if_nametoindex), so tests/native can check them directly. + +#define DDNATV_DNS_TYPE_A 1 +#define DDNATV_DNS_TYPE_AAAA 28 +#define DDNATV_DNS_MAX_SERVERS 8 + +typedef struct { + struct sockaddr_storage addr; + socklen_t len; +} ddnatv_dns_server_t; + +// Fills `server` with the DNS server `text` (an IPv4 or IPv6 address, IPv6 optionally with a +// "%interface" scope) on port 53. Returns 0 for loopback and unspecified addresses (nothing answers +// there on Android), for a link-local IPv6 address without a scope, and for anything invalid. +static int dns_server_from_string(const char *text, ddnatv_dns_server_t *server) { + memset(server, 0, sizeof(*server)); + if (!text) return 0; + struct in_addr a4; + if (inet_pton(AF_INET, text, &a4) == 1) { + if ((ntohl(a4.s_addr) >> 24) == 127 || a4.s_addr == 0) return 0; + struct sockaddr_in *sin = (struct sockaddr_in *)&server->addr; + sin->sin_family = AF_INET; + sin->sin_port = htons(53); + sin->sin_addr = a4; + server->len = sizeof(*sin); + return 1; + } + char host[INET6_ADDRSTRLEN + IF_NAMESIZE + 2]; + if (strlen(text) >= sizeof(host)) return 0; + strcpy(host, text); + unsigned int scope = 0; + char *pct = strchr(host, '%'); + if (pct) { + *pct++ = '\0'; + if (*pct >= '0' && *pct <= '9') { + scope = (unsigned int)strtoul(pct, NULL, 10); + } else { + scope = if_nametoindex(pct); + } + } + struct in6_addr a6; + if (inet_pton(AF_INET6, host, &a6) != 1) return 0; + if (IN6_IS_ADDR_LOOPBACK(&a6) || IN6_IS_ADDR_UNSPECIFIED(&a6)) return 0; + if (IN6_IS_ADDR_V4MAPPED(&a6) && (a6.s6_addr[12] == 127 || (a6.s6_addr[12] | a6.s6_addr[13] | a6.s6_addr[14] | a6.s6_addr[15]) == 0)) return 0; + if (IN6_IS_ADDR_LINKLOCAL(&a6) && scope == 0) return 0; + struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)&server->addr; + sin6->sin6_family = AF_INET6; + sin6->sin6_port = htons(53); + sin6->sin6_addr = a6; + sin6->sin6_scope_id = scope; + server->len = sizeof(*sin6); + return 1; +} + +// The "nameserver" lines of a resolv.conf, in order: up to `max` usable servers, IPv4 and IPv6. +static int parse_nameservers(const char *text, ddnatv_dns_server_t *out, int max) { + int count = 0; + const char *line = text; + while (line && *line && count < max) { + const char *next = strchr(line, '\n'); + size_t len = next ? (size_t)(next - line) : strlen(line); + char buf[256]; + if (len >= sizeof(buf)) len = sizeof(buf) - 1; + memcpy(buf, line, len); + buf[len] = '\0'; + char *p = buf; + while (*p == ' ' || *p == '\t') p++; + if (strncmp(p, "nameserver", 10) == 0 && (p[10] == ' ' || p[10] == '\t')) { + p += 10; + while (*p == ' ' || *p == '\t') p++; + char *end = p; + while (*end && *end != ' ' && *end != '\t' && *end != '\r' && *end != '#' && *end != ';') end++; + *end = '\0'; + if (dns_server_from_string(p, &out[count])) count++; + } + line = next ? next + 1 : NULL; + } + return count; +} + +static int dns_server_equal(const ddnatv_dns_server_t *a, const ddnatv_dns_server_t *b) { + return a->len == b->len && memcmp(&a->addr, &b->addr, a->len) == 0; +} + +// Builds a recursive query for one name and record type; returns its length, or -1 when the name +// is not a valid DNS name (an empty label, a label over 63 bytes, over 253 bytes in all). +static int dns_build_query(const char *name, int qtype, uint16_t txid, unsigned char *packet, size_t size) { + if (!name || !packet || size < 12) return -1; + size_t name_len = strlen(name); + if (name_len > 0 && name[name_len - 1] == '.') name_len--; // "example.com." is absolute + if (name_len == 0 || name_len > 253) return -1; + memset(packet, 0, 12); + packet[0] = (unsigned char)(txid >> 8); + packet[1] = (unsigned char)(txid & 0xff); + packet[2] = 0x01; // recursion desired + packet[5] = 0x01; // one question + size_t pos = 12; + size_t start = 0; + for (;;) { + size_t end = start; + while (end < name_len && name[end] != '.') end++; + size_t len = end - start; + if (len == 0 || len > 63 || pos + 1 + len + 1 + 4 > size) return -1; + packet[pos++] = (unsigned char)len; + memcpy(packet + pos, name + start, len); + pos += len; + if (end == name_len) break; + start = end + 1; + } + packet[pos++] = 0; + packet[pos++] = (unsigned char)(qtype >> 8); + packet[pos++] = (unsigned char)(qtype & 0xff); + packet[pos++] = 0x00; + packet[pos++] = 0x01; // class IN + return (int)pos; +} + +// Offset after the (possibly compressed) name at `off`, or -1 when it is malformed. +static int dns_skip_name(const unsigned char *msg, int n, int off) { + for (int labels = 0; labels < 128; labels++) { + if (off >= n) return -1; + unsigned char len = msg[off]; + if (len == 0) return off + 1; + if ((len & 0xc0) == 0xc0) return off + 2 <= n ? off + 2 : -1; + if (len & 0xc0) return -1; + off += 1 + len; + } + return -1; +} + +// Copies the first address of type `qtype` (4 bytes for A, 16 for AAAA) from the reply `msg` to the +// query `txid` and returns 0. Returns 1 when the reply says there is no such address (the name does +// not exist, or has no record of that type): asking other servers would only send the name to more +// of them. Returns -1 for anything that is worth asking another server about: a failure (SERVFAIL, +// REFUSED), a truncated, malformed or foreign reply. +static int dns_parse_answer(const unsigned char *msg, int n, uint16_t txid, int qtype, unsigned char *out) { + if (!msg || n < 12) return -1; + if (((msg[0] << 8) | msg[1]) != txid) return -1; + if (!(msg[2] & 0x80)) return -1; // not a reply + int rcode = msg[3] & 0x0f; + if (rcode == 3) return 1; // NXDOMAIN + if (rcode != 0) return -1; + int qdcount = (msg[4] << 8) | msg[5]; + int ancount = (msg[6] << 8) | msg[7]; + int off = 12; + for (int q = 0; q < qdcount; q++) { + off = dns_skip_name(msg, n, off); + if (off < 0 || off + 4 > n) return -1; + off += 4; + } + int want = qtype == DDNATV_DNS_TYPE_AAAA ? 16 : 4; + for (int a = 0; a < ancount; a++) { + off = dns_skip_name(msg, n, off); + if (off < 0 || off + 10 > n) return -1; + int rtype = (msg[off] << 8) | msg[off + 1]; + int rclass = (msg[off + 2] << 8) | msg[off + 3]; + int rdlen = (msg[off + 8] << 8) | msg[off + 9]; + off += 10; + if (off + rdlen > n) return -1; + if (rtype == qtype && rclass == 1 && rdlen == want) { + memcpy(out, msg + off, (size_t)want); + return 0; + } + off += rdlen; + } + return (msg[2] & 0x02) ? -1 : 1; // no such record, unless the reply was truncated +} + +// ---- Sockets bound to a port the program chose ---------------------------------------------- +// Which descriptors are TCP/UDP sockets that bind() gave a port the program asked for (not 0, +// where the kernel picks one). listen() reports only those to the app, which connects to a +// reported port to see whether it serves web pages (sockets.c). Descriptors past the bitmap +// are taken as not chosen: they are not reported. +#define DDNATV_CHOSEN_PORT_FDS 65536 +static unsigned char g_chosen_port_fds[DDNATV_CHOSEN_PORT_FDS / 8]; + +static void set_chosen_port_fd(int fd, int chosen) { + if (fd < 0 || fd >= DDNATV_CHOSEN_PORT_FDS) return; + unsigned char bit = (unsigned char)(1u << (fd & 7)); + // Written only when it changes: a page of the bitmap is copied for a forked child only then + if (chosen) { + if (!(__atomic_load_n(&g_chosen_port_fds[fd >> 3], __ATOMIC_RELAXED) & bit)) + __atomic_fetch_or(&g_chosen_port_fds[fd >> 3], bit, __ATOMIC_RELAXED); + } else if (__atomic_load_n(&g_chosen_port_fds[fd >> 3], __ATOMIC_RELAXED) & bit) { + __atomic_fetch_and(&g_chosen_port_fds[fd >> 3], (unsigned char)~bit, __ATOMIC_RELAXED); + } +} + +static int is_chosen_port_fd(int fd) { + if (fd < 0 || fd >= DDNATV_CHOSEN_PORT_FDS) return 0; + return (__atomic_load_n(&g_chosen_port_fds[fd >> 3], __ATOMIC_RELAXED) >> (fd & 7)) & 1; +} + +#ifndef DDNATV_HOST_TEST + +// DNS resolution hooking and localhost DNS redirect +#define DNS_REDIRECT_MAX 64 +static struct { + int fd; + struct sockaddr_storage orig; + socklen_t orig_len; + uint32_t active; +} g_dns_redirects[DNS_REDIRECT_MAX]; +static pthread_mutex_t g_dns_redirect_mutex = PTHREAD_MUTEX_INITIALIZER; + +static void record_dns_redirect(int fd, const struct sockaddr *orig, socklen_t orig_len) { + if (fd < 0 || !orig) return; + if (orig_len > sizeof(struct sockaddr_storage)) orig_len = sizeof(struct sockaddr_storage); + pthread_mutex_lock(&g_dns_redirect_mutex); + int target_idx = (fd >= 0 ? fd : -fd) % DNS_REDIRECT_MAX; + g_dns_redirects[target_idx].fd = fd; + memcpy(&g_dns_redirects[target_idx].orig, orig, orig_len); + g_dns_redirects[target_idx].orig_len = orig_len; + g_dns_redirects[target_idx].active = 1; + pthread_mutex_unlock(&g_dns_redirect_mutex); +} + +static void clear_dns_redirect(int fd) { + if (fd < 0) return; + int target_idx = (fd >= 0 ? fd : -fd) % DNS_REDIRECT_MAX; + if (!g_dns_redirects[target_idx].active || g_dns_redirects[target_idx].fd != fd) { + return; + } + pthread_mutex_lock(&g_dns_redirect_mutex); + if (g_dns_redirects[target_idx].active && g_dns_redirects[target_idx].fd == fd) { + g_dns_redirects[target_idx].active = 0; + g_dns_redirects[target_idx].fd = -1; + g_dns_redirects[target_idx].orig_len = 0; + } + pthread_mutex_unlock(&g_dns_redirect_mutex); +} + +int close(int fd) { + static int (*orig_close)(int) = NULL; + if (!orig_close) orig_close = (int (*)(int))dlsym(RTLD_NEXT, "close"); + // The ARM translator's memory file (privileged.c): left open, as if it were closed + if (g_kept_fd_count > 0 && is_kept_fd(fd)) return 0; + clear_dns_redirect(fd); + set_chosen_port_fd(fd, 0); + return orig_close ? orig_close(fd) : -1; +} + +int dup2(int oldfd, int newfd) { + static int (*orig_dup2)(int, int) = NULL; + if (!orig_dup2) orig_dup2 = (int (*)(int, int))dlsym(RTLD_NEXT, "dup2"); + if (oldfd != newfd) { + clear_dns_redirect(newfd); + set_chosen_port_fd(newfd, is_chosen_port_fd(oldfd)); + } + return orig_dup2 ? orig_dup2(oldfd, newfd) : -1; +} + +int dup3(int oldfd, int newfd, int flags) { + static int (*orig_dup3)(int, int, int) = NULL; + if (!orig_dup3) orig_dup3 = (int (*)(int, int, int))dlsym(RTLD_NEXT, "dup3"); + if (oldfd != newfd) { + clear_dns_redirect(newfd); + set_chosen_port_fd(newfd, is_chosen_port_fd(oldfd)); + } + return orig_dup3 ? orig_dup3(oldfd, newfd, flags) : -1; +} + +static int get_dns_redirect(int fd, struct sockaddr_storage *orig, socklen_t *orig_len) { + if (fd < 0) return 0; + int found = 0; + pthread_mutex_lock(&g_dns_redirect_mutex); + int target_idx = (fd >= 0 ? fd : -fd) % DNS_REDIRECT_MAX; + if (g_dns_redirects[target_idx].active && g_dns_redirects[target_idx].fd == fd) { + if (orig) *orig = g_dns_redirects[target_idx].orig; + if (orig_len) *orig_len = g_dns_redirects[target_idx].orig_len; + found = 1; + } + pthread_mutex_unlock(&g_dns_redirect_mutex); + return found; +} + +// A DNS query to 127.0.0.0/8 or ::1 (or ::ffff:127.x), where nothing listens on Android. +static inline int is_loopback_dns(const struct sockaddr *addr, socklen_t addrlen) { + if (!addr || addrlen < sizeof(sa_family_t)) return 0; + if (addr->sa_family == AF_INET && addrlen >= sizeof(struct sockaddr_in)) { + const struct sockaddr_in *sin = (const struct sockaddr_in *)addr; + return (sin->sin_port == htons(53) && ((ntohl(sin->sin_addr.s_addr) >> 24) == 127)); + } + if (addr->sa_family == AF_INET6 && addrlen >= sizeof(struct sockaddr_in6)) { + const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)addr; + if (sin6->sin6_port != htons(53)) return 0; + return IN6_IS_ADDR_LOOPBACK(&sin6->sin6_addr) || + (IN6_IS_ADDR_V4MAPPED(&sin6->sin6_addr) && sin6->sin6_addr.s6_addr[12] == 127); + } + return 0; +} + +static in_addr_t get_primary_dns(void) { + static in_addr_t cached_dns = 0; + static time_t last_check = 0; + static pthread_mutex_t dns_mutex = PTHREAD_MUTEX_INITIALIZER; + + struct timespec ts; + clock_gettime(CLOCK_MONOTONIC, &ts); + time_t now = ts.tv_sec; + + // Fast path: cached value valid within 5s TTL + if (cached_dns != 0 && (now - last_check < 5)) { + return cached_dns; + } + + pthread_mutex_lock(&dns_mutex); + if (cached_dns != 0 && (now - last_check < 5)) { + in_addr_t val = cached_dns; + pthread_mutex_unlock(&dns_mutex); + return val; + } + last_check = now; + + in_addr_t new_dns = 0; + init_ddnatv_hook(); + + // 1. Check Android system property net.dns1 via Bionic libc + static int (*orig_sys_prop_get)(const char *, char *) = NULL; + static int prop_lookup_done = 0; + if (!prop_lookup_done) { + orig_sys_prop_get = (int (*)(const char *, char *))dlsym(RTLD_DEFAULT, "__system_property_get"); + prop_lookup_done = 1; + } + if (orig_sys_prop_get) { + char prop_val[256]; + if (orig_sys_prop_get("net.dns1", prop_val) > 0 && prop_val[0] != '\0') { + struct in_addr a; + if (inet_aton(prop_val, &a)) { + if ((ntohl(a.s_addr) >> 24) != 127 && a.s_addr != 0) { + new_dns = a.s_addr; + } + } + } + } + + // 2. Parse /etc/resolv.conf in The native userland rootfs + char resolv_path[PATH_MAX]; + if (g_ddnatv_root[0] != '\0') { + snprintf(resolv_path, sizeof(resolv_path), "%s/etc/resolv.conf", g_ddnatv_root); + } else { + snprintf(resolv_path, sizeof(resolv_path), "/etc/resolv.conf"); + } + + struct stat st; + if (stat(resolv_path, &st) == 0) { + if (new_dns == 0) { + FILE *f = fopen(resolv_path, "r"); + if (f) { + char line[256]; + while (fgets(line, sizeof(line), f)) { + char *p = line; + while (*p == ' ' || *p == '\t') p++; + if (strncmp(p, "nameserver", 10) == 0) { + p += 10; + while (*p == ' ' || *p == '\t') p++; + char *end = p; + while (*end && *end != ' ' && *end != '\t' && *end != '\r' && *end != '\n') end++; + *end = '\0'; + struct in_addr a; + if (inet_aton(p, &a)) { + // Only accept valid, non-loopback DNS servers + if ((ntohl(a.s_addr) >> 24) != 127 && a.s_addr != 0) { + new_dns = a.s_addr; + break; + } + } + } + } + fclose(f); + } + } + } + + if (new_dns == 0) { + new_dns = inet_addr("8.8.8.8"); + } + + cached_dns = new_dns; + pthread_mutex_unlock(&dns_mutex); + return cached_dns; +} + + +// The DNS servers in the rootfs resolv.conf (which the app writes from Android's network settings), +// read again at most every 5 seconds. +static int get_dns_servers(ddnatv_dns_server_t *out, int max) { + static ddnatv_dns_server_t cached[DDNATV_DNS_MAX_SERVERS]; + static int cached_count = 0; + static time_t last_check = 0; + static int checked = 0; + static pthread_mutex_t servers_mutex = PTHREAD_MUTEX_INITIALIZER; + + struct timespec ts; + clock_gettime(CLOCK_MONOTONIC, &ts); + pthread_mutex_lock(&servers_mutex); + if (!checked || ts.tv_sec - last_check >= 5) { + checked = 1; + last_check = ts.tv_sec; + init_ddnatv_hook(); + char path[PATH_MAX]; + snprintf(path, sizeof(path), "%s/etc/resolv.conf", g_ddnatv_root[0] ? g_ddnatv_root : ""); + char text[4096]; + ssize_t n = -1; + int fd = open(path, O_RDONLY | O_CLOEXEC); + if (fd >= 0) { + n = read(fd, text, sizeof(text) - 1); + close(fd); + } + text[n > 0 ? n : 0] = '\0'; + cached_count = parse_nameservers(text, cached, DDNATV_DNS_MAX_SERVERS); + } + int count = cached_count < max ? cached_count : max; + memcpy(out, cached, (size_t)count * sizeof(cached[0])); + pthread_mutex_unlock(&servers_mutex); + return count; +} + +// Where a DNS query to a loopback address goes instead: the network's DNS server, in the family of +// the socket (an IPv6 socket gets the first IPv6 server, else the IPv4 one as ::ffff:a.b.c.d). +// Returns the length of the address written to `out`. +static socklen_t dns_redirect_target(const struct sockaddr *orig, struct sockaddr_storage *out) { + memset(out, 0, sizeof(*out)); + if (orig->sa_family == AF_INET) { + memcpy(out, orig, sizeof(struct sockaddr_in)); + ((struct sockaddr_in *)out)->sin_addr.s_addr = get_primary_dns(); + return sizeof(struct sockaddr_in); + } + struct sockaddr_in6 *dst = (struct sockaddr_in6 *)out; + memcpy(dst, orig, sizeof(*dst)); + ddnatv_dns_server_t servers[DDNATV_DNS_MAX_SERVERS]; + int n = get_dns_servers(servers, DDNATV_DNS_MAX_SERVERS); + for (int i = 0; i < n; i++) { + if (servers[i].addr.ss_family == AF_INET6) { + const struct sockaddr_in6 *s6 = (const struct sockaddr_in6 *)&servers[i].addr; + dst->sin6_addr = s6->sin6_addr; + dst->sin6_scope_id = s6->sin6_scope_id; + return sizeof(*dst); + } + } + in_addr_t v4 = get_primary_dns(); + memset(&dst->sin6_addr, 0, sizeof(dst->sin6_addr)); + dst->sin6_addr.s6_addr[10] = 0xff; + dst->sin6_addr.s6_addr[11] = 0xff; + memcpy(&dst->sin6_addr.s6_addr[12], &v4, 4); + dst->sin6_scope_id = 0; + return sizeof(*dst); +} + +// Puts the loopback address that a DNS socket was redirected from back into the source address of a +// reply (`cap` is the size of the caller's buffer), so resolvers that check the sender accept it. +static void restore_dns_source(int fd, struct sockaddr *addr, socklen_t cap, socklen_t *len) { + if (!addr || cap < sizeof(sa_family_t)) return; + in_port_t port; + if (addr->sa_family == AF_INET && cap >= sizeof(struct sockaddr_in)) { + port = ((const struct sockaddr_in *)addr)->sin_port; + } else if (addr->sa_family == AF_INET6 && cap >= sizeof(struct sockaddr_in6)) { + port = ((const struct sockaddr_in6 *)addr)->sin6_port; + } else { + return; + } + if (port != htons(53)) return; + struct sockaddr_storage orig; + socklen_t orig_len = 0; + if (!get_dns_redirect(fd, &orig, &orig_len) || orig.ss_family != addr->sa_family) return; + memcpy(addr, &orig, orig_len < cap ? orig_len : cap); + if (len) *len = orig_len; +} + +#define DDNATV_ADDRINFO_MAGIC 0x434f5254 + +// One addrinfo for an IPv4 (4 bytes) or IPv6 (16 bytes) address; freed by the freeaddrinfo hook. +static struct addrinfo *alloc_addrinfo(const char *node, int family, const void *addr, int port, int socktype, int protocol) { + struct addrinfo *ai = (struct addrinfo *)calloc(1, sizeof(struct addrinfo)); + if (!ai) return NULL; + socklen_t len = family == AF_INET6 ? sizeof(struct sockaddr_in6) : sizeof(struct sockaddr_in); + void *sa = calloc(1, len); + if (!sa) { + free(ai); + return NULL; + } + if (family == AF_INET6) { + struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sa; + sin6->sin6_family = AF_INET6; + sin6->sin6_port = htons((uint16_t)port); + memcpy(&sin6->sin6_addr, addr, 16); + } else { + struct sockaddr_in *sin = (struct sockaddr_in *)sa; + sin->sin_family = AF_INET; + sin->sin_port = htons((uint16_t)port); + memcpy(&sin->sin_addr, addr, 4); + } + + ai->ai_flags = DDNATV_ADDRINFO_MAGIC; + ai->ai_family = family; + ai->ai_socktype = socktype ? socktype : SOCK_STREAM; + ai->ai_protocol = protocol; + ai->ai_addrlen = len; + ai->ai_addr = (struct sockaddr *)sa; + ai->ai_canonname = node ? strdup(node) : NULL; + ai->ai_next = NULL; + return ai; +} + +static uint16_t generate_dns_txid(void) { + uint16_t txid = 0; + static ssize_t (*libc_getrandom)(void *, size_t, unsigned int) = NULL; + static int getrandom_checked = 0; + if (!getrandom_checked) { + libc_getrandom = (ssize_t (*)(void *, size_t, unsigned int))dlsym(RTLD_DEFAULT, "getrandom"); + getrandom_checked = 1; + } + if (libc_getrandom) { + if (libc_getrandom(&txid, sizeof(txid), 1 /* GRND_NONBLOCK */) == sizeof(txid) && txid != 0) { + return txid; + } + } +#if defined(SYS_getrandom) || defined(__NR_getrandom) +#ifndef __NR_getrandom +#define __NR_getrandom SYS_getrandom +#endif + long r = syscall(__NR_getrandom, &txid, sizeof(txid), 1 /* GRND_NONBLOCK */); + if (r == (long)sizeof(txid) && txid != 0) { + return txid; + } +#endif + struct timespec ts; + clock_gettime(CLOCK_MONOTONIC, &ts); + uint32_t val = (uint32_t)(ts.tv_nsec ^ (ts.tv_sec << 16) ^ (uintptr_t)&txid); + txid = (uint16_t)((val & 0xffff) ^ (val >> 16)); + if (txid == 0) txid = 0x5a6b; + return txid; +} + +static void add_dns_server(ddnatv_dns_server_t *list, int *count, int max, const ddnatv_dns_server_t *server) { + if (*count >= max) return; + for (int i = 0; i < *count; i++) { + if (dns_server_equal(&list[i], server)) return; + } + list[(*count)++] = *server; +} + +// Looks one address of `name` up itself, for when glibc found none: asks the network's DNS servers, +// then public ones (IPv4 first, then IPv6, for IPv6-only networks without IPv4 translation), and +// stops at the first that answers. `qtype` is DDNATV_DNS_TYPE_A (4 bytes into `out`) or +// DDNATV_DNS_TYPE_AAAA (16 bytes). `*server` is -1 to ask them in turn, or the index of the only +// server to ask; on return it holds the server that answered (-1 when none did). +static int dns_lookup(const char *name, int qtype, unsigned char *out, int *server) { + if (!name || !out) return -1; + int family = qtype == DDNATV_DNS_TYPE_AAAA ? AF_INET6 : AF_INET; + if (inet_pton(family, name, out) == 1) return 0; + + static const char *const k_public_dns[] = { + "8.8.8.8", "1.1.1.1", "9.9.9.9", "2001:4860:4860::8888", "2606:4700:4700::1111", + }; + ddnatv_dns_server_t servers[DDNATV_DNS_MAX_SERVERS + 6]; + int max = (int)(sizeof(servers) / sizeof(servers[0])); + int count = 0; + ddnatv_dns_server_t s; + // the network's own servers in resolv.conf's order first, its IPv6 ones too: the first IPv4 one + // (get_primary_dns) can be the app's public fallback, which must not see private names first + ddnatv_dns_server_t network[DDNATV_DNS_MAX_SERVERS]; + int network_count = get_dns_servers(network, DDNATV_DNS_MAX_SERVERS); + for (int i = 0; i < network_count; i++) add_dns_server(servers, &count, max, &network[i]); + char primary[INET_ADDRSTRLEN]; + in_addr_t p_dns = get_primary_dns(); // also covers net.dns1 of older Android versions + if (inet_ntop(AF_INET, &p_dns, primary, sizeof(primary)) && dns_server_from_string(primary, &s)) { + add_dns_server(servers, &count, max, &s); + } + for (size_t i = 0; i < sizeof(k_public_dns) / sizeof(k_public_dns[0]); i++) { + if (dns_server_from_string(k_public_dns[i], &s)) add_dns_server(servers, &count, max, &s); + } + + unsigned char packet[512]; + uint16_t txid = generate_dns_txid(); + int packet_len = dns_build_query(name, qtype, txid, packet, sizeof(packet)); + if (packet_len < 0) return -1; + + int only = *server; + *server = -1; + for (int i = (only >= 0 ? only : 0); i < count && (only < 0 || i == only); i++) { + int sock = socket(servers[i].addr.ss_family, SOCK_DGRAM | SOCK_CLOEXEC, 0); + if (sock < 0) continue; + + struct timeval tv; + tv.tv_sec = 0; + tv.tv_usec = 600000; // 600ms fast failover + setsockopt(sock, SOL_SOCKET, SO_RCVTIMEO, &tv, sizeof(tv)); + + // A connected socket only receives datagrams from that server. + if (connect(sock, (const struct sockaddr *)&servers[i].addr, servers[i].len) != 0 || + send(sock, packet, (size_t)packet_len, 0) != packet_len) { + close(sock); + continue; + } + unsigned char resp[1500]; + ssize_t n = recv(sock, resp, sizeof(resp), 0); + close(sock); + int result = n > 0 ? dns_parse_answer(resp, (int)n, txid, qtype, out) : -1; + if (result >= 0) { + *server = i; + return result == 0 ? 0 : -1; + } + } + return -1; +} + +// Whether the network's DNS servers are all IPv6 ones, as on an IPv6-only mobile network. +static int network_dns_is_ipv6_only(void) { + ddnatv_dns_server_t servers[DDNATV_DNS_MAX_SERVERS]; + int n = get_dns_servers(servers, DDNATV_DNS_MAX_SERVERS); + for (int i = 0; i < n; i++) { + if (servers[i].addr.ss_family != AF_INET6) return 0; + } + return n > 0; +} + +// glibc reads /etc/services with an open() of its own, which the path hooks never see, so a service +// name was looked up where Android has no such file: getaddrinfo(host, "https") failed with +// EAI_SERVICE. The rootfs's file is read here when glibc finds nothing. 0, ENOENT or ERANGE. +static int ddnatv_lookup_service(const char *name, int port, const char *proto, + struct servent *out, char *buf, size_t buflen) { + char path_buf[PATH_MAX]; + const char *path = rewrite_path("/etc/services", path_buf, sizeof(path_buf)); + FILE *f = path ? fopen(path, "re") : NULL; + if (!f) return ENOENT; + char line[512]; + int result = ENOENT; + while (result == ENOENT && fgets(line, sizeof(line), f)) { + char *hash = strchr(line, '#'); + if (hash) *hash = '\0'; + char *save = NULL; + char *svc = strtok_r(line, " \t\r\n", &save); + char *pp = svc ? strtok_r(NULL, " \t\r\n", &save) : NULL; + char *slash = pp ? strchr(pp, '/') : NULL; + if (!slash) continue; + *slash = '\0'; + const char *svc_proto = slash + 1; + int svc_port = atoi(pp); + if (proto && strcmp(proto, svc_proto) != 0) continue; + char *aliases[16]; + int naliases = 0; + int matched = name ? strcmp(svc, name) == 0 : svc_port == port; + for (char *a = strtok_r(NULL, " \t\r\n", &save); a && naliases < 15; a = strtok_r(NULL, " \t\r\n", &save)) { + aliases[naliases++] = a; + if (name && strcmp(a, name) == 0) matched = 1; + } + if (!matched) continue; + // buf holds the alias pointers, then the strings + size_t need = sizeof(char *) * (size_t)(naliases + 1) + strlen(svc) + 1 + strlen(svc_proto) + 1; + for (int i = 0; i < naliases; i++) need += strlen(aliases[i]) + 1; + if (need > buflen) { result = ERANGE; break; } + char **list = (char **)(void *)buf; + char *p = buf + sizeof(char *) * (size_t)(naliases + 1); + out->s_name = strcpy(p, svc); p += strlen(svc) + 1; + out->s_proto = strcpy(p, svc_proto); p += strlen(svc_proto) + 1; + for (int i = 0; i < naliases; i++) { list[i] = strcpy(p, aliases[i]); p += strlen(aliases[i]) + 1; } + list[naliases] = NULL; + out->s_aliases = list; + out->s_port = (int)htons((uint16_t)svc_port); + result = 0; + } + fclose(f); + return result; +} + +int getservbyname_r(const char *name, const char *proto, struct servent *result_buf, char *buf, size_t buflen, + struct servent **result) { + static int (*orig)(const char *, const char *, struct servent *, char *, size_t, struct servent **) = NULL; + if (!orig) orig = (int (*)(const char *, const char *, struct servent *, char *, size_t, struct servent **))dlsym(RTLD_NEXT, "getservbyname_r"); + int ret = orig ? orig(name, proto, result_buf, buf, buflen, result) : ENOENT; + if (ret == 0 && result && *result) return 0; + if (!name || !result_buf || !buf) return ret; + int err = ddnatv_lookup_service(name, 0, proto, result_buf, buf, buflen); + if (result) *result = err == 0 ? result_buf : NULL; + return err == ERANGE ? ERANGE : 0; +} + +int getservbyport_r(int port, const char *proto, struct servent *result_buf, char *buf, size_t buflen, + struct servent **result) { + static int (*orig)(int, const char *, struct servent *, char *, size_t, struct servent **) = NULL; + if (!orig) orig = (int (*)(int, const char *, struct servent *, char *, size_t, struct servent **))dlsym(RTLD_NEXT, "getservbyport_r"); + int ret = orig ? orig(port, proto, result_buf, buf, buflen, result) : ENOENT; + if (ret == 0 && result && *result) return 0; + if (!result_buf || !buf) return ret; + int err = ddnatv_lookup_service(NULL, ntohs((uint16_t)port), proto, result_buf, buf, buflen); + if (result) *result = err == 0 ? result_buf : NULL; + return err == ERANGE ? ERANGE : 0; +} + +struct servent *getservbyname(const char *name, const char *proto) { + static __thread struct servent entry; + static __thread char buf[1024]; + struct servent *found = NULL; + return getservbyname_r(name, proto, &entry, buf, sizeof(buf), &found) == 0 ? found : NULL; +} + +struct servent *getservbyport(int port, const char *proto) { + static __thread struct servent entry; + static __thread char buf[1024]; + struct servent *found = NULL; + return getservbyport_r(port, proto, &entry, buf, sizeof(buf), &found) == 0 ? found : NULL; +} + +static int synthesize_fallback_addrinfo(const char *node, const char *service, + const struct addrinfo *hints, + struct addrinfo **res) { + if (!node || !res) return EAI_NONAME; + + int socktype = (hints && hints->ai_socktype) ? hints->ai_socktype : SOCK_STREAM; + int protocol = (hints && hints->ai_protocol) ? hints->ai_protocol + : socktype == SOCK_DGRAM ? IPPROTO_UDP : socktype == SOCK_STREAM ? IPPROTO_TCP : 0; + int family = hints ? hints->ai_family : AF_UNSPEC; + if (family != AF_UNSPEC && family != AF_INET && family != AF_INET6) return EAI_FAMILY; + + // As glibc: no service is port 0, a number is that port, a name comes from /etc/services + int port = 0; + if (service && *service) { + char *end = NULL; + errno = 0; + long p = strtol(service, &end, 10); + if (end && *end == '\0' && errno == 0) { + if (p < 0 || p > 65535) return EAI_SERVICE; + port = (int)p; + } else { + struct servent se, *found = NULL; + char se_buf[1024]; + if (getservbyname_r(service, socktype == SOCK_DGRAM ? "udp" : "tcp", &se, se_buf, sizeof(se_buf), &found) != 0 || !found) + return EAI_SERVICE; + port = ntohs((uint16_t)found->s_port); + } + } + + // The address families the caller asked for: an IPv6-only caller must not get an IPv4 address, + // and AF_UNSPEC gets both, IPv6 first on a network whose DNS servers are all IPv6 ones. The second + // lookup only asks the server that answered the first, and is skipped when none answered. + int want4 = family == AF_UNSPEC || family == AF_INET; + int want6 = family == AF_UNSPEC || family == AF_INET6; + int v6_first = want6 && (!want4 || network_dns_is_ipv6_only()); + unsigned char resolved[16]; + int server = -1; + struct addrinfo *first = NULL; + struct addrinfo *second = NULL; + if (dns_lookup(node, v6_first ? DDNATV_DNS_TYPE_AAAA : DDNATV_DNS_TYPE_A, resolved, &server) == 0) { + first = alloc_addrinfo(node, v6_first ? AF_INET6 : AF_INET, resolved, port, socktype, protocol); + } + if (want4 && want6 && server >= 0 && + dns_lookup(node, v6_first ? DDNATV_DNS_TYPE_A : DDNATV_DNS_TYPE_AAAA, resolved, &server) == 0) { + second = alloc_addrinfo(node, v6_first ? AF_INET : AF_INET6, resolved, port, socktype, protocol); + } + if (first && second) { + first->ai_next = second; + } + struct addrinfo *ai = first ? first : second; + if (ai) { + *res = ai; + return 0; + } + + return EAI_NONAME; +} + +int getaddrinfo(const char *node, const char *service, + const struct addrinfo *hints, + struct addrinfo **res) { + static int (*orig_getaddrinfo)(const char *, const char *, const struct addrinfo *, struct addrinfo **) = NULL; + if (!orig_getaddrinfo) orig_getaddrinfo = (int (*)(const char *, const char *, const struct addrinfo *, struct addrinfo **))dlsym(RTLD_NEXT, "getaddrinfo"); + + struct addrinfo mod_hints; + if (hints) { + mod_hints = *hints; + // On Android, unprivileged apps are blocked by SELinux from querying netlink routing interfaces. + // Glibc's AI_ADDRCONFIG flag causes getaddrinfo to fail or return no addresses when netlink fails. + // Clearing AI_ADDRCONFIG ensures normal, robust DNS resolution. + mod_hints.ai_flags &= ~AI_ADDRCONFIG; + } else { + memset(&mod_hints, 0, sizeof(mod_hints)); + mod_hints.ai_family = AF_UNSPEC; + mod_hints.ai_flags = 0; + } + + int ret = orig_getaddrinfo ? orig_getaddrinfo(node, service, &mod_hints, res) : EAI_FAIL; + // A numeric-only lookup must never turn into a DNS query. + if ((ret != 0 || !res || !*res) && node && !(hints && (hints->ai_flags & AI_NUMERICHOST))) { + int fallback = synthesize_fallback_addrinfo(node, service, hints, res); + // When the fallback finds nothing either, glibc's own error (EAI_AGAIN: try again later, + // EAI_NONAME: no such name) is the more precise one. + // A request the fallback rejects outright (no such service, an unsupported family) is that + // error whatever glibc's was + if (fallback == 0 || ret == 0 || fallback == EAI_SERVICE || fallback == EAI_FAMILY) ret = fallback; + } + return ret; +} + +void freeaddrinfo(struct addrinfo *res) { + static void (*orig_freeaddrinfo)(struct addrinfo *) = NULL; + if (!orig_freeaddrinfo) orig_freeaddrinfo = (void (*)(struct addrinfo *))dlsym(RTLD_NEXT, "freeaddrinfo"); + + if (!res) return; + if (res->ai_flags == DDNATV_ADDRINFO_MAGIC) { + struct addrinfo *curr = res; + while (curr) { + struct addrinfo *next = curr->ai_next; + if (curr->ai_canonname) free(curr->ai_canonname); + if (curr->ai_addr) free(curr->ai_addr); + free(curr); + curr = next; + } + return; + } + if (orig_freeaddrinfo) orig_freeaddrinfo(res); +} + +// gethostbyname() and gethostbyname2() read /etc/resolv.conf with glibc's own open(), on Android's +// /etc, so they asked no DNS server and only /etc/hosts answered. When glibc finds nothing, the +// name is looked up with getaddrinfo() above, which knows the network's servers; a name DNS does +// not have still gets no address (HOST_NOT_FOUND). +static int hostent_from_getaddrinfo(const char *name, int af, struct hostent *ret, char *buf, size_t buflen, + struct hostent **result, int *herr) { + *result = NULL; + if (!name || (af != AF_INET && af != AF_INET6)) { *herr = NO_RECOVERY; return EINVAL; } + struct addrinfo hints; + memset(&hints, 0, sizeof(hints)); + hints.ai_family = af; + hints.ai_socktype = SOCK_STREAM; + hints.ai_flags = AI_CANONNAME; + struct addrinfo *res = NULL; + int rc = getaddrinfo(name, NULL, &hints, &res); + if (rc != 0 || !res) { + *herr = (rc == EAI_NONAME || rc == EAI_NODATA || rc == EAI_ADDRFAMILY) ? HOST_NOT_FOUND + : rc == EAI_AGAIN ? TRY_AGAIN : NO_RECOVERY; + if (res) freeaddrinfo(res); + return rc == EAI_AGAIN ? EAGAIN : ENOENT; + } + size_t addr_len = af == AF_INET ? sizeof(struct in_addr) : sizeof(struct in6_addr); + int count = 0; + for (struct addrinfo *a = res; a && count < 16; a = a->ai_next) if (a->ai_family == af) count++; + const char *canon = res->ai_canonname ? res->ai_canonname : name; + size_t canon_len = strlen(canon) + 1; + size_t need = sizeof(char *) * (size_t)(count + 1) + sizeof(char *) + addr_len * (size_t)count + canon_len + sizeof(void *); + if (count == 0 || need > buflen) { + freeaddrinfo(res); + if (count == 0) { *herr = NO_DATA; return ENOENT; } + *herr = NETDB_INTERNAL; + return ERANGE; + } + // pointers first, aligned, then the addresses and the name + char *p = buf + ((sizeof(void *) - ((uintptr_t)buf % sizeof(void *))) % sizeof(void *)); + char **addr_list = (char **)p; + p += sizeof(char *) * (size_t)(count + 1); + char **aliases = (char **)p; + p += sizeof(char *); + aliases[0] = NULL; + int i = 0; + for (struct addrinfo *a = res; a && i < count; a = a->ai_next) { + if (a->ai_family != af) continue; + const void *src = af == AF_INET ? (const void *)&((struct sockaddr_in *)a->ai_addr)->sin_addr + : (const void *)&((struct sockaddr_in6 *)a->ai_addr)->sin6_addr; + memcpy(p, src, addr_len); + addr_list[i++] = p; + p += addr_len; + } + addr_list[i] = NULL; + memcpy(p, canon, canon_len); + ret->h_name = p; + ret->h_aliases = aliases; + ret->h_addrtype = af; + ret->h_length = (int)addr_len; + ret->h_addr_list = addr_list; + freeaddrinfo(res); + *result = ret; + *herr = 0; + return 0; +} + +int gethostbyname2_r(const char *name, int af, struct hostent *ret, char *buf, size_t buflen, + struct hostent **result, int *h_errnop) { + static int (*orig)(const char *, int, struct hostent *, char *, size_t, struct hostent **, int *) = NULL; + if (!orig) orig = (int (*)(const char *, int, struct hostent *, char *, size_t, struct hostent **, int *))dlsym(RTLD_NEXT, "gethostbyname2_r"); + int herr = 0; + int rc = orig ? orig(name, af, ret, buf, buflen, result, &herr) : ENOSYS; + if (rc == 0 && result && *result) { if (h_errnop) *h_errnop = 0; return 0; } + if (rc == ERANGE) { if (h_errnop) *h_errnop = herr; return rc; } + int fallback_herr = 0; + struct hostent *found = NULL; + rc = hostent_from_getaddrinfo(name, af, ret, buf, buflen, &found, &fallback_herr); + if (result) *result = found; + if (h_errnop) *h_errnop = fallback_herr; + return rc; +} + +int gethostbyname_r(const char *name, struct hostent *ret, char *buf, size_t buflen, + struct hostent **result, int *h_errnop) { + return gethostbyname2_r(name, AF_INET, ret, buf, buflen, result, h_errnop); +} + +static __thread struct hostent t_hostent; +static __thread char t_hostent_buf[4096]; + +struct hostent *gethostbyname2(const char *name, int af) { + struct hostent *result = NULL; + int herr = 0; + gethostbyname2_r(name, af, &t_hostent, t_hostent_buf, sizeof(t_hostent_buf), &result, &herr); + h_errno = result ? 0 : herr; + return result; +} + +struct hostent *gethostbyname(const char *name) { + return gethostbyname2(name, AF_INET); +} + +// Whether a resolver state names a server other than loopback. glibc keeps IPv6 servers in the +// extension (their nsaddr_list entry has family 0), so an IPv6-only resolv.conf counts too. +// The network's own servers, IPv6 ones too (an IPv6-only network has no IPv4 server to ask), for a +// state glibc left with none it can use: it read no /etc/resolv.conf. glibc frees the IPv6 entries. +static void fill_fallback_servers(res_state statp) { + ddnatv_dns_server_t servers[DDNATV_DNS_MAX_SERVERS]; + int n = get_dns_servers(servers, DDNATV_DNS_MAX_SERVERS); + for (int i = 0; i < MAXNS; i++) { + free(statp->_u._ext.nsaddrs[i]); + statp->_u._ext.nsaddrs[i] = NULL; + } + int count = 0; + for (int i = 0; i < n && count < MAXNS; i++) { + if (servers[i].addr.ss_family == AF_INET) { + memcpy(&statp->nsaddr_list[count], &servers[i].addr, sizeof(struct sockaddr_in)); + statp->nsaddr_list[count].sin_port = htons(53); + statp->_u._ext.nsaddrs[count] = NULL; + count++; + } else if (servers[i].addr.ss_family == AF_INET6) { + struct sockaddr_in6 *six = malloc(sizeof(*six)); + if (!six) continue; + memcpy(six, &servers[i].addr, sizeof(*six)); + six->sin6_port = htons(53); + memset(&statp->nsaddr_list[count], 0, sizeof(statp->nsaddr_list[count])); + statp->_u._ext.nsaddrs[count] = six; + count++; + } + } + if (count == 0) { + statp->nsaddr_list[0].sin_family = AF_INET; + statp->nsaddr_list[0].sin_port = htons(53); + statp->nsaddr_list[0].sin_addr.s_addr = get_primary_dns(); + statp->nsaddr_list[1].sin_family = AF_INET; + statp->nsaddr_list[1].sin_port = htons(53); + inet_pton(AF_INET, "8.8.8.8", &statp->nsaddr_list[1].sin_addr); + count = 2; + } + statp->nscount = count; +} + +static int res_state_has_usable_server(res_state statp) { + for (int i = 0; i < statp->nscount && i < MAXNS; i++) { + if (statp->nsaddr_list[i].sin_family == AF_INET) { + in_addr_t a = statp->nsaddr_list[i].sin_addr.s_addr; + if ((ntohl(a) >> 24) != 127 && a != 0) return 1; + } else if (statp->_u._ext.nsaddrs[i] != NULL) { + const struct in6_addr *a6 = &statp->_u._ext.nsaddrs[i]->sin6_addr; + if (!IN6_IS_ADDR_LOOPBACK(a6) && !IN6_IS_ADDR_UNSPECIFIED(a6)) return 1; + } + } + return 0; +} + +int res_init(void) { + static int (*orig_res_init)(void) = NULL; + // glibc's symbols are __res_init and __res_ninit (resolv.h makes the names macros): looked up as + // res_init and res_ninit they were never found, the state stayed without RES_INIT, and Chromium + // (Steam's store) failed to read a DNS configuration + if (!orig_res_init) orig_res_init = (int (*)(void))dlsym(RTLD_NEXT, "__res_init"); + if (!orig_res_init) orig_res_init = (int (*)(void))dlsym(RTLD_NEXT, "res_init"); + int ret = orig_res_init ? orig_res_init() : 0; + res_state statp = __res_state(); + if (statp) { + if (!res_state_has_usable_server(statp)) fill_fallback_servers(statp); + statp->retrans = 1; + statp->retry = 2; + } + return ret; +} + +int res_ninit(res_state statp) { + static int (*orig_res_ninit)(res_state) = NULL; + if (!orig_res_ninit) orig_res_ninit = (int (*)(res_state))dlsym(RTLD_NEXT, "__res_ninit"); + if (!orig_res_ninit) orig_res_ninit = (int (*)(res_state))dlsym(RTLD_NEXT, "res_ninit"); + if (statp) { + memset(statp, 0, sizeof(*statp)); + statp->_vcsock = -1; + for (int i = 0; i < MAXNS; i++) { + statp->_u._ext.nssocks[i] = -1; + } + } + int ret = orig_res_ninit ? orig_res_ninit(statp) : 0; + if (statp) { + if (!res_state_has_usable_server(statp)) fill_fallback_servers(statp); + statp->retrans = 1; + statp->retry = 2; + } + return ret; +} + +int res_nquery(res_state statp, const char *dname, int class, int type, + unsigned char *answer, int anslen) { + static int (*orig_res_nquery)(res_state, const char *, int, int, unsigned char *, int) = NULL; + if (!orig_res_nquery) orig_res_nquery = (int (*)(res_state, const char *, int, int, unsigned char *, int))dlsym(RTLD_NEXT, "res_nquery"); + // DNS SRV queries are optional for APT mirrors and frequently cause delays or issues + if (type == 33 /* T_SRV */) { + h_errno = NO_DATA; + return -1; + } + return orig_res_nquery ? orig_res_nquery(statp, dname, class, type, answer, anslen) : -1; +} + +int res_query(const char *dname, int class, int type, + unsigned char *answer, int anslen) { + static int (*orig_res_query)(const char *, int, int, unsigned char *, int) = NULL; + if (!orig_res_query) orig_res_query = (int (*)(const char *, int, int, unsigned char *, int))dlsym(RTLD_NEXT, "res_query"); + if (type == 33 /* T_SRV */) { + h_errno = NO_DATA; + return -1; + } + return orig_res_query ? orig_res_query(dname, class, type, answer, anslen) : -1; +} + +int res_nsearch(res_state statp, const char *dname, int class, int type, + unsigned char *answer, int anslen) { + static int (*orig_res_nsearch)(res_state, const char *, int, int, unsigned char *, int) = NULL; + if (!orig_res_nsearch) orig_res_nsearch = (int (*)(res_state, const char *, int, int, unsigned char *, int))dlsym(RTLD_NEXT, "res_nsearch"); + if (type == 33 /* T_SRV */) { + h_errno = NO_DATA; + return -1; + } + return orig_res_nsearch ? orig_res_nsearch(statp, dname, class, type, answer, anslen) : -1; +} + +int res_search(const char *dname, int class, int type, + unsigned char *answer, int anslen) { + static int (*orig_res_search)(const char *, int, int, unsigned char *, int) = NULL; + if (!orig_res_search) orig_res_search = (int (*)(const char *, int, int, unsigned char *, int))dlsym(RTLD_NEXT, "res_search"); + if (type == 33 /* T_SRV */) { + h_errno = NO_DATA; + return -1; + } + return orig_res_search ? orig_res_search(dname, class, type, answer, anslen) : -1; +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/paths.c b/tools/nativeguest/hook/paths.c new file mode 100644 index 0000000000..4c1340b339 --- /dev/null +++ b/tools/nativeguest/hook/paths.c @@ -0,0 +1,697 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Path translation: Ubuntu paths (/usr, /etc, ...) mapped into the rootfs, Android's own mounts +// left alone, and the library directories of the rootfs. + +// ---- Path translation ------------------------------------------------------------------- +// Pure string functions (no syscalls), so tests/native can check them directly. They run on +// every file-system call, so they avoid snprintf and compute the rootfs prefix length once. + +static char g_ddnatv_root[PATH_MAX] = {0}; +static size_t g_ddnatv_root_len = 0; + +static void ddnatv_set_root(const char *root, size_t len) { + if (!root) len = 0; + if (len > sizeof(g_ddnatv_root) - 1) len = sizeof(g_ddnatv_root) - 1; + if (len > 0) memcpy(g_ddnatv_root, root, len); + g_ddnatv_root[len] = '\0'; + g_ddnatv_root_len = len; +} + +// Mounts that proot used to provide: "src:dst" pairs from DDNATV_BINDS ('|' separated), longest dst first. +// A path under dst is read from src; src equal to dst keeps a host path that would otherwise be +// looked up in the rootfs. +struct ddnatv_bind { + char *src, *dst; + size_t src_len, dst_len; + int identity; + int order; // position in DDNATV_BINDS: the earlier of two mounts of one folder is its guest path +}; +// as many as the session has: a fixed table dropped what came after its 128th entry +static struct ddnatv_bind *g_binds = NULL; +static int g_nbinds = 0; +static char *g_binds_raw = NULL; +// The session's host name (DDNATV_HOSTNAME), what proot put in uname(): Android's kernel says "localhost" +static char g_hostname[65]; +// A Flatpak sandbox's: the session's rootfs (DDNATV_LINK_ROOT), whose hook stored absolute guest +// link targets as paths in it, as the kernel follows them there; in the sandbox they are guest paths +static char g_link_root[PATH_MAX]; +static size_t g_link_root_len = 0; + +static int ddnatv_bind_longer_first(const void *a, const void *b) { + const struct ddnatv_bind *x = a, *y = b; + return (y->dst_len > x->dst_len) - (y->dst_len < x->dst_len); +} + +static void ddnatv_load_binds(const char *spec) { + if (!spec || !spec[0]) return; + char *raw = strdup(spec); + char *copy = strdup(spec); + if (!raw || !copy) { free(raw); free(copy); return; } + char *save = NULL; + size_t count = 1; + for (const char *c = spec; *c; c++) count += *c == '|'; + g_binds = calloc(count, sizeof(*g_binds)); + if (!g_binds) { free(raw); free(copy); return; } + for (char *entry = strtok_r(copy, "|", &save); entry && (size_t)g_nbinds < count; entry = strtok_r(NULL, "|", &save)) { + char *colon = strchr(entry, ':'); + const char *src = entry; + const char *dst = colon ? colon + 1 : entry; + if (colon) *colon = '\0'; + if (src[0] != '/' || dst[0] != '/' || strcmp(dst, "/") == 0) continue; + struct ddnatv_bind *b = &g_binds[g_nbinds++]; + b->src = strdup(src); + b->dst = strdup(dst); + b->src_len = strlen(src); + b->dst_len = strlen(dst); + while (b->dst_len > 1 && b->dst[b->dst_len - 1] == '/') b->dst[--b->dst_len] = '\0'; + while (b->src_len > 1 && b->src[b->src_len - 1] == '/') b->src[--b->src_len] = '\0'; + b->identity = strcmp(b->src, b->dst) == 0; + b->order = g_nbinds - 1; + } + free(copy); + qsort(g_binds, (size_t)g_nbinds, sizeof(g_binds[0]), ddnatv_bind_longer_first); + g_binds_raw = raw; +} + +// Appends s[0..len) to out[0..used) and NUL-terminates, truncating like snprintf. +// Returns the new length. +static size_t ddnatv_append(char *out, size_t outsz, size_t used, const char *s, size_t len) { + if (outsz == 0) return 0; + size_t room = used < outsz - 1 ? outsz - 1 - used : 0; + if (len > room) len = room; + if (len > 0) memcpy(out + used, s, len); + out[used + len] = '\0'; + return used + len; +} + +// Copies the string src into out[0..outsz), truncated and NUL-terminated as strncpy() followed by +// out[outsz - 1] = '\0' leaves it, but writes only the bytes of the string: strncpy() fills the rest +// of a PATH_MAX buffer with zeros, 4 KB of writes for a path of 30 characters, and in a child that a +// shell has just forked every page written is a copy-on-write fault. +static size_t ddnatv_copy_cstr(char *out, size_t outsz, const char *src) { + if (outsz == 0) return 0; + size_t len = strnlen(src, outsz - 1); + memcpy(out, src, len); + out[len] = '\0'; + return len; +} + +static inline int is_path_prefix(const char *path, const char *prefix, size_t prefix_len) { + if (strncmp(path, prefix, prefix_len) != 0) return 0; + return path[prefix_len] == '/' || path[prefix_len] == '\0'; +} + +static inline const char *get_rootfs_subpath(const char *target) { + if (!target || g_ddnatv_root_len == 0) return NULL; + if (strncmp(target, g_ddnatv_root, g_ddnatv_root_len) == 0 && + (target[g_ddnatv_root_len] == '/' || target[g_ddnatv_root_len] == '\0')) { + return target + g_ddnatv_root_len; + } + return NULL; +} + +// A guest path that a session mount puts outside the rootfs (/run/droiddeck, a game library): a +// program or script there is the guest's, and a script's "#!/bin/sh" is the rootfs shell. The +// kernel ran them with Android's /system/bin/sh, which found no /usr/bin/kwin_wayland. +static int is_mapped_guest_path(const char *path) { + if (!path || path[0] != '/') return 0; + for (int i = 0; i < g_nbinds; i++) { + const struct ddnatv_bind *b = &g_binds[i]; + if (b->identity) continue; + if (is_path_prefix(path, b->dst, b->dst_len)) return 1; + // its real place too: a relative program is made absolute from the real working directory + if (is_path_prefix(path, b->src, b->src_len) && get_rootfs_subpath(b->src) == NULL) return 1; + } + return 0; +} + +// Android's own mounts and files, which must never be redirected into the rootfs. +// `path` starts with '/'; a prefix can only match when its second character does. +static int is_android_host_path(const char *path) { + switch (path[1]) { + case 'a': return is_path_prefix(path, "/apex", 5); + case 'c': return is_path_prefix(path, "/config", 7); + case 'd': return is_path_prefix(path, "/dev", 4) || is_path_prefix(path, "/d", 2) || + is_path_prefix(path, "/data", 5); + case 'l': return is_path_prefix(path, "/linkerconfig", 13); + case 'o': return is_path_prefix(path, "/odm", 4) || is_path_prefix(path, "/oem", 4); + case 'p': return is_path_prefix(path, "/proc", 5) || is_path_prefix(path, "/product", 8); + case 's': return strcmp(path, "/sbin/su") == 0 || strcmp(path, "/su") == 0 || + is_path_prefix(path, "/sys", 4) || is_path_prefix(path, "/system", 7) || + is_path_prefix(path, "/system_ext", 11) || is_path_prefix(path, "/sdcard", 7) || + is_path_prefix(path, "/storage", 8); + case 'v': return is_path_prefix(path, "/vendor", 7); + default: return 0; + } +} + +static const char *rewrite_path_in_root(const char *path, char *buffer, size_t bufsize); + +#if defined(__aarch64__) +static long raw_readlinkat(int dirfd, const char *path, char *buf, size_t size) { + register long x8 __asm__("x8") = 78; // readlinkat, made directly: the hook's own readlink would map the path again + register long x0 __asm__("x0") = dirfd; + register long x1 __asm__("x1") = (long)path; + register long x2 __asm__("x2") = (long)buf; + register long x3 __asm__("x3") = (long)size; + __asm__ volatile("svc #0" : "+r"(x0) : "r"(x8), "r"(x1), "r"(x2), "r"(x3) : "memory"); + return x0; +} +#endif + +static __thread int t_bind_link_depth = 0; + +// A mount stand-in can hold symbolic links with absolute guest targets (/sys/class/hidraw/hidraw16 -> +// /sys/devices/droiddeck/...): proot follows them inside the guest, the kernel on Android's own /sys. +// A link met on the way to a deeper path is replaced by its target, mapped again; the last component is +// left as it is (lstat() and readlink() must see the link). +static const char *resolve_bind_links(const char *host, size_t src_len, char *buffer, size_t bufsize) { +#if defined(__aarch64__) + size_t len = strlen(host); + if (len >= PATH_MAX || t_bind_link_depth >= 8) return host; + for (size_t i = src_len + 1; i < len; i++) { + if (host[i] != '/') continue; + char prefix[PATH_MAX]; + memcpy(prefix, host, i); + prefix[i] = '\0'; + char target[PATH_MAX]; + long n = raw_readlinkat(AT_FDCWD, prefix, target, sizeof(target) - 1); + if (n <= 0) continue; + target[n] = '\0'; + if (target[0] != '/') continue; + char guest[PATH_MAX]; + size_t used = ddnatv_append(guest, sizeof(guest), 0, target, (size_t)n); + ddnatv_append(guest, sizeof(guest), used, host + i, len - i); + t_bind_link_depth++; + const char *mapped = rewrite_path_in_root(guest, buffer, bufsize); + if (mapped != buffer) ddnatv_copy_cstr(buffer, bufsize, mapped); + t_bind_link_depth--; + return buffer; + } +#else + (void)src_len; (void)bufsize; +#endif + return host == buffer ? buffer : host; +} + +// Wine opens every file through its prefix's drive link (dosdevices/z: -> /), so the link must be +// followed in the guest's view even where the prefix is plain rootfs: the kernel would look for the +// rest of the path on Android's own tree. Only that component is checked, not each one of every path. +static const char *resolve_drive_links(const char *host, char *buffer, size_t bufsize) { + const char *devices = strstr(host, "/dosdevices/"); + if (!devices) return host; + return resolve_bind_links(host, (size_t)(devices - host) + 11, buffer, bufsize); +} + +// Maps an absolute Ubuntu path into the rootfs. Returns `path` (possibly advanced past +// redundant leading "/" and "/." components) when it needs no change, else `buffer`. +static const char *rewrite_path_in_root(const char *path, char *buffer, size_t bufsize) { + if (!path) return NULL; + if (path[0] != '/' || g_ddnatv_root_len == 0) return path; + + // Strip multiple redundant leading slashes: //foo -> /foo + while (path[0] == '/' && path[1] == '/') { + path++; + } + + // Strip leading /./: /./boot -> /boot + while (path[0] == '/' && path[1] == '.' && (path[2] == '/' || path[2] == '\0')) { + if (path[2] == '/') { + path += 2; + } else { + path = "/"; + break; + } + } + + // Root directory + if (path[1] == '\0') { + ddnatv_append(buffer, bufsize, 0, g_ddnatv_root, g_ddnatv_root_len); + return buffer; + } + + for (int i = 0; i < g_nbinds; i++) { + const struct ddnatv_bind *b = &g_binds[i]; + if (path[1] == b->dst[1] && is_path_prefix(path, b->dst, b->dst_len)) { + if (b->identity) return path; + size_t n = ddnatv_append(buffer, bufsize, 0, b->src, b->src_len); + ddnatv_append(buffer, bufsize, n, path + b->dst_len, strlen(path + b->dst_len)); + return resolve_bind_links(buffer, b->src_len, buffer, bufsize); + } + } + + // Already inside The native userland rootfs + if (get_rootfs_subpath(path) != NULL) { + return resolve_drive_links(path, buffer, bufsize); + } + + // The real place of a mounted folder, which getcwd() and /proc/self/fd links answer for it: Steam + // made a game's path from one on the SD card library and found no sekiro.exe in the rootfs + for (int i = 0; i < g_nbinds; i++) { + const struct ddnatv_bind *b = &g_binds[i]; + if (!b->identity && path[1] == b->src[1] && is_path_prefix(path, b->src, b->src_len)) + return resolve_drive_links(path, buffer, bufsize); + } + + // POSIX shared memory (/dev/shm) redirection to The native userland rootfs tmp/shm + if (strncmp(path, "/dev/shm", 8) == 0 && (path[8] == '/' || path[8] == '\0')) { + size_t n = ddnatv_append(buffer, bufsize, 0, g_ddnatv_root, g_ddnatv_root_len); + n = ddnatv_append(buffer, bufsize, n, "/tmp/shm", 8); + ddnatv_append(buffer, bufsize, n, path + 8, strlen(path + 8)); + return buffer; + } + + // Real host Android kernel & system mounts + if (is_android_host_path(path)) { + return path; + } + + // Any other absolute path belongs to The native userland rootfs (/boot, /media, /snap, /etc, /usr, ...) + size_t n = ddnatv_append(buffer, bufsize, 0, g_ddnatv_root, g_ddnatv_root_len); + ddnatv_append(buffer, bufsize, n, path, strlen(path)); + return resolve_drive_links(buffer, buffer, bufsize); +} + +// A link target the session's hook stored as a path in its rootfs, given back as the guest path it +// stands for (see g_link_root). Rewrites target[0..len) in place; returns the new length. +static size_t link_root_guest_target(char *target, size_t len) { + if (!g_link_root_len || len < g_link_root_len || memcmp(target, g_link_root, g_link_root_len) != 0) return len; + if (len == g_link_root_len) { target[0] = '/'; target[1] = '\0'; return 1; } + if (target[g_link_root_len] != '/') return len; + memmove(target, target + g_link_root_len, len - g_link_root_len + 1); + return len - g_link_root_len; +} + +// The guest path a symbolic link at absolute guest path `path` leads to, followed in the guest's +// view: the kernel resolves a relative target next to the link's real place, and in a mount that is +// elsewhere (Flatpak's /run/user/0/wayland-0 -> ../../flatpak/wayland-0, where /run/flatpak/wayland-0 +// is another mount). Returns `path` when it is no link. +static const char *follow_guest_link(const char *path, char *out, size_t outsz) { +#if defined(__aarch64__) + const char *cur = path; + for (int depth = 0; depth < 8; depth++) { + char host_buf[PATH_MAX]; + const char *host = rewrite_path_in_root(cur, host_buf, sizeof(host_buf)); + // /dev/stdin and /dev/fd are mounts of /proc/self/fd, whose links ("pipe:[123]") only the kernel opens + if (strncmp(host, "/proc/", 6) == 0) return cur; + char target[PATH_MAX]; + long n = raw_readlinkat(AT_FDCWD, host, target, sizeof(target) - 1); + if (n <= 0) return cur; + target[n] = '\0'; + n = (long)link_root_guest_target(target, (size_t)n); + char joined[PATH_MAX]; + if (target[0] == '/') { + ddnatv_copy_cstr(joined, sizeof(joined), target); + } else { + const char *slash = strrchr(cur, '/'); + size_t dir_len = slash ? (size_t)(slash - cur) : 0; + size_t used = ddnatv_append(joined, sizeof(joined), 0, cur, dir_len); + used = ddnatv_append(joined, sizeof(joined), used, "/", 1); + ddnatv_append(joined, sizeof(joined), used, target, strlen(target)); + } + // lexically, as the guest sees it + size_t len = 0; + out[0] = '\0'; + for (const char *p = joined; *p;) { + while (*p == '/') p++; + const char *end = strchr(p, '/'); + size_t part = end ? (size_t)(end - p) : strlen(p); + if (part == 0) break; + if (part == 1 && p[0] == '.') { + } else if (part == 2 && p[0] == '.' && p[1] == '.') { + while (len > 0 && out[len - 1] != '/') len--; + if (len > 0) len--; + out[len] = '\0'; + } else if (len + 1 + part < outsz) { + out[len++] = '/'; + memcpy(out + len, p, part); + len += part; + out[len] = '\0'; + } + p += part; + } + if (len == 0) { out[0] = '/'; out[1] = '\0'; } + cur = out; + } + return cur; +#else + (void)out; (void)outsz; + return path; +#endif +} + +// On ENOENT, stat()/lstat()/readlink() retry /usr/bin <-> /bin and /usr/sbin <-> /sbin, for +// rootfs trees where bin and sbin are real directories. Returns 1 for the bin pair, 2 for the +// sbin pair (with the other spelling in `alt`), 0 when `sub` is in neither. +#define DDNATV_USRMERGE_BIN 1 +#define DDNATV_USRMERGE_SBIN 2 +static int usrmerge_alt_path(const char *sub, char *alt, size_t altsz) { + const char *dir; + const char *rest; + int pair; + if (strncmp(sub, "/usr/bin/", 9) == 0) { + dir = "/bin/"; rest = sub + 9; pair = DDNATV_USRMERGE_BIN; + } else if (strncmp(sub, "/bin/", 5) == 0) { + dir = "/usr/bin/"; rest = sub + 5; pair = DDNATV_USRMERGE_BIN; + } else if (strncmp(sub, "/usr/sbin/", 10) == 0) { + dir = "/sbin/"; rest = sub + 10; pair = DDNATV_USRMERGE_SBIN; + } else if (strncmp(sub, "/sbin/", 6) == 0) { + dir = "/usr/sbin/"; rest = sub + 6; pair = DDNATV_USRMERGE_SBIN; + } else { + return 0; + } + size_t n = ddnatv_append(alt, altsz, 0, g_ddnatv_root, g_ddnatv_root_len); + n = ddnatv_append(alt, altsz, n, dir, strlen(dir)); + ddnatv_append(alt, altsz, n, rest, strlen(rest)); + return pair; +} + +// Whether postprocess_readlink() below can change a link's target of length target_len, read +// through linkpath: only a target that starts with the rootfs path (at least that long) or a relative +// one into /etc/alternatives (at least "../alternatives", 15 characters, from a directory next to it; +// any "../" under /etc/alternatives itself). lstat() of a link reads it only then, to report its +// rewritten length. +static int readlink_result_may_change(const char *linkpath, long long target_len) { + if (g_ddnatv_root_len > 0 && target_len >= (long long)g_ddnatv_root_len) return 1; + if (!linkpath || linkpath[0] != '/') return 0; + if (strncmp(linkpath, "/etc/alternatives", 17) == 0) return target_len >= 2; + return target_len >= 15; +} + +// Helper for path normalization +static void normalize_path(char *path) { + if (!path || !*path) return; + int is_abs = (path[0] == '/'); + char *stack[128]; + int top = 0; + + char tmp[4096]; + strncpy(tmp, path, sizeof(tmp) - 1); + tmp[sizeof(tmp) - 1] = '\0'; + + char *saveptr = NULL; + char *tok = strtok_r(tmp, "/", &saveptr); + while (tok) { + if (strcmp(tok, ".") == 0) { + // ignore + } else if (strcmp(tok, "..") == 0) { + if (top > 0) top--; + } else { + if (top < 128) stack[top++] = tok; + } + tok = strtok_r(NULL, "/", &saveptr); + } + + char *dst = path; + if (is_abs) *dst++ = '/'; + for (int i = 0; i < top; i++) { + size_t len = strlen(stack[i]); + memcpy(dst, stack[i], len); + dst += len; + if (i + 1 < top) *dst++ = '/'; + } + if (dst == path && is_abs) *dst++ = '/'; + *dst = '\0'; +} + +// /proc/self/fd/N, /proc/thread-self/fd/N and /proc/PID/fd/N: the real path of an open file. A program +// that finds a path this way (Bun and Zig programs do: their realpath() is an open and a readlink of +// this) goes on with system calls of its own, which the hook does not see, so a path inside the rootfs +// has to keep its real beginning there: "/home" for $DDNATV_ROOT/home is a path that does not exist +// for them ("ENOENT, realpath '/home'" in Kilo). It is what getcwd() answers, too. +static int is_proc_fd_link(const char *path) { + if (!path || strncmp(path, "/proc/", 6) != 0) return 0; + const char *p = path + 6; + if (strncmp(p, "self/", 5) == 0) { + p += 5; + } else if (strncmp(p, "thread-self/", 12) == 0) { + p += 12; + } else { + if (*p < '0' || *p > '9') return 0; + while (*p >= '0' && *p <= '9') p++; + if (*p != '/') return 0; + p++; + } + // fd/N and nothing after it: a path beneath the link goes through it to somewhere else + if (strncmp(p, "fd/", 3) != 0) return 0; + p += 3; + if (*p < '0' || *p > '9') return 0; + while (*p >= '0' && *p <= '9') p++; + return *p == '\0'; +} + +// The guest path of a folder that a session mount puts outside the rootfs, for what the kernel +// reports as its real place (getcwd(), /proc/self/cwd and fd links). Wine found no DOS drive for +// Sekiro's folder on the SD card library ("starting in the Windows directory"), and the game quit. +// Rewrites buf[0..len) in place when the guest path fits in cap; returns the new length. +static size_t guest_path_of_mount_source(char *buf, size_t len, size_t cap) { + const struct ddnatv_bind *best = NULL; + for (int i = 0; i < g_nbinds; i++) { + const struct ddnatv_bind *b = &g_binds[i]; + if (b->identity || get_rootfs_subpath(b->src) != NULL || len < b->src_len) continue; + if (memcmp(buf, b->src, b->src_len) != 0 || (len > b->src_len && buf[b->src_len] != '/')) continue; + if (!best || b->src_len > best->src_len || (b->src_len == best->src_len && b->order < best->order)) best = b; + } + if (!best) return len; + size_t rest = len - best->src_len; + if (best->dst_len + rest + 1 > cap) return len; + memmove(buf + best->dst_len, buf + best->src_len, rest); + memcpy(buf, best->dst, best->dst_len); + buf[best->dst_len + rest] = '\0'; + return best->dst_len + rest; +} + +static ssize_t postprocess_readlink(const char *linkpath, char *buf, ssize_t ret, size_t bufsiz) { + if (ret <= 0) return ret; + if ((size_t)ret < bufsiz) { + buf[ret] = '\0'; + ret = (ssize_t)link_root_guest_target(buf, (size_t)ret); + } + ret = (ssize_t)guest_path_of_mount_source(buf, (size_t)ret, bufsiz); + + // 1. Strip g_ddnatv_root if target starts with it + if (g_ddnatv_root_len > 0 && !is_proc_fd_link(linkpath)) { + size_t rlen = g_ddnatv_root_len; + if ((size_t)ret >= rlen && memcmp(buf, g_ddnatv_root, rlen) == 0 && + ((size_t)ret == rlen || buf[rlen] == '/')) { + size_t new_len = ret - rlen; + if (new_len == 0) { + buf[0] = '/'; + return 1; + } else { + memmove(buf, buf + rlen, new_len); + return (ssize_t)new_len; + } + } + } + + // 2. Normalize relative alternatives links. The result can only start with /etc/alternatives + // (or the link be in it) when "alternatives" is in the target or in the link's own path: the + // normalized path is made of their components. Most relative links have neither (the ones of + // /usr/lib and /usr/share/doc), and these skip the copies and the normalization, which were a + // tenth of what "cp -a" of a tree of them cost. + if (linkpath && linkpath[0] == '/' && (size_t)ret < PATH_MAX && ret >= 2 && buf[0] == '.' && buf[1] == '.' && + (memmem(buf, (size_t)ret, "alternatives", 12) != NULL || strstr(linkpath, "alternatives") != NULL)) { + char link_copy[PATH_MAX]; + memcpy(link_copy, buf, ret); + link_copy[ret] = '\0'; + + if (strncmp(link_copy, "..", 2) == 0) { + char parent[PATH_MAX]; + snprintf(parent, sizeof(parent), "%s", linkpath); + char *last_slash = strrchr(parent, '/'); + if (last_slash) { + if (last_slash == parent) { + *(last_slash + 1) = '\0'; + } else { + *last_slash = '\0'; + } + } + char combined[PATH_MAX * 2]; + snprintf(combined, sizeof(combined), "%s/%s", parent, link_copy); + normalize_path(combined); + + if (strncmp(combined, "/etc/alternatives", 17) == 0 || + strncmp(linkpath, "/etc/alternatives", 17) == 0) { + size_t clen = strlen(combined); + if (clen <= bufsiz) { + memcpy(buf, combined, clen); + return (ssize_t)clen; + } + } + } + } + + return ret; +} + +// Android's SELinux label, which the xattr hooks keep away from Ubuntu programs. +static const char k_selinux_xattr[] = "security.selinux"; + +static int is_selinux_xattr(const char *name) { + return name != NULL && strcmp(name, k_selinux_xattr) == 0; +} + +// Removes "security.selinux" from a listxattr() result (NUL-separated names); returns the new length. +static ssize_t drop_selinux_xattr(char *list, ssize_t len) { + if (!list || len <= 0) return len; + ssize_t out = 0; + ssize_t i = 0; + while (i < len) { + size_t name_len = strnlen(list + i, (size_t)(len - i)); + ssize_t entry = (ssize_t)name_len + 1; + if (entry > len - i) entry = len - i; + if (name_len != sizeof(k_selinux_xattr) - 1 || memcmp(list + i, k_selinux_xattr, name_len) != 0) { + memmove(list + out, list + i, (size_t)entry); + out += entry; + } + i += entry; + } + return out; +} + +// Library directories of the rootfs, in the order ld.so searches them. ld.so tries every +// directory for every library, so the multiarch ones that hold nearly all libraries come first +// (as in glibc's own default order). Keep in sync with Environment.kt, 00-env.sh and su.sh. +static const char *const k_rootfs_lib_dirs[] = { + "/lib/aarch64-linux-gnu", "/usr/lib/aarch64-linux-gnu", + "/lib/arm-linux-gnueabihf", "/usr/lib/arm-linux-gnueabihf", + "/lib", "/usr/lib", "/usr/local/lib", + "/usr/lib/systemd", "/lib/systemd", + "/usr/lib/aarch64-linux-gnu/systemd", "/lib/aarch64-linux-gnu/systemd", + "/usr/lib/arm-linux-gnueabihf/systemd", "/lib/arm-linux-gnueabihf/systemd", +}; + +// Whether the ':'-separated list holds the directory dir[0..dir_len) as one of its entries. +static int lib_dir_list_has(const char *list, const char *dir, size_t dir_len) { + if (!list) return 0; + for (const char *p = list; *p;) { + const char *end = strchr(p, ':'); + size_t len = end ? (size_t)(end - p) : strlen(p); + if (len == dir_len && memcmp(p, dir, len) == 0) return 1; + if (!end) break; + p = end + 1; + } + return 0; +} + +// Appends the rootfs library directories as a ':'-separated list (with a leading ':' when +// `separate` is set), leaving out those that `have` (a list too, or NULL) names already: the +// caller's LD_LIBRARY_PATH is usually this very list, and ld.so spends time on every directory of +// the list it is given, in every program that is started, and tries it again for each library that +// is not found. Returns the new length. +static size_t append_rootfs_lib_dirs_missing_from(char *out, size_t outsz, size_t used, int separate, const char *have) { + for (size_t i = 0; i < sizeof(k_rootfs_lib_dirs) / sizeof(k_rootfs_lib_dirs[0]); i++) { + // a Flatpak sandbox mounts /usr from its runtime + char buf[PATH_MAX]; + const char *full = rewrite_path_in_root(k_rootfs_lib_dirs[i], buf, sizeof(buf)); + size_t n = strlen(full); + if (have && have[0] != '\0' && lib_dir_list_has(have, full, n)) continue; + // whole directories only: a cut-off one would be searched in the wrong place + if (used + (separate ? 1 : 0) + n >= outsz) continue; + if (separate) used = ddnatv_append(out, outsz, used, ":", 1); + separate = 1; + used = ddnatv_append(out, outsz, used, full, n); + } + return used; +} + +// All of them. +static size_t append_rootfs_lib_dirs(char *out, size_t outsz, size_t used, int separate) { + return append_rootfs_lib_dirs_missing_from(out, outsz, used, separate, NULL); +} + +#ifndef DDNATV_HOST_TEST +// Relative *at() calls. A program that walks a path one component at a time (systemd's chase(), used +// by libudev; fts) opens "/" and then "sys", "class", ... relative to the last descriptor, and those +// names never pass through rewrite_path(): "/" is the rootfs, whose own sys/ is empty, so the stand-ins +// mounted at /sys/class/hidraw and the host's /sys were out of reach. The directories on the way to a +// mount (every proper ancestor of a mount's guest path) are recorded by device and inode; a name given +// relative to one of them is joined to its guest path and mapped like an absolute one. +struct ddnatv_at_dir { + unsigned long dev, ino; + char *guest; +}; +static struct ddnatv_at_dir *g_at_dirs = NULL; +static int g_n_at_dirs = 0; +static pthread_once_t g_at_once = PTHREAD_ONCE_INIT; + +#if defined(__aarch64__) +static long raw_fstatat(int dirfd, const char *path, struct stat *st, int flags) { + register long x8 __asm__("x8") = 79; // newfstatat + register long x0 __asm__("x0") = dirfd; + register long x1 __asm__("x1") = (long)path; + register long x2 __asm__("x2") = (long)st; + register long x3 __asm__("x3") = flags; + __asm__ volatile("svc #0" : "+r"(x0) : "r"(x8), "r"(x1), "r"(x2), "r"(x3) : "memory"); + return x0; +} +#endif + +static void ddnatv_add_at_dir(const char *guest) { +#if defined(__aarch64__) + for (int i = 0; i < g_n_at_dirs; i++) if (strcmp(g_at_dirs[i].guest, guest) == 0) return; + char buf[PATH_MAX]; + const char *host = rewrite_path_in_root(guest, buf, sizeof(buf)); + struct stat st; + if (raw_fstatat(AT_FDCWD, host, &st, 0) != 0 || !S_ISDIR(st.st_mode)) return; + struct ddnatv_at_dir *grown = realloc(g_at_dirs, sizeof(*grown) * (size_t)(g_n_at_dirs + 1)); + if (!grown) return; + g_at_dirs = grown; + g_at_dirs[g_n_at_dirs].dev = (unsigned long)st.st_dev; + g_at_dirs[g_n_at_dirs].ino = (unsigned long)st.st_ino; + g_at_dirs[g_n_at_dirs].guest = strdup(guest); + if (g_at_dirs[g_n_at_dirs].guest) g_n_at_dirs++; +#else + (void)guest; +#endif +} + +static void ddnatv_build_at_dirs(void) { + if (g_nbinds == 0) return; + ddnatv_add_at_dir("/"); + for (int i = 0; i < g_nbinds; i++) { + char guest[PATH_MAX]; + ddnatv_copy_cstr(guest, sizeof(guest), g_binds[i].dst); + for (char *slash = strrchr(guest, '/'); slash && slash > guest; slash = strrchr(guest, '/')) { + *slash = '\0'; + ddnatv_add_at_dir(guest); + } + } +} + +// The absolute host path for `rel` given relative to `dirfd`, or NULL when the call needs no change. +static const char *map_at(int dirfd, const char *rel, char *buf, size_t size) { +#if defined(__aarch64__) + if (dirfd == AT_FDCWD || !rel || rel[0] == '\0' || rel[0] == '/' || g_nbinds == 0) return NULL; + pthread_once(&g_at_once, ddnatv_build_at_dirs); + if (g_n_at_dirs == 0) return NULL; + struct stat st; + if (raw_fstatat(dirfd, "", &st, AT_EMPTY_PATH) != 0) return NULL; + for (int i = 0; i < g_n_at_dirs; i++) { + if (g_at_dirs[i].ino != (unsigned long)st.st_ino || g_at_dirs[i].dev != (unsigned long)st.st_dev) continue; + char guest[PATH_MAX]; + const char *base = g_at_dirs[i].guest; + size_t used = ddnatv_append(guest, sizeof(guest), 0, base, strlen(base)); + if (used > 1) used = ddnatv_append(guest, sizeof(guest), used, "/", 1); + ddnatv_append(guest, sizeof(guest), used, rel, strlen(rel)); + const char *mapped = rewrite_path_in_root(guest, buf, size); + if (mapped != buf) ddnatv_copy_cstr(buf, size, mapped); + return buf; + } +#else + (void)dirfd; (void)rel; (void)buf; (void)size; +#endif + return NULL; +} + +#define DDNATV_AT_REMAP_NAMED(dirfd, pathname, buf) \ + char buf[PATH_MAX]; \ + if (map_at((dirfd), (pathname), buf, sizeof(buf))) { \ + (dirfd) = AT_FDCWD; \ + (pathname) = buf; \ + } +#define DDNATV_AT_REMAP(dirfd, pathname) DDNATV_AT_REMAP_NAMED(dirfd, pathname, ddnatv_at_buf) +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/posix_shm.c b/tools/nativeguest/hook/posix_shm.c new file mode 100644 index 0000000000..afd8a6f655 --- /dev/null +++ b/tools/nativeguest/hook/posix_shm.c @@ -0,0 +1,174 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c. +// +// shm_open() and shm_unlink() of glibc open /dev/shm/NAME with a system call of their own, which +// the path hooks never see and Android has no /dev/shm for. They go through open() and unlink() +// here, which map /dev/shm. + +#ifndef DDNATV_HOST_TEST + +static int posix_shm_path(const char *name, char *path, size_t size) { + if (!name) { errno = EINVAL; return -1; } + while (*name == '/') name++; + size_t len = strlen(name); + if (len == 0 || len > NAME_MAX || strchr(name, '/') || strcmp(name, ".") == 0 || strcmp(name, "..") == 0) { + errno = len > NAME_MAX ? ENAMETOOLONG : EINVAL; + return -1; + } + if (snprintf(path, size, "/dev/shm/%s", name) >= (int)size) { errno = ENAMETOOLONG; return -1; } + return 0; +} + +int shm_open(const char *name, int oflag, mode_t mode) { + char path[PATH_MAX]; + if (posix_shm_path(name, path, sizeof(path)) < 0) return -1; + return open(path, (oflag & (O_ACCMODE | O_CREAT | O_EXCL | O_TRUNC)) | O_NOFOLLOW | O_CLOEXEC, mode); +} + +int shm_unlink(const char *name) { + char path[PATH_MAX]; + if (posix_shm_path(name, path, sizeof(path)) < 0) return -1; + return unlink(path); +} + +#endif /* !DDNATV_HOST_TEST */ + +#ifndef DDNATV_HOST_TEST +// glibc's posix_spawn child resets every signal handler to its default, the hook's SIGSYS handler +// included, before it runs the file actions, and "close everything from N" is close_range(), which +// Android's seccomp filter answers with SIGSYS: the child died of it (Python's subprocess with +// close_fds does this). It becomes one close per descriptor, added when the program is spawned so +// that descriptors opened in between and the ones earlier actions make are closed too; the targets +// of actions added after it stay open, as they would. A close of a descriptor that is not open is +// no error to glibc. +#define CLOSEFROM_SLOTS 64 +#define CLOSEFROM_KEEP 32 +static struct closefrom_entry { + posix_spawn_file_actions_t *actions; + int from; // -1: no close-from yet, only targets of actions seen + int highest; // the highest descriptor an action before close-from makes + int nkeep; + int keep[CLOSEFROM_KEEP]; + int closed_to; // the descriptors up to this one are closed by actions already added + int bad_source; // a dup2 after close-from duplicates a descriptor it closed: glibc's EBADF +} g_closefrom[CLOSEFROM_SLOTS]; +static pthread_mutex_t g_closefrom_lock = PTHREAD_MUTEX_INITIALIZER; + +static struct closefrom_entry *closefrom_entry(posix_spawn_file_actions_t *actions, int create) { + struct closefrom_entry *free_slot = NULL; + for (int i = 0; i < CLOSEFROM_SLOTS; i++) { + if (g_closefrom[i].actions == actions) return &g_closefrom[i]; + if (!g_closefrom[i].actions && !free_slot) free_slot = &g_closefrom[i]; + } + if (!create || !free_slot) return NULL; + memset(free_slot, 0, sizeof(*free_slot)); + free_slot->actions = actions; + free_slot->from = -1; + free_slot->highest = -1; + free_slot->closed_to = -1; + return free_slot; +} + +static void closefrom_note_target(posix_spawn_file_actions_t *actions, int fd) { + pthread_mutex_lock(&g_closefrom_lock); + struct closefrom_entry *e = closefrom_entry(actions, 1); + if (e) { + if (e->from < 0) { + if (fd > e->highest) e->highest = fd; + } else if (e->nkeep < CLOSEFROM_KEEP) { + e->keep[e->nkeep++] = fd; + } + } + pthread_mutex_unlock(&g_closefrom_lock); +} + +int posix_spawn_file_actions_addclosefrom_np(posix_spawn_file_actions_t *actions, int from) { + if (!actions || from < 0) return EINVAL; + pthread_mutex_lock(&g_closefrom_lock); + struct closefrom_entry *e = closefrom_entry(actions, 1); + if (e && (e->from < 0 || from < e->from)) e->from = from; + pthread_mutex_unlock(&g_closefrom_lock); + return e ? 0 : ENOMEM; +} + +int posix_spawn_file_actions_addopen(posix_spawn_file_actions_t *actions, int fd, const char *path, int oflag, mode_t mode) { + static int (*orig)(posix_spawn_file_actions_t *, int, const char *, int, mode_t) = NULL; + if (!orig) orig = (int (*)(posix_spawn_file_actions_t *, int, const char *, int, mode_t))dlsym(RTLD_NEXT, "posix_spawn_file_actions_addopen"); + int ret = orig ? orig(actions, fd, path, oflag, mode) : ENOSYS; + if (ret == 0) closefrom_note_target(actions, fd); + return ret; +} + +int posix_spawn_file_actions_adddup2(posix_spawn_file_actions_t *actions, int fd, int newfd) { + static int (*orig)(posix_spawn_file_actions_t *, int, int) = NULL; + if (!orig) orig = (int (*)(posix_spawn_file_actions_t *, int, int))dlsym(RTLD_NEXT, "posix_spawn_file_actions_adddup2"); + int ret = orig ? orig(actions, fd, newfd) : ENOSYS; + if (ret == 0) { + pthread_mutex_lock(&g_closefrom_lock); + struct closefrom_entry *e = closefrom_entry(actions, 0); + if (e && e->from >= 0 && fd >= e->from) { + int reopened = 0; + for (int k = 0; k < e->nkeep; k++) reopened |= e->keep[k] == fd; + if (!reopened) e->bad_source = 1; + } + pthread_mutex_unlock(&g_closefrom_lock); + closefrom_note_target(actions, newfd); + } + return ret; +} + +int posix_spawn_file_actions_init(posix_spawn_file_actions_t *actions) { + static int (*orig)(posix_spawn_file_actions_t *) = NULL; + if (!orig) orig = (int (*)(posix_spawn_file_actions_t *))dlsym(RTLD_NEXT, "posix_spawn_file_actions_init"); + pthread_mutex_lock(&g_closefrom_lock); + struct closefrom_entry *e = closefrom_entry(actions, 0); + if (e) e->actions = NULL; + pthread_mutex_unlock(&g_closefrom_lock); + return orig ? orig(actions) : ENOSYS; +} + +int posix_spawn_file_actions_destroy(posix_spawn_file_actions_t *actions) { + static int (*orig)(posix_spawn_file_actions_t *) = NULL; + if (!orig) orig = (int (*)(posix_spawn_file_actions_t *))dlsym(RTLD_NEXT, "posix_spawn_file_actions_destroy"); + pthread_mutex_lock(&g_closefrom_lock); + struct closefrom_entry *e = closefrom_entry(actions, 0); + if (e) e->actions = NULL; + pthread_mutex_unlock(&g_closefrom_lock); + return orig ? orig(actions) : ENOSYS; +} + +static int apply_closefrom(posix_spawn_file_actions_t *actions) { + pthread_mutex_lock(&g_closefrom_lock); + struct closefrom_entry *e = closefrom_entry(actions, 0); + if (!e || e->from < 0) { + pthread_mutex_unlock(&g_closefrom_lock); + return 0; + } + if (e->bad_source) { + pthread_mutex_unlock(&g_closefrom_lock); + return EBADF; + } + int highest = e->highest; + DIR *dir = opendir("/proc/self/fd"); + if (dir) { + int self = dirfd(dir); + struct dirent *entry; + while ((entry = readdir(dir)) != NULL) { + if (entry->d_name[0] < '0' || entry->d_name[0] > '9') continue; + int fd = atoi(entry->d_name); + if (fd != self && fd > highest) highest = fd; + } + closedir(dir); + } + int start = e->from > e->closed_to + 1 ? e->from : e->closed_to + 1; + for (int fd = start; fd <= highest; fd++) { + int kept = 0; + for (int k = 0; k < e->nkeep; k++) kept |= e->keep[k] == fd; + if (!kept && posix_spawn_file_actions_addclose(actions, fd) != 0) break; + e->closed_to = fd; + } + pthread_mutex_unlock(&g_closefrom_lock); + return 0; +} +#else +static int apply_closefrom(posix_spawn_file_actions_t *actions) { (void)actions; return 0; } +#endif diff --git a/tools/nativeguest/hook/privileged.c b/tools/nativeguest/hook/privileged.c new file mode 100644 index 0000000000..6b527ae4f3 --- /dev/null +++ b/tools/nativeguest/hook/privileged.c @@ -0,0 +1,815 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Calls an app may not make (chown, mknod, capabilities, prctl, landlock, seccomp, namespaces, +// close_range) and the generic syscall() entry point. + +// The ARM translator of x86 devices and emulators (ndk_translation, houdini) keeps memory files of +// its own open in the process (ndk_translation at descriptor 3) and needs them whenever it +// translates more code: a program that closes every descriptor it did not open (sshd at start, +// closefrom(3)) made it abort later ("CHECK failed" in mmap_posix.cc). Its memory files open when +// the hook starts survive close(), close_range() and closefrom(); phones that run ARM code +// themselves have none. +#define DDNATV_MAX_KEPT_FDS 4 +static int g_kept_fds[DDNATV_MAX_KEPT_FDS]; // ascending +static int g_kept_fd_count = 0; + +static int is_kept_fd(int fd) { + for (int i = 0; i < g_kept_fd_count; i++) { + if (g_kept_fds[i] == fd) return 1; + } + return 0; +} + +// Calls fn for each part of [first, last] that leaves out the descriptors in kept (ascending); +// the first nonzero answer of fn is returned, else 0. +static int for_each_range_without(unsigned int first, unsigned int last, const int *kept, int nkept, + int (*fn)(unsigned int, unsigned int, void *), void *arg) { + unsigned int from = first; + for (int i = 0; i < nkept && from <= last; i++) { + if (kept[i] < 0 || (unsigned int)kept[i] < from || (unsigned int)kept[i] > last) continue; + unsigned int k = (unsigned int)kept[i]; + if (k > from) { + int r = fn(from, k - 1, arg); + if (r != 0) return r; + } + if (k == last) return 0; + from = k + 1; + } + return from <= last ? fn(from, last, arg) : 0; +} + +#ifndef DDNATV_HOST_TEST + +// ndk_translation's file is "/memfd:child"; any memory file counts in a process whose executable is +// a translator's runner (houdini). ndk_translation shows a program its own path as /proc/self/exe, +// so the name is what tells there. +// +// This runs at the start of every program, so it costs three system calls on a phone that runs ARM +// code itself: the descriptors that are open (/proc/self/fd, read at once) are all that are asked +// about, where asking about each of the numbers from 3 to 63 was 61 readlink() calls in every +// process that was started. +// Set once this process knows that it has none (it looked, or was told by DDNATV_NT=0 in its +// environment, which prepare_ddnatv_env hands on to the programs it starts) +static int g_no_translator = 0; + +__attribute__((constructor(102))) static void find_translator_files(void) { + // The first program of a session looks; the ones it starts are told (a translator is there for + // all the programs of a machine or for none, and where it is not known they look as before) + const char *known = getenv("DDNATV_NT"); + if (known && known[0] == '0' && known[1] == '\0') { + g_no_translator = 1; + return; + } + ssize_t (*real_readlink)(const char *, char *, size_t) = (ssize_t (*)(const char *, char *, size_t))dlsym(RTLD_NEXT, "readlink"); + int (*real_open)(const char *, int, ...) = (int (*)(const char *, int, ...))dlsym(RTLD_NEXT, "open"); + int (*real_close)(int) = (int (*)(int))dlsym(RTLD_NEXT, "close"); + ssize_t (*real_getdents64)(int, void *, size_t) = (ssize_t (*)(int, void *, size_t))dlsym(RTLD_NEXT, "getdents64"); + if (!real_readlink || !real_open || !real_close) return; + int dir = real_getdents64 ? real_open("/proc/self/fd", O_RDONLY | O_DIRECTORY | O_CLOEXEC) : -1; + if (dir < 0) return; + // The numbers of the descriptors open now, those from 3 to 63 (the directory's own left out) + char entries[2048]; + unsigned char open_fds[64]; + int nopen = 0; + for (;;) { + long n = real_getdents64(dir, entries, sizeof(entries)); + if (n <= 0) break; + for (long off = 0; off < n;) { + // struct linux_dirent64: d_ino (8), d_off (8), d_reclen (2), d_type (1), then d_name + unsigned short reclen; + memcpy(&reclen, entries + off + 16, sizeof(reclen)); + const char *name = entries + off + 19; + off += reclen ? reclen : n; // a record without a length ends the buffer + if (name[0] < '0' || name[0] > '9') continue; // "." and ".." + int fd = atoi(name); + if (fd >= 3 && fd < 64 && fd != dir) open_fds[nopen++] = (unsigned char)fd; + } + // A short answer is the whole directory; asking again would only be told "no more" + if ((size_t)n + 64 <= sizeof(entries)) break; + } + real_close(dir); + if (nopen == 0) { + g_no_translator = 1; + return; + } + + char path[PATH_MAX]; + int runner = 0; + ssize_t n = real_readlink("/proc/self/exe", path, sizeof(path) - 1); + if (n > 0) { + path[n] = '\0'; + const char *base = strrchr(path, '/'); + base = base ? base + 1 : path; + runner = strncmp(base, "ndk_translation", 15) == 0 || strncmp(base, "houdini", 7) == 0; + } + // In ascending order, as the list is kept + for (int i = 0; i < nopen - 1; i++) { + for (int j = i + 1; j < nopen; j++) { + if (open_fds[j] < open_fds[i]) { + unsigned char t = open_fds[i]; + open_fds[i] = open_fds[j]; + open_fds[j] = t; + } + } + } + for (int i = 0; i < nopen && g_kept_fd_count < DDNATV_MAX_KEPT_FDS; i++) { + char link[32], target[64]; + snprintf(link, sizeof(link), "/proc/self/fd/%d", open_fds[i]); + ssize_t m = real_readlink(link, target, sizeof(target) - 1); + if (m <= 0) continue; + target[m] = '\0'; + if (strncmp(target, "/memfd:child", 12) == 0 || (runner && strncmp(target, "/memfd:", 7) == 0)) { + g_kept_fds[g_kept_fd_count++] = open_fds[i]; + } + } + if (g_kept_fd_count == 0) g_no_translator = 1; +} + +int chown(const char *pathname, uid_t owner, gid_t group) { (void)pathname; (void)owner; (void)group; return 0; } +int fchown(int fd, uid_t owner, gid_t group) { (void)fd; (void)owner; (void)group; return 0; } +int lchown(const char *pathname, uid_t owner, gid_t group) { (void)pathname; (void)owner; (void)group; return 0; } +int fchownat(int dirfd, const char *pathname, uid_t owner, gid_t group, int flags) { + DDNATV_AT_REMAP(dirfd, pathname); + (void)dirfd; (void)pathname; (void)owner; (void)group; (void)flags; return 0; +} +int chroot(const char *path) { (void)path; return 0; } + +// Hook mkfifo / mkfifoat / mknod / mknodat +int mkfifo(const char *pathname, mode_t mode); +int mkfifoat(int dirfd, const char *pathname, mode_t mode); + +int mknodat(int dirfd, const char *pathname, mode_t mode, dev_t dev) { + DDNATV_AT_REMAP(dirfd, pathname); + (void)dev; + if (!pathname) { + errno = EFAULT; + return -1; + } + char buf[PATH_MAX]; + const char *target = (pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + // A file type of 0 means a regular file, as in mknod(2), which also fails with EEXIST instead + // of touching an existing file. + if (S_ISREG(mode) || (mode & S_IFMT) == 0) { + // mknod(2) returns 0 on success, never a file descriptor: close the + // transient fd instead of leaking one per call (tar/dpkg extract + // thousands of files; leaked fds exhaust the table -> EBADF noise). + int fd = openat(dirfd, target, O_CREAT | O_EXCL | O_WRONLY | O_CLOEXEC, mode & 07777); + if (fd >= 0) { + close(fd); + return 0; + } + return -1; + } + if (S_ISFIFO(mode)) { + return mkfifoat(dirfd, target, mode); + } + return 0; +} + +int mknod(const char *pathname, mode_t mode, dev_t dev) { + return mknodat(AT_FDCWD, pathname, mode, dev); +} + +int mkfifoat(int dirfd, const char *pathname, mode_t mode) { + static int (*orig_mkfifoat)(int, const char *, mode_t) = NULL; + if (!orig_mkfifoat) orig_mkfifoat = (int (*)(int, const char *, mode_t))dlsym(RTLD_NEXT, "mkfifoat"); + if (!pathname) { + errno = EFAULT; + return -1; + } + char buf[PATH_MAX]; + const char *target = (pathname[0] == '/') ? rewrite_path(pathname, buf, sizeof(buf)) : pathname; + if (orig_mkfifoat) { + return orig_mkfifoat(dirfd, target, mode); + } + static int (*orig_mkfifo)(const char *, mode_t) = NULL; + if (!orig_mkfifo) orig_mkfifo = (int (*)(const char *, mode_t))dlsym(RTLD_NEXT, "mkfifo"); + if (orig_mkfifo && dirfd == AT_FDCWD) { + return orig_mkfifo(target, mode); + } + return -1; +} + +int mkfifo(const char *pathname, mode_t mode) { + return mkfifoat(AT_FDCWD, pathname, mode); +} + +// Hook sync / syncfs to prevent Android flash storage stalls during dpkg operations +void sync(void) { + // No-op +} + +int syncfs(int fd) { + (void)fd; + return 0; +} + +int capget(void *hdrp, void *datap) { + static int (*orig_capget)(void *, void *) = NULL; + if (!orig_capget) orig_capget = (int (*)(void *, void *))dlsym(RTLD_NEXT, "capget"); + if (orig_capget && orig_capget(hdrp, datap) == 0) { + return 0; + } + if (datap) { + uint32_t ver = hdrp ? *(const uint32_t *)hdrp : 0; + size_t nbytes = (ver == 0x20071026U || ver == 0x20080522U) ? 24 : 12; + memset(datap, 0, nbytes); + } + errno = 0; + return 0; +} +int capset(void *hdrp, const void *datap) { (void)hdrp; (void)datap; return 0; } + +int prctl(int option, ...) { + va_list ap; + va_start(ap, option); + unsigned long arg2 = va_arg(ap, unsigned long); + unsigned long arg3 = va_arg(ap, unsigned long); + unsigned long arg4 = va_arg(ap, unsigned long); + unsigned long arg5 = va_arg(ap, unsigned long); + va_end(ap); + + // PR_SET_NO_NEW_PRIVS = 38, PR_GET_NO_NEW_PRIVS = 39 +#ifdef PR_SET_NO_NEW_PRIVS + if (option == PR_SET_NO_NEW_PRIVS) return 0; +#endif + if (option == 38) return 0; +#ifdef PR_GET_NO_NEW_PRIVS + if (option == PR_GET_NO_NEW_PRIVS) return 1; +#endif + if (option == 39) return 1; + + // PR_SET_SECCOMP = 22, PR_GET_SECCOMP = 21 +#ifdef PR_SET_SECCOMP + if (option == PR_SET_SECCOMP) { errno = EINVAL; return -1; } +#endif + if (option == 22) { errno = EINVAL; return -1; } +#ifdef PR_GET_SECCOMP + if (option == PR_GET_SECCOMP) return 0; +#endif + if (option == 21) return 0; + + // PR_SET_SPECULATION_CTRL = 47 + if (option == 47) return 0; + + static int (*orig_prctl)(int, unsigned long, unsigned long, unsigned long, unsigned long) = NULL; + if (!orig_prctl) orig_prctl = (int (*)(int, unsigned long, unsigned long, unsigned long, unsigned long))dlsym(RTLD_NEXT, "prctl"); + return orig_prctl ? orig_prctl(option, arg2, arg3, arg4, arg5) : 0; +} + +// Limits that leave a process no new descriptors (RLIMIT_NOFILE below 16) or no file writes +// (RLIMIT_FSIZE 0) are not applied. Sandboxes give them to their unprivileged part (sshd's before +// login sets 1 and 0, with the seccomp filter above), and Android's ARM translator (emulators, x86 +// devices) needs new descriptors and memory files in the process: sshd's died in it ("CHECK failed" +// in its mmap) and the client's connection was reset. Other limits are set as asked. +static int sandbox_only_limit(int resource, const struct rlimit *rlim) { + if (!rlim) return 0; + if (resource == RLIMIT_NOFILE) return rlim->rlim_cur < 16; + if (resource == RLIMIT_FSIZE) return rlim->rlim_cur == 0; + return 0; +} + +int setrlimit(__rlimit_resource_t resource, const struct rlimit *rlim) { + if (sandbox_only_limit((int)resource, rlim)) return 0; + static int (*orig_setrlimit)(__rlimit_resource_t, const struct rlimit *) = NULL; +#if defined(__USE_FILE_OFFSET64) && !defined(__LP64__) + // With 64-bit file offsets on a 32-bit system this function is setrlimit64 + if (!orig_setrlimit) orig_setrlimit = (int (*)(__rlimit_resource_t, const struct rlimit *))dlsym(RTLD_NEXT, "setrlimit64"); +#else + if (!orig_setrlimit) orig_setrlimit = (int (*)(__rlimit_resource_t, const struct rlimit *))dlsym(RTLD_NEXT, "setrlimit"); +#endif + if (!orig_setrlimit) { + errno = ENOSYS; + return -1; + } + return orig_setrlimit(resource, rlim); +} +#if defined(__LP64__) +__asm__(".globl setrlimit64\n" ".set setrlimit64, setrlimit\n"); +#endif + +#ifndef LANDLOCK_CREATE_RULESET_VERSION +#define LANDLOCK_CREATE_RULESET_VERSION (1U << 0) +#endif + +#ifndef __NR_landlock_create_ruleset +#define __NR_landlock_create_ruleset 444 +#endif +#ifndef __NR_landlock_add_rule +#define __NR_landlock_add_rule 445 +#endif +#ifndef __NR_landlock_restrict_self +#define __NR_landlock_restrict_self 446 +#endif + +#ifndef __NR_seccomp +#if defined(__aarch64__) +#define __NR_seccomp 277 +#elif defined(__x86_64__) +#define __NR_seccomp 317 +#elif defined(__arm__) +#define __NR_seccomp 383 +#else +#define __NR_seccomp 277 +#endif +#endif + +#ifndef __NR_unshare +#if defined(__aarch64__) +#define __NR_unshare 97 +#elif defined(__x86_64__) +#define __NR_unshare 272 +#elif defined(__arm__) +#define __NR_unshare 337 +#else +#define __NR_unshare 97 +#endif +#endif + +#ifndef __NR_setns +#if defined(__aarch64__) +#define __NR_setns 268 +#elif defined(__x86_64__) +#define __NR_setns 308 +#elif defined(__arm__) +#define __NR_setns 375 +#else +#define __NR_setns 268 +#endif +#endif + +#ifndef __NR_clone3 +#define __NR_clone3 435 +#endif +#ifndef __NR_pidfd_open +#define __NR_pidfd_open 434 +#endif +#ifndef __NR_pidfd_send_signal +#define __NR_pidfd_send_signal 424 +#endif +#ifndef __NR_pidfd_getfd +#define __NR_pidfd_getfd 438 +#endif +#ifndef __NR_close_range +#define __NR_close_range 436 +#endif +#ifndef __NR_faccessat +#if defined(__aarch64__) +#define __NR_faccessat 48 +#elif defined(__arm__) +#define __NR_faccessat 334 +#elif defined(__x86_64__) +#define __NR_faccessat 269 +#endif +#endif +#ifndef __NR_faccessat2 +#define __NR_faccessat2 439 +#endif +#ifndef __NR_statx +#if defined(__aarch64__) || defined(__arm__) +#define __NR_statx 291 +#elif defined(__x86_64__) +#define __NR_statx 332 +#endif +#endif + +#ifndef SECCOMP_SET_MODE_STRICT +#define SECCOMP_SET_MODE_STRICT 0 +#endif +#ifndef SECCOMP_SET_MODE_FILTER +#define SECCOMP_SET_MODE_FILTER 1 +#endif +#ifndef SECCOMP_GET_ACTION_AVAIL +#define SECCOMP_GET_ACTION_AVAIL 2 +#endif + +int landlock_create_ruleset(const void *attr, size_t size, uint32_t flags) { + (void)attr; + (void)size; + (void)flags; + errno = ENOSYS; + return -1; +} + +int landlock_add_rule(int ruleset_fd, int rule_type, const void *rule_attr, uint32_t flags) { + (void)ruleset_fd; + (void)rule_type; + (void)rule_attr; + (void)flags; + errno = ENOSYS; + return -1; +} + +int landlock_restrict_self(int ruleset_fd, uint32_t flags) { + (void)ruleset_fd; + (void)flags; + errno = ENOSYS; + return -1; +} + +int seccomp(unsigned int operation, unsigned int flags, void *args) { + (void)flags; + (void)args; + if (operation != SECCOMP_SET_MODE_STRICT && + operation != SECCOMP_SET_MODE_FILTER && + operation != SECCOMP_GET_ACTION_AVAIL && + operation != 3 /* SECCOMP_GET_NOTIF_SIZES */) { + errno = EINVAL; + return -1; + } + errno = ENOSYS; + return -1; +} + +int unshare(int flags) { + (void)flags; + errno = ENOSYS; + return -1; +} + +int setns(int fd, int nstype) { + (void)fd; + (void)nstype; + errno = ENOSYS; + return -1; +} + +#ifndef CLOSE_RANGE_CLOEXEC +#define CLOSE_RANGE_CLOEXEC (1U << 2) +#endif + +static int close_range_all(unsigned int first, unsigned int last, int flags); + +static int close_range_part(unsigned int first, unsigned int last, void *flags) { + return close_range_all(first, last, *(int *)flags); +} + +int close_range(unsigned int first, unsigned int last, int flags) { + // Close-on-exec only (CLOSE_RANGE_CLOEXEC) leaves the translator's files open + if (g_kept_fd_count > 0 && !(flags & CLOSE_RANGE_CLOEXEC)) { + return for_each_range_without(first, last, g_kept_fds, g_kept_fd_count, close_range_part, &flags); + } + return close_range_all(first, last, flags); +} + +// glibc's closefrom() makes the close_range system call itself, past the function above +void closefrom(int lowfd) { + close_range(lowfd < 0 ? 0U : (unsigned int)lowfd, ~0U, 0); +} + +static int close_range_all(unsigned int first, unsigned int last, int flags) { + static int (*orig_close_range)(unsigned int, unsigned int, int) = NULL; + if (!orig_close_range) { + orig_close_range = (int (*)(unsigned int, unsigned int, int))dlsym(RTLD_NEXT, "close_range"); + } +#ifdef __NR_close_range + static long (*orig_raw_syscall)(long, ...) = NULL; + if (!orig_raw_syscall) orig_raw_syscall = (long (*)(long, ...))dlsym(RTLD_NEXT, "syscall"); + if (orig_raw_syscall) { + long sret = orig_raw_syscall(__NR_close_range, first, last, flags); + if (sret == 0) return 0; + if (sret < 0 && errno != ENOSYS) return -1; + } +#endif + if (orig_close_range) { + int cret = orig_close_range(first, last, flags); + if (cret == 0) return 0; + if (cret < 0 && errno != ENOSYS) return -1; + } + + int set_cloexec = (flags & CLOSE_RANGE_CLOEXEC) != 0; + + DIR *d = opendir("/proc/self/fd"); + if (d) { + int dfd = dirfd(d); + struct dirent *de; + while ((de = readdir(d)) != NULL) { + if (de->d_name[0] == '.') continue; + int fd = atoi(de->d_name); + if (fd >= (int)first && (last == ~0U || (unsigned int)fd <= last) && fd != dfd) { + if (set_cloexec) { + int fl = fcntl(fd, F_GETFD); + if (fl >= 0) { + fcntl(fd, F_SETFD, fl | FD_CLOEXEC); + } + } else { + close(fd); + } + } + } + closedir(d); + return 0; + } + int max_fd = (int)sysconf(_SC_OPEN_MAX); + if (max_fd <= 0 || max_fd > 1024) max_fd = 1024; + int end = (last < (unsigned int)max_fd) ? (int)last : max_fd; + for (int fd = (int)first; fd <= end; fd++) { + if (set_cloexec) { + int fl = fcntl(fd, F_GETFD); + if (fl >= 0) { + fcntl(fd, F_SETFD, fl | FD_CLOEXEC); + } + } else { + close(fd); + } + } + return 0; +} + +static __thread int t_syscall_redirect = 0; + +long syscall(long number, ...) { + va_list ap; + va_start(ap, number); + unsigned long arg1 = va_arg(ap, unsigned long); + unsigned long arg2 = va_arg(ap, unsigned long); + unsigned long arg3 = va_arg(ap, unsigned long); + unsigned long arg4 = va_arg(ap, unsigned long); + unsigned long arg5 = va_arg(ap, unsigned long); + unsigned long arg6 = va_arg(ap, unsigned long); + va_end(ap); + +#if defined(__NR_readlinkat) + if (number == __NR_readlinkat) { + return (long)readlinkat((int)arg1, (const char *)arg2, (char *)arg3, (size_t)arg4); + } +#endif +#if defined(__NR_readlink) + if (number == __NR_readlink) { + return (long)readlink((const char *)arg1, (char *)arg2, (size_t)arg3); + } +#endif +#if defined(__NR_linkat) + if (number == __NR_linkat) { + return (long)linkat((int)arg1, (const char *)arg2, (int)arg3, (const char *)arg4, (int)arg5); + } +#endif +#if defined(__NR_link) + if (number == __NR_link) { + return (long)link((const char *)arg1, (const char *)arg2); + } +#endif + +#ifdef __NR_landlock_create_ruleset + if (number == __NR_landlock_create_ruleset) { + return (long)landlock_create_ruleset((const void *)arg1, (size_t)arg2, (uint32_t)arg3); + } + if (number == __NR_landlock_add_rule) { + return (long)landlock_add_rule((int)arg1, (int)arg2, (const void *)arg3, (uint32_t)arg4); + } + if (number == __NR_landlock_restrict_self) { + return (long)landlock_restrict_self((int)arg1, (uint32_t)arg2); + } +#endif + +#ifdef __NR_seccomp + if (number == __NR_seccomp) { + return (long)seccomp((unsigned int)arg1, (unsigned int)arg2, (void *)arg3); + } +#endif + +#ifdef __NR_unshare + if (number == __NR_unshare) { + return (long)unshare((int)arg1); + } +#endif + +#ifdef __NR_setns + if (number == __NR_setns) { + return (long)setns((int)arg1, (int)arg2); + } +#endif + +#ifdef __NR_clone3 + if (number == __NR_clone3) { + errno = ENOSYS; + return -1; + } +#endif + +#ifdef __NR_pidfd_open + if (number == __NR_pidfd_open) { + errno = ENOSYS; + return -1; + } +#endif +#ifdef __NR_pidfd_send_signal + if (number == __NR_pidfd_send_signal) { + errno = ENOSYS; + return -1; + } +#endif +#ifdef __NR_pidfd_getfd + if (number == __NR_pidfd_getfd) { + errno = ENOSYS; + return -1; + } +#endif + +#ifdef __NR_close_range + if (number == __NR_close_range) { + // libblsession's close_range() calls syscall() again: the nested call goes straight to the kernel + if (t_syscall_redirect) return call_orig_syscall(number, arg1, arg2, arg3, 0, 0, 0); + t_syscall_redirect++; + long ret = (long)close_range((unsigned int)arg1, (unsigned int)arg2, (int)arg3); + t_syscall_redirect--; + return ret; + } +#endif + +#ifdef __NR_openat2 + if (number == __NR_openat2) { + // libblsession's openat2() calls syscall() again (an endless loop until the stack ran out): the nested + // call maps the path and goes straight to the kernel + if (t_syscall_redirect) { + char nested_buf[PATH_MAX]; + const char *path = (const char *)arg2; + if (path && path[0] == '/') path = rewrite_path(path, nested_buf, sizeof(nested_buf)); + return call_orig_syscall(number, arg1, (unsigned long)path, arg3, arg4, 0, 0); + } + t_syscall_redirect++; + long ret = (long)openat2((int)arg1, (const char *)arg2, (struct ddnatv_open_how *)arg3, (size_t)arg4); + t_syscall_redirect--; + return ret; + } +#endif + +#ifdef __NR_fchmodat2 + if (number == __NR_fchmodat2) { + return (long)fchmodat2((int)arg1, (const char *)arg2, (mode_t)arg3, (int)arg4); + } +#endif + +#if defined(__NR_statx) + if (number == __NR_statx) { + return (long)statx((int)arg1, (const char *)arg2, (int)arg3, (unsigned int)arg4, (struct statx *)arg5); + } +#endif + +#if defined(__NR_faccessat) + if (number == __NR_faccessat) { + if (t_syscall_redirect) { + char nested_buf[PATH_MAX]; + const char *path = (const char *)arg2; + if (path && path[0] == '/') path = rewrite_path(path, nested_buf, sizeof(nested_buf)); + return call_orig_syscall(number, arg1, (unsigned long)path, arg3, 0, 0, 0); + } + t_syscall_redirect++; + long ret = (long)faccessat((int)arg1, (const char *)arg2, (int)arg3, 0); + t_syscall_redirect--; + return ret; + } +#endif + +#if defined(__NR_faccessat2) + if (number == __NR_faccessat2) { + return (long)faccessat2((int)arg1, (const char *)arg2, (int)arg3, (int)arg4); + } +#endif + +#if defined(__NR_mknodat) + if (number == __NR_mknodat) { + return (long)mknodat((int)arg1, (const char *)arg2, (mode_t)arg3, (dev_t)arg4); + } +#endif + +#if defined(__NR_mknod) + if (number == __NR_mknod) { + return (long)mknod((const char *)arg1, (mode_t)arg2, (dev_t)arg3); + } +#endif + +#if defined(__NR_mkfifoat) + if (number == __NR_mkfifoat) { + return (long)mkfifoat((int)arg1, (const char *)arg2, (mode_t)arg3); + } +#endif + +#if defined(__NR_setresuid) + if (number == __NR_setresuid) return 0; +#endif +#if defined(__NR_setresuid32) + if (number == __NR_setresuid32) return 0; +#endif +#if defined(__NR_setresgid) + if (number == __NR_setresgid) return 0; +#endif +#if defined(__NR_setresgid32) + if (number == __NR_setresgid32) return 0; +#endif +#if defined(__NR_setuid) + if (number == __NR_setuid) return 0; +#endif +#if defined(__NR_setuid32) + if (number == __NR_setuid32) return 0; +#endif +#if defined(__NR_setgid) + if (number == __NR_setgid) return 0; +#endif +#if defined(__NR_setgid32) + if (number == __NR_setgid32) return 0; +#endif +#if defined(__NR_setreuid) + if (number == __NR_setreuid) return 0; +#endif +#if defined(__NR_setreuid32) + if (number == __NR_setreuid32) return 0; +#endif +#if defined(__NR_setregid) + if (number == __NR_setregid) return 0; +#endif +#if defined(__NR_setregid32) + if (number == __NR_setregid32) return 0; +#endif +#if defined(__NR_setgroups) + if (number == __NR_setgroups) return 0; +#endif +#if defined(__NR_setgroups32) + if (number == __NR_setgroups32) return 0; +#endif +#if defined(__NR_setfsuid) + if (number == __NR_setfsuid) return 0; +#endif +#if defined(__NR_setfsuid32) + if (number == __NR_setfsuid32) return 0; +#endif +#if defined(__NR_setfsgid) + if (number == __NR_setfsgid) return 0; +#endif +#if defined(__NR_setfsgid32) + if (number == __NR_setfsgid32) return 0; +#endif +#if defined(__NR_getuid) + if (number == __NR_getuid) return 0; +#endif +#if defined(__NR_getuid32) + if (number == __NR_getuid32) return 0; +#endif +#if defined(__NR_geteuid) + if (number == __NR_geteuid) return 0; +#endif +#if defined(__NR_geteuid32) + if (number == __NR_geteuid32) return 0; +#endif +#if defined(__NR_getgid) + if (number == __NR_getgid) return 0; +#endif +#if defined(__NR_getgid32) + if (number == __NR_getgid32) return 0; +#endif +#if defined(__NR_getegid) + if (number == __NR_getegid) return 0; +#endif +#if defined(__NR_getegid32) + if (number == __NR_getegid32) return 0; +#endif +#if defined(__NR_getresuid) + if (number == __NR_getresuid) { + uid_t *ruid = (uid_t *)arg1; + uid_t *euid = (uid_t *)arg2; + uid_t *suid = (uid_t *)arg3; + if (ruid) *ruid = 0; + if (euid) *euid = 0; + if (suid) *suid = 0; + return 0; + } +#endif +#if defined(__NR_getresuid32) + if (number == __NR_getresuid32) { + uid_t *ruid = (uid_t *)arg1; + uid_t *euid = (uid_t *)arg2; + uid_t *suid = (uid_t *)arg3; + if (ruid) *ruid = 0; + if (euid) *euid = 0; + if (suid) *suid = 0; + return 0; + } +#endif +#if defined(__NR_getresgid) + if (number == __NR_getresgid) { + gid_t *rgid = (gid_t *)arg1; + gid_t *egid = (gid_t *)arg2; + gid_t *sgid = (gid_t *)arg3; + if (rgid) *rgid = 0; + if (egid) *egid = 0; + if (sgid) *sgid = 0; + return 0; + } +#endif +#if defined(__NR_getresgid32) + if (number == __NR_getresgid32) { + gid_t *rgid = (gid_t *)arg1; + gid_t *egid = (gid_t *)arg2; + gid_t *sgid = (gid_t *)arg3; + if (rgid) *rgid = 0; + if (egid) *egid = 0; + if (sgid) *sgid = 0; + return 0; + } +#endif + + return call_orig_syscall(number, arg1, arg2, arg3, arg4, arg5, arg6); +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/setup.c b/tools/nativeguest/hook/setup.c new file mode 100644 index 0000000000..90c5d87afe --- /dev/null +++ b/tools/nativeguest/hook/setup.c @@ -0,0 +1,384 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Start-up (DDNATV_ROOT, certificate and time zone defaults), /proc/self/exe, rewrite_path() and +// the short names of Unix sockets. + +#ifndef DDNATV_HOST_TEST + +static char g_real_exe[PATH_MAX] = {0}; +// DDNATV_PRELOAD: guest paths of libraries every program loads before the hook (what +// /etc/ld.so.preload does for programs run by the rootfs's own ld.so), and the same as host paths. +static char *g_preload_guest = NULL; +static char *g_preload_host = NULL; +static int g_initialized = 0; + +static void init_ddnatv_hook(void) { + if (g_initialized) return; + const char *root = getenv("DDNATV_ROOT"); + if (root && strlen(root) > 0) { + size_t len = strlen(root); + if (len > sizeof(g_ddnatv_root) - 1) len = sizeof(g_ddnatv_root) - 1; + if (root[len - 1] == '/') len--; + ddnatv_set_root(root, len); + } else { + Dl_info info; + if (dladdr((void *)init_ddnatv_hook, &info) && info.dli_fname) { + const char *p = strstr(info.dli_fname, "/usr/lib/libddnatv-hook"); + if (p && p > info.dli_fname) { + size_t len = p - info.dli_fname; + if (len < sizeof(g_ddnatv_root)) { + ddnatv_set_root(info.dli_fname, len); + } + } + } + } + ddnatv_load_binds(getenv("DDNATV_BINDS")); + const char *hostname = getenv("DDNATV_HOSTNAME"); + if (hostname && hostname[0] && strlen(hostname) < sizeof(g_hostname)) ddnatv_copy_cstr(g_hostname, sizeof(g_hostname), hostname); + const char *link_root = getenv("DDNATV_LINK_ROOT"); + if (link_root && link_root[0] == '/' && strlen(link_root) < sizeof(g_link_root)) { + ddnatv_copy_cstr(g_link_root, sizeof(g_link_root), link_root); + g_link_root_len = strlen(g_link_root); + while (g_link_root_len > 1 && g_link_root[g_link_root_len - 1] == '/') g_link_root[--g_link_root_len] = 0; + } + const char *preload = getenv("DDNATV_PRELOAD"); + if (preload && preload[0] && g_ddnatv_root_len > 0) { + size_t libs = 1; + for (const char *p = preload; *p; p++) libs += *p == ':'; + size_t cap = libs * (PATH_MAX + 1); + char *host = malloc(cap); + if (host) { + size_t used = 0; + host[0] = '\0'; + char *copy = strdup(preload); + char *save = NULL; + for (char *lib = copy ? strtok_r(copy, ":", &save) : NULL; lib; lib = strtok_r(NULL, ":", &save)) { + if (lib[0] != '/') continue; + char mapped_buf[PATH_MAX]; + const char *mapped = rewrite_path_in_root(lib, mapped_buf, sizeof(mapped_buf)); + size_t mapped_len = strlen(mapped); + if (used + mapped_len + 2 > cap) break; + if (used) host[used++] = ':'; + used = ddnatv_append(host, cap, used, mapped, mapped_len); + } + free(copy); + g_preload_host = host; + g_preload_guest = strdup(preload); + } + } + const char *curr_real_exe = getenv("DDNATV_REAL_EXE"); + if (curr_real_exe && curr_real_exe[0] != '\0') { + ddnatv_copy_cstr(g_real_exe, sizeof(g_real_exe), curr_real_exe); + } + if (g_ddnatv_root[0] != '\0') { + const char *curr_tzdir = getenv("TZDIR"); + if (!curr_tzdir || curr_tzdir[0] == '\0') { + char tzdir_buf[PATH_MAX]; + snprintf(tzdir_buf, sizeof(tzdir_buf), "%s/usr/share/zoneinfo", g_ddnatv_root); + setenv("TZDIR", tzdir_buf, 0); + } + + const char *curr_cert = getenv("SSL_CERT_FILE"); + if (!curr_cert || curr_cert[0] == '\0' || strcmp(curr_cert, "/etc/ssl/certs/ca-certificates.crt") == 0) { + char cert_buf[PATH_MAX]; + snprintf(cert_buf, sizeof(cert_buf), "%s/etc/ssl/certs/ca-certificates.crt", g_ddnatv_root); + setenv("SSL_CERT_FILE", cert_buf, 1); + } + + const char *curr_cert_dir = getenv("SSL_CERT_DIR"); + if (!curr_cert_dir || curr_cert_dir[0] == '\0' || strcmp(curr_cert_dir, "/etc/ssl/certs") == 0) { + char cert_dir_buf[PATH_MAX]; + snprintf(cert_dir_buf, sizeof(cert_dir_buf), "%s/etc/ssl/certs:/system/etc/security/cacerts", g_ddnatv_root); + setenv("SSL_CERT_DIR", cert_dir_buf, 1); + } + + const char *curr_curl = getenv("CURL_CA_BUNDLE"); + if (!curr_curl || curr_curl[0] == '\0' || strcmp(curr_curl, "/etc/ssl/certs/ca-certificates.crt") == 0) { + char curl_buf[PATH_MAX]; + snprintf(curl_buf, sizeof(curl_buf), "%s/etc/ssl/certs/ca-certificates.crt", g_ddnatv_root); + setenv("CURL_CA_BUNDLE", curl_buf, 1); + } + + const char *curr_godebug = getenv("GODEBUG"); + if (!curr_godebug || curr_godebug[0] == '\0') { + setenv("GODEBUG", "netdns=cgo", 0); + } else if (strstr(curr_godebug, "netdns") == NULL) { + char godebug_buf[512]; + snprintf(godebug_buf, sizeof(godebug_buf), "%s,netdns=cgo", curr_godebug); + setenv("GODEBUG", godebug_buf, 1); + } + } + g_initialized = 1; +} + +// Before the program runs: init_ddnatv_hook() sets variables, and setenv() may move the block the +// environment is kept in. A program that had changed its environment (putenv, setenv) and passed it +// to execv() before its first call into the hook handed the exec code a block that was freed by the +// time it was read. +__attribute__((constructor(103))) static void init_ddnatv_hook_early(void) { + init_ddnatv_hook(); + // The kernel names the process after what it executed, the rootfs ld.so: process monitors, and + // the app's own checks of /proc//comm (steam, wineserver), saw only "ld-linux-aarch64.so.1" + const char *name = program_invocation_short_name; + if (g_ddnatv_root[0] != '\0' && name && name[0] && strncmp(name, "ld-linux", 8) != 0) { + prctl(PR_SET_NAME, (unsigned long)name, 0, 0, 0); + } +} + +void tzset(void) { + static void (*orig_tzset)(void) = NULL; + if (!orig_tzset) orig_tzset = (void (*)(void))dlsym(RTLD_NEXT, "tzset"); + init_ddnatv_hook(); + if (g_ddnatv_root[0] != '\0') { + const char *curr_tzdir = getenv("TZDIR"); + if (!curr_tzdir || curr_tzdir[0] == '\0') { + char tzdir_buf[PATH_MAX]; + snprintf(tzdir_buf, sizeof(tzdir_buf), "%s/usr/share/zoneinfo", g_ddnatv_root); + setenv("TZDIR", tzdir_buf, 0); + } + } + if (orig_tzset) orig_tzset(); +} + +static int is_proc_self_exe(const char *path) { + if (!path) return 0; + if (strcmp(path, "/proc/self/exe") == 0 || + strcmp(path, "/proc/thread-self/exe") == 0) { + return 1; + } + if (strncmp(path, "/proc/", 6) == 0) { + const char *p = path + 6; + while (*p >= '0' && *p <= '9') p++; + if (strcmp(p, "/exe") == 0) { + pid_t pid = (pid_t)atoi(path + 6); + if (pid == getpid()) { + return 1; + } + } + } + return 0; +} + +static ssize_t handle_proc_self_exe(char *buf, size_t bufsiz) { + if (!buf || bufsiz == 0) { + errno = EINVAL; + return -1; + } + init_ddnatv_hook(); + if (g_real_exe[0] == '\0') { + int fd = open("/proc/self/cmdline", O_RDONLY); + if (fd >= 0) { + char cmdline[8192]; + ssize_t n = read(fd, cmdline, sizeof(cmdline) - 1); + close(fd); + if (n > 0) { + cmdline[n] = '\0'; + char *args[64] = {0}; + int ac = 0; + char *p = cmdline; + while (p < cmdline + n && ac < 64) { + args[ac++] = p; + p += strlen(p) + 1; + } + for (int i = 0; i < ac; i++) { + if (strcmp(args[i], "--argv0") == 0 && i + 2 < ac) { + strncpy(g_real_exe, args[i + 2], sizeof(g_real_exe) - 1); + g_real_exe[sizeof(g_real_exe) - 1] = '\0'; + break; + } + } + if (g_real_exe[0] == '\0' && ac > 0 && args[0] && args[0][0] != '\0') { + strncpy(g_real_exe, args[0], sizeof(g_real_exe) - 1); + g_real_exe[sizeof(g_real_exe) - 1] = '\0'; + } + } + } + } + + if (g_real_exe[0] != '\0') { + char stripped[PATH_MAX]; + const char *out_path = g_real_exe; + if (g_ddnatv_root[0] != '\0') { + size_t rlen = g_ddnatv_root_len; + if (strncmp(g_real_exe, g_ddnatv_root, rlen) == 0 && + (g_real_exe[rlen] == '/' || g_real_exe[rlen] == '\0')) { + out_path = g_real_exe + rlen; + if (out_path[0] == '\0') out_path = "/"; + } + } + strncpy(stripped, out_path, sizeof(stripped) - 1); + stripped[sizeof(stripped) - 1] = '\0'; + + size_t len = strlen(stripped); + size_t copy_len = (len < bufsiz) ? len : bufsiz; + memcpy(buf, stripped, copy_len); + return (ssize_t)copy_len; + } + return -1; +} + +static const char *rewrite_path(const char *path, char *buffer, size_t bufsize) { + if (!path) return NULL; + // Relative paths must NEVER be rewritten to rootfs root + if (path[0] != '/') return path; + init_ddnatv_hook(); + return rewrite_path_in_root(path, buffer, bufsize); +} + +// rewrite_path() for calls that follow a symbolic link in the last component. In a mount whose +// source is elsewhere the kernel would follow the link's absolute guest target on Android's own +// tree (a Flatpak app's /app/bin/PINBALL.DAT -> /app/extra/Pinball/PINBALL.DAT), so the link is +// followed in the guest's view first. The rootfs's own links were made relative already. +static const char *rewrite_path_follow(const char *path, char *buffer, size_t bufsize) { + if (!path) return NULL; + if (path[0] != '/') return path; + init_ddnatv_hook(); + int moved = 0; + for (int i = 0; i < g_nbinds; i++) { + const struct ddnatv_bind *b = &g_binds[i]; + if (path[1] == b->dst[1] && is_path_prefix(path, b->dst, b->dst_len)) { moved = !b->identity; break; } + } + char from_source[PATH_MAX]; + if (!moved) { + // or a mount's real place, as /proc/self/exe and getcwd() give it (a Flatpak app's checkout) + const struct ddnatv_bind *best = NULL; + for (int i = 0; i < g_nbinds; i++) { + const struct ddnatv_bind *b = &g_binds[i]; + if (b->identity || !is_path_prefix(path, b->src, b->src_len)) continue; + if (!best || b->src_len > best->src_len) best = b; + } + if (!best) { + const char *host = rewrite_path_in_root(path, buffer, bufsize); +#if defined(__aarch64__) + // A link in the rootfs with an absolute guest target that the hook did not write (one made + // under proot, or copied from Proton's template prefix, as Wine's "z:" -> "/") is followed + // by the kernel on Android's own tree: Wine found no drive for any path and gave games + // \\?\unix\ names, which an NW.js game could not load its DLLs from. + if (is_android_host_path(path)) return host; + char target[PATH_MAX]; + long n = raw_readlinkat(AT_FDCWD, host, target, sizeof(target) - 1); + if (n <= 0 || target[0] != '/') return host; + target[n] = '\0'; + if (is_android_host_path(target) || + (g_ddnatv_root_len && strncmp(target, g_ddnatv_root, g_ddnatv_root_len) == 0)) return host; + char guest_path[PATH_MAX]; + ddnatv_copy_cstr(guest_path, sizeof(guest_path), path); + char guest_target[PATH_MAX]; + const char *followed = follow_guest_link(guest_path, guest_target, sizeof(guest_target)); + char mapped[PATH_MAX]; + ddnatv_copy_cstr(buffer, bufsize, rewrite_path_in_root(followed, mapped, sizeof(mapped))); + return buffer; +#else + return host; +#endif + } + size_t n = ddnatv_append(from_source, sizeof(from_source), 0, best->dst, best->dst_len); + ddnatv_append(from_source, sizeof(from_source), n, path + best->src_len, strlen(path + best->src_len)); + path = from_source; + } + char guest[PATH_MAX]; + const char *followed = follow_guest_link(path, guest, sizeof(guest)); + char mapped[PATH_MAX]; + const char *host = rewrite_path_in_root(followed, mapped, sizeof(mapped)); + // the result may be `followed` or `path` itself, which can live here + ddnatv_copy_cstr(buffer, bufsize, host); + return buffer; +} + +// Whether the rootfs keeps bin (pair DDNATV_USRMERGE_BIN) or sbin as a symlink into /usr, as +// Ubuntu 24.04 does. Checked once per process with one readlink(). +static int rootfs_pair_is_merged(int pair) { + static int known[3] = { 0, -1, -1 }; + if (known[pair] >= 0) return known[pair]; + static ssize_t (*orig_readlink)(const char *, char *, size_t) = NULL; + if (!orig_readlink) orig_readlink = (ssize_t (*)(const char *, char *, size_t))dlsym(RTLD_NEXT, "readlink"); + const char *dir = (pair == DDNATV_USRMERGE_BIN) ? "/bin" : "/sbin"; + const char *usr_dir = (pair == DDNATV_USRMERGE_BIN) ? "usr/bin" : "usr/sbin"; + char path[PATH_MAX]; + char link[16]; + size_t n = ddnatv_append(path, sizeof(path), 0, g_ddnatv_root, g_ddnatv_root_len); + ddnatv_append(path, sizeof(path), n, dir, strlen(dir)); + int saved_errno = errno; + ssize_t len = orig_readlink ? orig_readlink(path, link, sizeof(link) - 1) : -1; + errno = saved_errno; + int merged = 0; + if (len > 0) { + link[len] = '\0'; + size_t ulen = strlen(usr_dir); + merged = strncmp(link, usr_dir, ulen) == 0 && (link[ulen] == '\0' || (link[ulen] == '/' && link[ulen + 1] == '\0')); + } + known[pair] = merged; + return merged; +} + +// The other spelling of a missing rootfs path under bin/sbin, or NULL when there is none or both +// spellings reach the same directory (the retry could only fail again). +static const char *usrmerge_retry_path(const char *target, char *alt, size_t altsz) { + const char *sub = get_rootfs_subpath(target); + if (!sub) return NULL; + int pair = usrmerge_alt_path(sub, alt, altsz); + if (pair == 0 || rootfs_pair_is_merged(pair)) return NULL; + return alt; +} + +static const char *rewrite_unix_socket_path(const char *sun_path, char *out_buf, size_t out_size) { + if (!sun_path || out_size == 0) return sun_path; + // Abstract sockets start with null byte (\0); leave untouched + if (sun_path[0] == '\0') { + return sun_path; + } + + char full[PATH_MAX]; + const char *rw = (sun_path[0] == '/') ? rewrite_path(sun_path, full, sizeof(full)) : sun_path; + size_t rw_len = strlen(rw); + + // If rewritten path fits safely in sockaddr_un.sun_path (usually 108 bytes) + if (rw_len < out_size) { + strncpy(out_buf, rw, out_size - 1); + out_buf[out_size - 1] = '\0'; + return out_buf; + } + + // Path exceeds sockaddr_un 108-byte limit! + // Deterministically hash the path into /tmp to guarantee it fits safely (< 80 bytes) + // while remaining 100% deterministic between server and client. + unsigned long long hash = 14695981039346656037ULL; + for (const char *p = rw; *p; p++) { + hash ^= (unsigned char)(*p); + hash *= 1099511628211ULL; + } + + init_ddnatv_hook(); + if (g_ddnatv_root[0] != '\0') { + snprintf(out_buf, out_size, "%s/tmp/.ctx_sock_%016llx", g_ddnatv_root, hash); + } else { + snprintf(out_buf, out_size, "/tmp/.ctx_sock_%016llx", hash); + } + out_buf[out_size - 1] = '\0'; + return out_buf; +} + +static void unlink_mapped_unix_socket(const char *target) { + if (!target) return; + size_t t_len = strlen(target); + if (t_len >= 107) { + unsigned long long hash = 14695981039346656037ULL; + for (const char *p = target; *p; p++) { + hash ^= (unsigned char)(*p); + hash *= 1099511628211ULL; + } + char short_path[PATH_MAX]; + init_ddnatv_hook(); + if (g_ddnatv_root[0] != '\0') { + snprintf(short_path, sizeof(short_path), "%s/tmp/.ctx_sock_%016llx", g_ddnatv_root, hash); + } else { + snprintf(short_path, sizeof(short_path), "/tmp/.ctx_sock_%016llx", hash); + } + static int (*orig_unlink)(const char *) = NULL; + if (!orig_unlink) orig_unlink = (int (*)(const char *))dlsym(RTLD_NEXT, "unlink"); + if (orig_unlink) orig_unlink(short_path); + } +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/signals.c b/tools/nativeguest/hook/signals.c new file mode 100644 index 0000000000..0b5765070d --- /dev/null +++ b/tools/nativeguest/hook/signals.c @@ -0,0 +1,233 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// The SIGSYS handler for system calls Android's seccomp filter blocks, and the signal hooks that +// keep programs from replacing or blocking it. + +#ifndef DDNATV_HOST_TEST + +#ifndef SYS_SECCOMP +#define SYS_SECCOMP 1 +#endif + +static int (*get_real_sigaction(void))(int, const struct sigaction *, struct sigaction *); + +// A program's own SIGSYS handler, for the traps of a seccomp filter it installed itself (Firefox's +// and Chromium's sandboxes emulate the calls they trap there). Android's app filter traps with data +// 0; such a sandbox's traps carry their own nonzero data, which the kernel gives as si_errno. +static struct sigaction g_app_sigsys; +static int g_app_sigsys_set = 0; + +static void remember_app_sigsys(const struct sigaction *act, struct sigaction *oldact) { + if (oldact) { + if (g_app_sigsys_set) { + *oldact = g_app_sigsys; + } else { + memset(oldact, 0, sizeof(*oldact)); + oldact->sa_handler = SIG_DFL; + } + } + if (act) { + g_app_sigsys = *act; + g_app_sigsys_set = act->sa_handler != SIG_DFL && act->sa_handler != SIG_IGN; + } +} + +// Intercept SECCOMP blocked syscalls (SIGSYS), resolve sandbox/landlock gracefully, and advance PC +static void ddnatv_sigsys_handler(int sig, siginfo_t *info, void *ctx) { + if (!ctx || !info) return; + if (info->si_code != SYS_SECCOMP) { + int (*real_sig)(int, const struct sigaction *, struct sigaction *) = get_real_sigaction(); + if (real_sig) { + struct sigaction sa_dfl; + memset(&sa_dfl, 0, sizeof(sa_dfl)); + sa_dfl.sa_handler = SIG_DFL; + sigemptyset(&sa_dfl.sa_mask); + real_sig(sig, &sa_dfl, NULL); + } + raise(sig); + return; + } + if (info->si_errno != 0 && g_app_sigsys_set) { + if (g_app_sigsys.sa_flags & SA_SIGINFO) g_app_sigsys.sa_sigaction(sig, info, ctx); + else g_app_sigsys.sa_handler(sig); + return; + } + ucontext_t *uctx = (ucontext_t *)ctx; + + int sys_nr = info->si_syscall; + long ret_val = is_sigsys_synthetic_success_syscall(sys_nr) ? 0 : -ENOSYS; + +#if defined(__aarch64__) + uctx->uc_mcontext.regs[0] = (uint64_t)ret_val; + if (uctx->uc_mcontext.pc >= 4) { + uint32_t insn_at_pc = 0; + uint32_t insn_before_pc = 0; + memcpy(&insn_at_pc, (const void *)uctx->uc_mcontext.pc, sizeof(insn_at_pc)); + memcpy(&insn_before_pc, (const void *)(uctx->uc_mcontext.pc - 4), sizeof(insn_before_pc)); + // On SECCOMP_RET_TRAP, the kernel already advanced PC past svc #0 (*(pc - 4) is svc #0). + // Only advance PC if PC itself points to svc #0 and *(pc - 4) does not. + int at_is_svc = ((insn_at_pc & 0xffe0001fU) == 0xd4000001U); + int prev_is_svc = ((insn_before_pc & 0xffe0001fU) == 0xd4000001U); + if (at_is_svc && !prev_is_svc) { + uctx->uc_mcontext.pc += 4; + } + } +#elif defined(__arm__) + uctx->uc_mcontext.arm_r0 = (unsigned long)ret_val; + if (uctx->uc_mcontext.arm_pc >= 4) { + if (uctx->uc_mcontext.arm_cpsr & 0x20) { + uint16_t insn_at_pc = 0; + uint16_t insn_before_pc = 0; + memcpy(&insn_at_pc, (const void *)uctx->uc_mcontext.arm_pc, sizeof(insn_at_pc)); + memcpy(&insn_before_pc, (const void *)(uctx->uc_mcontext.arm_pc - 2), sizeof(insn_before_pc)); + int at_is_svc = ((insn_at_pc & 0xff00U) == 0xdf00U); + int prev_is_svc = ((insn_before_pc & 0xff00U) == 0xdf00U); + if (at_is_svc && !prev_is_svc) { + uctx->uc_mcontext.arm_pc += 2; + } + } else { + uint32_t insn_at_pc = 0; + uint32_t insn_before_pc = 0; + memcpy(&insn_at_pc, (const void *)uctx->uc_mcontext.arm_pc, sizeof(insn_at_pc)); + memcpy(&insn_before_pc, (const void *)(uctx->uc_mcontext.arm_pc - 4), sizeof(insn_before_pc)); + int at_is_svc = ((insn_at_pc & 0x0f000000U) == 0x0f000000U); + int prev_is_svc = ((insn_before_pc & 0x0f000000U) == 0x0f000000U); + if (at_is_svc && !prev_is_svc) { + uctx->uc_mcontext.arm_pc += 4; + } + } + } +#elif defined(__x86_64__) && defined(REG_RAX) + uctx->uc_mcontext.gregs[REG_RAX] = (greg_t)ret_val; + if (uctx->uc_mcontext.gregs[REG_RIP] >= 2) { + unsigned char insn_at[2] = {0}; + unsigned char insn_prev[2] = {0}; + memcpy(insn_at, (const void *)uctx->uc_mcontext.gregs[REG_RIP], sizeof(insn_at)); + memcpy(insn_prev, (const void *)(uctx->uc_mcontext.gregs[REG_RIP] - 2), sizeof(insn_prev)); + int at_is_sys = (insn_at[0] == 0x0f && insn_at[1] == 0x05); + int prev_is_sys = (insn_prev[0] == 0x0f && insn_prev[1] == 0x05); + if (at_is_sys && !prev_is_sys) { + uctx->uc_mcontext.gregs[REG_RIP] += 2; + } + } +#elif defined(__i386__) && defined(REG_EAX) + uctx->uc_mcontext.gregs[REG_EAX] = (greg_t)ret_val; + if (uctx->uc_mcontext.gregs[REG_EIP] >= 2) { + unsigned char insn_at[2] = {0}; + unsigned char insn_prev[2] = {0}; + memcpy(insn_at, (const void *)uctx->uc_mcontext.gregs[REG_EIP], sizeof(insn_at)); + memcpy(insn_prev, (const void *)(uctx->uc_mcontext.gregs[REG_EIP] - 2), sizeof(insn_prev)); + int at_is_sys = (insn_at[0] == 0xcd && insn_at[1] == 0x80); + int prev_is_sys = (insn_prev[0] == 0xcd && insn_prev[1] == 0x80); + if (at_is_sys && !prev_is_sys) { + uctx->uc_mcontext.gregs[REG_EIP] += 2; + } + } +#endif +} + +static int (*get_real_sigaction(void))(int, const struct sigaction *, struct sigaction *) { + static int (*real_sigaction)(int, const struct sigaction *, struct sigaction *) = NULL; + if (!real_sigaction) { + real_sigaction = (int (*)(int, const struct sigaction *, struct sigaction *))dlsym(RTLD_NEXT, "sigaction"); + if (!real_sigaction) { + real_sigaction = (int (*)(int, const struct sigaction *, struct sigaction *))dlsym(RTLD_DEFAULT, "sigaction"); + } + } + return real_sigaction; +} + +__attribute__((constructor(101))) static void install_sigsys_handler(void) { + int (*real_sig)(int, const struct sigaction *, struct sigaction *) = get_real_sigaction(); + if (!real_sig) return; + + struct sigaction sa; + memset(&sa, 0, sizeof(sa)); + sa.sa_sigaction = ddnatv_sigsys_handler; + sa.sa_flags = SA_SIGINFO | SA_RESTART; + sigemptyset(&sa.sa_mask); + real_sig(SIGSYS, &sa, NULL); +} + +int sigaction(int signum, const struct sigaction *act, struct sigaction *oldact) { + int (*real_sig)(int, const struct sigaction *, struct sigaction *) = get_real_sigaction(); + if (!real_sig) return -1; + + if (signum == SIGSYS) { + if (act && act->sa_sigaction == ddnatv_sigsys_handler) { + return real_sig(signum, act, oldact); + } + remember_app_sigsys(act, oldact); + return 0; + } + return real_sig(signum, act, oldact); +} + +int rt_sigaction(int signum, const struct sigaction *act, struct sigaction *oldact, size_t sigsetsize) { + static int (*orig_rt_sigaction)(int, const struct sigaction *, struct sigaction *, size_t) = NULL; + if (!orig_rt_sigaction) orig_rt_sigaction = (int (*)(int, const struct sigaction *, struct sigaction *, size_t))dlsym(RTLD_NEXT, "rt_sigaction"); + + if (signum == SIGSYS) { + if (act && act->sa_sigaction == ddnatv_sigsys_handler) { + return orig_rt_sigaction ? orig_rt_sigaction(signum, act, oldact, sigsetsize) : 0; + } + remember_app_sigsys(act, oldact); + return 0; + } + return orig_rt_sigaction ? orig_rt_sigaction(signum, act, oldact, sigsetsize) : -1; +} + +int __libc_sigaction(int signum, const struct sigaction *act, struct sigaction *oldact) { + return sigaction(signum, act, oldact); +} + +typedef void (*sighandler_t)(int); +sighandler_t signal(int signum, sighandler_t handler) { + static sighandler_t (*orig_signal)(int, sighandler_t) = NULL; + if (!orig_signal) orig_signal = (sighandler_t (*)(int, sighandler_t))dlsym(RTLD_NEXT, "signal"); + if (signum == SIGSYS) { + struct sigaction act, old; + memset(&act, 0, sizeof(act)); + act.sa_handler = handler; + remember_app_sigsys(&act, &old); + return old.sa_handler; + } + return orig_signal ? orig_signal(signum, handler) : NULL; +} + +int sigprocmask(int how, const sigset_t *set, sigset_t *oldset) { + static int (*orig_sigprocmask)(int, const sigset_t *, sigset_t *) = NULL; + if (!orig_sigprocmask) orig_sigprocmask = (int (*)(int, const sigset_t *, sigset_t *))dlsym(RTLD_NEXT, "sigprocmask"); + if (set && (how == SIG_BLOCK || how == SIG_SETMASK)) { + sigset_t mod_set = *set; + sigdelset(&mod_set, SIGSYS); + return orig_sigprocmask ? orig_sigprocmask(how, &mod_set, oldset) : 0; + } + return orig_sigprocmask ? orig_sigprocmask(how, set, oldset) : 0; +} + +int pthread_sigmask(int how, const sigset_t *set, sigset_t *oldset) { + static int (*orig_pthread_sigmask)(int, const sigset_t *, sigset_t *) = NULL; + if (!orig_pthread_sigmask) orig_pthread_sigmask = (int (*)(int, const sigset_t *, sigset_t *))dlsym(RTLD_NEXT, "pthread_sigmask"); + if (set && (how == SIG_BLOCK || how == SIG_SETMASK)) { + sigset_t mod_set = *set; + sigdelset(&mod_set, SIGSYS); + return orig_pthread_sigmask ? orig_pthread_sigmask(how, &mod_set, oldset) : 0; + } + return orig_pthread_sigmask ? orig_pthread_sigmask(how, set, oldset) : 0; +} + +int rt_sigprocmask(int how, const sigset_t *set, sigset_t *oldset, size_t sigsetsize) { + static int (*orig_rt_sigprocmask)(int, const sigset_t *, sigset_t *, size_t) = NULL; + if (!orig_rt_sigprocmask) orig_rt_sigprocmask = (int (*)(int, const sigset_t *, sigset_t *, size_t))dlsym(RTLD_NEXT, "rt_sigprocmask"); + if (set && (how == SIG_BLOCK || how == SIG_SETMASK)) { + sigset_t mod_set; + memcpy(&mod_set, set, sizeof(mod_set)); + sigdelset(&mod_set, SIGSYS); + return orig_rt_sigprocmask ? orig_rt_sigprocmask(how, &mod_set, oldset, sigsetsize) : 0; + } + return orig_rt_sigprocmask ? orig_rt_sigprocmask(how, set, oldset, sigsetsize) : 0; +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/sockets.c b/tools/nativeguest/hook/sockets.c new file mode 100644 index 0000000000..2903505f9b --- /dev/null +++ b/tools/nativeguest/hook/sockets.c @@ -0,0 +1,351 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Sockets: Unix socket paths in the rootfs, the redirected DNS queries of loopback DNS, and the +// TCP servers programs start (the app offers to open them in the browser). + +// The TCP port a listening socket was bound to, 0 for other sockets. +static int listening_tcp_port(int fd) { + struct sockaddr_storage ss; + socklen_t len = sizeof(ss); + memset(&ss, 0, sizeof(ss)); + if (syscall(SYS_getsockname, fd, (struct sockaddr *)&ss, &len) != 0) return 0; + if (ss.ss_family == AF_INET && len >= (socklen_t)sizeof(struct sockaddr_in)) + return ntohs(((struct sockaddr_in *)&ss)->sin_port); + if (ss.ss_family == AF_INET6 && len >= (socklen_t)sizeof(struct sockaddr_in6)) + return ntohs(((struct sockaddr_in6 *)&ss)->sin6_port); + return 0; +} + +// Tells the app that this program listens on [port]: $DDNATV_ROOT/run/ddnatv/listening/PORT with +// "PID NAME" (ListeningPorts). Raw system calls: nothing of this library runs again. +static void report_listening_port(const char *root, size_t root_len, int port, const char *name) { + if (root_len == 0 || port <= 0 || port > 65535) return; + char path[PATH_MAX]; + int n = snprintf(path, sizeof(path), "%.*s/run/ddnatv/listening/%d", (int)root_len, root, port); + if (n <= 0 || n >= (int)sizeof(path)) return; + int out = (int)syscall(SYS_openat, AT_FDCWD, path, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC, 0600); + if (out < 0) return; // no app watching (the directory is the app's) + char line[160]; + int m = snprintf(line, sizeof(line), "%d %.100s\n", (int)getpid(), name && name[0] ? name : "?"); + if (m > 0) syscall(SYS_write, out, line, (size_t)(m < (int)sizeof(line) ? m : (int)sizeof(line) - 1)); + syscall(SYS_close, out); +} + +// The first port of the kernel's range for ports it picks itself, from the text of +// /proc/sys/net/ipv4/ip_local_port_range ("32768\t60999"); 32768, Linux's default, when there is none. +static int ephemeral_port_low(const char *range) { + if (!range) return 32768; + while (*range == ' ' || *range == '\t') range++; + int low = 0, digits = 0; + while (*range >= '0' && *range <= '9' && digits < 6) low = low * 10 + (*range++ - '0'), digits++; + return (digits > 0 && low > 0 && low <= 65535) ? low : 32768; +} + +// Whether listen() tells the app about a server on `port`, which it then connects to and sends an +// HTTP request (LocalServers). Only for a port the program chose (`chosen`) below the kernel's own +// range: a server whose port the kernel picked, or one in that range, is how programs talk to +// each other (Gradle's daemon, the Kotlin daemon, a JVM's debugger, test runners). Such a server +// often accepts one connection, so the app's own took the place of the program it waited for: +// that one read EOF ("Did not receive connection preamble" from Gradle, #51). Web servers people +// open (npm run dev, vite, python3 -m http.server, jupyter) are on ports such as 3000, 5173, 8000. +static int listening_port_is_reported(int chosen, int port, int ephemeral_low) { + return chosen && port > 0 && port < ephemeral_low; +} + +#ifndef DDNATV_HOST_TEST + +// The kernel's range, read once (raw system calls: nothing of this library runs again) +static int kernel_ephemeral_port_low(void) { + static int low = 0; + int v = __atomic_load_n(&low, __ATOMIC_RELAXED); + if (v) return v; + char text[64]; + ssize_t n = -1; + int fd = (int)syscall(SYS_openat, AT_FDCWD, "/proc/sys/net/ipv4/ip_local_port_range", O_RDONLY | O_CLOEXEC); + if (fd >= 0) { + n = syscall(SYS_read, fd, text, sizeof(text) - 1); + syscall(SYS_close, fd); + } + if (n > 0) text[n] = '\0'; + v = ephemeral_port_low(n > 0 ? text : NULL); + __atomic_store_n(&low, v, __ATOMIC_RELAXED); + return v; +} + +int listen(int sockfd, int backlog) { + static int (*orig_listen)(int, int) = NULL; + if (!orig_listen) orig_listen = (int (*)(int, int))dlsym(RTLD_NEXT, "listen"); + if (!orig_listen) { + errno = ENOSYS; + return -1; + } + int ret = orig_listen(sockfd, backlog); + if (ret == 0) { + int saved_errno = errno; + int port = is_chosen_port_fd(sockfd) ? listening_tcp_port(sockfd) : 0; + if (listening_port_is_reported(port > 0, port, kernel_ephemeral_port_low())) { + init_ddnatv_hook(); + extern char *program_invocation_short_name; + report_listening_port(g_ddnatv_root, g_ddnatv_root_len, port, program_invocation_short_name); + } + errno = saved_errno; + } + return ret; +} + +int bind(int sockfd, const struct sockaddr *addr, socklen_t addrlen) { + static int (*orig_bind)(int, const struct sockaddr *, socklen_t) = NULL; + if (!orig_bind) orig_bind = (int (*)(int, const struct sockaddr *, socklen_t))dlsym(RTLD_NEXT, "bind"); + + if (addr && addrlen > offsetof(struct sockaddr_un, sun_path) && addr->sa_family == AF_UNIX) { + const struct sockaddr_un *sun = (const struct sockaddr_un *)addr; + if (sun->sun_path[0] != '\0') { + struct sockaddr_un mod_sun; + memset(&mod_sun, 0, sizeof(mod_sun)); + mod_sun.sun_family = AF_UNIX; + rewrite_unix_socket_path(sun->sun_path, mod_sun.sun_path, sizeof(mod_sun.sun_path)); + return orig_bind ? orig_bind(sockfd, (struct sockaddr *)&mod_sun, sizeof(mod_sun)) : -1; + } + } + int ret = orig_bind ? orig_bind(sockfd, addr, addrlen) : -1; + if (ret == 0 && addr) { + int saved_errno = errno; + int chosen = 0; + if (addr->sa_family == AF_INET && addrlen >= (socklen_t)sizeof(struct sockaddr_in)) + chosen = ((const struct sockaddr_in *)addr)->sin_port != 0; + else if (addr->sa_family == AF_INET6 && addrlen >= (socklen_t)sizeof(struct sockaddr_in6)) + chosen = ((const struct sockaddr_in6 *)addr)->sin6_port != 0; + set_chosen_port_fd(sockfd, chosen); + errno = saved_errno; + } + return ret; +} + +int connect(int sockfd, const struct sockaddr *addr, socklen_t addrlen) { + static int (*orig_connect)(int, const struct sockaddr *, socklen_t) = NULL; + if (!orig_connect) orig_connect = (int (*)(int, const struct sockaddr *, socklen_t))dlsym(RTLD_NEXT, "connect"); + + if (addr && addrlen > offsetof(struct sockaddr_un, sun_path) && addr->sa_family == AF_UNIX) { + const struct sockaddr_un *sun = (const struct sockaddr_un *)addr; + if (sun->sun_path[0] != '\0') { + struct sockaddr_un mod_sun; + memset(&mod_sun, 0, sizeof(mod_sun)); + mod_sun.sun_family = AF_UNIX; + char guest[sizeof(sun->sun_path) + 1]; + size_t max = addrlen - offsetof(struct sockaddr_un, sun_path); + if (max > sizeof(sun->sun_path)) max = sizeof(sun->sun_path); + memcpy(guest, sun->sun_path, max); + guest[max] = '\0'; + char followed[PATH_MAX]; + const char *path = guest[0] == '/' ? follow_guest_link(guest, followed, sizeof(followed)) : guest; + rewrite_unix_socket_path(path, mod_sun.sun_path, sizeof(mod_sun.sun_path)); + return orig_connect ? orig_connect(sockfd, (struct sockaddr *)&mod_sun, sizeof(mod_sun)) : -1; + } + } + + if (addr && is_loopback_dns(addr, addrlen)) { + struct sockaddr_storage redirected; + socklen_t redirected_len = dns_redirect_target(addr, &redirected); + int ret = orig_connect ? orig_connect(sockfd, (struct sockaddr *)&redirected, redirected_len) : -1; + if (ret == 0 || errno == EINPROGRESS) { + int saved_errno = errno; + record_dns_redirect(sockfd, addr, addrlen); + errno = saved_errno; + } + return ret; + } + return orig_connect ? orig_connect(sockfd, addr, addrlen) : -1; +} + +ssize_t sendto(int sockfd, const void *buf, size_t len, int flags, + const struct sockaddr *dest_addr, socklen_t addrlen) { + static ssize_t (*orig_sendto)(int, const void *, size_t, int, const struct sockaddr *, socklen_t) = NULL; + if (!orig_sendto) orig_sendto = (ssize_t (*)(int, const void *, size_t, int, const struct sockaddr *, socklen_t))dlsym(RTLD_NEXT, "sendto"); + + if (dest_addr && is_loopback_dns(dest_addr, addrlen)) { + struct sockaddr_storage redirected; + socklen_t redirected_len = dns_redirect_target(dest_addr, &redirected); + record_dns_redirect(sockfd, dest_addr, addrlen); + return orig_sendto ? orig_sendto(sockfd, buf, len, flags, (struct sockaddr *)&redirected, redirected_len) : -1; + } + return orig_sendto ? orig_sendto(sockfd, buf, len, flags, dest_addr, addrlen) : -1; +} + +#if defined(__NR_getuid32) +#define DDNATV_NR_REAL_GETUID __NR_getuid32 +#define DDNATV_NR_REAL_GETGID __NR_getgid32 +#else +#define DDNATV_NR_REAL_GETUID __NR_getuid +#define DDNATV_NR_REAL_GETGID __NR_getgid +#endif + +// Credentials sent over a Unix socket (SCM_CREDENTIALS) have to be the process's own: the kernel +// refuses others with EPERM, and programs fill them in with getuid(), which is root's 0 here. +// PulseAudio's clients send them on every connection, which then failed ("Connection terminated"). +// Returns 1 with the message copied into mod (its control data into ctrl) and the ids made real. +static int real_scm_credentials(const struct msghdr *msg, struct msghdr *mod, char *ctrl, size_t ctrl_size) { + if (!msg || !msg->msg_control || msg->msg_controllen < sizeof(struct cmsghdr) || msg->msg_controllen > ctrl_size) return 0; + int found = 0; + for (struct cmsghdr *c = CMSG_FIRSTHDR(msg); c; c = CMSG_NXTHDR((struct msghdr *)msg, c)) { + if (c->cmsg_level == SOL_SOCKET && c->cmsg_type == SCM_CREDENTIALS) found = 1; + } + if (!found) return 0; + memcpy(mod, msg, sizeof(*mod)); + memcpy(ctrl, msg->msg_control, msg->msg_controllen); + mod->msg_control = ctrl; + for (struct cmsghdr *c = CMSG_FIRSTHDR(mod); c; c = CMSG_NXTHDR(mod, c)) { + if (c->cmsg_level != SOL_SOCKET || c->cmsg_type != SCM_CREDENTIALS || c->cmsg_len < CMSG_LEN(sizeof(struct ucred))) continue; + // a record that claims more than the buffer holds is the kernel's to refuse, not ours to read + if (c->cmsg_len > mod->msg_controllen - (size_t)((char *)c - ctrl)) break; + struct ucred cred; + memcpy(&cred, CMSG_DATA(c), sizeof(cred)); + cred.pid = getpid(); + cred.uid = (uid_t)call_orig_syscall(DDNATV_NR_REAL_GETUID, 0, 0, 0, 0, 0, 0); + cred.gid = (gid_t)call_orig_syscall(DDNATV_NR_REAL_GETGID, 0, 0, 0, 0, 0, 0); + memcpy(CMSG_DATA(c), &cred, sizeof(cred)); + } + return 1; +} + +ssize_t sendmsg(int sockfd, const struct msghdr *msg, int flags) { + static ssize_t (*orig_sendmsg)(int, const struct msghdr *, int) = NULL; + if (!orig_sendmsg) orig_sendmsg = (ssize_t (*)(int, const struct msghdr *, int))dlsym(RTLD_NEXT, "sendmsg"); + struct msghdr cred_msg; + char cred_ctrl[512] __attribute__((aligned(8))); + if (real_scm_credentials(msg, &cred_msg, cred_ctrl, sizeof(cred_ctrl))) msg = &cred_msg; + + if (msg && msg->msg_name && is_loopback_dns((const struct sockaddr *)msg->msg_name, msg->msg_namelen)) { + struct sockaddr_storage redirected; + socklen_t redirected_len = dns_redirect_target((const struct sockaddr *)msg->msg_name, &redirected); + struct msghdr mod_msg; + memcpy(&mod_msg, msg, sizeof(mod_msg)); + mod_msg.msg_name = &redirected; + mod_msg.msg_namelen = redirected_len; + record_dns_redirect(sockfd, (const struct sockaddr *)msg->msg_name, msg->msg_namelen); + return orig_sendmsg ? orig_sendmsg(sockfd, &mod_msg, flags) : -1; + } + return orig_sendmsg ? orig_sendmsg(sockfd, msg, flags) : -1; +} + +static void present_peer_as_root(struct ucred *cred) { + if (cred->uid == (uid_t)call_orig_syscall(DDNATV_NR_REAL_GETUID, 0, 0, 0, 0, 0, 0)) cred->uid = 0; + if (cred->gid == (gid_t)call_orig_syscall(DDNATV_NR_REAL_GETGID, 0, 0, 0, 0, 0, 0)) cred->gid = 0; +} + +// A server compares a peer's credentials with the user the peer claims, which is getuid()'s 0 +// here, while the kernel reports the app's ids: dbus-daemon refused every EXTERNAL login ("Did not +// receive a reply"), so the Plasma desktop never started. +int getsockopt(int sockfd, int level, int optname, void *optval, socklen_t *optlen) { + static int (*orig_getsockopt)(int, int, int, void *, socklen_t *) = NULL; + if (!orig_getsockopt) orig_getsockopt = (int (*)(int, int, int, void *, socklen_t *))dlsym(RTLD_NEXT, "getsockopt"); + if (!orig_getsockopt) { + errno = ENOSYS; + return -1; + } + int ret = orig_getsockopt(sockfd, level, optname, optval, optlen); + if (ret == 0 && level == SOL_SOCKET && optname == SO_PEERCRED && optval && optlen && *optlen >= sizeof(struct ucred)) { + struct ucred cred; + memcpy(&cred, optval, sizeof(cred)); + present_peer_as_root(&cred); + memcpy(optval, &cred, sizeof(cred)); + } + return ret; +} + +static void received_credentials_as_root(struct msghdr *msg) { + if (!msg || !msg->msg_control || msg->msg_controllen < sizeof(struct cmsghdr)) return; + for (struct cmsghdr *c = CMSG_FIRSTHDR(msg); c; c = CMSG_NXTHDR(msg, c)) { + if (c->cmsg_level != SOL_SOCKET || c->cmsg_type != SCM_CREDENTIALS || c->cmsg_len < CMSG_LEN(sizeof(struct ucred))) continue; + struct ucred cred; + memcpy(&cred, CMSG_DATA(c), sizeof(cred)); + present_peer_as_root(&cred); + memcpy(CMSG_DATA(c), &cred, sizeof(cred)); + } +} + +ssize_t recvfrom(int sockfd, void *buf, size_t len, int flags, + struct sockaddr *src_addr, socklen_t *addrlen) { + static ssize_t (*orig_recvfrom)(int, void *, size_t, int, struct sockaddr *, socklen_t *) = NULL; + if (!orig_recvfrom) orig_recvfrom = (ssize_t (*)(int, void *, size_t, int, struct sockaddr *, socklen_t *))dlsym(RTLD_NEXT, "recvfrom"); + + socklen_t cap = addrlen ? *addrlen : 0; + ssize_t ret = orig_recvfrom ? orig_recvfrom(sockfd, buf, len, flags, src_addr, addrlen) : -1; + if (ret > 0 && src_addr && addrlen) { + int saved_errno = errno; + restore_dns_source(sockfd, src_addr, cap, addrlen); + errno = saved_errno; + } + return ret; +} + +// What programs built with _FORTIFY_SOURCE call when the buffer's size is known; the check is +// glibc's +extern void __chk_fail(void) __attribute__((__noreturn__)); +ssize_t __recvfrom_chk(int sockfd, void *buf, size_t len, size_t buflen, int flags, + struct sockaddr *src_addr, socklen_t *addrlen) { + if (len > buflen) __chk_fail(); + return recvfrom(sockfd, buf, len, flags, src_addr, addrlen); +} + +ssize_t recvmsg(int sockfd, struct msghdr *msg, int flags) { + static ssize_t (*orig_recvmsg)(int, struct msghdr *, int) = NULL; + if (!orig_recvmsg) orig_recvmsg = (ssize_t (*)(int, struct msghdr *, int))dlsym(RTLD_NEXT, "recvmsg"); + + socklen_t cap = msg ? msg->msg_namelen : 0; + ssize_t ret = orig_recvmsg ? orig_recvmsg(sockfd, msg, flags) : -1; + if (ret >= 0) received_credentials_as_root(msg); + if (ret > 0 && msg && msg->msg_name) { + int saved_errno = errno; + restore_dns_source(sockfd, (struct sockaddr *)msg->msg_name, cap, &msg->msg_namelen); + errno = saved_errno; + } + return ret; +} + +int getpeername(int sockfd, struct sockaddr *addr, socklen_t *addrlen) { + static int (*orig_getpeername)(int, struct sockaddr *, socklen_t *) = NULL; + if (!orig_getpeername) orig_getpeername = (int (*)(int, struct sockaddr *, socklen_t *))dlsym(RTLD_NEXT, "getpeername"); + + socklen_t cap = addrlen ? *addrlen : 0; + int ret = orig_getpeername ? orig_getpeername(sockfd, addr, addrlen) : -1; + if (ret == 0 && addr && addrlen) restore_dns_source(sockfd, addr, cap, addrlen); + return ret; +} + +// accept() as accept4() without flags, the call bionic makes for both: Android's seccomp filter +// for apps is made from what bionic calls. On the x86_64 emulator a translated accept() answered +// with its system call number (43) as the new descriptor, and sshd failed every connection with +// "fcntl(43, F_GETFL): Bad file descriptor" (Perl, Python and nginx use accept4 themselves). +int accept(int sockfd, struct sockaddr *addr, socklen_t *addrlen) { + static int (*orig_accept4)(int, struct sockaddr *, socklen_t *, int) = NULL; + if (!orig_accept4) orig_accept4 = (int (*)(int, struct sockaddr *, socklen_t *, int))dlsym(RTLD_NEXT, "accept4"); + if (!orig_accept4) { + errno = ENOSYS; + return -1; + } + return orig_accept4(sockfd, addr, addrlen, 0); +} + +#ifndef AF_NETLINK +#define AF_NETLINK 16 +#endif +#ifndef NETLINK_AUDIT +#define NETLINK_AUDIT 9 +#endif + +int socket(int domain, int type, int protocol) { + static int (*orig_socket)(int, int, int) = NULL; + if (!orig_socket) orig_socket = (int (*)(int, int, int))dlsym(RTLD_NEXT, "socket"); + if (domain == AF_NETLINK && protocol == NETLINK_AUDIT) { + errno = EPROTONOSUPPORT; + return -1; + } + int fd = orig_socket ? orig_socket(domain, type, protocol) : -1; + // A new socket has not chosen a port, whatever the descriptor's last one had (close_range() and + // raw close system calls do not pass the hook's close()) + if (fd >= 0) set_chosen_port_fd(fd, 0); + return fd; +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/hook/static_programs.c b/tools/nativeguest/hook/static_programs.c new file mode 100644 index 0000000000..406fca0da9 --- /dev/null +++ b/tools/nativeguest/hook/static_programs.c @@ -0,0 +1,345 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// Statically linked programs: their seccomp-blocked system calls are patched before they run. + +// ---- Static programs ---------------------------------------------------------------------- +// A statically linked program (gcc -static) carries its own copy of glibc, whose system calls the +// preloaded hook never sees. The ones Android's seccomp filter answers with SIGSYS therefore kill it: +// set_robust_list at start-up, clone3 for every thread, rseq, and the others the hook's SIGSYS +// handler catches for dynamic programs. Before such a program runs, The native userland patches those call sites +// in its file to what that handler answers (0 for set_robust_list and the set*id family, -ENOSYS, +// which glibc falls back from, for the rest), as scripts/patch-bootstrap-ld.py does to the rootfs +// ld.so and libc at build time. The scanning is a pure function over a buffer, so tests/native can +// check it against the script. + +#define DDNATV_STATIC_WINDOW 16 // instructions between "mov x8, #nr" and its "svc #0" + +// AArch64: what the SIGSYS handler answers for syscall `nr`: 1 for 0, 2 for -ENOSYS, 0 to leave it. +// set_robust_list keeps the script's no-op (x0 then holds its non-error first argument). +static int a64_blocked_syscall(unsigned int nr) { + switch (nr) { + case 99: // set_robust_list + return 3; + case 100: // get_robust_list + case 143: case 144: case 145: case 146: case 147: case 149: // setregid setgid setreuid setuid setresuid setresgid + case 151: case 152: case 159: // setfsuid setfsgid setgroups + return 1; + case 97: case 217: case 218: case 219: // unshare add_key request_key keyctl + case 268: case 277: case 280: case 293: // setns seccomp bpf rseq + return 2; + default: + return (nr >= 424 && nr < 512) ? 2 : 0; // newer than Android's filter (clone3, close_range, ...) + } +} + +static uint32_t rd32(const unsigned char *p) { return (uint32_t)p[0] | ((uint32_t)p[1] << 8) | ((uint32_t)p[2] << 16) | ((uint32_t)p[3] << 24); } +static uint16_t rd16(const unsigned char *p) { return (uint16_t)(p[0] | (p[1] << 8)); } +static void wr32(unsigned char *p, uint32_t v) { p[0] = v & 0xff; p[1] = (v >> 8) & 0xff; p[2] = (v >> 16) & 0xff; p[3] = (v >> 24) & 0xff; } +static void wr16(unsigned char *p, uint16_t v) { p[0] = v & 0xff; p[1] = (v >> 8) & 0xff; } + +// An AArch64 instruction that ends the search for the "svc #0" of a "mov x8, #nr": a branch, another +// svc, or anything with x8 in its first register field (another write to x8, most likely). +static int a64_ends_syscall_window(uint32_t insn) { + if ((insn & 0x1f) == 8) return 1; + if ((insn & 0xffe0001f) == 0xd4000001u) return 1; // svc #imm + if ((insn & 0x7c000000u) == 0x14000000u) return 1; // b, bl + if ((insn & 0xff000010u) == 0x54000000u) return 1; // b.cond + if ((insn & 0x7e000000u) == 0x34000000u) return 1; // cbz, cbnz + if ((insn & 0x7e000000u) == 0x36000000u) return 1; // tbz, tbnz + if ((insn & 0xfe000000u) == 0xd6000000u) return 1; // br, blr, ret + return 0; +} + +static size_t a64_patch_seccomp_syscalls(unsigned char *data, size_t start, size_t end) { + size_t patched = 0; + start = (start + 3) & ~(size_t)3; + for (size_t pos = start; pos + 4 <= end; pos += 4) { + uint32_t insn = rd32(data + pos); + // movz x8, #nr / movz w8, #nr + if ((insn & 0x7fe0001fu) != 0x52800008u) continue; + int result = a64_blocked_syscall((insn >> 5) & 0xffff); + if (!result) continue; + for (size_t s = pos + 4, i = 0; s + 4 <= end && i < DDNATV_STATIC_WINDOW; s += 4, i++) { + uint32_t next = rd32(data + s); + if (next == 0xd4000001u) { // svc #0 + wr32(data + s, result == 3 ? 0xd503201fu /* nop */ + : result == 1 ? 0xd2800000u /* mov x0, #0 */ + : 0x928004a0u); /* mov x0, #-38 */ + patched++; + break; + } + if (a64_ends_syscall_window(next)) break; + } + } + return patched; +} + +// 32-bit ARM: the three calls glibc makes on its own, with the exact patterns of the script +// (ARM mode, Thumb-2 with r7, and Thumb-2 through __libc_do_syscall with r12). +static long thumb_bl_target(const unsigned char *data, size_t size, size_t off) { + if (off + 4 > size) return -1; + uint16_t hw1 = rd16(data + off), hw2 = rd16(data + off + 2); + if ((hw1 & 0xf800) != 0xf000 || (hw2 & 0xd000) != 0xd000) return -1; + long s = (hw1 >> 10) & 1; + long imm10 = hw1 & 0x3ff; + long j1 = (hw2 >> 13) & 1, j2 = (hw2 >> 11) & 1; + long imm11 = hw2 & 0x7ff; + long i1 = (j1 ^ s) ^ 1, i2 = (j2 ^ s) ^ 1; + long imm25 = (s << 24) | (i1 << 23) | (i2 << 22) | (imm10 << 12) | (imm11 << 1); + if (s) imm25 -= (1L << 25); + return (long)off + 4 + imm25; +} + +static size_t arm_patch_seccomp_syscalls(unsigned char *data, size_t start, size_t end) { + static const struct { uint32_t movw_r7; uint32_t repl; } arm[] = { + { 0xe3007152u, 0xe320f000u }, // movw r7, #338 (set_robust_list) -> nop + { 0xe30071b3u, 0xe3e00025u }, // movw r7, #435 (clone3) -> mvn r0, #37 + { 0xe300718eu, 0xe3e00025u }, // movw r7, #398 (rseq) -> mvn r0, #37 + }; + static const struct { uint16_t hw1, hw2; int nop_only; } thumb_r7[] = { + { 0xf240, 0x1752, 1 }, // movw r7, #338 + { 0xf240, 0x17b3, 0 }, // movw r7, #435 + { 0xf240, 0x178e, 0 }, // movw r7, #398 + }; + static const struct { uint16_t hw1, hw2; uint16_t repl1, repl2; } thumb_r12[] = { + { 0xf44f, 0x7ca9, 0xf04f, 0x0000 }, // mov.w r12, #338 -> mov.w r0, #0 + { 0xf44f, 0x7cc7, 0xf06f, 0x0025 }, // mov.w r12, #398 -> mvn.w r0, #37 + { 0xf240, 0x1cb3, 0xf06f, 0x0025 }, // movw r12, #435 -> mvn.w r0, #37 + }; + static const unsigned char do_syscall_stub[6] = { 0x80, 0xb5, 0x67, 0x46, 0x00, 0xdf }; + size_t patched = 0; + + size_t a4 = (start + 3) & ~(size_t)3, e4 = end & ~(size_t)3; + for (size_t pos = a4; pos + 4 < e4; pos += 4) { + uint32_t insn = rd32(data + pos); + for (size_t k = 0; k < sizeof(arm) / sizeof(arm[0]); k++) { + if (insn != arm[k].movw_r7) continue; + for (size_t s = pos + 4; s < e4 && s < pos + 68; s += 4) { + if (rd32(data + s) == 0xef000000u) { // svc #0 + wr32(data + s, arm[k].repl); + patched++; + break; + } + } + } + } + + size_t a2 = (start + 1) & ~(size_t)1, e2 = end & ~(size_t)1; + for (size_t t = a2; t + 4 < e2; t += 2) { + uint16_t hw1 = rd16(data + t), hw2 = rd16(data + t + 2); + int matched_r7 = 0; + for (size_t k = 0; k < sizeof(thumb_r7) / sizeof(thumb_r7[0]); k++) { + if (hw1 != thumb_r7[k].hw1 || hw2 != thumb_r7[k].hw2) continue; + matched_r7 = 1; + size_t limit = (e2 - 2 < t + 64 ? e2 - 2 : t + 64) + 2; + for (size_t s = t + 4; s < limit; s += 2) { + if (rd16(data + s) == 0xdf00) { // svc #0 + if (!thumb_r7[k].nop_only) { + wr16(data + t, 0xf06f); // mvn.w r0, #37 in place of the movw + wr16(data + t + 2, 0x0025); + } + wr16(data + s, 0xbf00); // nop + patched++; + break; + } + } + break; + } + if (matched_r7) continue; + for (size_t k = 0; k < sizeof(thumb_r12) / sizeof(thumb_r12[0]); k++) { + if (hw1 != thumb_r12[k].hw1 || hw2 != thumb_r12[k].hw2) continue; + size_t limit = (e2 - 4 < t + 48 ? e2 - 4 : t + 48) + 2; + for (size_t s = t + 4; s < limit; s += 2) { + long target = thumb_bl_target(data, end, s); + if (target >= (long)start && target + 6 <= (long)end && memcmp(data + target, do_syscall_stub, 6) == 0) { + wr16(data + s, thumb_r12[k].repl1); + wr16(data + s + 2, thumb_r12[k].repl2); + patched++; + break; + } + } + break; + } + } + return patched; +} + +#ifndef EM_ARM +#define EM_ARM 40 +#endif +#ifndef EM_AARCH64 +#define EM_AARCH64 183 +#endif + +// Patches the blocked syscalls in data[start, end), code of an ELF for `e_machine`; returns how many. +static size_t patch_seccomp_syscalls(unsigned char *data, size_t start, size_t end, uint16_t e_machine) { + if (!data || end <= start) return 0; + if (e_machine == EM_AARCH64) return a64_patch_seccomp_syscalls(data, start, end); + if (e_machine == EM_ARM) return arm_patch_seccomp_syscalls(data, start, end); + return 0; +} + +// Reads the program headers of an ELF file into `ph` (as 64-bit fields); returns their number, or -1. +struct ddnatv_phdr { uint32_t type, flags; uint64_t offset, filesz; }; +static int read_elf_phdrs(int fd, uint16_t *machine, struct ddnatv_phdr *ph, int max) { + unsigned char eh[64]; + if (pread(fd, eh, sizeof(eh), 0) < 52 || memcmp(eh, "\x7f" "ELF", 4) != 0 || eh[5] != 1) return -1; + int is64 = eh[4] == 2; + uint64_t phoff = is64 ? ((uint64_t)rd32(eh + 32) | ((uint64_t)rd32(eh + 36) << 32)) : rd32(eh + 28); + uint16_t phentsize = rd16(eh + (is64 ? 54 : 42)); + uint16_t phnum = rd16(eh + (is64 ? 56 : 44)); + *machine = rd16(eh + 18); + if (phentsize < (is64 ? 56 : 32) || phnum == 0 || phnum > max) return -1; + for (int i = 0; i < phnum; i++) { + unsigned char e[64]; + if (pread(fd, e, phentsize < sizeof(e) ? phentsize : sizeof(e), (off_t)(phoff + (uint64_t)i * phentsize)) < (is64 ? 56 : 32)) return -1; + ph[i].type = rd32(e); + if (is64) { + ph[i].flags = rd32(e + 4); + ph[i].offset = (uint64_t)rd32(e + 8) | ((uint64_t)rd32(e + 12) << 32); + ph[i].filesz = (uint64_t)rd32(e + 32) | ((uint64_t)rd32(e + 36) << 32); + } else { + ph[i].offset = rd32(e + 4); + ph[i].filesz = rd32(e + 16); + ph[i].flags = rd32(e + 24); + } + } + return phnum; +} + +// Whether the ELF has a Go build-ID note: Go programs make their own system calls and never these. +static int elf_is_go(int fd, const struct ddnatv_phdr *ph, int n) { + for (int i = 0; i < n; i++) { + if (ph[i].type != 4 /* PT_NOTE */ || ph[i].filesz < 16) continue; + unsigned char note[16]; + if (pread(fd, note, sizeof(note), (off_t)ph[i].offset) != sizeof(note)) continue; + if (rd32(note) == 4 && memcmp(note + 12, "Go\0\0", 4) == 0) return 1; + } + return 0; +} + +#define DDNATV_STATIC_XATTR "user.ddnatv.seccomp" +#define DDNATV_STATIC_MAX_CODE (256u * 1024 * 1024) + +#ifdef DDNATV_HAVE_GOSYS +static int prepare_go_program(int fd, const char *path, const struct stat *st); +static uint32_t go_blob_fingerprint(void); +static int go_disabled(void); +#endif + +// What was done to a file is recorded with its size and time, with the rootfs (a Go program carries +// the paths of it) and with the code Go programs are given (go_programs.c): a newer The native userland looks at +// the programs again. +static void static_marker(const struct stat *st, char *buf, size_t size) { + unsigned fingerprint = 0; + const char *off = ""; +#ifdef DDNATV_HAVE_GOSYS + fingerprint = go_blob_fingerprint(); + if (go_disabled()) off = " off"; +#endif + snprintf(buf, size, "3 %lld %lld.%09ld %08x %s%s", (long long)st->st_size, (long long)st->st_mtim.tv_sec, + (long)st->st_mtim.tv_nsec, fingerprint, g_ddnatv_root, off); +} + +// Makes a static program safe to start (see above). Runs before every start of one, so a program +// already handled (marked by an extended attribute that holds its size and modification time) costs +// one fstat and one getxattr; without extended attributes it is scanned again each time. Returns the +// number of patched calls, 0 when there was nothing to do, -1 when the file could not be handled +// (it is then started as it is). +// go_only: leave the file alone unless it is an AArch64 Go program. That is for a program that asks for +// Android's linker (GOOS=android): it is started like the dynamic ones, but it makes its own system +// calls, so it gets the code of the static Go programs (#42). +static int prepare_static_program_ex(const char *path, int go_only) { + int fd = open(path, O_RDONLY | O_CLOEXEC); + if (fd < 0) return -1; + struct stat st; + char marker[PATH_MAX + 96], seen[PATH_MAX + 96]; + if (fstat(fd, &st) != 0 || !S_ISREG(st.st_mode)) { + close(fd); + return -1; + } + static_marker(&st, marker, sizeof(marker)); + ssize_t seen_len = fgetxattr(fd, DDNATV_STATIC_XATTR, seen, sizeof(seen) - 1); + if (seen_len > 0) { + seen[seen_len] = '\0'; + if (strcmp(seen, marker) == 0) { + close(fd); + return 0; + } + } + + struct ddnatv_phdr ph[64]; + uint16_t machine = 0; + int n = read_elf_phdrs(fd, &machine, ph, 64); + if (go_only && !(n >= 0 && machine == EM_AARCH64 && elf_is_go(fd, ph, n))) { + close(fd); + return 0; + } + if (n < 0 || (machine != EM_AARCH64 && machine != EM_ARM) || elf_is_go(fd, ph, n)) { + // A Go program has no C library for the hook to be loaded into: it gets code of its own + int go_rc = 0; +#ifdef DDNATV_HAVE_GOSYS + if (n >= 0 && machine == EM_AARCH64 && elf_is_go(fd, ph, n)) go_rc = prepare_go_program(fd, path, &st); +#endif + if (n >= 0 && go_rc >= 0) { + struct stat after; + if (fstat(fd, &after) == 0) static_marker(&after, marker, sizeof(marker)); + fsetxattr(fd, DDNATV_STATIC_XATTR, marker, strlen(marker), 0); + } + close(fd); + return n < 0 || go_rc < 0 ? -1 : 0; + } + + int total = 0; + int wfd = -1; + int made_writable = 0; + for (int i = 0; i < n; i++) { + if (ph[i].type != 1 /* PT_LOAD */ || !(ph[i].flags & 1 /* PF_X */) || ph[i].filesz == 0) continue; + if (ph[i].filesz > DDNATV_STATIC_MAX_CODE || ph[i].offset > (uint64_t)st.st_size || + ph[i].filesz > (uint64_t)st.st_size - ph[i].offset) continue; + size_t len = (size_t)ph[i].filesz; + unsigned char *code = (unsigned char *)malloc(len); + if (!code) continue; + if (pread(fd, code, len, (off_t)ph[i].offset) != (ssize_t)len) { + free(code); + continue; + } + size_t patched = patch_seccomp_syscalls(code, 0, len, machine); + if (patched > 0) { + if (wfd < 0) { + wfd = open(path, O_WRONLY | O_CLOEXEC); + if (wfd < 0 && errno == EACCES && fchmod(fd, (st.st_mode | S_IWUSR) & 07777) == 0) { + made_writable = 1; + wfd = open(path, O_WRONLY | O_CLOEXEC); + } + } + // ETXTBSY: the program is running right now, so it was handled when it started. + if (wfd < 0 || pwrite(wfd, code, len, (off_t)ph[i].offset) != (ssize_t)len) { + free(code); + total = -1; + break; + } + total += (int)patched; + } + free(code); + } + if (wfd >= 0) { + // Keep the times: make and friends must not see a rebuilt program. + const struct timespec times[2] = { st.st_atim, st.st_mtim }; + futimens(wfd, times); + close(wfd); + } + if (made_writable) fchmod(fd, st.st_mode & 07777); + if (total >= 0) { + struct stat after; + if (fstat(fd, &after) == 0) { + static_marker(&after, marker, sizeof(marker)); + fsetxattr(fd, DDNATV_STATIC_XATTR, marker, strlen(marker), 0); + } + } + close(fd); + return total; +} + +static int prepare_static_program(const char *path) { return prepare_static_program_ex(path, 0); } diff --git a/tools/nativeguest/hook/syscalls.c b/tools/nativeguest/hook/syscalls.c new file mode 100644 index 0000000000..06cacd8646 --- /dev/null +++ b/tools/nativeguest/hook/syscalls.c @@ -0,0 +1,128 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// The system calls that Android's seccomp filter answers with SIGSYS, and which of them the +// SIGSYS handler (signals.c) turns into a fake success. + +static int is_sigsys_synthetic_success_syscall(int sys_nr) { +#if defined(__NR_setuid) + if (sys_nr == __NR_setuid) return 1; +#endif +#if defined(__NR_setuid32) + if (sys_nr == __NR_setuid32) return 1; +#endif +#if defined(__NR_setgid) + if (sys_nr == __NR_setgid) return 1; +#endif +#if defined(__NR_setgid32) + if (sys_nr == __NR_setgid32) return 1; +#endif +#if defined(__NR_setreuid) + if (sys_nr == __NR_setreuid) return 1; +#endif +#if defined(__NR_setreuid32) + if (sys_nr == __NR_setreuid32) return 1; +#endif +#if defined(__NR_setregid) + if (sys_nr == __NR_setregid) return 1; +#endif +#if defined(__NR_setregid32) + if (sys_nr == __NR_setregid32) return 1; +#endif +#if defined(__NR_setresuid) + if (sys_nr == __NR_setresuid) return 1; +#endif +#if defined(__NR_setresuid32) + if (sys_nr == __NR_setresuid32) return 1; +#endif +#if defined(__NR_setresgid) + if (sys_nr == __NR_setresgid) return 1; +#endif +#if defined(__NR_setresgid32) + if (sys_nr == __NR_setresgid32) return 1; +#endif +#if defined(__NR_setfsuid) + if (sys_nr == __NR_setfsuid) return 1; +#endif +#if defined(__NR_setfsuid32) + if (sys_nr == __NR_setfsuid32) return 1; +#endif +#if defined(__NR_setfsgid) + if (sys_nr == __NR_setfsgid) return 1; +#endif +#if defined(__NR_setfsgid32) + if (sys_nr == __NR_setfsgid32) return 1; +#endif +#if defined(__NR_setgroups) + if (sys_nr == __NR_setgroups) return 1; +#endif +#if defined(__NR_setgroups32) + if (sys_nr == __NR_setgroups32) return 1; +#endif +#if defined(__NR_set_robust_list) + if (sys_nr == __NR_set_robust_list) return 1; +#endif +#if defined(__NR_get_robust_list) + if (sys_nr == __NR_get_robust_list) return 1; +#endif + return 0; +} + +static int is_handled_sigsys_syscall(int sys_nr) { + if (is_sigsys_synthetic_success_syscall(sys_nr)) { + return 1; + } + + // Unified Linux 5.1+ syscall numbers across architectures + if (sys_nr >= 424 && sys_nr < 512) { + return 1; + } + + // Architecture-specific syscall numbers guarded per target ABI +#if defined(__aarch64__) + if (sys_nr == 97 /* __NR_unshare */ || + sys_nr == 217 /* __NR_add_key */ || + sys_nr == 218 /* __NR_request_key */ || + sys_nr == 219 /* __NR_keyctl */ || + sys_nr == 268 /* __NR_setns */ || + sys_nr == 277 /* __NR_seccomp */ || + sys_nr == 280 /* __NR_bpf */ || + sys_nr == 293 /* __NR_rseq */) { + return 1; + } +#elif defined(__arm__) + if (sys_nr == 309 /* __NR_add_key */ || + sys_nr == 310 /* __NR_request_key */ || + sys_nr == 311 /* __NR_keyctl */ || + sys_nr == 337 /* __NR_unshare */ || + sys_nr == 375 /* __NR_setns */ || + sys_nr == 383 /* __NR_seccomp */ || + sys_nr == 386 /* __NR_bpf */ || + sys_nr == 398 /* __NR_rseq */) { + return 1; + } +#elif defined(__x86_64__) + if (sys_nr == 248 /* __NR_add_key */ || + sys_nr == 249 /* __NR_request_key */ || + sys_nr == 250 /* __NR_keyctl */ || + sys_nr == 272 /* __NR_unshare */ || + sys_nr == 308 /* __NR_setns */ || + sys_nr == 317 /* __NR_seccomp */ || + sys_nr == 321 /* __NR_bpf */ || + sys_nr == 334 /* __NR_rseq */) { + return 1; + } +#elif defined(__i386__) + if (sys_nr == 286 /* __NR_add_key */ || + sys_nr == 287 /* __NR_request_key */ || + sys_nr == 288 /* __NR_keyctl */ || + sys_nr == 310 /* __NR_unshare */ || + sys_nr == 346 /* __NR_setns */ || + sys_nr == 354 /* __NR_seccomp */ || + sys_nr == 357 /* __NR_bpf */ || + sys_nr == 386 /* __NR_rseq */) { + return 1; + } +#endif + return 0; +} diff --git a/tools/nativeguest/hook/sysv_shm.c b/tools/nativeguest/hook/sysv_shm.c new file mode 100644 index 0000000000..0b43e1fe2c --- /dev/null +++ b/tools/nativeguest/hook/sysv_shm.c @@ -0,0 +1,561 @@ +// Part of libddnatv-hook.so, included by ddnatv-hook.c (one translation unit, so the +// parts share their static functions and are built with the same command as before). +// +// System V shared memory (shmget, shmat, shmdt, shmctl). Android's seccomp filter blocks these system +// calls for apps (the SIGSYS handler turns them into ENOSYS), but X uses them: a program draws an image +// into a segment and the X server reads it from there (the MIT-SHM extension), and Qt, GTK and SDL +// programs expect it. The segments are files of their own in /tmp/.ddnatv-sysv-shm of the rootfs, +// which every process of the app can open and map: +// +// id-N the segment's description: "PID KEY MODE SIZE" (who made it, its key, its rights, its size) +// seg-N its memory (a file of SIZE bytes, mapped MAP_SHARED) +// key-K for a segment with a key: the N it belongs to (K in hex) +// att-N-P process P has the segment attached (made by shmat(), removed by its last shmdt()) +// +// N is chosen at random and claimed with O_EXCL, so processes never pick the same one. IPC_RMID +// removes the files at once: programs that attached the segment keep their mapping (as on Linux), +// later attaches fail, which is what X programs expect (they remove a segment as soon as the X +// server has attached it). A segment nobody removed stays until the session's directory is cleared. + +#ifndef DDNATV_HOST_TEST + +#ifndef MAP_FIXED_NOREPLACE +#define MAP_FIXED_NOREPLACE 0x100000 +#endif +#ifndef SHM_REMAP +#define SHM_REMAP 040000 +#endif + +#define SHM_DIR "/tmp/.ddnatv-sysv-shm" +#define SHM_MAX_ATTACH 512 + +struct shm_meta { + int pid; + long key; + unsigned mode; + size_t size; +}; + +struct shm_attach { + void *addr; + size_t size; + int id; +}; + +static struct shm_attach g_shm_attach[SHM_MAX_ATTACH]; +static pthread_mutex_t g_shm_lock = PTHREAD_MUTEX_INITIALIZER; + +// root + /tmp/.ddnatv-sysv-shm[/name] +static int shm_path(char *out, size_t outsz, const char *name) { + int n = snprintf(out, outsz, "%s%s%s%s", g_ddnatv_root, SHM_DIR, name ? "/" : "", name ? name : ""); + return n > 0 && (size_t)n < outsz ? 0 : -1; +} + +static int shm_open_file(const char *name, int flags, unsigned mode) { + char path[PATH_MAX]; + if (shm_path(path, sizeof(path), name) != 0) return -1; + return (int)syscall(SYS_openat, AT_FDCWD, path, flags | O_CLOEXEC, mode); +} + +static void shm_unlink_file(const char *name) { + char path[PATH_MAX]; + if (shm_path(path, sizeof(path), name) == 0) syscall(SYS_unlinkat, AT_FDCWD, path, 0); +} + +static int shm_ensure_dir(void) { + char path[PATH_MAX]; + if (shm_path(path, sizeof(path), NULL) != 0) return -1; + if (syscall(SYS_mkdirat, AT_FDCWD, path, 0700) == 0 || errno == EEXIST) return 0; + // /tmp of the rootfs missing too (a rootfs being set up) + char tmp[PATH_MAX]; + snprintf(tmp, sizeof(tmp), "%s/tmp", g_ddnatv_root); + syscall(SYS_mkdirat, AT_FDCWD, tmp, 01777); + return (syscall(SYS_mkdirat, AT_FDCWD, path, 0700) == 0 || errno == EEXIST) ? 0 : -1; +} + +static int shm_read_small(const char *name, char *buf, size_t bufsz) { + int fd = shm_open_file(name, O_RDONLY, 0); + if (fd < 0) return -1; + ssize_t n = (ssize_t)syscall(SYS_read, fd, buf, bufsz - 1); + syscall(SYS_close, fd); + if (n < 0) return -1; + buf[n] = '\0'; + return (int)n; +} + +// The description of segment `id`; waits a moment for one being written. 0, or -1 (errno EINVAL). +static int shm_read_meta(int id, struct shm_meta *meta) { + char name[32], text[128]; + snprintf(name, sizeof(name), "id-%d", id); + for (int attempt = 0; attempt < 50; attempt++) { + int n = shm_read_small(name, text, sizeof(text)); + if (n < 0) break; + unsigned long size = 0; + if (n > 0 && sscanf(text, "%d %lx %o %lu", &meta->pid, &meta->key, &meta->mode, &size) == 4) { + meta->size = (size_t)size; + return 0; + } + struct timespec pause = { 0, 1000000 }; + nanosleep(&pause, NULL); + } + errno = EINVAL; + return -1; +} + +static int shm_process_alive(int pid) { + return pid > 0 && (kill(pid, 0) == 0 || errno == EPERM); +} + +static void shm_remove(int id, long key) { + char name[32]; + if (key != IPC_PRIVATE) { + // only when the key still names this segment + char text[32]; + snprintf(name, sizeof(name), "key-%lx", key); + if (shm_read_small(name, text, sizeof(text)) > 0 && atoi(text) == id) shm_unlink_file(name); + } + snprintf(name, sizeof(name), "seg-%d", id); + shm_unlink_file(name); + snprintf(name, sizeof(name), "id-%d", id); + shm_unlink_file(name); +} + +static int shm_mark_attached(int id, int attached) { + char name[48]; + snprintf(name, sizeof(name), "att-%d-%d", id, (int)getpid()); + if (!attached) { + shm_unlink_file(name); + return 0; + } + int fd = shm_open_file(name, O_WRONLY | O_CREAT, 0600); + if (fd < 0) return -1; + syscall(SYS_close, fd); + return 0; +} + +// The collector holds this exclusively while it scans and removes, shmat() shared while it checks a +// segment, maps it and marks itself, so that no segment is collected while it is being attached. +static int shm_lock_dir(int op) { + int fd = shm_open_file(".lock", O_RDWR | O_CREAT, 0600); + if (fd < 0) return -1; + long rc; + do { + rc = syscall(SYS_flock, fd, op); + } while (rc != 0 && errno == EINTR); + if (rc != 0) { + syscall(SYS_close, fd); + return -1; + } + return fd; +} + +static void shm_unlock_dir(int fd) { + if (fd >= 0) syscall(SYS_close, fd); +} + +// Deletes the marks of attached processes that have ended. Every segment stays until IPC_RMID, as on +// Linux: a private one's maker can hand its id to a process that attaches after the maker has ended. +static void shm_collect(void) { + char path[PATH_MAX]; + if (shm_path(path, sizeof(path), NULL) != 0) return; + int lock = shm_lock_dir(LOCK_EX); + if (lock < 0) return; + int dfd = (int)syscall(SYS_openat, AT_FDCWD, path, O_RDONLY | O_DIRECTORY | O_CLOEXEC); + if (dfd < 0) { + shm_unlock_dir(lock); + return; + } + char dents[4096]; + for (;;) { + long n = syscall(SYS_getdents64, dfd, dents, sizeof(dents)); + if (n <= 0) break; + for (long at = 0; at < n;) { + unsigned short reclen; + memcpy(&reclen, dents + at + 16, sizeof(reclen)); + if (reclen == 0) break; + const char *entry = dents + at + 19; + int id = 0, pid = 0; + if (strncmp(entry, "att-", 4) == 0 && sscanf(entry + 4, "%d-%d", &id, &pid) == 2 && !shm_process_alive(pid)) + shm_unlink_file(entry); + at += reclen; + } + } + syscall(SYS_close, dfd); + shm_unlock_dir(lock); +} + +static int shm_create(long key, size_t size, unsigned mode) { + // a different sequence of ids for every call, also within one second and one process + static unsigned calls = 0; + struct timespec now; + clock_gettime(CLOCK_MONOTONIC, &now); + unsigned seed = (unsigned)getpid() * 2654435761u ^ (unsigned)now.tv_nsec ^ (unsigned)now.tv_sec * 40503u ^ + __atomic_add_fetch(&calls, 1, __ATOMIC_RELAXED) * 0x9e3779b9u; + for (int attempt = 0; attempt < 64; attempt++) { + seed = seed * 1103515245u + 12345u; + int id = (int)((seed >> 1) & 0x3fffffff); + if (id == 0) continue; + char name[32]; + snprintf(name, sizeof(name), "id-%d", id); + int meta_fd = shm_open_file(name, O_WRONLY | O_CREAT | O_EXCL, 0600); + if (meta_fd < 0) { + if (errno == EEXIST) continue; + return -1; + } + snprintf(name, sizeof(name), "seg-%d", id); + int seg_fd = shm_open_file(name, O_RDWR | O_CREAT | O_TRUNC, 0600); + long page = sysconf(_SC_PAGESIZE); + if (page <= 0) page = 4096; + if (size > (size_t)INTPTR_MAX - (size_t)page) { + // no file (and no mapping) can be that large + if (seg_fd >= 0) syscall(SYS_close, seg_fd); + syscall(SYS_close, meta_fd); + shm_remove(id, IPC_PRIVATE); + errno = EINVAL; + return -1; + } + size_t rounded = (size + (size_t)page - 1) / (size_t)page * (size_t)page; + if (seg_fd < 0 || ftruncate(seg_fd, (off_t)rounded) != 0) { + int saved = errno; + if (seg_fd >= 0) syscall(SYS_close, seg_fd); + syscall(SYS_close, meta_fd); + shm_remove(id, IPC_PRIVATE); + errno = saved == EFBIG ? EINVAL : (saved ? saved : ENOMEM); + return -1; + } + syscall(SYS_close, seg_fd); + char text[128]; + int len = snprintf(text, sizeof(text), "%d %lx %o %lu\n", getpid(), key, mode & 0777, (unsigned long)size); + ssize_t written = (ssize_t)syscall(SYS_write, meta_fd, text, (size_t)len); + syscall(SYS_close, meta_fd); + if (written != len) { + shm_remove(id, IPC_PRIVATE); + errno = ENOSPC; + return -1; + } + return id; + } + errno = ENOSPC; + return -1; +} + +// Writes `text` to the file `name` at once: into "new-ID" first, then renamed over it (`exclusive`: only +// when `name` does not exist yet, else -1 with EEXIST). Readers see the old file or the whole new one. +static int shm_publish(const char *name, int id, const char *text, size_t len, int exclusive) { + char tmp_name[32], tmp[PATH_MAX], path[PATH_MAX]; + snprintf(tmp_name, sizeof(tmp_name), "new-%d", id); + if (shm_path(tmp, sizeof(tmp), tmp_name) != 0 || shm_path(path, sizeof(path), name) != 0) { + errno = ENAMETOOLONG; + return -1; + } + int fd = (int)syscall(SYS_openat, AT_FDCWD, tmp, O_WRONLY | O_CREAT | O_TRUNC | O_CLOEXEC, 0600); + if (fd < 0) return -1; + ssize_t written = (ssize_t)syscall(SYS_write, fd, text, len); + syscall(SYS_close, fd); + if (written != (ssize_t)len) { + syscall(SYS_unlinkat, AT_FDCWD, tmp, 0); + errno = ENOSPC; + return -1; + } + long rc; + if (exclusive) { + rc = syscall(SYS_renameat2, AT_FDCWD, tmp, AT_FDCWD, path, 1 /* RENAME_NOREPLACE */); + if (rc != 0 && (errno == ENOSYS || errno == EINVAL)) { + // a kernel or file system without RENAME_NOREPLACE: claim the name, then write it + int kfd = (int)syscall(SYS_openat, AT_FDCWD, path, O_WRONLY | O_CREAT | O_EXCL | O_CLOEXEC, 0600); + syscall(SYS_unlinkat, AT_FDCWD, tmp, 0); + if (kfd < 0) return -1; + written = (ssize_t)syscall(SYS_write, kfd, text, len); + syscall(SYS_close, kfd); + if (written == (ssize_t)len) return 0; + syscall(SYS_unlinkat, AT_FDCWD, path, 0); + errno = ENOSPC; + return -1; + } + } else { + rc = syscall(SYS_renameat2, AT_FDCWD, tmp, AT_FDCWD, path, 0); +#ifdef SYS_renameat + if (rc != 0 && errno == ENOSYS) rc = syscall(SYS_renameat, AT_FDCWD, tmp, AT_FDCWD, path); +#endif + } + if (rc != 0) { + int saved = errno; + syscall(SYS_unlinkat, AT_FDCWD, tmp, 0); + errno = saved; + return -1; + } + return 0; +} + +int shmget(key_t key, size_t size, int shmflg) { + init_ddnatv_hook(); + if (g_ddnatv_root[0] == '\0') { + errno = ENOSYS; + return -1; + } + if (shm_ensure_dir() != 0) return -1; + if ((shmflg & IPC_CREAT) || key == IPC_PRIVATE) shm_collect(); + if (key == IPC_PRIVATE) { + if (size == 0) { + errno = EINVAL; + return -1; + } + return shm_create(IPC_PRIVATE, size, (unsigned)shmflg); + } + char key_name[32]; + snprintf(key_name, sizeof(key_name), "key-%lx", (long)key); + for (int attempt = 0; attempt < 8; attempt++) { + char text[32]; + if (shm_read_small(key_name, text, sizeof(text)) > 0) { + int id = atoi(text); + struct shm_meta meta; + if (id > 0 && shm_read_meta(id, &meta) == 0) { + if ((shmflg & IPC_CREAT) && (shmflg & IPC_EXCL)) { + errno = EEXIST; + return -1; + } + if (size > meta.size) { + errno = EINVAL; + return -1; + } + return id; + } + shm_unlink_file(key_name); // names a segment that is gone + } + if (!(shmflg & IPC_CREAT)) { + errno = ENOENT; + return -1; + } + if (size == 0) { + errno = EINVAL; + return -1; + } + int id = shm_create((long)key, size, (unsigned)shmflg); + if (id < 0) return -1; + // The key file appears with its id in it, never empty: written under a name of its own, then + // renamed to the key's name unless another process made the key's segment meanwhile + int len = snprintf(text, sizeof(text), "%d\n", id); + int published = shm_publish(key_name, id, text, (size_t)len, 1); + if (published == 0) return id; + int saved = errno; + shm_remove(id, IPC_PRIVATE); + if (saved != EEXIST) { + errno = saved; + return -1; + } + // another process made the key's segment at the same time: use that one + } + errno = EAGAIN; + return -1; +} + +static void *shmat_locked(int shmid, const void *shmaddr, int shmflg); + +void *shmat(int shmid, const void *shmaddr, int shmflg) { + init_ddnatv_hook(); + // without the lock the collector could remove the segment mid-attach + int lock = g_ddnatv_root[0] != '\0' ? shm_lock_dir(LOCK_SH) : -1; + if (lock < 0) { + errno = EINVAL; + return (void *)-1; + } + void *addr = shmat_locked(shmid, shmaddr, shmflg); + int saved = errno; + shm_unlock_dir(lock); + errno = saved; + return addr; +} + +static int shm_attached_here_locked(int id); + +static void *shmat_locked(int shmid, const void *shmaddr, int shmflg) { + struct shm_meta meta; + if (g_ddnatv_root[0] == '\0' || shm_read_meta(shmid, &meta) != 0) { + errno = EINVAL; + return (void *)-1; + } + int readonly = (shmflg & SHM_RDONLY) != 0; + char name[32]; + snprintf(name, sizeof(name), "seg-%d", shmid); + int fd = shm_open_file(name, readonly ? O_RDONLY : O_RDWR, 0); + if (fd < 0) { + errno = EINVAL; + return (void *)-1; + } + void *want = (void *)shmaddr; + int flags = MAP_SHARED; + if (want) { + if (shmflg & SHM_RND) want = (void *)((uintptr_t)want & ~((uintptr_t)SHMLBA - 1)); + else if ((uintptr_t)want & ((uintptr_t)sysconf(_SC_PAGESIZE) - 1)) { + syscall(SYS_close, fd); + errno = EINVAL; + return (void *)-1; + } + // an address in use is replaced only with SHM_REMAP, as on Linux (MAP_FIXED_NOREPLACE: a kernel + // older than 4.17 takes it as a hint, which the check below catches) + flags |= (shmflg & SHM_REMAP) ? MAP_FIXED : MAP_FIXED_NOREPLACE; + } + // a place in the table first, so that every attach can be detached + int slot = -1; + pthread_mutex_lock(&g_shm_lock); + for (int i = 0; i < SHM_MAX_ATTACH; i++) { + if (!g_shm_attach[i].addr && !g_shm_attach[i].size) { + g_shm_attach[i].size = 1; // reserved + slot = i; + break; + } + } + pthread_mutex_unlock(&g_shm_lock); + if (slot < 0) { + syscall(SYS_close, fd); + errno = EMFILE; + return (void *)-1; + } + void *addr = mmap(want, meta.size, readonly ? PROT_READ : (PROT_READ | PROT_WRITE), flags, fd, 0); + int saved = errno; + syscall(SYS_close, fd); + if (addr != MAP_FAILED && want && addr != want) { + munmap(addr, meta.size); + addr = MAP_FAILED; + saved = EINVAL; + } + pthread_mutex_lock(&g_shm_lock); + // the mark keeps the segment from being collected; without one the attach is undone + if (addr != MAP_FAILED && shm_mark_attached(shmid, 1) != 0) { + saved = errno; + if (shm_attached_here_locked(shmid) == 0) shm_mark_attached(shmid, 0); + munmap(addr, meta.size); + addr = MAP_FAILED; + if (saved != ENOMEM) saved = EINVAL; + } + if (addr == MAP_FAILED) { + g_shm_attach[slot].size = 0; + } else { + g_shm_attach[slot].addr = addr; + g_shm_attach[slot].size = meta.size; + g_shm_attach[slot].id = shmid; + } + pthread_mutex_unlock(&g_shm_lock); + if (addr == MAP_FAILED) { + errno = saved == ENOMEM ? ENOMEM : EINVAL; + return (void *)-1; + } + return addr; +} + +int shmdt(const void *shmaddr) { + pthread_mutex_lock(&g_shm_lock); + for (int i = 0; i < SHM_MAX_ATTACH; i++) { + if (g_shm_attach[i].addr && g_shm_attach[i].addr == shmaddr) { + void *addr = g_shm_attach[i].addr; + size_t size = g_shm_attach[i].size; + int id = g_shm_attach[i].id; + g_shm_attach[i].addr = NULL; + g_shm_attach[i].size = 0; + // counted and unmarked under the lock, so that an attach of this process meanwhile keeps its mark + if (shm_attached_here_locked(id) == 0) shm_mark_attached(id, 0); + pthread_mutex_unlock(&g_shm_lock); + munmap(addr, size); + return 0; + } + } + pthread_mutex_unlock(&g_shm_lock); + errno = EINVAL; + return -1; +} + +static int shm_attached_here_locked(int id) { + int count = 0; + for (int i = 0; i < SHM_MAX_ATTACH; i++) { + if (g_shm_attach[i].addr && g_shm_attach[i].id == id) count++; + } + return count; +} + +static int shm_attached_here(int id) { + int count = 0; + pthread_mutex_lock(&g_shm_lock); + for (int i = 0; i < SHM_MAX_ATTACH; i++) { + if (g_shm_attach[i].addr && g_shm_attach[i].id == id) count++; + } + pthread_mutex_unlock(&g_shm_lock); + return count; +} + +int shmctl(int shmid, int cmd, struct shmid_ds *buf) { + init_ddnatv_hook(); + if (g_ddnatv_root[0] == '\0') { + errno = ENOSYS; + return -1; + } + switch (cmd) { + case IPC_INFO: + case SHM_INFO: + if (buf) { + // the caller's buffer is the structure of the command (struct shminfo or struct shm_info) + memset(buf, 0, cmd == IPC_INFO ? sizeof(struct shminfo) : sizeof(struct shm_info)); + if (cmd == IPC_INFO) { + struct shminfo *info = (struct shminfo *)buf; + info->shmmax = sizeof(unsigned long) > 4 ? (unsigned long)1 << 40 : 0x7fffffffUL; + info->shmmin = 1; + info->shmmni = 4096; + info->shmseg = 4096; + info->shmall = (unsigned long)1 << 30; + } + } + return 0; + case SHM_LOCK: + case SHM_UNLOCK: + return 0; + default: + break; + } + struct shm_meta meta; + if (shm_read_meta(shmid, &meta) != 0) { + errno = EINVAL; + return -1; + } + switch (cmd) { + case IPC_STAT: + case SHM_STAT: + case SHM_STAT_ANY: + if (!buf) { + errno = EFAULT; + return -1; + } + memset(buf, 0, sizeof(*buf)); + buf->shm_perm.__key = (key_t)meta.key; + // The owner's rights for everyone of the app: X compares the uid of its client with the owner's, + // and the two can differ in The native userland (root emulated for one, not the other) + unsigned owner = meta.mode & 0600; + buf->shm_perm.mode = (unsigned short)(owner | (owner >> 3) | (owner >> 6)); + buf->shm_perm.uid = buf->shm_perm.cuid = geteuid(); + buf->shm_perm.gid = buf->shm_perm.cgid = getegid(); + buf->shm_segsz = meta.size; + buf->shm_cpid = meta.pid; + buf->shm_lpid = getpid(); + buf->shm_nattch = (shmatt_t)(shm_attached_here(shmid) + (meta.pid != getpid() ? 1 : 0)); + buf->shm_ctime = time(NULL); + return cmd == IPC_STAT ? 0 : shmid; + case IPC_SET: { + if (!buf) { + errno = EFAULT; + return -1; + } + // the new rights are kept (owner and group stay the app's: there is no other user to give it to) + char name[32], text[128]; + snprintf(name, sizeof(name), "id-%d", shmid); + int len = snprintf(text, sizeof(text), "%d %lx %o %lu\n", meta.pid, meta.key, buf->shm_perm.mode & 0777u, + (unsigned long)meta.size); + return shm_publish(name, shmid, text, (size_t)len, 0) == 0 ? 0 : -1; + } + case IPC_RMID: + shm_remove(shmid, meta.key); + return 0; + default: + errno = EINVAL; + return -1; + } +} + +#endif /* !DDNATV_HOST_TEST */ diff --git a/tools/nativeguest/seccomp-sim.c b/tools/nativeguest/seccomp-sim.c new file mode 100644 index 0000000000..e1b50a09c6 --- /dev/null +++ b/tools/nativeguest/seccomp-sim.c @@ -0,0 +1,92 @@ +// Runs a program under a seccomp filter that answers the system calls Android's app policy blocks +// with SIGSYS, the way a stock app process does, for testing on builds that have no filter: +// seccomp-sim [-a NR,NR...] PROGRAM [ARGS...] +// seccomp-sim -f FILTER PROGRAM [ARGS...] +// -a leaves the listed system calls allowed (to find which one kills a program). -f installs a +// filter as it is (raw struct sock_filter entries), such as the app filter a device's zygote makes. +#define _GNU_SOURCE +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +static const int blocked[] = {99, 100, 97, 217, 218, 219, 268, 277, 280, 293, 143, 144, 145, 146, 147, 149, 151, 152, 159}; + +#define MAX_ALLOWED 64 +#define NBLOCKED (sizeof(blocked) / sizeof(blocked[0])) + +static int run_filter_file(const char *path, char **argv) { + static struct sock_filter filter[BPF_MAXINSNS]; + FILE *f = fopen(path, "rb"); + if (!f) { + perror("seccomp-sim: -f"); + return 2; + } + size_t n = fread(filter, sizeof(filter[0]), BPF_MAXINSNS, f); + int extra = fgetc(f) != EOF; + fclose(f); + if (n == 0 || extra) { + fprintf(stderr, "seccomp-sim: %s holds no filter of at most %d instructions\n", path, BPF_MAXINSNS); + return 2; + } + struct sock_fprog prog = { .len = (unsigned short)n, .filter = filter }; + if (prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0) || prctl(PR_SET_SECCOMP, SECCOMP_MODE_FILTER, &prog)) { + perror("seccomp-sim"); + return 1; + } + execv(argv[0], argv); + perror("seccomp-sim: exec"); + return 127; +} + +int main(int argc, char **argv) { + if (argc > 3 && strcmp(argv[1], "-f") == 0) return run_filter_file(argv[2], argv + 3); + int skip[MAX_ALLOWED], nskip = 0, arg = 1; + if (argc > 3 && strcmp(argv[1], "-a") == 0) { + for (char *p = argv[2];; p++) { + char *end = NULL; + long nr = strtol(p, &end, 10); + if (end == p || (*end != '\0' && *end != ',') || *p < '0' || *p > '9' || + nr < 0 || nr > 1023 || nskip == MAX_ALLOWED) { + fprintf(stderr, "seccomp-sim: -a takes up to %d comma-separated system call numbers, not \"%s\"\n", MAX_ALLOWED, argv[2]); + return 2; + } + skip[nskip++] = (int)nr; + if (*end == '\0') break; + p = end; + } + arg = 3; + } + if (arg >= argc) return 2; + struct sock_filter filter[4 + 2 * MAX_ALLOWED + 2 + 2 * NBLOCKED + 1]; + int n = 0; + filter[n++] = (struct sock_filter)BPF_STMT(BPF_LD | BPF_W | BPF_ABS, offsetof(struct seccomp_data, arch)); + filter[n++] = (struct sock_filter)BPF_JUMP(BPF_JMP | BPF_JEQ | BPF_K, AUDIT_ARCH_AARCH64, 1, 0); + filter[n++] = (struct sock_filter)BPF_STMT(BPF_RET | BPF_K, SECCOMP_RET_ALLOW); + filter[n++] = (struct sock_filter)BPF_STMT(BPF_LD | BPF_W | BPF_ABS, offsetof(struct seccomp_data, nr)); + for (int i = 0; i < nskip; i++) { + filter[n++] = (struct sock_filter)BPF_JUMP(BPF_JMP | BPF_JEQ | BPF_K, skip[i], 0, 1); + filter[n++] = (struct sock_filter)BPF_STMT(BPF_RET | BPF_K, SECCOMP_RET_ALLOW); + } + filter[n++] = (struct sock_filter)BPF_JUMP(BPF_JMP | BPF_JGE | BPF_K, 424, 0, 1); + filter[n++] = (struct sock_filter)BPF_STMT(BPF_RET | BPF_K, SECCOMP_RET_TRAP); + for (size_t i = 0; i < NBLOCKED; i++) { + filter[n++] = (struct sock_filter)BPF_JUMP(BPF_JMP | BPF_JEQ | BPF_K, blocked[i], 0, 1); + filter[n++] = (struct sock_filter)BPF_STMT(BPF_RET | BPF_K, SECCOMP_RET_TRAP); + } + filter[n++] = (struct sock_filter)BPF_STMT(BPF_RET | BPF_K, SECCOMP_RET_ALLOW); + struct sock_fprog prog = { .len = (unsigned short)n, .filter = filter }; + if (prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0) || prctl(PR_SET_SECCOMP, SECCOMP_MODE_FILTER, &prog)) { + perror("seccomp-sim"); + return 1; + } + execv(argv[arg], argv + arg); + perror("seccomp-sim: exec"); + return 127; +} diff --git a/tools/packs/build.sh b/tools/packs/build.sh index 7b7e7e76fd..4ea6a41932 100755 --- a/tools/packs/build.sh +++ b/tools/packs/build.sh @@ -77,6 +77,7 @@ pack tracking "$work/tracking" hand_landmarker.task hand_landmarker_lite.task po pack xbox "$linuxfs/droiddeck-xbox" version xodus-cli xodus-service pack comet "$linuxfs/droiddeck-comet" version comet pack powervr "$repo/app/src/main/assets/hybris" runtime.tzst version.txt +[ ! -f "$linuxfs/droiddeck-ubisoft/droiddeck-upc.exe" ] || pack ubisoft "$linuxfs/droiddeck-ubisoft" droiddeck-upc.exe mkdir "$work/butler" fetch "https://broth.itch.zone/butler/linux-arm64/${BUTLER_VERSION}/archive/default" \ diff --git a/tools/proot/PATCHES.md b/tools/proot/PATCHES.md index ddb3278d7e..c4173a48c7 100644 --- a/tools/proot/PATCHES.md +++ b/tools/proot/PATCHES.md @@ -142,6 +142,26 @@ Prototype (inert unless `PROOT_FASTPATH` is set; see `docs/development/proot-per `statx` (`newfstatat`) and `memfd_create`. Syscalls outside the trampoline and sessions without `PROOT_FASTPATH` are unchanged. `bench/statx-trap.c` traps `statx` and checks an existing directory still reads as one. +- `0026-arm64-kernel-program-layout.patch` - on ARM64, PRoot put its loader at 128 GiB, a PIE + program at 192 GiB and its interpreter at 252 GiB. Android kernels give a process a 39-bit + (512 GiB) address space, so those three split the low half into holes of 64 GiB or less, and a + program that reserves one large contiguous range there could not get it. The Linux kernel loads + a PIE program at two thirds of the address space (`ELF_ET_DYN_BASE`, 0x5555555000 with 39 bits) + and keeps the range below it free; the loader, program and interpreter now sit there too, which + leaves 64 GiB to 336 GiB free as on a native kernel. Switch emulators that run guest code + natively reserve 256 GiB above 64 GiB for guest memory: under PRoot the reservation failed and + the first guest instruction faulted forever. 48-bit address spaces and 32-bit programs are + unchanged in practice. +- `0027-guest-seccomp-sigsys.patch` - PRoot treated every seccomp `SIGSYS` as Android's app policy + refusing a call: it emulated the few it knows and answered the rest with `ENOSYS`, so a filter + the guest installs itself never reached its own handler. Firefox's content sandbox traps + `openat` and opens files through a broker in the parent; every font open came back `ENOSYS`, + and each tab crashed in `gfxFontGroup::GetDefaultFont`. Android's policy traps with + `SECCOMP_RET_DATA` 0, while Firefox's and Chromium's filters tag their traps, so a tagged + `SIGSYS` is now delivered to the guest. A trap from the fast path's trampoline still gets + `ENOSYS`, because its arguments are host paths; the fast path then stops for that process and + repeats the call through a plain `svc`, which the guest's filter traps with the guest path. + `bench/guest-trap.c` installs a tagged `openat` trap and checks its handler answers the call. Old kernel fixes: diff --git a/tools/proot/bench/guest-trap.c b/tools/proot/bench/guest-trap.c new file mode 100644 index 0000000000..ae5a304287 --- /dev/null +++ b/tools/proot/bench/guest-trap.c @@ -0,0 +1,49 @@ +// Run inside a session, with and without the fast path: a seccomp filter the guest installs +// itself must reach its own SIGSYS handler, which answers the trapped openat. +#define _GNU_SOURCE +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#define ANSWER 4242 +static volatile int traps, data; + +static void on_sigsys(int sig, siginfo_t *info, void *context) { + (void)sig; + ucontext_t *uc = context; + traps++; + data = info->si_errno; + uc->uc_mcontext.regs[0] = ANSWER; +} + +int main(void) { + struct sigaction sa; + memset(&sa, 0, sizeof sa); + sa.sa_sigaction = on_sigsys; + sa.sa_flags = SA_SIGINFO; + sigaction(SIGSYS, &sa, NULL); + struct sock_filter code[] = { + BPF_STMT(BPF_LD | BPF_W | BPF_ABS, offsetof(struct seccomp_data, nr)), + BPF_JUMP(BPF_JMP | BPF_JEQ | BPF_K, SYS_openat, 0, 1), + BPF_STMT(BPF_RET | BPF_K, SECCOMP_RET_TRAP | 7), + BPF_STMT(BPF_RET | BPF_K, SECCOMP_RET_ALLOW), + }; + struct sock_fprog filter = {.len = sizeof code / sizeof *code, .filter = code}; + if (prctl(PR_SET_NO_NEW_PRIVS, 1, 0, 0, 0) || prctl(PR_SET_SECCOMP, SECCOMP_MODE_FILTER, &filter, 0, 0)) { + perror("seccomp"); + return 77; + } + int fd = open("/etc/hostname", O_RDONLY); + int err = errno; + printf("open=%d errno=%d traps=%d data=%d\n", fd, fd < 0 ? err : 0, traps, data); + return fd == ANSWER && traps == 1 && data == 7 ? 0 : 1; +} diff --git a/tools/proot/fastpath/fastpath.c b/tools/proot/fastpath/fastpath.c index 5bad6e04ea..8d645eddd2 100644 --- a/tools/proot/fastpath/fastpath.c +++ b/tools/proot/fastpath/fastpath.c @@ -49,7 +49,30 @@ static size_t rootlen; static long long ttl_ns = 2000000000LL; static unsigned long hits, misses; -static long sc(long nr, long a, long b, long c, long d, long e) { return fp_sys(nr, a, b, c, d, e, 0); } +// A seccomp filter the guest installs itself (Firefox's content sandbox) can trap a trampoline +// syscall that the host allows; proot answers those with ENOSYS. The call is then repeated +// through libc, where the guest's own SIGSYS handler sees the guest path, and the process stops +// using the fast path. +static __thread int fp_refused; +static int optional_syscall(long nr) { + return nr == SYS_statx || nr == SYS_memfd_create || nr == SYS_faccessat2 || nr == SYS_close_range || + nr == SYS_openat2 || nr == SYS_renameat2; +} +static long sc(long nr, long a, long b, long c, long d, long e) { + if (fp_refused) return -ENOSYS; + long r = fp_sys(nr, a, b, c, d, e, 0); + if (r == -ENOSYS && !optional_syscall(nr)) { + __atomic_store_n(&fp_on, 0, __ATOMIC_RELAXED); + fp_refused = 1; + } + return r; +} +static inline int refused(void) { + if (!fp_refused) return 0; + fp_refused = 0; + return 1; +} +static inline int answered(long r) { return !refused() && r != FP_SLOW; } static void fp_init(void); static pthread_once_t init_once = PTHREAD_ONCE_INIT; static inline int fp_ready(void) { @@ -788,7 +811,7 @@ static int ret(long r) { if (!real_##name) real_##name = (type)dlsym(RTLD_NEXT, #name) #define ANSWER(r, dirfd, path, real_call) \ - do { long r_ = (r); if (r_ != FP_SLOW) { hits++; return ret(r_); } missed(__func__, dirfd, path); return real_call; } while (0) + do { long r_ = (r); if (answered(r_)) { hits++; return ret(r_); } missed(__func__, dirfd, path); return real_call; } while (0) static long fp_open(int dirfd, const char *path, int flags, mode_t mode) { @@ -805,7 +828,7 @@ static long fp_open(int dirfd, const char *path, int flags, mode_t mode) { static int do_openat(int dirfd, const char *path, int flags, mode_t mode, int (*real)(int, const char *, int, ...)) { long r = fp_open(dirfd, path, flags, mode); - if (r != FP_SLOW) { hits++; return ret(r); } + if (answered(r)) { hits++; return ret(r); } missed(__func__, dirfd, path); return real(dirfd, path, flags, mode); } @@ -870,8 +893,10 @@ int lstat64(const char *p, struct stat64 *st) { return lstat(p, (struct stat *)s int fstat(int fd, struct stat *st) { REAL(fstat, int (*)(int, struct stat *)); if (!fp_ready()) return real_fstat(fd, st); + long r = sc(SYS_fstat, fd, (long)st, 0, 0, 0); + if (!answered(r)) return real_fstat(fd, st); hits++; - return ret(sc(SYS_fstat, fd, (long)st, 0, 0, 0)); + return ret(r); } int fstat64(int fd, struct stat64 *st) { return fstat(fd, (struct stat *)st); } @@ -989,7 +1014,7 @@ static long fp_access(int dirfd, const char *path, int mode, int flags) { static int access_common(int dirfd, const char *path, int mode, int flags) { REAL(faccessat, int (*)(int, const char *, int, int)); long rs = fp_access(dirfd, path, mode, flags); - if (rs != FP_SLOW) { hits++; return ret(rs); } + if (answered(rs)) { hits++; return ret(rs); } missed(__func__, dirfd, path); if (flags == 0) return (int)syscall(SYS_faccessat, dirfd, path, mode); return real_faccessat(dirfd, path, mode, flags); @@ -1087,7 +1112,7 @@ char *canonicalize_file_name(const char *path) { return realpath(path, NULL); } char *getcwd(char *buf, size_t size) { REAL(getcwd, char *(*)(char *, size_t)); char g[PATH_MAX]; - if (!fp_ready() || own_cwd(g) == FP_SLOW) { missed(__func__, AT_FDCWD, "."); return real_getcwd(buf, size); } + if (!fp_ready() || own_cwd(g) == FP_SLOW || refused()) { missed(__func__, AT_FDCWD, "."); return real_getcwd(buf, size); } hits++; size_t need = strlen(g) + 1; if (buf && size == 0) { errno = EINVAL; return NULL; } @@ -1181,7 +1206,7 @@ static long fp_rename(int olddirfd, const char *old, int newdirfd, const char *n static int rename_common(int olddirfd, const char *old, int newdirfd, const char *new, unsigned flags) { REAL(renameat2, int (*)(int, const char *, int, const char *, unsigned)); long rs = fp_rename(olddirfd, old, newdirfd, new, flags); - if (rs != FP_SLOW) { hits++; return ret(rs); } + if (answered(rs)) { hits++; return ret(rs); } missed(__func__, olddirfd, old); if (!flags) return (int)syscall(SYS_renameat, olddirfd, old, newdirfd, new); return real_renameat2(olddirfd, old, newdirfd, new, flags); @@ -1355,7 +1380,7 @@ static long fp_getxattr(const char *path, const char *name, void *value, size_t static ssize_t getxattr_common(const char *path, const char *name, void *value, size_t size, int follow, ssize_t (*real)(const char *, const char *, void *, size_t)) { long rs = fp_getxattr(path, name, value, size, follow); - if (rs != FP_SLOW) { hits++; return rs < 0 ? ret(rs) : rs; } + if (answered(rs)) { hits++; return rs < 0 ? ret(rs) : rs; } missed(__func__, AT_FDCWD, path); return real(path, name, value, size); } @@ -1378,7 +1403,7 @@ static long fp_listxattr(const char *path, char *list, size_t size, int follow) static ssize_t listxattr_common(const char *path, char *list, size_t size, int follow, ssize_t (*real)(const char *, char *, size_t)) { long rs = fp_listxattr(path, list, size, follow); - if (rs != FP_SLOW) { hits++; return rs < 0 ? ret(rs) : rs; } + if (answered(rs)) { hits++; return rs < 0 ? ret(rs) : rs; } missed(__func__, AT_FDCWD, path); return real(path, list, size); } @@ -1581,6 +1606,7 @@ static int accept_common(int fd, struct sockaddr *addr, socklen_t *len, int flag struct sockaddr_storage got; socklen_t got_len = sizeof got; long r = sc(SYS_accept4, fd, addr ? (long)&got : 0, addr ? (long)&got_len : 0, flags, 0); + if (refused()) return real_accept4(fd, addr, len, flags); if (r >= 0) inherit_long_name(fd, (int)r); if (!addr) return ret(r); if (r >= 0) report_address((int)r, LONG_PEER, &got, got_len, addr, len); @@ -1595,6 +1621,7 @@ static int name_common(long nr, int fd, struct sockaddr *addr, socklen_t *len, i struct sockaddr_storage got; socklen_t got_len = sizeof got; long r = sc(nr, fd, (long)&got, (long)&got_len, 0, 0); + if (refused()) return real(fd, addr, len); if (r == 0) report_address(fd, nr == SYS_getsockname ? LONG_SELF : LONG_PEER, &got, got_len, addr, len); return ret(r); } @@ -1687,7 +1714,7 @@ static int online_cpus(void) { int get_nprocs(void) { REAL(get_nprocs, int (*)(void)); int n = fp_ready() ? online_cpus() : -1; - if (n > 0) { hits++; return n; } + if (n > 0 && !refused()) { hits++; return n; } missed(__func__, AT_FDCWD, "(nprocs)"); return real_get_nprocs(); } @@ -1743,6 +1770,7 @@ int isatty(int fd) { if (!fp_ready()) return real_isatty(fd); hits++; long r = sc(SYS_ioctl, fd, TCGETS, (long)&k, 0, 0); + if (refused()) return real_isatty(fd); if (r < 0) { errno = (int)-r; return 0; } return r == 0; } diff --git a/tools/proot/fastpath/svc-patch.h b/tools/proot/fastpath/svc-patch.h index 6d19da3156..09cb014089 100644 --- a/tools/proot/fastpath/svc-patch.h +++ b/tools/proot/fastpath/svc-patch.h @@ -74,11 +74,14 @@ long fp_svc_dispatch(const long *r) { int saved_errno = errno; long result = svc_blocked(r); uintptr_t frame = (uintptr_t)r; - if (result == FP_SLOW && (!svc_busy || frame >= svc_busy)) { + if (result == FP_SLOW && __atomic_load_n(&fp_on, __ATOMIC_RELAXED) && (!svc_busy || frame >= svc_busy)) { uintptr_t previous = svc_busy; svc_busy = frame; - if (svc_stack_room(frame)) { result = svc_path_call(r); svc_busy = 0; } - else svc_busy = previous; + if (svc_stack_room(frame)) { + result = svc_path_call(r); + if (refused()) result = FP_SLOW; + svc_busy = 0; + } else svc_busy = previous; } if (result == FP_SLOW) { __atomic_fetch_add(&svc_slow, 1, __ATOMIC_RELAXED); diff --git a/tools/proot/patches/0026-arm64-kernel-program-layout.patch b/tools/proot/patches/0026-arm64-kernel-program-layout.patch new file mode 100644 index 0000000000..57e05e452d --- /dev/null +++ b/tools/proot/patches/0026-arm64-kernel-program-layout.patch @@ -0,0 +1,17 @@ +diff --git a/src/arch.h b/src/arch.h +index 06b7f1b..db129a9 100644 +--- a/src/arch.h ++++ b/src/arch.h +@@ -135,9 +135,9 @@ typedef unsigned char byte_t; + #define OFFSETOF_STAT_UID_32 24 + #define OFFSETOF_STAT_GID_32 28 + +- #define LOADER_ADDRESS 0x2000000000 +- #define EXEC_PIC_ADDRESS 0x3000000000 +- #define INTERP_PIC_ADDRESS 0x3f00000000 ++ #define LOADER_ADDRESS 0x5400000000 ++ #define EXEC_PIC_ADDRESS 0x5555000000 ++ #define INTERP_PIC_ADDRESS 0x5f00000000 + #define HAS_POKEDATA_WORKAROUND true + + #define HAS_LOADER_32BIT true diff --git a/tools/proot/patches/0027-guest-seccomp-sigsys.patch b/tools/proot/patches/0027-guest-seccomp-sigsys.patch new file mode 100644 index 0000000000..73e7c3ce14 --- /dev/null +++ b/tools/proot/patches/0027-guest-seccomp-sigsys.patch @@ -0,0 +1,59 @@ +From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001 +From: Kurt Himebauch +Date: Mon, 9 Nov 2026 15:30:00 -0500 +Subject: [PATCH] seccomp: hand a guest filter's own SIGSYS back to the guest + +--- +--- a/src/tracee/seccomp.h ++++ b/src/tracee/seccomp.h +@@ -1,3 +1,4 @@ ++#include + #include "tracee/tracee.h" + #include "sys/vfs.h" + +@@ -18,5 +19,5 @@ + + void restart_syscall_after_seccomp(Tracee* tracee); + void set_result_after_seccomp(Tracee *tracee, word_t result); +-int handle_seccomp_event(Tracee* tracee); ++int handle_seccomp_event(Tracee* tracee, const siginfo_t *siginfo); + void fix_and_restart_enosys_syscall(Tracee* tracee); +--- a/src/tracee/seccomp.c ++++ b/src/tracee/seccomp.c +@@ -68,7 +68,7 @@ + * + * Return 0 to swallow signal or SIGSYS to deliver it to process. + */ +-int handle_seccomp_event(Tracee* tracee) ++int handle_seccomp_event(Tracee* tracee, const siginfo_t *siginfo) + { + int ret; + +@@ -100,6 +100,16 @@ + + print_current_regs(tracee, 3, "seccomp SIGSYS"); + ++ /* Android's app policy traps with SECCOMP_RET_DATA 0. A filter the guest ++ * installed itself (Firefox's and Chromium's sandboxes) tags its traps, and ++ * its own SIGSYS handler answers them, usually through a broker process. ++ * A trap from the fast path's trampoline still gets ENOSYS: its arguments ++ * are host paths, and the fast path repeats the call through libc. */ ++ if (siginfo->si_errno != 0 && !from_fastpath_stub(tracee)) { ++ VERBOSE(tracee, 4, "SIGSYS from the guest's own seccomp filter (data %d)", siginfo->si_errno); ++ return SIGSYS; ++ } ++ + return handle_seccomp_event_common(tracee); + } + +--- a/src/tracee/event.c ++++ b/src/tracee/event.c +@@ -676,7 +676,7 @@ + tracee->skip_next_seccomp_signal = false; + signal = 0; + } else { +- signal = handle_seccomp_event(tracee); ++ signal = handle_seccomp_event(tracee, &siginfo); + } + } else { + VERBOSE(tracee, 1, "non-seccomp SIGSYS"); diff --git a/tools/quest/build-driver.py b/tools/quest/build-driver.py index 43c7c5a3be..b11ec27d6d 100644 --- a/tools/quest/build-driver.py +++ b/tools/quest/build-driver.py @@ -7,6 +7,9 @@ import sys import tarfile import tempfile import hashlib +import http.client +import time +import urllib.error import urllib.request import zipfile @@ -32,11 +35,23 @@ def pack(entries, output): print(output) +def download(url, attempts=4): + for attempt in range(1, attempts + 1): + try: + with urllib.request.urlopen(url, timeout=120) as response: + return response.read() + except (OSError, http.client.HTTPException) as error: + if attempt == attempts or isinstance(error, urllib.error.HTTPError) and error.code < 500 and error.code != 429: + raise + print(f'Download failed ({error}); retrying in {attempt * 15} s') + time.sleep(attempt * 15) + + def build_a6xx(ndk, output_dir=OUTPUT.parent, archive_path=None): cached = archive_path or ROOT / 'app/build/quest-inputs' / f'Turnip-{A6XX_TAG}.zip' if not cached.exists(): cached.parent.mkdir(parents=True, exist_ok=True) - data = urllib.request.urlopen(A6XX_URL, timeout=120).read() + data = download(A6XX_URL) if hashlib.sha256(data).hexdigest() != A6XX_SHA256: raise ValueError('A6xx archive checksum mismatch') cached.write_bytes(data) diff --git a/tools/release/pr_discord.py b/tools/release/pr_discord.py index b577df247b..77a576208e 100644 --- a/tools/release/pr_discord.py +++ b/tools/release/pr_discord.py @@ -101,23 +101,31 @@ def description_excerpt(body): return "" -def build_content(repo, number, title, sha, apk, release, description=None): +def commit_subject(message): + subject = (message or "").splitlines()[0].strip() if message else "" + return plain_title(subject[:300]) + + +def build_content(repo, number, title, sha, apk, release, description=None, commit_message=None): excerpt = description_excerpt(description) + subject = commit_subject(commit_message) return (f"**Signed test build** `pr-{number}` · `{sha[:7]}`\n" f"[#{number}](https://github.com/{repo}/pull/{number}): {plain_title(title)}\n" + + (f"Latest commit: {subject}\n" if subject else "") + (f"\n{excerpt}\n\n" if excerpt else "") + "_Not merged — for testing._\n" f"In the app: **Updates → Test builds → #{number}**\n" f"Download: [standard APK](<{apk}>) · [all variants](<{release}>)") -def retired_content(content, merged): - label = "Merged" if merged else "Closed" - if content.startswith(("**Merged** —", "**Closed** —")): +def retired_content(content, merged=False, superseded_by=None): + label = f"Superseded by `{superseded_by[:7]}`" if superseded_by else ("Merged" if merged else "Closed") + if content.startswith(("**Merged** —", "**Closed** —", "**Superseded by `")): content = "\n".join(line[2:-2] if line.startswith("~~") and line.endswith("~~") else line for line in content.splitlines()[2:]) struck = "\n".join(f"~~{line}~~" if line else "" for line in content.splitlines()) - return f"**{label}** — this test build is no longer available.\n\n{struck}" + note = "This test build has been replaced." if superseded_by else "This test build is no longer available." + return f"**{label}** — {note}\n\n{struck}" def sync(mode, repo, number, discord, sha="", apk="", release=""): @@ -136,6 +144,11 @@ def sync(mode, repo, number, discord, sha="", apk="", release=""): return raise RuntimeError("Signed build report comment is missing") message_id = saved_message(comment["body"], discord.id) + state_match = STATE.search(comment["body"]) + try: + old_state = json.loads(state_match.group(1)) if state_match else {} + except ValueError: + old_state = {} if mode == "retire": if message_id: message = discord.request("GET", f"/messages/{message_id}") @@ -144,16 +157,41 @@ def sync(mode, repo, number, discord, sha="", apk="", release=""): {"content": retired_content(message["content"], pull.get("merged", False)), "allowed_mentions": {"parse": []}, "flags": 4}) return - content = build_content(repo, number, pull["title"], sha, apk, release, pull.get("body")) + try: + commit = github(f"repos/{repo}/commits/{sha}") or {} + except RuntimeError: + commit = {} + commit_message = (commit.get("commit") or {}).get("message", "") + content = build_content(repo, number, pull["title"], sha, apk, release, pull.get("body"), commit_message) if len(content) > 1800: raise RuntimeError("Discord announcement is too long") payload = {"content": content, "allowed_mentions": {"parse": []}, "flags": 4} - message = discord.request("PATCH", f"/messages/{message_id}", payload) if message_id else None + old_message = None + previous_sha = old_state.get("sha") + if message_id and not previous_sha: + old_message = discord.request("GET", f"/messages/{message_id}") + if old_message: + match = re.search(r"`([0-9a-f]{7})`", old_message.get("content", "")) + previous_sha = match.group(1) if match else None + if message_id and (previous_sha == sha or previous_sha == sha[:7]): + message = discord.request("PATCH", f"/messages/{message_id}", payload) + else: + if message_id and old_state.get("sha"): + previous = discord.request("GET", f"/messages/{message_id}") + if previous: + discord.request("PATCH", f"/messages/{message_id}", + {"content": retired_content(previous["content"], superseded_by=sha), + "allowed_mentions": {"parse": []}, "flags": 4}) + elif message_id and old_message: + discord.request("PATCH", f"/messages/{message_id}", + {"content": retired_content(old_message["content"], superseded_by=sha), + "allowed_mentions": {"parse": []}, "flags": 4}) + message = None if message is None: message = discord.request("POST", "?wait=true", payload) if message is None: raise RuntimeError("Discord webhook no longer exists") - state = {"webhook_id": discord.id, "message_id": message["id"]} + state = {"webhook_id": discord.id, "message_id": message["id"], "sha": sha} latest = github(f"repos/{repo}/issues/comments/{comment['id']}") body = STATE.sub("", latest["body"]).rstrip() + f"\n" github(f"repos/{repo}/issues/comments/{comment['id']}", "PATCH", {"body": body}) diff --git a/tools/release/runtime_inputs.py b/tools/release/runtime_inputs.py index 806c49f79e..57fe792465 100644 --- a/tools/release/runtime_inputs.py +++ b/tools/release/runtime_inputs.py @@ -14,15 +14,16 @@ ROOT = Path(__file__).resolve().parents[2] MANIFEST = Path('app/build/runtime-inputs.json') PACKS = Path('app/build/packs') PACKED = {'assets/linuxfs/usr/local/lib/droiddeck-xbox/': 'xbox', 'assets/linuxfs/usr/local/lib/droiddeck-comet/': 'comet', + 'assets/linuxfs/usr/local/lib/droiddeck-ubisoft/': 'ubisoft', 'assets/directaudio/': 'directaudio', 'assets/hybris/': 'powervr'} PACKED_FILES = {'lib/arm64-v8a/libproot.so': ('proot', 'libproot.so'), 'lib/arm64-v8a/libproot-loader.so': ('proot', 'libproot-loader.so')} PACKED_LIBRARIES = ['lib/arm64-v8a/libopencv_java4.so', 'lib/arm64-v8a/libmediapipe_tasks_jni.so'] -PACK_NAMES = ['proot', 'directaudio', 'tracking', 'xbox', 'comet', 'butler', 'powervr'] +PACK_NAMES = ['proot', 'directaudio', 'tracking', 'xbox', 'comet', 'butler', 'powervr', 'ubisoft'] SOURCE_PATHS = ['app/build.gradle', 'app/src/main/cpp/fakeinput_steam.cpp', 'app/src/main/assets/pulseaudio.tzst', 'tools/linuxfs', 'tools/proot', 'tools/aaudio-sink', 'tools/directaudio', 'tools/packs', 'tools/gamescope/release.env', 'tools/droiddeck-esync/release.env', - 'tools/mangoapp', 'tools/msitools', 'tools/pipewire', 'tools/comet', 'tools/xbox', 'tools/dirt-ws2', 'tools/components', 'tools/ci', 'tools/build_local.sh', + 'tools/mangoapp', 'tools/msitools', 'tools/pipewire', 'tools/comet', 'tools/xbox', 'tools/dirt-ws2', 'tools/ubisoft-launcher', 'tools/components', 'tools/ci', 'tools/build_local.sh', 'tools/powervr', 'tools/hybris', 'tools/dxvk', 'tools/vulkan-wsi', 'tools/release/runtime_inputs.py', 'app/src/main/assets/desktop-removal', 'tools/quest', 'tools/vr/src', 'tools/vr/driver_droiddeck', 'tools/vr/layer', 'tools/vr/build.sh', @@ -76,7 +77,7 @@ def required(): paths += [f'assets/graphics_driver/adrenotools-{name}.tzst' for name in ['turnip26.3.0-a6xx', 'turnip26.3.0-quest2']] paths += ['assets/linuxfs/' + name for name in ['libfakeinput.so', 'libblsession.so', - 'libblfastpath.so', 'libssbs.so', 'usr/local/bin/droiddeck-clipboard', + 'libblfastpath.so', 'libddnatv-hook.so', 'libssbs.so', 'usr/local/bin/droiddeck-clipboard', 'usr/local/bin/droiddeck-gog-maintenance', 'usr/local/bin/gamescope', 'usr/local/lib/droiddeck/uruntime', 'usr/local/lib/droiddeck-pipewire.tzst']] @@ -211,7 +212,8 @@ def pack_digests(root, name): def check_apk(apk, root=ROOT): data = verify(root) - packs = {name: pack_digests(root, name) for name in PACK_NAMES} + packs = {name: pack_digests(root, name) for name in PACK_NAMES + if name != 'ubisoft' or (root / PACKS / 'ubisoft.tar.zst').is_file()} with ZipFile(apk) as package: names = set(package.namelist()) for library in PACKED_LIBRARIES: @@ -231,7 +233,7 @@ def check_apk(apk, root=ROOT): if prefix: if name in names: raise ValueError('APK still carries ' + name + ', which the ' + PACKED[prefix] + ' pack provides') - if packs[PACKED[prefix]].get(name[len(prefix):]) != output['sha256']: + if packs.get(PACKED[prefix], {}).get(name[len(prefix):]) != output['sha256']: raise ValueError('Add-on pack ' + PACKED[prefix] + ' is missing or has a stale ' + name) continue try: diff --git a/tools/release/validate_apk.py b/tools/release/validate_apk.py index 3ff90c2e27..1e7e31f960 100644 --- a/tools/release/validate_apk.py +++ b/tools/release/validate_apk.py @@ -63,6 +63,10 @@ def main(): expected = run["head_sha"] if run["event"] == "pull_request": prs = api(f"repos/{repo}/commits/{expected}/pulls") + owner = (run.get("head_repository") or {}).get("owner", {}).get("login") + if not prs and owner and run.get("head_branch"): + query = urlencode({"state": "open", "head": f"{owner}:{run['head_branch']}"}) + prs = api(f"repos/{repo}/pulls?{query}") pr_number = next((pr["number"] for pr in prs if pr["state"] == "open" and pr["head"]["sha"] == expected), None) if pr_number is None: diff --git a/tools/release/virustotal-scan.sh b/tools/release/virustotal-scan.sh new file mode 100755 index 0000000000..8138a428ae --- /dev/null +++ b/tools/release/virustotal-scan.sh @@ -0,0 +1,89 @@ +#!/usr/bin/env bash +# Usage: virustotal-scan.sh ... +# Scans each file on VirusTotal and writes the verdicts to $GITHUB_STEP_SUMMARY. +# Exits 1 when an engine flags a file and FAIL_ON_DETECTION=1. +set -euo pipefail + +API=${VT_API:-https://www.virustotal.com/api/v3} +: "${VT_API_KEY:?VT_API_KEY is not set}" +POLL_SECONDS=${POLL_SECONDS:-30} +TIMEOUT_SECONDS=${TIMEOUT_SECONDS:-1200} +SUMMARY=${GITHUB_STEP_SUMMARY:-/dev/stdout} + +vt() { + curl -sS --fail-with-body --retry 5 --retry-delay 20 --retry-all-errors \ + -H "x-apikey: $VT_API_KEY" "$@" +} + +# Workflow commands end at a newline and decode %XX sequences. +warn() { + local message=$1 + message=${message//'%'/'%25'} + message=${message//$'\r'/'%0D'} + message=${message//$'\n'/'%0A'} + printf '::warning title=VirusTotal::%s\n' "$message" +} + +# The free API allows 4 requests a minute; poll slowly. +wait_for_analysis() { + local id=$1 waited=0 status + while :; do + status=$(vt "$API/analyses/$id" | jq -r .data.attributes.status) + [ "$status" = completed ] && return 0 + [ "$waited" -ge "$TIMEOUT_SECONDS" ] && return 1 + sleep "$POLL_SECONDS" + waited=$((waited + POLL_SECONDS)) + done +} + +flagged_total=0 +{ + echo "### VirusTotal" + echo + echo "| File | Flagged | Engines | Detections |" + echo "| --- | --- | --- | --- |" +} >> "$SUMMARY" + +for file in "$@"; do + name=$(basename "$file") + sha=$(sha256sum "$file" | cut -d' ' -f1) + link="https://www.virustotal.com/gui/file/$sha" + + known=$(curl -sS --retry 5 --retry-delay 20 -o /dev/null -w '%{http_code}' \ + -H "x-apikey: $VT_API_KEY" "$API/files/$sha") + if [ "$known" != 200 ] && [ "$known" != 404 ]; then + echo "::error title=VirusTotal::hash lookup for $name returned HTTP $known" + exit 1 + fi + if [ "$known" = 404 ]; then + # Files over 32 MB need a one-time upload URL. + url=$(vt "$API/files/upload_url" | jq -r .data) + id=$(vt -X POST -F "file=@$file" "$url" | jq -r .data.id) + echo "uploaded $name ($sha), analysis $id" + if ! wait_for_analysis "$id"; then + warn "$name was still being analysed after ${TIMEOUT_SECONDS}s: $link" + echo "| [$name]($link) | pending | | |" >> "$SUMMARY" + continue + fi + fi + + report=$(vt "$API/files/$sha") + malicious=$(jq -r '.data.attributes.last_analysis_stats.malicious // 0' <<<"$report") + suspicious=$(jq -r '.data.attributes.last_analysis_stats.suspicious // 0' <<<"$report") + engines=$(jq -r '[(.data.attributes.last_analysis_stats // {})[]] | add // 0' <<<"$report") + detections=$(jq -r '[(.data.attributes.last_analysis_results // {})[] + | select(.category == "malicious" or .category == "suspicious") + | "\(.engine_name): \(.result)"] | join("
")' <<<"$report") + flagged=$((malicious + suspicious)) + flagged_total=$((flagged_total + flagged)) + echo "$name: $flagged/$engines flagged $link" + echo "| [$name]($link) | $flagged | $engines | ${detections:-none} |" >> "$SUMMARY" + if [ "$flagged" -gt 0 ]; then + warn "$name flagged by $flagged/$engines engines: ${detections//
/, } $link" + fi +done + +if [ "$flagged_total" -gt 0 ] && [ "${FAIL_ON_DETECTION:-0}" = 1 ]; then + echo "::error::VirusTotal flagged the release" + exit 1 +fi diff --git a/tools/tests/test_appimage_run.py b/tools/tests/test_appimage_run.py index 5e0c5dd658..14ac8ad676 100644 --- a/tools/tests/test_appimage_run.py +++ b/tools/tests/test_appimage_run.py @@ -6,7 +6,7 @@ import unittest from pathlib import Path RUN = Path(__file__).resolve().parents[1] / "linuxfs/overlay/usr/local/bin/droiddeck-appimage-run" -KEYS = ("QT_QPA_PLATFORM", "WAYLAND_DISPLAY", "SDL_VIDEODRIVER", "XDG_SESSION_TYPE", "QT_WAYLAND_DISABLE_WINDOWDECORATION", "DISABLE_GAMESCOPE_WSI") +KEYS = ("TU_DEBUG", "DROIDDECK_GAME_TU_DEBUG", "QT_QPA_PLATFORM", "WAYLAND_DISPLAY", "SDL_VIDEODRIVER", "XDG_SESSION_TYPE", "QT_WAYLAND_DISABLE_WINDOWDECORATION", "DISABLE_GAMESCOPE_WSI") QUICK = ("usr/lib/libQt6Quick.so.6", "usr/lib/libvulkan.so.1", "usr/plugins/platforms/libqwayland-generic.so") RUN_MODE = {"GAMESCOPE_WAYLAND_DISPLAY": "gamescope-0", "WAYLAND_DISPLAY": "gamescope-0", "DISPLAY": ":0", "QT_QPA_PLATFORM": "xcb", "SDL_VIDEODRIVER": "x11", "XDG_SESSION_TYPE": "x11"} @@ -128,5 +128,24 @@ class AppImageRunTest(unittest.TestCase): self.assertEqual("wayland;xcb", env["QT_QPA_PLATFORM"]) + def test_a_program_drops_the_sessions_sysmem_like_a_steam_game(self): + env, _ = self.launch(dict(RUN_MODE, TU_DEBUG="sysmem", DROIDDECK_GAME_TU_DEBUG="")) + self.assertEqual("unset", env["TU_DEBUG"]) + self.assertEqual("unset", env["DROIDDECK_GAME_TU_DEBUG"]) + + def test_a_program_gets_the_game_driver_setting(self): + env, _ = self.launch(dict(RUN_MODE, TU_DEBUG="sysmem", DROIDDECK_GAME_TU_DEBUG="gmem")) + self.assertEqual("gmem", env["TU_DEBUG"]) + + def test_a_chromium_app_keeps_the_session_setting(self): + self.bundle("chrome_100_percent.pak") + env, _ = self.launch(dict(RUN_MODE, TU_DEBUG="sysmem", DROIDDECK_GAME_TU_DEBUG="")) + self.assertEqual("sysmem", env["TU_DEBUG"]) + + def test_without_the_game_setting_the_session_value_stays(self): + env, _ = self.launch(dict(RUN_MODE, TU_DEBUG="sysmem")) + self.assertEqual("sysmem", env["TU_DEBUG"]) + + if __name__ == "__main__": unittest.main() diff --git a/tools/tests/test_binfmt_preload.py b/tools/tests/test_binfmt_preload.py index 8314d39e40..9966b28505 100644 --- a/tools/tests/test_binfmt_preload.py +++ b/tools/tests/test_binfmt_preload.py @@ -22,22 +22,29 @@ extern char **environ; int main(int argc, char **argv) { if (argc < 3) return 2; const char *how = argv[1], *file = argv[2]; + char *node_env[] = {"ELECTRON_RUN_AS_NODE=1", NULL}; + char *const *child_env = !strcmp(how, "execve-node") || !strcmp(how, "execvpe-node") || + !strcmp(how, "spawn-node") || !strcmp(how, "spawnp-node") ? node_env : environ; char **args = argv + 2; if (!strcmp(how, "access")) { int result = access(file, X_OK); printf("access %d %d\n", result, result ? errno : 0); return 0; } - if (!strcmp(how, "spawn") || !strcmp(how, "spawnp")) { + if (!strcmp(how, "spawn") || !strcmp(how, "spawnp") || !strcmp(how, "spawn-node") || + !strcmp(how, "spawnp-node")) { pid_t pid; - int error = how[5] ? posix_spawnp(&pid, file, NULL, NULL, args, environ) : posix_spawn(&pid, file, NULL, NULL, args, environ); + int spawnp = !strcmp(how, "spawnp") || !strcmp(how, "spawnp-node"); + int error = spawnp ? posix_spawnp(&pid, file, NULL, NULL, args, child_env) + : posix_spawn(&pid, file, NULL, NULL, args, child_env); if (error) { printf("errno %d\n", error); return 3; } int status; waitpid(pid, &status, 0); printf("exit %d\n", WEXITSTATUS(status)); return 0; } - if (!strcmp(how, "execve")) execve(file, args, environ); + if (!strcmp(how, "execve") || !strcmp(how, "execve-node")) execve(file, args, (char *const *)child_env); + else if (!strcmp(how, "execvpe-node")) execvpe(file, args, (char *const *)child_env); else if (!strcmp(how, "execv")) execv(file, args); else if (!strcmp(how, "execvp")) execvp(file, args); else if (!strcmp(how, "execvpe")) execvpe(file, args, environ); @@ -88,6 +95,15 @@ class BinfmtPreloadTest(unittest.TestCase): path.chmod(mode) return path + def chromium_script(self): + folder = self.dir / "vscode" + folder.mkdir() + executable = folder / "code" + executable.write_text("#!/bin/sh\nprintf '%s\\n' \"$@\"\n") + executable.chmod(0o755) + (folder / "chrome-sandbox").touch() + return executable + def environment(self, desktop=True, **extra): env = {"PATH": "%s:/usr/bin:/bin" % self.dir, "LD_PRELOAD": str(self.library), "HANDLER_LOG": str(self.log)} if desktop: @@ -161,6 +177,17 @@ class BinfmtPreloadTest(unittest.TestCase): self.file("script.sh", b"#!/bin/sh\nexit 5\n") self.assertEqual(self.run_program("spawnp", "script.sh"), (0, "exit 5", None)) + def test_explicit_node_child_environment_skips_injection_for_execve_and_spawn(self): + code = self.chromium_script() + self.assertEqual(self.run_program("execve-node", code, "--version"), (0, "--version", None)) + self.assertEqual(self.run_program("execvpe-node", code, "--version"), (0, "--version", None)) + self.assertEqual(self.run_program("spawn-node", code, "--version"), (0, "--version\nexit 0", None)) + self.assertEqual(self.run_program("spawnp-node", code, "--version"), (0, "--version\nexit 0", None)) + + def test_chromium_gui_launch_without_node_mode_still_receives_no_sandbox(self): + code = self.chromium_script() + self.assertEqual(self.run_program("execve", code, "--version"), (0, "--no-sandbox\n--version", None)) + def test_the_hand_off_switch_works_without_the_desktop(self): tool = self.x86() for how in ("execve", "execvp"): diff --git a/tools/tests/test_ci_checks.py b/tools/tests/test_ci_checks.py index f2e258a020..125dba0398 100644 --- a/tools/tests/test_ci_checks.py +++ b/tools/tests/test_ci_checks.py @@ -58,11 +58,17 @@ class CiChecksTest(unittest.TestCase): with tempfile.TemporaryDirectory() as directory: root = Path(directory) sudo = root / 'sudo' - sudo.write_text('#!/bin/bash\nprintf "%s\\n" "$*" >> "$APT_LOG"\nexit "${APT_RESULT:-0}"\n') + sudo.write_text('#!/bin/bash\nprintf "%s\\n" "$*" >> "$APT_LOG"\n' + 'for arg; do case "$arg" in Dir::Etc::sourcelist=*) ' + 'grep -h "^URIs:" "${arg#*=}" >> "$APT_LOG.mirrors";; esac; done\n' + 'exit "${APT_RESULT:-0}"\n') sudo.chmod(0o755) query = root / 'dpkg-query' query.write_text('#!/bin/sh\nexit 1\n') query.chmod(0o755) + dpkg = root / 'dpkg' + dpkg.write_text('#!/bin/sh\necho "${DPKG_ARCH:-amd64}"\n') + dpkg.chmod(0o755) log = root / 'apt.log' sources = root / 'ubuntu.sources' sources.write_text('URIs: http://mirror.invalid/ubuntu\n') @@ -71,8 +77,23 @@ class CiChecksTest(unittest.TestCase): installer = ROOT / 'tools/ci/install-ubuntu-packages.sh' result = subprocess.run(['bash', str(installer), 'qemu-user'], env=dict(env, APT_RESULT='17')) self.assertEqual(result.returncode, 17) - self.assertEqual(len(log.read_text().splitlines()), 2) + self.assertEqual(len(log.read_text().splitlines()), 3) + mirrors = Path(str(log) + '.mirrors') + self.assertEqual(mirrors.read_text().splitlines(), [ + 'URIs: http://mirror.invalid/ubuntu', + 'URIs: https://archive.ubuntu.com/ubuntu', + 'URIs: https://mirrors.edge.kernel.org/ubuntu', + ]) log.unlink() + mirrors.unlink() + result = subprocess.run(['bash', str(installer), 'qemu-user'], env=dict(env, APT_RESULT='17', DPKG_ARCH='arm64')) + self.assertEqual(result.returncode, 17) + self.assertEqual(mirrors.read_text().splitlines()[1:], [ + 'URIs: https://ports.ubuntu.com/ubuntu-ports', + 'URIs: https://mirrors.ocf.berkeley.edu/ubuntu-ports', + ]) + log.unlink() + mirrors.unlink() subprocess.run(['bash', str(installer), 'qemu-user'], env=env, check=True) update, install = log.read_text().splitlines() for command in (update, install): diff --git a/tools/tests/test_desktop_open.py b/tools/tests/test_desktop_open.py index a23d855448..c32baf71a6 100644 --- a/tools/tests/test_desktop_open.py +++ b/tools/tests/test_desktop_open.py @@ -482,6 +482,83 @@ class ProtonRunTest(Temp): self.assertEqual(found["droiddeck-proton-arm64"], (str(self.root / "compatibilitytools.d/droiddeck-proton-arm64"), "droiddeck-proton")) + def test_a_valve_depot_is_registered_through_the_droiddeck_wrapper(self): + name = "Proton Experimental (ARM64)" + folder = "steamapps/common/%s" % name + shutil.rmtree(self.root / "compatibilitytools.d/droiddeck-proton-arm64") + self.write("Steam/steamapps/appmanifest_4427310.acf", '"AppState" { "appid" "4427310" }') + self.write("Steam/%s/toolmanifest.vdf" % folder, '"manifest"\n{\n "commandline" "/proton %verb%"\n}\n') + self.write("Steam/%s/proton" % folder, b"#!/bin/sh\n", 0o755) + self.write("Steam/%s/files/bin-arm64/proton" % folder, b"#!/bin/sh\n", 0o755) + found = RUN["tools"](str(self.root)) + wrapper = self.root / "compatibilitytools.d/droiddeck-proton-arm64" + self.assertEqual(found["droiddeck-proton-arm64"], (str(wrapper), "droiddeck-proton")) + self.assertNotIn(name, found) + + def test_an_incomplete_valve_depot_is_not_registered(self): + name = "Proton Experimental (ARM64)" + folder = "steamapps/common/%s" % name + shutil.rmtree(self.root / "compatibilitytools.d/droiddeck-proton-arm64") + self.write("Steam/steamapps/appmanifest_4427310.acf", '"AppState" { "appid" "4427310" }') + self.write("Steam/%s/toolmanifest.vdf" % folder, '"manifest"\n{\n "commandline" "/proton %verb%"\n}\n') + self.write("Steam/%s/files/bin-arm64/proton" % folder, b"#!/bin/sh\n", 0o755) + found = RUN["tools"](str(self.root)) + self.assertNotIn("droiddeck-proton-arm64", found) + self.assertFalse((self.root / "compatibilitytools.d/droiddeck-proton-arm64").exists()) + + def test_a_failed_wrapper_build_does_not_hide_existing_tools(self): + shutil.rmtree(self.root / "compatibilitytools.d/droiddeck-proton-arm64") + self.write("Steam/steamapps/appmanifest_4427310.acf", '"AppState" { "appid" "4427310" }') + folder = "steamapps/common/Proton Experimental (ARM64)" + self.write("Steam/%s/proton" % folder, b"#!/bin/sh\n", 0o755) + self.write("Steam/%s/files/bin-arm64/proton" % folder, b"#!/bin/sh\n", 0o755) + build = mock.Mock(side_effect=OSError("read-only")) + with mock.patch.dict(RUN["compat"](), {"build_tool": build}): + found = RUN["tools"](str(self.root)) + build.assert_called_once() + self.assertIn("droiddeck-proton-11-arm64", found) + + def test_a_runnable_depot_is_chosen_over_a_newer_incomplete_one(self): + shutil.rmtree(self.root / "compatibilitytools.d/droiddeck-proton-arm64") + self.write("Steam/steamapps/appmanifest_4427310.acf", '"AppState" { "appid" "4427310" }') + good = "Steam/steamapps/common/Proton Experimental (ARM64)" + self.write("%s/proton" % good, b"#!/bin/sh\n", 0o755) + self.write("%s/files/bin-arm64/proton" % good, b"#!/bin/sh\n", 0o755) + broken = "Library/steamapps/common/Proton Experimental (ARM64)" + self.write("Library/steamapps/libraryfolders.vdf", b"") + self.write("%s/version" % broken, b"2\n") + self.write("%s/files/bin-arm64/proton" % broken, b"#!/bin/sh\n", 0o755) + self.write("Steam/steamapps/libraryfolders.vdf", '"path" "%s"' % (self.tmp / "Library")) + compat = RUN["compat"]() + source = compat["find_source"] + self.assertEqual(source(str(self.root), runnable=True), str(self.tmp / good)) + + def test_a_registered_wrapper_without_its_launcher_is_rebuilt(self): + wrapper = self.root / "compatibilitytools.d/droiddeck-proton-arm64" + self.write("Steam/steamapps/appmanifest_4427310.acf", '"AppState" { "appid" "4427310" }') + folder = "Steam/steamapps/common/Proton Experimental (ARM64)" + self.write("%s/proton" % folder, b"#!/bin/sh\n", 0o755) + self.write("%s/files/bin-arm64/proton" % folder, b"#!/bin/sh\n", 0o755) + launcher = wrapper / RUN["compat"]()["LAUNCHER"] + if launcher.exists(): + launcher.unlink() + found = RUN["tools"](str(self.root)) + self.assertTrue(os.access(launcher, os.X_OK)) + self.assertIn("droiddeck-proton-arm64", found) + + def test_a_registered_wrapper_without_its_manifest_is_rebuilt(self): + wrapper = self.root / "compatibilitytools.d/droiddeck-proton-arm64" + self.write("Steam/steamapps/appmanifest_4427310.acf", '"AppState" { "appid" "4427310" }') + folder = "Steam/steamapps/common/Proton Experimental (ARM64)" + self.write("%s/proton" % folder, b"#!/bin/sh\n", 0o755) + self.write("%s/files/bin-arm64/proton" % folder, b"#!/bin/sh\n", 0o755) + manifest = wrapper / "toolmanifest.vdf" + if manifest.exists(): + manifest.unlink() + found = RUN["tools"](str(self.root)) + self.assertTrue(manifest.is_file()) + self.assertIn("droiddeck-proton-arm64", found) + def test_steams_choice_for_the_title_then_its_default(self): available = RUN["tools"](str(self.root)) current = RUN["mapping"](str(self.root)) diff --git a/tools/tests/test_droiddeck_agent.py b/tools/tests/test_droiddeck_agent.py index 02e53f9607..a1adca90c6 100644 --- a/tools/tests/test_droiddeck_agent.py +++ b/tools/tests/test_droiddeck_agent.py @@ -457,6 +457,26 @@ class AgentTest(unittest.TestCase): self.assertEqual(1, agent.main(["--steam-shortcut-state", game_id])) self.assertEqual(2, agent.main(["--steam-shortcut-state"])) + def test_steam_ready_uses_steams_initialized_store(self): + with patch.object(agent, "cdp_eval", return_value={"value": True}) as evaluate: + self.assertTrue(agent.steam_ready(self.dir)) + self.assertIn("m_bIsInitialized", evaluate.call_args.args[1]) + with patch.object(agent, "cdp_eval", return_value={"value": False}): + self.assertFalse(agent.steam_ready(self.dir)) + + def test_pending_interstitial_is_continued_by_steam(self): + with patch.object(agent, "cdp_eval", return_value={"value": True}) as evaluate: + self.assertTrue(agent.steam_clear_pending_interstitial(self.dir, "3551182975")) + expression = evaluate.call_args.args[1] + self.assertIn("ContinueGameAction", expression) + self.assertIn("ShowInterstitials", expression) + self.assertIn('"3551182975"', expression) + self.assertIn("await apps.GetActiveGameActions()", expression) + with patch.object(agent, "cdp_eval", return_value={"value": False}): + self.assertFalse(agent.steam_clear_pending_interstitial(self.dir, "3551182975")) + with self.assertRaises(agent.AgentError): + agent.steam_clear_pending_interstitial(self.dir, "0") + def test_asleep_command_reports_steams_own_sleep_state(self): with patch.dict(os.environ, {"BL_LAUNCH_DIR": str(self.dir.parent)}): for value, code in (("yes", 0), ("no", 5), ("unknown", 1), (None, 1)): diff --git a/tools/tests/test_droiddeck_proton_default.py b/tools/tests/test_droiddeck_proton_default.py index 6c0665d571..2173a223a1 100644 --- a/tools/tests/test_droiddeck_proton_default.py +++ b/tools/tests/test_droiddeck_proton_default.py @@ -3,14 +3,18 @@ import runpy import tempfile import unittest from pathlib import Path +from unittest import mock BIN = Path(__file__).resolve().parents[1] / "linuxfs/overlay/usr/local/bin" COMPAT = runpy.run_path(str(BIN / "steam-compatibility")) TOOL = COMPAT["TOOL"] OLD = {"name": "DroidDeck-Proton-11-11.2", "display": "DroidDeck-Proton 11-11.2", "dir": "DroidDeck-Proton 11-11.2", "valve": False} NEW = {"name": "DroidDeck-Proton-11-11.4", "display": "DroidDeck-Proton 11-11.4", "dir": "DroidDeck-Proton 11-11.4", "valve": False} -VALVE = {"name": TOOL, "display": "Proton Experimental ARM64", "dir": "Proton - Experimental (ARM64)", "valve": True} +VALVE = {"name": TOOL, "display": "Proton Experimental ARM64", "dir": COMPAT["SOURCES"][0], "valve": True} +VALVE_11 = {"name": COMPAT["TOOL_11"], "display": "Proton 11.0 ARM64", "dir": COMPAT["SOURCES"][1], "valve": True} GE = {"name": "GE-Proton11-7", "display": "GE-Proton11-7", "dir": "GE-Proton11-7", "valve": False} +GE10 = {"name": "GE-Proton10-3", "display": "GE-Proton10-3", "dir": "GE-Proton10-3", "valve": False} +NEWER = {"name": "DroidDeck-Proton-11-12.1", "display": "DroidDeck-Proton 11-12.1", "dir": "DroidDeck-Proton 11-12.1", "valve": False} def config_text(entries): @@ -19,15 +23,19 @@ def config_text(entries): class DroidDeckProtonDefaultTest(unittest.TestCase): - def run_default(self, state, mapping, catalog, apps=(), request=None, settle=True): + def run_default(self, state, mapping, catalog, apps=(), request=None, settle=True, owned=None, games=None): with tempfile.TemporaryDirectory() as tmp: directory = Path(tmp) (directory / "state.json").write_text(json.dumps(state)) if request is not None: (directory / "request.json").write_text(json.dumps(request)) + if games is not None: + (directory / "games.json").write_text(json.dumps({"version": 1, "games": games})) config = directory / "config.vdf" config.write_text(config_text(mapping)) - default = COMPAT["register_default"](str(config), list(apps), catalog=catalog, directory=str(directory), settle=settle) + with mock.patch.dict(COMPAT["register_default"].__globals__, steam_running=lambda: False): + default = COMPAT["register_default"](str(config), list(apps), catalog=catalog, directory=str(directory), + settle=settle, owned=owned) return default, COMPAT["read_config_mapping"](str(config)), json.loads((directory / "state.json").read_text()) def test_a_replacement_seen_while_steam_runs_still_moves_the_default_later(self): @@ -50,8 +58,7 @@ class DroidDeckProtonDefaultTest(unittest.TestCase): {"default": TOOL, "auto": {"42": TOOL}}, [("0", TOOL), ("42", TOOL), ("43", TOOL)], [VALVE, NEW], ["42", "43"]) self.assertEqual(default, NEW["name"]) self.assertEqual(mapping, {"0": NEW["name"], "42": NEW["name"], "43": TOOL}) - self.assertEqual(state["default"], NEW["name"]) - self.assertTrue(state["own_proton"]) + self.assertEqual((state["default"], state["source"], state["written"]), (NEW["name"], "update", NEW["name"])) def test_a_default_picked_after_the_switch_is_kept(self): default, mapping, state = self.run_default( @@ -59,8 +66,7 @@ class DroidDeckProtonDefaultTest(unittest.TestCase): [("0", NEW["name"])], [VALVE, NEW], request={"seq": 2, "valve": True, "dir": VALVE["dir"]}) self.assertEqual(default, TOOL) self.assertEqual(mapping, {"0": TOOL}) - default, mapping, state = self.run_default( - {"default": TOOL, "own_proton": True, "tools": [VALVE, NEW]}, [("0", TOOL)], [VALVE, NEW]) + default, mapping, state = self.run_default(state, [("0", TOOL)], [VALVE, NEW]) self.assertEqual(default, TOOL) self.assertEqual(mapping, {"0": TOOL}) @@ -75,7 +81,7 @@ class DroidDeckProtonDefaultTest(unittest.TestCase): def test_a_replaced_build_does_not_override_a_valve_default(self): default, mapping, _ = self.run_default( - {"default": TOOL, "own_proton": True, "tools": [VALVE, OLD]}, [("0", TOOL), ("43", OLD["name"])], [VALVE, NEW], ["43"]) + {"default": TOOL, "source": "app", "written": TOOL, "tools": [VALVE, OLD]}, [("0", TOOL), ("43", OLD["name"])], [VALVE, NEW], ["43"]) self.assertEqual(default, TOOL) self.assertEqual(mapping, {"0": TOOL, "43": NEW["name"]}) @@ -85,6 +91,114 @@ class DroidDeckProtonDefaultTest(unittest.TestCase): self.assertEqual(mapping, {"0": TOOL}) self.assertNotIn("own_proton", state) + def test_a_fresh_state_with_steam_on_proton_experimental_moves_to_the_newest_build(self): + default, mapping, state = self.run_default({}, [("0", TOOL)], [VALVE, OLD, NEW]) + self.assertEqual((default, mapping), (NEW["name"], {"0": NEW["name"]})) + default, mapping, state = self.run_default(state, [("0", NEW["name"])], [VALVE, OLD, NEW]) + self.assertEqual((default, state["source"]), (NEW["name"], "update")) + + def test_a_default_adopted_from_steam_by_an_earlier_build_recovers(self): + default, mapping, state = self.run_default( + {"default": TOOL, "source": "steam", "seq": 5, "own_proton": True, "tools": [VALVE, NEW]}, [("0", TOOL)], [VALVE, NEW]) + self.assertEqual((default, mapping, state["source"]), (NEW["name"], {"0": NEW["name"]}, "update")) + self.assertNotIn("own_proton", state) + + def test_a_request_applied_without_a_change_still_moves_to_the_newest_build(self): + for request in ({"seq": 5, "valve": True, "dir": VALVE["dir"]}, {"seq": 5, "valve": False, "dir": GE["dir"]}): + default, mapping, state = self.run_default({"default": TOOL, "applied": 1}, [("0", TOOL)], [VALVE, NEW], request=request) + self.assertEqual((default, mapping, state["applied"]), (NEW["name"], {"0": NEW["name"]}, 5)) + + def test_a_default_that_is_not_installed_falls_back_without_counting_as_a_pick(self): + default, mapping, state = self.run_default( + {"default": GE["name"], "source": "app", "seq": 9, "written": GE["name"]}, [("0", GE["name"])], [VALVE]) + self.assertEqual((default, mapping), (TOOL, {"0": TOOL})) + self.assertEqual((state["source"], state["seq"]), ("fallback", 9)) + default, _, state = self.run_default(state, [("0", TOOL)], [VALVE, NEW]) + self.assertEqual((default, state["source"]), (NEW["name"], "update")) + + def test_proton_experimental_asked_for_in_the_app_stays(self): + default, mapping, state = self.run_default( + {"default": NEW["name"], "written": NEW["name"], "applied": 1}, [("0", NEW["name"])], [VALVE, NEW], + request={"seq": 2, "valve": True, "dir": VALVE["dir"]}) + self.assertEqual((default, state["source"]), (TOOL, "app")) + for catalog in ([VALVE, NEW], [VALVE, NEW, NEWER], [VALVE, NEWER]): + default, mapping, state = self.run_default(state, [("0", TOOL)], catalog) + self.assertEqual((default, mapping, state["source"]), (TOOL, {"0": TOOL}, "app")) + + def test_proton_experimental_picked_in_steam_stays(self): + default, mapping, state = self.run_default( + {"default": NEW["name"], "written": NEW["name"], "source": "update"}, [("0", TOOL)], [VALVE, NEW]) + self.assertEqual((default, state["source"], state["written"]), (TOOL, "steam", TOOL)) + for catalog in ([VALVE, NEW], [VALVE, NEW, NEWER]): + default, mapping, state = self.run_default(state, [("0", TOOL)], catalog) + self.assertEqual((default, mapping, state["source"]), (TOOL, {"0": TOOL}, "steam")) + + def test_steam_echoing_the_written_default_is_not_a_pick(self): + default, _, state = self.run_default( + {"default": NEW["name"], "written": TOOL, "source": "update"}, [("0", TOOL)], [VALVE, NEW]) + self.assertEqual((default, state["source"]), (NEW["name"], "update")) + + def test_a_default_the_running_client_does_not_list_is_kept(self): + state = {"default": NEW["name"], "written": NEW["name"], "seq": 1, "source": "update"} + default, state = COMPAT["choose_default"](TOOL, state, {}, [VALVE, NEW], listed=[TOOL]) + self.assertEqual((default, state["default"], state["source"], state["seq"]), (TOOL, NEW["name"], "update", 1)) + default, state = COMPAT["choose_default"](GE["name"], dict(state, written=TOOL), {}, [VALVE, NEW, GE]) + self.assertEqual((default, state["source"]), (GE["name"], "steam")) + + def test_owned_shortcuts_follow_the_default_and_explicit_picks_stay(self): + owned = ["3000000001", "3000000002", "3000000003", "3000000004"] + catalog = [VALVE, NEW, GE, GE10] + default, mapping, state = self.run_default( + {"default": NEW["name"], "written": NEW["name"], "source": "update", "auto": {}}, + [("0", NEW["name"]), ("3000000001", NEW["name"]), ("3000000002", TOOL), ("3000000003", GE["name"]), + ("3000000004", NEW["name"]), ("42", GE["name"]), ("44", NEW["name"])], + catalog, ["42", "44"] + owned, settle=False, owned=owned, games={"44": {"valve": False, "dir": GE["dir"]}}) + self.assertEqual(mapping, {"0": NEW["name"], "3000000001": NEW["name"], "3000000002": NEW["name"], + "3000000003": GE["name"], "3000000004": NEW["name"], "42": GE["name"], "44": GE["name"]}) + mapping["3000000001"] = TOOL + default, mapping, state = self.run_default(state, sorted(mapping.items()), catalog, ["42", "44"] + owned, + settle=False, owned=owned) + self.assertEqual(mapping["3000000001"], TOOL) + default, mapping, state = self.run_default(state, sorted(mapping.items()), catalog, ["42", "44"] + owned, + request={"seq": 1, "valve": False, "dir": GE10["dir"]}) + self.assertEqual(default, GE10["name"]) + self.assertEqual(mapping, {"0": GE10["name"], "3000000001": TOOL, "3000000002": GE10["name"], + "3000000003": GE["name"], "3000000004": GE10["name"], "42": GE["name"], "44": GE["name"]}) + + def test_proton_experimental_picked_for_a_game_in_steam_stays(self): + default, mapping, state = self.run_default( + {"default": NEW["name"], "written": NEW["name"], "source": "update", + "auto": {"42": NEW["name"], "43": NEW["name"], "45": NEW["name"]}}, + [("0", NEW["name"]), ("42", "proton_experimental"), ("43", NEW["name"]), ("45", TOOL)], [VALVE, NEW], + ["42", "43", "44", "45"]) + self.assertEqual(default, NEW["name"]) + self.assertEqual(mapping, {"0": NEW["name"], "42": TOOL, "43": NEW["name"], "44": NEW["name"], "45": TOOL}) + self.assertEqual(state["auto"], {"43": NEW["name"], "44": NEW["name"]}) + self.assertTrue({"42", "45"} <= set(state["picked"])) + default, mapping, state = self.run_default(state, sorted(mapping.items()), [VALVE, NEWER], ["42", "43", "44", "45"]) + self.assertEqual(default, NEWER["name"]) + self.assertEqual(mapping, {"0": NEWER["name"], "42": TOOL, "43": NEWER["name"], "44": NEWER["name"], "45": TOOL}) + + def test_a_steam_pick_of_a_valve_proton_moves_to_the_build_made_from_it(self): + catalog = [VALVE, VALVE_11, NEW] + default, mapping, state = self.run_default( + {"default": NEW["name"], "written": NEW["name"], "source": "update", "auto": {"42": TOOL, "43": NEW["name"]}, + "picked": ["44"]}, + [("0", NEW["name"]), ("42", "proton-experimental-arm64"), ("43", "proton_11"), ("44", "proton_11-arm64"), + ("45", "proton_9")], catalog, ["42", "43", "44", "45"]) + self.assertEqual(mapping, {"0": NEW["name"], "42": TOOL, "43": VALVE_11["name"], "44": VALVE_11["name"], "45": NEW["name"]}) + self.assertEqual(state["auto"], {"45": NEW["name"]}) + _, mapping, _ = self.run_default(state, sorted(mapping.items()), catalog, ["42", "43", "44", "45"], + request={"seq": 1, "valve": False, "dir": GE["dir"]}) + self.assertEqual(mapping, {"0": NEW["name"], "42": TOOL, "43": VALVE_11["name"], "44": VALVE_11["name"], "45": NEW["name"]}) + + def test_proton_experimental_picked_as_steams_default_stays(self): + default, mapping, state = self.run_default( + {"default": NEW["name"], "written": NEW["name"], "source": "update"}, [("0", "proton_experimental")], [VALVE, NEW]) + self.assertEqual((default, mapping, state["source"]), (TOOL, {"0": TOOL}, "steam")) + default, mapping, state = self.run_default(state, [("0", TOOL)], [VALVE, NEW, NEWER]) + self.assertEqual((default, mapping), (TOOL, {"0": TOOL})) + def test_the_newest_build_is_found_by_version(self): newest, gone = COMPAT["own_proton_moves"]({"tools": [OLD]}, [dict(NEW, name="a", dir="DroidDeck-Proton 11-9.10"), dict(NEW, name="b", dir="DroidDeck-Proton 11-11.1")]) self.assertEqual(newest, "b") diff --git a/tools/tests/test_droiddeckctl.py b/tools/tests/test_droiddeckctl.py index ad434989a8..ab929de931 100644 --- a/tools/tests/test_droiddeckctl.py +++ b/tools/tests/test_droiddeckctl.py @@ -213,6 +213,18 @@ class DroiddeckctlTest(FakeAdbTest): started = [e["args"] for e in self.calls() if e["args"][:3] == ["shell", "am", "start"]] self.assertIn("com.antutu.benchmark.full/com.droiddeck.launcher.agent.AgentStartActivity", started[0]) + def test_a_start_delivered_to_an_existing_task_is_a_failure(self): + output = (b"Starting: Intent { cmp=com.droiddeck.launcher/.agent.AgentStartActivity (has extras) }\n" + b"Warning: Activity not started, intent has been delivered to currently running top-most instance.\n" + b"Status: ok\nActivity: com.droiddeck.launcher/.FrontEndActivity\nComplete\n") + + def adb(_adb, _serial, *args, timeout=30): + return ctl.subprocess.CompletedProcess(args, 0, output, b"") + + with unittest.mock.patch.object(ctl, "run_adb", adb), self.assertRaises(ctl.ControlError) as caught: + ctl.start_agent_activity("adb", "fake-1", {"mode": "steam"}) + self.assertEqual("ACTIVITY_START_FAILED", caught.exception.code) + def test_a_malformed_package_is_refused_before_adb(self): with unittest.mock.patch.dict(os.environ, {"DROIDDECK_PACKAGE": "com.example;reboot"}): variant = load("droiddeckctl") @@ -328,6 +340,15 @@ class DroiddeckctlTest(FakeAdbTest): self.assertEqual("222", out["displays"][1]["physicalId"]) self.assertEqual([1080, 1240], out["displays"][1]["size"]) + def test_displays_named_with_their_unique_id(self): + text = DUMPSYS_DISPLAY.replace("mPrimaryDisplayDevice=Screen-2", + "mPrimaryDisplayDevice=Screen-2(local:222)") + self.configure({}, dumpsys_display=text) + code, out = self.run_ctl("screenshot", str(self.dir / "shot.png"), "--display", "4") + self.assertEqual(0, code) + shot = [c for c in self.calls() if c["args"][:2] == ["exec-out", "screencap"]][0] + self.assertEqual(["exec-out", "screencap", "-p", "-d", "222"], shot["args"]) + def test_unknown_display_is_an_error(self): self.configure({}, dumpsys_display=DUMPSYS_DISPLAY) code, out = self.run_ctl("screenshot", str(self.dir / "x.png"), "--display", "9") @@ -398,6 +419,30 @@ class DroiddeckctlTest(FakeAdbTest): self.assertEqual(4, code) self.assertEqual("NO_FRAMES", out["error"]["code"]) + def test_provider_call_falls_back_to_a_broadcast_without_content(self): + calls = [] + answers = iter([b"", b'{"ok": true, "command": "state"}']) + + def adb(_adb, _serial, *args, timeout=30): + calls.append(args) + if args[:2] == ("shell", "content"): + return ctl.subprocess.CompletedProcess(args, 127, b"", b"/system/bin/sh: content: inaccessible or not found") + if args[:2] == ("shell", "am"): + return ctl.subprocess.CompletedProcess(args, 0, b"Broadcast completed: result=0", b"") + if args[:2] == ("shell", "pidof " + ctl.PACKAGE): + return ctl.subprocess.CompletedProcess(args, 0, b"4940\n", b"") + return ctl.subprocess.CompletedProcess(args, 0, next(answers), b"") + + with unittest.mock.patch.object(ctl, "run_adb", adb), unittest.mock.patch.object(ctl.time, "sleep"): + answer = ctl.provider_call("adb", "fake-1", "state", arg="a b", request={"x": 1}) + self.assertEqual({"ok": True, "command": "state"}, answer) + broadcast = next(c for c in calls if c[:2] == ("shell", "am")) + self.assertEqual(("shell", "am", "broadcast", "-a", ctl.PACKAGE + ".AGENT_CALL", "-p", ctl.PACKAGE), broadcast[:7]) + self.assertIn("'a b'", broadcast) + self.assertEqual(ctl.encode_request({"x": 1}), broadcast[broadcast.index("request") + 1]) + call_id = broadcast[broadcast.index("id") + 1] + self.assertIn("agent-calls/%s.json" % call_id, calls[-1][1]) + def test_pacing_turns_timestats_off_when_the_dump_fails(self): calls = [] @@ -792,5 +837,48 @@ class ScenarioTest(FakeAdbTest): self.assertEqual([{"appId": 7, "timeout": 15.0}] * 2, [c["request"] for c in self.calls("quit")]) +class ProviderFallbackTest(unittest.TestCase): + MISSING = "/system/bin/sh: content: inaccessible or not found\n" + + def adb(self, answers): + calls = [] + + def run(adb, serial, *args, timeout=None): + calls.append(args) + for prefix, (code, out, err) in answers: + if " ".join(args).startswith(" ".join(prefix)): + return unittest.mock.Mock(returncode=code, stdout=out.encode(), stderr=err.encode()) + raise AssertionError(f"unexpected adb call {args}") + return calls, unittest.mock.patch.object(ctl, "run_adb", run) + + def test_a_command_that_prints_the_shell_error_is_not_run_again(self): + result = 'Result: Bundle[{json={"ok":true,"stdout":{"text":"' + self.MISSING.strip() + '"}}}]' + calls, patch = self.adb([(["shell", "content"], (0, result, ""))]) + with patch: + self.assertTrue(ctl.provider_call("adb", "s", "native", request={"argv": ["x"]})["ok"]) + self.assertEqual(1, len(calls)) + + def test_a_shell_without_content_uses_the_broadcast(self): + calls, patch = self.adb([ + (["shell", "content"], (127, "", self.MISSING)), + (["shell", "pidof"], (0, "4940\n", "")), + (["shell", "am", "broadcast"], (0, "Broadcast completed", "")), + (["shell"], (0, '{"ok": true}', "")), + ]) + with patch: + self.assertTrue(ctl.provider_call("adb", "s", "state")["ok"]) + self.assertEqual(["shell", "am", "broadcast"], list(calls[2][:3])) + + def test_the_broadcast_needs_the_app_running(self): + calls, patch = self.adb([ + (["shell", "content"], (127, "", self.MISSING)), + (["shell", "pidof"], (1, "", "")), + ]) + with patch, self.assertRaises(ctl.ControlError) as raised: + ctl.provider_call("adb", "s", "state") + self.assertEqual("APP_NOT_RUNNING", raised.exception.code) + self.assertFalse(any(c[:3] == ("shell", "am", "broadcast") for c in calls)) + + if __name__ == "__main__": unittest.main() diff --git a/tools/tests/test_fakeinput_reentry.py b/tools/tests/test_fakeinput_reentry.py new file mode 100644 index 0000000000..7abd49caed --- /dev/null +++ b/tools/tests/test_fakeinput_reentry.py @@ -0,0 +1,58 @@ +from pathlib import Path +import os +import shutil +import subprocess +import sys +import tempfile +import unittest + +SOURCE = Path(__file__).resolve().parents[2] / "app/src/main/cpp/fakeinput_steam.cpp" + +# Stands in for an allocator like mimalloc that calls access() while it starts up (Claude Code +# probes /sys/devices/system/node/node1 on its first allocation, which comes from fakeinput's +# constructor when it is preloaded). +PROGRAM = r""" +#define _GNU_SOURCE +#include +#include +#include + +extern void *__libc_malloc(size_t); +static int started; + +void *malloc(size_t size) { + if (!started) { + started = 1; + access("/sys/devices/system/node/node1", R_OK); + } + return __libc_malloc(size); +} + +int main(void) { + puts("ok"); + return 0; +} +""" + + +@unittest.skipUnless(sys.platform == "linux" and shutil.which("gcc") and shutil.which("g++"), + "needs Linux, gcc and g++") +class FakeinputReentryTest(unittest.TestCase): + def test_allocator_calling_hooks_during_first_allocation_survives_preload(self): + with tempfile.TemporaryDirectory() as tmp: + path = Path(tmp) + (path / "program.c").write_text(PROGRAM) + subprocess.run(["gcc", "-rdynamic", "-o", str(path / "program"), str(path / "program.c")], check=True) + subprocess.run(["g++", "-shared", "-fPIC", "-O2", "-Wno-attributes", "-pthread", + "-std=c++17", "-static-libstdc++", "-static-libgcc", + "-Wl,--exclude-libs,ALL", "-o", str(path / "libfakeinput.so"), + str(SOURCE), "-ldl"], check=True) + result = subprocess.run([str(path / "program")], + env=dict(os.environ, LD_PRELOAD=str(path / "libfakeinput.so")), + capture_output=True, text=True, timeout=10) + self.assertEqual(result.returncode, 0, result.stderr) + self.assertEqual(result.stdout, "ok\n") + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/tests/test_game_environment.py b/tools/tests/test_game_environment.py index dfc65de1c7..d6cb49582e 100644 --- a/tools/tests/test_game_environment.py +++ b/tools/tests/test_game_environment.py @@ -708,6 +708,54 @@ class ReadConfigMappingTest(unittest.TestCase): class GameEnvironmentTest(unittest.TestCase): + def test_component_filter_and_prefix_repair_use_per_game_proton_architecture(self): + with tempfile.TemporaryDirectory() as tmp: + home = Path(tmp) + config = home / ".config/droiddeck/game-environment.json" + config.parent.mkdir(parents=True) + config.write_text(json.dumps({"version": 1, "shared": {"PROTON_USE_ARM64": "1"}, + "games": {"42": {"PROTON_USE_ARM64": "0"}}})) + seen_components, seen_repair, seen_start = [], [], [] + globals = MODULE["main"].__globals__ + stubs = { + "game_gpu": lambda env: env, + "mark_install_scripts": lambda command, env: [], + "install_scripts_done": lambda scripts, env: False, + "scripts_digest": lambda scripts: None, + "win_components": lambda *args: seen_components.append(args[3]) or "", + "repair_foreign_system_dlls": lambda *args: seen_repair.append(args[2]) or [], + "gl_vsync": lambda env: False, + "game_images": lambda env: None, + "skip_red_launcher": lambda command: command, + "ubisoft_overlay_off": lambda env: None, + "project_zomboid_jvm": lambda command: None, + "engine_fixes": lambda *args: ({}, [], []), + "dirt_ws2_wanted": lambda *args: None, + "apply_game_debug_logs": lambda env, config, debug_dir: env, + "offline_without_anticheat": lambda command, env: command, + "game_logs": lambda command, env, app_id: env, + "directaudio_settings": lambda env: env, + "vram_cap": lambda env: env, + "render_path_defaults": lambda *args: None, + "bridge_feature_level": lambda env: None, + "force_ssbs": lambda command, env: env, + "game_cores": lambda env: None, + "cpu_topology": lambda env, command: None, + "ego_core_plan": lambda *args: None, + "runpy": mock.Mock(run_path=lambda *args: {"launch": lambda command, env: None}), + "load_sync": lambda: {}, + "select_sync": lambda command, env, sync: (command, env), + "start": lambda command, env, *args: seen_start.append(env) or 7, + } + environment = {"HOME": tmp, "STEAM_COMPAT_DATA_PATH": "/compatdata/42", "PROTON_USE_ARM64": "1"} + command = ["/stock/proton", "waitforexitandrun", "/game/game.exe"] + with patch.dict(os.environ, environment, clear=True), patch.object(sys, "argv", ["game-env", *command]), \ + patch.dict(globals, stubs): + self.assertEqual(MODULE["main"](), 7) + self.assertEqual(["0"], [env["PROTON_USE_ARM64"] for env in seen_components]) + self.assertEqual(["0"], [env["PROTON_USE_ARM64"] for env in seen_repair]) + self.assertEqual(["0"], [env["PROTON_USE_ARM64"] for env in seen_start]) + def test_optional_xbox_loader_failure_keeps_stock_launch(self): from unittest.mock import patch for error in (FileNotFoundError('missing'), RuntimeError('module initialization failed')): @@ -902,6 +950,46 @@ class GameEnvironmentTest(unittest.TestCase): self.assertEqual(MODULE["apply_config"](env, config, "42")["TU_DEBUG"], "sysmem") self.assertNotIn("TU_DEBUG", MODULE["apply_config"](env, config, "43")) + def test_a_chromium_app_keeps_the_sessions_turnip_debug(self): + gpu = MODULE["game_gpu"] + self.assertEqual(gpu({"TU_DEBUG": "sysmem", "DROIDDECK_GAME_TU_DEBUG": "", "KEEP": "1"}, True), + {"TU_DEBUG": "sysmem", "KEEP": "1"}) + self.assertEqual(gpu({"TU_DEBUG": "sysmem", "DROIDDECK_GAME_TU_DEBUG": "nolrz"}, True), {"TU_DEBUG": "sysmem"}) + self.assertEqual(gpu({"TU_DEBUG": "sysmem"}, True), {"TU_DEBUG": "sysmem"}) + + def test_chromium_files_are_found_four_levels_deep_and_no_further(self): + chromium = MODULE["chromium_app"] + with tempfile.TemporaryDirectory() as tmp: + root = Path(tmp) / "app" + (root / "usr/lib/tool").mkdir(parents=True) + (root / "usr/lib/tool/libtool.so").write_bytes(b"") + self.assertFalse(chromium(str(root))) + for name in ("chrome-sandbox", "chrome_100_percent.pak", "v8_context_snapshot.bin"): + found = root / "a/b/c" / name + found.parent.mkdir(parents=True, exist_ok=True) + found.write_bytes(b"") + self.assertTrue(chromium(str(root)), name) + found.unlink() + deep = root / "a/b/c/d/chrome-sandbox" + deep.parent.mkdir(parents=True) + deep.write_bytes(b"") + self.assertFalse(chromium(str(root))) + self.assertFalse(chromium(str(Path(tmp) / "missing"))) + + def test_chromium_detection_does_not_follow_links_inside_the_app(self): + chromium = MODULE["chromium_app"] + with tempfile.TemporaryDirectory() as tmp: + other = Path(tmp) / "other" + other.mkdir() + (other / "chrome-sandbox").write_bytes(b"") + root = Path(tmp) / "app" + root.mkdir() + (root / "linked").symlink_to(other, target_is_directory=True) + self.assertFalse(chromium(str(root))) + link = Path(tmp) / "app-link" + link.symlink_to(other, target_is_directory=True) + self.assertTrue(chromium(str(link))) + def test_the_vram_cap_comes_before_the_games_own_dxvk_settings(self): cap = MODULE["vram_cap"] self.assertEqual(cap({"BL_VRAM_MB": "4096"})["DXVK_CONFIG"], "dxgi.maxDeviceMemory = 4096") @@ -1036,6 +1124,23 @@ class GameEnvironmentTest(unittest.TestCase): scope = MODULE["game_id"](env) expected = "untouched" if scope is None else scope if scope in {"42", "4294967295", "2147483648"} else "*" self.assertEqual(target.read_text(), expected) + for app, expected in (("42", "42"), ("4294967295", "4294967295"), ("43", "*"), ("", "*"), ("x", "*")): + with self.subTest(shared=app): + env = dict(os.environ, HOME=str(root), STEAM_COMPAT_DATA_PATH="/steam/compatdata/2929927072", SteamAppId=app) + target.write_text("untouched") + subprocess.run(["bash", "-c", script, "test", str(base)], env=env, check=True, capture_output=True) + self.assertEqual(MODULE["game_id"](env), app if app in {"42", "4294967295", "43"} else "2929927072") + self.assertEqual(target.read_text(), expected) + for game, expected in ( + (str(42 << 32 | 0x02000000), "42"), (str(4294967295 << 32 | 0x02000000), "4294967295"), + (str(42 << 32 | 0x02000001), "*"), (str(42 << 32 | 0x02000000 | 1 << 64), "*"), ("33554432", "*"), ("x", "*"), + ): + with self.subTest(direct=game): + env = dict(os.environ, HOME=str(root), STEAM_COMPAT_DATA_PATH="/steam/compatdata/2929927072", SteamAppId="0", SteamGameId=game) + target.write_text("untouched") + subprocess.run(["bash", "-c", script, "test", str(base)], env=env, check=True, capture_output=True) + self.assertEqual(MODULE["game_id"](env), expected if expected != "*" else "2929927072") + self.assertEqual(target.read_text(), expected) def test_engine_fixes_follow_the_games_files(self): with tempfile.TemporaryDirectory() as tmp: @@ -1540,6 +1645,10 @@ class GameEnvironmentTest(unittest.TestCase): self.assertIsNone(MODULE["game_id"]({"STEAM_COMPAT_DATA_PATH": prefix})) self.assertEqual(MODULE["game_id"]({"STEAM_COMPAT_DATA_PATH": "/a/compatdata/42/"}), "42") self.assertEqual(MODULE["game_id"]({"STEAM_COMPAT_DATA_PATH": "/a/compatdata/-1"}), "4294967295") + shared = {"STEAM_COMPAT_DATA_PATH": "/a/compatdata/2929927072", "SteamAppId": "2424921676"} + self.assertEqual(MODULE["game_id"](shared), "2424921676") + self.assertEqual(MODULE["game_id"]({"STEAM_COMPAT_DATA_PATH": "/a/compatdata/2929927072"}), "2929927072") + self.assertEqual(MODULE["game_id"]({"STEAM_COMPAT_DATA_PATH": "/a/compatdata/42", "SteamAppId": "7"}), "42") def test_launch_reads_updates_preserves_argv_and_does_not_execute_values(self): with tempfile.TemporaryDirectory() as tmp: @@ -2024,7 +2133,7 @@ class ProtonDefaultTest(unittest.TestCase): self.assertEqual(mapping_of(config.read_text()), {"0": self.TOOL, "427520": self.TOOL}) saved = json.loads((Path(tmp) / "state.json").read_text()) self.assertEqual(saved["native_choices"], []) - self.assertEqual(saved["auto"], {"427520": self.TOOL}) + self.assertEqual(saved["auto"], {}) finally: globals_["appinfo_platforms"] = original_platforms @@ -2545,6 +2654,178 @@ class UbisoftCompositionTest(unittest.TestCase): self.assertEqual(list(prefix.glob(".ubisoft-*.reg")), []) + +def pe_image(machine): + head = bytearray(64) + head[:2] = b"MZ" + head[60:64] = (64).to_bytes(4, "little") + return bytes(head) + b"PE\0\0" + machine.to_bytes(2, "little") + b"\0" * 32 + + +def arm64ec_pe_image(): + image = bytearray(0x400) + image[:2] = b"MZ" + image[60:64] = (64).to_bytes(4, "little") + image[64:68] = b"PE\0\0" + coff = 68 + image[coff:coff + 2] = (0x8664).to_bytes(2, "little") + image[coff + 2:coff + 4] = (1).to_bytes(2, "little") + image[coff + 16:coff + 18] = (240).to_bytes(2, "little") + optional = coff + 20 + image[optional:optional + 2] = (0x20B).to_bytes(2, "little") + image[optional + 108:optional + 112] = (16).to_bytes(4, "little") + directory = optional + 112 + 10 * 8 + image[directory:directory + 4] = (0x1000).to_bytes(4, "little") + image[directory + 4:directory + 8] = (0xD0).to_bytes(4, "little") + section = optional + 240 + image[section + 8:section + 12] = (0x200).to_bytes(4, "little") + image[section + 12:section + 16] = (0x1000).to_bytes(4, "little") + image[section + 16:section + 20] = (0x200).to_bytes(4, "little") + image[section + 20:section + 24] = (0x200).to_bytes(4, "little") + image[0x200:0x204] = (0xD0).to_bytes(4, "little") + image[0x2C8:0x2D0] = (0x10000000).to_bytes(8, "little") + return bytes(image) + + +class ForeignSystemDllTest(unittest.TestCase): + def prefix(self, tmp, arm=True): + proton = Path(tmp) / "Proton" + dist = proton / "files/lib/wine" + if arm: + (dist / "aarch64-unix").mkdir(parents=True) + else: + (dist / "x86_64-unix").mkdir(parents=True) + for libdir, machine in (("aarch64-windows", 0xAA64), ("i386-windows", 0x14C)): + (dist / libdir).mkdir(parents=True) + for name in ("ucrtbase.dll", "rpcrt4.dll"): + (dist / libdir / name).write_bytes(pe_image(machine)) + windows = Path(tmp) / "compat/pfx/drive_c/windows" + for folder in ("system32", "syswow64"): + (windows / folder).mkdir(parents=True) + return proton / "proton", Path(tmp) / "compat", windows + + def run_repair(self, compat, proton): + return MODULE["repair_foreign_system_dlls"](str(compat), str(proton)) + + def test_x64_dll_in_arm64_system32_is_replaced_by_the_builtin(self): + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + (windows / "system32/UCRTBASE.DLL").write_bytes(pe_image(0x8664)) + (windows / "system32/rpcrt4.dll").write_bytes(pe_image(0xAA64)) + fixed = self.run_repair(compat, proton) + self.assertEqual(["system32/UCRTBASE.DLL (machine 0x8664)"], fixed) + self.assertTrue((windows / "system32/UCRTBASE.DLL").is_symlink()) + self.assertEqual(0xAA64, MODULE["pe_machine"](windows / "system32/UCRTBASE.DLL")) + self.assertEqual(0x8664, MODULE["pe_machine"](windows / "system32/UCRTBASE.DLL.foreign-arch")) + self.assertFalse((windows / "system32/rpcrt4.dll").is_symlink()) + self.assertEqual([], self.run_repair(compat, proton)) + + def test_64_bit_dll_in_syswow64_is_replaced(self): + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + (windows / "syswow64/ucrtbase.dll").write_bytes(pe_image(0xAA64)) + self.assertEqual(["syswow64/ucrtbase.dll (machine 0xaa64)"], self.run_repair(compat, proton)) + self.assertEqual(0x14C, MODULE["pe_machine"](windows / "syswow64/ucrtbase.dll")) + + def test_matching_ec_symlinked_unknown_and_non_pe_files_are_left_alone(self): + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + system32 = windows / "system32" + (system32 / "ucrtbase.dll").write_bytes(pe_image(0xA641)) + (system32 / "userlib.dll").write_bytes(pe_image(0x8664)) + (system32 / "rpcrt4.dll").write_bytes(b"not a pe file") + self.assertEqual([], self.run_repair(compat, proton)) + self.assertFalse((system32 / "ucrtbase.dll").is_symlink()) + self.assertEqual(0x8664, MODULE["pe_machine"](system32 / "userlib.dll")) + + def test_x64_visual_cpp_runtime_in_arm64_system32_is_kept(self): + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + builtins = proton.parent / "files/lib/wine/aarch64-windows" + for name in ("msvcp140.dll", "VCRUNTIME140.dll", "msvcp_win.dll"): + (builtins / name.lower()).write_bytes(pe_image(0xAA64)) + (windows / "system32" / name).write_bytes(pe_image(0x8664)) + self.assertEqual(["system32/msvcp_win.dll (machine 0x8664)"], self.run_repair(compat, proton)) + self.assertFalse((windows / "system32/msvcp140.dll").is_symlink()) + self.assertFalse((windows / "system32/VCRUNTIME140.dll").is_symlink()) + + def test_final_arm64ec_image_is_not_repaired_as_a_foreign_x64_dll(self): + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + dll = windows / "system32/ucrtbase.dll" + dll.write_bytes(arm64ec_pe_image()) + self.assertEqual(0x8664, MODULE["pe_machine"](dll)) + self.assertTrue(MODULE["PE"]["machine_compatible"](dll, frozenset((0xAA64, 0xA641)))) + self.assertFalse(MODULE["PE"]["machine_compatible"](dll, frozenset((0x8664,)))) + self.assertEqual([], self.run_repair(compat, proton)) + self.assertFalse(dll.is_symlink()) + + def test_component_owned_and_native_first_foreign_dlls_are_still_replaced(self): + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + (windows / "system32/ucrtbase.dll").write_bytes(pe_image(0x8664)) + (windows / "system32/rpcrt4.dll").write_bytes(pe_image(0x8664)) + state = {"files": {"drive_c/windows/system32/ucrtbase.dll": {}}} + (compat / ".droiddeck-wincomponents.json").write_text(json.dumps(state)) + reg = 'WINE REGISTRY Version 2\n\n[Software\\\\Wine\\\\DllOverrides] 1\n"RPCRT4.DLL"="native,builtin"\n' + (compat / "pfx/user.reg").write_text(reg) + env = {"WINEDLLOVERRIDES": "ucrtbase=n,b"} + self.assertEqual(["system32/rpcrt4.dll (machine 0x8664)", "system32/ucrtbase.dll (machine 0x8664)"], + sorted(MODULE["repair_foreign_system_dlls"](str(compat), str(proton), env))) + self.assertEqual(0xAA64, MODULE["pe_machine"](windows / "system32/ucrtbase.dll")) + self.assertEqual(0xAA64, MODULE["pe_machine"](windows / "system32/rpcrt4.dll")) + + def test_newest_foreign_copy_is_the_only_backup_and_failed_final_replace_restores_it(self): + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + dll = windows / "system32/ucrtbase.dll" + dll.write_bytes(pe_image(0x8664)) + backup = windows / "system32/ucrtbase.dll.foreign-arch" + backup.write_bytes(pe_image(0x1234)) + self.assertEqual(["system32/ucrtbase.dll (machine 0x8664)"], self.run_repair(compat, proton)) + self.assertEqual(0x1234, MODULE["pe_machine"](backup)) + self.assertEqual(0x8664, MODULE["pe_machine"](backup.with_name(backup.name + ".1"))) + self.assertEqual(0xAA64, MODULE["pe_machine"](dll)) + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + dll = windows / "system32/ucrtbase.dll" + dll.write_bytes(pe_image(0x8664)) + backup = windows / "system32/ucrtbase.dll.foreign-arch" + backup.write_bytes(pe_image(0x1234)) + real = os.replace + def flaky_with_backup(src, dst): + if str(src).endswith(".bl-new"): + raise OSError("boom") + return real(src, dst) + with mock.patch("os.replace", side_effect=flaky_with_backup): + self.assertEqual([], self.run_repair(compat, proton)) + self.assertEqual(0x8664, MODULE["pe_machine"](dll)) + self.assertFalse((windows / "system32/ucrtbase.dll.foreign-arch.1").exists()) + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp) + dll = windows / "system32/ucrtbase.dll" + dll.write_bytes(pe_image(0x8664)) + real = os.replace + def flaky(src, dst): + if str(src).endswith(".bl-new"): + raise OSError("boom") + return real(src, dst) + with mock.patch("os.replace", side_effect=flaky): + self.assertEqual([], self.run_repair(compat, proton)) + self.assertEqual(0x8664, MODULE["pe_machine"](dll)) + self.assertFalse(dll.is_symlink()) + self.assertFalse((windows / "system32/ucrtbase.dll.foreign-arch").exists()) + self.assertFalse((windows / "system32/ucrtbase.dll.bl-new").is_symlink()) + + def test_non_arm64_proton_and_missing_prefix_are_untouched(self): + with tempfile.TemporaryDirectory() as tmp: + proton, compat, windows = self.prefix(tmp, arm=False) + (windows / "system32/ucrtbase.dll").write_bytes(pe_image(0x8664)) + self.assertEqual([], self.run_repair(compat, proton)) + self.assertEqual(0x8664, MODULE["pe_machine"](windows / "system32/ucrtbase.dll")) + self.assertEqual([], self.run_repair(Path(tmp) / "missing", proton)) + + if __name__ == "__main__": unittest.main() diff --git a/tools/tests/test_game_gpu_launchers.py b/tools/tests/test_game_gpu_launchers.py new file mode 100644 index 0000000000..09b3aef85a --- /dev/null +++ b/tools/tests/test_game_gpu_launchers.py @@ -0,0 +1,108 @@ +import os +import runpy +import shutil +import subprocess +import sys +import tempfile +import unittest +from pathlib import Path + +BIN = Path(__file__).resolve().parents[1] / "linuxfs/overlay/usr/local/bin" +KEYS = ("TU_DEBUG", "DROIDDECK_GAME_TU_DEBUG", "MESA_LOADER_DRIVER_OVERRIDE", "GALLIUM_DRIVER", + "LIBGL_KOPPER_DRI2", "VK_ICD_FILENAMES", "VK_DRIVER_FILES") +SESSION = {"TU_DEBUG": "sysmem", "DROIDDECK_GAME_TU_DEBUG": ""} +GPU_SESSION = {"MESA_LOADER_DRIVER_OVERRIDE": "zink", "GALLIUM_DRIVER": "zink", + "LIBGL_KOPPER_DRI2": "true", "VK_ICD_FILENAMES": "/runtime/turnip.json", + "VK_DRIVER_FILES": "/runtime/turnip.json"} + + +class GameGpuLaunchersTest(unittest.TestCase): + def setUp(self): + self.tmp = Path(tempfile.mkdtemp()) + self.addCleanup(shutil.rmtree, self.tmp, True) + self.out = self.tmp / "env" + self.tools = self.tmp / "tools" + self.tools.mkdir() + self.app = self.tmp / "deploy" + (self.app / "files/bin").mkdir(parents=True) + self.report = self.tools / "report" + self.report.write_text("#!/bin/sh\nfor k in %s; do eval \"echo $k=\\${$k-unset}\"; done > %s\n" + % (" ".join(KEYS), self.out)) + self.report.chmod(0o755) + flatpak = self.tools / "flatpak" + flatpak.write_text("#!/bin/sh\n" + "if [ \"$1\" = info ]; then [ \"$3\" = org.example.App ] && echo %s; exit 0; fi\n" + "exec %s\n" % (self.app, self.report)) + flatpak.chmod(0o755) + + def chromium(self): + (self.app / "files/lib/browser").mkdir(parents=True) + (self.app / "files/lib/browser/chrome_100_percent.pak").write_bytes(b"") + + def run_env(self, command, session): + env = {k: v for k, v in os.environ.items() if k not in KEYS + ("DBUS_SESSION_BUS_ADDRESS", "GAMESCOPE_WAYLAND_DISPLAY")} + env.update(session, PATH="%s:%s" % (self.tools, env.get("PATH", "/usr/bin:/bin")), + DBUS_SESSION_BUS_ADDRESS="unix:path=/dev/null") + result = subprocess.run(command, env=env, capture_output=True, text=True, timeout=30) + self.assertEqual(0, result.returncode, result.stderr) + return dict(line.split("=", 1) for line in self.out.read_text().splitlines()) + + def wrapper(self, *args, session=SESSION): + return self.run_env([sys.executable, str(BIN / "droiddeck-game-gpu"), *args, "--", str(self.report)], session) + + def flatpak(self, session=SESSION): + return self.run_env(["bash", str(BIN / "droiddeck-flatpak-run"), "--command=app", "org.example.App"], session) + + def test_the_wrapper_gives_a_program_the_game_setting(self): + self.assertEqual({key: "unset" for key in KEYS}, self.wrapper()) + self.assertEqual("gmem", self.wrapper(session={"TU_DEBUG": "sysmem", "DROIDDECK_GAME_TU_DEBUG": "gmem"})["TU_DEBUG"]) + + def test_non_flatpak_programs_keep_the_session_gpu_path(self): + values = self.wrapper(session=GPU_SESSION) + self.assertEqual(GPU_SESSION, {key: values[key] for key in GPU_SESSION}) + + def test_the_wrapper_keeps_the_session_setting_for_chromium(self): + values = self.wrapper("--chromium") + self.assertEqual(("sysmem", "unset"), (values["TU_DEBUG"], values["DROIDDECK_GAME_TU_DEBUG"])) + self.assertEqual("unset", self.wrapper("--for", str(self.app / "files"))["TU_DEBUG"]) + self.chromium() + self.assertEqual("sysmem", self.wrapper("--for", str(self.app / "files"))["TU_DEBUG"]) + + def test_without_the_game_setting_the_wrapper_changes_nothing(self): + self.assertEqual("sysmem", self.wrapper(session={"TU_DEBUG": "sysmem"})["TU_DEBUG"]) + self.assertEqual("unset", self.wrapper(session={})["TU_DEBUG"]) + + def test_the_wrapper_reports_a_missing_program(self): + result = subprocess.run([sys.executable, str(BIN / "droiddeck-game-gpu"), "--", str(self.tmp / "missing")], + capture_output=True, text=True, timeout=30) + self.assertEqual(127, result.returncode) + self.assertEqual(2, subprocess.run([sys.executable, str(BIN / "droiddeck-game-gpu")], capture_output=True, + timeout=30).returncode) + + def test_a_flatpak_app_gets_the_game_setting(self): + self.assertEqual({key: "unset" for key in KEYS}, self.flatpak(session=dict(SESSION, **GPU_SESSION))) + self.assertEqual("nolrz", self.flatpak({"TU_DEBUG": "sysmem", "DROIDDECK_GAME_TU_DEBUG": "nolrz"})["TU_DEBUG"]) + + def test_a_chromium_flatpak_keeps_the_session_setting(self): + self.chromium() + values = self.flatpak() + self.assertEqual(("sysmem", "unset"), (values["TU_DEBUG"], values["DROIDDECK_GAME_TU_DEBUG"])) + + def test_a_flatpak_without_the_game_setting_is_unchanged(self): + self.assertEqual("sysmem", self.flatpak({"TU_DEBUG": "sysmem"})["TU_DEBUG"]) + + def test_a_snap_gets_the_game_setting_unless_it_is_chromium(self): + try: + snap_run = runpy.run_path(str(BIN / "droiddeck-snap-run")) + except ImportError: + self.skipTest("PyYAML is not installed") + gpu = snap_run["game_gpu"] + snap = self.app / "files" + self.assertEqual({"KEEP": "1"}, gpu(dict(SESSION, KEEP="1"), str(snap))) + self.assertEqual({"TU_DEBUG": "nolrz"}, gpu({"TU_DEBUG": "sysmem", "DROIDDECK_GAME_TU_DEBUG": "nolrz"}, str(snap))) + self.chromium() + self.assertEqual({"TU_DEBUG": "sysmem"}, gpu(dict(SESSION), str(snap))) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/tests/test_gamescope_pointer_hold.py b/tools/tests/test_gamescope_pointer_hold.py new file mode 100644 index 0000000000..6c8d93ee4c --- /dev/null +++ b/tools/tests/test_gamescope_pointer_hold.py @@ -0,0 +1,147 @@ +from pathlib import Path +import shutil +import subprocess +import tempfile +import unittest + + +ROOT = Path(__file__).resolve().parents[2] +PATCH = ROOT / "tools/gamescope/patches/0133-constraint-relative-when-held.patch" + + +def added_source(): + return "\n".join(line[1:] for line in PATCH.read_text().splitlines() if line.startswith("+") and not line.startswith("+++")) + + +def block(text, start): + begin = text.index(start) + return text[begin:text.index("\n}", begin) + 3] + + +def rules(): + text = added_source() + return "\n".join([ + block(text, "struct PointerHold"), + block(text, "static bool pointer_hold_step"), + ]) + + +PREAMBLE = r''' +#include +#include +#include +#include +#include +''' + +MAIN = r''' +static const uint64_t FRAME = 16'666'667ul; + +static bool run(PointerHold &state, int frames, double seatDX, double seatDY, double pointerDX, double pointerDY, uint64_t &now, bool constrained = true) { + bool held = state.bHeld; + for (int i = 0; i < frames; i++) { + now += FRAME; + held = pointer_hold_step(state, constrained, seatDX, seatDY, pointerDX, pointerDY, now); + } + return held; +} + +int main() { + uint64_t now = 1'000'000'000ul; + + PointerHold cursorGame; + assert(!run(cursorGame, 600, 12.0, -9.0, 12.0, -9.0, now)); + assert(!run(cursorGame, 600, 40.0, 3.0, 39.0, 3.0, now)); + assert(!run(cursorGame, 1, 30.0, 0.0, 0.0, 0.0, now)); + assert(!run(cursorGame, 1, 30.0, 0.0, 30.0, 0.0, now)); + assert(!run(cursorGame, 1, 30.0, 0.0, 0.0, 0.0, now)); + assert(!run(cursorGame, 120, 2.0, 1.0, 0.0, 0.0, now)); + + PointerHold offset; + assert(!run(offset, 600, 25.0, 25.0, 25.0, 25.0, now)); + + PointerHold recentring; + assert(!run(recentring, 2, -40.0, 12.0, 0.0, 0.0, now)); + assert(run(recentring, 1, -40.0, 12.0, 1.0, 0.0, now)); + assert(run(recentring, 600, 0.0, 0.0, 0.0, 0.0, now)); + assert(run(recentring, 29, 10.0, 4.0, 10.0, 4.0, now)); + assert(run(recentring, 1, 20.0, 0.0, 0.0, 0.0, now)); + assert(run(recentring, 29, 10.0, 4.0, 10.0, 4.0, now)); + assert(!run(recentring, 1, 10.0, 4.0, 10.0, 4.0, now)); + + PointerHold clipped; + assert(run(clipped, 3, 0.0, 30.0, 0.0, 2.0, now)); + + PointerHold spaced; + for (int i = 0; i < 10; i++) { + assert(!run(spaced, 1, 50.0, 0.0, 0.0, 0.0, now)); + now += 600'000'000ul; + } + + PointerHold hinted; + hinted.bHeld = true; + assert(run(hinted, 29, 0.0, 15.0, 0.0, 15.0, now)); + assert(!run(hinted, 1, 0.0, 15.0, 0.0, 15.0, now)); + + PointerHold hintedCamera; + hintedCamera.bHeld = true; + assert(run(hintedCamera, 600, 30.0, -8.0, 0.0, 0.0, now)); + + PointerHold chained; + for (int i = 0; i < 6; i++) { + assert(!run(chained, 1, 50.0, 0.0, 0.0, 0.0, now)); + now += 400'000'000ul; + } + + PointerHold released; + assert(run(released, 3, 0.0, -25.0, 0.0, 0.0, now)); + assert(!run(released, 1, 0.0, -25.0, 0.0, 0.0, now, false)); + assert(!run(released, 2, 0.0, -25.0, 0.0, 0.0, now)); + + puts("ok"); + return 0; +} +''' + + +@unittest.skipUnless(shutil.which("c++"), "needs a C++ compiler") +class PointerHoldTest(unittest.TestCase): + def test_only_a_game_that_holds_the_x_pointer_goes_relative(self): + with tempfile.TemporaryDirectory() as tmp: + source = Path(tmp) / "hold.cpp" + binary = Path(tmp) / "hold" + source.write_text(PREAMBLE + rules() + MAIN) + subprocess.run(["c++", "-std=c++17", "-Wall", "-Wextra", "-Werror", str(source), "-o", str(binary)], check=True) + self.assertEqual(subprocess.run([str(binary)], capture_output=True, text=True, check=True).stdout.strip(), "ok") + + def test_a_hinted_constraint_starts_relative_and_others_wait_for_the_hold(self): + added = [line.strip() for line in added_source().splitlines()] + self.assertIn("update_pointer_hold( pPaintFocus, bHasPointerConstraint && bImageEmpty && nRelativeMouse != 2 && !bExcludedAppId,", added) + self.assertIn("pPaintFocus->cursor && pPaintFocus->cursor->IsConstrained() );", added) + self.assertIn("s_Hold.bHeld = bHinted;", added) + self.assertIn("if ( s_bTracking && bHinted && !s_bHinted )", added) + self.assertIn("const bool bGameHoldsPointer = bHasPointerConstraint && s_bPointerHeld;", added) + self.assertIn(": ( bForcedRelativeMouse || s_bFollowClientPointer || ( bImageEmpty && bGameHoldsPointer && !bExcludedAppId ) );", added) + + def test_a_new_window_or_constraint_starts_its_own_hold(self): + tracker = block(added_source(), "static void update_pointer_hold") + reset = tracker.index("if ( pWindow != s_pWindow || pConstraint != s_pConstraint )") + self.assertIn("const steamcompmgr_win_t *pWindow = pFocus->inputFocusWindow;", tracker) + constraint = tracker.index("wlserver.GetCursorConstraint();") + self.assertLess(tracker.index("wlserver_lock();"), constraint) + self.assertLess(constraint, tracker.index("wlserver_unlock();")) + self.assertLess(reset, tracker.index("if ( s_bTracking && bHinted && !s_bHinted )")) + self.assertIn("s_bTracking = false;", tracker[reset:reset + 120]) + + def test_the_motion_sent_to_clients_is_counted(self): + added = [line.strip() for line in added_source().splitlines()] + self.assertIn("wlserver.flSentDX += unaccel_dx;", added) + self.assertIn("wlserver.flSentDY += unaccel_dy;", added) + + def test_the_forced_and_follow_rules_are_unchanged(self): + removed = [line[1:].strip() for line in PATCH.read_text().splitlines() if line.startswith("-") and not line.startswith("---")] + self.assertEqual(removed, [": ( bForcedRelativeMouse || s_bFollowClientPointer || ( bImageEmpty && bHasPointerConstraint && !bExcludedAppId ) );"]) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/tests/test_memory_pressure.py b/tools/tests/test_memory_pressure.py index 8aa2d1f2c5..13f9e2f8d3 100644 --- a/tools/tests/test_memory_pressure.py +++ b/tools/tests/test_memory_pressure.py @@ -32,7 +32,7 @@ step() { :; } bl_zram_usage() { _bl_rss=$rss _bl_swap=$client_swap; } bl_zram_send() { echo "send:$1:$3"; rss=$((rss - reclaimed)); _bl_pageout_complete=${pageout_complete:-1}; } ''' + functions + '\nbl_memory_read\n' + body - result = run_bash(harness) + result = run_bash('NOW=0\n' + harness.replace('SECONDS', 'NOW')) self.assertEqual(0, result.returncode, result.stderr) self.assertEqual('', result.stderr) return result.stdout.splitlines() @@ -168,7 +168,7 @@ bl_session_others() { _bl_session=(321 654); } bl_zram_usage() { _bl_rss=$rss _bl_swap=$swap; } bl_zram_send() { echo "send:$1:$3"; rss=$((rss - pushed)); swap=$((swap + pushed)); _bl_pageout_complete=$complete; } ''' + functions + '\nbl_memory_read\n' + body - result = run_bash(harness) + result = run_bash('NOW=0\n' + harness.replace('SECONDS', 'NOW')) self.assertEqual(0, result.returncode, result.stderr) self.assertEqual('', result.stderr) return result.stdout.splitlines() @@ -229,9 +229,34 @@ echo "backoff:$_bl_tier_backoff" self.assertEqual(['send:1:game', 'send:1:game'], self.run_policy(''' _bl_tier_backoff=300 SECONDS=0; bl_session_pressure -swap=0 SECONDS=20; bl_session_pressure SECONDS=30; bl_session_pressure +''')) + + def test_nearly_out_of_memory_still_backs_off_when_the_game_reads_its_pageout_back(self): + self.memory(available=512) + self.assertEqual(['send:1:game', 'backoff:60', 'send:1:game'], self.run_policy(''' +SECONDS=0; bl_session_pressure +swap=0 +SECONDS=30; bl_session_pressure +echo "backoff:$_bl_tier_backoff" +SECONDS=59; bl_session_pressure +SECONDS=60; bl_session_pressure +SECONDS=90; bl_session_pressure +''')) + + def test_nearly_out_of_memory_retries_a_skipped_pageout_after_30_seconds(self): + self.memory(available=512) + self.assertEqual(['send:1:game', 'send:1:game'], self.run_policy(''' +SECONDS=0; bl_session_pressure +swap=0 +SECONDS=30; bl_session_pressure +_bl_tier_backoff=300 +saved=$rss; rss=$((128 * 1024)) +SECONDS=330; bl_session_pressure +rss=$saved +SECONDS=359; bl_session_pressure +SECONDS=360; bl_session_pressure ''')) def test_small_swap_headroom_skips_the_pageout(self): diff --git a/tools/tests/test_netlink_preload.py b/tools/tests/test_netlink_preload.py index 64c3b9c97a..aedbdbd733 100644 --- a/tools/tests/test_netlink_preload.py +++ b/tools/tests/test_netlink_preload.py @@ -118,6 +118,7 @@ PROGRAM = r""" #include #include #include +#include #include #include @@ -317,6 +318,8 @@ static void *ordinary_traffic(void *argument) { probe_end(counts); require(counts[0] == 0, "ordinary setup avoids netlink lock"); + int pipes[2]; + require(pipe(pipes) == 0, "ordinary pipe setup"); probe_begin(0); const int rounds = 32; for (int round = 0; round < rounds; round++) { @@ -338,6 +341,15 @@ static void *ordinary_traffic(void *argument) { message.msg_name = &source; message.msg_namelen = sizeof(source); require(recvmsg(server, &message, 0) == 1 && buffer == 'z', "ordinary recvmsg"); + require(write(client, "w", 1) == 1, "ordinary write"); + require(read(server, &buffer, 1) == 1 && buffer == 'w', "ordinary read"); + char pair[2]; + struct iovec pieces[2] = {{.iov_base = "v", .iov_len = 1}, {.iov_base = "u", .iov_len = 1}}; + require(writev(client, pieces, 2) == 2, "ordinary writev"); + require(recv(server, pair, 2, MSG_WAITALL) == 2 && pair[0] == 'v' && pair[1] == 'u', + "ordinary writev data"); + require(write(pipes[1], "p", 1) == 1 && read(pipes[0], &buffer, 1) == 1 && buffer == 'p', + "ordinary pipe"); length = sizeof(source); require(getpeername(client, (struct sockaddr *)&source, &length) == 0, "ordinary peer"); const int options[] = {SO_TYPE, SO_DOMAIN, SO_PROTOCOL}; @@ -368,6 +380,8 @@ static void *ordinary_traffic(void *argument) { require(counts[2] == (unsigned)rounds, "ordinary traffic has only requested getpeername"); require(counts[3] == 0, "ordinary traffic avoids restoration fstat"); require(counts[4] == (unsigned)rounds * 3, "ordinary socket options use one syscall each"); + close(pipes[0]); + close(pipes[1]); close(client); close(server); if (server != listener) close(listener); @@ -798,6 +812,52 @@ static void connect_test(void) { close(descriptor); } +static ssize_t link_reply(int descriptor, const char *path, unsigned char *buffer, size_t capacity) { + struct { + struct nlmsghdr header; + struct ifinfomsg info; + } query = { + .header = {.nlmsg_len = sizeof(query), .nlmsg_type = RTM_GETLINK, + .nlmsg_flags = NLM_F_REQUEST | NLM_F_ACK, .nlmsg_seq = 42}, + .info = {.ifi_index = 1} + }; + struct iovec parts[2] = {{.iov_base = &query.header, .iov_len = sizeof(query.header)}, + {.iov_base = &query.info, .iov_len = sizeof(query.info)}}; + struct msghdr message = {.msg_iov = parts, .msg_iovlen = 2}; + ssize_t sent; + if (!strcmp(path, "send")) sent = send(descriptor, &query, sizeof(query), 0); + else if (!strcmp(path, "sendmsg")) sent = sendmsg(descriptor, &message, 0); + else if (!strcmp(path, "write")) sent = write(descriptor, &query, sizeof(query)); + else sent = writev(descriptor, parts, 2); + require(sent == sizeof(query), path); + ssize_t received = read(descriptor, buffer, capacity); + require(received > 0, "read reply"); + return received; +} + +static void write_test(void) { + const char *paths[] = {"send", "sendmsg", "write", "writev"}; + unsigned char expected[4096]; + int descriptor = route_socket(); + ssize_t expected_length = link_reply(descriptor, paths[0], expected, sizeof(expected)); + struct nlmsghdr *header = (struct nlmsghdr *)expected; + require(header->nlmsg_type == RTM_NEWLINK && header->nlmsg_seq == 42 + && header->nlmsg_pid == port_of(descriptor), "send reply"); + require(expected_length > (ssize_t)NLMSG_ALIGN(header->nlmsg_len), "acknowledged reply"); + struct nlmsghdr *acknowledgement = (struct nlmsghdr *)(expected + NLMSG_ALIGN(header->nlmsg_len)); + require(acknowledgement->nlmsg_type == NLMSG_ERROR + && ((struct nlmsgerr *)NLMSG_DATA(acknowledgement))->error == 0, "send acknowledgement"); + for (size_t index = 1; index < sizeof(paths) / sizeof(paths[0]); index++) { + unsigned char buffer[4096]; + ssize_t length = link_reply(descriptor, paths[index], buffer, sizeof(buffer)); + require(length == expected_length, "reply length"); + require(!memcmp(buffer, expected, length), "reply bytes"); + } + require(recv(descriptor, expected, sizeof(expected), MSG_DONTWAIT) == -1 && errno == EAGAIN, + "no extra replies"); + close(descriptor); +} + static void receive_test(void) { int descriptor = route_socket(); send_link(descriptor, 1, 0); @@ -985,6 +1045,7 @@ int main(int argc, char **argv) { else if (!strcmp(argv[1], "nonblocking")) send_timeout_test(1); else if (!strcmp(argv[1], "connect")) connect_test(); else if (!strcmp(argv[1], "receive")) receive_test(); + else if (!strcmp(argv[1], "write")) write_test(); else if (!strcmp(argv[1], "replace")) replacement_test(0); else if (!strcmp(argv[1], "raw_replace")) replacement_test(1); else if (!strcmp(argv[1], "shared")) shared_test(0); @@ -1160,6 +1221,9 @@ class NetlinkPreloadTest(unittest.TestCase): def test_kernel_connect_and_disconnect(self): self.run_program("connect") + def test_write_and_writev_requests_get_the_same_replies_as_send(self): + self.run_program("write") + def test_receive_sources_and_truncation(self): self.run_program("receive") diff --git a/tools/tests/test_pr_discord.py b/tools/tests/test_pr_discord.py index 0533e7094c..a80efdff75 100644 --- a/tools/tests/test_pr_discord.py +++ b/tools/tests/test_pr_discord.py @@ -14,17 +14,30 @@ class PrDiscordTest(unittest.TestCase): self.discord.request.return_value = {"id": "1557547293375332465"} self.github = patch.object(module, "github").start() self.addCleanup(patch.stopall) - self.github.side_effect = lambda path, method="GET", body=None: self.pull if "/pulls/" in path else self.comment + def github_request(path, method="GET", body=None): + if "/pulls/" in path: + return self.pull + if "/commits/" in path: + return {"commit": {"message": "Fix reconnect behavior\n\nMore details"}} + if path.endswith("/issues/comments/10"): + if method == "PATCH": + self.comment["body"] = body["body"] + return self.comment + return self.comment + self.github.side_effect = github_request patch.object(module, "report_comment", return_value=self.comment).start() - def publish(self): - module.sync("publish", "Droid-Deck/DroidDeck", "410", self.discord, "a" * 40, + def publish(self, sha=None): + if sha is not None: + self.pull["head"]["sha"] = sha + sha = sha or "a" * 40 + module.sync("publish", "Droid-Deck/DroidDeck", "410", self.discord, sha, "https://github.com/Droid-Deck/DroidDeck-CI/releases/download/pr-410/build.apk", "https://github.com/Droid-Deck/DroidDeck-CI/releases/tag/pr-410") def save_state(self): self.comment["body"] += '\n' + "webhook_id": self.discord.id, "message_id": "1557547293375332465", "sha": "a" * 40}) + ' -->' def test_create_confirmed_message_and_persist_reference(self): self.publish() @@ -36,12 +49,76 @@ class PrDiscordTest(unittest.TestCase): self.assertEqual("1557547293375332465", module.saved_message(saved, self.discord.id)) self.assertIn("Build download", saved) - def test_new_build_updates_existing_message(self): + def test_same_build_updates_existing_message_without_duplicate(self): self.save_state() self.publish() self.assertEqual("PATCH", self.discord.request.call_args.args[0]) saved = self.github.call_args.args[2]["body"] self.assertEqual(1, len(module.STATE.findall(saved))) + self.assertIn('"sha": "' + "a" * 40 + '"', saved) + + def test_new_commit_retires_old_message_and_posts_replacement(self): + self.save_state() + old_content = module.build_content("Droid-Deck/DroidDeck", "410", self.pull["title"], "a" * 40, + "apk", "release") + self.discord.request.side_effect = [ + {"content": old_content}, {"id": "1557547293375332465"}, {"id": "1557547293375332466"}] + self.publish("b" * 40) + calls = self.discord.request.call_args_list + self.assertEqual(["GET", "PATCH", "POST"], [call.args[0] for call in calls]) + self.assertIn("**Superseded by `bbbbbbb`**", calls[1].args[2]["content"]) + self.assertIn("~~Download:", calls[1].args[2]["content"]) + self.assertIn("Latest commit: Fix reconnect behavior", calls[2].args[2]["content"]) + saved = self.github.call_args.args[2]["body"] + self.assertEqual("1557547293375332466", module.saved_message(saved, self.discord.id)) + self.assertIn('"sha": "' + "b" * 40 + '"', saved) + + def test_publish_supersede_rerun_and_close_lifecycle(self): + messages = {} + created = [] + next_id = 1 + + def discord_request(method, suffix="", body=None): + nonlocal next_id + if method == "POST": + message_id = str(1557547293375332465 + next_id) + next_id += 1 + messages[message_id] = {"id": message_id, "content": body["content"]} + created.append(message_id) + return messages[message_id] + message_id = suffix.split("/")[-1] + if method == "GET": + return messages.get(message_id) + if method == "PATCH": + if message_id not in messages: + return None + messages[message_id].update(body) + return messages[message_id] + self.fail(f"Unexpected Discord method: {method}") + + self.discord.request.side_effect = discord_request + self.publish("a" * 40) + first_id = created[-1] + self.publish("b" * 40) + second_id = created[-1] + self.publish("b" * 40) + self.assertEqual(2, len(created)) + self.assertIn("**Superseded by `bbbbbbb`**", messages[first_id]["content"]) + self.assertIn("`bbbbbbb`", messages[second_id]["content"]) + + self.pull.update(state="closed", merged=True) + module.sync("retire", "Droid-Deck/DroidDeck", "410", self.discord) + self.assertTrue(messages[second_id]["content"].startswith("**Merged**")) + self.assertIn("~~Latest commit:", messages[second_id]["content"]) + + def test_legacy_state_uses_embedded_short_sha_to_supersede(self): + self.save_state() + self.comment["body"] = self.comment["body"].replace(', "sha": "' + "a" * 40 + '"', '') + old_content = "**Signed test build** `pr-410` · `aaaaaaa`\nold build" + self.discord.request.side_effect = [ + {"content": old_content}, {"id": "1557547293375332465"}, {"id": "1557547293375332466"}] + self.publish("b" * 40) + self.assertEqual(["GET", "PATCH", "POST"], [call.args[0] for call in self.discord.request.call_args_list]) def test_deleted_message_is_recreated(self): self.save_state() @@ -78,6 +155,10 @@ class PrDiscordTest(unittest.TestCase): module.sync("retire", "Droid-Deck/DroidDeck", "410", self.discord) self.discord.request.assert_not_called() + def test_superseded_content_is_idempotent(self): + once = module.retired_content("first\n\nlast", superseded_by="a" * 40) + self.assertEqual(once, module.retired_content(once, superseded_by="a" * 40)) + def test_old_build_without_saved_id_is_not_guessed(self): self.pull["state"] = "closed" module.sync("retire", "Droid-Deck/DroidDeck", "410", self.discord) @@ -153,6 +234,29 @@ class PrDiscordTest(unittest.TestCase): self.assertLessEqual(len(content), 1800) self.assertLessEqual(len(module.retired_content(content, True)), 2000) + def test_commit_subject_is_sanitized_and_uses_only_first_line(self): + content = module.build_content("Droid-Deck/DroidDeck", "410", "title", "a" * 40, + "apk", "release", commit_message="Fix *input* @everyone\nDetails") + self.assertIn(r"Latest commit: Fix \*input\* @everyone", content) + self.assertNotIn("Details", content) + + def test_commit_lookup_failure_does_not_block_announcement(self): + def unavailable_commit(path, method="GET", body=None): + if "/commits/" in path: + raise RuntimeError("GitHub request failed") + return self.pull if "/pulls/" in path else self.comment + self.github.side_effect = unavailable_commit + self.publish() + self.assertEqual("POST", self.discord.request.call_args.args[0]) + self.assertNotIn("Latest commit:", self.discord.request.call_args.args[2]["content"]) + + def test_empty_commit_response_does_not_block_announcement(self): + self.github.side_effect = lambda path, method="GET", body=None: ( + self.pull if "/pulls/" in path else None if "/commits/" in path else self.comment) + self.publish() + self.assertEqual("POST", self.discord.request.call_args.args[0]) + self.assertNotIn("Latest commit:", self.discord.request.call_args.args[2]["content"]) + original_report = module.report_comment diff --git a/tools/tests/test_preload_snapshots.py b/tools/tests/test_preload_snapshots.py index 6629d1ab22..2d0ee01642 100644 --- a/tools/tests/test_preload_snapshots.py +++ b/tools/tests/test_preload_snapshots.py @@ -150,6 +150,30 @@ class PreloadSnapshotTest(unittest.TestCase): with self.assertRaisesRegex(ValueError, 'successful main'): snapshots.artifact_bytes(self.data['origin'], self.root / 'cache') + def test_origin_apk_without_a_newer_output_reads_the_rest(self): + from zipfile import ZipFile + newest = 'libddnatv-hook.so' + apk = io.BytesIO() + with ZipFile(apk, 'w') as z: + for name, value in self.binaries.items(): + if name != newest: + z.writestr('assets/linuxfs/' + name, value) + outer = io.BytesIO() + with ZipFile(outer, 'w') as z: + z.writestr('app-release.apk', apk.getvalue()) + digest = snapshots.sha(outer.getvalue()) + origin = dict(self.data['origin'], artifact_sha256=digest) + build = dict(event='push', head_branch='main', conclusion='success', head_sha=origin['commit'], + path='.github/workflows/build.yml', repository=dict(full_name=snapshots.REPO)) + artifact = dict(name='droiddeck-apk', workflow_run=dict(id=origin['run']), digest='sha256:' + digest) + cache = self.root / 'cache' + cache.mkdir() + (cache / (digest + '.zip')).write_bytes(outer.getvalue()) + with patch.object(snapshots, 'api', side_effect=[build, artifact]): + content = snapshots.artifact_bytes(origin, cache) + self.assertNotIn(newest, content) + self.assertEqual(set(content), snapshots.FILES - {newest}) + def test_corrupt_archive_is_rejected(self): with self.assertRaisesRegex(ValueError, 'checksum'): snapshots.unpack(self.content + b'tampered', self.data) diff --git a/tools/tests/test_quest_driver_download.py b/tools/tests/test_quest_driver_download.py new file mode 100644 index 0000000000..aed4f47c1b --- /dev/null +++ b/tools/tests/test_quest_driver_download.py @@ -0,0 +1,56 @@ +import importlib.util +import io +import unittest +import urllib.error +from pathlib import Path +from unittest import mock + +SCRIPT = Path(__file__).resolve().parents[1] / "quest/build-driver.py" +spec = importlib.util.spec_from_file_location("build_driver", SCRIPT) +driver = importlib.util.module_from_spec(spec) +spec.loader.exec_module(driver) + + +def http_error(code): + return urllib.error.HTTPError("https://example.invalid/a.zip", code, "error", {}, io.BytesIO()) + + +class Response(io.BytesIO): + def __enter__(self): + return self + + def __exit__(self, *args): + self.close() + + +class DriverDownloadTest(unittest.TestCase): + def fetch(self, *outcomes): + calls = [] + + def urlopen(url, timeout): + calls.append(url) + outcome = outcomes[len(calls) - 1] + if isinstance(outcome, Exception): + raise outcome + return Response(outcome) + + with mock.patch.object(driver.urllib.request, "urlopen", urlopen), mock.patch.object(driver.time, "sleep") as sleep: + try: + return driver.download("https://example.invalid/a.zip"), len(calls), sleep.call_count + except Exception as error: + return error, len(calls), sleep.call_count + + def test_a_timeout_or_server_error_is_retried(self): + self.assertEqual((b"zip", 3, 2), self.fetch(TimeoutError("read timed out"), http_error(502), b"zip")) + + def test_a_missing_file_fails_at_once(self): + error, calls, sleeps = self.fetch(http_error(404)) + self.assertEqual((404, 1, 0), (error.code, calls, sleeps)) + + def test_it_gives_up_after_the_last_attempt(self): + error, calls, sleeps = self.fetch(*[http_error(504)] * 4) + self.assertEqual((504, 4, 3), (error.code, calls, sleeps)) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/tests/test_runtime_inputs.py b/tools/tests/test_runtime_inputs.py index 60c0fc9920..906bef4c2f 100644 --- a/tools/tests/test_runtime_inputs.py +++ b/tools/tests/test_runtime_inputs.py @@ -33,6 +33,9 @@ class RuntimeInputsTest(unittest.TestCase): self.source = self.root / 'tools/linuxfs/preload/test.c' self.source.parent.mkdir(parents=True) self.source.write_text('current source') + service = self.root / 'app/src/main/assets/linuxfs/usr/local/lib/droiddeck-ubisoft/droiddeck-upc.exe' + service.parent.mkdir(parents=True) + service.write_bytes(b'MZ service') self.audio(['pactl', 'modules/arm64/module-aaudio-sink.so', 'modules/arm64/module-directaudio-native-sink.so']) self.packs() @@ -179,6 +182,13 @@ class RuntimeInputsTest(unittest.TestCase): with self.assertRaisesRegex(ValueError, 'xbox pack provides'): runtime.check_apk(apk, self.root) + def test_an_apk_still_carrying_the_ubisoft_service_is_rejected(self): + name = 'assets/linuxfs/usr/local/lib/droiddeck-ubisoft/droiddeck-upc.exe' + self.assertIn(name, runtime.outputs(self.root)) + apk = self.current_apk(self.root / 'bundled.apk', {name: b'MZ service'}) + with self.assertRaisesRegex(ValueError, 'ubisoft pack provides'): + runtime.check_apk(apk, self.root) + def test_an_apk_still_carrying_the_powervr_runtime_is_rejected(self): apk = self.current_apk(self.root / 'bundled.apk', {'assets/hybris/runtime.tzst': b'runtime'}) with self.assertRaisesRegex(ValueError, 'powervr pack provides'): diff --git a/tools/tests/test_session_appimage.py b/tools/tests/test_session_appimage.py index f1ba2d11af..3fc5352427 100644 --- a/tools/tests/test_session_appimage.py +++ b/tools/tests/test_session_appimage.py @@ -6,8 +6,12 @@ import tempfile import unittest from pathlib import Path -SESSION = Path(__file__).resolve().parents[1] / "linuxfs/overlay/usr/local/bin/droiddeck-session" +BIN = Path(__file__).resolve().parents[1] / "linuxfs/overlay/usr/local/bin" +SESSION = BIN / "droiddeck-session" +EXEC = BIN / "droiddeck-appimage-exec" URUNTIME = "/usr/local/lib/droiddeck/uruntime" +FEX = "/usr/local/bin/droiddeck-fex" +REPORT = "#!/bin/sh\nprintf '%%s\\n' \"TARGET=${TARGET_APPIMAGE:-} EXTRACT=${APPIMAGE_EXTRACT_AND_RUN:-}\" %s \"$@\"\n" def target_case(): @@ -15,34 +19,54 @@ def target_case(): return match.group(0) -class SessionAppImageTest(unittest.TestCase): +class AppImageExecTest(unittest.TestCase): def setUp(self): self.dir = Path(tempfile.mkdtemp()) self.addCleanup(shutil.rmtree, self.dir, True) self.image = self.dir / "rpcs3.AppImage" - self.image.write_bytes(b"\x7fELF") - self.uruntime = self.dir / "uruntime" - self.uruntime.write_text("#!/bin/sh\n") - self.uruntime.chmod(0o755) + self.machine(183) + self.uruntime = self.tool("uruntime", "uruntime") + self.fex = self.tool("droiddeck-fex", "fex") - def launch(self, fex=()): - script = ("set -u\n" - "run_program() { printf '%%s\\n' \"TARGET=${TARGET_APPIMAGE:-} EXTRACT=${APPIMAGE_EXTRACT_AND_RUN:-}\" \"$@\"; exit 0; }\n" - "target=%s\nfex=(%s)\nset -- --no-gui\n" % (self.image, " ".join(fex)) - + target_case().replace(URUNTIME, str(self.uruntime))) + def machine(self, number): + self.image.write_bytes(b"\x7fELF" + bytes(14) + number.to_bytes(2, "little") + bytes(44)) + + def tool(self, name, label): + path = self.dir / name + path.write_text(REPORT % label) + path.chmod(0o755) + return path + + def launch(self): + script = self.dir / "exec" + script.write_text(EXEC.read_text().replace(URUNTIME, str(self.uruntime)).replace(FEX, str(self.fex))) env = {k: v for k, v in os.environ.items() if k not in ("TARGET_APPIMAGE", "APPIMAGE_EXTRACT_AND_RUN")} - return subprocess.run(["bash", "-c", script], env=env, capture_output=True, text=True, timeout=30).stdout.splitlines() + return subprocess.run(["bash", str(script), str(self.image), "--no-gui"], env=env, + capture_output=True, text=True, timeout=30).stdout.splitlines() def test_an_arm64_image_runs_through_the_shipped_runtime(self): - self.assertEqual(["TARGET=%s EXTRACT=1" % self.image, str(self.uruntime), "--no-gui"], self.launch()) + self.assertEqual(["TARGET=%s EXTRACT=1" % self.image, "uruntime", "--no-gui"], self.launch()) def test_without_the_shipped_runtime_the_image_runs_itself(self): self.uruntime.unlink() - self.assertEqual(["TARGET= EXTRACT=1", str(self.image), "--no-gui"], self.launch()) + self.image.write_text(REPORT % "own") + self.assertEqual(["TARGET= EXTRACT=1", "own", "--no-gui"], self.launch()) def test_an_x86_image_still_starts_under_fex(self): - fex = ("/usr/local/bin/droiddeck-fex", "run", "--mode", "on", "--") - self.assertEqual(["TARGET= EXTRACT=1", *fex, str(self.image), "--no-gui"], self.launch(fex)) + self.machine(62) + self.assertEqual(["TARGET= EXTRACT=1", "fex", "run", "--mode", "on", "--", str(self.image), "--no-gui"], self.launch()) + + def test_an_x86_image_without_fex_uses_the_shipped_runtime(self): + self.machine(62) + self.fex.unlink() + self.assertEqual(["TARGET=%s EXTRACT=1" % self.image, "uruntime", "--no-gui"], self.launch()) + + def test_the_session_starts_images_through_the_shared_launcher(self): + script = ("set -u\n" + "run_program() { printf '%%s\\n' \"$@\"; exit 0; }\n" + "target=%s\nfex=()\nset -- --no-gui\n" % self.image + target_case()) + out = subprocess.run(["bash", "-c", script], capture_output=True, text=True, timeout=30).stdout.splitlines() + self.assertEqual(["/usr/local/bin/droiddeck-appimage-exec", str(self.image), "--no-gui"], out) if __name__ == "__main__": diff --git a/tools/tests/test_session_bus.py b/tools/tests/test_session_bus.py new file mode 100644 index 0000000000..3528500f1d --- /dev/null +++ b/tools/tests/test_session_bus.py @@ -0,0 +1,55 @@ +import re +import shutil +import subprocess +import tempfile +import unittest +from pathlib import Path + +SESSION = Path(__file__).resolve().parents[1] / "linuxfs/overlay/usr/local/bin/droiddeck-session" + +FAKE_DAEMON = """#!/usr/bin/env python3 +import socket, sys, time +address = next(a for a in sys.argv if a.startswith("--address=")) +path = address.split("unix:path=", 1)[1] +open(sys.argv[0] + ".args", "w").write(" ".join(sys.argv[1:])) +s = socket.socket(socket.AF_UNIX) +s.bind(path) +time.sleep(5) +""" + + +class SessionBusTest(unittest.TestCase): + def setUp(self): + self.root = Path(tempfile.mkdtemp()) + self.addCleanup(shutil.rmtree, self.root, True) + self.bin = self.root / "bin" + self.bin.mkdir() + self.runtime = self.root / "run" + self.runtime.mkdir() + daemon = self.bin / "dbus-daemon" + daemon.write_text(FAKE_DAEMON) + daemon.chmod(0o755) + + def run_block(self, env_address=""): + match = re.search(r'^ *if \[ -z "\$\{DBUS_SESSION_BUS_ADDRESS:-\}" \]; then\n.*?^ *fi\n *fi\n', + SESSION.read_text(), re.M | re.S) + self.assertIsNotNone(match) + script = "nap() { sleep \"$1\"; }\n" + match.group(0) + 'echo "ADDRESS=$DBUS_SESSION_BUS_ADDRESS"\nkill %1 2>/dev/null\n' + env = {"PATH": "%s:/usr/bin:/bin" % self.bin, "XDG_RUNTIME_DIR": str(self.runtime)} + if env_address: + env["DBUS_SESSION_BUS_ADDRESS"] = env_address + return subprocess.run(["bash", "-c", script], env=env, capture_output=True, text=True, timeout=30).stdout + + def test_steam_mode_exports_its_own_session_bus(self): + out = self.run_block() + self.assertIn("ADDRESS=unix:path=%s/bus" % self.runtime, out) + self.assertIn("--session", (self.bin / "dbus-daemon.args").read_text()) + + def test_an_existing_session_bus_is_kept(self): + out = self.run_block("unix:path=/somewhere/else") + self.assertIn("ADDRESS=unix:path=/somewhere/else", out) + self.assertFalse((self.bin / "dbus-daemon.args").exists()) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/tests/test_session_machine_id.py b/tools/tests/test_session_machine_id.py new file mode 100644 index 0000000000..20fb3c4b1e --- /dev/null +++ b/tools/tests/test_session_machine_id.py @@ -0,0 +1,61 @@ +import re +import shutil +import subprocess +import tempfile +import unittest +from pathlib import Path + +SESSION = Path(__file__).resolve().parents[1] / "linuxfs/overlay/usr/local/bin/droiddeck-session" +FRESH = "0123456789abcdef0123456789abcdef" + + +class SessionMachineIdTest(unittest.TestCase): + def setUp(self): + self.root = Path(tempfile.mkdtemp()) + self.addCleanup(shutil.rmtree, self.root, True) + self.bin = self.root / "bin" + self.bin.mkdir() + self.file = self.root / "machine-id" + + def generator(self, output, status=0): + tool = self.bin / "dbus-uuidgen" + tool.write_text("#!/bin/sh\necho %s\nexit %d\n" % (output, status)) + tool.chmod(0o755) + + def ensure(self): + match = re.search(r"^ensure_machine_id\(\) \{\n.*?^\} 2>/dev/null\n", SESSION.read_text(), re.M | re.S) + script = match.group(0).replace("/etc/machine-id", str(self.file)) + "ensure_machine_id\n" + subprocess.run(["bash", "-c", script], env={"PATH": "%s:/usr/bin:/bin" % self.bin}, timeout=30, check=True) + return self.file.read_text() if self.file.exists() else None + + def test_the_empty_id_shipped_in_the_runtime_gets_a_fresh_one(self): + self.file.write_text("") + self.generator(FRESH) + self.assertEqual(FRESH + "\n", self.ensure()) + self.assertEqual([self.file.name], [p.name for p in self.root.iterdir() if p.is_file()]) + + def test_a_missing_or_malformed_id_is_replaced(self): + self.generator(FRESH) + self.assertEqual(FRESH + "\n", self.ensure()) + self.file.write_text("uninitialized\n") + self.assertEqual(FRESH + "\n", self.ensure()) + self.file.write_text("fedcba9876543210fedcba9876543210\nextra\n") + self.assertEqual(FRESH + "\n", self.ensure()) + self.file.write_text("0" * 32 + "\n") + self.assertEqual(FRESH + "\n", self.ensure()) + + def test_a_valid_id_is_never_changed(self): + self.file.write_text("fedcba9876543210fedcba9876543210\n") + self.generator(FRESH) + self.assertEqual("fedcba9876543210fedcba9876543210\n", self.ensure()) + + def test_without_a_usable_generator_the_file_is_left_alone(self): + self.file.write_text("") + self.generator(FRESH, status=1) + self.assertEqual("", self.ensure()) + self.generator("not-an-id") + self.assertEqual("", self.ensure()) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/tests/test_steam_cold_launch.py b/tools/tests/test_steam_cold_launch.py index 1695ad0e16..0fe085ff9e 100644 --- a/tools/tests/test_steam_cold_launch.py +++ b/tools/tests/test_steam_cold_launch.py @@ -41,6 +41,7 @@ class SteamColdLaunchTest(unittest.TestCase): "#!/bin/sh\n" "printf '%s\n' \"$@\" > \"$AGENT_ARGS\"\n" "n=$(cat \"$AGENT_COUNT\" 2>/dev/null || echo 0); n=$((n + 1)); echo $n > \"$AGENT_COUNT\"\n" + "[ \"$1\" = --steam-ready ] && exit \"${READY_STATUS:-0}\"\n" "exit \"$AGENT_STATUS\"\n") agent.chmod(0o755) sleep = self.bin / "sleep" @@ -55,12 +56,13 @@ class SteamColdLaunchTest(unittest.TestCase): pgrep.chmod(0o755) self.block = LAUNCH_BLOCK.replace("/usr/local/bin/droiddeck-agent", str(agent)) - def run_launch(self, target, focus="769", helper_status=0, running_after=999): + def run_launch(self, target, focus="769", helper_status=0, running_after=999, ready_status=0): env = dict(os.environ, HOME=str(self.root), BL_LAUNCH_DIR=str(self.launch_dir), PATH=str(self.bin) + os.pathsep + os.environ["PATH"], AGENT_ARGS=str(self.agent_args), SLEEP_ARGS=str(self.sleep_args), AGENT_COUNT=str(self.agent_count), AGENT_STATUS=str(helper_status), - FOCUS=focus, FOCUS_COUNT=str(self.focus_count), RUNNING_AFTER=str(running_after)) + FOCUS=focus, FOCUS_COUNT=str(self.focus_count), RUNNING_AFTER=str(running_after), + READY_STATUS=str(ready_status)) script = self.block + "\nprintf 'ARG:%s\n' \"$@\"\nwait\n" url = target if target.startswith("steam://") else "steam://rungameid/" + target result = subprocess.run(["bash", "-c", script, "cold-launch", url], @@ -72,28 +74,40 @@ class SteamColdLaunchTest(unittest.TestCase): return [l for l in result.stdout.splitlines() if "launching the requested game" in l] def test_a_shortcut_that_takes_focus_is_handed_over_once_without_waiting_for_the_overview(self): - result = self.run_launch(SHORTCUT, focus="769 769 4242") + result = self.run_launch(SHORTCUT, focus="769 4242") self.assertEqual(SHORTCUT, (self.launch_dir / "steam-game").read_text().strip()) self.assertEqual(1, len(self.hand_offs(result)), result.stdout) - self.assertFalse(self.agent_args.exists(), result.stdout) - self.assertEqual(["1"], self.sleep_args.read_text().split()) + self.assertEqual(["--steam-ready"], self.agent_args.read_text().splitlines()) + self.assertFalse(self.sleep_args.exists()) def test_a_shortcut_that_never_takes_focus_is_handed_over_again_after_the_overview_wait(self): result = self.run_launch(SHORTCUT, focus="769", helper_status=0) - self.assertEqual(2, len(self.hand_offs(result)), result.stdout) - self.assertIn("launching the requested game again", result.stdout) - self.assertEqual(["--wait-steam-shortcut-overview", SHORTCUT, "45"], self.agent_args.read_text().splitlines()) + self.assertEqual(1, len(self.hand_offs(result)), result.stdout) + self.assertIn("clearing the pending launch interstitial", result.stdout) + self.assertEqual(["--steam-clear-pending-interstitial", "3551182975"], self.agent_args.read_text().splitlines()) self.assertEqual(["1"] * 20, self.sleep_args.read_text().split()) def test_a_timed_out_overview_still_gets_one_more_hand_off(self): result = self.run_launch(SHORTCUT, focus="769", helper_status=1) self.assertEqual(2, len(self.hand_offs(result)), result.stdout) self.assertIn("overview status 1", result.stdout) + self.assertIn("launching the requested game again", result.stdout) + + def test_a_steam_that_never_reports_ready_still_gets_the_launch(self): + result = self.run_launch("413150", ready_status=1) + self.assertEqual("413150", (self.launch_dir / "steam-game").read_text().strip()) + self.assertEqual(1, len(self.hand_offs(result)), result.stdout) + self.assertEqual(["1"] * 30, self.sleep_args.read_text().split()) + + def test_a_focus_change_does_not_end_the_readiness_wait(self): + result = self.run_launch("413150", focus="769 4242", ready_status=1) + self.assertEqual(1, len(self.hand_offs(result)), result.stdout) + self.assertEqual(["1"] * 30, self.sleep_args.read_text().split()) def test_a_game_still_starting_without_a_window_is_not_launched_twice(self): result = self.run_launch(SHORTCUT, running_after=1) self.assertEqual(1, len(self.hand_offs(result)), result.stdout) - self.assertFalse(self.agent_args.exists()) + self.assertIn("--steam-ready", self.agent_args.read_text()) self.assertEqual(["-f", "reaper SteamLaunch AppId=3551182975( |$)"], (self.root / "pgrep-args").read_text().splitlines()) self.assertIn("already starting", result.stdout) @@ -108,15 +122,15 @@ class SteamColdLaunchTest(unittest.TestCase): focus = " ".join(["769"] * 23) + " 4242" result = self.run_launch(SHORTCUT, focus=focus, helper_status=0) self.assertEqual(1, len(self.hand_offs(result)), result.stdout) - self.assertIn("took focus while waiting", result.stdout) + self.assertNotIn("clearing the pending launch interstitial", result.stdout) self.assertNotIn("launching the requested game again", result.stdout) def test_native_app_id_keeps_the_short_delay_and_is_handed_over_once(self): result = self.run_launch("413150") self.assertEqual("413150", (self.launch_dir / "steam-game").read_text().strip()) self.assertEqual(1, len(self.hand_offs(result)), result.stdout) - self.assertEqual("4", self.sleep_args.read_text().strip()) - self.assertFalse(self.agent_args.exists()) + self.assertFalse(self.sleep_args.exists()) + self.assertIn("--steam-ready", self.agent_args.read_text()) def test_a_restart_for_a_game_uses_the_same_hand_off(self): loop = SOURCE[SOURCE.index(' if [ -s "$HOME/.bl-restart-game" ]; then'):SOURCE.index(' if [ -f "$HOME/.bl-restart-once" ]; then')] diff --git a/tools/tests/test_steam_compat_live.py b/tools/tests/test_steam_compat_live.py index af2d8cfb62..15ae63bb89 100644 --- a/tools/tests/test_steam_compat_live.py +++ b/tools/tests/test_steam_compat_live.py @@ -749,6 +749,54 @@ class ReconcileTest(unittest.TestCase): self.assertIn(entry % ("10", COMPAT["FEX_TOOL"]), " ".join(config.read_text().split())) self.assertEqual(self.games(), {}) + def test_our_default_the_client_does_not_list_survives_to_the_next_start(self): + build = "DroidDeck-Proton 11-11.4" + (self.steam / "compatibilitytools.d" / build).mkdir(parents=True) + (self.steam / "compatibilitytools.d" / build / COMPAT["EXTRA_WRAPPER"]).write_text("") + (self.state / "state.json").write_text(json.dumps({"default": build, "written": build, "source": "update", "auto": {"10": build}})) + page = FakePage({"0": TOOL, "10": build}, [TOOL, TOOL_11]) + state = self.reconcile(page) + self.assertEqual((state["default"], state["source"], state["written"]), (build, "update", TOOL)) + self.assertEqual(page.sets, [("10", TOOL), ("11", TOOL)]) + config = self.steam / "config/config.vdf" + config.parent.mkdir(parents=True) + vdf = '"InstallConfigStore" { "Software" { "Valve" { "Steam" { "CompatToolMapping" { %s } } } } }' + entry = '"%s" { "name" "%s" "config" "" "priority" "250" }' + config.write_text(vdf % "".join(entry % (app, page.mapping[app]) for app in ("0", "10", "11"))) + with mock.patch.dict(COMPAT["register_default"].__globals__, steam_running=lambda: False): + default = COMPAT["register_default"](str(config), ["10", "11"], catalog=COMPAT["tool_catalog"](str(self.steam)), + directory=str(self.state), settle=True) + self.assertEqual(default, build) + self.assertEqual(COMPAT["read_config_mapping"](str(config)), {"0": build, "10": build, "11": build}) + + def test_proton_experimental_picked_for_a_game_in_steam_is_kept_and_mirrored(self): + build = "DroidDeck-Proton 11-12.3" + (self.steam / "compatibilitytools.d" / build).mkdir(parents=True) + (self.steam / "compatibilitytools.d" / build / COMPAT["EXTRA_WRAPPER"]).write_text("") + (self.state / "state.json").write_text(json.dumps( + {"default": build, "written": build, "source": "update", "auto": {"11": build}, "picked": ["10", "11"], "tools": [], + "games_applied": {"10": {"valve": False, "dir": build}}})) + self.write_games({"10": {"valve": False, "dir": build}}) + page = FakePage({"0": build, "10": "proton_experimental", "11": build}, [TOOL, TOOL_11, build, "proton_experimental"]) + state = self.reconcile(page) + self.assertEqual(page.sets, [("10", TOOL)]) + self.assertEqual(state["auto"], {"11": build}) + self.assertEqual(self.games(), {"10": {"valve": True, "dir": COMPAT["SOURCES"][0]}}) + config = self.steam / "config/config.vdf" + config.parent.mkdir(parents=True) + vdf = '"InstallConfigStore" { "Software" { "Valve" { "Steam" { "CompatToolMapping" { %s } } } } }' + entry = '"%s" { "name" "%s" "config" "" "priority" "250" }' + config.write_text(vdf % "".join(entry % (app, page.mapping[app]) for app in ("0", "10", "11"))) + with mock.patch.dict(COMPAT["register_default"].__globals__, steam_running=lambda: False): + default = COMPAT["register_default"](str(config), ["10", "11"], catalog=COMPAT["tool_catalog"](str(self.steam)), + directory=str(self.state), settle=True) + self.assertEqual(default, build) + self.assertEqual(COMPAT["read_config_mapping"](str(config)), {"0": build, "10": TOOL, "11": build}) + page.sets.clear() + self.write_games({"10": {"valve": True, "dir": COMPAT["SOURCES"][1]}}) + self.reconcile(page) + self.assertEqual(page.sets, [("10", TOOL_11)]) + def test_file_mode_defers_to_the_live_helper(self): (self.state / "live.pid").write_text("%d\n" % os.getpid()) self.assertTrue(COMPAT["live_helper_running"]()) diff --git a/tools/tests/test_steam_tool_platforms.py b/tools/tests/test_steam_tool_platforms.py new file mode 100644 index 0000000000..899b0b07e9 --- /dev/null +++ b/tools/tests/test_steam_tool_platforms.py @@ -0,0 +1,215 @@ +import json +import os +from pathlib import Path +import select +import tempfile +import unittest +from unittest import mock + +from tools.tests import test_droiddeck_fex as fixtures +from tools.tests import test_steam_compat_live as live +from tools.tests.test_steam_compat_mapping import config_text + + +COMPAT = live.COMPAT +TOOL = COMPAT["TOOL"] + + +class ToolPlatformsTest(unittest.TestCase): + def setUp(self): + temporary = tempfile.TemporaryDirectory() + self.addCleanup(temporary.cleanup) + self.root = Path(temporary.name) + self.steam = self.root / "Steam" + self.state = self.root / "state" + self.config = self.steam / "config/config.vdf" + self.config.parent.mkdir(parents=True) + self.state.mkdir() + (self.steam / "appcache").mkdir() + (self.steam / "steamapps").mkdir() + self.entries = { + 976730: ("windows", "64", "game"), + 1826330: ("linux", "", "tool"), + 1161040: ("linux", "", "tool"), + 900001: ("windows", "64", "tool"), + 900002: ("linux", "arm64", "tool"), + 900003: ("osx", "64", "tool"), + 900004: ("", "", "tool"), + 900005: ("linux,windows", "64", "tool"), + } + self.write_appinfo() + self.catalog = [{"name": TOOL, "display": "Proton", "dir": "Proton", "valve": True}] + self.config.write_text(config_text('"0" { "name" "%s" }' % TOOL)) + patcher = mock.patch.dict(COMPAT["register_default"].__globals__, COMPAT_DIR=str(self.state)) + patcher.start() + self.addCleanup(patcher.stop) + + def write_appinfo(self, magic=0x07564429): + (self.steam / "appcache/appinfo.vdf").write_bytes(fixtures.AppInfoTest.appinfo(self.entries, magic)) + + def platforms(self): + return COMPAT["tool_platforms"](str(self.steam)) + + def plan(self, current, auto=None, **kwargs): + return COMPAT["plan_mapping"](current, ["976730"], [TOOL], TOOL, auto or {}, + tools=self.platforms(), **kwargs) + + def test_metadata_selects_tools_across_cache_formats(self): + for magic in (0x07564427, 0x07564428, 0x07564429): + with self.subTest(magic=magic): + self.write_appinfo(magic) + self.assertEqual(set(self.platforms()), {"1826330", "1161040", "900001", "900002", "900005"}) + + def test_tools_are_not_installed_games(self): + for app in self.entries: + (self.steam / ("steamapps/appmanifest_%s.acf" % app)).write_text("") + self.assertEqual(COMPAT["installed_apps"](str(self.steam)), ["976730"]) + + def test_linux_tools_clear_proton_and_windows_tools_get_default_before_install(self): + current = {"0": TOOL, "976730": TOOL, "1826330": TOOL, "1161040": "proton_experimental"} + changes, auto = self.plan(current, {"1826330": TOOL, "976730": TOOL}) + self.assertEqual(changes, {"1826330": None, "1161040": None, "900001": TOOL}) + self.assertNotIn("1826330", auto) + self.assertEqual(auto["900001"], TOOL) + self.assertEqual(auto["976730"], TOOL) + + def test_removed_ge_proton_is_cleared_with_or_without_saved_ownership(self): + for saved in ({}, {"1826330": "GE-Proton11-7"}): + with self.subTest(saved=saved): + changes, auto = self.plan({"0": TOOL, "1826330": "GE-Proton11-7"}, saved) + self.assertIsNone(changes["1826330"]) + self.assertNotIn("1826330", auto) + + def test_removed_ge_proton_game_selection_survives(self): + changes, auto = self.plan({"0": TOOL, "976730": "GE-Proton11-7"}) + self.assertNotIn("976730", changes) + self.assertNotIn("976730", auto) + + def test_saved_native_selections_survive(self): + for name in (COMPAT["FEX_TOOL"], "custom-native"): + with self.subTest(name=name): + changes, auto = self.plan({"0": TOOL, "1826330": name}, {"1826330": name}) + self.assertNotIn("1826330", changes) + self.assertNotIn("1826330", auto) + + def test_main_watches_cache_updates_and_replacements(self): + class StopWatching(BaseException): + pass + + watchers = [] + + def capture(files): + watcher = live.LIVE["Watcher"](files) + watchers.append(watcher) + raise StopWatching() + + namespace = live.LIVE["main"].__globals__ + with mock.patch.dict(namespace, Watcher=capture), mock.patch.dict(os.environ, BL_CDP_PORT="1"), \ + mock.patch.object(live.LIVE["sys"], "argv", ["compat", str(self.steam)]): + with self.assertRaises(StopWatching): + live.LIVE["main"]() + watcher = watchers[0] + if watcher.fd >= 0: + self.addCleanup(os.close, watcher.fd) + self.assertFalse(watcher.changed()) + self.entries[900006] = ("linux", "", "tool") + self.write_appinfo() + self.assertTrue(watcher.changed()) + self.assertIn("900006", self.platforms()) + cache = self.steam / "appcache/appinfo.vdf" + replacement = cache.with_suffix(".tmp") + replacement.write_bytes(cache.read_bytes()) + replacement.replace(cache) + self.assertTrue(watcher.changed()) + + def test_watcher_follows_an_appcache_created_after_startup(self): + root = self.root / "late" + (root / "state").mkdir(parents=True) + watcher = live.LIVE["Watcher"]([str(root / "state/request.json"), str(root / "appcache/appinfo.vdf")]) + self.assertGreaterEqual(watcher.fd, 0) + self.addCleanup(os.close, watcher.fd) + self.assertFalse(watcher.changed()) + (root / "appcache").mkdir() + self.assertTrue(watcher.changed()) + (root / "appcache/appinfo.vdf").write_bytes(b"x") + self.assertTrue(watcher.changed()) + + def test_watcher_follows_each_missing_directory_level(self): + root = self.root / "levels" + root.mkdir() + target = root / "sd/steamapps/appmanifest_1.acf" + watcher = live.LIVE["Watcher"]([str(target)]) + self.assertGreaterEqual(watcher.fd, 0) + self.addCleanup(os.close, watcher.fd) + (root / "sd").mkdir() + self.assertTrue(select.select([watcher.fd], [], [], 1)[0]) + self.assertFalse(watcher.changed()) + (root / "sd/steamapps").mkdir() + self.assertTrue(select.select([watcher.fd], [], [], 1)[0]) + self.assertTrue(watcher.changed()) + target.write_bytes(b"x") + self.assertTrue(watcher.changed()) + + def test_linux_tool_requests_cannot_restore_windows_platform(self): + changes, auto = self.plan({"0": TOOL, "1826330": TOOL}, overrides={"1826330": TOOL}) + self.assertIsNone(changes["1826330"]) + self.assertNotIn("1826330", auto) + + def test_linux_execution_tools_and_custom_selections_survive(self): + current = {"0": TOOL, "1826330": COMPAT["FEX_TOOL"], "900002": "custom-native", + "900001": "custom-windows", "900005": TOOL} + changes, auto = self.plan(current) + self.assertEqual(changes, {"976730": TOOL}) + self.assertNotIn("1826330", auto) + + def test_missing_or_malformed_cache_does_not_invent_platforms(self): + cache = self.steam / "appcache/appinfo.vdf" + cache.unlink() + self.assertEqual(self.platforms(), {}) + cache.write_bytes(b"invalid") + self.assertEqual(self.platforms(), {}) + + def test_offline_repair_is_idempotent_and_preserves_game_and_neighbor_fields(self): + self.config.write_text(config_text( + '"0" { "name" "%s" } "976730" { "name" "custom-game" } ' + '"1826330" { "name" "%s" }' % (TOOL, TOOL))) + for _ in range(2): + COMPAT["register_default"](str(self.config), ["976730"], catalog=self.catalog, + directory=str(self.state), default=TOOL) + self.assertEqual(COMPAT["read_config_mapping"](str(self.config)), + {"0": TOOL, "976730": "custom-game", "900001": TOOL}) + self.assertIn('"outside"', self.config.read_text()) + state = json.loads((self.state / "state.json").read_text()) + self.assertNotIn("1826330", state["auto"]) + + def reconcile(self, page): + helper = live.LIVE["Helper"](str(self.steam), 1) + helper.page = page + with mock.patch.dict(COMPAT, tool_catalog=lambda root: self.catalog): + helper.reconcile() + return json.loads((self.state / "state.json").read_text()) + + def test_live_repair_covers_uninstalled_dependencies_and_stays_idempotent(self): + page = live.FakePage({"0": TOOL, "1826330": TOOL, "976730": "custom-game"}, [TOOL]) + state = self.reconcile(page) + self.assertEqual(page.sets, [("900001", TOOL), ("1826330", "")]) + self.assertNotIn("1826330", state["auto"]) + page.sets.clear() + self.reconcile(page) + self.assertEqual(page.sets, []) + self.assertEqual(page.mapping["976730"], "custom-game") + + def test_live_removed_ge_proton_is_cleared_and_stays_cleared(self): + page = live.FakePage({"0": TOOL, "1826330": "GE-Proton11-7"}, [TOOL]) + (self.state / "state.json").write_text(json.dumps({"auto": {"1826330": "GE-Proton11-7"}})) + state = self.reconcile(page) + self.assertIn(("1826330", ""), page.sets) + self.assertNotIn("1826330", state["auto"]) + page.sets.clear() + self.reconcile(page) + self.assertEqual(page.sets, []) + + def test_live_refused_tools_are_not_written(self): + page = live.FakePage({"0": TOOL, "1826330": TOOL}, [TOOL], refused={"1826330", "900001"}) + self.reconcile(page) + self.assertEqual(page.sets, []) diff --git a/tools/tests/test_store_launch.py b/tools/tests/test_store_launch.py index 7ea5a1ae79..36a1b7c9a1 100644 --- a/tools/tests/test_store_launch.py +++ b/tools/tests/test_store_launch.py @@ -387,6 +387,193 @@ def set_registry(**arguments): return {'install': {'action': 'setRegistry', 'arguments': arguments}, 'name': 'setRegistry'} +def support_data(**arguments): + return {'install': {'action': 'supportData', 'arguments': arguments}, 'name': 'supportData'} + + +class GogSupportData(unittest.TestCase): + def prefix(self, root): + user = Path(root) / 'compat/pfx/drive_c/users/steamuser' + user.mkdir(parents=True) + return user + + def test_support_files_reach_the_prefix_once(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + user = self.prefix(root) + support = folder / 'support/9' + (support / 'Docs').mkdir(parents=True) + (support / 'Docs/Fallout4.ini').write_text('[Archive]\n') + (support / 'Plugins.txt').write_text('*LondonWorldSpace.esm\n') + (folder / '__AppData/Saves').mkdir(parents=True) + (folder / '__AppData/Saves/a.txt').write_text('a') + gog_script(folder, '9', [ + set_registry(root='HKLM', subkey='Software\\Game', valueName='a', valueData='b', valueType='string'), + support_data(type='folder', target='{userdocs}/My Games/Fallout4'), + support_data(type='file', overwrite=True, source='{supportDir}/docs/Fallout4.ini', + target='{userdocs}/My Games/Fallout4/Fallout4.ini'), + support_data(type='file', overwrite=True, source='{supportDir}/Plugins.txt', + target='{localappdata}/Fallout4/Plugins.txt'), + support_data(type='folder', overwrite=True, source='{app}/__AppData', target='{localappdata}/Fallout4'), + ]) + with patch.object(store, 'create_prefix') as create: + self.assertEqual('copied=3', store.gog_support_data(folder, root + '/compat', '/proton')) + create.assert_not_called() + self.assertTrue((user / 'Documents/My Games/Fallout4').is_dir()) + self.assertEqual('[Archive]\n', (user / 'Documents/My Games/Fallout4/Fallout4.ini').read_text()) + self.assertEqual('*LondonWorldSpace.esm\n', (user / 'AppData/Local/Fallout4/Plugins.txt').read_text()) + self.assertEqual('a', (user / 'AppData/Local/Fallout4/Saves/a.txt').read_text()) + (user / 'AppData/Local/Fallout4/Plugins.txt').write_text('player order') + self.assertEqual('ready', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertEqual('player order', (user / 'AppData/Local/Fallout4/Plugins.txt').read_text()) + + def test_a_source_the_build_lacks_does_not_recopy_the_rest_every_launch(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + user = self.prefix(root) + (folder / 'support/9').mkdir(parents=True) + (folder / 'support/9/Plugins.txt').write_text('x') + gog_script(folder, '9', [ + support_data(type='file', overwrite=True, source='{supportDir}/Plugins.txt', target='{localappdata}/G/Plugins.txt'), + support_data(type='folder', overwrite=True, source='{app}/__AppData', target='{localappdata}/G'), + ]) + self.assertEqual('copied=1 missing=1', store.gog_support_data(folder, root + '/compat', '/proton')) + (user / 'AppData/Local/G/Plugins.txt').write_text('player order') + self.assertEqual('ready', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertEqual('player order', (user / 'AppData/Local/G/Plugins.txt').read_text()) + + def test_a_link_never_carries_a_copy_outside(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + user = self.prefix(root) + outside = Path(root) / 'outside' + outside.mkdir() + (outside / 'secret.ini').write_text('s') + (folder / '__AppData').mkdir() + (folder / '__AppData/linked').symlink_to(outside) + (folder / 'support/9').mkdir(parents=True) + (folder / 'support/9/a.ini').write_text('a') + gog_script(folder, '9', [ + support_data(type='folder', overwrite=True, source='{app}/__AppData', target='{localappdata}/G'), + support_data(type='file', overwrite=True, source='{supportDir}/a.ini', target='{localappdata}/G/linked/a.ini'), + support_data(type='file', overwrite=True, source='{app}/__AppData/linked/secret.ini', target='{userdocs}/secret.ini'), + ]) + self.assertEqual('copied=1 skipped=2', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertTrue((user / 'AppData/Local/G/linked').is_symlink()) + self.assertEqual(['secret.ini'], sorted(p.name for p in outside.iterdir())) + self.assertFalse((user / 'Documents/secret.ini').exists()) + + def test_a_linked_source_folder_is_copied_as_a_link(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + user = self.prefix(root) + outside = Path(root) / 'outside' + outside.mkdir() + (outside / 'secret.ini').write_text('s') + (folder / 'linked').symlink_to(outside) + gog_script(folder, '9', [support_data(type='folder', overwrite=True, source='{app}/linked', target='{userdocs}/G')]) + store.gog_support_data(folder, root + '/compat', '/proton') + self.assertTrue((user / 'Documents/G').is_symlink()) + self.assertEqual(outside, Path(os.readlink(user / 'Documents/G'))) + + def test_a_players_own_links_stay_without_overwrite(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + user = self.prefix(root) + (folder / 'support/9/Saves').mkdir(parents=True) + (folder / 'support/9/a.ini').write_text('a') + (folder / 'support/9/Saves/b.ini').write_text('b') + (user / 'Documents/G').mkdir(parents=True) + (user / 'Documents/a.ini').symlink_to(user / 'mine.ini') + (user / 'Documents/G/b.ini').symlink_to(user / 'gone.ini') + gog_script(folder, '9', [ + support_data(type='file', source='{supportDir}/a.ini', target='{userdocs}/a.ini'), + support_data(type='folder', source='{supportDir}/Saves', target='{userdocs}/G'), + ]) + self.assertEqual('copied=0', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertEqual(user / 'mine.ini', Path(os.readlink(user / 'Documents/a.ini'))) + self.assertEqual(user / 'gone.ini', Path(os.readlink(user / 'Documents/G/b.ini'))) + + def test_a_changed_script_applies_again(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + user = self.prefix(root) + (folder / 'support/9').mkdir(parents=True) + (folder / 'support/9/a.ini').write_text('1') + action = support_data(type='file', overwrite=True, source='{supportDir}/a.ini', target='{userdocs}/a.ini') + gog_script(folder, '9', [action]) + self.assertEqual('copied=1', store.gog_support_data(folder, root + '/compat', '/proton')) + (folder / 'support/9/b.ini').write_text('2') + gog_script(folder, '9', [action, support_data(type='file', overwrite=True, source='{supportDir}/b.ini', + target='{userdocs}/b.ini')]) + self.assertEqual('copied=2', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertEqual('2', (user / 'Documents/b.ini').read_text()) + + def test_a_players_file_is_kept_unless_the_script_overwrites_it(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + user = self.prefix(root) + (folder / 'support/9').mkdir(parents=True) + (folder / 'support/9/a.ini').write_text('default') + (user / 'Documents').mkdir() + (user / 'Documents/a.ini').write_text('mine') + gog_script(folder, '9', [support_data(type='file', source='{supportDir}/a.ini', target='{userdocs}/a.ini')]) + self.assertEqual('copied=0', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertEqual('mine', (user / 'Documents/a.ini').read_text()) + + def test_paths_outside_the_known_folders_are_refused(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + self.prefix(root) + (folder / 'support/9').mkdir(parents=True) + (folder / 'support/9/a.ini').write_text('x') + gog_script(folder, '9', [ + support_data(type='file', overwrite=True, source='{supportDir}/a.ini', target='{userdocs}/../../../../escape.ini'), + support_data(type='file', overwrite=True, source='{supportDir}/a.ini', target='C:/escape.ini'), + support_data(type='folder', target='{windir}/x'), + ]) + self.assertEqual('copied=0 skipped=3', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertEqual([], list(Path(root).rglob('escape.ini'))) + self.assertFalse((Path(root) / 'compat/pfx' / store.GOG_SUPPORT_MARK).exists()) + + def test_links_in_a_support_folder_are_copied_as_links(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + user = self.prefix(root) + outside = Path(root) / 'outside' + outside.mkdir() + (outside / 'secret.txt').write_text('s') + (folder / '__AppData').mkdir() + (folder / '__AppData/linked').symlink_to(outside, target_is_directory=True) + gog_script(folder, '9', [support_data(type='folder', overwrite=True, source='{app}/__AppData', target='{localappdata}/G')]) + self.assertEqual('copied=1', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertTrue((user / 'AppData/Local/G/linked').is_symlink()) + self.assertEqual('s', (outside / 'secret.txt').read_text()) + + def test_without_support_data_no_prefix_is_made(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + gog_script(folder, '9', [set_registry(root='HKLM', subkey='Software\\Game', valueName='a', valueData='b', valueType='string')]) + with patch.object(store, 'create_prefix') as create: + self.assertEqual('none', store.gog_support_data(folder, root + '/compat', '/proton')) + create.assert_not_called() + + def test_a_missing_prefix_is_made_first(self): + with tempfile.TemporaryDirectory() as root: + folder = game(root, store_id='gog', ident='9') + gog_script(folder, '9', [support_data(type='folder', target='{userdocs}/My Games/G')]) + with patch.object(store, 'create_prefix', return_value='failed') as create: + self.assertEqual('no-prefix', store.gog_support_data(folder, root + '/compat', '/proton')) + create.assert_called_once_with(root + '/compat', '/proton') + + def made(compat_data, proton): + self.prefix(root) + return 'created' + with patch.object(store, 'create_prefix', side_effect=made): + self.assertEqual('copied=0', store.gog_support_data(folder, root + '/compat', '/proton')) + self.assertTrue((Path(root) / 'compat/pfx/drive_c/users/steamuser/Documents/My Games/G').is_dir()) + + class GogRegistry(unittest.TestCase): def test_patch_registration_uses_authentic_build_and_the_prefix_registry_executable(self): with tempfile.TemporaryDirectory() as root: @@ -605,6 +792,107 @@ class GogRegistry(unittest.TestCase): folder = game(root, store_id='gog') with patch.dict(os.environ, {'BL_LAUNCH_DIR': root, 'STEAM_COMPAT_DATA_PATH': root + '/compat/', 'BL_STORE_PROTON': '/chosen/proton'}), \ patch.object(store, 'prepare_gog', return_value=False), patch.object(store, 'ask', return_value=None), \ - patch.object(store, 'apply_gog_registry', return_value='ready') as apply: + patch.object(store, 'apply_gog_registry', return_value='ready') as apply, \ + patch.object(store, 'gog_support_data', return_value='ready') as support: store.main([str(folder / store.LAUNCHER)]) apply.assert_called_once_with(folder, root + '/compat', '/chosen/proton') + support.assert_called_once_with(folder, root + '/compat', '/chosen/proton') + + +class Ubisoft(unittest.TestCase): + def setUp(self): + self.tmp = tempfile.TemporaryDirectory() + self.root = Path(self.tmp.name) + self.compat_data = self.root / 'compatdata/2929927072' + (self.compat_data / 'pfx').mkdir(parents=True) + (self.compat_data / 'pfx/system.reg').write_text('WINE REGISTRY Version 2\n') + (self.compat_data / 'pfx/user.reg').write_text('WINE REGISTRY Version 2\n') + self.folder = self.root / 'Games/Stores/Ubisoft/Splinter Cell' + (self.folder / 'system').mkdir(parents=True) + self.sidecar = {'store': 'ubisoft', 'id': 'space-1', 'exe': 'system/SplinterCell.exe', 'extra': {'productId': '109'}} + service = self.root / 'droiddeck-upc.exe' + service.write_bytes(b'MZ') + for patcher in (patch.object(store, 'UBISOFT_SERVICE', service), patch.object(store, 'UBISOFT_CACHE', self.root / 'cache'), + patch.object(store, 'wait_for_server', return_value=True)): + patcher.start() + self.addCleanup(patcher.stop) + + def tearDown(self): + self.tmp.cleanup() + + def runtime(self): + folder = store.ubisoft_runtime_dir(self.compat_data) + folder.mkdir(parents=True, exist_ok=True) + for name in store.UBISOFT_RUNTIME: + (folder / name).write_bytes(b'MZ') + + def answer(self, *_args, **_kwargs): + return {'ok': True, 'ticket': 'PC', 'owned': [82, 109], 'appId': 'app', + 'account': {'userId': 'u1', 'username': 'name', 'nameOnPlatform': 'name', 'email': 'e@x', 'country': 'US'}} + + def prepare(self, ask_app): + return store.prepare_ubisoft(self.folder, self.sidecar, str(self.compat_data), str(self.root / 'launch'), '/proton', ask_app=ask_app) + + def test_an_extracted_runtime_is_not_extracted_again(self): + self.runtime() + with patch.object(store.subprocess, 'run') as run: + self.assertEqual('present', store.install_runtime(str(self.compat_data))) + run.assert_not_called() + + def test_the_runtime_comes_from_the_installer_through_7z(self): + installer = self.root / 'UbisoftConnectInstaller.exe' + + def run(command, **_kwargs): + self.assertEqual(['7z', 'e', '-y'], command[:3]) + self.assertEqual(str(installer), command[4]) + out = Path(command[3][2:]) + for name in command[5:]: + (out / name).write_bytes(b'MZ') + + (self.root / 'cache').mkdir() + with patch.object(store, 'fetch_installer', return_value=installer), patch.object(store.subprocess, 'run', side_effect=run): + self.assertEqual('installed', store.install_runtime(str(self.compat_data))) + self.assertTrue(store.ubisoft_runtime_ready(str(self.compat_data))) + + def test_a_launch_registers_the_game_and_writes_the_session_for_the_service(self): + self.runtime() + result = self.prepare(self.answer) + self.assertEqual('runtime present, registered 109, 0 manifest value(s), session ready', result) + reg = (self.compat_data / 'pfx/system.reg').read_text() + for view in ('[Software\\\\Ubisoft\\\\Launcher]', '[Software\\\\Wow6432Node\\\\Ubisoft\\\\Launcher]'): + self.assertIn(view, reg) + self.assertIn('[Software\\\\Wow6432Node\\\\Ubisoft\\\\Launcher\\\\Installs\\\\109]', reg) + self.assertIn('"InstallDir"="C:\\\\Program Files (x86)\\\\Ubisoft\\\\Ubisoft Game Launcher\\\\"', reg) + launch = json.loads((self.folder / store.UBISOFT_LAUNCH).read_text()) + self.assertEqual(109, launch['productId']) + self.assertEqual('PC', launch['ticket']) + self.assertEqual([82, 109], launch['owned']) + self.assertEqual(store.windows_path(str(self.folder / 'system/SplinterCell.exe')), launch['exe']) + self.assertEqual('C:/users/steamuser/Saved Games/Ubisoft/u1/109/', launch['saves']) + self.assertTrue((self.compat_data / 'pfx/drive_c/users/steamuser/Saved Games/Ubisoft/u1/109').is_dir()) + + def test_without_a_session_the_launch_file_is_removed_and_the_game_starts_as_is(self): + self.runtime() + (self.folder / store.UBISOFT_LAUNCH).write_text('{}') + result = self.prepare(lambda *_a, **_k: {'ok': False, 'reason': 'signed-out'}) + self.assertEqual('runtime present, registered 109, session signed-out', result) + self.assertFalse((self.folder / store.UBISOFT_LAUNCH).exists()) + + def test_a_game_without_a_product_is_left_alone(self): + self.sidecar['extra'] = {} + self.assertEqual('no-product', self.prepare(self.answer)) + + def test_the_manifest_registry_lands_in_both_views_with_the_install_folder_and_language(self): + self.runtime() + registry = [{'key': r'HKEY_LOCAL_MACHINE\SOFTWARE\Ubisoft\Launcher\Installs\109\Language', + 'values': [{'name': 'French', 'value': 'fr-FR'}, {'name': 'English', 'value': 'en-US'}]}, + {'key': r'HKEY_LOCAL_MACHINE\SOFTWARE\Ubisoft\Splinter Cell\GamePath', 'values': [{'name': '$INSTALL_DIR', 'value': ''}]}] + answer = dict(self.answer(), registry=registry, language='en-US') + result = self.prepare(lambda *_a, **_k: answer) + self.assertEqual('runtime present, registered 109, 4 manifest value(s), session ready', result) + reg = (self.compat_data / 'pfx/system.reg').read_text() + self.assertIn(r'[SOFTWARE\\Wow6432Node\\Ubisoft\\Launcher\\Installs\\109]', reg) + self.assertIn(r'[SOFTWARE\\Ubisoft\\Launcher\\Installs\\109]', reg) + self.assertIn('"Language"="en-US"', reg) + folder = store.windows_path(str(self.folder)).replace('\\', '\\\\') + self.assertIn('"GamePath"="%s\\\\"' % folder, reg) diff --git a/tools/tests/test_store_launch_ea.py b/tools/tests/test_store_launch_ea.py new file mode 100644 index 0000000000..2dd72b324b --- /dev/null +++ b/tools/tests/test_store_launch_ea.py @@ -0,0 +1,129 @@ +import base64 +import importlib.machinery +import importlib.util +import json +from pathlib import Path +import tempfile +import unittest +from unittest.mock import patch + +BIN = Path(__file__).resolve().parents[1] / 'linuxfs/overlay/usr/local/bin' +loader = importlib.machinery.SourceFileLoader('droiddeck_store_launch_ea', str(BIN / 'droiddeck-store-launch')) +spec = importlib.util.spec_from_loader(loader.name, loader) +store = importlib.util.module_from_spec(spec) +loader.exec_module(store) + + +class EaHook(unittest.TestCase): + def test_wmi_output_reads_the_value_under_the_header(self): + text = 'Manufacturer \r\r\nThe Wine Project \r\r\n\r\r\n' + self.assertEqual(store.wmi_value(text), 'The Wine Project') + self.assertEqual(store.wmi_value(store.decode_output('Name\r\nFEX CPU\r\n'.encode('utf-16'))), 'FEX CPU') + self.assertEqual(store.wmi_value(''), '') + + def test_registry_points_the_game_keys_at_the_install_folder(self): + sidecar = {'id': 'Origin.OFR.50.0001', 'title': 'Mass Effect 3', 'extra': {'registry': json.dumps([ + [r'HKEY_LOCAL_MACHINE\SOFTWARE\EA Games\Game', 'Install Dir'], + [r'HKLM\SOFTWARE\Respawn\Titanfall2', 'Install Dir'], + [r'HKEY_CLASSES_ROOT\x', 'y'], + ])}} + entries = store.ea_registry_entries(Path('/root/Games/Stores/EA/Game'), sidecar) + self.assertIn((r'HKEY_LOCAL_MACHINE\SOFTWARE\Origin', 'ClientPath', store.EA_CLIENT), entries) + game = [e for e in entries if e[1] == 'Install Dir'] + self.assertEqual([e[0] for e in game], [r'HKEY_LOCAL_MACHINE\SOFTWARE\EA Games\Game', r'HKEY_LOCAL_MACHINE\SOFTWARE\Respawn\Titanfall2']) + self.assertEqual(game[0][2], 'Z:' + '\\'.join(['', 'root', 'Games', 'Stores', 'EA', 'Game', ''])) + self.assertIn((r'HKEY_LOCAL_MACHINE\SOFTWARE\EA Games\Game', 'DisplayName', 'Mass Effect 3'), entries) + self.assertIn((r'HKEY_LOCAL_MACHINE\SOFTWARE\Respawn\Titanfall2', 'DisplayName', 'Mass Effect 3'), entries) + + def test_legacy_games_are_registered_by_content_id(self): + sidecar = {'id': 'Origin.OFR.50.0005237', 'title': 'Mass Effect 3 (2012)', + 'extra': {'contentIds': '71073,71183, bad id', 'displayName': 'Mass Effect 3', 'locale': 'fr_FR'}} + entries = store.ea_registry_entries(Path('/root/Games/ME3'), sidecar) + key = r'HKEY_LOCAL_MACHINE\SOFTWARE\Origin Games' + '\\' + self.assertIn((key + '71073', 'DisplayName', 'Mass Effect 3'), entries) + self.assertIn((key + '71183', 'Locale', 'fr_FR'), entries) + self.assertFalse(any('bad id' in e[0] for e in entries)) + + def test_cpuid_probe_is_a_32_bit_console_program(self): + import struct + exe = store.cpuid_exe() + self.assertEqual(exe[:2], b'MZ') + self.assertEqual(exe[0x40:0x44], b'PE\0\0') + self.assertEqual(struct.unpack_from(' -char *const *bl_webhelper_argv(const char *path, char *const argv[]); +#include +char *const *bl_webhelper_argv(const char *path, char *const argv[], char *const envp[]); int main(int argc, char **argv) { - char *const *out = bl_webhelper_argv(argv[1], argv + 1); + const char *mode = getenv("TEST_NODE_MODE_CHILD"); + static char node[64]; + snprintf(node, sizeof node, "ELECTRON_RUN_AS_NODE=%s", mode ? mode : ""); + char *node_env[] = {node, NULL}; + char *plain_env[] = {"PATH=/usr/bin", NULL}; + char *const *envp = mode ? node_env : plain_env; + char *const *out = bl_webhelper_argv(argv[1], argv + 1, (char *const *)envp); for (int i = 0; out[i]; i++) printf("%s\n", out[i]); return 0; } @@ -35,13 +42,28 @@ class WebhelperPreloadTest(unittest.TestCase): def tearDownClass(cls): shutil.rmtree(cls.tmp, ignore_errors=True) - def argv(self, *args, spec=None): + def argv(self, *args, spec=None, node_child=False, parent_node=False): env = {k: v for k, v in os.environ.items() if k != "BL_WEBHELPER_ARGS"} + env.pop("ELECTRON_RUN_AS_NODE", None) if spec is not None: env["BL_WEBHELPER_ARGS"] = spec + if node_child is not False: + env["TEST_NODE_MODE_CHILD"] = "1" if node_child is True else node_child + else: + env.pop("TEST_NODE_MODE_CHILD", None) + if parent_node: + env["ELECTRON_RUN_AS_NODE"] = "1" result = subprocess.run([str(self.program), *args], env=env, capture_output=True, text=True, check=True) return result.stdout.splitlines() + def chromium(self, directory, name): + root = self.tmp / directory + root.mkdir(exist_ok=True) + executable = root / name + executable.touch() + (root / "chrome-sandbox").touch() + return str(executable) + def test_the_browser_process_keeps_its_helpers_in_process(self): out = self.argv(WEBHELPER, "-lang=en_US", "--enable-features=A", "--no-sandbox", "--disable-features=B,C") self.assertEqual(out, [WEBHELPER, "-lang=en_US", "--no-sandbox", "--no-zygote", "--in-process-gpu", @@ -57,6 +79,31 @@ class WebhelperPreloadTest(unittest.TestCase): other = ["/usr/bin/steam", "--enable-features=A"] self.assertEqual(self.argv(*other), other) + def test_node_mode_from_the_child_environment_skips_sandbox_injection(self): + code = self.chromium("vscode", "code") + self.assertEqual(self.argv(code, node_child=True), [code]) + + def test_any_nonempty_node_mode_value_skips_sandbox_injection(self): + code = self.chromium("vscode-true", "code") + for value in ("true", "0", "yes"): + self.assertEqual(self.argv(code, node_child=value), [code]) + + def test_empty_node_mode_value_still_gets_sandbox_flag(self): + chrome = self.chromium("chromium-empty-mode", "chrome") + self.assertEqual(self.argv(chrome, node_child=""), [chrome, "--no-sandbox"]) + + def test_non_browser_helper_beside_chrome_sandbox_skips_injection_in_node_mode(self): + helper = self.chromium("vscode-helper", "remote-cli") + self.assertEqual(self.argv(helper, node_child=True), [helper]) + + def test_chromium_gui_launch_still_gets_sandbox_flag_from_explicit_environment(self): + chrome = self.chromium("chromium", "chrome") + self.assertEqual(self.argv(chrome), [chrome, "--no-sandbox"]) + + def test_parent_node_mode_does_not_override_the_explicit_child_environment(self): + chrome = self.chromium("chromium-parent-mode", "chrome") + self.assertEqual(self.argv(chrome, parent_node=True), [chrome, "--no-sandbox"]) + def test_stock_turns_it_off(self): args = [WEBHELPER, "--enable-features=A"] self.assertEqual(self.argv(*args, spec="stock"), args) diff --git a/tools/tests/test_wincomponents.py b/tools/tests/test_wincomponents.py index 51c555b9bb..7423fb2bbf 100644 --- a/tools/tests/test_wincomponents.py +++ b/tools/tests/test_wincomponents.py @@ -35,8 +35,146 @@ class WinComponentsTest(unittest.TestCase): def pick(self, *ids): self.selection.write_text(json.dumps({"version": 1, "games": {"2571976725": list(ids)}})) - def apply(self): - return MODULE["apply"](self.compat, "2571976725", self.selection, self.store) + def apply(self, proton=None, env=None): + return MODULE["apply"](self.compat, "2571976725", self.selection, self.store, proton=proton, env=env) + + def proton(self, arm=True): + root = Path(self.tmp.name) / ("arm-proton" if arm else "x64-proton") + (root / "files/lib/wine" / ("aarch64-unix" if arm else "x86_64-unix")).mkdir(parents=True) + return root / "proton" + + def pe_image(self, machine): + head = bytearray(64) + head[:2] = b"MZ" + head[60:64] = (64).to_bytes(4, "little") + return bytes(head) + b"PE\0\0" + machine.to_bytes(2, "little") + b"\0" * 32 + + def arm64ec_pe_image(self): + image = bytearray(0x400) + image[:2] = b"MZ" + image[60:64] = (64).to_bytes(4, "little") + image[64:68] = b"PE\0\0" + coff = 68 + image[coff:coff + 2] = (0x8664).to_bytes(2, "little") + image[coff + 2:coff + 4] = (1).to_bytes(2, "little") + image[coff + 16:coff + 18] = (240).to_bytes(2, "little") + optional = coff + 20 + image[optional:optional + 2] = (0x20B).to_bytes(2, "little") + image[optional + 108:optional + 112] = (16).to_bytes(4, "little") + directory = optional + 112 + 10 * 8 + image[directory:directory + 4] = (0x1000).to_bytes(4, "little") + image[directory + 4:directory + 8] = (0xD0).to_bytes(4, "little") + section = optional + 240 + image[section + 8:section + 12] = (0x200).to_bytes(4, "little") + image[section + 12:section + 16] = (0x1000).to_bytes(4, "little") + image[section + 16:section + 20] = (0x200).to_bytes(4, "little") + image[section + 20:section + 24] = (0x200).to_bytes(4, "little") + image[0x200:0x204] = (0xD0).to_bytes(4, "little") + image[0x2C8:0x2D0] = (0x10000000).to_bytes(8, "little") + return bytes(image) + + def test_foreign_component_dll_is_skipped_and_override_dropped(self): + proton = self.proton() + self.component("vc", ["ucrtbase"], {"system32/ucrtbase.dll": self.pe_image(0x8664)}) + self.pick("vc") + names, _ = self.apply(proton) + self.assertEqual(names, []) + self.assertFalse((self.pfx / "system32/ucrtbase.dll").exists()) + names, notes = self.apply(proton) + self.assertEqual(names, []) + self.assertEqual(notes, []) + + def test_component_final_arm64ec_dll_is_placed_and_keeps_its_override(self): + proton = self.proton() + self.component("vc", ["ucrtbase"], {"system32/ucrtbase.dll": self.arm64ec_pe_image()}) + self.pick("vc") + names, _ = self.apply(proton) + self.assertEqual(names, ["ucrtbase"]) + self.assertEqual(MODULE["pe_machine"](self.pfx / "system32/ucrtbase.dll"), 0x8664) + + def test_x64_visual_cpp_runtime_is_placed_in_arm64_system32(self): + proton = self.proton() + self.component("vc", ["msvcp140", "vcruntime140_1"], { + "system32/msvcp140.dll": self.pe_image(0x8664), + "system32/vcruntime140_1.dll": self.pe_image(0x8664), + }) + self.pick("vc") + names, _ = self.apply(proton) + self.assertEqual(names, ["msvcp140", "vcruntime140_1"]) + self.assertEqual(MODULE["pe_machine"](self.pfx / "system32/msvcp140.dll"), 0x8664) + self.assertEqual(MODULE["pe_machine"](self.pfx / "system32/vcruntime140_1.dll"), 0x8664) + + def test_compatible_copy_keeps_override_when_other_architecture_copy_is_skipped(self): + proton = self.proton() + self.component("vc", ["ucrtbase"], { + "system32/ucrtbase.dll": self.pe_image(0x8664), + "syswow64/ucrtbase.dll": self.pe_image(0x14C), + }) + self.pick("vc") + names, _ = self.apply(proton) + self.assertEqual(names, ["ucrtbase"]) + self.assertFalse((self.pfx / "system32/ucrtbase.dll").exists()) + self.assertEqual(MODULE["pe_machine"](self.pfx / "syswow64/ucrtbase.dll"), 0x14C) + + def test_existing_foreign_component_dll_is_removed_for_repair(self): + proton = self.proton() + self.component("vc", ["ucrtbase"], {"system32/ucrtbase.dll": self.pe_image(0x8664)}) + self.pick("vc") + self.pfx.joinpath("system32").mkdir(parents=True) + self.pfx.joinpath("system32/ucrtbase.dll").write_bytes(self.pe_image(0x8664)) + self.compat.joinpath(".droiddeck-wincomponents.json").write_text(json.dumps({ + "files": {"drive_c/windows/system32/ucrtbase.dll": "vc"}, "components": ["vc"]})) + self.apply(proton) + self.assertFalse((self.pfx / "system32/ucrtbase.dll").exists()) + self.assertEqual([], GAME_ENV["repair_foreign_system_dlls"](str(self.compat), str(proton))) + self.assertEqual([], GAME_ENV["repair_foreign_system_dlls"](str(self.compat), str(proton))) + + def test_foreign_component_restore_does_not_override_repair_with_native_override(self): + proton = self.proton() + builtin = Path(self.tmp.name) / "arm-proton/files/lib/wine/aarch64-windows/ucrtbase.dll" + builtin.parent.mkdir(parents=True, exist_ok=True) + builtin.write_bytes(self.pe_image(0xAA64)) + system32 = self.pfx / "system32" + system32.mkdir(parents=True) + dll = system32 / "ucrtbase.dll" + dll.write_bytes(self.pe_image(0x8664)) + backup = self.compat / ".droiddeck-wincomponents-backup/drive_c/windows/system32/ucrtbase.dll" + backup.parent.mkdir(parents=True) + backup.write_bytes(self.pe_image(0x8664)) + self.compat.joinpath(".droiddeck-wincomponents.json").write_text(json.dumps({ + "files": {"drive_c/windows/system32/ucrtbase.dll": "vc"}, "components": ["vc"]})) + self.compat.joinpath("pfx/user.reg").parent.mkdir(parents=True, exist_ok=True) + self.compat.joinpath("pfx/user.reg").write_text( + 'WINE REGISTRY Version 2\n\n[Software\\\\Wine\\\\DllOverrides] 1\n"ucrtbase"="native,builtin"\n') + fixed = GAME_ENV["repair_foreign_system_dlls"](str(self.compat), str(proton)) + self.assertEqual(["system32/ucrtbase.dll (machine 0x8664)"], fixed) + self.apply(proton) + self.assertTrue(dll.is_symlink()) + self.assertEqual(0xAA64, MODULE["pe_machine"](dll)) + + def test_matching_component_dll_is_placed(self): + proton = self.proton() + self.component("vc", ["ucrtbase"], {"system32/ucrtbase.dll": self.pe_image(0xAA64)}) + self.pick("vc") + names, _ = self.apply(proton) + self.assertEqual(names, ["ucrtbase"]) + self.assertEqual(MODULE["pe_machine"](self.pfx / "system32/ucrtbase.dll"), 0xAA64) + + def test_x64_proton_places_x64_component_dll(self): + proton = self.proton(arm=False) + self.component("vc", ["ucrtbase"], {"system32/ucrtbase.dll": self.pe_image(0x8664)}) + self.pick("vc") + names, _ = self.apply(proton) + self.assertEqual(names, ["ucrtbase"]) + self.assertEqual(MODULE["pe_machine"](self.pfx / "system32/ucrtbase.dll"), 0x8664) + + def test_arm_proton_with_x64_selection_places_x64_component_dll(self): + proton = self.proton() + self.component("vc", ["ucrtbase"], {"system32/ucrtbase.dll": self.pe_image(0x8664)}) + self.pick("vc") + names, _ = self.apply(proton, {"PROTON_USE_ARM64": "0"}) + self.assertEqual(names, ["ucrtbase"]) + self.assertEqual(MODULE["pe_machine"](self.pfx / "system32/ucrtbase.dll"), 0x8664) def test_places_files_before_the_prefix_exists_and_returns_overrides(self): self.component("openal", ["openal32"], {"syswow64/OpenAL32.dll": b"x86", "system32/OpenAL32.dll": b"x64"}) @@ -235,7 +373,7 @@ class WinComponentsTest(unittest.TestCase): self.pick("openal") globals_ = GAME_ENV["win_components"].__globals__ real = runpy.run_path(str(BIN / "droiddeck-wincomponents")) - real["apply"].__defaults__ = (self.selection, self.store, self.selection.parent / "no-pending.json", None) + real["apply"].__defaults__ = (self.selection, self.store, self.selection.parent / "no-pending.json", None, None, None) with mock.patch.dict(globals_, {"runpy": mock.Mock(run_path=lambda _path: real)}): self.assertEqual(GAME_ENV["win_components"](str(self.compat) + "/", "2571976725"), "openal32=n,b") self.assertEqual(GAME_ENV["win_components"]("", "2571976725"), "") diff --git a/tools/ubisoft-launcher/.gitignore b/tools/ubisoft-launcher/.gitignore new file mode 100644 index 0000000000..90de6fc989 --- /dev/null +++ b/tools/ubisoft-launcher/.gitignore @@ -0,0 +1,2 @@ +target/ +out/ diff --git a/tools/ubisoft-launcher/Cargo.lock b/tools/ubisoft-launcher/Cargo.lock new file mode 100644 index 0000000000..a2bc2229ea --- /dev/null +++ b/tools/ubisoft-launcher/Cargo.lock @@ -0,0 +1,105 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 4 + +[[package]] +name = "droiddeck-ubisoft-launcher" +version = "0.1.0" +dependencies = [ + "serde_json", +] + +[[package]] +name = "itoa" +version = "1.0.19" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3bd1574e617a9a6c1f8f8181bd7e841e1f20e4277607ef28945765188d6284d4" + +[[package]] +name = "memchr" +version = "2.8.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "cf8baf1c55e62ffcace7a9f06f4bd9cd3f0c4beb022d3b367256b91b87513d98" + +[[package]] +name = "proc-macro2" +version = "1.0.107" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "985e7ec9bb745e6ce6535b544d84d6cd6f7ad8bd711c398938ae983b91a766d9" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.47" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1fbf4db142a473a8d80c26bbf18454ed458bf8d26c8219c331daecfdbd079001" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "serde" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4148590afebada386688f18773da617792bf2ef03ffc1e4cbd2b1d45b023e0ba" +dependencies = [ + "serde_core", +] + +[[package]] +name = "serde_core" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "67dca2c9c51e58a4791a4b1ed58308b39c64224d349a935ab5039aa360942a48" +dependencies = [ + "serde_derive", +] + +[[package]] +name = "serde_derive" +version = "1.0.229" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7a5d71263a5a7d47b41f6b3f06ba276f10cc18b0931f1799f710578e2309348" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "serde_json" +version = "1.0.154" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e7e9cc8b1b85264074fbcc02a88680c4096b1e47df8f739dceb03bf482f04bd6" +dependencies = [ + "itoa", + "memchr", + "serde", + "serde_core", + "zmij", +] + +[[package]] +name = "syn" +version = "3.0.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d78c8dee4c7bf0e14673097256fed6142ce9d3b85a408189d07482442145823b" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "unicode-ident" +version = "1.0.27" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a2c754d6c33795a1c324727428e5a7dedb5b06195f9890bdbcba760d3e246563" + +[[package]] +name = "zmij" +version = "1.0.23" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "29666d0abbfad1e3dc4dcf6144730dd3a3ab225bbbdac83319345b1b44ccfc1b" diff --git a/tools/ubisoft-launcher/Cargo.toml b/tools/ubisoft-launcher/Cargo.toml new file mode 100644 index 0000000000..e90819761e --- /dev/null +++ b/tools/ubisoft-launcher/Cargo.toml @@ -0,0 +1,19 @@ +[package] +name = "droiddeck-ubisoft-launcher" +version = "0.1.0" +edition = "2021" +license = "GPL-3.0-only" +publish = false + +[[bin]] +name = "droiddeck-upc" +path = "src/main.rs" + +[dependencies] +serde_json = "1" + +[profile.release] +opt-level = "s" +lto = true +panic = "abort" +strip = true diff --git a/tools/ubisoft-launcher/build.sh b/tools/ubisoft-launcher/build.sh new file mode 100755 index 0000000000..437d2c2df0 --- /dev/null +++ b/tools/ubisoft-launcher/build.sh @@ -0,0 +1,10 @@ +#!/usr/bin/env bash +# Builds droiddeck-upc.exe for Wine and stages it with the guest scripts. +set -euo pipefail +here=$(cd "$(dirname "$0")" && pwd) +out=${1:-"$here/../../app/src/main/assets/linuxfs/usr/local/lib/droiddeck-ubisoft"} +target=x86_64-pc-windows-gnu +rustup target add "$target" >/dev/null 2>&1 || true +cargo build --manifest-path "$here/Cargo.toml" --release --locked --target "$target" +mkdir -p "$out" +install -m644 "${CARGO_TARGET_DIR:-$here/target}/$target/release/droiddeck-upc.exe" "$out/droiddeck-upc.exe" diff --git a/tools/ubisoft-launcher/src/launcher.rs b/tools/ubisoft-launcher/src/launcher.rs new file mode 100644 index 0000000000..343708dba0 --- /dev/null +++ b/tools/ubisoft-launcher/src/launcher.rs @@ -0,0 +1,513 @@ +//! What Ubisoft Connect answers on its local pipes, built from the launch configuration. +//! +//! Field numbers follow `mg.protocol.uplaydll` and `game_starter` as embedded in Ubisoft's own +//! `uplay_r1.dll`; see docs/development/ubisoft-launch.md. + +use crate::pb::{self, Msg, Value}; +use serde_json::Value as Json; + +pub const GAME_START: &str = "game_start_ipc_pipe_"; +pub const API_PROCESS: &str = "uplay_api_process_ipc_pipe_"; +pub const SESSION: &str = "uplay_ipc_pipe_"; +pub const AUX: &str = "uplay_aux_ipc_pipe_"; +pub const SERVICE: &str = "uplay_service_ipc_pipe_"; +pub const ORBIT: &str = "orbit_ipc_pipe_"; +/// Pipes Connect creates that the game may open; they are held open without answers. +pub const QUIET: &[&str] = &[ + "upc_api_process_ipc_pipe_standard", + "uplay_protocol_ipc_pipe_", + "uplay_overlay_ipc_pipe_", + "uplay_crash_reporter_ipc_pipe_", +]; +/// `GetOsiRsp.Status.Failed`: no online-services pipe is offered. +const OSI_FAILED: u64 = 1; +/// The add-on list Connect returns from the aux init; the game echoes it back. +const AUX_ADDONS: [u64; 3] = [3367, 3368, 3962]; +/// `OverlayInjectionMethod_None`. +const OVERLAY_NONE: u64 = 1; +const HWSCORE: &str = "C:/ProgramData/Ubisoft/Ubisoft Game Launcher/cache//statistics/hwscore"; + +pub struct Config { + pub product: u32, + pub exe: String, + pub args: String, + pub workdir: String, + pub user_id: String, + pub username: String, + pub name_on_platform: String, + pub email: String, + pub country: String, + pub ticket: String, + pub owned: Vec, + pub app_id: String, + pub saves: String, + pub language: String, + pub bridge: String, + pub log: String, + /// Installed chunks of the game's manifest: id and tags. + pub chunks: Vec<(u32, String)>, + /// Owned products and their ownership type (0 game, 1 add-on). + pub products: Vec<(u32, u32)>, +} + +fn s(j: &Json, k: &str) -> String { + j.get(k).and_then(|v| v.as_str()).unwrap_or_default().to_string() +} + +impl Config { + pub fn parse(text: &str) -> Result { + let j: Json = serde_json::from_str(text).map_err(|e| format!("config: {e}"))?; + let product = j.get("productId").and_then(|v| v.as_u64()).ok_or("config: no productId")? as u32; + let account = j.get("account").cloned().unwrap_or(Json::Null); + let mut owned: Vec = j.get("owned").and_then(|v| v.as_array()).map(|a| a.iter().filter_map(|v| v.as_u64()).map(|v| v as u32).collect()).unwrap_or_default(); + if !owned.contains(&product) { + owned.push(product); + } + let mut saves = s(&j, "saves").replace('\\', "/"); + if !saves.ends_with('/') { + saves.push('/'); + } + let c = Config { + product, + exe: s(&j, "exe"), + args: s(&j, "args"), + workdir: s(&j, "workdir"), + user_id: s(&account, "userId"), + username: s(&account, "username"), + name_on_platform: s(&account, "nameOnPlatform"), + email: s(&account, "email"), + country: s(&account, "country"), + ticket: s(&j, "ticket"), + owned, + app_id: s(&j, "appId"), + saves, + language: Some(s(&j, "language")).filter(|l| !l.is_empty()).unwrap_or_else(|| "en-US".into()), + bridge: s(&j, "bridge"), + log: s(&j, "log"), + chunks: j.get("chunks").and_then(|v| v.as_array()).map(|a| a.iter().filter_map(|c| { + Some((c.get("id")?.as_u64()? as u32, c.get("tags").and_then(|t| t.as_str()).unwrap_or("").to_string())) + }).collect()).unwrap_or_default(), + products: j.get("products").and_then(|v| v.as_array()).map(|a| a.iter().filter_map(|p| { + Some((p.get("id")?.as_u64()? as u32, p.get("type").and_then(|t| t.as_u64()).unwrap_or(0) as u32)) + }).collect()).unwrap_or_default(), + }; + if c.exe.is_empty() || c.ticket.is_empty() { + return Err("config: exe and ticket are required".into()); + } + Ok(c) + } + + fn root(&self) -> String { + let mut r = self.workdir.replace('\\', "/"); + if !r.ends_with('/') { + r.push('/'); + } + r + } + + /// The executable the way Connect hands it back: the install root, a slash, then the path under it. + pub fn reply_exe(&self, requested: &str) -> String { + let root = self.root(); + let base = root.trim_end_matches('/'); + let exe = requested.replace('\\', "/"); + let rel = if !base.is_empty() && exe.to_lowercase().starts_with(&(base.to_lowercase() + "/")) { &exe[base.len() + 1..] } else { &exe[..] }; + format!("{root}/{rel}") + } + + /// `game_starter.Downstream` granting the start the starter asked for. + pub fn game_start(&self, request: &[u8]) -> Vec { + let requested = pb::find(request, 10, 4).map(|b| String::from_utf8_lossy(b).into_owned()).unwrap_or_else(|| self.exe.clone()); + let progress = Msg::new() + .msg(1, Msg::new().uint(1, 1).uint(2, 113).uint(3, 0).uint(4, 1).uint(5, 0)) + .msg(1, Msg::new().uint(1, 3).uint(2, 123).uint(3, 0).uint(4, 0).uint(5, 0)); + let granted = Msg::new() + .uint(1, 0) + .uint(2, 0) + .text(3, &self.reply_exe(&requested)) + .text(4, &self.root()) + .uint(8, 3) + .msg(9, progress); + Msg::new().msg(2, Msg::new().msg(1, granted)).0 + } + + /// `Chunks`: every installed chunk, marked downloaded. + fn chunks(&self) -> Msg { + let mut m = Msg::new(); + for (id, tags) in &self.chunks { + m = m.msg(1, Msg::new().uint(1, *id as u64).uint(2, 1).text(3, tags)); + } + m + } + + /// `Rsp.initProcessRsp` for the game announcing its process. The overlay is reported off + /// everywhere: with it on, `uplay_r1.dll` loads `overlay.dll` and fails its startup without it. + pub fn init_process(&self) -> Vec { + Msg::new().msg(13, Msg::new().uint(1, 1).uint(3, 0).uint(4, OVERLAY_NONE).uint(6, 0)).0 + } + + /// `Rsp.initRsp`: the account, its products and the PC ticket. `uplay_r2.dll` copies the + /// install and storage state into objects it only creates for the subsystems the game asked + /// for, without checking them, so those parts follow the request when it names subsystems. + pub fn session(&self, wants: Option) -> Vec { + let account = Msg::new() + .text(1, &self.user_id) + .text(2, &self.username) + .text(3, &self.name_on_platform) + .text(4, &self.email) + .text(5, "") + .text(6, &self.country); + let mut body = Msg::new().uint(1, 1).msg(2, account).uint(3, 1).uint(4, self.product as u64); + for id in &self.owned { + body = body.uint(5, *id as u64); + } + body = body + .msg(6, Msg::new().uint(1, self.product as u64).text(2, "")) + .uint(7, 0) + .text(8, &self.ticket); + if wants.map_or(true, |w| w.install) { + body = body.msg(14, Msg::new().uint(1, 1).msg(2, self.chunks()).text(3, &self.language)); + } + body = body + .msg(11, Msg::new().uint(1, 0)) + .uint(12, 0) + .msg(15, Msg::new().uint(1, 0).uint(2, OVERLAY_NONE)) + .msg(16, Msg::new().uint(1, 6211).uint(2, 22395).float(3, 1.0)); + if wants.map_or(true, |w| w.storage) { + body = body.msg(17, Msg::new().text(1, &self.saves)); + } + body = body + .bytes(18, b"") + .msg(19, Msg::new().uint(1, 1).uint(2, 1)) + .msg(21, Msg::new().uint(2, 1)); + if wants.is_some() { + body = body.bytes(20, b""); + } + if !self.app_id.is_empty() { + body = body.msg(22, Msg::new().text(1, &self.app_id)); + } + Msg::new().msg(1, body.bytes(23, b"")).0 + } + + /// `Rsp.userRsp.getCredentialsRsp`: the account without its password, which DroidDeck never holds. + pub fn credentials(&self, request_id: u64) -> Vec { + let rsp = Msg::new().uint(1, request_id).text(2, &self.username).text(3, "").text(4, &self.user_id).text(5, &self.email); + Msg::new().msg(8, Msg::new().msg(1, rsp)).0 + } + + /// `Rsp.installerRsp.initInstallerRsp`. + pub fn installer(&self) -> Vec { + Msg::new().msg(10, Msg::new().msg(1, Msg::new().uint(1, 1).msg(2, self.chunks()).text(3, &self.language))).0 + } + + /// `Rsp.productRsp.getProductListRsp`: every owned product as owned, playable and purchased. + pub fn product_list(&self, request_id: u64) -> Vec { + let mut list = Msg::new().uint(1, request_id).uint(2, 1); + let products: Vec<(u32, u32)> = if self.products.is_empty() { self.owned.iter().map(|id| (*id, 0)).collect() } else { self.products.clone() }; + for (id, kind) in products { + list = list.msg(3, Msg::new().uint(1, id as u64).uint(2, if kind == 1 { 2 } else { 1 }).uint(3, 1).uint(4, 3).uint(6, 1)); + } + Msg::new().msg(15, Msg::new().msg(1, list)).0 + } + + pub fn service_hello(&self) -> Vec { + Msg::new().msg(3, Msg::new().uint(1, 1).msg(3, Msg::new().text(1, HWSCORE))).0 + } + + /// `mg.protocol.orbitdll.Rsp`. The DLL keeps its own `*.save` files in the folder `init` returns. + pub fn orbit(&self, body: &[u8]) -> Option<(Vec, String)> { + let f = pb::fields(body)?; + let id = pb::num(&f, 1)?; + let rsp = Msg::new().uint(1, id); + if let Some(init) = pb::sub(&f, 12) { + let product = pb::fields(init).and_then(|i| pb::num(&i, 1)).unwrap_or(0); + return Some((rsp.msg(12, Msg::new().text(1, &self.saves).uint(2, 1)).0, format!("init {id} for {product} answered"))); + } + if pb::has(&f, 2) { + let login = Msg::new().text(1, &self.username).text(2, "").text(3, ""); + return Some((rsp.msg(2, login).0, format!("login details {id} answered"))); + } + if let Some(osi) = pb::sub(&f, 3) { + let sub = pb::fields(osi).and_then(|o| pb::num(&o, 1)).unwrap_or(0); + return Some((rsp.msg(3, Msg::new().uint(2, OSI_FAILED)).0, format!("osi {id} for {sub} declined"))); + } + None + } +} + +/// Requests answered with only their id and a result: (`Req` field, its request) to (`Rsp` field, its +/// response, `OperationResult`). 1 is ok and 4 not found. +const ACKNOWLEDGED: &[(u32, u32, u32, u32, u64)] = &[ + (8, 1, 5, 1, 1), // achievements: list (none) + (8, 2, 5, 2, 4), // achievements: image + (8, 3, 5, 3, 1), // achievements: earn + (9, 1, 6, 1, 1), // overlay: show + (9, 2, 6, 2, 1), // overlay: shop url + (9, 4, 6, 3, 1), // overlay: browser url + (9, 5, 6, 4, 1), // overlay: notification + (9, 6, 6, 5, 1), // overlay: friend invitation + (9, 7, 6, 6, 1), // overlay: friend selection + (9, 8, 6, 8, 1), // overlay: micro app + (10, 1, 7, 1, 4), // avatar + (20, 1, 14, 1, 1), // store products (none) + (23, 3, 15, 5, 1), // track add-on + (25, 1, 17, 1, 4), // user lookup + (25, 3, 17, 3, 1), // rich presence + (25, 4, 17, 4, 1), // played with +]; + +/// `Rsp.streamingRsp` (20) for `Req.streamingReq` (27): the game is not streamed, so its streaming +/// type is `StreamingType_None` and every other streaming query is not found. +fn streaming(req: &[(u32, Value<'_>)]) -> (Vec, String) { + let id = pb::num(req, 1).unwrap_or(0); + let rsp = if pb::has(req, 3) { + Msg::new().uint(1, id).uint(2, 1).msg(4, Msg::new().uint(1, 0)) + } else { + Msg::new().uint(1, id).uint(2, 4) + }; + (Msg::new().msg(20, rsp).0, format!("streaming id {id} -> not streamed")) +} + +/// The id-and-result answer to a request in [ACKNOWLEDGED] or a streaming query, with a name for the log. +pub fn acknowledge(body: &[u8]) -> Option<(Vec, String)> { + let f = pb::fields(body)?; + if let Some(req) = pb::sub(&f, 27).and_then(pb::fields) { + return Some(streaming(&req)); + } + for &(req, sub, rsp, rsp_sub, result) in ACKNOWLEDGED { + let Some(inner) = pb::sub(&f, req).and_then(pb::fields) else { continue }; + let Some(leaf) = pb::sub(&inner, sub).and_then(pb::fields) else { continue }; + let id = pb::num(&leaf, 1).unwrap_or(0); + let answer = Msg::new().msg(rsp, Msg::new().msg(rsp_sub, Msg::new().uint(1, id).uint(2, result))).0; + return Some((answer, format!("{req}.{sub} id {id} -> {result}"))); + } + None +} + +/// The subsystems an `InitReq` asks for (fields 4 to 11). +#[derive(Clone, Copy, Debug, Default, PartialEq)] +pub struct Subsystems { + pub install: bool, + pub storage: bool, +} + +impl Subsystems { + /// `None` when the request names no subsystem at all. + pub fn of(init: &[u8]) -> Option { + let f = pb::fields(init)?; + if !(4..=11).any(|n| pb::has(&f, n)) { + return None; + } + let on = |n| pb::num(&f, n).unwrap_or(0) != 0; + Some(Subsystems { storage: on(7), install: on(8) }) + } +} + +pub enum SessionReq { + Init(Option), + Installer, + ProductList(u64), + Credentials(u64), + Other, +} + +pub fn session_request(body: &[u8]) -> SessionReq { + let Some(f) = pb::fields(body) else { return SessionReq::Other }; + let leaf = |req, sub| pb::sub(&f, req).and_then(pb::fields).and_then(|r| pb::sub(&r, sub).and_then(pb::fields)); + if pb::sub(&f, 13).and_then(pb::fields).is_some_and(|i| pb::has(&i, 1)) { + SessionReq::Installer + } else if pb::has(&f, 1) { + SessionReq::Init(pb::sub(&f, 1).and_then(Subsystems::of)) + } else if let Some(get) = leaf(11, 1) { + SessionReq::Credentials(pb::num(&get, 1).unwrap_or(0)) + } else if let Some(list) = leaf(23, 1) { + SessionReq::ProductList(pb::num(&list, 1).unwrap_or(0)) + } else { + SessionReq::Other + } +} + +/// The product and game process announced on the api-process pipe, each when the game names it +/// (Far Cry 3 Blood Dragon sends only its process). +pub fn announced(body: &[u8]) -> Option<(Option, Option)> { + let f = pb::fields(body)?; + let r = pb::fields(pb::sub(&f, 2)?)?; + let named = |n| pb::num(&r, n).map(|v| v as u32).filter(|v| *v != 0); + Some((named(1), named(2))) +} + +pub enum AuxReq<'a> { + Init(u64), + Activate(u64, &'a [u8]), + Other(u64), +} + +/// `UplayAuxDll.Req`: an init, or an activation carrying the game's Denuvo request token. +pub fn aux_request(body: &[u8]) -> AuxReq<'_> { + let Some(f) = pb::fields(body) else { return AuxReq::Other(0) }; + let rid = pb::num(&f, 1).unwrap_or(0); + let Some(activate) = pb::sub(&f, 3) else { + return if pb::has(&f, 2) { AuxReq::Init(rid) } else { AuxReq::Other(rid) }; + }; + let token = pb::fields(activate) + .and_then(|a| pb::sub(&a, 2).and_then(pb::fields)) + .and_then(|t| t.iter().find_map(|(n, v)| match v { Value::Bytes(b) if *n == 2 => Some(*b), _ => None })); + match token { + Some(t) => AuxReq::Activate(rid, t), + None => AuxReq::Other(rid), + } +} + +pub fn aux_init(rid: u64, pid: u32) -> Vec { + let mut init = Msg::new().uint(1, 1).uint(2, pid as u64); + for a in AUX_ADDONS { + init = init.uint(3, a); + } + Msg::new().uint(1, rid).msg(2, init).0 +} + +pub fn aux_token(rid: u64, game_token: &[u8]) -> Vec { + let answer = Msg::new().uint(2, 1).uint(3, 0).bytes(4, game_token).bytes(5, b""); + Msg::new().uint(1, rid).msg(3, Msg::new().msg(2, answer)).0 +} + +#[cfg(test)] +mod tests { + use super::*; + + fn config() -> Config { + Config::parse(r#"{"productId":109,"exe":"Z:/games/sc/system/splintercell.exe","workdir":"Z:/games/sc","ticket":"T", + "account":{"userId":"u1","username":"name","nameOnPlatform":"name","email":"e@x","country":"US"}, + "owned":[82],"appId":"a-b","saves":"Z:/saves/u1/109","chunks":[{"id":0,"tags":""},{"id":64,"tags":"custo05"}]}"#).unwrap() + } + + #[test] + fn the_owned_list_always_holds_the_game_and_saves_end_with_a_slash() { + let c = config(); + assert_eq!(c.owned, vec![82, 109]); + assert_eq!(c.saves, "Z:/saves/u1/109/"); + } + + #[test] + fn the_start_reply_names_the_exe_under_the_root_with_connects_double_slash() { + let c = config(); + assert_eq!(c.reply_exe("Z:\\games\\sc\\system\\splintercell.exe"), "Z:/games/sc//system/splintercell.exe"); + let req = Msg::new().msg(1, Msg::new().msg(1, Msg::new().uint(1, 13389).uint(2, 109).text(10, "Z:/games/sc/system/splintercell.exe"))); + let rsp = c.game_start(&req.0); + let granted = pb::fields(pb::sub(&pb::fields(pb::sub(&pb::fields(&rsp).unwrap(), 2).unwrap()).unwrap(), 1).unwrap()).unwrap(); + assert_eq!(pb::num(&granted, 1), Some(0)); + assert_eq!(pb::sub(&granted, 3), Some(&b"Z:/games/sc//system/splintercell.exe"[..])); + assert_eq!(pb::sub(&granted, 4), Some(&b"Z:/games/sc/"[..])); + assert_eq!(pb::num(&granted, 8), Some(3)); + } + + #[test] + fn the_session_carries_the_ticket_products_and_save_root() { + let rsp = config().session(None); + let init = pb::fields(pb::sub(&pb::fields(&rsp).unwrap(), 1).unwrap()).unwrap(); + assert_eq!(pb::num(&init, 1), Some(1)); + assert_eq!(pb::num(&init, 4), Some(109)); + let owned: Vec = init.iter().filter_map(|(n, v)| match v { Value::Int(x) if *n == 5 => Some(*x), _ => None }).collect(); + assert_eq!(owned, vec![82, 109]); + assert_eq!(pb::sub(&init, 8), Some(&b"T"[..])); + let saves = pb::fields(pb::sub(&init, 17).unwrap()).unwrap(); + assert_eq!(pb::sub(&saves, 1), Some(&b"Z:/saves/u1/109/"[..])); + let account = pb::fields(pb::sub(&init, 2).unwrap()).unwrap(); + assert_eq!(pb::sub(&account, 1), Some(&b"u1"[..])); + assert_eq!(pb::sub(&account, 5), Some(&b""[..])); + let install = pb::fields(pb::sub(&init, 14).unwrap()).unwrap(); + assert_eq!(pb::num(&install, 1), Some(1)); + let chunks = pb::fields(pb::sub(&install, 2).unwrap()).unwrap(); + let second = pb::fields(match &chunks[1].1 { Value::Bytes(b) => b, _ => panic!() }).unwrap(); + assert_eq!((pb::num(&second, 1), pb::num(&second, 2), pb::sub(&second, 3)), (Some(64), Some(1), Some(&b"custo05"[..]))); + } + + fn session_fields(rsp: &[u8]) -> Vec { + let init = pb::fields(pb::sub(&pb::fields(rsp).unwrap(), 1).unwrap()).unwrap(); + init.iter().map(|(n, _)| *n).collect() + } + + #[test] + fn an_r2_session_leaves_out_the_install_and_storage_the_game_did_not_ask_for() { + let req = Msg::new().msg(1, Msg::new().uint(1, 6145).uint(2, 512).uint(3, 2).uint(4, 1).uint(5, 1).uint(7, 1).uint(8, 0)); + let SessionReq::Init(wants) = session_request(&req.0) else { panic!() }; + assert_eq!(wants, Some(Subsystems { install: false, storage: true })); + let fields = session_fields(&config().session(wants)); + assert!(!fields.contains(&14)); + assert!(fields.contains(&17)); + assert!(fields.contains(&20)); + let all = session_fields(&config().session(Some(Subsystems { install: true, storage: true }))); + assert!(all.contains(&14) && all.contains(&17)); + } + + #[test] + fn streaming_queries_say_the_game_is_not_streamed() { + let (answer, _) = acknowledge(&[0xda, 0x01, 0x06, 0x08, 0x80, 0x80, 0x08, 0x1a, 0x00]).unwrap(); + let rsp = pb::fields(pb::sub(&pb::fields(&answer).unwrap(), 20).unwrap()).unwrap(); + assert_eq!((pb::num(&rsp, 1), pb::num(&rsp, 2)), (Some(0x20000), Some(1))); + assert_eq!(pb::num(&pb::fields(pb::sub(&rsp, 4).unwrap()).unwrap(), 1), Some(0)); + let (answer, _) = acknowledge(&Msg::new().msg(27, Msg::new().uint(1, 7).bytes(2, b"")).0).unwrap(); + let rsp = pb::fields(pb::sub(&pb::fields(&answer).unwrap(), 20).unwrap()).unwrap(); + assert_eq!((pb::num(&rsp, 1), pb::num(&rsp, 2)), (Some(7), Some(4))); + } + + #[test] + fn an_r1_session_without_subsystems_keeps_install_and_storage() { + let SessionReq::Init(wants) = session_request(&Msg::new().msg(1, Msg::new().uint(1, 109).uint(2, 4242)).0) else { panic!() }; + assert_eq!(wants, None); + let fields = session_fields(&config().session(wants)); + assert!(fields.contains(&14) && fields.contains(&17)); + assert!(!fields.contains(&20)); + } + + #[test] + fn requests_are_told_apart() { + assert!(matches!(session_request(&Msg::new().msg(1, Msg::new().uint(1, 109)).0), SessionReq::Init(None))); + assert!(matches!(session_request(&Msg::new().msg(13, Msg::new().bytes(1, b"")).0), SessionReq::Installer)); + assert!(matches!(session_request(&[0xba, 0x01, 0x06, 0x0a, 0x04, 0x08, 0x80, 0x80, 0x04]), SessionReq::ProductList(65536))); + let (answer, _) = acknowledge(&[0x42, 0x08, 0x0a, 0x06, 0x08, 0x80, 0x80, 0x08, 0x10, 0x00]).unwrap(); + let rsp = pb::fields(pb::sub(&pb::fields(pb::sub(&pb::fields(&answer).unwrap(), 5).unwrap()).unwrap(), 1).unwrap()).unwrap(); + assert_eq!((pb::num(&rsp, 1), pb::num(&rsp, 2)), (Some(0x20000), Some(1))); + assert!(acknowledge(&Msg::new().msg(1, Msg::new().uint(1, 1)).0).is_none()); + assert_eq!(announced(&Msg::new().msg(2, Msg::new().uint(1, 109).uint(2, 4242).uint(5, 1)).0), Some((Some(109), Some(4242)))); + assert_eq!(announced(&[0x12, 0x05, 0x10, 0x88, 0x04, 0x28, 0x01]), Some((None, Some(520)))); + assert!(matches!(session_request(&[0x5a, 0x04, 0x0a, 0x02, 0x08, 0x00]), SessionReq::Credentials(0))); + let activate = Msg::new().uint(1, 2).msg(3, Msg::new().msg(2, Msg::new().bytes(2, b"challenge").uint(3, 0))); + assert!(matches!(aux_request(&activate.0), AuxReq::Activate(2, b"challenge"))); + assert!(matches!(aux_request(&Msg::new().uint(1, 1).msg(2, Msg::new().uint(1, 109)).0), AuxReq::Init(1))); + } + + #[test] + fn orbit_init_answers_with_the_save_folder() { + let (rsp, what) = config().orbit(&[0x08, 0x01, 0x62, 0x03, 0x08, 0xcd, 0x01]).unwrap(); + assert_eq!(what, "init 1 for 205 answered"); + let f = pb::fields(&rsp).unwrap(); + assert_eq!(pb::num(&f, 1), Some(1)); + let init = pb::fields(pb::sub(&f, 12).unwrap()).unwrap(); + assert_eq!(pb::sub(&init, 1), Some(&b"Z:/saves/u1/109/"[..])); + assert_eq!(pb::num(&init, 2), Some(1)); + } + + #[test] + fn orbit_login_details_carry_no_password_and_osi_is_declined() { + let c = config(); + let (rsp, _) = c.orbit(&Msg::new().uint(1, 2).bytes(2, b"").0).unwrap(); + let f = pb::fields(&rsp).unwrap(); + let login = pb::fields(pb::sub(&f, 2).unwrap()).unwrap(); + assert_eq!((pb::sub(&login, 1), pb::sub(&login, 2), pb::sub(&login, 3)), (Some(&b"name"[..]), Some(&b""[..]), Some(&b""[..]))); + let (rsp, what) = c.orbit(&Msg::new().uint(1, 3).msg(3, Msg::new().uint(1, 7)).0).unwrap(); + assert_eq!(what, "osi 3 for 7 declined"); + let osi = pb::fields(pb::sub(&pb::fields(&rsp).unwrap(), 3).unwrap()).unwrap(); + assert_eq!((pb::num(&osi, 2), pb::has(&osi, 1)), (Some(OSI_FAILED), false)); + assert!(c.orbit(&Msg::new().uint(1, 4).0).is_none()); + } + + #[test] + fn credentials_name_the_account_without_a_password() { + let rsp = config().credentials(7); + let user = pb::fields(pb::sub(&pb::fields(&rsp).unwrap(), 8).unwrap()).unwrap(); + let get = pb::fields(pb::sub(&user, 1).unwrap()).unwrap(); + assert_eq!(pb::num(&get, 1), Some(7)); + assert_eq!((pb::sub(&get, 2), pb::sub(&get, 3), pb::sub(&get, 4), pb::sub(&get, 5)), + (Some(&b"name"[..]), Some(&b""[..]), Some(&b"u1"[..]), Some(&b"e@x"[..]))); + } +} diff --git a/tools/ubisoft-launcher/src/main.rs b/tools/ubisoft-launcher/src/main.rs new file mode 100644 index 0000000000..0b7126a919 --- /dev/null +++ b/tools/ubisoft-launcher/src/main.rs @@ -0,0 +1,355 @@ +//! Stands in for Ubisoft Connect on the local pipes a Ubisoft game talks to, and starts the game. +//! +//! Usage: droiddeck-upc.exe + +#![cfg_attr(windows, windows_subsystem = "windows")] + +mod launcher; +mod pb; +#[cfg(windows)] +mod win; + +#[cfg(not(windows))] +fn main() { + eprintln!("droiddeck-upc runs inside Wine"); + std::process::exit(2); +} + +#[cfg(windows)] +fn main() { + std::process::exit(service::run()); +} + +#[cfg(windows)] +mod service { + use crate::launcher::{self, AuxReq, Config, SessionReq}; + use crate::win::{self, Handle}; + use std::fs::OpenOptions; + use std::io::Write; + use std::path::PathBuf; + use std::sync::atomic::{AtomicU32, Ordering}; + use std::sync::{Arc, Mutex}; + use std::thread; + use std::time::{Duration, Instant}; + + const MAX_FRAME: usize = 16 << 20; + const ANNOUNCE_WAIT: Duration = Duration::from_secs(120); + const RESTART_WAIT: Duration = Duration::from_secs(15); + const DENUVO_WAIT: Duration = Duration::from_secs(90); + + struct State { + cfg: Config, + prefix: String, + log: Mutex>, + event: Handle, + game: AtomicU32, + started: Instant, + } + + impl State { + fn say(&self, line: &str) { + let text = format!("[{:7.2}] {line}\n", self.started.elapsed().as_secs_f32()); + eprint!("droiddeck-upc: {text}"); + if let Some(f) = self.log.lock().unwrap().as_mut() { + let _ = f.write_all(text.as_bytes()); + } + } + } + + struct Frames<'a> { + pipe: &'a Handle, + buf: Vec, + } + + impl<'a> Frames<'a> { + fn new(pipe: &'a Handle) -> Self { + Frames { pipe, buf: Vec::new() } + } + + fn fill(&mut self) -> bool { + let mut chunk = vec![0u8; 65536]; + match self.pipe.read(&mut chunk) { + Some(n) => { + self.buf.extend_from_slice(&chunk[..n]); + true + } + None => false, + } + } + + /// The next message without its 4-byte big-endian length. + fn next(&mut self) -> Option> { + while self.buf.len() < 4 { + if !self.fill() { + return None; + } + } + let n = u32::from_be_bytes(self.buf[..4].try_into().unwrap()) as usize; + if n > MAX_FRAME { + return None; + } + while self.buf.len() < 4 + n { + if !self.fill() { + return None; + } + } + let body = self.buf[4..4 + n].to_vec(); + self.buf.drain(..4 + n); + Some(body) + } + } + + fn send(pipe: &Handle, body: &[u8]) -> bool { + let mut framed = (body.len() as u32).to_be_bytes().to_vec(); + framed.extend_from_slice(body); + pipe.write_all(&framed) + } + + fn hold(state: &State, name: &str, frames: &mut Frames) { + while let Some(body) = frames.next() { + state.say(&format!("{name}: {} B left unanswered", body.len())); + } + } + + fn game_start(state: &State, pipe: Handle) { + let mut frames = Frames::new(&pipe); + let Some(req) = frames.next() else { return }; + send(&pipe, &state.cfg.game_start(&req)); + state.say("game_start: start granted"); + hold(state, "game_start", &mut frames); + } + + fn api_process(state: &State, pipe: Handle) { + let mut frames = Frames::new(&pipe); + let Some(req) = frames.next() else { return }; + match launcher::announced(&req) { + Some((product, named)) => { + let product = product.unwrap_or(state.cfg.product); + match named.or_else(|| pipe.client_pid()) { + Some(pid) => { + state.say(&format!("api_process: product {product} is process {pid}")); + state.game.store(pid, Ordering::SeqCst); + } + None => state.say(&format!("api_process: product {product} named no process")), + } + } + None => state.say(&format!("api_process: {} B announcement not understood {}", req.len(), hex(&req, 32))), + } + send(&pipe, &state.cfg.init_process()); + state.event.set(); + hold(state, "api_process", &mut frames); + } + + fn session(state: &State, pipe: Handle) { + let mut frames = Frames::new(&pipe); + let mut pushes = 0; + while let Some(req) = frames.next() { + match launcher::session_request(&req) { + SessionReq::Init(wants) => { + pushes += 1; + send(&pipe, &state.cfg.session(wants)); + let asked = wants.map_or("no subsystems named".to_string(), |w| format!("install {}, storage {}", w.install, w.storage)); + state.say(&format!("session: init answered ({pushes}; {asked}; {})", hex(&req, 48))); + } + SessionReq::Installer => { + send(&pipe, &state.cfg.installer()); + state.say("session: installer init answered"); + } + SessionReq::Credentials(id) => { + send(&pipe, &state.cfg.credentials(id)); + state.say(&format!("session: credentials {id} answered")); + } + SessionReq::ProductList(id) => { + send(&pipe, &state.cfg.product_list(id)); + state.say(&format!("session: product list {id} answered")); + } + SessionReq::Other => match launcher::acknowledge(&req) { + Some((answer, what)) => { + send(&pipe, &answer); + state.say(&format!("session: {what}")); + } + None => state.say(&format!("session: {} B request {} not handled", req.len(), hex(&req, 24))), + }, + } + } + state.say("session: closed"); + } + + fn denuvo(state: &State, rid: u64, challenge: &[u8]) -> Option> { + if state.cfg.bridge.is_empty() { + return None; + } + let dir = PathBuf::from(&state.cfg.bridge); + let _ = std::fs::create_dir_all(&dir); + let rsp = dir.join(format!("denuvo-{rid}.rsp")); + let _ = std::fs::remove_file(&rsp); + let part = dir.join(format!("denuvo-{rid}.req.part")); + std::fs::write(&part, challenge).ok()?; + std::fs::rename(&part, dir.join(format!("denuvo-{rid}.req"))).ok()?; + let deadline = Instant::now() + DENUVO_WAIT; + while Instant::now() < deadline { + if let Ok(token) = std::fs::read(&rsp) { + let _ = std::fs::remove_file(&rsp); + return (!token.is_empty()).then_some(token); + } + thread::sleep(Duration::from_millis(200)); + } + None + } + + fn aux(state: &State, pipe: Handle) { + let mut frames = Frames::new(&pipe); + while let Some(req) = frames.next() { + match launcher::aux_request(&req) { + AuxReq::Init(rid) => { + send(&pipe, &launcher::aux_init(rid, win::pid())); + state.say("aux: init answered"); + } + AuxReq::Activate(rid, challenge) => { + state.say(&format!("aux: activation {rid} with a {} B challenge", challenge.len())); + match denuvo(state, rid, challenge) { + Some(token) => { + send(&pipe, &launcher::aux_token(rid, &token)); + state.say(&format!("aux: activation {rid} answered ({} B)", token.len())); + } + None => state.say(&format!("aux: no game token for activation {rid}")), + } + } + AuxReq::Other(rid) => state.say(&format!("aux: request {rid} not handled ({} B)", req.len())), + } + } + } + + fn service(state: &State, pipe: Handle) { + send(&pipe, &state.cfg.service_hello()); + let mut chunk = vec![0u8; 65536]; + while pipe.read(&mut chunk).is_some() {} + } + + fn orbit(state: &State, pipe: Handle) { + let mut frames = Frames::new(&pipe); + while let Some(req) = frames.next() { + match state.cfg.orbit(&req) { + Some((answer, what)) => { + send(&pipe, &answer); + state.say(&format!("orbit: {what}")); + } + None => state.say(&format!("orbit: {} B request {} not handled", req.len(), hex(&req, 24))), + } + } + state.say("orbit: closed"); + } + + fn quiet(state: &State, name: &str, pipe: Handle) { + state.say(&format!("{name}: connected")); + let mut chunk = vec![0u8; 65536]; + while let Some(n) = pipe.read(&mut chunk) { + state.say(&format!("{name}: {n} B unanswered {}", hex(&chunk[..n], 64))); + } + } + + fn serve(state: Arc, name: &'static str) { + thread::spawn(move || { + let full = format!("{}{name}", state.prefix); + loop { + let Some(pipe) = win::accept(&full) else { + state.say(&format!("{name}: cannot serve the pipe (error {})", win::last_error())); + return; + }; + let s = state.clone(); + thread::spawn(move || match name { + launcher::GAME_START => game_start(&s, pipe), + launcher::API_PROCESS => api_process(&s, pipe), + launcher::SESSION => session(&s, pipe), + launcher::AUX => aux(&s, pipe), + launcher::SERVICE => service(&s, pipe), + launcher::ORBIT => orbit(&s, pipe), + _ => quiet(&s, name, pipe), + }); + } + }); + } + + fn hex(b: &[u8], n: usize) -> String { + b.iter().take(n).map(|x| format!("{x:02x}")).collect() + } + + fn command_line(cfg: &Config) -> String { + let mut c = format!("\"{}\"", cfg.exe); + if !cfg.args.trim().is_empty() { + c.push(' '); + c.push_str(cfg.args.trim()); + } + c + } + + pub fn run() -> i32 { + let Some(path) = std::env::args().nth(1) else { + eprintln!("usage: droiddeck-upc "); + return 2; + }; + let parsed = std::fs::read_to_string(&path).map_err(|e| e.to_string()).and_then(|t| Config::parse(&t)); + let _ = std::fs::remove_file(&path); + let cfg = match parsed { + Ok(c) => c, + Err(e) => { + eprintln!("droiddeck-upc: {e}"); + return 2; + } + }; + let log = (!cfg.log.is_empty()).then(|| OpenOptions::new().create(true).append(true).open(&cfg.log).ok()).flatten(); + let state = Arc::new(State { + prefix: format!(r"\\.\pipe\terminal_{}_", win::session_id()), + cfg, + log: Mutex::new(log), + event: win::inheritable_event(), + game: AtomicU32::new(0), + started: Instant::now(), + }); + state.say(&format!("product {} on {}*", state.cfg.product, state.prefix)); + for name in [launcher::GAME_START, launcher::API_PROCESS, launcher::SESSION, launcher::AUX, launcher::SERVICE, launcher::ORBIT] + .into_iter() + .chain(launcher::QUIET.iter().copied()) + { + serve(state.clone(), name); + } + thread::sleep(Duration::from_millis(300)); + + let (child, pid) = match win::spawn(&command_line(&state.cfg), &state.cfg.workdir) { + Ok(c) => c, + Err(e) => { + state.say(&format!("cannot start {} (error {e})", state.cfg.exe)); + return 1; + } + }; + state.say(&format!("started {} as process {pid}", state.cfg.exe)); + while !child.wait(1000) {} + let mut code = child.exit_code(); + state.say(&format!("process {pid} exited with 0x{code:08x}")); + + let mut waiting = Instant::now(); + let mut limit = ANNOUNCE_WAIT; + loop { + let game = state.game.swap(0, Ordering::SeqCst); + if game != 0 { + match win::open_process(game) { + Some(h) => { + while !h.wait(1000) {} + code = h.exit_code(); + state.say(&format!("game process {game} exited with 0x{code:08x}")); + } + None => state.say(&format!("game process {game} is already gone")), + } + waiting = Instant::now(); + limit = RESTART_WAIT; + continue; + } + if waiting.elapsed() >= limit { + break; + } + thread::sleep(Duration::from_millis(500)); + } + state.say("done"); + code as i32 + } +} diff --git a/tools/ubisoft-launcher/src/pb.rs b/tools/ubisoft-launcher/src/pb.rs new file mode 100644 index 0000000000..d0ae27d160 --- /dev/null +++ b/tools/ubisoft-launcher/src/pb.rs @@ -0,0 +1,168 @@ +//! The protobuf wire format, enough to build and read the launcher messages by field number. + +pub fn varint(mut n: u64, out: &mut Vec) { + loop { + let b = (n & 0x7f) as u8; + n >>= 7; + if n == 0 { + out.push(b); + return; + } + out.push(b | 0x80); + } +} + +#[derive(Default, Clone)] +pub struct Msg(pub Vec); + +impl Msg { + pub fn new() -> Self { + Msg(Vec::new()) + } + + fn key(mut self, field: u32, wire: u8) -> Self { + varint(((field as u64) << 3) | wire as u64, &mut self.0); + self + } + + pub fn uint(self, field: u32, value: u64) -> Self { + let mut m = self.key(field, 0); + varint(value, &mut m.0); + m + } + + pub fn bytes(self, field: u32, value: &[u8]) -> Self { + let mut m = self.key(field, 2); + varint(value.len() as u64, &mut m.0); + m.0.extend_from_slice(value); + m + } + + pub fn text(self, field: u32, value: &str) -> Self { + self.bytes(field, value.as_bytes()) + } + + pub fn msg(self, field: u32, value: Msg) -> Self { + self.bytes(field, &value.0) + } + + pub fn float(self, field: u32, value: f32) -> Self { + let mut m = self.key(field, 5); + m.0.extend_from_slice(&value.to_le_bytes()); + m + } +} + +#[derive(Debug, Clone, PartialEq)] +pub enum Value<'a> { + Int(u64), + Bytes(&'a [u8]), +} + +fn read_varint(b: &[u8], i: &mut usize) -> Option { + let mut r = 0u64; + let mut shift = 0; + loop { + let c = *b.get(*i)?; + *i += 1; + if shift >= 64 { + return None; + } + r |= ((c & 0x7f) as u64) << shift; + if c & 0x80 == 0 { + return Some(r); + } + shift += 7; + } +} + +/// The top-level fields of a message, or `None` when it does not parse. +pub fn fields(b: &[u8]) -> Option)>> { + let mut out = Vec::new(); + let mut i = 0; + while i < b.len() { + let key = read_varint(b, &mut i)?; + let field = (key >> 3) as u32; + match key & 7 { + 0 => out.push((field, Value::Int(read_varint(b, &mut i)?))), + 1 => { + let v = b.get(i..i + 8)?; + i += 8; + out.push((field, Value::Int(u64::from_le_bytes(v.try_into().ok()?)))); + } + 2 => { + let n = read_varint(b, &mut i)? as usize; + let v = b.get(i..i.checked_add(n)?)?; + i += n; + out.push((field, Value::Bytes(v))); + } + 5 => { + let v = b.get(i..i + 4)?; + i += 4; + out.push((field, Value::Int(u32::from_le_bytes(v.try_into().ok()?) as u64))); + } + _ => return None, + } + } + Some(out) +} + +pub fn sub<'a>(f: &[(u32, Value<'a>)], field: u32) -> Option<&'a [u8]> { + f.iter().find_map(|(n, v)| match v { + Value::Bytes(b) if *n == field => Some(*b), + _ => None, + }) +} + +pub fn num(f: &[(u32, Value<'_>)], field: u32) -> Option { + f.iter().find_map(|(n, v)| match v { + Value::Int(x) if *n == field => Some(*x), + _ => None, + }) +} + +pub fn has(f: &[(u32, Value<'_>)], field: u32) -> bool { + f.iter().any(|(n, _)| *n == field) +} + +/// The first length-delimited `field` at any depth up to `depth`, searching breadth first. +pub fn find(b: &[u8], field: u32, depth: u32) -> Option<&[u8]> { + let f = fields(b)?; + if let Some(v) = sub(&f, field) { + return Some(v); + } + if depth == 0 { + return None; + } + f.iter().find_map(|(_, v)| match v { + Value::Bytes(inner) => find(inner, field, depth - 1), + _ => None, + }) +} + +#[cfg(test)] +mod tests { + use super::*; + + #[test] + fn round_trip() { + let m = Msg::new().uint(1, 300).text(2, "hi").msg(3, Msg::new().uint(4, 1)).float(5, 1.0); + let f = fields(&m.0).unwrap(); + assert_eq!(num(&f, 1), Some(300)); + assert_eq!(sub(&f, 2), Some(&b"hi"[..])); + assert_eq!(num(&fields(sub(&f, 3).unwrap()).unwrap(), 4), Some(1)); + assert_eq!(num(&f, 5), Some(0x3f80_0000)); + } + + #[test] + fn finds_nested_fields() { + let m = Msg::new().msg(1, Msg::new().msg(1, Msg::new().uint(2, 109).text(10, "C:/game.exe"))); + assert_eq!(find(&m.0, 10, 4), Some(&b"C:/game.exe"[..])); + assert_eq!(find(&m.0, 11, 4), None); + } + + #[test] + fn rejects_truncated_input() { + assert!(fields(&[0x0a, 0x05, 1, 2]).is_none()); + } +} diff --git a/tools/ubisoft-launcher/src/win.rs b/tools/ubisoft-launcher/src/win.rs new file mode 100644 index 0000000000..e6953f46d1 --- /dev/null +++ b/tools/ubisoft-launcher/src/win.rs @@ -0,0 +1,189 @@ +//! The handful of kernel32 calls the launcher needs. + +#![allow(non_snake_case, clippy::upper_case_acronyms)] + +use std::ffi::c_void; +use std::os::windows::ffi::OsStrExt; + +pub type HANDLE = *mut c_void; +pub const INVALID: HANDLE = -1isize as HANDLE; +const PIPE_ACCESS_DUPLEX: u32 = 3; +const PIPE_TYPE_BYTE: u32 = 0; +const PIPE_READMODE_BYTE: u32 = 0; +const PIPE_WAIT: u32 = 0; +const PIPE_UNLIMITED_INSTANCES: u32 = 255; +const ERROR_PIPE_CONNECTED: u32 = 535; +const HANDLE_FLAG_INHERIT: u32 = 1; +const SYNCHRONIZE: u32 = 0x0010_0000; +const PROCESS_QUERY_LIMITED_INFORMATION: u32 = 0x1000; +pub const WAIT_OBJECT_0: u32 = 0; +const BUFFER: u32 = 65536; + +#[repr(C)] +struct STARTUPINFOW { + cb: u32, + lpReserved: *mut u16, + lpDesktop: *mut u16, + lpTitle: *mut u16, + dwX: u32, + dwY: u32, + dwXSize: u32, + dwYSize: u32, + dwXCountChars: u32, + dwYCountChars: u32, + dwFillAttribute: u32, + dwFlags: u32, + wShowWindow: u16, + cbReserved2: u16, + lpReserved2: *mut u8, + hStdInput: HANDLE, + hStdOutput: HANDLE, + hStdError: HANDLE, +} + +#[repr(C)] +struct PROCESS_INFORMATION { + hProcess: HANDLE, + hThread: HANDLE, + dwProcessId: u32, + dwThreadId: u32, +} + +#[link(name = "kernel32")] +extern "system" { + fn CreateNamedPipeW(name: *const u16, open: u32, mode: u32, max: u32, out: u32, inp: u32, timeout: u32, sa: *mut c_void) -> HANDLE; + fn ConnectNamedPipe(h: HANDLE, ov: *mut c_void) -> i32; + fn ReadFile(h: HANDLE, buf: *mut u8, n: u32, read: *mut u32, ov: *mut c_void) -> i32; + fn WriteFile(h: HANDLE, buf: *const u8, n: u32, written: *mut u32, ov: *mut c_void) -> i32; + fn FlushFileBuffers(h: HANDLE) -> i32; + fn CloseHandle(h: HANDLE) -> i32; + fn GetLastError() -> u32; + fn CreateEventW(sa: *mut c_void, manual: i32, initial: i32, name: *const u16) -> HANDLE; + fn SetEvent(h: HANDLE) -> i32; + fn SetHandleInformation(h: HANDLE, mask: u32, flags: u32) -> i32; + fn CreateProcessW(app: *const u16, cmd: *mut u16, pa: *mut c_void, ta: *mut c_void, inherit: i32, flags: u32, + env: *mut c_void, cwd: *const u16, si: *mut STARTUPINFOW, pi: *mut PROCESS_INFORMATION) -> i32; + fn WaitForSingleObject(h: HANDLE, ms: u32) -> u32; + fn GetExitCodeProcess(h: HANDLE, code: *mut u32) -> i32; + fn OpenProcess(access: u32, inherit: i32, pid: u32) -> HANDLE; + fn ProcessIdToSessionId(pid: u32, session: *mut u32) -> i32; + fn GetNamedPipeClientProcessId(pipe: HANDLE, pid: *mut u32) -> i32; + fn GetCurrentProcessId() -> u32; +} + +pub fn wide(s: &str) -> Vec { + std::ffi::OsStr::new(s).encode_wide().chain(Some(0)).collect() +} + +pub fn last_error() -> u32 { + unsafe { GetLastError() } +} + +pub fn pid() -> u32 { + unsafe { GetCurrentProcessId() } +} + +pub fn session_id() -> u32 { + let mut s = 0; + if unsafe { ProcessIdToSessionId(GetCurrentProcessId(), &mut s) } == 0 { + return 1; + } + s +} + +pub struct Handle(pub HANDLE); +unsafe impl Send for Handle {} +unsafe impl Sync for Handle {} + +impl Drop for Handle { + fn drop(&mut self) { + if !self.0.is_null() && self.0 != INVALID { + unsafe { CloseHandle(self.0) }; + } + } +} + +impl Handle { + pub fn read(&self, buf: &mut [u8]) -> Option { + let mut n = 0u32; + let ok = unsafe { ReadFile(self.0, buf.as_mut_ptr(), buf.len() as u32, &mut n, std::ptr::null_mut()) }; + (ok != 0 && n > 0).then_some(n as usize) + } + + pub fn write_all(&self, mut data: &[u8]) -> bool { + while !data.is_empty() { + let mut n = 0u32; + if unsafe { WriteFile(self.0, data.as_ptr(), data.len() as u32, &mut n, std::ptr::null_mut()) } == 0 || n == 0 { + return false; + } + data = &data[n as usize..]; + } + unsafe { FlushFileBuffers(self.0) }; + true + } + + pub fn wait(&self, ms: u32) -> bool { + unsafe { WaitForSingleObject(self.0, ms) == WAIT_OBJECT_0 } + } + + pub fn exit_code(&self) -> u32 { + let mut c = 0; + unsafe { GetExitCodeProcess(self.0, &mut c) }; + c + } + + pub fn set(&self) { + unsafe { SetEvent(self.0) }; + } + + pub fn client_pid(&self) -> Option { + let mut pid = 0; + (unsafe { GetNamedPipeClientProcessId(self.0, &mut pid) } != 0 && pid != 0).then_some(pid) + } +} + +/// A new instance of the named pipe, waiting for its client; `None` when it cannot be created. +pub fn accept(name: &str) -> Option { + let w = wide(name); + let h = unsafe { + CreateNamedPipeW(w.as_ptr(), PIPE_ACCESS_DUPLEX, PIPE_TYPE_BYTE | PIPE_READMODE_BYTE | PIPE_WAIT, + PIPE_UNLIMITED_INSTANCES, BUFFER, BUFFER, 0, std::ptr::null_mut()) + }; + if h == INVALID { + return None; + } + let pipe = Handle(h); + if unsafe { ConnectNamedPipe(h, std::ptr::null_mut()) } == 0 && last_error() != ERROR_PIPE_CONNECTED { + return None; + } + Some(pipe) +} + +/// An auto-reset event the started process inherits. +pub fn inheritable_event() -> Handle { + let h = unsafe { CreateEventW(std::ptr::null_mut(), 0, 0, std::ptr::null()) }; + unsafe { SetHandleInformation(h, HANDLE_FLAG_INHERIT, HANDLE_FLAG_INHERIT) }; + Handle(h) +} + +pub fn spawn(command_line: &str, cwd: &str) -> Result<(Handle, u32), u32> { + let mut cmd = wide(command_line); + let dir = wide(cwd); + let mut si: STARTUPINFOW = unsafe { std::mem::zeroed() }; + si.cb = std::mem::size_of::() as u32; + let mut pi: PROCESS_INFORMATION = unsafe { std::mem::zeroed() }; + let ok = unsafe { + CreateProcessW(std::ptr::null(), cmd.as_mut_ptr(), std::ptr::null_mut(), std::ptr::null_mut(), 1, 0, + std::ptr::null_mut(), if cwd.is_empty() { std::ptr::null() } else { dir.as_ptr() }, &mut si, &mut pi) + }; + if ok == 0 { + return Err(last_error()); + } + drop(Handle(pi.hThread)); + Ok((Handle(pi.hProcess), pi.dwProcessId)) +} + +pub fn open_process(pid: u32) -> Option { + let h = unsafe { OpenProcess(SYNCHRONIZE | PROCESS_QUERY_LIMITED_INFORMATION, 0, pid) }; + (!h.is_null()).then(|| Handle(h)) +} diff --git a/tools/ubuntu/README.md b/tools/ubuntu/README.md index 85001fe67a..eefff4c6c7 100644 --- a/tools/ubuntu/README.md +++ b/tools/ubuntu/README.md @@ -9,7 +9,8 @@ Steam on the desktop). The app installs it into `files/linuxfs` and runs it unde `/dev/kgsl-3d0`, and KWin with `patches/kwin` (nested desktop scale, an explicit render node, scroll source/discrete forwarding). Both get a `+droiddeck` version. `patches/mesa` adds KGSL UBWC 5/6 (backported from upstream Mesa) and the KGSL device numbers for WSI (from - [Droid-Deck/Drivers](https://github.com/Droid-Deck/Drivers)). + [Droid-Deck/Drivers](https://github.com/Droid-Deck/Drivers)). It also carries Icenowy Zheng's upstream + Zink fix that keeps the Imagination depth/stencil swizzle off colour views (Mesa d55418dae7). - The runtime's built-in Vulkan driver is DroidDeck's DD-Turnip Linux build (`DD_TURNIP_URL` and `DD_TURNIP_SHA256` in `base.env`): Ubuntu's Turnip is diverted to `libvulkan_freedreno.so.distrib` because it lacks the Adreno 8xx fixes. Zink, EGL and llvmpipe stay Ubuntu's. diff --git a/tools/ubuntu/patches/mesa/0005-zink-check-zs-aspect-before-creating-zs-view.patch b/tools/ubuntu/patches/mesa/0005-zink-check-zs-aspect-before-creating-zs-view.patch new file mode 100644 index 0000000000..3a2aa0bd96 --- /dev/null +++ b/tools/ubuntu/patches/mesa/0005-zink-check-zs-aspect-before-creating-zs-view.patch @@ -0,0 +1,41 @@ +From d55418dae753c8daacf66ab81a7481094808576a Mon Sep 17 00:00:00 2001 +From: Icenowy Zheng +Date: Sun, 31 May 2026 21:56:32 +0800 +Subject: [PATCH] zink: check Z/S aspect before creating Z/S image view + +When moving the code of creating image views to the init_sampler_view() +function, the check for Z/S aspect bits was forgotten to be added +(because it was a big if gating a lot of code originally). + +When the driver doesn't have needs_zs_shader_swizzle set, this is not +problematic, because the condition for creating Z/S view is to have only +Z aspect; however the needs_zs_shader_swizzle case now fails because Z/S +views are now created for color images. + +Fix the issue by re-adding the Z/S aspect check before checking +needs_zs_shader_swizzle flag. + +Fixes: cafa22142bf1 ("zink: create views for samplers lazily") +Signed-off-by: Icenowy Zheng +Part-of: +--- + src/gallium/drivers/zink/zink_context.c | 3 ++- + 1 file changed, 2 insertions(+), 1 deletion(-) + +diff --git a/src/gallium/drivers/zink/zink_context.c b/src/gallium/drivers/zink/zink_context.c +index e264e57b2703..41bc1b6932a7 100644 +--- a/src/gallium/drivers/zink/zink_context.c ++++ b/src/gallium/drivers/zink/zink_context.c +@@ -1173,7 +1173,8 @@ init_sampler_view(struct zink_context *ctx, struct zink_sampler_view *sv) + + bool red_depth_sampler_view = false; + if (sv->ivci.subresourceRange.aspectMask == VK_IMAGE_ASPECT_DEPTH_BIT || +- screen->driver_compiler_workarounds.needs_zs_shader_swizzle) { ++ ((sv->ivci.subresourceRange.aspectMask & (VK_IMAGE_ASPECT_DEPTH_BIT | VK_IMAGE_ASPECT_STENCIL_BIT)) && ++ screen->driver_compiler_workarounds.needs_zs_shader_swizzle)) { + VkComponentSwizzle *swizzle = (VkComponentSwizzle*)&sv->ivci.components; + for (unsigned i = 0; i < 4; i++) { + if (swizzle[i] == VK_COMPONENT_SWIZZLE_ONE || +-- +GitLab +