Files
jak-project/third-party/curl/docs/internals/DYNBUF.md
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

3.7 KiB
Vendored
Generated

dynbuf

This is the internal module for creating and handling "dynamic buffers". This means buffers that can be appended to, dynamically and grow to adapt.

There is always a null-terminator put at the end of the dynamic buffer.

The struct dynbuf is used to hold data for each instance of a dynamic buffer. The members of that struct MUST NOT be accessed or modified without using the dedicated dynbuf API.

curlx_dyn_init

void curlx_dyn_init(struct dynbuf *s, size_t toobig);

This initializes a struct to use for dynbuf and it cannot fail. The toobig value must be set to the maximum size we allow this buffer instance to grow to. The functions below return CURLE_OUT_OF_MEMORY when hitting this limit.

curlx_dyn_free

void curlx_dyn_free(struct dynbuf *s);

Free the associated memory and clean up. After a free, the dynbuf struct can be reused to start appending new data to.

curlx_dyn_addn

CURLcode curlx_dyn_addn(struct dynbuf *s, const void *mem, size_t len);

Append arbitrary data of a given length to the end of the buffer.

If this function fails it calls curlx_dyn_free on dynbuf.

curlx_dyn_add

CURLcode curlx_dyn_add(struct dynbuf *s, const char *str);

Append a C string to the end of the buffer.

If this function fails it calls curlx_dyn_free on dynbuf.

curlx_dyn_addf

CURLcode curlx_dyn_addf(struct dynbuf *s, const char *fmt, ...);

Append a printf()-style string to the end of the buffer.

If this function fails it calls curlx_dyn_free on dynbuf.

curlx_dyn_vaddf

CURLcode curlx_dyn_vaddf(struct dynbuf *s, const char *fmt, va_list ap);

Append a vprintf()-style string to the end of the buffer.

If this function fails it calls curlx_dyn_free on dynbuf.

curlx_dyn_reset

void curlx_dyn_reset(struct dynbuf *s);

Reset the buffer length, but leave the allocation.

curlx_dyn_tail

CURLcode curlx_dyn_tail(struct dynbuf *s, size_t length);

Keep length bytes of the buffer tail (the last length bytes of the buffer). The rest of the buffer is dropped. The specified length must not be larger than the buffer length. To instead keep the leading part, see curlx_dyn_setlen().

curlx_dyn_ptr

char *curlx_dyn_ptr(const struct dynbuf *s);

Returns a char * to the buffer if it has a length, otherwise may return NULL. Since the buffer may be reallocated, this pointer should not be trusted or used anymore after the next buffer manipulation call.

curlx_dyn_uptr

unsigned char *curlx_dyn_uptr(const struct dynbuf *s);

Returns an unsigned char * to the buffer if it has a length, otherwise may return NULL. Since the buffer may be reallocated, this pointer should not be trusted or used anymore after the next buffer manipulation call.

curlx_dyn_len

size_t curlx_dyn_len(const struct dynbuf *s);

Returns the length of the buffer in bytes. Does not include the null-terminator byte.

curlx_dyn_setlen

CURLcode curlx_dyn_setlen(struct dynbuf *s, size_t len);

Sets the new shorter length of the buffer in number of bytes. Keeps the leftmost set number of bytes, discards the rest. To instead keep the tail part of the buffer, see curlx_dyn_tail().

curlx_dyn_take

char *curlx_dyn_take(struct dynbuf *s, size_t *plen);

Transfers ownership of the internal buffer to the caller. The dynbuf resets to its initial state. The returned pointer may be NULL if the dynbuf never allocated memory. The returned length is the amount of data written to the buffer. The actual allocated memory might be larger.