mirror of
https://github.com/open-goal/jak-project
synced 2026-08-12 20:03:14 -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)
196 lines
6.1 KiB
C
Vendored
Generated
196 lines
6.1 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
|
|
*
|
|
***************************************************************************/
|
|
/* <DESC>
|
|
* Use in-memory user certificate and private key and retrieve an HTTPS page.
|
|
* </DESC>
|
|
*/
|
|
|
|
/* Written by Ishan SinghLevett, based on Theo Borm's cacertinmem.c. Note that
|
|
* to maintain simplicity this example does not use a CA certificate for peer
|
|
* verification. Some form of peer verification must be used in real
|
|
* circumstances when a secure connection is required.
|
|
*/
|
|
|
|
/* Requires: USE_OPENSSL */
|
|
|
|
#include <openssl/ssl.h>
|
|
|
|
#include <stdio.h>
|
|
|
|
#include <curl/curl.h>
|
|
|
|
static size_t write_cb(char *ptr, size_t size, size_t nmemb, void *stream)
|
|
{
|
|
fwrite(ptr, size, nmemb, (FILE *)stream);
|
|
return nmemb * size;
|
|
}
|
|
|
|
static CURLcode sslctx_function(CURL *curl, void *sslctx, void *pointer)
|
|
{
|
|
/** This example uses a (fake) certificate and private key **/
|
|
/* replace the XXX with the actual client/user certificate */
|
|
static const char mypem[] =
|
|
"-----BEGIN CERTIFICATE-----\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"-----END CERTIFICATE-----\n";
|
|
|
|
/* replace the XXX with the actual private key */
|
|
static const char mykey[] =
|
|
"-----BEGIN PRIVATE KEY-----\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n"
|
|
"-----END PRIVATE KEY-----\n";
|
|
|
|
CURLcode result = CURLE_ABORTED_BY_CALLBACK;
|
|
X509 *cert = NULL;
|
|
BIO *bio = NULL;
|
|
BIO *kbio = NULL;
|
|
EVP_PKEY *pkey = NULL;
|
|
int ret;
|
|
|
|
(void)curl;
|
|
(void)pointer;
|
|
|
|
/* get a BIO */
|
|
bio = BIO_new_mem_buf(mypem, sizeof(mypem) - 1);
|
|
if(!bio) {
|
|
printf("BIO_new_mem_buf() failed\n");
|
|
goto out;
|
|
}
|
|
|
|
/* use it to read the PEM formatted certificate from memory into an X509
|
|
structure that SSL can use. */
|
|
cert = PEM_read_bio_X509(bio, NULL, 0, NULL);
|
|
if(!cert) {
|
|
printf("PEM_read_bio_X509() failed\n");
|
|
goto out;
|
|
}
|
|
|
|
/* tell SSL to use the X509 certificate */
|
|
ret = SSL_CTX_use_certificate((SSL_CTX *)sslctx, cert);
|
|
if(ret != 1) {
|
|
printf("SSL_CTX_use_certificate() failed\n");
|
|
goto out;
|
|
}
|
|
|
|
/* create a bio for the private key */
|
|
kbio = BIO_new_mem_buf(mykey, sizeof(mykey) - 1);
|
|
if(!kbio) {
|
|
printf("BIO_new_mem_buf() failed\n");
|
|
goto out;
|
|
}
|
|
|
|
pkey = PEM_read_bio_PrivateKey(kbio, NULL, NULL, NULL);
|
|
if(!pkey) {
|
|
printf("PEM_read_bio_PrivateKey() failed\n");
|
|
goto out;
|
|
}
|
|
|
|
/* tell SSL to use the private key from memory */
|
|
ret = SSL_CTX_use_PrivateKey((SSL_CTX *)sslctx, pkey);
|
|
if(ret != 1) {
|
|
printf("SSL_CTX_use_PrivateKey() failed\n");
|
|
goto out;
|
|
}
|
|
|
|
result = CURLE_OK;
|
|
|
|
out:
|
|
/* free resources that have been allocated by OpenSSL functions */
|
|
if(bio)
|
|
BIO_free(bio);
|
|
|
|
if(kbio)
|
|
BIO_free(kbio);
|
|
|
|
if(pkey)
|
|
EVP_PKEY_free(pkey);
|
|
|
|
if(cert)
|
|
X509_free(cert);
|
|
|
|
/* all set to go */
|
|
return result;
|
|
}
|
|
|
|
int main(void)
|
|
{
|
|
CURL *curl;
|
|
|
|
CURLcode result = curl_global_init(CURL_GLOBAL_ALL);
|
|
if(result != CURLE_OK)
|
|
return (int)result;
|
|
|
|
curl = curl_easy_init();
|
|
if(curl) {
|
|
curl_easy_setopt(curl, CURLOPT_VERBOSE, 0L);
|
|
curl_easy_setopt(curl, CURLOPT_HEADER, 0L);
|
|
curl_easy_setopt(curl, CURLOPT_NOPROGRESS, 1L);
|
|
curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1L);
|
|
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_cb);
|
|
curl_easy_setopt(curl, CURLOPT_WRITEDATA, stdout);
|
|
curl_easy_setopt(curl, CURLOPT_HEADERFUNCTION, write_cb);
|
|
curl_easy_setopt(curl, CURLOPT_HEADERDATA, stderr);
|
|
curl_easy_setopt(curl, CURLOPT_SSLCERTTYPE, "PEM");
|
|
|
|
/* both VERIFYPEER and VERIFYHOST are set to 0 in this case because there
|
|
is no CA certificate */
|
|
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
|
|
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);
|
|
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://www.example.com/");
|
|
curl_easy_setopt(curl, CURLOPT_SSLKEYTYPE, "PEM");
|
|
|
|
/* first try: retrieve page without user certificate and key -> fails */
|
|
result = curl_easy_perform(curl);
|
|
if(result == CURLE_OK)
|
|
printf("*** transfer succeeded ***\n");
|
|
else
|
|
printf("*** transfer failed ***\n");
|
|
|
|
/* second try: retrieve page using user certificate and key -> succeeds to
|
|
* load the certificate and key by installing a function doing the
|
|
* necessary "modifications" to the SSL CONTEXT before link init
|
|
*/
|
|
curl_easy_setopt(curl, CURLOPT_SSL_CTX_FUNCTION, sslctx_function);
|
|
result = curl_easy_perform(curl);
|
|
if(result == CURLE_OK)
|
|
printf("*** transfer succeeded ***\n");
|
|
else
|
|
printf("*** transfer failed ***\n");
|
|
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
curl_global_cleanup();
|
|
return (int)result;
|
|
}
|