--!A cross-platform build utility based on Lua -- -- Licensed under the Apache License, Version 2.0 (the "License"); -- you may not use this file except in compliance with the License. -- You may obtain a copy of the License at -- -- http://www.apache.org/licenses/LICENSE-2.0 -- -- Unless required by applicable law or agreed to in writing, software -- distributed under the License is distributed on an "AS IS" BASIS, -- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -- See the License for the specific language governing permissions and -- limitations under the License. -- -- Copyright (C) 2015-present, Xmake Open Source Community. -- -- @author ruki -- @file toolchain.lua -- -- imports import("core.base.option") import("core.project.config") import("core.base.semver") import("core.base.hashset") import("core.tool.linker") import("core.tool.compiler") import("core.language.language") import("lib.detect.find_tool") import("detect.sdks.find_vstudio") -- attempt to check vs environment function _check_vsenv(toolchain, check) -- have been checked? local vs = toolchain:config("vs") or config.get("vs") if vs then vs = tostring(vs) end local vcvars = toolchain:config("vcvars") if vs and vcvars then return vs end -- find vstudio local vs_toolset = toolchain:config("vs_toolset") or config.get("vs_toolset") local vs_sdkver = toolchain:config("vs_sdkver") or config.get("vs_sdkver") local vstudio = find_vstudio({toolset = vs_toolset, sdkver = vs_sdkver}) if vstudio then -- make order vsver local vsvers = {} for vsver, _ in pairs(vstudio) do if not vs or vs ~= vsver then table.insert(vsvers, vsver) end end table.sort(vsvers, function (a, b) return tonumber(a) > tonumber(b) end) if vs then table.insert(vsvers, 1, vs) end -- get vcvarsall for _, vsver in ipairs(vsvers) do local vcvarsall = (vstudio[vsver] or {}).vcvarsall or {} local vcvars = vcvarsall[toolchain:arch()] if vcvars and vcvars.PATH and vcvars.INCLUDE and vcvars.LIB then toolchain:config_set("vcvars", vcvars) toolchain:config_set("vcarchs", table.orderkeys(vcvarsall)) toolchain:config_set("vs_toolset", vcvars.VCToolsVersion) toolchain:config_set("vs_sdkver", vcvars.WindowsSDKVersion) if check and check(toolchain, vcvars) then return vsver end end end end end -- check the visual studio function check_vstudio(toolchain, check) local vs = _check_vsenv(toolchain, check) if vs then if toolchain:is_global() then config.set("vs", vs, {force = true, readonly = true}) end toolchain:config_set("vs", vs) cprint("checking for Microsoft Visual Studio (%s) version ... ${color.success}%s", toolchain:arch(), vs) else cprint("checking for Microsoft Visual Studio (%s) version ... ${color.nothing}${text.nothing}", toolchain:arch()) end return vs end -- add the given vs environment function _add_vsenv(toolchain, name, curenvs) -- get vcvars local vcvars = toolchain:config("vcvars") if not vcvars then return end -- get the paths for the vs environment local new = vcvars[name] if new then -- fix case naming conflict for cmake/msbuild between the new msvc envs and current environment, if we are running xmake in vs prompt. -- @see https://github.com/xmake-io/xmake/issues/4751 for k, c in pairs(curenvs) do if name:lower() == k:lower() and name ~= k then name = k break end end -- msvc-wine on linux if (name == "INCLUDE" or name == "LIB") and not is_host("windows") then toolchain:add("runenvs", name, path.joinenv(path.splitenv(new), ";")) else for _, item in ipairs(path.splitenv(new)) do toolchain:add("runenvs", name, item) end end end end -- get clang target function get_clang_target(toolchain) local target if toolchain:is_plat("windows") then if toolchain:is_arch("x86_64", "x64") then target = "x86_64-pc-windows-msvc" elseif toolchain:is_arch("i386", "x86", "i686") then target = "i686-pc-windows-msvc" elseif toolchain:is_arch("arm64", "aarch64") then target = "aarch64-pc-windows-msvc" elseif toolchain:is_arch("arm64ec") then target = "arm64ec-pc-windows-msvc" elseif toolchain:is_arch("arm.*") then target = "armv7-pc-windows-msvc" end elseif toolchain:is_plat("mingw") then if toolchain:is_arch("x86_64", "x64") then target = "x86_64-w64-windows-gnu" elseif toolchain:is_arch("i386", "x86", "i686") then target = "i686-w64-windows-gnu" elseif toolchain:is_arch("arm64", "aarch64") then target = "aarch64-w64-windows-gnu" elseif toolchain:is_arch("arm.*") then target = "armv7-w64-windows-gnu" end elseif toolchain:is_plat("linux") then if toolchain:is_arch("x86_64", "x64") then target = "x86_64-linux-gnu" elseif toolchain:is_arch("i386", "x86", "i686") then target = "i686-linux-gnu" elseif toolchain:is_arch("arm64", "aarch64", "arm64-v8a") then target = "aarch64-linux-gnu" elseif toolchain:is_arch("arm.*") then target = "armv7-linux-gnu" end elseif toolchain:is_plat("cross") then target = toolchain:cross() if target and target:endswith("-") then target = target:sub(1, -2) end end return target end -- get clang target flags -- @see https://github.com/xmake-io/xmake/issues/7271 function get_clang_target_flags(toolchain) local target if toolchain:is_cross() or toolchain:is_plat("windows") then target = get_clang_target(toolchain) if target then return "--target=" .. target end end if toolchain:is_arch("x86_64", "x64") then return "-m64" elseif toolchain:is_arch("i386", "x86") then return "-m32" end end -- get xcode/apple target triple for clang -target -- -- e.g. -- - macosx: x86_64-apple-macos14.0 -- - macosx(catalyst): arm64-apple-macos14.0-macabi -- - iphoneos: arm64-apple-ios18.2 -- - iphoneos(simulator): x86_64-apple-ios18.2-simulator -- - appletvos: arm64-apple-tvos17.0 -- - watchos: armv7k-apple-watchos10.0 -- - applexros(simulator): x86_64-apple-xros1.0-simulator -- -- configs: -- - appledev: simulator/catalyst -- - target_minver: deployment target version (ios 32-bit will be capped to 10) function get_xcode_target_triple(toolchain) local arch = toolchain:arch() local plat = toolchain:plat() local platmap = {macosx = "macos", iphoneos = "ios", watchos = "watchos", appletvos = "tvos", applexros = "xros"} plat = platmap[plat] or plat local target_minver = toolchain:config("target_minver") or config.get("target_minver") local appledev = toolchain:config("appledev") or config.get("appledev") local target = format("%s-apple-%s", arch, plat) if target_minver then if plat == "ios" and tonumber(target_minver) > 10 and (arch == "armv7" or arch == "armv7s" or arch == "i386") then target_minver = "10" end target = target .. target_minver end if plat == "macos" then if appledev == "catalyst" then target = target .. "-macabi" end else if appledev == "simulator" then target = target .. "-simulator" end end return target end -- add vs environments function add_vsenvs(toolchain, opt) opt = opt or {} local curenvs = os.getenvs() local varnames = opt.varnames or {"PATH", "LIB", "INCLUDE", "LIBPATH"} for _, name in ipairs(varnames) do _add_vsenv(toolchain, name, curenvs) end for _, name in ipairs(find_vstudio.get_vcvars()) do if not table.contains(varnames, name:upper()) then _add_vsenv(toolchain, name, curenvs) end end end -- set llvm runtimes function set_llvm_runtimes(toolchain) -- We should set them up uniformly here, because runtimes will be accessed early (in sanitizer), -- which automatically triggers lazy loading of the toolchain. -- However, if some runtime configurations are set in advance in the descriptor scope, -- lazy loading will not be triggered when the runtimes are accessed, and some Windows runtimes may be lost. -- -- @see https://github.com/xmake-io/xmake/pull/7146#issuecomment-3674402132 toolchain:set("runtimes", "c++_static", "c++_shared", "stdc++_static", "stdc++_shared") if toolchain:is_plat("windows") then toolchain:add("runtimes", "MT", "MTd", "MD", "MDd") end end -- check vc build tools sdk function check_vc_build_tools(toolchain, sdkdir, check) local opt = {} opt.sdkdir = sdkdir opt.vs_toolset = toolchain:config("vs_toolset") or config.get("vs_toolset") opt.vs_sdkver = toolchain:config("vs_sdkver") or config.get("vs_sdkver") local vcvarsall = find_vstudio.find_build_tools(opt) if not vcvarsall then return end local vcvars = vcvarsall[toolchain:arch()] if vcvars and vcvars.PATH and vcvars.INCLUDE and vcvars.LIB then toolchain:config_set("vcvars", vcvars) toolchain:config_set("vcarchs", table.orderkeys(vcvarsall)) toolchain:config_set("vs_toolset", vcvars.VCToolsVersion) toolchain:config_set("vs_sdkver", vcvars.WindowsSDKVersion) if check and check(toolchain, vcvars) then return vcvars end end end -- is the compatible with the host? function is_compatible_with_host(name) if is_host("linux", "macosx", "bsd") then if name:startswith("clang") or name:startswith("gcc") or name == "llvm" then return true end elseif is_host("windows") then if name == "msvc" or name == "llvm" or name == "clang-cl" then return true end end end -- get vs version function get_vsver(vs) local vsvers = {["2026"] = "18", ["2022"] = "17", ["2019"] = "16", ["2017"] = "15", ["2015"] = "14", ["2013"] = "12", ["2012"] = "11", ["2010"] = "10", ["2008"] = "9", ["2005"] = "8"} return assert(vsvers[vs], "unknown msvc version!") end -- get vs toolset version, e.g. v143, v144, .. function get_vs_toolset_ver(vs_toolset) local toolset_ver if vs_toolset then local verinfo = semver.new(vs_toolset) toolset_ver = "v" .. verinfo:major() .. (tostring(verinfo:minor()):sub(1, 1) or "0") -- @see https://github.com/xmake-io/xmake/pull/5176 if toolset_ver and toolset_ver == "v144" and verinfo:ge("14.40") and verinfo:lt("14.50") then toolset_ver = "v143" end end return toolset_ver end -- map compiler flags for package function map_compflags_for_package(package, langkind, name, values) -- @note we need to patch package:sourcekinds(), because it wiil be called nf_runtime for gcc/clang package.sourcekinds = function (self) local sourcekind = language.langkinds()[langkind] return sourcekind end local flags = compiler.map_flags(langkind, name, values, {target = package}) package.sourcekinds = nil return flags end -- map linker flags for package function map_linkflags_for_package(package, targetkind, sourcekinds, name, values) -- @note we need to patch package:sourcekinds(), because it wiil be called nf_runtime for gcc/clang package.sourcekinds = function (self) return sourcekinds end local flags = linker.map_flags(targetkind, sourcekinds, name, values, {target = package}) package.sourcekinds = nil return flags end -- Check and cache llvm/clang driver info (e.g. -print-resource-dir/-print-target-triple) in toolchain:config(). -- It must be collected during toolchain on_check so that toolchain on_load can use it without running clang again. -- @see https://github.com/xmake-io/xmake/issues/7337#issuecomment-3942499208 function check_llvm_info(toolchain, clang, opt) opt = opt or {} if not clang then return end local envs = opt.envs local resourcedir = try {function () return os.iorunv(clang, {"-print-resource-dir"}, {envs = envs}) end} if resourcedir then resourcedir = path.normalize(resourcedir:trim()) dprint("checking for llvm resource dir ... %s", resourcedir) if #resourcedir > 0 and os.isdir(resourcedir) then toolchain:config_set("llvm_resourcedir", resourcedir) end end local target_triple = try {function () return os.iorunv(clang, {"-print-target-triple"}, {envs = envs}) end} if target_triple then target_triple = target_triple:trim() dprint("checking for llvm target triple ... %s", target_triple) if #target_triple > 0 then toolchain:config_set("llvm_target_triple", target_triple) end end end -- get llvm sdk resource directory function _get_llvm_resourcedir(toolchain) return toolchain:config("llvm_resourcedir") or nil end -- get llvm sdk root directory function _get_llvm_rootdir(toolchain) local memcache = toolchain:memcache() local cachekey = "get_llvm_rootdir" local llvm_rootdir = memcache:get(cachekey) if llvm_rootdir == nil then local resourcedir = _get_llvm_resourcedir(toolchain) if resourcedir then llvm_rootdir = path.normalize(path.join(resourcedir, "..", "..", "..")) if not os.isdir(llvm_rootdir) then llvm_rootdir = nil end end memcache:set(cachekey, llvm_rootdir or false) end return llvm_rootdir or nil end -- get compiler-rt info function _get_llvm_compiler_rtinfo(toolchain) local memcache = toolchain:memcache() local cachekey = "get_llvm_compiler_rtinfo" local rtinfo = memcache:get(cachekey) if rtinfo == nil then local resourcedir = _get_llvm_resourcedir(toolchain) if resourcedir then local res_libdir = path.join(resourcedir, "lib") -- when -DLLVM_ENABLE_TARGET_RUNTIME_DIR=OFF rtdir is windows/ and rtlink is clang_rt.builtins_.lib -- when ON rtdir is windows/ and rtlink is clang_rt.builtins.lib local target_triple = _get_llvm_target_triple(toolchain) local arch = target_triple and target_triple:split("-")[1] local plat if toolchain:is_plat("windows", "mingw") then plat = "windows" elseif toolchain:is_plat("linux") then plat = "linux" elseif toolchain:is_plat("macosx", "iphoneos", "watchos", "appletvos", "applexros") then plat = "darwin" end local tripletdir = target_triple and path.join(res_libdir, "windows", target_triple) tripletdir = os.isdir(tripletdir) or nil local rtdir = tripletdir and path.join(plat, target_triple) or plat rtinfo = {rtdir = res_libdir, rtlibdir = path.join(res_libdir, rtdir)} if os.isdir(rtinfo.rtlibdir) and toolchain:is_plat("windows", "mingw") then local rtlink if tripletdir then rtlink = "clang_rt.builtins.lib" elseif arch then rtlink = "clang_rt.builtins-" .. arch .. ".lib" end if rtlink and os.isfile(path.join(rtinfo.rtlibdir, rtlink)) then rtinfo.rtlink = path.join(rtdir, rtlink) end end end memcache:set(cachekey, rtinfo or false) end return rtinfo or nil end -- get llvm target triple function _get_llvm_target_triple(toolchain) return toolchain:config("llvm_target_triple") or nil end -- get llvm toolchain dirs function get_llvm_dirs(toolchain) local memcache = toolchain:memcache() local cachekey = "get_llvm_dirs" local llvm_dirs = memcache:get(cachekey) if llvm_dirs == nil then local rootdir = toolchain:sdkdir() if not rootdir and (toolchain:is_plat("windows") or is_host("windows")) then rootdir = _get_llvm_rootdir(toolchain) end local bindir, libdir, cxxlibdir, includedir, cxxincludedir, resourcedir, rtdir, rtlink, rtlibdir local libcxx_static, libcxxabi_static if rootdir then bindir = path.join(rootdir, "bin") bindir = os.isdir(bindir) and bindir or nil libdir = path.join(rootdir, "lib") libdir = os.isdir(libdir) and libdir or nil if libdir then cxxlibdir = path.join(libdir, "c++") cxxlibdir = os.isdir(cxxlibdir) and cxxlibdir or nil if not cxxlibdir then local target_triple = _get_llvm_target_triple(toolchain) if target_triple then cxxlibdir = path.join(libdir, target_triple) cxxlibdir = os.isdir(cxxlibdir) and cxxlibdir or nil end end end -- detect the static c++ runtime archives (for --runtimes=c++_static with libc++) if libdir then local staticdirs = cxxlibdir and {cxxlibdir, libdir} or {libdir} for _, dir in ipairs(staticdirs) do if not libcxx_static and os.isfile(path.join(dir, "libc++.a")) then libcxx_static = path.join(dir, "libc++.a") end if not libcxxabi_static and os.isfile(path.join(dir, "libc++abi.a")) then libcxxabi_static = path.join(dir, "libc++abi.a") end end end includedir = path.join(rootdir, "include") includedir = os.isdir(includedir) and includedir or nil if includedir then cxxincludedir = path.join(includedir, "c++", "v1") cxxincludedir = os.isdir(cxxincludedir) and cxxincludedir or nil end resourcedir = _get_llvm_resourcedir(toolchain) local rtinfo = _get_llvm_compiler_rtinfo(toolchain) if rtinfo then rtdir = rtinfo.rtdir rtlink = rtinfo.rtlink rtlibdir = rtinfo.rtlibdir end end llvm_dirs = {rootdir = rootdir, bindir = bindir, libdir = libdir, cxxlibdir = cxxlibdir, includedir = includedir, cxxincludedir = cxxincludedir, resourcedir = resourcedir, rtdir = rtdir, rtlibdir = rtlibdir, rtlink = rtlink, libcxx_static = libcxx_static, libcxxabi_static = libcxxabi_static } memcache:set(cachekey, llvm_dirs) end return llvm_dirs end -- add runenvs for llvm function add_llvm_runenvs(toolchain) local dirs = get_llvm_dirs(toolchain) if dirs then if dirs.bindir and (toolchain:is_plat("windows") or is_host("windows")) then toolchain:add("runenvs", "PATH", dirs.bindir) end for _, dir in ipairs({dirs.libdir or false, dirs.cxxlibdir or false, dirs.rtlibdir or false}) do if dir then if toolchain:is_plat("windows") or is_host("windows") then toolchain:add("runenvs", "PATH", dir) elseif toolchain:is_plat("linux", "bsd") then toolchain:add("runenvs", "LD_LIBRARY_PATH", dir) elseif toolchain:is_plat("macosx") then -- using use DYLD_FALLBACK_LIBRARY_PATH instead of DYLD_LIBRARY_PATH to avoid symbols error when running homebrew llvm (which is linked to system libc++) -- e.g dyld[5195]: Symbol not found: __ZnwmSt19__type_descriptor_t -- Referenced from: <378C7CC2-7CD6-3B88-9C66-FE198E30462B> /usr/local/Cellar/llvm/21.1.5/bin/clang-21 -- Expected as weak-def export from some loaded dylibSymbol not found: __ZnamSt19__type_descriptor_t toolchain:add("runenvs", "DYLD_FALLBACK_LIBRARY_PATH", dir) end end end end end -- get sanitizer flags -- -- @param target the target or package -- @param opt the options, e.g. {checkmode = "address", sourcekind = "cxx"} -- -- @return the sanitizer flags, e.g. {cflags = {}, ldflags = {}} -- function get_sanitizer_flags(target, opt) opt = opt or {} local checkmode = opt.checkmode local sourcekind = opt.sourcekind -- add cflags local result = {} local flagnames = { cc = "cflags", cxx = "cxxflags", mm = "mflags", mxx = "mxxflags" } local flagname = flagnames[sourcekind] if flagname and target:has_tool(sourcekind, "cl", "clang", "clangxx", "clang_cl", "gcc", "gxx") then result[flagname] = "-fsanitize=" .. checkmode end -- add ldflags local ldflags = {} -- msvc does not have an fsanitize linker flag, so the 'link' tool is excluded if target:has_tool("ld", "clang", "clangxx", "gcc", "gxx") then table.insert(ldflags, "-fsanitize=" .. checkmode) end -- add windows ldflags if target:is_plat("windows") and checkmode == "address" and not target:has_tool("cxx", "cl") then assert(target:has_runtime("MD", "MT"), "clang asan only support MD/MT runtime on windows") if target:has_tool("cxx", "clang", "clangxx") then if target:has_runtime("MT") then table.insert(ldflags, "-D_MT") elseif target:has_runtime("MD") then table.join2(ldflags, {"-D_MT", "-D_DLL"}) end elseif target:has_tool("cxx", "clang_cl") then -- TODO: This is hack, try to find a way to let cmake use clang++ for link -- @see https://gitlab.kitware.com/cmake/cmake/-/issues/26430 local toolchain = target:toolchain("clang-cl") or target:toolchain("clang") local libdir = assert(get_llvm_dirs(toolchain).rtlibdir, "clang resource directory not found") local kind if target:has_runtime("MD") then kind = "dynamic" elseif target:has_runtime("MT") then kind = "static" end local driver = target:has_tool("ld", "lld_link", "link") and "" or "-Wl," local thunk = path.join(libdir, string.format("clang_rt.asan_%s_runtime_thunk-x86_64.lib", kind)) table.join2(ldflags, { path.unix(path.join(libdir, "clang_rt.asan_dynamic-x86_64.lib")), driver .. "/WHOLEARCHIVE:" .. path.unix(thunk), driver .. "/INFERASANLIBS:NO", }) end end if #ldflags > 0 then result.ldflags = ldflags result.shflags = ldflags end return result end -- get zig target function get_zig_target(toolchain) local zig_version = toolchain:config("zig_version") -- get target from cross only for cross-compilation -- @see https://github.com/xmake-io/xmake/issues/7180 local target if not target and toolchain:is_cross() then target = toolchain:cross() end -- get target from arch if not target then local arch if toolchain:is_arch("arm64", "arm64-v8a") then arch = "aarch64" elseif toolchain:is_arch("arm", "armv7") then arch = "arm" elseif toolchain:is_arch("i386", "x86") then if zig_version and semver.compare(zig_version, "0.11") >= 0 then arch = "x86" else arch = "i386" end elseif toolchain:is_arch("riscv64") then arch = "riscv64" elseif toolchain:is_arch("loong64") then arch = "loongarch64" elseif toolchain:is_arch("mips.*") then arch = toolchain:arch() elseif toolchain:is_arch("ppc64") then arch = "powerpc64" elseif toolchain:is_arch("ppc") then arch = "powerpc" elseif toolchain:is_arch("s390x") then arch = "s390x" else arch = "x86_64" end if toolchain:is_plat("cross") then -- xmake f -p cross --toolchain=zig --cross=mips64el-linux-gnuabi64 elseif toolchain:is_plat("macosx") then --@see https://github.com/ziglang/zig/issues/14226 target = arch .. "-macos-none" elseif toolchain:is_plat("linux") then if arch == "arm" then target = "arm-linux-gnueabi" elseif arch == "mips64" or arch == "mips64el" then target = arch .. "-linux-gnuabi64" else target = arch .. "-linux-gnu" end elseif toolchain:is_plat("windows") then target = arch .. "-windows-msvc" elseif toolchain:is_plat("mingw") then target = arch .. "-windows-gnu" end end return target end -- check if the file is a c++ header file extension function is_cxx_headerext(extension) -- prioritize .h* extensions to filter out most cases quickly if extension:startswith(".h") then return true end local headerexts = _g.headerexts if not headerexts then local other_header_extensions = { ".inl", ".ipp", ".tcc", ".tpl", ".inc" } headerexts = hashset.from(other_header_extensions) _g.headerexts = headerexts end return headerexts:has(extension) or false end