mirror of
https://github.com/open-goal/jak-project
synced 2026-08-27 00:23:50 -04:00
Alexander J. Semenuk
5d5e35fb9b
## Problem Windows builds break with a current local toolchain (Scoop LLVM 22.1.8, CMake 4.4.0, VS 2026), in two independent ways: 1. The build stops at curl's deliberate guard: `#error "no non-blocking method was found/used/set"` in `third-party/curl/lib/nonblock.c`. 2. From the second configure onward, `cmake --build` re-runs CMake in an endless loop (observed 42 consecutive reconfigure cycles in a single build). Likely the same mechanism behind the "endlessly building" VS 2026 note in `docs/setup/dev/vs.md`. ## Root cause 1. `third-party/curl/CMake/CurlTests.c` passes `int *` to `ioctlsocket()`, whose third parameter is `u_long *`. Clang 22 promotes `-Wincompatible-pointer-types` to a hard error in C, so the `HAVE_IOCTLSOCKET_FIONBIO` try_compile silently fails and `curl_config.h` never defines it. Upstream CI does not see this because the windows-2022 runner image ships an older LLVM. GCC 14 promotes the same warning to a hard error, which is very likely the `CurlTests.c.obj` failure reported from MSYS2 in open-goal/jak-project#3551. Upstream curl hit the identical problem with GCC 14 and fixed the probe in curl 8.8.0 (curl/curl#13578). 2. The root CMakeLists copies the build tree's `compile_commands.json` into `<src>/build/` for clangd using `configure_file()`, which registers its input as a configure dependency. CMake rewrites `compile_commands.json` late in every generation, after `CTestTestfile.cmake` and `cmake_install.cmake` (outputs of the same Ninja regen rule), so once the dependency is registered the rule is deterministically dirty and every `ninja` invocation re-runs CMake. A pristine first configure is safe (the file does not exist yet, so the `if(EXISTS ...)` guard skips the copy), which is why the loop looks machine- or IDE-specific. ## Fix 1. Per review, re-vendor `third-party/curl` at the `curl-8_21_0` tag (previously `curl-8_3_0`), which carries the upstream probe fix plus two years of upstream development; `vendor.yaml` updated to match. Adjustments the version jump forced: - curl 8.15 removed the native macOS Secure Transport backend (`CURL_USE_SECTRANSP`), so macOS now builds curl against OpenSSL like Linux. The two macOS workflows install Homebrew `openssl@3` and export `OPENSSL_ROOT_DIR` (keg-only), and the macOS setup docs gained the same two lines. - `CURL_BROTLI` / `CURL_ZSTD` switched to AUTO-detection in curl 8.10; pinned OFF to keep the previous no-compression behavior and avoid silently linking whatever the CI images happen to have. - curl's new top-level `BUILD_EXAMPLES` cache option (default ON) leaked into discord-rpc's identically named option and broke configure at a nonexistent `examples/send-presence` directory; pinned OFF ahead of the third-party subdirectories. The diff is dominated by the mechanical tag-tree swap under `third-party/curl` (linguist-vendored, collapsed in review). The hand-written changes are `CMakeLists.txt`, the two macOS workflows, `docs/setup/system/macos.md`, and `vendor.yaml`. 2. Swap `configure_file()` for `file(COPY ...)`: the same clangd copy with no configure dependency registered. (`file(COPY_FILE ... ONLY_IF_DIFFERENT)` would be cleaner still but requires CMake 3.21, above the declared `cmake_minimum_required(VERSION 3.10)`.) ## Test plan - [x] Fresh `cmake --preset Release-windows-clang` (LLVM 22, no cache seeding) completes and logs `Enabled SSL backends: Schannel`; the FIONBIO probe passes without the previous `#error` - [x] Full Windows Release build from scratch in the branch worktree (all 1422 targets) - [x] goalc-test suite: 1509 passed, 0 failed - [x] Second consecutive configure with `compile_commands.json` present: the regen rule in `build.ninja` has no `compile_commands.json` input; `<src>/build/compile_commands.json` is still refreshed for clangd - [x] Repeated `ninja` invocations after a full build no longer re-run CMake - [x] macOS Intel and ARM CI green (first exercise of the OpenSSL backend switch) --- I work off a self-hosted forge, so this GitHub account is quiet; the configure logs and ninja dirty-node traces from the investigation are available if anyone wants the raw data. (AI-assisted)
95 lines
3.3 KiB
Bash
Vendored
Generated
95 lines
3.3 KiB
Bash
Vendored
Generated
#!/bin/sh -x
|
|
# Copyright (C) Viktor Szakats
|
|
#
|
|
# SPDX-License-Identifier: curl
|
|
|
|
# shellcheck disable=SC2086
|
|
|
|
set -eu
|
|
|
|
cd "$(dirname "$0")"
|
|
|
|
mode="${1:-all}"; shift
|
|
|
|
cmake_consumer="${TEST_CMAKE_CONSUMER:-cmake}"
|
|
cmake_provider="${TEST_CMAKE_PROVIDER:-${cmake_consumer}}"
|
|
|
|
gen="${TEST_CMAKE_GENERATOR:-Ninja}"
|
|
|
|
cmake_opts='-DBUILD_CURL_EXE=OFF -DBUILD_LIBCURL_DOCS=OFF -DBUILD_MISC_DOCS=OFF -DENABLE_CURL_MANUAL=OFF'
|
|
|
|
src='../..'
|
|
|
|
runresults() {
|
|
set +x
|
|
for bin in "$1"/test-consumer*; do
|
|
file "${bin}" || true
|
|
${TEST_CMAKE_EXE_RUNNER:-} "${bin}" || true
|
|
done
|
|
set -x
|
|
}
|
|
|
|
if [ "${mode}" = 'all' ] || [ "${mode}" = 'ExternalProject' ]; then
|
|
(cd "${src}"; git archive --format=tar HEAD) | gzip > source.tar.gz
|
|
src="${PWD}/source.tar.gz"
|
|
sha="$(sha256sum "${src}" | grep -a -i -o -w -E '[0-9a-f]{64}')"
|
|
bldc='bld-externalproject'
|
|
rm -rf "${bldc}"
|
|
"${cmake_consumer}" -B "${bldc}" -G "${gen}" ${TEST_CMAKE_FLAGS:-} -DCURL_TEST_OPTS="${cmake_opts} -DCMAKE_UNITY_BUILD=ON $*" \
|
|
-DTEST_INTEGRATION_MODE=ExternalProject \
|
|
-DFROM_ARCHIVE="${src}" -DFROM_HASH="${sha}"
|
|
"${cmake_consumer}" --build "${bldc}" --verbose
|
|
runresults "${bldc}"
|
|
fi
|
|
|
|
if [ "${mode}" = 'all' ] || [ "${mode}" = 'FetchContent' ]; then
|
|
src="${PWD}/${src}"
|
|
bldc='bld-fetchcontent'
|
|
rm -rf "${bldc}"
|
|
"${cmake_consumer}" -B "${bldc}" -G "${gen}" ${cmake_opts} -DCMAKE_UNITY_BUILD=ON ${TEST_CMAKE_FLAGS:-} "$@" \
|
|
-DTEST_INTEGRATION_MODE=FetchContent \
|
|
-DFROM_GIT_REPO="${src}" \
|
|
-DFROM_GIT_TAG="$(git rev-parse HEAD)"
|
|
"${cmake_consumer}" --build "${bldc}" --verbose
|
|
PATH="${bldc}/_deps/curl-build/lib:${PATH}"
|
|
runresults "${bldc}"
|
|
fi
|
|
|
|
if [ "${mode}" = 'all' ] || [ "${mode}" = 'add_subdirectory' ]; then
|
|
rm -rf curl
|
|
if ! ln -s "${src}" curl; then
|
|
rm -rf curl; mkdir curl; (cd "${src}"; git archive --format=tar HEAD) | tar -x --directory=curl # for MSYS2/Cygwin
|
|
fi
|
|
bldc='bld-add_subdirectory'
|
|
rm -rf "${bldc}"
|
|
"${cmake_consumer}" -B "${bldc}" -G "${gen}" ${cmake_opts} -DCMAKE_UNITY_BUILD=ON ${TEST_CMAKE_FLAGS:-} "$@" \
|
|
-DTEST_INTEGRATION_MODE=add_subdirectory
|
|
"${cmake_consumer}" --build "${bldc}" --verbose
|
|
PATH="${bldc}/curl/lib:${PATH}"
|
|
runresults "${bldc}"
|
|
fi
|
|
|
|
if [ "${mode}" = 'all' ] || [ "${mode}" = 'find_package' ]; then
|
|
src="${PWD}/${src}"
|
|
bldp='bld-curl'
|
|
prefix="${PWD}/${bldp}/_pkg"
|
|
rm -rf "${bldp}"
|
|
"${cmake_provider}" -B "${bldp}" -S "${src}" -G "${gen}" ${cmake_opts} -DCMAKE_UNITY_BUILD=ON ${TEST_CMAKE_FLAGS:-} ${TEST_CMAKE_FLAGS_PROVIDER:-} "$@" \
|
|
-DBUILD_SHARED_LIBS=ON \
|
|
-DBUILD_STATIC_LIBS=ON \
|
|
-DCMAKE_INSTALL_PREFIX="${prefix}"
|
|
"${cmake_provider}" --build "${bldp}" --verbose
|
|
"${cmake_provider}" --install "${bldp}"
|
|
echo '::group::libcurl.pc'; cat "${prefix}"/lib/pkgconfig/*.pc || true; echo '::endgroup::'
|
|
echo '::group::curl-config.cmake'; cat "${prefix}"/lib/cmake/CURL/CURL* || true; echo '::endgroup::'
|
|
echo '::group::curl-config'; cat "${prefix}"/bin/curl-config || true; echo '::endgroup::'
|
|
bldc='bld-find_package'
|
|
rm -rf "${bldc}"
|
|
"${cmake_consumer}" -B "${bldc}" -G "${gen}" ${TEST_CMAKE_FLAGS:-} ${TEST_CMAKE_FLAGS_CONSUMER:-} \
|
|
-DTEST_INTEGRATION_MODE=find_package \
|
|
-DCMAKE_PREFIX_PATH="${prefix}/lib/cmake/CURL"
|
|
"${cmake_consumer}" --build "${bldc}" --verbose
|
|
PATH="${prefix}/bin:${PATH}"
|
|
runresults "${bldc}"
|
|
fi
|