mirror of
https://github.com/open-goal/jak-project
synced 2026-08-20 22:35:07 -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)
162 lines
3.9 KiB
C
Vendored
Generated
162 lines
3.9 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 "curl_setup.h"
|
|
#include "vtls/keylog.h"
|
|
|
|
#if defined(USE_OPENSSL) || defined(USE_GNUTLS) || defined(USE_WOLFSSL) || \
|
|
defined(USE_RUSTLS)
|
|
|
|
#include "escape.h"
|
|
#include "curlx/fopen.h"
|
|
|
|
/* The fp for the open SSLKEYLOGFILE, or NULL if not open */
|
|
static FILE *keylog_file_fp;
|
|
/* Used for verbose logging */
|
|
static char *keylog_file_name;
|
|
|
|
void Curl_tls_keylog_open(void)
|
|
{
|
|
if(!keylog_file_fp) {
|
|
keylog_file_name = getenv("SSLKEYLOGFILE");
|
|
if(keylog_file_name) {
|
|
keylog_file_fp = curlx_fopen(keylog_file_name, FOPEN_APPENDTEXT);
|
|
if(keylog_file_fp) {
|
|
#ifdef _WIN32
|
|
if(setvbuf(keylog_file_fp, NULL, _IONBF, 0))
|
|
#else
|
|
if(setvbuf(keylog_file_fp, NULL, _IOLBF, 4096))
|
|
#endif
|
|
{
|
|
curlx_fclose(keylog_file_fp);
|
|
keylog_file_fp = NULL;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void Curl_tls_keylog_close(void)
|
|
{
|
|
if(keylog_file_fp) {
|
|
curlx_fclose(keylog_file_fp);
|
|
keylog_file_fp = NULL;
|
|
}
|
|
}
|
|
|
|
bool Curl_tls_keylog_enabled(void)
|
|
{
|
|
return !!keylog_file_fp;
|
|
}
|
|
|
|
const char *Curl_tls_keylog_file_name(void)
|
|
{
|
|
return keylog_file_name;
|
|
}
|
|
|
|
bool Curl_tls_keylog_write_line(const char *line)
|
|
{
|
|
/* The current maximum valid keylog line length LF and NUL is 195. */
|
|
size_t linelen;
|
|
char buf[256];
|
|
|
|
if(!keylog_file_fp || !line) {
|
|
return FALSE;
|
|
}
|
|
|
|
linelen = strlen(line);
|
|
if(linelen == 0 || linelen > sizeof(buf) - 2) {
|
|
/* Empty line or too big to fit in an LF and NUL. */
|
|
return FALSE;
|
|
}
|
|
|
|
memcpy(buf, line, linelen);
|
|
if(line[linelen - 1] != '\n') {
|
|
buf[linelen++] = '\n';
|
|
}
|
|
buf[linelen] = '\0';
|
|
|
|
/* Using fputs here instead of fprintf since libcurl's fprintf replacement
|
|
may not be thread-safe. */
|
|
fputs(buf, keylog_file_fp);
|
|
return TRUE;
|
|
}
|
|
|
|
bool Curl_tls_keylog_write(
|
|
const char *label,
|
|
const unsigned char client_random[CLIENT_RANDOM_SIZE],
|
|
const unsigned char *secret, size_t secretlen)
|
|
{
|
|
size_t pos, i;
|
|
unsigned char line[KEYLOG_LABEL_MAXLEN + 1 +
|
|
(2 * CLIENT_RANDOM_SIZE) + 1 +
|
|
(2 * SECRET_MAXLEN) + 1 + 1];
|
|
|
|
if(!keylog_file_fp) {
|
|
return FALSE;
|
|
}
|
|
|
|
pos = strlen(label);
|
|
if(pos > KEYLOG_LABEL_MAXLEN || !secretlen || secretlen > SECRET_MAXLEN) {
|
|
/* Should never happen - sanity check anyway. */
|
|
return FALSE;
|
|
}
|
|
|
|
memcpy(line, label, pos);
|
|
line[pos++] = ' ';
|
|
|
|
/* Client Random */
|
|
for(i = 0; i < CLIENT_RANDOM_SIZE; i++) {
|
|
Curl_hexbyte(&line[pos], client_random[i]);
|
|
pos += 2;
|
|
}
|
|
line[pos++] = ' ';
|
|
|
|
/* Secret */
|
|
for(i = 0; i < secretlen; i++) {
|
|
Curl_hexbyte(&line[pos], secret[i]);
|
|
pos += 2;
|
|
}
|
|
line[pos++] = '\n';
|
|
line[pos] = '\0';
|
|
|
|
/* Using fputs here instead of fprintf since libcurl's fprintf replacement
|
|
may not be thread-safe. */
|
|
fputs((char *)line, keylog_file_fp);
|
|
return TRUE;
|
|
}
|
|
|
|
#else /* TLS backend */
|
|
|
|
bool Curl_tls_keylog_enabled(void)
|
|
{
|
|
return FALSE;
|
|
}
|
|
|
|
const char *Curl_tls_keylog_file_name(void)
|
|
{
|
|
return NULL;
|
|
}
|
|
|
|
#endif /* TLS backend */
|