mirror of
https://github.com/open-goal/jak-project
synced 2026-09-12 20:56:09 -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)
188 lines
7.3 KiB
CMake
Vendored
Generated
188 lines
7.3 KiB
CMake
Vendored
Generated
#***************************************************************************
|
|
# _ _ ____ _
|
|
# Project ___| | | | _ \| |
|
|
# / __| | | | |_) | |
|
|
# | (__| |_| | _ <| |___
|
|
# \___|\___/|_| \_\_____|
|
|
#
|
|
# Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
#
|
|
# This software is licensed as described in the file COPYING, which
|
|
# you should have received as part of this distribution. The terms
|
|
# are also available at https://curl.se/docs/copyright.html.
|
|
#
|
|
# You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
# copies of the Software, and permit persons to whom the Software is
|
|
# furnished to do so, under the terms of the COPYING file.
|
|
#
|
|
# This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
# KIND, either express or implied.
|
|
#
|
|
# SPDX-License-Identifier: curl
|
|
#
|
|
###########################################################################
|
|
# Find the ngtcp2 library
|
|
#
|
|
# This module accepts optional COMPONENTS to control the crypto library (these are
|
|
# mutually exclusive):
|
|
#
|
|
# - BoringSSL: Use `libngtcp2_crypto_boringssl`. (also for AWS-LC)
|
|
# - GnuTLS: Use `libngtcp2_crypto_gnutls`.
|
|
# - LibreSSL: Use `libngtcp2_crypto_libressl`. (requires ngtcp2 1.15.0+)
|
|
# - ossl: Use `libngtcp2_crypto_ossl`.
|
|
# - quictls: Use `libngtcp2_crypto_quictls`. (also for LibreSSL with ngtcp2 <1.15.0)
|
|
# - wolfSSL: Use `libngtcp2_crypto_wolfssl`.
|
|
#
|
|
# Input variables:
|
|
#
|
|
# - `NGTCP2_INCLUDE_DIR`: Absolute path to ngtcp2 include directory.
|
|
# - `NGTCP2_LIBRARY`: Absolute path to `ngtcp2` library.
|
|
# - `NGTCP2_CRYPTO_BORINGSSL_LIBRARY`: Absolute path to `ngtcp2_crypto_boringssl` library.
|
|
# - `NGTCP2_CRYPTO_GNUTLS_LIBRARY`: Absolute path to `ngtcp2_crypto_gnutls` library.
|
|
# - `NGTCP2_CRYPTO_LIBRESSL_LIBRARY`: Absolute path to `ngtcp2_crypto_libressl` library.
|
|
# - `NGTCP2_CRYPTO_OSSL_LIBRARY`: Absolute path to `ngtcp2_crypto_ossl` library.
|
|
# - `NGTCP2_CRYPTO_QUICTLS_LIBRARY`: Absolute path to `ngtcp2_crypto_quictls` library.
|
|
# - `NGTCP2_CRYPTO_WOLFSSL_LIBRARY`: Absolute path to `ngtcp2_crypto_wolfssl` library.
|
|
# - `NGTCP2_USE_STATIC_LIBS`: Configure for static ngtcp2 libraries.
|
|
#
|
|
# Defines:
|
|
#
|
|
# - `NGTCP2_FOUND`: System has ngtcp2.
|
|
# - `NGTCP2_VERSION`: Version of ngtcp2.
|
|
# - `NGTCP2_CRYPTO_BACKEND`: Name of the crypto library component. (Empty if COMPONENTS was not used.)
|
|
# - `CURL::ngtcp2`: ngtcp2 library target.
|
|
|
|
set(NGTCP2_CRYPTO_BACKEND "")
|
|
if(NGTCP2_FIND_COMPONENTS)
|
|
foreach(_component IN LISTS NGTCP2_FIND_COMPONENTS)
|
|
if(_component MATCHES "^(BoringSSL|GnuTLS|LibreSSL|ossl|quictls|wolfSSL)")
|
|
if(NGTCP2_CRYPTO_BACKEND)
|
|
message(FATAL_ERROR "NGTCP2: Only one crypto library can be selected")
|
|
endif()
|
|
set(NGTCP2_CRYPTO_BACKEND ${_component})
|
|
endif()
|
|
endforeach()
|
|
|
|
if(NGTCP2_CRYPTO_BACKEND)
|
|
string(TOLOWER "ngtcp2_crypto_${NGTCP2_CRYPTO_BACKEND}" _crypto_library_lower)
|
|
string(TOUPPER "ngtcp2_crypto_${NGTCP2_CRYPTO_BACKEND}" _crypto_library_upper)
|
|
endif()
|
|
endif()
|
|
|
|
set(_ngtcp2_pc_requires "libngtcp2")
|
|
if(NGTCP2_CRYPTO_BACKEND)
|
|
list(APPEND _ngtcp2_pc_requires "lib${_crypto_library_lower}")
|
|
endif()
|
|
|
|
set(_tried_pkgconfig FALSE)
|
|
if(NOT DEFINED NGTCP2_INCLUDE_DIR AND
|
|
NOT DEFINED NGTCP2_LIBRARY)
|
|
if(CURL_USE_PKGCONFIG)
|
|
find_package(PkgConfig QUIET)
|
|
pkg_check_modules(_ngtcp2 ${_ngtcp2_pc_requires})
|
|
set(_tried_pkgconfig TRUE)
|
|
endif()
|
|
if(NOT _ngtcp2_FOUND AND CURL_USE_CMAKECONFIG AND NGTCP2_CRYPTO_BACKEND)
|
|
find_package(ngtcp2 CONFIG QUIET)
|
|
# Skip using it if the crypto library target is not available
|
|
if(ngtcp2_CONFIG AND
|
|
NOT TARGET ngtcp2::${_crypto_library_lower}_static AND
|
|
NOT TARGET ngtcp2::${_crypto_library_lower})
|
|
unset(ngtcp2_CONFIG)
|
|
endif()
|
|
endif()
|
|
endif()
|
|
|
|
if(_ngtcp2_FOUND)
|
|
set(NGTCP2_FOUND TRUE)
|
|
set(NGTCP2_VERSION ${_ngtcp2_libngtcp2_VERSION})
|
|
if(NGTCP2_USE_STATIC_LIBS)
|
|
set(_ngtcp2_CFLAGS "${_ngtcp2_STATIC_CFLAGS}")
|
|
set(_ngtcp2_INCLUDE_DIRS "${_ngtcp2_STATIC_INCLUDE_DIRS}")
|
|
set(_ngtcp2_LIBRARY_DIRS "${_ngtcp2_STATIC_LIBRARY_DIRS}")
|
|
set(_ngtcp2_LIBRARIES "${_ngtcp2_STATIC_LIBRARIES}")
|
|
endif()
|
|
message(STATUS "Found NGTCP2 (via pkg-config): ${_ngtcp2_INCLUDE_DIRS} (found version \"${NGTCP2_VERSION}\")")
|
|
elseif(ngtcp2_CONFIG)
|
|
set(NGTCP2_FOUND TRUE)
|
|
set(NGTCP2_VERSION ${ngtcp2_VERSION})
|
|
if(NGTCP2_USE_STATIC_LIBS OR NOT TARGET ngtcp2::ngtcp2)
|
|
set(_ngtcp2_LIBRARIES ngtcp2::ngtcp2_static ngtcp2::${_crypto_library_lower}_static)
|
|
else()
|
|
set(_ngtcp2_LIBRARIES ngtcp2::ngtcp2 ngtcp2::${_crypto_library_lower})
|
|
endif()
|
|
message(STATUS "Found NGTCP2 (via CMake Config): ${ngtcp2_CONFIG} (found version \"${NGTCP2_VERSION}\")")
|
|
else()
|
|
find_path(NGTCP2_INCLUDE_DIR NAMES "ngtcp2/ngtcp2.h")
|
|
if(NGTCP2_USE_STATIC_LIBS)
|
|
set(_ngtcp2_CFLAGS "-DNGTCP2_STATICLIB")
|
|
find_library(NGTCP2_LIBRARY NAMES "ngtcp2_static" "ngtcp2")
|
|
else()
|
|
find_library(NGTCP2_LIBRARY NAMES "ngtcp2")
|
|
endif()
|
|
|
|
unset(NGTCP2_VERSION CACHE)
|
|
if(NGTCP2_INCLUDE_DIR AND EXISTS "${NGTCP2_INCLUDE_DIR}/ngtcp2/version.h")
|
|
set(_version_regex "#[\t ]*define[\t ]+NGTCP2_VERSION[\t ]+\"([^\"]*)\"")
|
|
file(STRINGS "${NGTCP2_INCLUDE_DIR}/ngtcp2/version.h" _version_str REGEX "${_version_regex}")
|
|
string(REGEX REPLACE "${_version_regex}" "\\1" _version_str "${_version_str}")
|
|
set(NGTCP2_VERSION "${_version_str}")
|
|
unset(_version_regex)
|
|
unset(_version_str)
|
|
endif()
|
|
|
|
if(NGTCP2_CRYPTO_BACKEND)
|
|
if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.20)
|
|
cmake_path(GET NGTCP2_LIBRARY PARENT_PATH _ngtcp2_library_dir)
|
|
else()
|
|
get_filename_component(_ngtcp2_library_dir "${NGTCP2_LIBRARY}" DIRECTORY)
|
|
endif()
|
|
if(NGTCP2_USE_STATIC_LIBS)
|
|
find_library(${_crypto_library_upper}_LIBRARY NAMES ${_crypto_library_lower}_static ${_crypto_library_lower}
|
|
HINTS ${_ngtcp2_library_dir})
|
|
else()
|
|
find_library(${_crypto_library_upper}_LIBRARY NAMES ${_crypto_library_lower}
|
|
HINTS ${_ngtcp2_library_dir})
|
|
endif()
|
|
|
|
if(${_crypto_library_upper}_LIBRARY)
|
|
set(NGTCP2_${NGTCP2_CRYPTO_BACKEND}_FOUND TRUE)
|
|
set(NGTCP2_CRYPTO_LIBRARY ${${_crypto_library_upper}_LIBRARY})
|
|
endif()
|
|
endif()
|
|
|
|
include(FindPackageHandleStandardArgs)
|
|
find_package_handle_standard_args(NGTCP2
|
|
REQUIRED_VARS
|
|
NGTCP2_INCLUDE_DIR
|
|
NGTCP2_LIBRARY
|
|
VERSION_VAR
|
|
NGTCP2_VERSION
|
|
HANDLE_COMPONENTS
|
|
)
|
|
|
|
if(NGTCP2_FOUND)
|
|
set(_ngtcp2_INCLUDE_DIRS ${NGTCP2_INCLUDE_DIR})
|
|
set(_ngtcp2_LIBRARIES ${NGTCP2_LIBRARY} ${NGTCP2_CRYPTO_LIBRARY})
|
|
endif()
|
|
|
|
mark_as_advanced(NGTCP2_INCLUDE_DIR NGTCP2_LIBRARY NGTCP2_CRYPTO_LIBRARY)
|
|
|
|
if(NOT NGTCP2_FOUND AND _tried_pkgconfig) # reset variables to allow another round of detection
|
|
unset(NGTCP2_INCLUDE_DIR CACHE)
|
|
unset(NGTCP2_LIBRARY CACHE)
|
|
endif()
|
|
endif()
|
|
|
|
if(NGTCP2_FOUND)
|
|
if(NOT TARGET CURL::ngtcp2)
|
|
add_library(CURL::ngtcp2 INTERFACE IMPORTED)
|
|
set_target_properties(CURL::ngtcp2 PROPERTIES
|
|
INTERFACE_LIBCURL_PC_MODULES "${_ngtcp2_pc_requires}"
|
|
INTERFACE_COMPILE_OPTIONS "${_ngtcp2_CFLAGS}"
|
|
INTERFACE_INCLUDE_DIRECTORIES "${_ngtcp2_INCLUDE_DIRS}"
|
|
INTERFACE_LINK_DIRECTORIES "${_ngtcp2_LIBRARY_DIRS}"
|
|
INTERFACE_LINK_LIBRARIES "${_ngtcp2_LIBRARIES}")
|
|
endif()
|
|
endif()
|