path: root/xmake.lua

-- Copyright Epic Games, Inc. All Rights Reserved.

set_configvar("ZEN_SCHEMA_VERSION", 5) -- force state wipe after 0.2.31 causing bad data (dan.engelbrecht)
set_configvar("ZEN_DATA_FORCE_SCRUB_VERSION", 0)

set_allowedplats("windows", "linux", "macosx")
set_allowedarchs("windows|x64", "linux|x86_64", "macosx|x86_64", "macosx|arm64")

--------------------------------------------------------------------------
-- We support debug and release modes. On Windows we use static CRT to
-- minimize dependencies.

set_allowedmodes("debug", "release")
add_rules("mode.debug", "mode.release")

if is_plat("windows") then
    if false then
        -- DLL runtime
        if is_mode("debug") then
            set_runtimes("MDd") 
        else
            set_runtimes("MD")
        end
    else
        -- static runtime
        if is_mode("debug") then
            set_runtimes("MTd") 
        else
            set_runtimes("MT")
        end
    end
end

--------------------------------------------------------------------------
-- Sanitizers
--
-- https://xmake.io/api/description/builtin-policies.html#build-sanitizer-address
--
-- When using sanitizers, it may be necessary to change some configuration
-- options. In particular, you may want to use `--zensentry=no` to disable
-- Sentry support as it may not be compatible with some sanitizers. Also,
-- it may be necessary to disable mimalloc by using `--zenmimalloc=no`.

-- AddressSanitizer is supported on Windows (MSVC 2019+), Linux, and MacOS

local use_asan = false       -- Automatically disables Sentry when set to true
set_policy("build.sanitizer.address", use_asan)

-- ThreadSanitizer, MemorySanitizer, LeakSanitizer, and UndefinedBehaviorSanitizer
-- are supported on Linux and MacOS only.
--
-- You can enable these by editing the xmake.lua directly, or by passing the 
-- appropriate flags on the command line:
--
-- `xmake --policies=build.sanitizer.thread:y` for ThreadSanitizer, 
-- `xmake --policies=build.sanitizer.memory:y` for MemorySanitizer, etc.

-- When using TSAN you will want to also use the suppression tile to silence
-- known benign races. You do this by ensuring the the TSAN_OPTIONS environment
-- vriable is set to something like `TSAN_OPTIONS="suppressions=$(projectdir)/tsan.supp"`
--
-- `prompt> TSAN_OPTIONS="detect_deadlocks=0 suppressions=$(projectdir)/tsan.supp" xmake run zenserver`

--set_policy("build.sanitizer.thread", true) 
--set_policy("build.sanitizer.leak", true)
--set_policy("build.sanitizer.undefined", true)

-- In practice, this does not work because of the difficulty of compiling 
-- dependencies with MemorySanitizer. 
--set_policy("build.sanitizer.memory", true) 

--------------------------------------------------------------------------
-- Dependencies

add_repositories("zen-repo repo")
set_policy("build.ccache", false)
set_policy("package.precompiled", false)

add_defines("gsl_FEATURE_GSL_COMPATIBILITY_MODE=1") 
add_requires("gsl-lite", {system = false})
add_requires("http_parser", {system = false})
add_requires("json11", {system = false})
add_requires("lua", {system = false})
add_requires("lz4", {system = false})
add_requires("xxhash", {system = false})
add_requires("zlib", {system = false})

add_defines("EASTL_STD_ITERATOR_CATEGORY_ENABLED", "EASTL_DEPRECATIONS_FOR_2024_APRIL=EA_DISABLED")
add_requires("eastl", {system = false})

add_requires("consul", {system = false}) -- for hub tests
add_requires("nomad", {system = false}) -- for nomad provisioner tests
add_requires("oidctoken", {system = false})

if has_config("zenmimalloc") and not use_asan then
    add_requires("mimalloc", {system = false})
end

--------------------------------------------------------------------------
-- Crypto configuration. For reasons unknown each platform needs a 
-- different package

if is_plat("windows") then
    -- we use schannel on Windows
    add_defines("ZEN_USE_OPENSSL=0")
    add_requires("libcurl", {system = false})
elseif is_plat("linux", "macosx") then
    add_requires("openssl3", {system = false})
    add_defines("ZEN_USE_OPENSSL=1")
    add_requires("libcurl", {system = false, configs = {openssl3 = true}})
end

--------------------------------------------------------------------------

if is_plat("windows") then
    -- for bundling, Linux tries to compile from source which fails with UE toolchain, 
    -- fallback is regular zip
    add_requires("7z")
end

-- When using the UE clang toolchain, statically link the toolchain's libc++ and
-- libc++abi to avoid ABI mismatches with system libraries at runtime.
-- These are project-level flags (not in the toolchain definition) so they don't
-- propagate into cmake package builds.
if is_plat("linux") and get_config("toolchain") == "ue-clang" then
    add_ldflags("-static-libstdc++", {force = true})
    add_ldflags("$(projectdir)/thirdparty/ue-libcxx/lib64/libc++.a", {force = true})
    add_ldflags("$(projectdir)/thirdparty/ue-libcxx/lib64/libc++abi.a", {force = true})
    add_ldflags("-lpthread", {force = true})
end

if has_config("zensentry") and not use_asan then
    if is_plat("linux") then
        add_requires("sentry-native 0.12.1", {configs = {backend = "crashpad"}})
    elseif is_plat("windows") then
        add_requires("sentry-native 0.12.1", {debug = is_mode("debug"), configs = {backend = "crashpad"}})
    else
        add_requires("sentry-native 0.12.1", {configs = {backend = "crashpad"}})
    end
end

enable_unity = false

--add_rules("c++.unity_build")

if is_mode("release") then
    -- LTO does not appear to work with the current Linux UE toolchain
    -- Also, disabled LTO on Mac to reduce time spent building openssl tests
    if not is_plat("linux", "macosx") then
        set_policy("build.optimization.lto", true)
    end
    set_optimize("fastest")
end

if is_mode("debug") then
    add_defines("DEBUG")
end

if is_mode("debug") then
    add_defines("ZEN_WITH_TESTS=1")
else
    add_defines("ZEN_WITH_TESTS=0")
end

-- fmt 11+ requires utf-8 when using unicode
if is_os("windows") then
    set_encodings("utf-8")
else
    set_encodings("source:utf-8", "target:utf-8")
end

if is_os("windows") then
    add_defines(
        "_CRT_SECURE_NO_WARNINGS",
        "_UNICODE",
        "UNICODE",
        "_CONSOLE",
        "NOMINMAX",             -- stop Windows SDK defining 'min' and 'max'
        "NOGDI",                -- otherwise Windows.h defines 'GetObject'
        "WIN32_LEAN_AND_MEAN",  -- cut down Windows.h
        "_WIN32_WINNT=0x0A00",
        "_WINSOCK_DEPRECATED_NO_WARNINGS" -- let us use the ANSI functions
    )
    -- Make builds more deterministic and portable
    add_cxxflags("/d1trimfile:$(curdir)\\")     -- eliminates the base path from __FILE__ paths
    add_cxxflags("/experimental:deterministic") -- (more) deterministic compiler output
    add_ldflags("/PDBALTPATH:%_PDB%")           -- deterministic pdb reference in exe

    add_cxxflags("/Zc:preprocessor")        -- Enable preprocessor conformance mode
    add_cxxflags("/Zc:u8EscapeEncoding")    -- Enable UTF-8 encoding for u8 string literals
    add_cxxflags("/Zc:inline")              -- Enforce inline semantics
    -- add_ldflags("/MAP")
end

if is_os("linux") or is_os("macosx") then
    add_cxxflags("-Wno-implicit-fallthrough")
    add_cxxflags("-Wno-missing-field-initializers")
    add_cxxflags("-Wno-strict-aliasing")
    add_cxxflags("-Wno-switch")
    add_cxxflags("-Wno-unused-lambda-capture")
    add_cxxflags("-Wno-unused-private-field")
    add_cxxflags("-Wno-unused-value")
    add_cxxflags("-Wno-unused-variable")
    add_cxxflags("-Wno-vla-cxx-extension")
end

if get_config("toolchain") == "clang-cl" then
    add_cxxflags("-Wno-unknown-warning-option", {force=true})
    add_cxxflags("-Wno-cast-function-type-mismatch", {force=true})
    add_cxxflags("-Wno-delete-non-abstract-non-virtual-dtor", {force=true})
    add_cxxflags("-Wno-format", {force=true})
    add_cxxflags("-Wno-implicit-fallthrough", {force=true})
    add_cxxflags("-Wno-inconsistent-missing-override", {force=true})
    add_cxxflags("-Wno-missing-field-initializers", {force=true})
    add_cxxflags("-Wno-parentheses-equality", {force=true})
    add_cxxflags("-Wno-reorder-ctor", {force=true})
    add_cxxflags("-Wno-sign-compare", {force=true})
    add_cxxflags("-Wno-strict-aliasing", {force=true})
    add_cxxflags("-Wno-switch", {force=true})
    add_cxxflags("-Wno-unused-but-set-variable", {force=true})
    add_cxxflags("-Wno-unused-lambda-capture", {force=true})
    add_cxxflags("-Wno-unused-parameter", {force=true})
    add_cxxflags("-Wno-unused-private-field", {force=true})
    add_cxxflags("-Wno-unused-value", {force=true})
    add_cxxflags("-Wno-unused-variable", {force=true})
    add_cxxflags("-Wno-vla-cxx-extension", {force=true})
    add_cflags("-Wno-unknown-warning-option", {force=true})
    add_cflags("-Wno-unused-command-line-argument", {force=true})
end

if is_os("macosx") then
    -- silence warnings about -Wno-vla-cxx-extension since to my knowledge we can't
    -- detect the clang version used in Xcode and only recent versions contain this flag
    add_cxxflags("-Wno-unknown-warning-option")
end

if is_os("linux") then
    add_defines("_GNU_SOURCE")
end

-- Turn use of undefined cpp macros into errors
if is_os("windows") then
    add_cxxflags("/we4668")
else
    add_cxxflags("-Wundef")
end

function add_define_by_config(define, config_name)
    local value = has_config(config_name) and 1 or 0
    add_defines(define.."="..value)
end

option("zensentry")
    set_default(true)
    set_showmenu(true)
    set_description("Enables Sentry support")
option_end()
add_define_by_config("ZEN_USE_SENTRY", "zensentry")

option("zenmimalloc")
    set_default(not use_asan)
    set_showmenu(true)
    set_description("Use MiMalloc for faster memory management")
option_end()
add_define_by_config("ZEN_USE_MIMALLOC", "zenmimalloc")

option("zenrpmalloc")
    set_default(true)
    set_showmenu(true)
    set_description("Use rpmalloc for faster memory management")
option_end()
add_define_by_config("ZEN_USE_RPMALLOC", "zenrpmalloc")

if is_os("windows") then
    option("httpsys")
        set_default(true)
        set_showmenu(true)
        set_description("Enable http.sys server")
    option_end()
    add_define_by_config("ZEN_WITH_HTTPSYS", "httpsys")
else
    add_defines("ZEN_WITH_HTTPSYS=0")
end

local compute_default = false

option("zencompute")
    set_default(compute_default)
    set_showmenu(true)
    set_description("Enable compute services endpoint")
option_end()
add_define_by_config("ZEN_WITH_COMPUTE_SERVICES", "zencompute")

option("zenhorde")
    set_default(compute_default)
    set_showmenu(true)
    set_description("Enable Horde worker provisioning")
option_end()
add_define_by_config("ZEN_WITH_HORDE", "zenhorde")

option("zennomad")
    set_default(compute_default)
    set_showmenu(true)
    set_description("Enable Nomad worker provisioning")
option_end()
add_define_by_config("ZEN_WITH_NOMAD", "zennomad")


if is_os("windows") then
    add_defines("UE_MEMORY_TRACE_AVAILABLE=1")
    option("zenmemtrack")
        set_default(true)
        set_showmenu(true)
        set_description("Enable UE's Memory Trace support")
    option_end()
    add_define_by_config("ZEN_WITH_MEMTRACK", "zenmemtrack")
else
    add_defines("ZEN_WITH_MEMTRACK=0")
end

option("zentrace")
    set_default(true)
    set_showmenu(true)
    set_description("Enable UE's Trace support")
option_end()
add_define_by_config("ZEN_WITH_TRACE", "zentrace")

option("zencpr")
    set_default(true)
    set_showmenu(true)
    set_description("Enable CPR HTTP client backend")
option_end()
add_define_by_config("ZEN_WITH_CPR", "zencpr")

set_warnings("allextra", "error")
set_languages("cxx20")

-- always generate debug information
set_symbols("debug")

includes("toolchains")

-- Auto-select the UE clang toolchain on Linux when the SDK is available
if is_plat("linux") and not get_config("toolchain") then
    local ue_sdk = os.getenv("UE_TOOLCHAIN_DIR")
    if not ue_sdk or ue_sdk == "" then
        local home = os.getenv("HOME")
        if home then
            local default_path = path.join(home, ".ue-toolchain")
            if os.isdir(default_path) then
                ue_sdk = default_path
            end
        end
    end
    if ue_sdk and ue_sdk ~= "" and os.isdir(ue_sdk) then
        set_toolchains("ue-clang")
    end
end

includes("thirdparty")
includes("src/transports")
includes("src/zenbase")
includes("src/zencore",             "src/zencore-test")
includes("src/zenhttp",             "src/zenhttp-test")
includes("src/zennet",              "src/zennet-test")
includes("src/zenremotestore",      "src/zenremotestore-test")
includes("src/zencompute",          "src/zencompute-test")
if has_config("zenhorde") then
    includes("src/zenhorde")
end
if has_config("zennomad") then
    includes("src/zennomad")
end
includes("src/zenstore",            "src/zenstore-test")
includes("src/zentelemetry",        "src/zentelemetry-test")
includes("src/zenutil",             "src/zenutil-test")
if is_plat("windows") then
    includes("src/zenvfs")
end
includes("src/zenserver",           "src/zenserver-test")
includes("src/zen")
includes("src/zentest-appstub")

--------------------------------------------------------------------------

task("bundle")
    set_menu {
        usage = "xmake bundle",
        description = "Create Zip bundle from binaries",
        options = {
            {nil, "withtrace", "k", nil, "Compiles with trace support"},
            {nil, "codesignidentity", "v", nil, "Code signing identity"},
        }
    }
    on_run(function ()
        import("scripts.bundle")
        bundle()
    end)

task("kill")
    set_menu {
        usage = "xmake kill",
        description = "Terminate any running zenserver instances",
    }
    on_run(function ()
        local ok = try { function() os.execv("xmake", {"run", "zen", "down", "--all"}) end }
        if ok then return end
        if is_host("windows") then
            ok = try { function() os.runv("taskkill", {"/F", "/IM", "zenserver.exe"}) end }
            if ok then print("zenserver terminated") end
        else
            ok = try { function() os.runv("pkill", {"-f", "zenserver"}) end }
            if ok then print("zenserver terminated") end
        end
    end)

task("precommit")
    set_menu {
        usage = "xmake precommit",
        description = "Run required pre-commit steps (clang-format, etc)",
    }
    on_run(function ()
        print(os.exec("pre-commit run --all-files"))
    end)

task("sln")
    set_menu {
        usage = "xmake sln [--open]",
        description = "Generate IDE project files",
        options = {
            {'o', "open", "k", nil, "Open the generated project in the IDE after generation"},
        }
    }
    if is_os("windows") then
        on_run(function ()
            import("core.base.option")
            os.exec("xmake project --yes --kind=vsxmake2022 -m release,debug -a x64")
            if option.get("open") then
                local sln = path.join(os.projectdir(), "vsxmake2022", path.filename(os.projectdir()) .. ".sln")
                printf("opening %s\n", sln)
                try { function() os.execv("explorer", {sln}) end, catch { function() end } }
            end
        end)
    elseif is_os("macosx") then
        on_run(function ()
            import("core.base.option")
            os.exec("xmake project --yes --kind=xcode -m release,debug -a x64,arm64")
            if option.get("open") then
                local xcproj = path.join(os.projectdir(), path.filename(os.projectdir()) .. ".xcodeproj")
                printf("opening %s\n", xcproj)
                os.exec("open \"%s\"", xcproj)
            end
        end)
    end

task("test")
    set_menu {
        usage = "xmake test --run=[name|all] [-- extra-args...] (use --list to see available tests)",
        description = "Run Zen tests",
        options = {
            {'r', "run", "kv", "all", "Run test(s) - comma-separated"},
            {'l', "list", "k", nil, "List available test names"},
            {'j', "junit", "k", nil, "Enable junit report output"},
            {'n', "noskip", "k", nil, "Run skipped tests (passes --no-skip to doctest)"},
            {nil, "repeat", "kv", nil, "Repeat tests N times (stops on first failure)"},
            {'v', "verbose", "k", nil, "Route child process output to stdout (zenserver-test)"},
            {nil, "arguments", "vs", nil, "Extra arguments passed to test runners (after --)"}
        }
    }
    on_run(function()
        import("scripts.test")
        test()
    end)