mirror of
https://github.com/Droid-Deck/DroidDeck.git
synced 2026-11-21 05:46:03 +00:00
fix: keep FEX's TSO on for Unity games (#1415)
The default FEX preset (Performance + TSO) is fine for Unity. But when the Default profile is switched to a preset that turns TSO off (Performance, Extreme, Extreme-gn, Denuvo), Unity players break. DroidDeck already keeps full TSO for .NET games (`coreclr.dll`) whatever the preset; this gives Unity players the same safety net for TSO. Tested on a Pixel 10 Pro Fold (PowerVR DXT-48-1536), shared preset Performance (TSO off): | Game | Build | TSO off | TSO on | | --- | --- | --- | --- | | Megabonk | Unity 2023.2 IL2CPP, native Linux, "Linux x86 (FEX)" | froze on about half of launches (every thread parked on a futex) | 5 of 5 starts, played run stayed responsive | | Crab Game | Unity IL2CPP, Windows, Proton arm64 | 9 of 10 starts; 1 access violation in `UnityPlayer.dll` (read of a garbage pointer) | 10 of 10 starts | Measured cost of TSO on Megabonk: none (+2% fps with TSO on, within noise). What changes: - `droiddeck-game-env`: `unity_memory_ordering` sets `FEX_TSOENABLED=1` when `UnityPlayer.dll`, `UnityPlayer.so` or `GameAssembly.so` sits next to the executable (or one folder below). A FEX preset chosen for the game still wins (fixes sit between the shared preset and the per-game entry, as for .NET). - `droiddeck-fex`: the FEX tool now applies the environment half of these game-file fixes, so native Linux Unity builds get it too. Launch arguments some fixes add stay Proton-only. - Docs paragraph in `docs/development/game-environment.md`; tests in `test_game_environment.py` and `test_droiddeck_fex.py`. Device check of the change itself: with the session's `droiddeck-game-env` patched, shared TSO off and no per-game entry, Crab Game started with `FEX_TSOENABLED=1`. Related to #1386, but not a fix for its Risk of Rain 2 crash: that game is Unity Mono, which with the default preset already has TSO on; the report points at multiblock instead (as the .NET fix turns off). Both games tested here are IL2CPP, so this PR doesn't change multiblock. #1386's other points (`steam_appid.txt`, `device.txt`) aren't covered. Tests (WSL, on main `16bedf36` with the patch): `test_game_environment` + `test_droiddeck_fex` 119 OK. Full `tools/tests`: 1114 tests, one failure, `test_appimage_run…test_a_failed_program_shows_the_log_it_wrote`, which fails the same way without the patch.
This commit is contained in:
5 files changed
+78
-4
No files matched your search
@@ -672,15 +672,27 @@ def launch(command, env, mode, decide=None):
|
||||
return os.execve(fex["bin"], [fex["bin"], program] + command[1:], guest)
|
||||
|
||||
|
||||
def game_environment(env):
|
||||
def game_environment(env, command):
|
||||
try:
|
||||
game_env = runpy.run_path(os.path.join(BIN_DIR, "droiddeck-game-env"))
|
||||
env = game_env["game_gpu"](env)
|
||||
app = game_env["game_id"](env) or env.get("SteamAppId") or env.get("SteamGameId")
|
||||
if not app:
|
||||
return env
|
||||
with open(GAME_ENVIRONMENT, encoding="utf-8") as source:
|
||||
return game_env["apply_config"](env, json.load(source), str(app))
|
||||
fixes = {}
|
||||
game = game_env["Game"](resolve(command[0], env), command[1:])
|
||||
for check in game_env["FIXES"]:
|
||||
found = check(game)
|
||||
# Environment fixes only: the launch arguments some fixes add were chosen for Windows builds.
|
||||
if found and found[0]:
|
||||
fixes.update(found[0])
|
||||
say(found[2])
|
||||
try:
|
||||
with open(GAME_ENVIRONMENT, encoding="utf-8") as source:
|
||||
config = json.load(source)
|
||||
except FileNotFoundError:
|
||||
config = {"version": 1}
|
||||
return game_env["apply_config"](env, config, str(app), fixes)
|
||||
except FileNotFoundError:
|
||||
return env
|
||||
except Exception as error:
|
||||
@@ -811,7 +823,7 @@ def main(argv):
|
||||
return 0
|
||||
if not command:
|
||||
return 2
|
||||
return launch(command, game_environment(dict(os.environ)), os.environ.get("DROIDDECK_FEX", "auto"))
|
||||
return launch(command, game_environment(dict(os.environ), command), os.environ.get("DROIDDECK_FEX", "auto"))
|
||||
if action == "run":
|
||||
try:
|
||||
mode, decide, command = parse_run(args)
|
||||
|
||||
@@ -87,6 +87,15 @@ def dotnet_memory_ordering(game):
|
||||
return DOTNET_FEX, [], ".NET runtime: FEX with full TSO and without multiblock"
|
||||
|
||||
|
||||
@fix
|
||||
def unity_memory_ordering(game):
|
||||
"""A Unity player under FEX without TSO deadlocks or crashes: Megabonk (Linux, IL2CPP) froze with every
|
||||
thread parked on a futex on about half of all launches, Crab Game (Windows under Proton, IL2CPP) died with
|
||||
an access violation in UnityPlayer.dll. Presets that turn TSO off keep it on for Unity games."""
|
||||
if {"unityplayer.so", "gameassembly.so", "unityplayer.dll"} & game.files:
|
||||
return {"FEX_TSOENABLED": "1"}, [], "Unity: FEX with TSO"
|
||||
|
||||
|
||||
@fix
|
||||
def godot_vulkan(game):
|
||||
if is_godot(game) and not game.has_arg("--rendering-driver"):
|
||||
|
||||
@@ -691,6 +691,32 @@ class LaunchTest(FexTestCase):
|
||||
command, env, mode = G["launch"].call_args[0]
|
||||
self.assertEqual((command, mode), (["/game/run.sh", "-a"], "auto"))
|
||||
|
||||
def test_steam_games_get_their_settings_and_linux_unity_keeps_tso(self):
|
||||
config = self.home / ".config/droiddeck/game-environment.json"
|
||||
unity = self.write(self.tmp / "Megabonk/Megabonk.x86_64", elf(62), 0o755)
|
||||
self.write(self.tmp / "Megabonk/UnityPlayer.so", elf(62))
|
||||
self.write(self.tmp / "Megabonk/GameAssembly.so", elf(62))
|
||||
other = self.write(self.tmp / "Other/game.x86_64", elf(62), 0o755)
|
||||
self.write(config, json.dumps({"version": 1, "shared": {"FEX_TSOENABLED": "0", "FEX_MULTIBLOCK": "1"},
|
||||
"games": {"20": {"FEX_TSOENABLED": "0"}}}))
|
||||
|
||||
def started(program, app):
|
||||
with mock.patch.dict(G, {"launch": mock.Mock(return_value=0), "GAME_ENVIRONMENT": str(config)}), \
|
||||
mock.patch.dict(os.environ, {"SteamAppId": app}, clear=True):
|
||||
_, said = self.quiet(FEX["main"], ["steam", "waitforexitandrun", str(program), "-arg"])
|
||||
command, env, _ = G["launch"].call_args[0]
|
||||
self.assertEqual(command, [str(program), "-arg"])
|
||||
return env.get("FEX_TSOENABLED"), env.get("FEX_MULTIBLOCK"), said
|
||||
|
||||
tso, multiblock, said = started(unity, "10")
|
||||
self.assertEqual((tso, multiblock), ("1", "1"))
|
||||
self.assertIn("Unity: FEX with TSO", said)
|
||||
self.assertEqual(started(other, "10")[:2], ("0", "1"))
|
||||
self.assertEqual(started(unity, "20")[:2], ("0", "1"))
|
||||
config.unlink()
|
||||
self.assertEqual(started(unity, "10")[:2], ("1", None))
|
||||
self.assertEqual(started(other, "10")[:2], (None, None))
|
||||
|
||||
|
||||
class AppInfoTest(unittest.TestCase):
|
||||
COMPAT = runpy.run_path(str(BIN / "steam-compatibility"))
|
||||
|
||||
@@ -357,6 +357,27 @@ class GameEnvironmentTest(unittest.TestCase):
|
||||
(asylum / name).touch()
|
||||
self.assertEqual(MODULE["engine_fixes"](str(asylum / "BmLauncher.exe"), []), ({}, [], []))
|
||||
|
||||
def test_unity_players_keep_tso_over_the_preset(self):
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
def game(*names):
|
||||
for name in names:
|
||||
(Path(tmp) / name).parent.mkdir(parents=True, exist_ok=True)
|
||||
(Path(tmp) / name).touch()
|
||||
return str(Path(tmp) / names[0])
|
||||
|
||||
il2cpp = game("Megabonk/Megabonk.x86_64", "Megabonk/UnityPlayer.so", "Megabonk/GameAssembly.so")
|
||||
mono = game("Mono/Game.x86_64", "Mono/UnityPlayer.so")
|
||||
windows = game("Crab Game/Crab Game.exe", "Crab Game/UnityPlayer.dll", "Crab Game/GameAssembly.dll")
|
||||
windows_mono = game("RoR2/Risk of Rain 2.exe", "RoR2/UnityPlayer.dll", "RoR2/MonoBleedingEdge/mono-2.0-bdwgc.dll")
|
||||
for exe in (il2cpp, mono, windows, windows_mono):
|
||||
env, extra, notes = MODULE["engine_fixes"](exe, [])
|
||||
self.assertEqual((env, extra, notes), ({"FEX_TSOENABLED": "1"}, [], ["Unity: FEX with TSO"]))
|
||||
performance = {"version": 1, "shared": {"FEX_TSOENABLED": "0", "FEX_VECTORTSOENABLED": "0"}}
|
||||
result = MODULE["apply_config"]({}, performance, "3405340", env)
|
||||
self.assertEqual((result["FEX_TSOENABLED"], result["FEX_VECTORTSOENABLED"]), ("1", "0"))
|
||||
performance["games"] = {"3405340": {"FEX_TSOENABLED": "0"}}
|
||||
self.assertEqual(MODULE["apply_config"]({}, performance, "3405340", env)["FEX_TSOENABLED"], "0")
|
||||
|
||||
def test_a_new_fix_only_needs_registering(self):
|
||||
with tempfile.TemporaryDirectory() as tmp:
|
||||
(Path(tmp) / "Game.exe").touch()
|
||||
|
||||
Reference in new issue
Block a user