mirror of
https://github.com/open-goal/jak-project
synced 2026-09-10 20:29:51 -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)
149 lines
5.3 KiB
Markdown
Vendored
Generated
149 lines
5.3 KiB
Markdown
Vendored
Generated
<!--
|
|
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
|
SPDX-License-Identifier: curl
|
|
-->
|
|
|
|
# Building via IDE Project Files
|
|
|
|
This document describes how to compile, build and install curl and libcurl
|
|
from sources using legacy versions of Visual Studio 2010 - 2013.
|
|
|
|
You need to generate the project files before using them. Please run "generate
|
|
-help" for usage details.
|
|
|
|
To generate project files for recent versions of Visual Studio instead, use
|
|
cmake. Refer to INSTALL-CMAKE.md in the docs directory.
|
|
|
|
## Directory Structure
|
|
|
|
The following directory structure is used for the legacy project files:
|
|
|
|
somedirectory\
|
|
|_curl
|
|
|_projects
|
|
|_<platform>
|
|
|_<ide>
|
|
|_lib
|
|
|_src
|
|
|
|
This structure allows for side-by-side compilation of curl on the same machine
|
|
using different versions of a given compiler (for example VC10 and VC12) and
|
|
allows for your own application or product to be compiled against those
|
|
variants of libcurl for example.
|
|
|
|
Note: Typically this side-by-side compilation is generally only required when
|
|
a library is being compiled against dynamic runtime libraries.
|
|
|
|
## Dependencies
|
|
|
|
The projects files also support build configurations that require third party
|
|
dependencies such as OpenSSL and libssh2. If you wish to support these, you
|
|
also need to download and compile those libraries as well.
|
|
|
|
To support compilation of these libraries using different versions of
|
|
compilers, the following directory structure has been used for both the output
|
|
of curl and libcurl as well as these dependencies.
|
|
|
|
somedirectory\
|
|
|_curl
|
|
| |_ build
|
|
| |_<architecture>
|
|
| |_<ide>
|
|
| |_<configuration>
|
|
| |_lib
|
|
| |_src
|
|
|
|
|
|_openssl
|
|
| |_ build
|
|
| |_<architecture>
|
|
| |_VC <version>
|
|
| |_<configuration>
|
|
|
|
|
|_libssh2
|
|
|_ build
|
|
|_<architecture>
|
|
|_VC <version>
|
|
|_<configuration>
|
|
|
|
As OpenSSL does not support side-by-side compilation when using different
|
|
versions of Visual Studio, a helper batch file has been provided to assist
|
|
with this. Please run `build-openssl -help` for usage details.
|
|
|
|
## Building with Visual C++
|
|
|
|
To build with VC++, you have to first install VC++ which is part of Visual
|
|
Studio.
|
|
|
|
Once you have VC++ installed you should launch the application and open one of
|
|
the solution or workspace files. The VC directory names are based on the
|
|
version of Visual C++ that you use. Each version of Visual Studio has a
|
|
default version of Visual C++. We offer these versions:
|
|
|
|
- VC10 (Visual Studio 2010 Version 10.0)
|
|
- VC11 (Visual Studio 2012 Version 11.0)
|
|
- VC12 (Visual Studio 2013 Version 12.0)
|
|
|
|
Separate solutions are provided for both libcurl and the curl command line
|
|
tool as well as a solution that includes both projects. libcurl.sln, curl.sln
|
|
and curl-all.sln, respectively. We recommend using curl-all.sln to build both
|
|
projects.
|
|
|
|
For example, if you are using Visual Studio 2010 then you should be able to
|
|
use `VC10\curl-all.sln` to build curl and libcurl.
|
|
|
|
## Running DLL based configurations
|
|
|
|
If you are a developer and plan to run the curl tool from Visual Studio with
|
|
any third-party libraries (such as OpenSSL or libssh2) then you need to add
|
|
the search path of these DLLs to the configuration's PATH environment. To do
|
|
that:
|
|
|
|
1. Open the 'curl-all.sln' or 'curl.sln' solutions
|
|
2. Right-click on the 'curl' project and select Properties
|
|
3. Navigate to 'Configuration Properties > Debugging > Environment'
|
|
4. Add `PATH='Path to DLL';C:\Windows\System32;C:\Windows;C:\Windows\System32\Wbem`
|
|
|
|
... where `Path to DLL` is the configuration specific path. For example the
|
|
following configurations in Visual Studio 2010 might be:
|
|
|
|
DLL Debug - DLL OpenSSL (Win32):
|
|
|
|
PATH=..\..\..\..\..\openssl\build\Win32\VC10\DLL Debug;C:\Windows\System32;
|
|
C:\Windows;C:\Windows\System32\Wbem
|
|
|
|
DLL Debug - DLL OpenSSL (x64):
|
|
|
|
PATH=..\..\..\..\..\openssl\build\Win64\VC10\DLL Debug;C:\Windows\System32;
|
|
C:\Windows;C:\Windows\System32\Wbem
|
|
|
|
If you are using a configuration that uses multiple third-party library DLLs
|
|
(such as `DLL Debug - DLL OpenSSL - DLL libssh2`) then 'Path to DLL' need to
|
|
contain the path to both of these.
|
|
|
|
## Notes
|
|
|
|
The following keywords have been used in the directory hierarchy:
|
|
|
|
- `<platform>` - The platform (For example: Windows)
|
|
- `<ide>` - The IDE (For example: VC10)
|
|
- `<architecture>` - The platform architecture (For example: Win32, Win64)
|
|
- `<configuration>` - The target configuration (For example: DLL Debug, LIB
|
|
Release - LIB OpenSSL)
|
|
|
|
Should you wish to help out with some of the items on the TODO list, or find
|
|
bugs in the project files that need correcting, and would like to submit
|
|
updated files back then please note that, whilst the solution files can be
|
|
edited directly, the templates for the project files (which are stored in the
|
|
git repository) need to be modified rather than the generated project files
|
|
that Visual Studio uses.
|
|
|
|
## Legacy Windows and SSL
|
|
|
|
Some of the project configurations use Schannel (Windows SSPI), the native SSL
|
|
library that comes with the Windows OS. Schannel in Windows 8 and earlier is
|
|
not able to connect to servers that no longer support the legacy handshakes
|
|
and algorithms used by those versions. If you are using curl in one of those
|
|
earlier versions of Windows you should choose another SSL backend like
|
|
OpenSSL.
|