mirror of
https://github.com/open-goal/jak-project
synced 2026-08-06 09:54:10 -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)
120 lines
4.6 KiB
C
Vendored
Generated
120 lines
4.6 KiB
C
Vendored
Generated
#ifndef HEADER_CURL_THRDQUEUE_H
|
|
#define HEADER_CURL_THRDQUEUE_H
|
|
/***************************************************************************
|
|
* _ _ ____ _
|
|
* 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 "curlx/timediff.h"
|
|
|
|
struct curl_thrdq;
|
|
|
|
#ifdef USE_THREADS
|
|
|
|
struct Curl_easy;
|
|
|
|
typedef enum {
|
|
CURL_THRDQ_EV_ITEM_DONE /* an item has been processed and is ready */
|
|
} Curl_thrdq_event;
|
|
|
|
/* Notification callback when "events" happen in the queue. May be called from
|
|
* any thread, queue is not locked. */
|
|
typedef void Curl_thrdq_ev_cb(const struct curl_thrdq *tqueue,
|
|
Curl_thrdq_event ev,
|
|
void *user_data);
|
|
|
|
/* Process a queued item. May be called from any thread. Queue is not
|
|
* locked. */
|
|
typedef void Curl_thrdq_item_process_cb(void *item);
|
|
|
|
/* Free an item. May be called from any thread at any time for an
|
|
* item that is in the queue (either before or after processing). */
|
|
typedef void Curl_thrdq_item_free_cb(void *item);
|
|
|
|
/* Create a new queue processing "items" by a thread pool.
|
|
*/
|
|
CURLcode Curl_thrdq_create(struct curl_thrdq **ptqueue,
|
|
const char *name,
|
|
uint32_t max_len, /* 0 for unlimited */
|
|
uint32_t min_threads,
|
|
uint32_t max_threads,
|
|
uint32_t idle_time_ms,
|
|
Curl_thrdq_item_free_cb *fn_free,
|
|
Curl_thrdq_item_process_cb *fn_process,
|
|
Curl_thrdq_ev_cb *fn_event, /* optional */
|
|
void *user_data);
|
|
|
|
/* Destroy the queue, free all queued items unprocessed and destroy
|
|
* the thread pool used.
|
|
* @param join TRUE when thread pool shall be joined. FALSE for
|
|
* detaching any running threads.
|
|
*/
|
|
void Curl_thrdq_destroy(struct curl_thrdq *tqueue, bool join);
|
|
|
|
/* Send "item" onto the queue. The caller needs to clear any reference
|
|
* to "item" on success, e.g. the queue takes ownership.
|
|
* `description` is an optional string describing the item for tracing
|
|
* purposes. It needs to have the same lifetime as `item`.
|
|
* Returns CURLE_AGAIN when the queue has already been full.
|
|
*
|
|
* With`timeout_ms` != 0, items that get stuck that long in the send
|
|
* queue are removed and added to the receive queue right away.
|
|
*/
|
|
CURLcode Curl_thrdq_send(struct curl_thrdq *tqueue, void *item,
|
|
const char *description, timediff_t timeout_ms);
|
|
|
|
/* Receive the oldest, processed item from the queue again, if there is one.
|
|
* The caller takes ownership of the item received, e.g. the queue
|
|
* relinquishes all references to item.
|
|
* Returns CURLE_AGAIN when there is no processed item, setting `pitem`
|
|
* to NULL.
|
|
*/
|
|
CURLcode Curl_thrdq_recv(struct curl_thrdq *tqueue, void **pitem);
|
|
|
|
/* Return TRUE if the passed "item" matches. */
|
|
typedef bool Curl_thrdq_item_match_cb(void *item, void *match_data);
|
|
|
|
/* Clear all scheduled/processed items that match from the queue. This
|
|
* will *not* be able to clear items that are being processed.
|
|
*/
|
|
void Curl_thrdq_clear(struct curl_thrdq *tqueue,
|
|
Curl_thrdq_item_match_cb *fn_match,
|
|
void *match_data);
|
|
|
|
CURLcode Curl_thrdq_await_done(struct curl_thrdq *tqueue,
|
|
uint32_t timeout_ms);
|
|
|
|
CURLcode Curl_thrdq_set_props(struct curl_thrdq *tqueue,
|
|
uint32_t max_len, /* 0 for unlimited */
|
|
uint32_t min_threads,
|
|
uint32_t max_threads,
|
|
uint32_t idle_time_ms);
|
|
|
|
#ifdef CURLVERBOSE
|
|
void Curl_thrdq_trace(struct curl_thrdq *tqueue,
|
|
struct Curl_easy *data);
|
|
#endif
|
|
|
|
#endif /* USE_THREADS */
|
|
|
|
#endif /* HEADER_CURL_THRDQUEUE_H */
|