mirror of
https://github.com/open-goal/jak-project
synced 2026-08-30 17:30:03 -04:00
Alexander J. Semenuk
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)
105 lines
2.6 KiB
Markdown
Vendored
Generated
105 lines
2.6 KiB
Markdown
Vendored
Generated
<!--
|
|
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
|
SPDX-License-Identifier: curl
|
|
-->
|
|
|
|
# bufref
|
|
|
|
This is an internal module for handling buffer references. A referenced
|
|
buffer is associated with its destructor function that is implicitly called
|
|
when the reference is invalidated. Once referenced, a buffer cannot be
|
|
reallocated.
|
|
|
|
A data length is stored within the reference for binary data handling
|
|
purposes; it is not used by the bufref API.
|
|
|
|
The `struct bufref` is used to hold data referencing a buffer. The members of
|
|
that structure **MUST NOT** be accessed or modified without using the dedicated
|
|
bufref API.
|
|
|
|
## `init`
|
|
|
|
```c
|
|
void Curl_bufref_init(struct bufref *br);
|
|
```
|
|
|
|
Initializes a `bufref` structure. This function **MUST** be called before any
|
|
other operation is performed on the structure.
|
|
|
|
Upon completion, the referenced buffer is `NULL` and length is zero.
|
|
|
|
This function may also be called to bypass referenced buffer destruction while
|
|
invalidating the current reference.
|
|
|
|
## `free`
|
|
|
|
```c
|
|
void Curl_bufref_free(struct bufref *br);
|
|
```
|
|
|
|
Destroys the previously referenced buffer using its destructor and
|
|
reinitializes the structure for a possible subsequent reuse.
|
|
|
|
## `set`
|
|
|
|
```c
|
|
void Curl_bufref_set(struct bufref *br, const void *buffer, size_t length,
|
|
void (*destructor)(void *));
|
|
```
|
|
|
|
Releases the previously referenced buffer, then assigns the new `buffer` to
|
|
the structure, associated with its `destructor` function. The latter can be
|
|
specified as `NULL`: this is the case when the referenced buffer is static.
|
|
|
|
if `buffer` is NULL, `length` must be zero.
|
|
|
|
## `memdup0`
|
|
|
|
```c
|
|
CURLcode Curl_bufref_memdup0(struct bufref *br, const void *data,
|
|
size_t length);
|
|
```
|
|
|
|
Releases the previously referenced buffer, then duplicates the `length`-byte
|
|
`data` into a buffer allocated via `malloc()` and references the latter
|
|
associated with destructor `curl_free()`.
|
|
|
|
An additional trailing byte is allocated and set to zero as a possible string
|
|
null-terminator; it is not counted in the stored length.
|
|
|
|
Returns `CURLE_OK` if successful, else `CURLE_OUT_OF_MEMORY`.
|
|
|
|
## `ptr`
|
|
|
|
```c
|
|
const char *Curl_bufref_ptr(const struct bufref *br);
|
|
```
|
|
|
|
Returns a `const char *` to the referenced buffer.
|
|
|
|
## `uptr`
|
|
|
|
```c
|
|
const unsigned char *Curl_bufref_uptr(const struct bufref *br);
|
|
```
|
|
|
|
Returns a `const unsigned char *` to the referenced buffer.
|
|
|
|
## `len`
|
|
|
|
```c
|
|
size_t Curl_bufref_len(const struct bufref *br);
|
|
```
|
|
|
|
Returns the stored length of the referenced buffer.
|
|
|
|
## `dup`
|
|
|
|
```c
|
|
char *Curl_bufref_dup(const struct bufref *br);
|
|
```
|
|
|
|
Returns a strdup() version of the buffer. Note that this assumes that the
|
|
bufref is null-terminated.
|