Use ARm64EC libraries for X64 support on ARM64 systems

Author: LeonarddeR

nvdaHelper/archBuild_sconscript

@@ -68,21 +68,23 @@ def COMProxyDllBuilder(env, target, source, proxyClsid):
 
 env.AddMethod(COMProxyDllBuilder, "COMProxyDll")
 
-# We only support compiling with MSVC 14.2 (2019) or newer
-if not env.get("MSVC_VERSION") or tuple(map(int, env.get("MSVC_VERSION").split("."))) < (14, 2):
-	raise RuntimeError("Visual C++ 14.2 (Visual Studio 2019) or newer not found")
+# We only support compiling with MSVC 14.3 (2022) or newer
+if not env.get("MSVC_VERSION") or tuple(map(int, env.get("MSVC_VERSION").split("."))) < (14, 3):
+	raise RuntimeError("Visual C++ 14.3 (Visual Studio 2022) or newer not found")
 
 PYTHON_PLATFORM = sysconfig.get_platform()
 TARGET_ARCH = env["TARGET_ARCH"]
+isArm64EC = env.get("isArm64EC", False)
 
 
 isNVDACoreArch = (
 	(PYTHON_PLATFORM == "win32" and TARGET_ARCH == "x86")
 	or (PYTHON_PLATFORM == "win-amd64" and TARGET_ARCH == "x86_64")
 	or (PYTHON_PLATFORM == "win-arm64" and TARGET_ARCH == "arm64")
 )
-
-
+isNVDAHelperLocalArch = isNVDACoreArch or (
+	PYTHON_PLATFORM == "win-amd64" and TARGET_ARCH == "arm64" and isArm64EC
+)
 debug = env["nvdaHelperDebugFlags"]
 release = env["release"]
 signExec = env["signExec"] if (bool(env["certFile"]) ^ bool(env["apiSigningToken"])) else None
@@ -124,7 +126,7 @@ env.Append(
 if TARGET_ARCH == "x86_64":
 	env.Append(MIDLFLAGS="/x64")
 elif TARGET_ARCH == "arm64":
-	env.Append(MIDLFLAGS="/arm64")
+	env.Append(MIDLFLAGS="/x64" if isArm64EC else "/arm64")
 else:
 	env.Append(MIDLFLAGS="/win32")
 
@@ -160,6 +162,11 @@ env.Append(
 	]
 )
 
+if isArm64EC:
+	env.Append(CCFLAGS="/arm64EC")
+	env.Append(LINKFLAGS="/machine:arm64ec")
+	env.Append(ARFLAGS="/machine:arm64ec")
+
 if "debugCRT" in debug:
 	env.Append(CCFLAGS=["/MTd"])
 else:
@@ -221,7 +228,7 @@ Export("detoursLib")
 apiHookObj = env.Object("apiHook", "common/apiHook.cpp")
 Export("apiHookObj")
 
-if isNVDACoreArch:
+if isNVDAHelperLocalArch:
 	localLib = env.SConscript("local/sconscript")
 	Export("localLib")
 	if signExec:
@@ -250,11 +257,14 @@ if signExec:
 	env.AddPostAction(remoteLib[0], [signExec])
 env.Install(libInstallDir, remoteLib)
 
-remoteLoaderProgram = env.SConscript("remoteLoader/sconscript")
-if signExec:
-	env.AddPostAction(remoteLoaderProgram, [signExec])
-env.Install(libInstallDir, remoteLoaderProgram)
+if not isNVDAHelperLocalArch:
+	remoteLoaderProgram = env.SConscript("remoteLoader/sconscript")
+	if signExec:
+		env.AddPostAction(remoteLoaderProgram, [signExec])
+	env.Install(libInstallDir, remoteLoaderProgram)
 
 if isNVDACoreArch:
 	thirdPartyEnv.SConscript("espeak/sconscript")
 	thirdPartyEnv.SConscript("liblouis/sconscript")
+	thirdPartyEnv.SConscript("javaAccessBridge/sconscript")
+	thirdPartyEnv.SConscript("uwp/sconscript")

nvdaHelper/javaAccessBridge/sconscript

@@ -0,0 +1,28 @@
+# A part of NonVisual Desktop Access (NVDA)
+# Copyright (C) 2019-2025 NV Access Limited, Leonard de Ruijter
+# This file may be used under the terms of the GNU General Public License, version 2 or later, as modified by the NVDA license.
+# For full terms and any additional permissions, see the NVDA license file: https://github.com/nvaccess/nvda/blob/master/copying.txt
+
+Import(
+	[
+		"thirdPartyEnv",
+		"sourceDir",
+	]
+)
+
+env: Environment = thirdPartyEnv
+TARGET_ARCH = env["TARGET_ARCH"]
+# Copy in the Java Access Bridge dependency.
+match TARGET_ARCH:
+	case "x86":
+		jabDllName = "windowsaccessbridge-32.dll"
+	case "x86_64":
+		jabDllName = "windowsaccessbridge-64.dll"
+	case _:
+		print(f"No Java Access Bridge support for NVDA core architecture {TARGET_ARCH!r}")
+		jabDllName = None		
+if jabDllName:
+	env.Command(
+		sourceDir.File("windowsaccessbridge.dll"), env.Dir("#include/javaAccessBridge32").File(jabDllName), Copy("$TARGET", "$SOURCE")
+	)
+

nvdaHelper/localWin10/sconscript

@@ -12,11 +12,6 @@
 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 ###
 
-import os
-import glob
-
-from SCons.Tool.MSCommon.vc import find_vc_pdir
-
 Import(
 	"env",
 	"sourceDir",
@@ -41,32 +36,4 @@ localWin10Lib = env.SharedLibrary(
 	],  # noqa: F821
 )
 
-# UWP dlls can only be dynamically linked with the CRT,
-# but some systems might not have this version of the CRT.
-# Therefore, we must include it.
-# VS keeps changing the path to reflect the latest major.minor.build version which we canot easily find out.
-# Therefore  Search these versioned directories from newest to oldest  to collect all the files we need.
-msvc = env.get("MSVC_VERSION")
-vcRedistDirs = glob.glob(
-	os.path.join(
-		find_vc_pdir(msvc, env), rf"Redist\MSVC\{msvc[:2]}*\x86\Microsoft.VC{msvc.replace('.', '')}.CRT"
-	)
-)
-if len(vcRedistDirs) == 0:
-	raise RuntimeError(
-		"Could not locate vc redistributables. Perhaps the Universal Windows Platform component in visual Studio is not installed"
-	)
-vcRedistDirs.sort(reverse=True)
-for fn in ("msvcp140.dll", "vccorlib140.dll", "vcruntime140.dll"):
-	for vcRedistDir in vcRedistDirs:
-		path = os.path.join(vcRedistDir, fn)
-		if os.path.isfile(path):
-			env.Install(sourceDir, path)
-			break
-		else:
-			raise RuntimeError(
-				"Could not locate %s. Perhaps the Universal Windows Platform component in visual Studio is not installed"
-				% fn
-			)
-
 Return(["localWin10Lib"])

nvdaHelper/uwp/sconscript

@@ -0,0 +1,46 @@
+# A part of NonVisual Desktop Access (NVDA)
+# Copyright (C) 2017-2025 NV Access Limited, Leonard de Ruijter
+# This file may be used under the terms of the GNU General Public License, version 2 or later, as modified by the NVDA license.
+# For full terms and any additional permissions, see the NVDA license file: https://github.com/nvaccess/nvda/blob/master/copying.txt
+
+import glob
+import os
+
+from SCons.Tool.MSCommon.vc import find_vc_pdir
+
+Import(
+	[
+		"thirdPartyEnv",
+		"sourceDir",
+	]
+)
+
+env: Environment = thirdPartyEnv
+
+# UWP dlls can only be dynamically linked with the CRT,
+# but some systems might not have this version of the CRT.
+# Therefore, we must include it.
+# VS keeps changing the path to reflect the latest major.minor.build version which we canot easily find out.
+# Therefore  Search these versioned directories from newest to oldest  to collect all the files we need.
+msvc = env.get("MSVC_VERSION")
+vcRedistDirs = glob.glob(
+	os.path.join(
+		find_vc_pdir(msvc, env), rf"Redist\MSVC\{msvc[:2]}*\x86\Microsoft.VC{msvc.replace('.', '')}.CRT"
+	)
+)
+if len(vcRedistDirs) == 0:
+	raise RuntimeError(
+		"Could not locate vc redistributables. Perhaps the Universal Windows Platform component in visual Studio is not installed"
+	)
+vcRedistDirs.sort(reverse=True)
+for fn in ("msvcp140.dll", "vccorlib140.dll", "vcruntime140.dll"):
+	for vcRedistDir in vcRedistDirs:
+		path = os.path.join(vcRedistDir, fn)
+		if os.path.isfile(path):
+			env.Install(sourceDir, path)
+			break
+		else:
+			raise RuntimeError(
+				"Could not locate %s. Perhaps the Universal Windows Platform component in visual Studio is not installed"
+				% fn
+			)

sconstruct

@@ -196,6 +196,8 @@ sourceLibDir64 = sourceDir.Dir("lib/x64")
 Export("sourceLibDir64")
 sourceLibDirArm64 = sourceDir.Dir("lib/arm64")
 Export("sourceLibDirArm64")
+sourceLibDirArm64EC = sourceDir.Dir("lib/arm64ec")
+Export("sourceLibDirArm64EC")
 buildDir = Dir("build")
 outFilePrefix = "nvda{type}_{version}".format(type="" if release else "_snapshot", version=version)
 Export("outFilePrefix")
@@ -247,10 +249,13 @@ archTools = ["default", "midl", "msrpc"]
 env32 = env.Clone(TARGET_ARCH="x86", tools=archTools)
 env64 = env.Clone(TARGET_ARCH="x86_64", tools=archTools)
 envArm64 = env.Clone(TARGET_ARCH="arm64", tools=archTools)
+envArm64EC = envArm64.Clone()
+envArm64EC["isArm64EC"] = True
 # Hack around odd bug where some tool [after] msvc states that static and shared objects are different
 env32["STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME"] = 1
 env64["STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME"] = 1
 envArm64["STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME"] = 1
+envArm64EC["STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME"] = 1
 
 if platform.architecture()[0].startswith("64"):
 	env = env64
@@ -276,17 +281,10 @@ resFile = env.RES(
 env32["projectResFile"] = resFile
 env64["projectResFile"] = resFile
 envArm64["projectResFile"] = resFile
+envArm64EC["projectResFile"] = resFile
 
 # Fill sourceDir with anything provided for it by miscDeps
 env.recursiveCopy(sourceDir, Dir("miscdeps/source"))
-# Copy in some other dependencies.
-for targetDir, jabDll in (
-	(sourceLibDir, "windowsaccessbridge-32.dll"),
-	(sourceLibDir64, "windowsaccessbridge-64.dll"),
-):
-	Command(
-		targetDir.File("windowsaccessbridge.dll"), env.Dir("#include/javaAccessBridge32").File(jabDll), Copy("$TARGET", "$SOURCE")
-	)
 
 env.SConscript("source/comInterfaces_sconscript", exports=["env"])
 
@@ -306,6 +304,11 @@ envArm64.SConscript(
 	exports={"env": envArm64, "clientInstallDir": clientDir.Dir("arm64"), "libInstallDir": sourceLibDirArm64},
 	variant_dir="build/arm64",
 )
+envArm64EC.SConscript(
+	"nvdaHelper/archBuild_sconscript",
+	exports={"env": envArm64EC, "clientInstallDir": clientDir.Dir("arm64ec"), "libInstallDir": sourceLibDirArm64EC},
+	variant_dir="build/arm64ec",
+)
 
 # Allow all NVDA's gettext po files to be compiled in source/locale
 for po in env.Glob(sourceDir.path + "/locale/*/lc_messages/*.po"):

source/JABHandler.py

@@ -39,7 +39,6 @@
 import NVDAObjects.JAB
 import core
 import textUtils
-import NVDAHelper
 import config
 from utils.security import isRunningOnSecureDesktop
 
@@ -1137,7 +1136,7 @@ def initialize():
 	global bridgeDll, isRunning
 	try:
 		bridgeDll = cdll.LoadLibrary(
-			os.path.join(NVDAHelper.coreArchLibPath, "windowsaccessbridge.dll"),
+			os.path.join("windowsaccessbridge.dll"),
 		)
 	except WindowsError:
 		raise NotImplementedError("dll not available")

source/NVDAHelper/__init__.py

@@ -34,6 +34,7 @@
 
 import buildVersion
 import globalVars
+import winVersion
 
 versionedLibPath = os.path.join(globalVars.appDir, "lib")
 
@@ -43,8 +44,13 @@
 	# When running as a py2exe build, libraries are in a version-specific directory
 	versionedLibPath = os.path.join(versionedLibPath, buildVersion.version)
 
+arch = winVersion.getWinVer().processorArchitecture
 versionedLibX86Path = os.path.join(versionedLibPath, "x86")
-versionedLibAMD64Path = os.path.join(versionedLibPath, "x64")
+versionedLibAMD64Path = os.path.join(
+	versionedLibPath,
+	# On ARM64 Windows, we use arm64ec libraries for interop with x64 code.
+	"arm64ec" if arch == "ARM64" else "x64",
+)
 versionedLibARM64Path = os.path.join(versionedLibPath, "arm64")
 
 match sysconfig.get_platform():
@@ -86,7 +92,6 @@ def warnDeprecatedWithReplacement(deprecated: str, replacement: str):
 
 
 from . import localLib  # noqa: E402
-import winVersion  # noqa: E402
 import winKernel  # noqa: E402
 import config  # noqa: E402
 import winUser  # noqa: E402
@@ -883,7 +888,6 @@ def initialize() -> None:
 		log.error("Error installing IA2 support")
 	# Manually start the in-process manager thread for this NVDA main thread now, as a slow system can cause this action to confuse WX
 	_remoteLib.initInprocManagerThreadIfNeeded()
-	arch = winVersion.getWinVer().processorArchitecture
 	if arch != "x86" and coreArchLibPath != versionedLibX86Path:
 		_remoteLoaderX86 = _RemoteLoader(versionedLibX86Path)
 	elif arch in ("AMD64", "ARM64") and coreArchLibPath != versionedLibAMD64Path:

source/setup.py

@@ -259,6 +259,7 @@ def _genManifestTemplate(shouldHaveUIAccess: bool) -> tuple[int, int, bytes]:
 		("lib/%s/x86" % version, glob("lib/x86/*.dll") + glob("lib/x86/*.exe")),
 		("lib/%s/x64" % version, glob("lib/x64/*.dll") + glob("lib/x64/*.exe")),
 		("lib/%s/arm64" % version, glob("lib/arm64/*.dll") + glob("lib/arm64/*.exe")),
+		("lib/%s/arm64ec" % version, glob("lib/arm64ec/*.dll") + glob("lib/arm64ec/*.exe")),
 		("waves", glob("waves/*.wav")),
 		("images", glob("images/*.ico")),
 		("fonts", glob("fonts/*.ttf")),