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

141 lines
5.1 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 "urldata.h"
#include "url.h"
static CURLcode t1620_setup(void)
{
CURLcode result = CURLE_OK;
global_init(CURL_GLOBAL_ALL);
return result;
}
static void t1620_parse(const char *input,
const char *exp_username,
const char *exp_password,
const char *exp_options)
{
char *userstr = NULL;
char *passwdstr = NULL;
char *options = NULL;
CURLcode result = Curl_parse_login_details(input, strlen(input), &userstr,
&passwdstr, &options);
fail_unless(result == CURLE_OK, "Curl_parse_login_details() failed");
fail_unless(!!exp_username == !!userstr, "username expectation failed");
fail_unless(!!exp_password == !!passwdstr, "password expectation failed");
fail_unless(!!exp_options == !!options, "options expectation failed");
if(!unitfail) {
fail_unless(!userstr || !exp_username ||
!strcmp(userstr, exp_username),
"userstr should be equal to exp_username");
fail_unless(!passwdstr || !exp_password ||
!strcmp(passwdstr, exp_password),
"passwdstr should be equal to exp_password");
fail_unless(!options || !exp_options ||
!strcmp(options, exp_options),
"options should be equal to exp_options");
}
curlx_free(userstr);
curlx_free(passwdstr);
curlx_free(options);
}
static CURLcode test_unit1620(const char *arg)
{
UNITTEST_BEGIN(t1620_setup())
CURLcode result;
struct Curl_easy *empty;
struct Curl_easy *dupe = NULL;
enum dupstring i;
bool connected = FALSE;
result = Curl_open(&empty);
if(result)
goto unit_test_abort;
fail_unless(result == CURLE_OK, "Curl_open() failed");
result = Curl_connect(empty, &connected);
fail_unless(result == CURLE_URL_MALFORMAT,
"Curl_connect() failed to return CURLE_URL_MALFORMAT");
fail_unless(empty->magic == CURLEASY_MAGIC_NUMBER,
"empty->magic should be equal to CURLEASY_MAGIC_NUMBER");
/* double invoke to ensure no dependency on internal state */
result = Curl_connect(empty, &connected);
fail_unless(result == CURLE_URL_MALFORMAT,
"Curl_connect() failed to return CURLE_URL_MALFORMAT");
result = Curl_init_do(empty, empty->conn);
fail_unless(result == CURLE_OK, "Curl_init_do() failed");
result = curl_easy_setopt((CURL *)empty, CURLOPT_NOBODY, 1L);
fail_unless(result == CURLE_OK, "curl_easy_setopt(CURLOPT_NOBODY) failed");
dupe = (struct Curl_easy *)curl_easy_duphandle((CURL *)empty);
if(!dupe)
Curl_close(&empty);
abort_unless(dupe, "curl_easy_duphandle() failed");
result = Curl_init_do(dupe, NULL);
fail_unless(result == CURLE_OK, "Curl_init_do() on duplicate failed");
fail_unless(dupe->req.no_body, "duplicate handle should keep no_body");
fail_unless(dupe->state.httpreq == HTTPREQ_HEAD,
"duplicate handle should use HTTPREQ_HEAD");
t1620_parse("hostname", "hostname", NULL, NULL);
t1620_parse("user:password", "user", "password", NULL);
t1620_parse("user:password;options", "user", "password", "options");
t1620_parse("user:password;options;more", "user", "password",
"options;more");
t1620_parse("", "", NULL, NULL);
t1620_parse(":", "", "", NULL);
t1620_parse(":;", "", "", NULL);
t1620_parse(":password", "", "password", NULL);
t1620_parse(":password;", "", "password", NULL);
t1620_parse(";options", "", NULL, "options");
t1620_parse("user;options", "user", NULL, "options");
t1620_parse("user:;options", "user", "", "options");
t1620_parse("user;options:password", "user", "password", "options");
t1620_parse("user;options:", "user", "", "options");
Curl_freeset(empty);
for(i = (enum dupstring)0; i < STRING_LAST; i++) {
fail_unless(!empty->set.str[i], "Curl_free() did not set to NULL");
}
result = Curl_close(&dupe);
fail_unless(result == CURLE_OK, "Curl_close() failed for duplicate");
result = Curl_close(&empty);
fail_unless(result == CURLE_OK, "Curl_close() failed");
UNITTEST_END(curl_global_cleanup())
}