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

245 lines
6.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"
#define PAUSE_TIME 5
struct t670_ReadThis {
CURL *curl;
time_t origin;
int count;
};
static size_t t670_read_cb(char *ptr, size_t size, size_t nmemb, void *userp)
{
struct t670_ReadThis *pooh = (struct t670_ReadThis *)userp;
time_t delta;
if(size * nmemb < 1)
return 0;
switch(pooh->count++) {
case 0:
*ptr = '\x41'; /* ASCII A. */
return 1;
case 1:
pooh->origin = time(NULL);
return CURL_READFUNC_PAUSE;
case 2:
delta = time(NULL) - pooh->origin;
*ptr = delta >= PAUSE_TIME ? '\x42' : '\x41'; /* ASCII A or B. */
return 1;
case 3:
return 0;
}
curl_mfprintf(stderr, "Read callback called after EOF\n");
exit(1);
}
static int t670_xferinfo(void *clientp,
curl_off_t dltotal, curl_off_t dlnow,
curl_off_t ultotal, curl_off_t ulnow)
{
struct t670_ReadThis *pooh = (struct t670_ReadThis *)clientp;
(void)dltotal;
(void)dlnow;
(void)ultotal;
(void)ulnow;
if(pooh->origin) {
time_t delta = time(NULL) - pooh->origin;
if(delta >= 4 * PAUSE_TIME) {
curl_mfprintf(stderr, "unpausing failed: drain problem?\n");
return CURLE_ABORTED_BY_CALLBACK;
}
if(delta >= PAUSE_TIME)
curl_easy_pause(pooh->curl, CURLPAUSE_CONT);
}
return 0;
}
static CURLcode test_lib670(const char *URL)
{
static const char testname[] = "field";
curl_mime *mime = NULL;
struct curl_httppost *formpost = NULL;
struct t670_ReadThis pooh;
CURLcode result = TEST_ERR_FAILURE;
/*
* Check proper pausing/unpausing from a mime or form read callback.
*/
if(curl_global_init(CURL_GLOBAL_ALL) != CURLE_OK) {
curl_mfprintf(stderr, "curl_global_init() failed\n");
return TEST_ERR_MAJOR_BAD;
}
pooh.origin = (time_t)0;
pooh.count = 0;
pooh.curl = curl_easy_init();
/* First set the URL that is about to receive our POST. */
easy_setopt(pooh.curl, CURLOPT_URL, URL);
/* get verbose debug output please */
easy_setopt(pooh.curl, CURLOPT_VERBOSE, 1L);
/* include headers in the output */
easy_setopt(pooh.curl, CURLOPT_HEADER, 1L);
if(testnum == 670 || testnum == 671) {
curl_mimepart *part;
/* Build the mime tree. */
mime = curl_mime_init(pooh.curl);
part = curl_mime_addpart(mime);
result = curl_mime_name(part, testname);
if(result != CURLE_OK) {
curl_mfprintf(stderr,
"Something went wrong when building the "
"mime structure: %d\n", (int)result);
goto test_cleanup;
}
result = curl_mime_data_cb(part, (curl_off_t)2, t670_read_cb,
NULL, NULL, &pooh);
/* Bind mime data to its easy handle. */
if(result == CURLE_OK)
easy_setopt(pooh.curl, CURLOPT_MIMEPOST, mime);
}
else {
struct curl_httppost *lastptr = NULL;
CURLFORMcode formrc;
/* Build the form. */
formrc = curl_formadd(&formpost, &lastptr,
CURLFORM_COPYNAME, testname,
CURLFORM_STREAM, &pooh,
CURLFORM_CONTENTLEN, (curl_off_t)2,
CURLFORM_END);
if(formrc) {
curl_mfprintf(stderr, "curl_formadd() = %d\n", (int)formrc);
goto test_cleanup;
}
/* We want to use our own read function. */
easy_setopt(pooh.curl, CURLOPT_READFUNCTION, t670_read_cb);
/* Send a multi-part formpost. */
easy_setopt(pooh.curl, CURLOPT_HTTPPOST, formpost);
}
if(testnum == 670 || testnum == 672) {
CURLMcode mresult;
CURLM *multi;
/* Use the multi interface. */
multi = curl_multi_init();
mresult = curl_multi_add_handle(multi, pooh.curl);
while(!mresult) {
struct timeval timeout;
int rc = 0;
fd_set fdread;
fd_set fdwrite;
fd_set fdexcept;
int maxfd = -1;
int still_running = 0;
mresult = curl_multi_perform(multi, &still_running);
if(!still_running || mresult != CURLM_OK)
break;
if(pooh.origin) {
time_t delta = time(NULL) - pooh.origin;
if(delta >= 4 * PAUSE_TIME) {
curl_mfprintf(stderr, "unpausing failed: drain problem?\n");
result = CURLE_OPERATION_TIMEDOUT;
break;
}
if(delta >= PAUSE_TIME)
curl_easy_pause(pooh.curl, CURLPAUSE_CONT);
}
FD_ZERO(&fdread);
FD_ZERO(&fdwrite);
FD_ZERO(&fdexcept);
timeout.tv_sec = 0;
timeout.tv_usec = 1000000 * PAUSE_TIME / 10;
mresult = curl_multi_fdset(multi, &fdread, &fdwrite, &fdexcept, &maxfd);
if(mresult)
break;
#ifdef _WIN32
if(maxfd == -1)
curlx_wait_ms(100);
else
#endif
rc = select(maxfd + 1, &fdread, &fdwrite, &fdexcept, &timeout);
if(rc == -1) {
curl_mfprintf(stderr, "Select error\n");
break;
}
}
if(mresult != CURLM_OK)
for(;;) {
int msgs_left;
CURLMsg *msg;
msg = curl_multi_info_read(multi, &msgs_left);
if(!msg)
break;
if(msg->msg == CURLMSG_DONE) {
result = msg->data.result;
}
}
curl_multi_remove_handle(multi, pooh.curl);
curl_multi_cleanup(multi);
}
else {
/* Use the easy interface. */
easy_setopt(pooh.curl, CURLOPT_XFERINFODATA, &pooh);
easy_setopt(pooh.curl, CURLOPT_XFERINFOFUNCTION, t670_xferinfo);
easy_setopt(pooh.curl, CURLOPT_NOPROGRESS, 0L);
result = curl_easy_perform(pooh.curl);
}
test_cleanup:
curl_easy_cleanup(pooh.curl);
if(testnum == 670 || testnum == 671) {
curl_mime_free(mime);
}
else {
curl_formfree(formpost);
}
curl_global_cleanup();
return result;
}