import methods import os import subprocess import sys from platform_methods import detect_arch from typing import TYPE_CHECKING if TYPE_CHECKING: from SCons import Environment # To match other platforms STACK_SIZE = 8388608 def get_name(): return "Windows" def try_cmd(test, prefix, arch): if arch: try: out = subprocess.Popen( get_mingw_bin_prefix(prefix, arch) + test, shell=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE, ) out.communicate() if out.returncode == 0: return True except Exception: pass else: for a in ["x86_64", "x86_32", "arm64", "arm32"]: try: out = subprocess.Popen( get_mingw_bin_prefix(prefix, a) + test, shell=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE, ) out.communicate() if out.returncode == 0: return True except Exception: pass return False def can_build(): if os.name == "nt": # Building natively on Windows # If VCINSTALLDIR is set in the OS environ, use traditional Godot logic to set up MSVC if os.getenv("VCINSTALLDIR"): # MSVC, manual setup return True # Otherwise, let SCons find MSVC if installed, or else MinGW. # Since we're just returning True here, if there's no compiler # installed, we'll get errors when it tries to build with the # null compiler. return True if os.name == "posix": # Cross-compiling with MinGW-w64 (old MinGW32 is not supported) prefix = os.getenv("MINGW_PREFIX", "") if try_cmd("gcc --version", prefix, "") or try_cmd("clang --version", prefix, ""): return True return False def get_mingw_bin_prefix(prefix, arch): if not prefix: mingw_bin_prefix = "" elif prefix[-1] != "/": mingw_bin_prefix = prefix + "/bin/" else: mingw_bin_prefix = prefix + "bin/" if arch == "x86_64": mingw_bin_prefix += "x86_64-w64-mingw32-" elif arch == "x86_32": mingw_bin_prefix += "i686-w64-mingw32-" elif arch == "arm32": mingw_bin_prefix += "armv7-w64-mingw32-" elif arch == "arm64": mingw_bin_prefix += "aarch64-w64-mingw32-" return mingw_bin_prefix def detect_build_env_arch(): msvc_target_aliases = { "amd64": "x86_64", "i386": "x86_32", "i486": "x86_32", "i586": "x86_32", "i686": "x86_32", "x86": "x86_32", "x64": "x86_64", "x86_64": "x86_64", "arm": "arm32", "arm64": "arm64", "aarch64": "arm64", } if os.getenv("VCINSTALLDIR") or os.getenv("VCTOOLSINSTALLDIR"): if os.getenv("Platform"): msvc_arch = os.getenv("Platform").lower() if msvc_arch in msvc_target_aliases.keys(): return msvc_target_aliases[msvc_arch] if os.getenv("VSCMD_ARG_TGT_ARCH"): msvc_arch = os.getenv("VSCMD_ARG_TGT_ARCH").lower() if msvc_arch in msvc_target_aliases.keys(): return msvc_target_aliases[msvc_arch] # Pre VS 2017 checks. if os.getenv("VCINSTALLDIR"): PATH = os.getenv("PATH").upper() VCINSTALLDIR = os.getenv("VCINSTALLDIR").upper() path_arch = { "BIN\\x86_ARM;": "arm32", "BIN\\amd64_ARM;": "arm32", "BIN\\x86_ARM64;": "arm64", "BIN\\amd64_ARM64;": "arm64", "BIN\\x86_amd64;": "a86_64", "BIN\\amd64;": "x86_64", "BIN\\amd64_x86;": "x86_32", "BIN;": "x86_32", } for path, arch in path_arch.items(): final_path = VCINSTALLDIR + path if final_path in PATH: return arch # VS 2017 and newer. if os.getenv("VCTOOLSINSTALLDIR"): host_path_index = os.getenv("PATH").upper().find(os.getenv("VCTOOLSINSTALLDIR").upper() + "BIN\\HOST") if host_path_index > -1: first_path_arch = os.getenv("PATH").split(";")[0].rsplit("\\", 1)[-1].lower() return msvc_target_aliases[first_path_arch] msys_target_aliases = { "mingw32": "x86_32", "mingw64": "x86_64", "ucrt64": "x86_64", "clang64": "x86_64", "clang32": "x86_32", "clangarm64": "arm64", } if os.getenv("MSYSTEM"): msys_arch = os.getenv("MSYSTEM").lower() if msys_arch in msys_target_aliases.keys(): return msys_target_aliases[msys_arch] return "" def get_opts(): from SCons.Variables import BoolVariable, EnumVariable mingw = os.getenv("MINGW_PREFIX", "") return [ ("mingw_prefix", "MinGW prefix", mingw), # Targeted Windows version: 7 (and later), minimum supported version # XP support dropped after EOL due to missing API for IPv6 and other issues # Vista support dropped after EOL due to GH-10243 ( "target_win_version", "Targeted Windows version, >= 0x0601 (Windows 7)", "0x0601", ), EnumVariable("windows_subsystem", "Windows subsystem", "gui", ("gui", "console")), ( "msvc_version", "MSVC version to use. Ignored if VCINSTALLDIR is set in shell env.", None, ), BoolVariable("use_mingw", "Use the Mingw compiler, even if MSVC is installed.", False), BoolVariable("use_llvm", "Use the LLVM compiler", False), BoolVariable("use_static_cpp", "Link MinGW/MSVC C++ runtime libraries statically", True), BoolVariable("use_asan", "Use address sanitizer (ASAN)", False), BoolVariable("debug_crt", "Compile with MSVC's debug CRT (/MDd)", False), BoolVariable("incremental_link", "Use MSVC incremental linking. May increase or decrease build times.", False), ("angle_libs", "Path to the ANGLE static libraries", ""), # Direct3D 12 support. ("mesa_libs", "Path to the MESA/NIR static libraries (required for D3D12)", ""), ("dxc_path", "Path to the DirectX Shader Compiler distribution (required for D3D12)", ""), ("agility_sdk_path", "Path to the Agility SDK distribution (optional for D3D12)", ""), BoolVariable( "agility_sdk_multiarch", "Whether the Agility SDK DLLs will be stored in arch-specific subdirectories", False, ), ("pix_path", "Path to the PIX runtime distribution (optional for D3D12)", ""), ] def get_doc_classes(): return [ "EditorExportPlatformWindows", ] def get_doc_path(): return "doc_classes" def get_flags(): arch = detect_build_env_arch() or detect_arch() return [ ("arch", arch), ("supported", ["mono"]), ] def build_res_file(target, source, env): arch_aliases = { "x86_32": "pe-i386", "x86_64": "pe-x86-64", "arm32": "armv7-w64-mingw32", "arm64": "aarch64-w64-mingw32", } cmdbase = "windres --include-dir . --target=" + arch_aliases[env["arch"]] mingw_bin_prefix = get_mingw_bin_prefix(env["mingw_prefix"], env["arch"]) for x in range(len(source)): ok = True # Try prefixed executable (MinGW on Linux). cmd = mingw_bin_prefix + cmdbase + " -i " + str(source[x]) + " -o " + str(target[x]) try: out = subprocess.Popen(cmd, shell=True, stderr=subprocess.PIPE).communicate() if len(out[1]): ok = False except Exception: ok = False # Try generic executable (MSYS2). if not ok: cmd = cmdbase + " -i " + str(source[x]) + " -o " + str(target[x]) try: out = subprocess.Popen(cmd, shell=True, stderr=subprocess.PIPE).communicate() if len(out[1]): return -1 except Exception: return -1 return 0 def setup_msvc_manual(env): """Running from VCVARS environment""" env_arch = detect_build_env_arch() if env["arch"] != env_arch: print( """ Arch argument (%s) is not matching Native/Cross Compile Tools Prompt/Developer Console (or Visual Studio settings) that is being used to run SCons (%s). Run SCons again without arch argument (example: scons p=windows) and SCons will attempt to detect what MSVC compiler will be executed and inform you. """ % (env["arch"], env_arch) ) sys.exit(200) print("Found MSVC, arch %s" % (env_arch)) def setup_msvc_auto(env): """Set up MSVC using SCons's auto-detection logic""" # If MSVC_VERSION is set by SCons, we know MSVC is installed. # But we may want a different version or target arch. # Valid architectures for MSVC's TARGET_ARCH: # ['amd64', 'emt64', 'i386', 'i486', 'i586', 'i686', 'ia64', 'itanium', 'x86', 'x86_64', 'arm', 'arm64', 'aarch64'] # Our x86_64 and arm64 are the same, and we need to map the 32-bit # architectures to other names since MSVC isn't as explicit. # The rest we don't need to worry about because they are # aliases or aren't supported by Godot (itanium & ia64). msvc_arch_aliases = {"x86_32": "x86", "arm32": "arm"} if env["arch"] in msvc_arch_aliases.keys(): env["TARGET_ARCH"] = msvc_arch_aliases[env["arch"]] else: env["TARGET_ARCH"] = env["arch"] # The env may have already been set up with default MSVC tools, so # reset a few things so we can set it up with the tools we want. # (Ideally we'd decide on the tool config before configuring any # environment, and just set the env up once, but this function runs # on an existing env so this is the simplest way.) env["MSVC_SETUP_RUN"] = False # Need to set this to re-run the tool env["MSVS_VERSION"] = None env["MSVC_VERSION"] = None if "msvc_version" in env: env["MSVC_VERSION"] = env["msvc_version"] env.Tool("msvc") env.Tool("mssdk") # we want the MS SDK # Note: actual compiler version can be found in env['MSVC_VERSION'], e.g. "14.1" for VS2015 print("Found MSVC version %s, arch %s" % (env["MSVC_VERSION"], env["arch"])) def setup_mingw(env): """Set up env for use with mingw""" env_arch = detect_build_env_arch() if os.getenv("MSYSTEM") == "MSYS": print( """ Running from base MSYS2 console/environment, use target specific environment instead (e.g., mingw32, mingw64, clang32, clang64). """ ) sys.exit(201) if env_arch != "" and env["arch"] != env_arch: print( """ Arch argument (%s) is not matching MSYS2 console/environment that is being used to run SCons (%s). Run SCons again without arch argument (example: scons p=windows) and SCons will attempt to detect what MSYS2 compiler will be executed and inform you. """ % (env["arch"], env_arch) ) sys.exit(202) if not try_cmd("gcc --version", env["mingw_prefix"], env["arch"]) and not try_cmd( "clang --version", env["mingw_prefix"], env["arch"] ): print( """ No valid compilers found, use MINGW_PREFIX environment variable to set MinGW path. """ ) sys.exit(202) print("Using MinGW, arch %s" % (env["arch"])) def configure_msvc(env, vcvars_msvc_config): """Configure env to work with MSVC""" ## Build type # TODO: Re-evaluate the need for this / streamline with common config. if env["target"] == "template_release": env.Append(LINKFLAGS=["/ENTRY:mainCRTStartup"]) if env["windows_subsystem"] == "gui": env.Append(LINKFLAGS=["/SUBSYSTEM:WINDOWS"]) else: env.Append(LINKFLAGS=["/SUBSYSTEM:CONSOLE"]) env.AppendUnique(CPPDEFINES=["WINDOWS_SUBSYSTEM_CONSOLE"]) ## Compile/link flags if env["debug_crt"]: # Always use dynamic runtime, static debug CRT breaks thread_local. env.AppendUnique(CCFLAGS=["/MDd"]) else: if env["use_static_cpp"]: env.AppendUnique(CCFLAGS=["/MT"]) else: env.AppendUnique(CCFLAGS=["/MD"]) # MSVC incremental linking is broken and may _increase_ link time (GH-77968). if not env["incremental_link"]: env.Append(LINKFLAGS=["/INCREMENTAL:NO"]) if env["arch"] == "x86_32": env["x86_libtheora_opt_vc"] = True env.AppendUnique(CCFLAGS=["/Gd", "/GR", "/nologo"]) env.AppendUnique(CCFLAGS=["/utf-8"]) # Force to use Unicode encoding. env.AppendUnique(CXXFLAGS=["/TP"]) # assume all sources are C++ # Once it was thought that only debug builds would be too large, # but this has recently stopped being true. See the mingw function # for notes on why this shouldn't be enabled for gcc env.AppendUnique(CCFLAGS=["/bigobj"]) if vcvars_msvc_config: # should be automatic if SCons found it if os.getenv("WindowsSdkDir") is not None: env.Prepend(CPPPATH=[os.getenv("WindowsSdkDir") + "/Include"]) else: print("Missing environment variable: WindowsSdkDir") env.AppendUnique( CPPDEFINES=[ "WINDOWS_ENABLED", "WASAPI_ENABLED", "WINMIDI_ENABLED", "TYPED_METHOD_BIND", "WIN32", "WINVER=%s" % env["target_win_version"], "_WIN32_WINNT=%s" % env["target_win_version"], ] ) env.AppendUnique(CPPDEFINES=["NOMINMAX"]) # disable bogus min/max WinDef.h macros if env["arch"] == "x86_64": env.AppendUnique(CPPDEFINES=["_WIN64"]) ## Libs LIBS = [ "winmm", "dsound", "kernel32", "ole32", "oleaut32", "sapi", "user32", "gdi32", "IPHLPAPI", "Shlwapi", "wsock32", "Ws2_32", "shell32", "advapi32", "dinput8", "dxguid", "imm32", "bcrypt", "Crypt32", "Avrt", "dwmapi", "dwrite", "wbemuuid", "ntdll", ] if env.debug_features: LIBS += ["psapi", "dbghelp"] if env["vulkan"]: env.AppendUnique(CPPDEFINES=["VULKAN_ENABLED"]) if not env["use_volk"]: LIBS += ["vulkan"] if env["d3d12"]: if env["dxc_path"] == "": print("The Direct3D 12 rendering driver requires dxc_path to be set.") sys.exit(255) env.AppendUnique(CPPDEFINES=["D3D12_ENABLED"]) LIBS += ["d3d12", "dxgi", "dxguid"] LIBS += ["version"] # Mesa dependency. # Needed for avoiding C1128. if env["target"] == "release_debug": env.Append(CXXFLAGS=["/bigobj"]) arch_subdir = "arm64" if env["arch"] == "arm64" else "x64" # PIX if env["pix_path"] != "": env.Append(LIBPATH=[env["pix_path"] + "/bin/" + arch_subdir]) LIBS += ["WinPixEventRuntime"] # Mesa if env["mesa_libs"] == "": print("The Direct3D 12 rendering driver requires mesa_libs to be set.") sys.exit(255) env.Append(LIBPATH=[env["mesa_libs"] + "/bin"]) LIBS += ["libNIR.windows." + env["arch"]] if env["opengl3"]: env.AppendUnique(CPPDEFINES=["GLES3_ENABLED"]) if env["angle_libs"] != "": env.AppendUnique(CPPDEFINES=["EGL_STATIC"]) env.Append(LIBPATH=[env["angle_libs"]]) LIBS += [ "libANGLE.windows." + env["arch"], "libEGL.windows." + env["arch"], "libGLES.windows." + env["arch"], ] LIBS += ["dxgi", "d3d9", "d3d11"] env.Prepend(CPPPATH=["#thirdparty/angle/include"]) env.Append(LINKFLAGS=[p + env["LIBSUFFIX"] for p in LIBS]) if vcvars_msvc_config: if os.getenv("WindowsSdkDir") is not None: env.Append(LIBPATH=[os.getenv("WindowsSdkDir") + "/Lib"]) else: print("Missing environment variable: WindowsSdkDir") ## LTO if env["lto"] == "auto": # No LTO by default for MSVC, doesn't help. env["lto"] = "none" if env["lto"] != "none": if env["lto"] == "thin": print("ThinLTO is only compatible with LLVM, use `use_llvm=yes` or `lto=full`.") sys.exit(255) env.AppendUnique(CCFLAGS=["/GL"]) env.AppendUnique(ARFLAGS=["/LTCG"]) if env["progress"]: env.AppendUnique(LINKFLAGS=["/LTCG:STATUS"]) else: env.AppendUnique(LINKFLAGS=["/LTCG"]) if vcvars_msvc_config: env.Prepend(CPPPATH=[p for p in os.getenv("INCLUDE").split(";")]) env.Append(LIBPATH=[p for p in os.getenv("LIB").split(";")]) # Sanitizers if env["use_asan"]: env.extra_suffix += ".san" env.Append(LINKFLAGS=["/INFERASANLIBS"]) env.Append(CCFLAGS=["/fsanitize=address"]) # Incremental linking fix env["BUILDERS"]["ProgramOriginal"] = env["BUILDERS"]["Program"] env["BUILDERS"]["Program"] = methods.precious_program env.Append(LINKFLAGS=["/NATVIS:platform\\windows\\godot.natvis"]) env.AppendUnique(LINKFLAGS=["/STACK:" + str(STACK_SIZE)]) def configure_mingw(env): # Workaround for MinGW. See: # https://www.scons.org/wiki/LongCmdLinesOnWin32 env.use_windows_spawn_fix() ## Build type if not env["use_llvm"] and not try_cmd("gcc --version", env["mingw_prefix"], env["arch"]): env["use_llvm"] = True if env["use_llvm"] and not try_cmd("clang --version", env["mingw_prefix"], env["arch"]): env["use_llvm"] = False # TODO: Re-evaluate the need for this / streamline with common config. if env["target"] == "template_release": env.Append(CCFLAGS=["-msse2"]) elif env.dev_build: # Allow big objects. It's supposed not to have drawbacks but seems to break # GCC LTO, so enabling for debug builds only (which are not built with LTO # and are the only ones with too big objects). env.Append(CCFLAGS=["-Wa,-mbig-obj"]) if env["windows_subsystem"] == "gui": env.Append(LINKFLAGS=["-Wl,--subsystem,windows"]) else: env.Append(LINKFLAGS=["-Wl,--subsystem,console"]) env.AppendUnique(CPPDEFINES=["WINDOWS_SUBSYSTEM_CONSOLE"]) ## Compiler configuration if os.name != "nt": env["PROGSUFFIX"] = env["PROGSUFFIX"] + ".exe" # for linux cross-compilation if env["arch"] == "x86_32": if env["use_static_cpp"]: env.Append(LINKFLAGS=["-static"]) env.Append(LINKFLAGS=["-static-libgcc"]) env.Append(LINKFLAGS=["-static-libstdc++"]) else: if env["use_static_cpp"]: env.Append(LINKFLAGS=["-static"]) if env["arch"] in ["x86_32", "x86_64"]: env["x86_libtheora_opt_gcc"] = True mingw_bin_prefix = get_mingw_bin_prefix(env["mingw_prefix"], env["arch"]) if env["use_llvm"]: env["CC"] = mingw_bin_prefix + "clang" env["CXX"] = mingw_bin_prefix + "clang++" if try_cmd("as --version", env["mingw_prefix"], env["arch"]): env["AS"] = mingw_bin_prefix + "as" if try_cmd("ar --version", env["mingw_prefix"], env["arch"]): env["AR"] = mingw_bin_prefix + "ar" if try_cmd("ranlib --version", env["mingw_prefix"], env["arch"]): env["RANLIB"] = mingw_bin_prefix + "ranlib" env.extra_suffix = ".llvm" + env.extra_suffix else: env["CC"] = mingw_bin_prefix + "gcc" env["CXX"] = mingw_bin_prefix + "g++" if try_cmd("as --version", env["mingw_prefix"], env["arch"]): env["AS"] = mingw_bin_prefix + "as" if try_cmd("gcc-ar --version", env["mingw_prefix"], env["arch"]): env["AR"] = mingw_bin_prefix + "gcc-ar" if try_cmd("gcc-ranlib --version", env["mingw_prefix"], env["arch"]): env["RANLIB"] = mingw_bin_prefix + "gcc-ranlib" ## LTO if env["lto"] == "auto": # Full LTO for production with MinGW. env["lto"] = "full" if env["lto"] != "none": if env["lto"] == "thin": if not env["use_llvm"]: print("ThinLTO is only compatible with LLVM, use `use_llvm=yes` or `lto=full`.") sys.exit(255) env.Append(CCFLAGS=["-flto=thin"]) env.Append(LINKFLAGS=["-flto=thin"]) elif not env["use_llvm"] and env.GetOption("num_jobs") > 1: env.Append(CCFLAGS=["-flto"]) env.Append(LINKFLAGS=["-flto=" + str(env.GetOption("num_jobs"))]) else: env.Append(CCFLAGS=["-flto"]) env.Append(LINKFLAGS=["-flto"]) env.Append(LINKFLAGS=["-Wl,--stack," + str(STACK_SIZE)]) ## Compile flags if not env["use_llvm"]: env.Append(CCFLAGS=["-mwindows"]) env.Append(CPPDEFINES=["WINDOWS_ENABLED", "WASAPI_ENABLED", "WINMIDI_ENABLED"]) env.Append( CPPDEFINES=[ ("WINVER", env["target_win_version"]), ("_WIN32_WINNT", env["target_win_version"]), ] ) env.Append( LIBS=[ "mingw32", "dsound", "ole32", "d3d9", "winmm", "gdi32", "iphlpapi", "shlwapi", "wsock32", "ws2_32", "kernel32", "oleaut32", "sapi", "dinput8", "dxguid", "ksuser", "imm32", "bcrypt", "crypt32", "avrt", "uuid", "dwmapi", "dwrite", "wbemuuid", "ntdll", ] ) if env.debug_features: env.Append(LIBS=["psapi", "dbghelp"]) if env["vulkan"]: env.Append(CPPDEFINES=["VULKAN_ENABLED"]) if not env["use_volk"]: env.Append(LIBS=["vulkan"]) if env["d3d12"]: env.AppendUnique(CPPDEFINES=["D3D12_ENABLED"]) env.Append(LIBS=["d3d12", "dxgi", "dxguid"]) arch_subdir = "arm64" if env["arch"] == "arm64" else "x64" # PIX if env["pix_path"] != "": env.Append(LIBPATH=[env["pix_path"] + "/bin/" + arch_subdir]) env.Append(LIBS=["WinPixEventRuntime"]) # Mesa if env["mesa_libs"] == "": print("The Direct3D 12 rendering driver requires mesa_libs to be set.") sys.exit(255) env.Append(LIBPATH=[env["mesa_libs"] + "/bin"]) env.Append(LIBS=["libNIR.windows." + env["arch"]]) env.Append(LIBS=["version"]) # Mesa dependency. if env["opengl3"]: env.Append(CPPDEFINES=["GLES3_ENABLED"]) if env["angle_libs"] != "": env.AppendUnique(CPPDEFINES=["EGL_STATIC"]) env.Append(LIBPATH=[env["angle_libs"]]) env.Append( LIBS=[ "EGL.windows." + env["arch"], "GLES.windows." + env["arch"], "ANGLE.windows." + env["arch"], ] ) env.Append(LIBS=["dxgi", "d3d9", "d3d11"]) env.Prepend(CPPPATH=["#thirdparty/angle/include"]) env.Append(CPPDEFINES=["MINGW_ENABLED", ("MINGW_HAS_SECURE_API", 1)]) # resrc env.Append(BUILDERS={"RES": env.Builder(action=build_res_file, suffix=".o", src_suffix=".rc")}) def configure(env: "Environment"): # Validate arch. supported_arches = ["x86_32", "x86_64", "arm32", "arm64"] if env["arch"] not in supported_arches: print( 'Unsupported CPU architecture "%s" for Windows. Supported architectures are: %s.' % (env["arch"], ", ".join(supported_arches)) ) sys.exit() # At this point the env has been set up with basic tools/compilers. env.Prepend(CPPPATH=["#platform/windows"]) if os.name == "nt": env["ENV"] = os.environ # this makes build less repeatable, but simplifies some things env["ENV"]["TMP"] = os.environ["TMP"] # First figure out which compiler, version, and target arch we're using if os.getenv("VCINSTALLDIR") and detect_build_env_arch() and not env["use_mingw"]: setup_msvc_manual(env) env.msvc = True vcvars_msvc_config = True elif env.get("MSVC_VERSION", "") and not env["use_mingw"]: setup_msvc_auto(env) env.msvc = True vcvars_msvc_config = False else: setup_mingw(env) env.msvc = False # Now set compiler/linker flags if env.msvc: configure_msvc(env, vcvars_msvc_config) else: # MinGW configure_mingw(env)