Files
jak-project/third-party/curl/tests/unit/unit3301.c
T
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

143 lines
3.9 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 "unitcheck.h"
#include "curlx/wait.h"
#include "thrdqueue.h"
#include "curl_threads.h"
#ifdef USE_THREADS
struct unit3301_item {
int id;
BIT(processed);
};
struct unit3301_ctx {
volatile int event;
};
static struct unit3301_item *unit3301_item_create(int id)
{
struct unit3301_item *uitem;
uitem = curlx_calloc(1, sizeof(*uitem));
if(uitem) {
uitem->id = id;
curl_mfprintf(stderr, "created item %d\n", uitem->id);
}
return uitem;
}
static void unit3301_item_free(void *item)
{
struct unit3301_item *uitem = item;
curl_mfprintf(stderr, "free item %d\n", uitem->id);
curlx_free(uitem);
}
static void unit3301_event(const struct curl_thrdq *tqueue,
Curl_thrdq_event ev,
void *user_data)
{
struct unit3301_ctx *ctx = user_data;
(void)tqueue;
switch(ev) {
case CURL_THRDQ_EV_ITEM_DONE:
ctx->event = 1;
break;
default:
break;
}
}
static void unit3301_process(void *item)
{
struct unit3301_item *uitem = item;
curlx_wait_ms(1);
uitem->processed = TRUE;
}
static CURLcode test_unit3301(const char *arg)
{
UNITTEST_BEGIN_SIMPLE
struct curl_thrdq *tqueue;
struct unit3301_ctx ctx;
int i, count, nrecvd;
CURLcode result;
/* create and teardown queue */
memset(&ctx, 0, sizeof(ctx));
result = Curl_thrdq_create(&tqueue, "unit3301-a", 0, 0, 2, 1,
unit3301_item_free, unit3301_process,
unit3301_event, &ctx);
fail_unless(!result, "queue-a create");
Curl_thrdq_destroy(tqueue, TRUE);
tqueue = NULL;
fail_unless(!ctx.event, "queue-a unexpected done count");
/* create queue, have it process `count` items */
count = 10;
memset(&ctx, 0, sizeof(ctx));
result = Curl_thrdq_create(&tqueue, "unit3301-b", 0, 0, 2, 1,
unit3301_item_free, unit3301_process,
unit3301_event, &ctx);
fail_unless(!result, "queue-b create");
for(i = 0; i < count; ++i) {
struct unit3301_item *uitem = unit3301_item_create(i);
fail_unless(uitem, "queue-b item create");
result = Curl_thrdq_send(tqueue, uitem, NULL, 0);
fail_unless(!result, "queue-b send");
}
result = thrdq_await_done(tqueue, 0);
fail_unless(!result, "queue-b await done");
nrecvd = 0;
for(i = 0; i < count; ++i) {
void *item;
result = Curl_thrdq_recv(tqueue, &item);
fail_unless(!result, "queue-b recv");
if(item) {
struct unit3301_item *uitem = item;
curl_mfprintf(stderr, "received item %d\n", uitem->id);
++nrecvd;
fail_unless(uitem->processed, "queue-b recv unprocessed item");
unit3301_item_free(item);
}
}
Curl_thrdq_destroy(tqueue, TRUE);
tqueue = NULL;
fail_unless(nrecvd == count, "queue-b unexpected done count");
UNITTEST_END_SIMPLE
}
#else
static CURLcode test_unit3301(const char *arg)
{
UNITTEST_BEGIN_SIMPLE
UNITTEST_END_SIMPLE
}
#endif /* USE_THREADS */