Files
jak-project/third-party/curl/tests/libtest/lib506.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

378 lines
10 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 "first.h"
#define THREADS 2
/* struct containing data of a thread */
struct t506_Tdata {
CURLSH *share;
char *url;
};
struct t506_userdata {
const char *text;
int share_counter;
int dns_counter;
int cookie_counter;
};
static int locks[3];
/* lock callback */
static void t506_test_lock(CURL *curl, curl_lock_data data,
curl_lock_access laccess, void *useptr)
{
const char *what;
struct t506_userdata *user = (struct t506_userdata *)useptr;
int locknum, *pcounter;
(void)curl;
(void)laccess;
switch(data) {
case CURL_LOCK_DATA_SHARE:
what = "share";
locknum = 0;
pcounter = &user->share_counter;
break;
case CURL_LOCK_DATA_DNS:
what = "dns";
locknum = 1;
pcounter = &user->dns_counter;
break;
case CURL_LOCK_DATA_COOKIE:
what = "cookie";
locknum = 2;
pcounter = &user->cookie_counter;
break;
default:
curl_mfprintf(stderr, "lock: no such data: %d\n", (int)data);
return;
}
/* detect locking of locked locks */
if(locks[locknum]) {
curl_mprintf("lock: double locked %s\n", what);
return;
}
locks[locknum]++;
curl_mprintf("lock: %-6s [%s]: %d\n", what, user->text, *pcounter);
(*pcounter)++;
}
/* unlock callback */
static void t506_test_unlock(CURL *curl, curl_lock_data data, void *useptr)
{
const char *what;
struct t506_userdata *user = (struct t506_userdata *)useptr;
int locknum, *pcounter;
(void)curl;
switch(data) {
case CURL_LOCK_DATA_SHARE:
what = "share";
locknum = 0;
pcounter = &user->share_counter;
break;
case CURL_LOCK_DATA_DNS:
what = "dns";
locknum = 1;
pcounter = &user->dns_counter;
break;
case CURL_LOCK_DATA_COOKIE:
what = "cookie";
pcounter = &user->cookie_counter;
locknum = 2;
break;
default:
curl_mfprintf(stderr, "unlock: no such data: %d\n", (int)data);
return;
}
/* detect unlocking of unlocked locks */
if(!locks[locknum]) {
curl_mprintf("unlock: double unlocked %s\n", what);
return;
}
locks[locknum]--;
curl_mprintf("unlock: %-6s [%s]: %d\n", what, user->text, *pcounter);
(*pcounter)++;
}
/* build host entry */
static struct curl_slist *sethost(struct curl_slist *headers)
{
(void)headers;
return curl_slist_append(NULL, "Host: www.host.foo.com");
}
/* the dummy thread function */
static void *t506_test_fire(void *ptr)
{
CURLcode result;
struct curl_slist *headers;
struct t506_Tdata *tdata = (struct t506_Tdata *)ptr;
CURL *curl;
curl = curl_easy_init();
if(!curl) {
curl_mfprintf(stderr, "curl_easy_init() failed\n");
return NULL;
}
headers = sethost(NULL);
curl_easy_setopt(curl, CURLOPT_VERBOSE, 1L);
curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(curl, CURLOPT_URL, tdata->url);
curl_easy_setopt(curl, CURLOPT_COOKIEFILE, "");
curl_mprintf("CURLOPT_SHARE\n");
curl_easy_setopt(curl, CURLOPT_SHARE, tdata->share);
curl_mprintf("PERFORM\n");
result = curl_easy_perform(curl);
if(result) {
int i = 0;
curl_mfprintf(stderr, "perform URL '%s' repeat %d failed, curlcode %d\n",
tdata->url, i, (int)result);
}
curl_mprintf("CLEANUP\n");
curl_easy_cleanup(curl);
curl_slist_free_all(headers);
return NULL;
}
/* test function */
static CURLcode test_lib506(const char *URL)
{
CURLcode result;
CURLSHcode scode = CURLSHE_OK;
CURLcode code = CURLE_OK;
char *url = NULL;
struct t506_Tdata tdata;
CURL *curl;
CURLSH *share;
struct curl_slist *headers = NULL;
struct curl_slist *cookies = NULL;
struct curl_slist *next_cookie = NULL;
int i;
struct t506_userdata user;
const char *jar = libtest_arg2;
memset(&user, 0, sizeof(user));
user.text = "Pigs in space";
curl_mprintf("GLOBAL_INIT\n");
if(curl_global_init(CURL_GLOBAL_ALL) != CURLE_OK) {
curl_mfprintf(stderr, "curl_global_init() failed\n");
return TEST_ERR_MAJOR_BAD;
}
/* prepare share */
curl_mprintf("SHARE_INIT\n");
share = curl_share_init();
if(!share) {
curl_mfprintf(stderr, "curl_share_init() failed\n");
curl_global_cleanup();
return TEST_ERR_MAJOR_BAD;
}
if(CURLSHE_OK == scode) {
curl_mprintf("CURLSHOPT_LOCKFUNC\n");
scode = curl_share_setopt(share, CURLSHOPT_LOCKFUNC, t506_test_lock);
}
if(CURLSHE_OK == scode) {
curl_mprintf("CURLSHOPT_UNLOCKFUNC\n");
scode = curl_share_setopt(share, CURLSHOPT_UNLOCKFUNC, t506_test_unlock);
}
if(CURLSHE_OK == scode) {
curl_mprintf("CURLSHOPT_USERDATA\n");
scode = curl_share_setopt(share, CURLSHOPT_USERDATA, &user);
}
if(CURLSHE_OK == scode) {
curl_mprintf("CURL_LOCK_DATA_COOKIE\n");
scode = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_COOKIE);
}
if(CURLSHE_OK == scode) {
curl_mprintf("CURL_LOCK_DATA_DNS\n");
scode = curl_share_setopt(share, CURLSHOPT_SHARE, CURL_LOCK_DATA_DNS);
}
if(CURLSHE_OK != scode) {
curl_mfprintf(stderr, "curl_share_setopt() failed\n");
curl_share_cleanup(share);
curl_global_cleanup();
return TEST_ERR_MAJOR_BAD;
}
/* initial cookie manipulation */
curl = curl_easy_init();
if(!curl) {
curl_mfprintf(stderr, "curl_easy_init() failed\n");
curl_share_cleanup(share);
curl_global_cleanup();
return TEST_ERR_MAJOR_BAD;
}
curl_mprintf("CURLOPT_SHARE\n");
easy_setopt(curl, CURLOPT_SHARE, share);
curl_mprintf("CURLOPT_COOKIELIST injected_and_clobbered\n");
easy_setopt(curl, CURLOPT_COOKIELIST,
"Set-Cookie: injected_and_clobbered=yes; "
"domain=host.foo.com; expires=Sat Feb 2 11:56:27 GMT 2030");
curl_mprintf("CURLOPT_COOKIELIST ALL\n");
easy_setopt(curl, CURLOPT_COOKIELIST, "ALL");
curl_mprintf("CURLOPT_COOKIELIST session\n");
easy_setopt(curl, CURLOPT_COOKIELIST, "Set-Cookie: session=elephants");
curl_mprintf("CURLOPT_COOKIELIST injected\n");
easy_setopt(curl, CURLOPT_COOKIELIST,
"Set-Cookie: injected=yes; domain=host.foo.com; "
"expires=Sat Feb 2 11:56:27 GMT 2030");
curl_mprintf("CURLOPT_COOKIELIST SESS\n");
easy_setopt(curl, CURLOPT_COOKIELIST, "SESS");
curl_mprintf("CLEANUP\n");
curl_easy_cleanup(curl);
/* start treads */
for(i = 1; i <= THREADS; i++) {
/* set thread data */
tdata.url = tutil_suburl(URL, i); /* must be curl_free()d */
tdata.share = share;
/* simulate thread, direct call of "thread" function */
curl_mprintf("*** run %d\n", i);
t506_test_fire(&tdata);
curl_free(tdata.url);
}
/* fetch another one and save cookies */
curl_mprintf("*** run %d\n", i);
curl = curl_easy_init();
if(!curl) {
curl_mfprintf(stderr, "curl_easy_init() failed\n");
curl_share_cleanup(share);
curl_global_cleanup();
return TEST_ERR_MAJOR_BAD;
}
url = tutil_suburl(URL, i);
headers = sethost(NULL);
easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
easy_setopt(curl, CURLOPT_URL, url);
curl_mprintf("CURLOPT_SHARE\n");
easy_setopt(curl, CURLOPT_SHARE, share);
curl_mprintf("CURLOPT_COOKIEJAR\n");
easy_setopt(curl, CURLOPT_COOKIEJAR, jar);
curl_mprintf("CURLOPT_COOKIELIST FLUSH\n");
easy_setopt(curl, CURLOPT_COOKIELIST, "FLUSH");
curl_mprintf("PERFORM\n");
curl_easy_perform(curl);
curl_mprintf("CLEANUP\n");
curl_easy_cleanup(curl);
curl_free(url);
curl_slist_free_all(headers);
/* load cookies */
curl = curl_easy_init();
if(!curl) {
curl_mfprintf(stderr, "curl_easy_init() failed\n");
curl_share_cleanup(share);
curl_global_cleanup();
return TEST_ERR_MAJOR_BAD;
}
url = tutil_suburl(URL, i);
headers = sethost(NULL);
easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
easy_setopt(curl, CURLOPT_URL, url);
curl_mprintf("CURLOPT_SHARE\n");
easy_setopt(curl, CURLOPT_SHARE, share);
curl_mprintf("CURLOPT_COOKIELIST ALL\n");
easy_setopt(curl, CURLOPT_COOKIELIST, "ALL");
curl_mprintf("CURLOPT_COOKIEJAR\n");
easy_setopt(curl, CURLOPT_COOKIEFILE, jar);
curl_mprintf("CURLOPT_COOKIELIST RELOAD\n");
easy_setopt(curl, CURLOPT_COOKIELIST, "RELOAD");
result = CURLE_OK;
code = curl_easy_getinfo(curl, CURLINFO_COOKIELIST, &cookies);
if(code != CURLE_OK) {
curl_mfprintf(stderr, "curl_easy_getinfo() failed\n");
result = TEST_ERR_MAJOR_BAD;
goto test_cleanup;
}
curl_mprintf("loaded cookies:\n");
if(!cookies) {
curl_mfprintf(stderr, " reloading cookies from '%s' failed\n", jar);
result = TEST_ERR_MAJOR_BAD;
goto test_cleanup;
}
curl_mprintf("-----------------\n");
next_cookie = cookies;
while(next_cookie) {
curl_mprintf(" %s\n", next_cookie->data);
next_cookie = next_cookie->next;
}
curl_mprintf("-----------------\n");
curl_slist_free_all(cookies);
/* try to free share, expect to fail because share is in use */
curl_mprintf("try SHARE_CLEANUP...\n");
scode = curl_share_cleanup(share);
if(scode == CURLSHE_OK) {
curl_mfprintf(stderr, "curl_share_cleanup succeed but error expected\n");
share = NULL;
}
else {
curl_mprintf("SHARE_CLEANUP failed, correct\n");
}
test_cleanup:
/* clean up last handle */
curl_mprintf("CLEANUP\n");
curl_easy_cleanup(curl);
curl_slist_free_all(headers);
curl_free(url);
/* free share */
curl_mprintf("SHARE_CLEANUP\n");
scode = curl_share_cleanup(share);
if(scode != CURLSHE_OK)
curl_mfprintf(stderr, "curl_share_cleanup failed, code errno %d\n",
(int)scode);
curl_mprintf("GLOBAL_CLEANUP\n");
curl_global_cleanup();
return result;
}