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

358 lines
9.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 "first.h"
struct t582_Sockets {
curl_socket_t *sockets;
int count; /* number of sockets actually stored in array */
int max_count; /* max number of sockets that fit in allocated array */
};
struct t582_ReadWriteSockets {
struct t582_Sockets read, write;
};
/**
* Remove a file descriptor from a sockets array.
*/
static void t582_removeFd(struct t582_Sockets *sockets, curl_socket_t fd,
int mention)
{
int i;
if(mention)
curl_mfprintf(stderr, "Remove socket fd %" FMT_SOCKET_T "\n", fd);
for(i = 0; i < sockets->count; ++i) {
if(sockets->sockets[i] == fd) {
if(i < sockets->count - 1)
memmove(&sockets->sockets[i], &sockets->sockets[i + 1],
sizeof(curl_socket_t) * (sockets->count - (i + 1)));
--sockets->count;
}
}
}
/**
* Add a file descriptor to a sockets array.
*/
static void t582_addFd(struct t582_Sockets *sockets, curl_socket_t fd,
const char *what)
{
/**
* To ensure we only have each file descriptor once, we remove it then add
* it again.
*/
curl_mfprintf(stderr, "Add socket fd %" FMT_SOCKET_T " for %s\n", fd, what);
t582_removeFd(sockets, fd, 0);
/*
* Allocate array storage when required.
*/
if(!sockets->sockets) {
sockets->sockets = curlx_malloc(sizeof(curl_socket_t) * 20U);
if(!sockets->sockets)
return;
sockets->max_count = 20;
}
else if(sockets->count >= sockets->max_count) {
/* this cannot happen in normal cases */
curl_mfprintf(stderr, "too many file handles error\n");
exit(2);
}
/*
* Add file descriptor to array.
*/
sockets->sockets[sockets->count] = fd;
++sockets->count;
}
/**
* Callback invoked by curl to poll reading / writing of a socket.
*/
static int t582_curlSocketCallback(CURL *curl, curl_socket_t s, int action,
void *userp, void *socketp)
{
struct t582_ReadWriteSockets *sockets = userp;
(void)curl;
(void)socketp;
if(action == CURL_POLL_IN || action == CURL_POLL_INOUT)
t582_addFd(&sockets->read, s, "read");
if(action == CURL_POLL_OUT || action == CURL_POLL_INOUT)
t582_addFd(&sockets->write, s, "write");
if(action == CURL_POLL_REMOVE) {
t582_removeFd(&sockets->read, s, 1);
t582_removeFd(&sockets->write, s, 0);
}
return 0;
}
/**
* Callback invoked by curl to set a timeout.
*/
static int t582_curlTimerCallback(CURLM *multi, long timeout_ms, void *userp)
{
struct curltime *timeout = userp;
(void)multi;
if(timeout_ms != -1) {
*timeout = curlx_now();
timeout->tv_usec += (int)timeout_ms * 1000;
}
else {
timeout->tv_sec = -1;
}
return 0;
}
/**
* Check for curl completion.
*/
static int t582_checkForCompletion(CURLM *multi, int *success)
{
int result = 0;
*success = 0;
while(1) {
int numMessages;
CURLMsg *message = curl_multi_info_read(multi, &numMessages);
if(!message)
break;
if(message->msg == CURLMSG_DONE) {
result = 1;
if(message->data.result == CURLE_OK)
*success = 1;
else
*success = 0;
}
else {
curl_mfprintf(stderr, "Got an unexpected message from curl: %d\n",
(int)message->msg);
result = 1;
*success = 0;
}
}
return result;
}
static ssize_t t582_getMicroSecondTimeout(struct curltime *timeout)
{
struct curltime now;
ssize_t result;
now = curlx_now();
result = (ssize_t)(((timeout->tv_sec - now.tv_sec) * 1000000) +
timeout->tv_usec - now.tv_usec);
if(result < 0)
result = 0;
return result;
}
/**
* Update a fd_set with all of the sockets in use.
*/
static void t582_updateFdSet(struct t582_Sockets *sockets, fd_set *fdset,
curl_socket_t *maxFd)
{
int i;
for(i = 0; i < sockets->count; ++i) {
FD_SET(sockets->sockets[i], fdset);
if(*maxFd < sockets->sockets[i] + 1) {
*maxFd = sockets->sockets[i] + 1;
}
}
}
static void notifyCurl(CURLM *multi, curl_socket_t s, int evBitmask,
const char *info)
{
int numhandles = 0;
CURLMcode mresult = curl_multi_socket_action(multi, s, evBitmask,
&numhandles);
if(mresult != CURLM_OK) {
curl_mfprintf(stderr, "curl error on %s (%d) %s\n",
info, mresult, curl_multi_strerror(mresult));
}
}
/**
* Invoke curl when a file descriptor is set.
*/
static void t582_checkFdSet(CURLM *multi, struct t582_Sockets *sockets,
fd_set *fdset, int evBitmask, const char *name)
{
int i;
for(i = 0; i < sockets->count; ++i) {
if(FD_ISSET(sockets->sockets[i], fdset)) {
notifyCurl(multi, sockets->sockets[i], evBitmask, name);
}
}
}
static CURLcode test_lib582(const char *URL)
{
CURLcode result = CURLE_OK;
CURL *curl = NULL;
char errbuf[STRERROR_LEN];
FILE *hd_src = NULL;
int hd;
curlx_struct_stat file_info;
CURLM *multi = NULL;
struct t582_ReadWriteSockets sockets = { { NULL, 0, 0 }, { NULL, 0, 0 } };
int success = 0;
struct curltime timeout = { 0 };
timeout.tv_sec = (time_t)-1;
assert(test_argc >= 5);
start_test_timing();
if(!libtest_arg3) {
curl_mfprintf(stderr, "Usage: lib582 [url] [filename] [username]\n");
return TEST_ERR_USAGE;
}
hd_src = curlx_fopen(libtest_arg2, "rb");
if(!hd_src) {
curl_mfprintf(stderr, "fopen() failed with error (%d) %s\n",
errno, curlx_strerror(errno, errbuf, sizeof(errbuf)));
curl_mfprintf(stderr, "Error opening file '%s'\n", libtest_arg2);
return TEST_ERR_FOPEN;
}
/* get the file size of the local file */
hd = curlx_fstat(fileno(hd_src), &file_info);
if(hd == -1) {
/* cannot open file, bail out */
curl_mfprintf(stderr, "fstat() failed with error (%d) %s\n",
errno, curlx_strerror(errno, errbuf, sizeof(errbuf)));
curl_mfprintf(stderr, "Error opening file '%s'\n", libtest_arg2);
curlx_fclose(hd_src);
return TEST_ERR_FSTAT;
}
curl_mfprintf(stderr, "Set to upload %" CURL_FORMAT_CURL_OFF_T " bytes\n",
(curl_off_t)file_info.st_size);
res_global_init(CURL_GLOBAL_ALL);
if(result != CURLE_OK) {
curlx_fclose(hd_src);
return result;
}
easy_init(curl);
/* enable uploading */
easy_setopt(curl, CURLOPT_UPLOAD, 1L);
/* specify target */
easy_setopt(curl, CURLOPT_URL, URL);
/* go verbose */
easy_setopt(curl, CURLOPT_VERBOSE, 1L);
/* now specify which file to upload */
easy_setopt(curl, CURLOPT_READDATA, hd_src);
easy_setopt(curl, CURLOPT_USERPWD, libtest_arg3);
easy_setopt(curl, CURLOPT_SSH_PUBLIC_KEYFILE, test_argv[4]);
easy_setopt(curl, CURLOPT_SSH_PRIVATE_KEYFILE, test_argv[5]);
easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
easy_setopt(curl, CURLOPT_INFILESIZE_LARGE, (curl_off_t)file_info.st_size);
multi_init(multi);
multi_setopt(multi, CURLMOPT_SOCKETFUNCTION, t582_curlSocketCallback);
multi_setopt(multi, CURLMOPT_SOCKETDATA, &sockets);
multi_setopt(multi, CURLMOPT_TIMERFUNCTION, t582_curlTimerCallback);
multi_setopt(multi, CURLMOPT_TIMERDATA, &timeout);
multi_add_handle(multi, curl);
while(!t582_checkForCompletion(multi, &success)) {
fd_set readSet, writeSet;
curl_socket_t maxFd = 0;
struct timeval tv = { 0 };
tv.tv_sec = 10;
FD_ZERO(&readSet);
FD_ZERO(&writeSet);
t582_updateFdSet(&sockets.read, &readSet, &maxFd);
t582_updateFdSet(&sockets.write, &writeSet, &maxFd);
if(timeout.tv_sec != (time_t)-1) {
int usTimeout = curlx_sztosi(t582_getMicroSecondTimeout(&timeout));
tv.tv_sec = usTimeout / 1000000;
tv.tv_usec = usTimeout % 1000000;
}
else if(maxFd <= 0) {
tv.tv_sec = 0;
tv.tv_usec = 100000;
}
select_test((int)maxFd, &readSet, &writeSet, NULL, &tv);
/* Check the sockets for reading / writing */
t582_checkFdSet(multi, &sockets.read, &readSet, CURL_CSELECT_IN,
"read");
t582_checkFdSet(multi, &sockets.write, &writeSet, CURL_CSELECT_OUT,
"write");
if(timeout.tv_sec != (time_t)-1 &&
t582_getMicroSecondTimeout(&timeout) == 0) {
/* curl's timer has elapsed. */
notifyCurl(multi, CURL_SOCKET_TIMEOUT, 0, "timeout");
}
abort_on_test_timeout();
}
if(!success) {
curl_mfprintf(stderr, "Error uploading file.\n");
result = TEST_ERR_MAJOR_BAD;
}
test_cleanup:
/* proper cleanup sequence - type PB */
curl_multi_remove_handle(multi, curl);
curl_easy_cleanup(curl);
curl_multi_cleanup(multi);
curl_global_cleanup();
/* close the local file */
curlx_fclose(hd_src);
/* free local memory */
curlx_free(sockets.read.sockets);
curlx_free(sockets.write.sockets);
return result;
}