Files
jak-project/third-party/curl/docs/examples/websocket.c
T
Alexander J. Semenuk 5d5e35fb9b fix: Windows toolchain compatibility (curl 8.21 re-vendor, endless reconfigure loop) (#4355)
## 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)
2026-07-27 19:19:18 -04:00

171 lines
4.9 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>
* WebSocket using CONNECT_ONLY
* </DESC>
*/
#include <stdio.h>
#include <string.h>
#ifdef _WIN32
#include <winsock2.h>
#include <windows.h>
#define sleep(s) Sleep((DWORD)(s * 1000))
#else
#include <unistd.h>
#endif
#include <curl/curl.h>
static CURLcode ping(CURL *curl, const char *send_payload)
{
CURLcode result = CURLE_OK;
const char *buf = send_payload;
size_t sent, blen = strlen(send_payload);
while(blen) {
result = curl_ws_send(curl, buf, blen, &sent, 0, CURLWS_PING);
if(result == CURLE_OK) {
buf += sent; /* deduct what was sent */
blen -= sent;
}
else if(result == CURLE_AGAIN) { /* blocked on sending */
fprintf(stderr, "ws: sent PING blocked, waiting a second\n");
sleep(1); /* either select() on socket or max timeout would
be good here. */
}
else /* real error sending */
break;
}
if(result == CURLE_OK)
fprintf(stderr, "ws: sent PING with payload\n");
return result;
}
static CURLcode recv_pong(CURL *curl, const char *expected_payload)
{
size_t rlen = 0;
const struct curl_ws_frame *meta;
char buffer[256];
CURLcode result;
retry:
result = curl_ws_recv(curl, buffer, sizeof(buffer), &rlen, &meta);
if(result == CURLE_OK) {
/* on small PING content, this example assumes the complete
* PONG content arrives in one go. Larger frames arrive
* in chunks, however. */
if(meta->flags & CURLWS_PONG) {
int same = 0;
if(rlen == strlen(expected_payload)) {
if(!memcmp(expected_payload, buffer, rlen))
same = 1;
}
fprintf(stderr, "ws: received PONG with %s payload back\n",
same ? "same" : "different");
}
else if(meta->flags & CURLWS_TEXT) {
fprintf(stderr, "ws: received TEXT frame '%.*s'\n", (int)rlen, buffer);
}
else if(meta->flags & CURLWS_BINARY) {
fprintf(stderr, "ws: received BINARY frame of %u bytes\n",
(unsigned int)rlen);
}
else {
/* some other frame arrived. */
fprintf(stderr, "ws: received frame of %u bytes rflags %x\n",
(unsigned int)rlen, (unsigned int)meta->flags);
goto retry;
}
}
else if(result == CURLE_AGAIN) { /* blocked on receiving */
fprintf(stderr, "ws: PONG not there yet, waiting a second\n");
sleep(1); /* either select() on socket or max timeout would
be good here. */
goto retry;
}
if(result != CURLE_OK)
fprintf(stderr, "ws: curl_ws_recv returned %u, received %u\n",
(unsigned int)result, (unsigned int)rlen);
return result;
}
/* close the connection */
static void websocket_close(CURL *curl)
{
size_t sent;
(void)curl_ws_send(curl, "", 0, &sent, 0, CURLWS_CLOSE);
}
static CURLcode websocket(CURL *curl)
{
CURLcode result;
int i = 0;
do {
result = ping(curl, "foobar");
if(result != CURLE_OK)
break;
result = recv_pong(curl, "foobar");
if(result != CURLE_OK)
break;
sleep(1);
} while(i++ < 10);
websocket_close(curl);
return result;
}
int main(int argc, const char *argv[])
{
CURL *curl;
CURLcode result = curl_global_init(CURL_GLOBAL_ALL);
if(result != CURLE_OK)
return (int)result;
curl = curl_easy_init();
if(curl) {
if(argc == 2)
curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
else
curl_easy_setopt(curl, CURLOPT_URL, "wss://example.com");
curl_easy_setopt(curl, CURLOPT_CONNECT_ONLY, 2L); /* websocket style */
/* Perform the request, result gets the return code */
result = curl_easy_perform(curl);
/* Check for errors */
if(result != CURLE_OK)
fprintf(stderr, "curl_easy_perform() failed: %s\n",
curl_easy_strerror(result));
else {
/* connected and ready */
result = websocket(curl);
}
/* always cleanup */
curl_easy_cleanup(curl);
}
curl_global_cleanup();
return (int)result;
}