mirror/jak-project
1
0
Fork 0
mirror of https://github.com/open-goal/jak-project synced 2026-08-16 05:09:45 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
5d5e35fb9be0d7854febd1f22a45d403209fb966
jak-project/third-party/curl/docs/FEATURES.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

5.9 KiB
Vendored
Generated
Raw Blame History

Features -- what curl can do

curl tool

  • config file support
  • multiple URLs in a single command line
  • range "globbing" support: [0-13], {one,two,three}
  • multiple file upload on a single command line
  • redirect stderr
  • parallel transfers

libcurl

  • URL RFC 3986 syntax
  • custom maximum download time
  • custom lowest download speed acceptable
  • custom output result after completion
  • guesses protocol from hostname unless specified
  • supports .netrc
  • progress bar with time statistics while downloading
  • standard proxy environment variables support
  • have run on 101 operating systems and 28 CPU architectures
  • selectable network interface for outgoing traffic
  • IPv6 support on Unix and Windows
  • happy eyeballs dual-stack IPv4 + IPv6 connects
  • persistent connections
  • SOCKS 4 + 5 support, with or without local name resolving
  • pre-proxy support, for proxy chaining
  • supports username and password in proxy environment variables
  • operations through HTTP proxy "tunnel" (using CONNECT)
  • replaceable memory functions (malloc, free, realloc, etc)
  • asynchronous name resolving
  • both a push and a pull style interface
  • international domain names (IDN)
  • transfer rate limiting
  • stable API and ABI
  • TCP keep alive
  • TCP Fast Open
  • DNS cache (that can be shared between transfers)
  • non-blocking single-threaded parallel transfers
  • Unix domain sockets to server or proxy
  • DNS-over-HTTPS
  • uses non-blocking name resolves
  • selectable name resolver backend

URL API

  • parses RFC 3986 URLs
  • generates URLs from individual components
  • manages "redirects"

Header API

  • easy access to HTTP response headers, from all contexts
  • named headers
  • iterate over headers

TLS

  • selectable TLS backend(s)
  • TLS False Start
  • TLS version control
  • TLS session resumption
  • key pinning
  • mutual authentication
  • Use dedicated CA cert bundle
  • Use OS-provided CA store
  • separate TLS options for HTTPS proxy

HTTP

  • HTTP/0.9 responses are optionally accepted
  • HTTP/1.0
  • HTTP/1.1
  • HTTP/2, including multiplexing and server push
  • GET
  • PUT
  • HEAD
  • POST
  • multipart formpost (RFC 1867-style)
  • authentication: Basic, Digest, NTLM (9) and Negotiate (SPNEGO) to server and proxy
  • resume transfers
  • follow redirects
  • maximum amount of redirects to follow
  • custom HTTP request
  • cookie get/send fully parsed
  • reads/writes the Netscape cookie file format
  • custom headers (replace/remove internally generated headers)
  • custom user-agent string
  • custom referrer string
  • range
  • proxy authentication
  • time conditions
  • via HTTP proxy, HTTPS proxy or SOCKS proxy
  • HTTP/2 or HTTP/1.1 to HTTPS proxy
  • retrieve file modification date
  • Content-Encoding support for deflate, gzip, brotli and zstd
  • "Transfer-Encoding: chunked" support in uploads
  • HSTS
  • alt-svc
  • ETags
  • HTTP/1.1 trailers, both sending and getting

HTTPS

  • HTTP/3
  • using client certificates
  • verify server certificate
  • via HTTP proxy, HTTPS proxy or SOCKS proxy
  • select desired encryption
  • select usage of a specific TLS version
  • ECH

FTP

  • download
  • authentication
  • Kerberos 5
  • active/passive using PORT, EPRT, PASV or EPSV
  • single file size information (compare to HTTP HEAD)
  • 'type=' URL support
  • directory listing
  • directory listing names-only
  • upload
  • upload append
  • upload via http-proxy as HTTP PUT
  • download resume
  • upload resume
  • custom ftp commands (before and/or after the transfer)
  • simple "range" support
  • via HTTP proxy, HTTPS proxy or SOCKS proxy
  • all operations can be tunneled through proxy
  • customizable to retrieve file modification date
  • no directory depth limit

FTPS

  • implicit ftps:// support that use SSL on both connections
  • explicit "AUTH TLS" and "AUTH SSL" usage to "upgrade" plain ftp:// connection to use SSL for both or one of the connections

SSH (both SCP and SFTP)

  • selectable SSH backend
  • known hosts support
  • public key fingerprinting
  • both password and public key auth

SFTP

  • both password and public key auth
  • with custom commands sent before/after the transfer
  • directory listing

TFTP

  • download
  • upload

TELNET

  • connection negotiation
  • custom telnet options
  • stdin/stdout I/O

LDAP

  • full LDAP URL support

DICT

  • extended DICT URL support

FILE

  • URL support
  • upload
  • resume

SMB

  • SMBv1 over TCP and SSL
  • download
  • upload
  • authentication with NTLMv1

SMTP

  • authentication: Plain, Login, CRAM-MD5, Digest-MD5, NTLM, Kerberos 5 and External
  • send emails
  • mail from support
  • mail size support
  • mail auth support for trusted server-to-server relaying
  • multiple recipients
  • via http-proxy

SMTPS

  • implicit smtps:// support
  • explicit "STARTTLS" usage to "upgrade" plain smtp:// connections to use SSL
  • via http-proxy

POP3

  • authentication: Clear Text, APOP and SASL
  • SASL based authentication: Plain, Login, CRAM-MD5, Digest-MD5, NTLM, Kerberos 5 and External
  • list emails
  • retrieve emails
  • enhanced command support for: CAPA, DELE, TOP, STAT, UIDL and NOOP via custom requests
  • via http-proxy

POP3S

  • implicit pop3s:// support
  • explicit STLS usage to "upgrade" plain pop3:// connections to use SSL
  • via http-proxy

IMAP

  • authentication: Clear Text and SASL
  • SASL based authentication: Plain, Login, CRAM-MD5, Digest-MD5, NTLM, Kerberos 5 and External
  • list the folders of a mailbox
  • select a mailbox with support for verifying the UIDVALIDITY
  • fetch emails with support for specifying the UID and SECTION
  • upload emails via the append command
  • enhanced command support for: EXAMINE, CREATE, DELETE, RENAME, STATUS, STORE, COPY and UID via custom requests
  • via http-proxy

IMAPS

  • implicit imaps:// support
  • explicit "STARTTLS" usage to "upgrade" plain imap:// connections to use SSL
  • via http-proxy

MQTT

  • Subscribe to and publish topics using URL scheme mqtt://broker/topic
Reference in New Issue View Git Blame Copy Permalink