Yucom/proton

425 lines
14 KiB
Text
Raw Normal View History

#!/usr/bin/python2.7
2018-01-18 21:00:48 +01:00
#script to launch Wine with the correct environment
import filecmp
2018-01-18 21:00:48 +01:00
import json
import os
import shutil
import struct
2018-01-18 21:00:48 +01:00
import subprocess
import sys
import tarfile
2018-01-18 21:00:48 +01:00
from filelock import FileLock, Timeout
#WITH_WINEDEBUG="+timestamp,+pid,+tid,+seh"
2018-04-30 16:02:22 +02:00
CURRENT_PREFIX_VERSION="3.7-1"
2018-01-18 21:00:48 +01:00
PFX="Proton: "
2018-03-06 19:13:24 +01:00
if "Darwin" in os.uname()[0]:
ld_path_var = "DYLD_LIBRARY_PATH"
else:
ld_path_var = "LD_LIBRARY_PATH"
2018-01-18 21:00:48 +01:00
def log(msg):
sys.stderr.write(PFX + msg + os.linesep)
sys.stderr.flush()
def upgrade_pfx(old_ver):
if old_ver == CURRENT_PREFIX_VERSION:
return
2018-04-20 17:11:19 +02:00
log("Upgrading prefix from " + str(old_ver) + " to " + CURRENT_PREFIX_VERSION + " (" + os.environ["STEAM_COMPAT_DATA_PATH"] + ")")
#nothing to do, yet
2018-01-18 21:00:48 +01:00
def run_wine(args):
subprocess.call(args, env=env, stderr=lfile)
def makedirs(path):
try:
os.makedirs(path)
except:
#already exists
pass
2018-01-18 21:00:48 +01:00
if not ("STEAM_COMPAT_DATA_PATH" in os.environ):
log("No compat data path?")
sys.exit(1)
if "STEAM_COMPAT_CONFIG" in os.environ:
2018-02-09 18:03:59 +01:00
config_opts = os.environ["STEAM_COMPAT_CONFIG"].split(",")
else:
config_opts = []
if "PROTON_USE_DXVK" in os.environ:
config_opts.append("dxvk")
2018-03-28 17:27:56 +02:00
if "PROTON_NO_D3D11" in os.environ:
config_opts.append("nod3d11")
basedir = os.path.dirname(sys.argv[0])
bindir = basedir + "/dist/bin/"
2018-02-14 20:59:35 +01:00
libdir = basedir + "/dist/lib"
lib64dir = basedir + "/dist/lib64"
2018-01-18 21:00:48 +01:00
wine_path = bindir + "/wine64"
#extract if needed
dist_lock = FileLock(basedir + "/dist.lock", timeout=-1)
with dist_lock:
if not os.path.exists(basedir + "/dist") or \
not os.path.exists(basedir + "/dist/version") or \
not filecmp.cmp(basedir + "/version", basedir + "/dist/version"):
if os.path.exists(basedir + "/dist"):
shutil.rmtree(basedir + "/dist")
tar = tarfile.open(basedir + "/proton_dist.tar.gz", mode="r:gz")
tar.extractall(path=basedir + "/dist")
tar.close()
shutil.copy(basedir + "/version", basedir + "/dist/")
2018-01-18 21:00:48 +01:00
env = dict(os.environ)
2018-03-28 17:27:56 +02:00
dlloverrides = {}
2018-01-18 21:00:48 +01:00
try:
env["WINEDEBUG"] = WITH_WINEDEBUG
lfile_path = os.environ["HOME"] + "/steam-" + os.environ["SteamGameId"] + ".log"
if os.path.exists(lfile_path):
os.remove(lfile_path)
lfile = open(lfile_path, "w+")
except (NameError, KeyError): #WITH_WINEDEBUG is unset, or SteamGameId is unset
env["WINEDEBUG"] = "-all"
lfile = None
2018-01-18 21:00:48 +01:00
2018-03-06 19:13:24 +01:00
if ld_path_var in os.environ:
env[ld_path_var] = lib64dir + ":" + libdir + ":" + os.environ[ld_path_var]
2018-01-18 21:00:48 +01:00
else:
2018-03-06 19:13:24 +01:00
env[ld_path_var] = lib64dir + ":" + libdir
2018-02-14 20:59:35 +01:00
env["WINEDLLPATH"] = lib64dir + "/wine:" + libdir + "/wine"
if "PATH" in os.environ:
env["PATH"] = bindir + ":" + os.environ["PATH"]
2018-02-14 20:59:35 +01:00
else:
env["PATH"] = bindir
2018-01-18 21:00:48 +01:00
with dist_lock:
if not os.path.isdir(basedir + "/dist/share/default_pfx"):
#make default prefix
env["WINEPREFIX"] = basedir + "/dist/share/default_pfx"
run_wine([wine_path, "wineboot"])
run_wine([bindir + "/wineserver", "-w"])
prefix = os.environ["STEAM_COMPAT_DATA_PATH"] + "/pfx/"
env["WINEPREFIX"] = prefix
2018-01-18 21:00:48 +01:00
2018-03-16 16:39:04 +01:00
prefix_lock = FileLock(os.environ["STEAM_COMPAT_DATA_PATH"] + "/pfx.lock", timeout=-1)
with prefix_lock:
if not os.path.isdir(prefix):
#copy default prefix into place
shutil.copytree(basedir + "/dist/share/default_pfx", prefix, symlinks=True)
version_file = os.environ["STEAM_COMPAT_DATA_PATH"] + "/version"
if os.path.exists(version_file):
with open(version_file, "r") as f:
upgrade_pfx(f.readline().strip())
else:
upgrade_pfx(None)
with open(version_file, "w") as f:
f.write(CURRENT_PREFIX_VERSION + "\n")
#copy steam files into place
if "STEAM_COMPAT_CLIENT_INSTALL_PATH" in os.environ:
#modern steam client sets this
steamdir = os.environ["STEAM_COMPAT_CLIENT_INSTALL_PATH"]
elif "STEAM_CLIENT_CONFIG_FILE" in os.environ:
#fallback for old steam clients (should remove once changes graduate)
steamdir = os.path.dirname(os.environ["STEAM_CLIENT_CONFIG_FILE"])
else:
#linux-only fallback, really shouldn't get here
steamdir = os.environ["HOME"] + ".steam/root/"
dst = prefix + "/drive_c/Program Files (x86)/"
makedirs(dst + "Steam")
filestocopy = ["steamclient.dll",
"steamclient64.dll",
"Steam.dll"]
for f in filestocopy:
if os.path.isfile(steamdir + "/legacycompat/" + f):
dstfile = dst + "Steam/" + f
if os.path.isfile(dstfile):
os.remove(dstfile)
shutil.copy(steamdir + "/legacycompat/" + f, dstfile)
#copy openvr files into place
dst = prefix + "/drive_c/vrclient/bin/"
makedirs(dst)
shutil.copy(basedir + "/dist/lib/wine/fakedlls/vrclient.dll", dst)
shutil.copy(basedir + "/dist/lib64/wine/fakedlls/vrclient_x64.dll", dst)
#parse linux openvr config and present it in win32 format to the app.
#logic from openvr's CVRPathRegistry_Public::GetPaths
#check environment for overrides
vr_runtime = None
if "VR_OVERRIDE" in env:
vr_runtime = env["VR_OVERRIDE"]
env.pop("VR_OVERRIDE")
vr_config = None
if "VR_CONFIG_PATH" in env:
vr_config = env["VR_CONFIG_PATH"]
env.pop("VR_CONFIG_PATH")
vr_log = None
if "VR_LOG_PATH" in env:
vr_log = env["VR_LOG_PATH"]
env.pop("VR_LOG_PATH")
#load from json if needed
if vr_runtime is None or \
vr_config is None or \
vr_log is None:
try:
#TODO: support mac
if "XDG_CONFIG_HOME" in os.environ:
path = os.environ["XDG_CONFIG_HOME"]
else:
path = os.environ["HOME"] + "/.config"
path = path + "/openvr/openvrpaths.vrpath"
j = json.load(open(path, "r"))
if vr_runtime is None:
vr_runtime = j["runtime"][0]
if vr_config is None:
vr_config = j["config"][0]
if vr_log is None:
vr_log = j["log"][0]
except:
pass
makedirs(prefix + "/drive_c/users/steamuser/Local Settings/Application Data/openvr")
#remove existing file
vrpaths_name = prefix + "/drive_c/users/steamuser/Local Settings/Application Data/openvr/openvrpaths.vrpath"
if os.path.exists(vrpaths_name):
os.remove(vrpaths_name)
#dump new file
if not vr_runtime is None:
try:
env["PROTON_VR_RUNTIME"] = vr_runtime
j = { "runtime": [ "C:\\vrclient\\", "C:\\vrclient" ] }
if not vr_config is None:
win_vr_config = subprocess.check_output([wine_path, "winepath", "-w", vr_config], env=env, stderr=lfile)
j["config"] = [ win_vr_config.strip() ]
if not vr_log is None:
win_vr_log = subprocess.check_output([wine_path, "winepath", "-w", vr_log], env=env, stderr=lfile)
j["log"] = [ win_vr_log.strip() ]
j["version"] = 1
j["jsonid"] = "vrpathreg"
json.dump(j, open(vrpaths_name, "w"), indent=2)
except:
pass
def make_dxvk_links(dll_dir, link_dir):
if os.path.lexists(link_dir + "/d3d11.dll"):
os.remove(link_dir + "/d3d11.dll")
if os.path.lexists(link_dir + "/dxgi.dll"):
os.remove(link_dir + "/dxgi.dll")
os.symlink(dll_dir + "/d3d11.dll", link_dir + "/d3d11.dll")
os.symlink(dll_dir + "/dxgi.dll", link_dir + "/dxgi.dll")
if "dxvk" in config_opts:
make_dxvk_links(basedir + "/dist/lib64/wine/dxvk/",
prefix + "drive_c/windows/system32")
make_dxvk_links(basedir + "/dist/lib/wine/dxvk/",
prefix + "drive_c/windows/syswow64")
2018-03-28 17:27:56 +02:00
dlloverrides["dxgi"] = "n"
dlloverrides["d3d11"] = "n"
2018-03-16 16:39:04 +01:00
else:
make_dxvk_links(basedir + "/dist/lib64/wine/",
prefix + "drive_c/windows/system32")
make_dxvk_links(basedir + "/dist/lib/wine/",
prefix + "drive_c/windows/syswow64")
2018-02-09 18:03:59 +01:00
2018-03-28 17:27:56 +02:00
if "nod3d11" in config_opts:
dlloverrides["d3d11"] = ""
if "dxgi" in dlloverrides:
del dlloverrides["dxgi"]
s = ""
for dll, setting in dlloverrides.iteritems():
if len(s) > 0:
s = s + ";" + dll + "=" + setting
else:
s = dll + "=" + setting
env["WINEDLLOVERRIDES"] = s
ARCH_UNKNOWN=0
ARCH_I386=1
ARCH_X86_64=2
def determine_architecture(path):
#algorithm from file's msdos magic file
try:
with open(path, "rb") as f:
magic = f.read(2)
if magic != "MZ":
return ARCH_UNKNOWN
f.seek(0x18)
reloc = struct.unpack('<H', f.read(2))[0]
if reloc < 0x40:
#DOS
return ARCH_I386
f.seek(0x3c)
pe_offs = struct.unpack('<L', f.read(4))[0]
f.seek(pe_offs)
magic = f.read(4)
if magic != "PE\0\0":
return ARCH_UNKNOWN
f.seek(pe_offs + 4)
arch = struct.unpack('<H', f.read(2))[0]
if arch == 0x8664:
return ARCH_X86_64
if arch == 0x014c:
return ARCH_I386
return ARCH_UNKNOWN
except:
return ARCH_UNKNOWN
game_arch = determine_architecture(sys.argv[2])
2018-03-14 19:58:11 +01:00
def dump_dbg_env(f):
f.write("PATH=\"" + env["PATH"] + "\" \\\n")
2018-03-14 19:58:11 +01:00
f.write("\tTERM=\"xterm\" \\\n") #XXX
f.write("\tWINEDEBUG=\"-all\" \\\n")
f.write("\tWINEDLLPATH=\"" + env["WINEDLLPATH"] + "\" \\\n")
2018-03-06 19:13:24 +01:00
f.write("\t" + ld_path_var + "=\"" + env[ld_path_var] + "\" \\\n")
f.write("\tWINEPREFIX=\"" + env["WINEPREFIX"] + "\" \\\n")
if "SteamGameId" in env:
f.write("\tSteamGameId=\"" + env["SteamGameId"] + "\" \\\n")
if "SteamAppId" in env:
f.write("\tSteamAppId=\"" + env["SteamAppId"] + "\" \\\n")
if "PROTON_VR_RUNTIME" in env:
f.write("\tPROTON_VR_RUNTIME=\"" + env["PROTON_VR_RUNTIME"] + "\" \\\n")
if "WINEDLLOVERRIDES" in env:
f.write("\tWINEDLLOVERRIDES=\"" + env["WINEDLLOVERRIDES"] + "\" \\\n")
2018-03-14 19:58:11 +01:00
def dump_dbg_scripts():
if game_arch == ARCH_X86_64:
2018-03-14 19:58:11 +01:00
wine_name = "\"" + bindir + "wine64\""
else:
2018-03-14 19:58:11 +01:00
wine_name = "\"" + bindir + "wine\""
exe_name = os.path.basename(sys.argv[2])
with open("/tmp/proton_winedbg", "w") as f:
f.write("#!/bin/bash\n")
f.write("#Run winedbg with args\n\n")
f.write("cd \"" + os.getcwd() + "\"\n")
dump_dbg_env(f)
f.write("\t" + wine_name + " winedbg \"$@\"\n")
os.chmod("/tmp/proton_winedbg", 0755)
with open("/tmp/proton_winedbg_run", "w") as f:
f.write("#!/bin/bash\n")
f.write("#Run winedbg and prepare to run game or given program\n\n")
f.write("cd \"" + os.getcwd() + "\"\n")
f.write("DEF_CMD=(")
first = True
for arg in sys.argv[2:]:
if first:
f.write("\"" + arg + "\"")
first = False
else:
f.write(" \"" + arg + "\"")
f.write(")\n")
dump_dbg_env(f)
f.write("\t" + wine_name + " winedbg \"${@:-${DEF_CMD[@]}}\"\n")
os.chmod("/tmp/proton_winedbg_run", 0755)
with open("/tmp/proton_gdb_attach", "w") as f:
f.write("#!/bin/bash\n")
f.write("#Run winedbg in gdb mode and auto-attach to already-running program\n\n")
f.write("cd \"" + os.getcwd() + "\"\n")
f.write("EXE_NAME=${1:-\"" + exe_name + "\"}\n")
f.write("WPID_HEX=$(/tmp/proton_winedbg --command 'info process' | grep -i \"$EXE_NAME\" | cut -f2 -d' ' | tr -d '0')\n")
f.write("if [ -z \"$WPID_HEX\" ]; then \n")
f.write(" echo \"Program does not appear to be running: \\\"$EXE_NAME\\\"\"\n")
f.write(" exit 1\n")
f.write("fi\n")
f.write("WPID_DEC=$(printf %d 0x$WPID_HEX)\n")
dump_dbg_env(f)
f.write("\t" + wine_name + " winedbg --gdb $WPID_DEC\n")
os.chmod("/tmp/proton_gdb_attach", 0755)
with open("/tmp/proton_gdb_run", "w") as f:
f.write("#!/bin/bash\n")
f.write("#Run winedbg in gdb mode and prepare to run game or given program\n\n")
f.write("cd \"" + os.getcwd() + "\"\n")
f.write("DEF_CMD=(")
first = True
for arg in sys.argv[2:]:
if first:
f.write("\"" + arg + "\"")
first = False
else:
f.write(" \"" + arg + "\"")
f.write(")\n")
dump_dbg_env(f)
f.write("\t" + wine_name + " winedbg --gdb \"${@:-${DEF_CMD[@]}}\"\n")
os.chmod("/tmp/proton_gdb_run", 0755)
with open("/tmp/proton_run", "w") as f:
f.write("#!/bin/bash\n")
f.write("#Run game or given command in environment\n\n")
f.write("cd \"" + os.getcwd() + "\"\n")
f.write("DEF_CMD=(")
first = True
for arg in sys.argv[2:]:
if first:
f.write("\"" + arg + "\"")
first = False
else:
f.write(" \"" + arg + "\"")
f.write(")\n")
dump_dbg_env(f)
if game_arch == ARCH_UNKNOWN:
f.write("\t" + wine_name + " start \"${@:-${DEF_CMD[@]}}\"\n")
else:
f.write("\t" + wine_name + " \"${@:-${DEF_CMD[@]}}\"\n")
2018-03-14 19:58:11 +01:00
os.chmod("/tmp/proton_run", 0755)
2018-02-02 21:21:35 +01:00
#determine mode
if sys.argv[1] == "run":
#start target app
2018-03-14 19:58:11 +01:00
# if "PROTON_DUMP_DEBUG_COMMAND" in os.environ: #for now, we are always dumping the debug scripts
dump_dbg_scripts()
# else: #see above
if game_arch == ARCH_UNKNOWN:
#probably a batch script or something, hopefully start.exe can handle it
run_wine([wine_path, "start", "/unix"] + sys.argv[2:])
else:
run_wine([wine_path] + sys.argv[2:])
2018-02-20 14:41:39 +01:00
elif sys.argv[1] == "getcompatpath":
#linux -> windows path
path = subprocess.check_output([wine_path, "winepath", "-w", sys.argv[2]], env=env, stderr=lfile)
2018-02-26 15:44:11 +01:00
sys.stdout.write(path)
2018-02-20 14:41:39 +01:00
elif sys.argv[1] == "getnativepath":
#windows -> linux path
path = subprocess.check_output([wine_path, "winepath", sys.argv[2]], env=env, stderr=lfile)
2018-02-26 15:44:11 +01:00
sys.stdout.write(path)
2018-02-02 21:21:35 +01:00
else:
2018-02-15 20:06:32 +01:00
log("Need a verb.")
2018-02-02 21:21:35 +01:00
sys.exit(1)
2018-01-18 21:00:48 +01:00
sys.exit(0)