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

201 lines
7.2 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" /* for curlx_safefree */
struct etest {
const char *input;
size_t ilen;
const char *output;
size_t olen;
};
static CURLcode test_unit1302(const char *arg)
{
UNITTEST_BEGIN_SIMPLE
CURLcode result;
unsigned int i;
/* common base64 encoding */
struct etest encode[] = {
{ "iiiiii", 1, "aQ==", 4 },
{ "iiiiii", 2, "aWk=", 4 },
{ "iiiiii", 3, "aWlp", 4 },
{ "iiiiii", 4, "aWlpaQ==", 8 },
{ "iiiiii", 5, "aWlpaWk=", 8 },
{ "iiiiii", 6, "aWlpaWlp", 8 },
{ "iiiiiii", 7, "aWlpaWlpaQ==", 12 },
{ "iiiiiiii", 8, "aWlpaWlpaWk=", 12 },
{ "iiiiiiiii", 9, "aWlpaWlpaWlp", 12 },
{ "iiiiiiiiii", 10, "aWlpaWlpaWlpaQ==", 16 },
{ "iiiiiiiiiii", 11, "aWlpaWlpaWlpaWk=", 16 },
{ "iiiiiiiiiiii", 12, "aWlpaWlpaWlpaWlp", 16 },
{ "\xff\x01\xfe\x02", 4, "/wH+Ag==", 8 },
{ "\xff\xff\xff\xff", 4, "/////w==", 8 },
{ "\x00\x00\x00\x00", 4, "AAAAAA==", 8 },
{ "\x00\x00\x00\x00", 1, "AA==", 4 },
};
/* base64 URL encoding */
struct etest url[] = {
{ "", 0, "", 0 },
{ "iiiiiiiiiii", 1, "aQ", 2 },
{ "iiiiiiiiiii", 2, "aWk", 3 },
{ "iiiiiiiiiii", 3, "aWlp", 4 },
{ "iiiiiiiiiii", 4, "aWlpaQ", 6 },
{ "iiiiiiiiiii", 5, "aWlpaWk", 7 },
{ "iiiiiiiiiii", 6, "aWlpaWlp", 8 },
{ "iiiiiiiiiii", 7, "aWlpaWlpaQ", 10 },
{ "iiiiiiiiiii", 8, "aWlpaWlpaWk", 11 },
{ "iiiiiiiiiii", 9, "aWlpaWlpaWlp", 12 },
{ "iiiiiiiiiii", 10, "aWlpaWlpaWlpaQ", 14 },
{ "iiiiiiiiiii", 11, "aWlpaWlpaWlpaWk", 15 },
{ "iiiiiiiiiiii", 12, "aWlpaWlpaWlpaWlp", 16 },
{ "\xff\x01\xfe\x02", 4, "_wH-Ag", 6 },
{ "\xff\xff\xff\xff", 4, "_____w", 6 },
{ "\xff\x00\xff\x00", 4, "_wD_AA", 6 },
{ "\x00\xff\x00\xff", 4, "AP8A_w", 6 },
{ "\x00\x00\x00\x00", 4, "AAAAAA", 6 },
{ "\x00", 1, "AA", 2 },
{ "\x01", 1, "AQ", 2 },
{ "\x02", 1, "Ag", 2 },
{ "\x03", 1, "Aw", 2 },
{ "\x04", 1, "BA", 2 }, /* spellchecker:disable-line */
{ "\x05", 1, "BQ", 2 },
{ "\x06", 1, "Bg", 2 },
{ "\x07", 1, "Bw", 2 },
{ "\x08", 1, "CA", 2 },
{ "\x09", 1, "CQ", 2 },
{ "\x0a", 1, "Cg", 2 },
{ "\x0b", 1, "Cw", 2 },
{ "\x0c", 1, "DA", 2 },
{ "\x0d", 1, "DQ", 2 },
{ "\x0e", 1, "Dg", 2 },
{ "\x0f", 1, "Dw", 2 },
{ "\x10", 1, "EA", 2 },
};
/* bad decode inputs */
struct etest badecode[] = {
{ "", 0, "", 0 }, /* no dats means error */
{ "", 0, "a", 1 }, /* data is too short */
{ "", 0, "aQ", 2 }, /* data is too short */
{ "", 0, "aQ=", 3 }, /* data is too short */
{ "", 0, "====", 1 }, /* data is only padding characters */
{ "", 0, "====", 2 }, /* data is only padding characters */
{ "", 0, "====", 3 }, /* data is only padding characters */
{ "", 0, "====", 4 }, /* data is only padding characters */
{ "", 0, "a===", 4 }, /* contains three padding characters */
{ "", 0, "a=Q=", 4 }, /* contains a padding character mid input */
{ "", 0, "aWlpa=Q=", 8 }, /* contains a padding character mid input */
{ "", 0, "a\x1f==", 4 }, /* contains illegal base64 character */
{ "", 0, "abcd ", 5 }, /* contains illegal base64 character */
{ "", 0, "abcd ", 6 }, /* contains illegal base64 character */
{ "", 0, " abcd", 5 }, /* contains illegal base64 character */
{ "", 0, "_abcd", 5 }, /* contains illegal base64 character */
{ "", 0, "abcd-", 5 }, /* contains illegal base64 character */
{ "", 0, "abcd_", 5 }, /* contains illegal base64 character */
{ "", 0, "aWlpaWlpaQ==-", 17 }, /* bad character after padding */
{ "", 0, "aWlpaWlpaQ==_", 17 }, /* bad character after padding */
{ "", 0, "aWlpaWlpaQ== ", 17 }, /* bad character after padding */
{ "", 0, "aWlpaWlpaQ=", 15 } /* unaligned size, missing a padding char */
};
for(i = 0; i < CURL_ARRAYSIZE(encode); i++) {
const struct etest *e = &encode[i];
char *out;
unsigned char *decoded;
size_t olen;
size_t dlen;
/* first encode */
result = curlx_base64_encode((const uint8_t *)e->input, e->ilen,
&out, &olen);
abort_unless(result == CURLE_OK, "return code should be CURLE_OK");
abort_unless(olen == e->olen, "wrong output size");
if(memcmp(out, e->output, e->olen)) {
curl_mfprintf(stderr, "Test %u encoded badly\n", i);
unitfail++;
}
curlx_safefree(out);
/* then verify decode */
result = curlx_base64_decode(e->output, &decoded, &dlen);
if(result != CURLE_OK) {
curl_mfprintf(stderr, "Test %u URL decode returned %d\n", i,
(int)result);
unitfail++;
}
if(dlen != e->ilen) {
curl_mfprintf(stderr, "Test %u URL decode output length %zu "
"instead of %zu\n", i, dlen, e->ilen);
unitfail++;
}
if(memcmp(decoded, e->input, dlen)) {
curl_mfprintf(stderr, "Test %u URL decoded badly. Got '%s', "
"expected '%s'\n", i, decoded, e->input);
unitfail++;
}
curlx_safefree(decoded);
}
for(i = 0; i < CURL_ARRAYSIZE(url); i++) {
const struct etest *e = &url[i];
char *out;
size_t olen;
result = curlx_base64url_encode((const uint8_t *)e->input, e->ilen,
&out, &olen);
abort_unless(result == CURLE_OK, "return code should be CURLE_OK");
if(olen != e->olen) {
curl_mfprintf(stderr, "Test %u URL encoded output length %zu "
"instead of %zu\n", i, olen, e->olen);
}
if(out && memcmp(out, e->output, e->olen)) {
curl_mfprintf(stderr, "Test %u URL encoded badly. Got '%s', "
"expected '%s'\n", i, out, e->output);
unitfail++;
}
curlx_safefree(out);
}
for(i = 0; i < CURL_ARRAYSIZE(badecode); i++) {
struct etest *e = &badecode[i];
unsigned char *decoded;
size_t dlen;
/* then verify decode with illegal inputs */
result = curlx_base64_decode(e->output, &decoded, &dlen);
if(result != CURLE_BAD_CONTENT_ENCODING) {
curl_mfprintf(stderr, "Test %u URL bad decoded badly. "
"Returned '%d', expected '%d'\n",
i, (int)result, CURLE_BAD_CONTENT_ENCODING);
unitfail++;
}
}
UNITTEST_END_SIMPLE
}