Files
Alexander J. Semenuk 5d5e35fb9b fix: Windows toolchain compatibility (curl 8.21 re-vendor, endless reconfigure loop) (#4355)
## 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)
2026-07-27 19:19:18 -04:00

323 lines
8.6 KiB
C
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
*
***************************************************************************/
#include "curl_setup.h"
#if defined(USE_SSL) && defined(USE_SSLS_EXPORT)
#include "urldata.h"
#include "curl_trc.h"
#include "vtls/vtls_scache.h"
#include "vtls/vtls_spack.h"
#include "curlx/strdup.h"
#define CURL_SPACK_VERSION 0x01
#define CURL_SPACK_IETF_ID 0x02
#define CURL_SPACK_VALID_UNTIL 0x03
#define CURL_SPACK_TICKET 0x04
#define CURL_SPACK_ALPN 0x05
#define CURL_SPACK_EARLYDATA 0x06
#define CURL_SPACK_QUICTP 0x07
static CURLcode spack_enc8(struct dynbuf *buf, uint8_t b)
{
return curlx_dyn_addn(buf, &b, 1);
}
static CURLcode spack_dec8(uint8_t *val, const uint8_t **src,
const uint8_t *end)
{
if(end - *src < 1)
return CURLE_READ_ERROR;
*val = **src;
*src += 1;
return CURLE_OK;
}
static CURLcode spack_enc16(struct dynbuf *buf, uint16_t val)
{
uint8_t nval[2];
nval[0] = (uint8_t)(val >> 8);
nval[1] = (uint8_t)val;
return curlx_dyn_addn(buf, nval, sizeof(nval));
}
static CURLcode spack_dec16(uint16_t *val, const uint8_t **src,
const uint8_t *end)
{
if(end - *src < 2)
return CURLE_READ_ERROR;
*val = (uint16_t)((*src)[0] << 8 | (*src)[1]);
*src += 2;
return CURLE_OK;
}
static CURLcode spack_enc32(struct dynbuf *buf, uint32_t val)
{
uint8_t nval[4];
nval[0] = (uint8_t)(val >> 24);
nval[1] = (uint8_t)(val >> 16);
nval[2] = (uint8_t)(val >> 8);
nval[3] = (uint8_t)val;
return curlx_dyn_addn(buf, nval, sizeof(nval));
}
static CURLcode spack_dec32(uint32_t *val, const uint8_t **src,
const uint8_t *end)
{
if(end - *src < 4)
return CURLE_READ_ERROR;
*val = (uint32_t)(*src)[0] << 24 | (uint32_t)(*src)[1] << 16 |
(uint32_t)(*src)[2] << 8 | (*src)[3];
*src += 4;
return CURLE_OK;
}
static CURLcode spack_enc64(struct dynbuf *buf, uint64_t val)
{
uint8_t nval[8];
nval[0] = (uint8_t)(val >> 56);
nval[1] = (uint8_t)(val >> 48);
nval[2] = (uint8_t)(val >> 40);
nval[3] = (uint8_t)(val >> 32);
nval[4] = (uint8_t)(val >> 24);
nval[5] = (uint8_t)(val >> 16);
nval[6] = (uint8_t)(val >> 8);
nval[7] = (uint8_t)val;
return curlx_dyn_addn(buf, nval, sizeof(nval));
}
static CURLcode spack_dec64(uint64_t *val, const uint8_t **src,
const uint8_t *end)
{
if(end - *src < 8)
return CURLE_READ_ERROR;
*val = (uint64_t)(*src)[0] << 56 | (uint64_t)(*src)[1] << 48 |
(uint64_t)(*src)[2] << 40 | (uint64_t)(*src)[3] << 32 |
(uint64_t)(*src)[4] << 24 | (uint64_t)(*src)[5] << 16 |
(uint64_t)(*src)[6] << 8 | (*src)[7];
*src += 8;
return CURLE_OK;
}
static CURLcode spack_encstr16(struct dynbuf *buf, const char *s)
{
size_t slen = strlen(s);
CURLcode result;
if(slen > UINT16_MAX)
return CURLE_BAD_FUNCTION_ARGUMENT;
result = spack_enc16(buf, (uint16_t)slen);
if(!result) {
result = curlx_dyn_addn(buf, s, slen);
}
return result;
}
static CURLcode spack_decstr16(char **val, const uint8_t **src,
const uint8_t *end)
{
uint16_t slen;
CURLcode result;
*val = NULL;
result = spack_dec16(&slen, src, end);
if(result)
return result;
if(end - *src < slen)
return CURLE_READ_ERROR;
*val = curlx_memdup0((const char *)(*src), slen);
*src += slen;
return *val ? CURLE_OK : CURLE_OUT_OF_MEMORY;
}
static CURLcode spack_encdata16(struct dynbuf *buf, const uint8_t *data,
size_t data_len)
{
CURLcode result;
if(data_len > UINT16_MAX)
return CURLE_BAD_FUNCTION_ARGUMENT;
result = spack_enc16(buf, (uint16_t)data_len);
if(!result) {
result = curlx_dyn_addn(buf, data, data_len);
}
return result;
}
static CURLcode spack_decdata16(uint8_t **val, size_t *val_len,
const uint8_t **src, const uint8_t *end)
{
uint16_t data_len;
CURLcode result;
*val = NULL;
result = spack_dec16(&data_len, src, end);
if(result)
return result;
if(end - *src < data_len)
return CURLE_READ_ERROR;
*val = curlx_memdup0((const char *)(*src), data_len);
*val_len = data_len;
*src += data_len;
return *val ? CURLE_OK : CURLE_OUT_OF_MEMORY;
}
CURLcode Curl_ssl_session_pack(struct Curl_easy *data,
struct Curl_ssl_session *s,
struct dynbuf *buf)
{
CURLcode result;
DEBUGASSERT(s->sdata);
DEBUGASSERT(s->sdata_len);
if(s->valid_until < 0)
return CURLE_BAD_FUNCTION_ARGUMENT;
result = spack_enc8(buf, CURL_SPACK_VERSION);
if(!result)
result = spack_enc8(buf, CURL_SPACK_TICKET);
if(!result)
result = spack_encdata16(buf, s->sdata, s->sdata_len);
if(!result)
result = spack_enc8(buf, CURL_SPACK_IETF_ID);
if(!result)
result = spack_enc16(buf, (uint16_t)s->ietf_tls_id);
if(!result)
result = spack_enc8(buf, CURL_SPACK_VALID_UNTIL);
if(!result)
result = spack_enc64(buf, (uint64_t)s->valid_until);
if(!result && s->alpn) {
result = spack_enc8(buf, CURL_SPACK_ALPN);
if(!result)
result = spack_encstr16(buf, s->alpn);
}
if(!result && s->earlydata_max) {
if(s->earlydata_max > UINT32_MAX)
result = CURLE_BAD_FUNCTION_ARGUMENT;
if(!result)
result = spack_enc8(buf, CURL_SPACK_EARLYDATA);
if(!result)
result = spack_enc32(buf, (uint32_t)s->earlydata_max);
}
if(!result && s->quic_tp && s->quic_tp_len) {
result = spack_enc8(buf, CURL_SPACK_QUICTP);
if(!result)
result = spack_encdata16(buf, s->quic_tp, s->quic_tp_len);
}
if(result)
CURL_TRC_SSLS(data, "error packing data: %d", (int)result);
return result;
}
CURLcode Curl_ssl_session_unpack(struct Curl_easy *data,
const void *bufv, size_t buflen,
struct Curl_ssl_session **ps)
{
struct Curl_ssl_session *s = NULL;
const unsigned char *buf = (const unsigned char *)bufv;
const unsigned char *end = buf + buflen;
uint8_t val8, *pval8;
uint16_t val16;
uint32_t val32;
uint64_t val64;
CURLcode result;
DEBUGASSERT(buf);
DEBUGASSERT(buflen);
*ps = NULL;
result = spack_dec8(&val8, &buf, end);
if(result)
goto out;
if(val8 != CURL_SPACK_VERSION) {
result = CURLE_READ_ERROR;
goto out;
}
s = curlx_calloc(1, sizeof(*s));
if(!s) {
result = CURLE_OUT_OF_MEMORY;
goto out;
}
while(buf < end) {
result = spack_dec8(&val8, &buf, end);
if(result)
goto out;
switch(val8) {
case CURL_SPACK_ALPN:
result = spack_decstr16(&s->alpn, &buf, end);
if(result)
goto out;
break;
case CURL_SPACK_EARLYDATA:
result = spack_dec32(&val32, &buf, end);
if(result)
goto out;
s->earlydata_max = val32;
break;
case CURL_SPACK_IETF_ID:
result = spack_dec16(&val16, &buf, end);
if(result)
goto out;
s->ietf_tls_id = val16;
break;
case CURL_SPACK_QUICTP: {
result = spack_decdata16(&pval8, &s->quic_tp_len, &buf, end);
if(result)
goto out;
s->quic_tp = pval8;
break;
}
case CURL_SPACK_TICKET: {
result = spack_decdata16(&pval8, &s->sdata_len, &buf, end);
if(result)
goto out;
s->sdata = pval8;
break;
}
case CURL_SPACK_VALID_UNTIL:
result = spack_dec64(&val64, &buf, end);
if(result)
goto out;
s->valid_until = (curl_off_t)val64;
break;
default: /* unknown tag */
result = CURLE_READ_ERROR;
goto out;
}
}
out:
if(result) {
CURL_TRC_SSLS(data, "error unpacking data: %d", (int)result);
Curl_ssl_session_destroy(s);
}
else
*ps = s;
return result;
}
#endif /* USE_SSL && USE_SSLS_EXPORT */