mirror of
https://github.com/open-goal/jak-project
synced 2026-08-20 06:16:35 -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)
109 lines
4.7 KiB
C
Vendored
Generated
109 lines
4.7 KiB
C
Vendored
Generated
#ifndef HEADER_CURL_RLIMIT_H
|
|
#define HEADER_CURL_RLIMIT_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 "curlx/timeval.h"
|
|
|
|
struct Curl_easy;
|
|
|
|
/* This is a rate limiter that provides "tokens" to be consumed
|
|
* per second. In the literature, this is referred to as a
|
|
* "token bucket" (https://en.wikipedia.org/wiki/Token_bucket).
|
|
* Example:
|
|
* A rate limit of 1 megabyte per second.
|
|
* - initially 1 million tokens are available.
|
|
* - these are drained in the first second.
|
|
* - checking available tokens before the 2nd second will return 0.
|
|
* - at/after the 2nd second, 1 million tokens are available again.
|
|
* - nothing happens for a second, the 1 million tokens would grow
|
|
* to 2 million, however the burst limit caps those at 1.5 million.
|
|
* Thus:
|
|
* - setting "burst" to CURL_OFF_T_MAX would average tokens over the
|
|
* complete lifetime. E.g. for a download, at the *end* of it, the
|
|
* average rate from start to finish would be the rate limit.
|
|
* - setting "burst" to the same value as "rate" would make a
|
|
* download always try to stay *at/below* the rate and slow times will
|
|
* not generate extra tokens.
|
|
*
|
|
* A rate limit can be blocked, causing the available tokens to become
|
|
* always 0 until unblocked. After unblocking, the rate limiting starts
|
|
* again with no history of the past.
|
|
*
|
|
* Finally, a rate limiter with rate 0 will always have CURL_OFF_T_MAX
|
|
* tokens available, unless blocked.
|
|
*/
|
|
|
|
struct Curl_rlimit {
|
|
int64_t rate_per_sec; /* rate tokens generated per second */
|
|
int64_t burst_per_sec; /* burst rate of tokens per second */
|
|
int64_t rate_per_step; /* rate tokens generated per step us */
|
|
int64_t burst_per_step; /* burst rate of tokens per step us */
|
|
timediff_t step_us; /* microseconds between token increases */
|
|
int64_t tokens; /* tokens available in the next second */
|
|
timediff_t spare_us; /* microseconds unaffecting tokens */
|
|
struct curltime ts; /* time of the last update */
|
|
BIT(blocked); /* blocking sets available tokens to 0 */
|
|
};
|
|
|
|
void Curl_rlimit_init(struct Curl_rlimit *r,
|
|
int64_t rate_per_sec,
|
|
int64_t burst_per_sec,
|
|
const struct curltime *pts);
|
|
|
|
/* Start ratelimiting with the given timestamp. Resets available tokens.
|
|
* `total_tokens` is either -1 or the number of total tokens expected
|
|
* to be consumed. */
|
|
void Curl_rlimit_start(struct Curl_rlimit *r, const struct curltime *pts,
|
|
int64_t total_tokens);
|
|
|
|
/* How many milliseconds to wait until token are available again. */
|
|
timediff_t Curl_rlimit_wait_ms(struct Curl_rlimit *r,
|
|
const struct curltime *pts);
|
|
|
|
/* When the rate limit will update its tokens again */
|
|
timediff_t Curl_rlimit_next_step_ms(struct Curl_rlimit *r,
|
|
const struct curltime *pts);
|
|
|
|
/* Return if rate limiting of tokens is active */
|
|
bool Curl_rlimit_active(struct Curl_rlimit *r);
|
|
bool Curl_rlimit_is_blocked(struct Curl_rlimit *r);
|
|
int64_t Curl_rlimit_per_step(struct Curl_rlimit *r);
|
|
|
|
/* Return how many tokens are available to spend, may be negative */
|
|
int64_t Curl_rlimit_avail(struct Curl_rlimit *r,
|
|
const struct curltime *pts);
|
|
|
|
/* Drain tokens from the ratelimit, give an estimate of how many tokens
|
|
* remain to be drained in the future (-1 for unknown). */
|
|
void Curl_rlimit_drain(struct Curl_rlimit *r,
|
|
size_t tokens,
|
|
const struct curltime *pts);
|
|
|
|
/* Block/unblock ratelimiting. A blocked ratelimit has 0 tokens available. */
|
|
void Curl_rlimit_block(struct Curl_rlimit *r,
|
|
bool activate,
|
|
const struct curltime *pts);
|
|
|
|
#endif /* HEADER_CURL_RLIMIT_H */
|