mirror of
https://github.com/open-goal/jak-project
synced 2026-08-20 22:35:07 -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)
86 lines
3.0 KiB
Markdown
Vendored
Generated
86 lines
3.0 KiB
Markdown
Vendored
Generated
<!--
|
|
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
|
SPDX-License-Identifier: curl
|
|
-->
|
|
|
|
# Rustls
|
|
|
|
[Rustls is a TLS backend written in Rust](https://docs.rs/rustls/). curl can
|
|
be built to use it as an alternative to OpenSSL or other TLS backends. We use
|
|
the [rustls-ffi C bindings](https://github.com/rustls/rustls-ffi). This
|
|
version of curl is compatible with `rustls-ffi` v0.15.x.
|
|
|
|
## Getting rustls-ffi
|
|
|
|
To build `curl` with `rustls` support you need to have `rustls-ffi` available first.
|
|
There are three options for this:
|
|
|
|
1. Install it from your package manager, if available.
|
|
2. Download pre-built binaries.
|
|
3. Build it from source.
|
|
|
|
### Installing rustls-ffi from a package manager
|
|
|
|
See the [rustls-ffi README] for packaging status. Availability and details for installation
|
|
differ between distributions.
|
|
|
|
Once installed, build `curl` using `--with-rustls`.
|
|
|
|
% git clone --depth 1 https://github.com/curl/curl
|
|
% cd curl
|
|
% autoreconf -fi
|
|
% ./configure --with-rustls
|
|
% make
|
|
|
|
[rustls-ffi README]: https://github.com/rustls/rustls-ffi?tab=readme-ov-file
|
|
|
|
### Downloading pre-built rustls-ffi binaries
|
|
|
|
Pre-built binaries are available on the [releases page] on GitHub for releases since 0.15.0.
|
|
Download the appropriate archive for your platform and extract it to a directory of your choice
|
|
(e.g. `${HOME}/rustls-ffi-built`).
|
|
|
|
Once downloaded, build `curl` using `--with-rustls` and the path to the extracted binaries.
|
|
|
|
% git clone --depth 1 https://github.com/curl/curl
|
|
% cd curl
|
|
% autoreconf -fi
|
|
% ./configure --with-rustls=${HOME}/rustls-ffi-built
|
|
% make
|
|
|
|
[releases page]: https://github.com/rustls/rustls-ffi/releases
|
|
|
|
### Building rustls-ffi from source
|
|
|
|
Building `rustls-ffi` from source requires both a rust compiler, and the [cargo-c] cargo plugin.
|
|
|
|
To install a Rust compiler, use [rustup] or your package manager to install
|
|
the **1.73** or newer toolchain.
|
|
|
|
To install `cargo-c`, use your [package manager][cargo-c pkg], download
|
|
[a pre-built archive][cargo-c prebuilt], or build it from source with `cargo install cargo-c`.
|
|
|
|
Next, check out, build, and install the appropriate version of `rustls-ffi` using `cargo`:
|
|
|
|
% git clone --depth 1 --branch v0.15.3 https://github.com/rustls/rustls-ffi
|
|
% cd rustls-ffi
|
|
% cargo capi install --release --prefix=${HOME}/rustls-ffi-built
|
|
|
|
Now configure and build `curl` using `--with-rustls`:
|
|
|
|
% git clone --depth 1 https://github.com/curl/curl
|
|
% cd curl
|
|
% autoreconf -fi
|
|
% ./configure --with-rustls=${HOME}/rustls-ffi-built
|
|
% make
|
|
|
|
See the [rustls-ffi README][cryptography provider] for more information on cryptography providers and
|
|
their build/platform requirements.
|
|
|
|
[cargo-c]: https://github.com/lu-zero/cargo-c
|
|
[rustup]: https://rustup.rs/
|
|
[cargo-c pkg]: https://github.com/lu-zero/cargo-c?tab=readme-ov-file#availability
|
|
[cargo-c prebuilt]: https://github.com/lu-zero/cargo-c/releases
|
|
[cryptography provider]: https://github.com/cpu/rustls-ffi?tab=readme-ov-file#cryptography-provider
|