mirror of
https://github.com/open-goal/jak-project
synced 2026-09-06 19:21:00 -04:00
5d5e35fb9b
## 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)
233 lines
6.4 KiB
C
Vendored
Generated
233 lines
6.4 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"
|
|
|
|
#if defined(_WIN32) || defined(MSDOS)
|
|
#include "tool_cfgable.h"
|
|
#include "tool_doswin.h"
|
|
|
|
static void getflagstr(char *buf, size_t len, int flags)
|
|
{
|
|
curl_msnprintf(buf, len, "%s,%s",
|
|
((flags & SANITIZE_ALLOW_PATH) ?
|
|
"SANITIZE_ALLOW_PATH" : ""),
|
|
((flags & SANITIZE_ALLOW_RESERVED) ?
|
|
"SANITIZE_ALLOW_RESERVED" : ""));
|
|
}
|
|
|
|
static void getcurlcodestr(char *buf, size_t len, int cc)
|
|
{
|
|
curl_msnprintf(buf, len, "%s (%d)",
|
|
(cc == SANITIZE_ERR_OK ? "SANITIZE_ERR_OK" :
|
|
cc == SANITIZE_ERR_BAD_ARGUMENT ? "SANITIZE_ERR_BAD_ARGUMENT" :
|
|
cc == SANITIZE_ERR_INVALID_PATH ? "SANITIZE_ERR_INVALID_PATH" :
|
|
cc == SANITIZE_ERR_OUT_OF_MEMORY ? "SANITIZE_ERR_OUT_OF_MEMORY" :
|
|
"unexpected error code - add name"), cc);
|
|
}
|
|
#endif
|
|
|
|
static CURLcode test_tool1604(const char *arg)
|
|
{
|
|
UNITTEST_BEGIN_SIMPLE
|
|
|
|
#if defined(_WIN32) || defined(MSDOS)
|
|
struct data {
|
|
const char *input;
|
|
int flags;
|
|
const char *expected_output;
|
|
SANITIZEcode expected_result;
|
|
};
|
|
|
|
/* START sanitize_file_name */
|
|
struct data data[] = {
|
|
{ "", 0,
|
|
"", SANITIZE_ERR_OK
|
|
},
|
|
{ "normal filename", 0,
|
|
"normal filename", SANITIZE_ERR_OK
|
|
},
|
|
{ "control\tchar", 0,
|
|
"control_char", SANITIZE_ERR_OK
|
|
},
|
|
{ "banned*char", 0,
|
|
"banned_char", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:foo", 0,
|
|
"f_foo", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:foo", SANITIZE_ALLOW_PATH,
|
|
"f:foo", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:\\foo", 0,
|
|
"f__foo", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:\\foo", SANITIZE_ALLOW_PATH,
|
|
"f:\\foo", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:/foo", 0,
|
|
"f__foo", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:/foo", SANITIZE_ALLOW_PATH,
|
|
"f:/foo", SANITIZE_ERR_OK
|
|
},
|
|
#ifndef MSDOS
|
|
{ "\\\\?\\C:\\foo", SANITIZE_ALLOW_PATH,
|
|
"\\\\?\\C:\\foo", SANITIZE_ERR_OK
|
|
},
|
|
{ "\\\\?\\C:\\foo", 0,
|
|
"____C__foo", SANITIZE_ERR_OK
|
|
},
|
|
#endif
|
|
{ "foo:bar", 0,
|
|
"foo_bar", SANITIZE_ERR_OK
|
|
},
|
|
{ "foo|<>/bar\\\":?*baz", 0,
|
|
"foo____bar_____baz", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:foo::$DATA", 0,
|
|
"f_foo__$DATA", SANITIZE_ERR_OK
|
|
},
|
|
{ "con . air", 0,
|
|
"con _ air", SANITIZE_ERR_OK
|
|
},
|
|
{ "con.air", 0,
|
|
"con_air", SANITIZE_ERR_OK
|
|
},
|
|
{ "con:/x", 0,
|
|
"con__x", SANITIZE_ERR_OK
|
|
},
|
|
{ "file . . . . .. .", 0,
|
|
"file", SANITIZE_ERR_OK
|
|
},
|
|
{ "foo . . ? . . ", 0,
|
|
"foo . . _", SANITIZE_ERR_OK
|
|
},
|
|
{ "com1", 0,
|
|
"_com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "com1", SANITIZE_ALLOW_RESERVED,
|
|
"com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:\\com1", 0,
|
|
"f__com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:\\com1", SANITIZE_ALLOW_PATH,
|
|
"f:\\_com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:\\com1", SANITIZE_ALLOW_RESERVED,
|
|
"f__com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "f:\\com1", SANITIZE_ALLOW_RESERVED | SANITIZE_ALLOW_PATH,
|
|
"f:\\com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "com1:\\com1", SANITIZE_ALLOW_PATH,
|
|
"_com1:\\_com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "com1:\\com1", SANITIZE_ALLOW_RESERVED | SANITIZE_ALLOW_PATH,
|
|
"com1:\\com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "com1:\\com1", SANITIZE_ALLOW_RESERVED,
|
|
"com1__com1", SANITIZE_ERR_OK
|
|
},
|
|
#ifndef MSDOS
|
|
{ "\\com1", SANITIZE_ALLOW_PATH,
|
|
"\\_com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "\\\\com1", SANITIZE_ALLOW_PATH,
|
|
"\\\\com1", SANITIZE_ERR_OK
|
|
},
|
|
{ "\\\\?\\C:\\com1", SANITIZE_ALLOW_PATH,
|
|
"\\\\?\\C:\\com1", SANITIZE_ERR_OK
|
|
},
|
|
#endif
|
|
{ "CoM1", 0,
|
|
"_CoM1", SANITIZE_ERR_OK
|
|
},
|
|
{ "CoM1", SANITIZE_ALLOW_RESERVED,
|
|
"CoM1", SANITIZE_ERR_OK
|
|
},
|
|
{ "COM56", 0,
|
|
"COM56", SANITIZE_ERR_OK
|
|
},
|
|
{ NULL, 0,
|
|
NULL, SANITIZE_ERR_BAD_ARGUMENT
|
|
},
|
|
};
|
|
|
|
size_t i;
|
|
|
|
for(i = 0; i < CURL_ARRAYSIZE(data); ++i) {
|
|
char *output = NULL;
|
|
char flagstr[256];
|
|
char receivedstr[256];
|
|
char expectedstr[256];
|
|
const char *flg = flagstr;
|
|
const char *rec = receivedstr;
|
|
const char *exp = expectedstr;
|
|
SANITIZEcode res;
|
|
|
|
res = sanitize_file_name(&output, data[i].input, data[i].flags);
|
|
|
|
if(res == data[i].expected_result &&
|
|
((!output && !data[i].expected_output) ||
|
|
(output && data[i].expected_output &&
|
|
!strcmp(output, data[i].expected_output)))) { /* OK */
|
|
curlx_free(output);
|
|
continue;
|
|
}
|
|
|
|
getflagstr(flagstr, sizeof(flagstr), data[i].flags);
|
|
abort_unless(flg, "out of memory");
|
|
getcurlcodestr(receivedstr, sizeof(receivedstr), res);
|
|
abort_unless(rec, "out of memory");
|
|
getcurlcodestr(expectedstr, sizeof(expectedstr), data[i].expected_result);
|
|
abort_unless(exp, "out of memory");
|
|
|
|
unitfail++;
|
|
curl_mfprintf(stderr, "\n"
|
|
"%s:%d sanitize_file_name failed.\n"
|
|
"input: %s\n"
|
|
"flags: %s\n"
|
|
"output: %s\n"
|
|
"result: %s\n"
|
|
"expected output: %s\n"
|
|
"expected result: %s\n",
|
|
__FILE__, __LINE__,
|
|
data[i].input,
|
|
flagstr,
|
|
output ? output : "(null)",
|
|
receivedstr,
|
|
data[i].expected_output ? data[i].expected_output : "(null)",
|
|
expectedstr);
|
|
|
|
curlx_free(output);
|
|
}
|
|
/* END sanitize_file_name */
|
|
#else
|
|
curl_mfprintf(stderr, "Skipped test not for this platform\n");
|
|
#endif /* _WIN32 || MSDOS */
|
|
|
|
UNITTEST_END_SIMPLE
|
|
}
|