Skip to content
Remote build execution technology for use in MSBuild, Microsoft Build Accelerator, and other build engines
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src/Branding
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
SECURITY.md

README.md

Microsoft AnyBuild

AnyBuild Icon

Introduction

AnyBuild is a build remote execution system that allows seamlessly remoting developer desktop and build agent load into Microsoft Azure. For larger code repositories this can result in significant speedups, particularly for less capable dev machines and build VMs. AnyBuild remotes the most expensive operations while leaving small build-test-rebuild commands just as fast.

See the London Build Meetup (October 1, 2019) slides.

AnyBuild handles build engines like MSBuild that do not specify inputs and outputs sufficiently for caching, and tools that bleed machine-specific paths into their outputs. Its Azure build agents do not need pre-installed tools; the tools are uploaded from the dev machine dynamically, cached for reuse, and executed under the same drive letters and paths as they would be on the dev machine or build agent, resulting in the same build outputs.

AnyBuild is based on sandboxing, caching, and virtualization technologies originally developed for Build Accelerator (BuildXL), mixed with the Projected Filesystem (ProjFS) filesystem virtualization driver originally created for the Virtual Filesystem for Git (formerly GVFS) on Windows 10. Its wire protocol is based on Google's Bazel Remote Execution API.

For a moderately large C++ heavy repo (500 proj files, 300 of them vcxproj) inside of Microsoft we see speedups of up to 40% on capable dev machines (6/12 cores, 64GB memory, SSD code drive) and much higher speedups for laptops and other lower-end client hardware.

6/12 Core Desktop Comparison

2/4 Core Laptop Comparison

(As of Sep 22, 2019. 25 build agents plus service coordinator VM in shared 96-core team pool with from 2 to 16 cores per agent, Azure D2 v2 Windows SKU, which would cost approximately $2000/month in VM time when running only during business hours 50 hours/week and paying full retail per-hour prices. cl.exe remoting only. Debug full build with no LTCG linking. MSBuild parallelism settings at +50% meaning /m:18 for the 6/12 core and /m:6 for the 2/4 core. AnyBuild MinParallelism=4 to remote only larger compilations.)

More Details

AnyBuild provides the following benefits for developers:

  • It extends a developer machine or build machine into the cloud by providing more cores, memory, and disk I/O buses to parallelize CPU-, memory-, and I/O-intensive build processes.
  • Typically we increase the parallelism settings for MSBuild by 50-100%.
  • It provides fast initial and upgrade deployment of Azure virtual machines as a shared pool for one or more developers in a team, flexible cost-benefit tradeoffs in the number and size of build agents, and control of when to turn the agent pool off and on to save costs. It's in your Azure subscription, under your control.
  • It solves the build agent installation problem: Instead of requiring installation of SDKs, packages, NodeJS and NPM, Python and Pip, and other artifacts onto remote exec agents, and trying to match client to agents at provisioning time, AnyBuild completely virtualizes the client machine filesystem into agents that have few or no installed components. Anything the user has installed that is needed for the build is added to the agent Content Addressable Store if not already available from previous runs. This provides a correct binary execution experience with a one-time cost to upload anything unique to a dev machine in the wild.
  • It supports incomplete input and output prediction - "non-hermetic actions" in Bazel terminology. Bazel and Goma require complete input file and directory, and output directory, prediction per remoted process or command. AnyBuild supports pluggable input and output predictors, but if the predictors are incomplete or buggy, or there is no predictor available, AnyBuild provides a correct - but slower - experience for the user by reaching back to the user's machine to get missing input files. The agent uses BuildXL sandboxing to watch the process execution and gather all of its outputs for return to the client machine.
  • Support for tools that rely on fully qualified paths: AnyBuild remotes all drive letters on a Windows dev machine, and executes processes within a virtualized environment that provides the exact same working directory and absolute paths.

What it doesn't do

  • No registry remoting. Tools must not rely on the agent's registry as there is nothing installed there but a base Windows 10 1903+ image.

Remoting More Than MSBuild

With specific settings you can remote just about anything, and wrap just about any top-level build process. AnyBuild uses Windows Detours logic to hook CreateProcess calls and decides what to remote and what to run locally.

We've run Gulp builds with remoting of Mocha unit tests. If the top-level build tool is a graphics rendering coordinator that can run multiple sub-processes in parallel, you can remote the rendering jobs to beefy multi-core or GPU-enabled agents (of course, check your software's licensing agreements, and remember if it checks the registry it's not going to work.) Refactor a TensorFlow training set into multiple sub-processes run under a build engine and remote the individual training processes to big agents.

Contributing

See CONTRIBUTING.

You can’t perform that action at this time.