mirror of
https://github.com/open-goal/jak-project
synced 2026-08-20 14:24:45 -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)
127 lines
5.8 KiB
Python
Vendored
Generated
127 lines
5.8 KiB
Python
Vendored
Generated
#!/usr/bin/env python3
|
|
# -*- coding: utf-8 -*-
|
|
#***************************************************************************
|
|
# _ _ ____ _
|
|
# 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
|
|
#
|
|
###########################################################################
|
|
#
|
|
import logging
|
|
from typing import Dict, List, Tuple
|
|
|
|
import pytest
|
|
from testenv import CurlClient, Env
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
@pytest.mark.skipif(condition=Env().slow_network, reason="not suitable for slow network tests")
|
|
@pytest.mark.skipif(condition=Env().ci_run, reason="not suitable for CI runs")
|
|
class TestStuttered:
|
|
|
|
# download 1 file, check that delayed response works in general
|
|
@pytest.mark.parametrize("proto", Env.http_protos())
|
|
def test_04_01_download_1(self, env: Env, httpd, nghttpx, proto):
|
|
count = 1
|
|
curl = CurlClient(env=env)
|
|
urln = f'https://{env.authority_for(env.domain1, proto)}' \
|
|
f'/curltest/tweak?id=[0-{count - 1}]'\
|
|
'&chunks=100&chunk_size=100&chunk_delay=10ms'
|
|
r = curl.http_download(urls=[urln], alpn_proto=proto)
|
|
r.check_response(count=1, http_status=200)
|
|
|
|
# download 50 files in 100 chunks a 100 bytes with 10ms delay between
|
|
# prepend 100 file requests to warm up connection processing limits
|
|
# (Apache2 increases # of parallel processed requests after successes)
|
|
@pytest.mark.parametrize("proto", Env.http_mplx_protos())
|
|
def test_04_02_100_100_10(self, env: Env, httpd, nghttpx, proto):
|
|
count = 50
|
|
warmups = 100
|
|
curl = CurlClient(env=env)
|
|
url1 = f'https://{env.authority_for(env.domain1, proto)}/data.json?[0-{warmups-1}]'
|
|
urln = f'https://{env.authority_for(env.domain1, proto)}' \
|
|
f'/curltest/tweak?id=[0-{count-1}]'\
|
|
'&chunks=100&chunk_size=100&chunk_delay=10ms'
|
|
r = curl.http_download(urls=[url1, urln], alpn_proto=proto,
|
|
extra_args=['--parallel'])
|
|
r.check_response(count=warmups+count, http_status=200)
|
|
assert r.total_connects == 1
|
|
t_avg, i_min, t_min, i_max, t_max = self.stats_spread(r.stats[warmups:], 'time_total')
|
|
if t_max < (5 * t_min) and t_min < 2:
|
|
log.warning(f'avg time of transfer: {t_avg} [{i_min}={t_min}, {i_max}={t_max}]')
|
|
|
|
# download 50 files in 1000 chunks a 10 bytes with 1ms delay between
|
|
# prepend 100 file requests to warm up connection processing limits
|
|
# (Apache2 increases # of parallel processed requests after successes)
|
|
@pytest.mark.parametrize("proto", Env.http_mplx_protos())
|
|
def test_04_03_1000_10_1(self, env: Env, httpd, nghttpx, proto):
|
|
count = 50
|
|
warmups = 100
|
|
curl = CurlClient(env=env)
|
|
url1 = f'https://{env.authority_for(env.domain1, proto)}/data.json?[0-{warmups-1}]'
|
|
urln = f'https://{env.authority_for(env.domain1, proto)}' \
|
|
f'/curltest/tweak?id=[0-{count - 1}]'\
|
|
'&chunks=1000&chunk_size=10&chunk_delay=100us'
|
|
r = curl.http_download(urls=[url1, urln], alpn_proto=proto,
|
|
extra_args=['--parallel'])
|
|
r.check_response(count=warmups+count, http_status=200)
|
|
assert r.total_connects == 1
|
|
t_avg, i_min, t_min, i_max, t_max = self.stats_spread(r.stats[warmups:], 'time_total')
|
|
if t_max < (5 * t_min):
|
|
log.warning(f'avg time of transfer: {t_avg} [{i_min}={t_min}, {i_max}={t_max}]')
|
|
|
|
# download 50 files in 10000 chunks a 1 byte with 10us delay between
|
|
# prepend 100 file requests to warm up connection processing limits
|
|
# (Apache2 increases # of parallel processed requests after successes)
|
|
@pytest.mark.parametrize("proto", Env.http_mplx_protos())
|
|
def test_04_04_1000_10_1(self, env: Env, httpd, nghttpx, proto):
|
|
count = 50
|
|
warmups = 100
|
|
curl = CurlClient(env=env)
|
|
url1 = f'https://{env.authority_for(env.domain1, proto)}/data.json?[0-{warmups-1}]'
|
|
urln = f'https://{env.authority_for(env.domain1, proto)}' \
|
|
f'/curltest/tweak?id=[0-{count - 1}]'\
|
|
'&chunks=10000&chunk_size=1&chunk_delay=50us'
|
|
r = curl.http_download(urls=[url1, urln], alpn_proto=proto,
|
|
extra_args=['--parallel'])
|
|
r.check_response(count=warmups+count, http_status=200)
|
|
assert r.total_connects == 1
|
|
t_avg, i_min, t_min, i_max, t_max = self.stats_spread(r.stats[warmups:], 'time_total')
|
|
if t_max < (5 * t_min):
|
|
log.warning(f'avg time of transfer: {t_avg} [{i_min}={t_min}, {i_max}={t_max}]')
|
|
|
|
def stats_spread(self, stats: List[Dict], key: str) -> Tuple[float, int, float, int, float]:
|
|
stotals = 0.0
|
|
s_min = 100.0
|
|
i_min = -1
|
|
s_max = 0.0
|
|
i_max = -1
|
|
for idx, s in enumerate(stats):
|
|
val = float(s[key])
|
|
stotals += val
|
|
if val > s_max:
|
|
s_max = val
|
|
i_max = idx
|
|
if val < s_min:
|
|
s_min = val
|
|
i_min = idx
|
|
return stotals/len(stats), i_min, s_min, i_max, s_max
|