From c71ba6da96c7f1437c3871ac3a05d39bd578d526 Mon Sep 17 00:00:00 2001 From: MaxsTechReview Date: Sun, 25 Oct 2026 21:09:24 -0400 Subject: [PATCH] Run desktop games on the GPU in a window (#1584) Steam games and Battle.net started from the KDE desktop run on the GPU in gamescope, opened as a KDE window, and Plasma no longer leaves programs with a zero realtime CPU limit that got games killed. --- tools/linuxfs/desktop/droiddeck-desktop | 3 + tools/linuxfs/desktop/droiddeck-gpu | 29 +++++++- .../overlay/usr/local/bin/droiddeck-battlenet | 15 +++- .../usr/local/bin/droiddeck-gpu-window | 7 ++ .../overlay/usr/local/bin/droiddeck-open | 8 +- .../overlay/usr/local/bin/steam-compatibility | 34 ++++++++- tools/tests/test_battlenet.py | 27 +++++++ tools/tests/test_desktop_gpu_window.py | 74 +++++++++++++++++++ tools/tests/test_game_environment.py | 29 ++++++++ 9 files changed, 214 insertions(+), 12 deletions(-) create mode 100644 tools/tests/test_desktop_gpu_window.py diff --git a/tools/linuxfs/desktop/droiddeck-desktop b/tools/linuxfs/desktop/droiddeck-desktop index 71377fed6..83b67d622 100644 --- a/tools/linuxfs/desktop/droiddeck-desktop +++ b/tools/linuxfs/desktop/droiddeck-desktop @@ -12,6 +12,9 @@ export MOZ_DISABLE_SOCKET_PROCESS_SANDBOX=1 MOZ_DISABLE_UTILITY_SANDBOX=1 export MOZ_SHM_NO_SEALS=1 export KWIN_COMPOSE=Q QT_QUICK_BACKEND=software LIBGL_ALWAYS_SOFTWARE=1 GALLIUM_DRIVER=llvmpipe [ -e /etc/mpv/mpv.conf ] || { mkdir -p /etc/mpv && echo gpu-sw=yes >/etc/mpv/mpv.conf; } 2>/dev/null +for conf in client client-rt; do + mkdir -p "/etc/pipewire/$conf.conf.d" && printf 'context.properties = {\n module.rt = false\n}\n' >"/etc/pipewire/$conf.conf.d/droiddeck-rt.conf" +done 2>/dev/null export DROIDDECK_NESTED_SCALE=1 export DROIDDECK_GLTHREAD=${mesa_glthread:-} unset MESA_LOADER_DRIVER_OVERRIDE LIBGL_KOPPER_DRI2 mesa_glthread diff --git a/tools/linuxfs/desktop/droiddeck-gpu b/tools/linuxfs/desktop/droiddeck-gpu index 40a346085..f759d3ad0 100644 --- a/tools/linuxfs/desktop/droiddeck-gpu +++ b/tools/linuxfs/desktop/droiddeck-gpu @@ -6,21 +6,42 @@ if [ -n "${BL_DEBUG_DIR:-}" ]; then fi width=${BL_WIDTH:-1280} height=${BL_HEIGHT:-720} -args=(--backend wayland --expose-wayland -f -W "$width" -H "$height" -w "$width" -h "$height") +window=0 +if [ "${BL_DESKTOP_GPU_WINDOW:-1}" != 0 ] && [ -n "${WAYLAND_DISPLAY:-}" ] && [ "$WAYLAND_DISPLAY" != wayland-0 ]; then + window=1 + parent=$WAYLAND_DISPLAY + args=(--backend sdl --expose-wayland -W "$width" -H "$height" -w "$width" -h "$height") +else + args=(--backend wayland --expose-wayland -f -W "$width" -H "$height" -w "$width" -h "$height") +fi if [ "${BL_FPS:-0}" -gt 0 ]; then args+=(-r "$BL_FPS") elif [ "${BL_REFRESH:-0}" -gt 0 ]; then args+=(-r "$BL_REFRESH") fi [ "${BL_HDR:-0}" = 1 ] && args+=(--hdr-enabled) -echo "== droiddeck-gpu $(date -u +%H:%M:%S): $* (gamescope ${width}x${height} on wayland-0)" -export WAYLAND_DISPLAY=wayland-0 +if [ "$window" = 1 ]; then + echo "== droiddeck-gpu $(date -u +%H:%M:%S): $* (gamescope ${width}x${height} in a window on $parent)" +else + echo "== droiddeck-gpu $(date -u +%H:%M:%S): $* (gamescope ${width}x${height} on wayland-0)" + export WAYLAND_DISPLAY=wayland-0 +fi export GDK_BACKEND=x11 QT_QPA_PLATFORM=xcb SDL_VIDEODRIVER=x11 unset LIBGL_ALWAYS_SOFTWARE QT_QUICK_BACKEND KWIN_COMPOSE +wsi=",${MESA_VK_WSI_DEBUG:-}," +while [[ $wsi == *,sw,* ]]; do wsi=${wsi//,sw,/,}; done +wsi=${wsi#,}; wsi=${wsi%,} +if [ -n "$wsi" ]; then export MESA_VK_WSI_DEBUG=$wsi; else unset MESA_VK_WSI_DEBUG; fi +export BL_DESKTOP_GPU_CHILD=1 export MESA_LOADER_DRIVER_OVERRIDE=zink GALLIUM_DRIVER=zink LIBGL_KOPPER_DRI2=true [ -n "${DROIDDECK_GLTHREAD:-}" ] && export mesa_glthread=$DROIDDECK_GLTHREAD export APPIMAGE_EXTRACT_AND_RUN=1 -gamescope "${args[@]}" -- /usr/local/bin/droiddeck-gpu-window "$@" +if [ "$window" = 1 ]; then + export BL_GPU_CHILD_WSI=${MESA_VK_WSI_DEBUG:-} + SDL_VIDEODRIVER=wayland MESA_VK_WSI_DEBUG=sw gamescope "${args[@]}" -- /usr/local/bin/droiddeck-gpu-window "$@" +else + gamescope "${args[@]}" -- /usr/local/bin/droiddeck-gpu-window "$@" +fi rc=$? echo "== droiddeck-gpu $(date -u +%H:%M:%S): exited $rc" exit $rc diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-battlenet b/tools/linuxfs/overlay/usr/local/bin/droiddeck-battlenet index d3f3fd770..cf3e6ae85 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-battlenet +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-battlenet @@ -551,8 +551,17 @@ class Tidy: return False +def desktop_gpu(): + if os.environ.get("BL_DESKTOP") != "1" or os.environ.get("BL_DESKTOP_GPU_CHILD"): + return None + if os.environ.get("BL_DESKTOP_GPU", "on").strip().lower() in ("off", "0", "no", "false"): + return None + gpu = os.path.join(BIN, "droiddeck-gpu") + return gpu if os.access(gpu, os.X_OK) else None + + def proton_options(): - if os.environ.get("BL_DESKTOP") == "1": + if os.environ.get("BL_DESKTOP") == "1" and not os.environ.get("BL_DESKTOP_GPU_CHILD"): return ["--window"] width, height = os.environ.get("BL_WIDTH", ""), os.environ.get("BL_HEIGHT", "") options = ["--desktop", "%sx%s" % (width, height)] if width.isdigit() and height.isdigit() else [] @@ -943,6 +952,10 @@ def main(argv): if action == "status": print(json.dumps(status(root))) return 0 + gpu = desktop_gpu() + if gpu: + say("the desktop starts Battle.net on the GPU") + os.execv(gpu, [gpu, os.path.abspath(sys.argv[0])] + list(sys.argv[1:])) os.environ["BL_BATTLENET"] = "1" if launching: say("launch %s" % argv[1]) diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-gpu-window b/tools/linuxfs/overlay/usr/local/bin/droiddeck-gpu-window index f5cb4007c..0c1c9818f 100755 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-gpu-window +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-gpu-window @@ -45,6 +45,13 @@ def advertise_compositing(): if __name__ == '__main__': if len(sys.argv) < 2: raise SystemExit('usage: droiddeck-gpu-window [args...]') + if 'BL_GPU_CHILD_WSI' in os.environ: + wsi = os.environ.pop('BL_GPU_CHILD_WSI') + if wsi: + os.environ['MESA_VK_WSI_DEBUG'] = wsi + else: + os.environ.pop('MESA_VK_WSI_DEBUG', None) + os.environ['SDL_VIDEODRIVER'] = 'x11' os.environ.setdefault('GTK_CSD', '1') try: connection = advertise_compositing() diff --git a/tools/linuxfs/overlay/usr/local/bin/droiddeck-open b/tools/linuxfs/overlay/usr/local/bin/droiddeck-open index 0809a228f..2fc023e04 100644 --- a/tools/linuxfs/overlay/usr/local/bin/droiddeck-open +++ b/tools/linuxfs/overlay/usr/local/bin/droiddeck-open @@ -9,9 +9,9 @@ Add an app does) when that holds native programs or libraries. A Steam library's droiddeck-open --exec FILE [ARGS...] an exec the kernel refused (libblsession) droiddeck-open --install the Run entries and default handlers -The desktop composites in software, so a program started from it goes full screen on the GPU -(droiddeck-gpu), as the menu's games do: --window keeps it in a desktop window instead, --terminal -runs it in Konsole. A plain script stays on the desktop, and an exec whose output is read (a terminal, +The desktop composites in software, so a program started from it runs on the GPU in a window of its +own (droiddeck-gpu), as the menu's games do: --window keeps it on the desktop's software drawing +instead, --terminal runs it in Konsole. A plain script stays on the desktop, and an exec whose output is read (a terminal, a pipe, a file) stays where it was started. """ import fcntl @@ -337,7 +337,7 @@ def unattended(env): def placed(cmd, what, mode, env): - """[cmd] where it shows: full screen on the GPU from the desktop, else where it was started.""" + """[cmd] where it shows: on the GPU from the desktop, else where it was started.""" if mode == "terminal" and what not in ("windows", "steam") and shutil.which("konsole"): return ["konsole", "--hold", "-e"] + cmd if mode == "window" or what in ("script", "steam") or not on_desktop(env): diff --git a/tools/linuxfs/overlay/usr/local/bin/steam-compatibility b/tools/linuxfs/overlay/usr/local/bin/steam-compatibility index 09dd3dd02..b1864dfad 100755 --- a/tools/linuxfs/overlay/usr/local/bin/steam-compatibility +++ b/tools/linuxfs/overlay/usr/local/bin/steam-compatibility @@ -90,6 +90,34 @@ bl_run() { } """ +BL_DESKTOP_GPU_SETUP = """ +bl_desktop_gpu() { + local name saved gpu=/usr/local/bin/droiddeck-gpu + local names=(LD_PRELOAD LD_LIBRARY_PATH ENABLE_VK_LAYER_VALVE_steam_overlay_1 ENABLE_VK_LAYER_VALVE_steam_fossilize_1) + if [ -n "${BL_DESKTOP_GPU_CHILD:-}" ]; then + for name in "${names[@]}"; do + saved=BL_GPU_SAVED_$name + [ -n "${!saved+x}" ] || continue + export "$name=${!saved}" + unset "$saved" + done + return 0 + fi + [ "${BL_DESKTOP:-}" = 1 ] && [ "${verb:-}" = waitforexitandrun ] && [ -x "$gpu" ] || return 0 + local choice=${BL_DESKTOP_GPU:-on} + case "${choice,,}" in off | 0 | no | false) return 0 ;; esac + case " $* " in *iscriptevaluator*) return 0 ;; esac + local clear=() + for name in "${names[@]}"; do + [ -n "${!name+x}" ] || continue + export "BL_GPU_SAVED_$name=${!name}" + clear+=(-u "$name") + done + echo "droiddeck-gpu: the desktop starts this game on the GPU" >&2 + exec env "${clear[@]}" "$gpu" "$0" "$verb" "$@" +} +bl_desktop_gpu "$@" +""" BL_COMPONENTS_SETUP = """ bl_components() { base=$1 @@ -380,7 +408,7 @@ LAUNCHER_TEMPLATE = LAUNCHER_SH def launcher_sh(sources=SOURCES): return (LAUNCHER_TEMPLATE % " ".join('"%s"' % n for n in sources)).replace( - "verb=$1; shift", "verb=$1; shift\n" + BL_DIRECTAUDIO_SETUP + BL_GAME_CPUS_SETUP + BL_IDTECH3_SETUP + "verb=$1; shift", "verb=$1; shift\n" + BL_DESKTOP_GPU_SETUP + BL_DIRECTAUDIO_SETUP + BL_GAME_CPUS_SETUP + BL_IDTECH3_SETUP + BL_VACDIAG_SETUP + BL_COMPONENTS_SETUP + BL_LIBPATH_SETUP + BL_STORE_SETUP, 1) @@ -469,7 +497,7 @@ verb=$1; shift case $verb in getcompatpath | getnativepath) printf '%s\\n' "$1"; exit 0 ;; esac -""" + BL_GAME_CPUS_SETUP + """ +""" + BL_DESKTOP_GPU_SETUP + BL_GAME_CPUS_SETUP + """ bl_game_cpus if [ -x /usr/local/bin/droiddeck-steamvr-flat ] && /usr/local/bin/droiddeck-steamvr-flat "$verb"; then exec /usr/local/bin/droiddeck-steamvr-game ${BL_TASKSET:-} /usr/local/bin/droiddeck-fex steam "$verb" "$@" @@ -652,7 +680,7 @@ def adopt_extras(tools): try: body = (EXTRA_WRAPPER_SH % entry_point).replace( 'here=$(dirname "$0")', - 'here=$(dirname "$0")\n' + BL_DIRECTAUDIO_SETUP + BL_GAME_CPUS_SETUP + BL_IDTECH3_SETUP + 'here=$(dirname "$0")\n' + BL_DESKTOP_GPU_SETUP + BL_DIRECTAUDIO_SETUP + BL_GAME_CPUS_SETUP + BL_IDTECH3_SETUP + BL_VACDIAG_SETUP + BL_COMPONENTS_SETUP + BL_LIBPATH_SETUP + BL_STORE_SETUP, 1) write_changed(wrapper, body, 0o755) write_changed(manifest, EXTRA_MANIFEST_VDF) diff --git a/tools/tests/test_battlenet.py b/tools/tests/test_battlenet.py index fe5aed720..2a953dfe7 100644 --- a/tools/tests/test_battlenet.py +++ b/tools/tests/test_battlenet.py @@ -947,6 +947,33 @@ class LaunchTest(Harness): os.environ["SteamGameId"] = "0" self.assertEqual(BNET["proton_options"](), []) + def test_on_the_desktop_battle_net_restarts_on_the_gpu_unless_turned_off(self): + with tempfile.TemporaryDirectory() as tmp: + gpu = os.path.join(tmp, "droiddeck-gpu") + with open(gpu, "w") as out: + out.write("#!/bin/sh\n") + os.chmod(gpu, 0o755) + with mock.patch.dict(BNET, {"BIN": tmp}), mock.patch.dict(os.environ, {"BL_DESKTOP": "1"}): + os.environ.pop("BL_DESKTOP_GPU", None) + os.environ.pop("BL_DESKTOP_GPU_CHILD", None) + self.assertEqual(BNET["desktop_gpu"](), gpu) + for choice in ("off", "0", "No", "false"): + os.environ["BL_DESKTOP_GPU"] = choice + self.assertIsNone(BNET["desktop_gpu"]()) + os.environ["BL_DESKTOP_GPU"] = "on" + os.environ["BL_DESKTOP_GPU_CHILD"] = "1" + self.assertIsNone(BNET["desktop_gpu"]()) + os.environ.pop("BL_DESKTOP_GPU_CHILD") + os.environ["BL_DESKTOP"] = "0" + self.assertIsNone(BNET["desktop_gpu"]()) + os.environ["BL_DESKTOP"] = "1" + os.chmod(gpu, 0o644) + self.assertIsNone(BNET["desktop_gpu"]()) + + def test_on_the_gpu_battle_net_fills_the_screen_instead_of_a_window(self): + with mock.patch.dict(os.environ, {"BL_DESKTOP": "1", "BL_DESKTOP_GPU_CHILD": "1", "BL_WIDTH": "1280", "BL_HEIGHT": "720", "SteamGameId": "0"}): + self.assertEqual(BNET["proton_options"](), ["--desktop", "1280x720"]) + def test_under_gamescope_battle_net_gets_a_desktop_of_the_screens_size(self): with mock.patch.dict(os.environ, {"BL_WIDTH": "1280", "BL_HEIGHT": "720", "SteamGameId": "0"}): os.environ.pop("BL_DESKTOP", None) diff --git a/tools/tests/test_desktop_gpu_window.py b/tools/tests/test_desktop_gpu_window.py new file mode 100644 index 000000000..ba3bfc549 --- /dev/null +++ b/tools/tests/test_desktop_gpu_window.py @@ -0,0 +1,74 @@ +import json +import os +from pathlib import Path +import shutil +import subprocess +import sys +import tempfile +import unittest + +TOOLS = Path(__file__).resolve().parents[1] +GPU = TOOLS / "linuxfs/desktop/droiddeck-gpu" +WINDOW = TOOLS / "linuxfs/overlay/usr/local/bin/droiddeck-gpu-window" +KEYS = ("MESA_VK_WSI_DEBUG", "SDL_VIDEODRIVER", "WAYLAND_DISPLAY", "BL_GPU_CHILD_WSI", "BL_DESKTOP_GPU_CHILD") + + +class DesktopGpuWindowTest(unittest.TestCase): + def setUp(self): + self.tmp = Path(tempfile.mkdtemp()) + self.addCleanup(shutil.rmtree, self.tmp, True) + self.out = self.tmp / "gamescope.json" + fake = self.tmp / "gamescope" + fake.write_text("#!%s\nimport json, os, sys\njson.dump({'args': sys.argv[1:], 'env': {k: os.environ.get(k) for k in %r}}, open(%r, 'w'))\n" + % (sys.executable, KEYS, str(self.out))) + fake.chmod(0o755) + + def run_gpu(self, **env): + base = {k: v for k, v in os.environ.items() if k not in KEYS + ("BL_DEBUG_DIR", "BL_DESKTOP_GPU_WINDOW")} + base.update(PATH="%s:%s" % (self.tmp, os.environ["PATH"]), BL_WIDTH="1280", BL_HEIGHT="720", **env) + subprocess.run(["bash", str(GPU), "game.exe"], env=base, check=True, capture_output=True) + return json.loads(self.out.read_text()) + + def test_on_the_desktop_the_game_gets_a_window_of_its_own(self): + run = self.run_gpu(WAYLAND_DISPLAY="wayland-1", MESA_VK_WSI_DEBUG="sw,linear") + self.assertEqual(run["args"][:2], ["--backend", "sdl"]) + self.assertNotIn("-f", run["args"]) + self.assertEqual(run["args"][-2:], ["/usr/local/bin/droiddeck-gpu-window", "game.exe"]) + self.assertEqual(run["env"]["WAYLAND_DISPLAY"], "wayland-1") + self.assertEqual(run["env"]["SDL_VIDEODRIVER"], "wayland") + self.assertEqual(run["env"]["MESA_VK_WSI_DEBUG"], "sw") + self.assertEqual(run["env"]["BL_GPU_CHILD_WSI"], "linear") + self.assertEqual(run["env"]["BL_DESKTOP_GPU_CHILD"], "1") + + def test_full_screen_stays_available(self): + for env in ({"WAYLAND_DISPLAY": "wayland-1", "BL_DESKTOP_GPU_WINDOW": "0"}, {"WAYLAND_DISPLAY": "wayland-0"}, {}): + run = self.run_gpu(**env) + self.assertEqual(run["args"][:2], ["--backend", "wayland"]) + self.assertIn("-f", run["args"]) + self.assertEqual(run["env"]["WAYLAND_DISPLAY"], "wayland-0") + self.assertIsNone(run["env"]["MESA_VK_WSI_DEBUG"]) + self.assertIsNone(run["env"]["BL_GPU_CHILD_WSI"]) + + def test_the_game_inside_the_window_gets_its_own_settings_back(self): + script = "import json, os; print(json.dumps({k: os.environ.get(k) for k in %r}))" % (KEYS,) + for saved, expected in (("linear", "linear"), ("", None)): + env = {k: v for k, v in os.environ.items() if k not in KEYS + ("DISPLAY",)} + env.update(BL_GPU_CHILD_WSI=saved, MESA_VK_WSI_DEBUG="sw", SDL_VIDEODRIVER="wayland") + out = subprocess.run([sys.executable, str(WINDOW), sys.executable, "-c", script], env=env, + check=True, capture_output=True, text=True).stdout + child = json.loads(out) + self.assertEqual(child["MESA_VK_WSI_DEBUG"], expected) + self.assertEqual(child["SDL_VIDEODRIVER"], "x11") + self.assertIsNone(child["BL_GPU_CHILD_WSI"]) + + def test_outside_a_window_the_game_keeps_its_settings(self): + script = "import os; print(os.environ.get('MESA_VK_WSI_DEBUG'), os.environ.get('SDL_VIDEODRIVER'))" + env = {k: v for k, v in os.environ.items() if k not in KEYS + ("DISPLAY",)} + env.update(MESA_VK_WSI_DEBUG="linear", SDL_VIDEODRIVER="x11") + out = subprocess.run([sys.executable, str(WINDOW), sys.executable, "-c", script], env=env, + check=True, capture_output=True, text=True).stdout.split() + self.assertEqual(out, ["linear", "x11"]) + + +if __name__ == "__main__": + unittest.main() diff --git a/tools/tests/test_game_environment.py b/tools/tests/test_game_environment.py index 3895ebc69..ae7c2b95d 100644 --- a/tools/tests/test_game_environment.py +++ b/tools/tests/test_game_environment.py @@ -77,6 +77,35 @@ class GameEnvironmentTest(unittest.TestCase): env=env, text=True, capture_output=True, check=True) self.assertEqual(result.stdout.strip(), expected) + def test_desktop_games_restart_on_the_gpu_with_steams_preloads_handed_back(self): + with tempfile.TemporaryDirectory() as tmp: + home = Path(tmp) + gpu = home / "gpu" + gpu.write_text("#!/bin/bash\necho \"gpu LD_PRELOAD=${LD_PRELOAD-unset}\"\nexport BL_DESKTOP_GPU_CHILD=1\nexec \"$@\"\n") + gpu.chmod(0o755) + launcher = home / "launcher" + setup = COMPAT["BL_DESKTOP_GPU_SETUP"].replace("/usr/local/bin/droiddeck-gpu", str(gpu)) + launcher.write_text("#!/bin/bash\nverb=$1; shift\n" + setup + "echo \"game $verb $* LD_PRELOAD=${LD_PRELOAD-unset} saved=${BL_GPU_SAVED_LD_PRELOAD-unset}\"\n") + launcher.chmod(0o755) + base = {key: value for key, value in os.environ.items() if not key.startswith("BL_")} + base["LD_PRELOAD"] = "overlay.so" + for extra, args, expected in ( + ({"BL_DESKTOP": "1"}, ["waitforexitandrun", "game.exe"], + ["gpu LD_PRELOAD=unset", "game waitforexitandrun game.exe LD_PRELOAD=overlay.so saved=unset"]), + ({"BL_DESKTOP": "1", "BL_DESKTOP_GPU": "Off"}, ["waitforexitandrun", "game.exe"], + ["game waitforexitandrun game.exe LD_PRELOAD=overlay.so saved=unset"]), + ({"BL_DESKTOP": "1"}, ["run", "setup.exe"], + ["game run setup.exe LD_PRELOAD=overlay.so saved=unset"]), + ({"BL_DESKTOP": "1"}, ["waitforexitandrun", "iscriptevaluator.exe"], + ["game waitforexitandrun iscriptevaluator.exe LD_PRELOAD=overlay.so saved=unset"]), + ({}, ["waitforexitandrun", "game.exe"], + ["game waitforexitandrun game.exe LD_PRELOAD=overlay.so saved=unset"]), + ): + with self.subTest(extra=extra, args=args): + result = subprocess.run([str(launcher)] + args, env=dict(base, **extra), + text=True, capture_output=True, check=True) + self.assertEqual(result.stdout.splitlines(), expected) + def test_the_install_script_evaluator_gets_its_scripts_marked_first(self): with tempfile.TemporaryDirectory() as tmp: root = Path(tmp)