Skip to content

[vcpkg-cmake] Support CMake's FASTBuild generator, opt-in - #54969

Open
Daniel Johansson (djohansson) wants to merge 6 commits into
microsoft:masterfrom
djohansson:fastbuild-generator
Open

Daniel Johansson (djohansson) wants to merge 6 commits into
microsoft:masterfrom
djohansson:fastbuild-generator

Conversation

@djohansson

@djohansson Daniel Johansson (djohansson) commented Nov 9, 2026 •

Copy link
Copy Markdown
Contributor

This adds opt-in support for CMake's FASTBuild generator (CMake 4.2 and newer; vcpkg's own CMake is 4.4.4) to vcpkg_cmake_configure and vcpkg_cmake_build. The default generator doesn't change for any existing triplet or port.

  • A portfile can pass GENERATOR FASTBuild.
  • A triplet can set VCPKG_CMAKE_GENERATOR (for example set(VCPKG_CMAKE_GENERATOR FASTBuild)) to choose the generator for ports that don't pick one themselves. A portfile's own GENERATOR or WINDOWS_USE_MSBUILD still wins, so a port that must use Ninja can still say so.
  • FBuild is acquired like Ninja. vcpkg_find_acquire_program(FASTBUILD) calls z_use_vcpkg_fetch(FASTBUILD), and FASTBuild 1.20 is added to scripts/vcpkg-tools.json for Windows x64, Linux x64 and macOS (a universal binary). The Linux archive carries no file modes; vcpkg fetch marks the extracted executable as executable.
  • vcpkg_cmake_build passes -j${VCPKG_CONCURRENCY} to FBuild, or -j1 for DISABLE_PARALLEL, as it does for Ninja. Failure logs collect fbuild.bff, the file CMake's FASTBuild generator writes.

Why a change to a shared helper: the generator can only be chosen inside vcpkg_cmake_configure. Today using FASTBuild for every port means an overlay of vcpkg-cmake, which then has to track this port by hand. The change is inert unless a triplet or portfile asks for FASTBuild.

Motivation: I build my project and its vcpkg dependencies with FASTBuild, for its cache and distributed compilation, and I have been carrying this as an overlay of vcpkg-cmake and a fork of vcpkg.

Testing (macOS 27, arm64, vcpkg 2026-10-29 bootstrapped from this branch, binary caching off):

  • An overlay triplet, the stock arm64-osx.cmake plus set(VCPKG_CMAKE_GENERATOR FASTBuild). vcpkg install zlib jsoncpp --triplet arm64-osx-fastbuild --host-triplet arm64-osx --classic succeeds. FBuild was fetched to downloads/tools/fastbuild-1.20-osx, configure got -DCMAKE_MAKE_PROGRAM=<that>/FBuild, the build trees contain fbuild.bff, and config-*-rel-fbuild.log was collected.
  • The same install with the stock arm64-osx triplet still uses Ninja (build.ninja, no fbuild.bff).
  • I have not run this branch on Windows or Linux. The same approach, as an overlay of vcpkg-cmake, has built my project's dependencies (70 to 90 ports per platform) with FASTBuild on Windows x64 (clang), Linux x64 and macOS arm64 since March 2026.

Documentation: MicrosoftDocs/vcpkg-docs#624 (VCPKG_CMAKE_GENERATOR on the triplet variables page, the generator order in vcpkg_cmake_configure's GENERATOR, and FASTBUILD in vcpkg_find_acquire_program's list).

  • Changes comply with the maintainer guide.
  • SHA512s are updated for each updated download (the new FASTBuild entries in vcpkg-tools.json).
  • The version database is fixed by rerunning ./vcpkg x-add-version --all and committing the result.
  • Exactly one version is added in each modified versions file.

πŸ€– Generated with Claude Code

Copilot AI balanced review requested due to automatic review settings November 9, 2026 18:31

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟑 Changes recommended

The FASTBUILD acquisition script lacks the required platform- and architecture-guarded integration-test call, leaving its downloads and extracted executable paths outside existing test coverage.

1 open issue
What changed in this PR

Adds opt-in FASTBuild support to vcpkg’s CMake helpers while preserving existing default generator selection and port-level overrides.

Changes:

  • Allows FASTBuild selection through port arguments or the VCPKG_CMAKE_GENERATOR triplet variable.
  • Adds platform-specific tool downloads, parallel build arguments, and configure-log collection.
  • Updates the vcpkg-cmake version and registry metadata.
File Description
versions/​v-/​vcpkg-cmake.json Records the new helper version.
versions/​baseline.json Advances the helper’s baseline version.
scripts/​vcpkg-tools.json Adds FASTBuild downloads for Windows, Linux, and macOS.
scripts/​cmake/​vcpkg_find_acquire_program(FASTBUILD).cmake Delegates FASTBuild acquisition to vcpkg fetch.
ports/​vcpkg-cmake/​vcpkg.json Bumps the helper’s version date.
ports/​vcpkg-cmake/​vcpkg_cmake_configure.cmake Adds generator selection, tool setup, and FASTBuild log collection.
ports/​vcpkg-cmake/​vcpkg_cmake_build.cmake Adds FASTBuild parallelism controls.

Review effort: Balanced

djohansson

This comment was marked as duplicate.

@djohansson Daniel Johansson (djohansson) left a comment •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Daniel Johansson (@djohansson) please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term β€œYou” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (β€œAgreement”) is agreed to by the party signing below (β€œYou”),
and conveys certain license rights to Microsoft Corporation and its affiliates (β€œMicrosoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    β€œCode” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    β€œProject” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    β€œSubmit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as β€œNot a Submission.”
    β€œSubmission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase β€œSubmission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to β€œemployer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term β€œYou” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

agree

…aries

Windows x64, Linux x64 and macOS (universal), as review asked: the host's
architecture from PROCESSOR_ARCHITECTURE on Windows and uname -m on Linux,
as other acquisition scripts take it.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@djohansson

Copy link
Copy Markdown
Contributor Author

@microsoft-github-policy-service agree

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟒 Approval recommended

No active review issues were identified for the opt-in FASTBuild integration.

No open issues πŸŽ‰

1 resolved since last review

Review effort: Balanced

Daniel Johansson (djohansson) added a commit to djohansson/speedo that referenced this pull request Nov 9, 2026
…fix, in place of our fork of an older vcpkg port (the user's call). The fix, offered upstream once Windows has built it: libcxx requires libcxxabi only off MSVC targets, where LLVM's libcxxabi stops with a FATAL_ERROR (Windows takes libc++ over vcruntime), so llvm[libcxx] builds there. The fork's other differences move out of the port: the host triplets build llvm with Ninja (VCPKG_CMAKE_GENERATOR, which the vcpkg-cmake overlay now honors, as microsoft/vcpkg#54969 proposes), since CMake's FASTBuild generator can't build it: a custom target with DEPENDS but no COMMAND (clang's hmaptool, the fork's patch), a directory as a custom command OUTPUT (clangd's XPC framework) and, with clang-cl, precompiled headers that overwrite themselves (the notes' "PCH race", which isn't one: the PCH compile's /Fo is %2, the PCH, where FASTBuild takes %3). The first and last are fixed on two CMake branches for the user to submit, reproduced and tested on macOS (a clang-cl cross-build for the PCH). The macOS host triplet passes the fork's static libc++ and libc++abi, and clangd without XPC. vcpkg-cmake's logs name fbuild.bff (they named build.fastbuild), riding on the same rebuild. Measured: setup rebuilt the 78 host packages and the target packages in 60 min (LLVM 47 min with Ninja, 44 with FASTBuild before) and uploaded them to the shared cache; the install gained the static analyzer's tools (vcpkg's port builds it), nothing moved (libc++ static only, the sanitizers' runtimes where clang looks); the five presets build; the quick tier passes, profile (validated, 60 of 60 clients)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@BillyONeal

Billy O'Neal (BillyONeal) commented Nov 10, 2026 •

Copy link
Copy Markdown
Member

The arm64-windows failure is a baseline issue: https://dev.azure.com/vcpkg/public/_build/results?buildId=140614

No change requested here.

@BillyONeal Billy O'Neal (BillyONeal) left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@BillyONeal

Copy link
Copy Markdown
Member

Not included: documentation of VCPKG_CMAKE_GENERATOR for vcpkg-docs (the triplet variables page and vcpkg_cmake_configure). I can open that PR there if this direction is acceptable.

Yes please submit to https://github.com/microsoftdocs/vcpkg-docs/

@BillyONeal

Billy O'Neal (BillyONeal) commented Nov 11, 2026 •

Copy link
Copy Markdown
Member

Hmmm please don't push random merges unless there's a specific thing you're trying to change, each time you push it resets builds, and because this change changes almost every port that's resetting >2 days of work for the build lab, so if you keep pushing we will never be able to merge this.

(We are willing to merge through some kinds of baseline issues for this kind of world rebuild situation)

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants