Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 3.03 KB

windows.md

File metadata and controls

82 lines (55 loc) · 3.03 KB

Getting started on Windows

This page provides instructions for installing the necessary dependencies to build OpenVMM on Windows.

We _strongly_ suggest using [WSL2](./linux.md) for OpenVMM development, rather
than developing on Windows directly.

Developing in WSL2 offers a smoother development experience, while still
allowing you to build and run OpenVMM on Windows through the use of
[cross compilation](./suggested_dev_env.md#wsl2-cross-compiling-from-wsl2-to-windows).

Additionally, it allows you to have a single clone of the OpenVMM repo
suitable for both OpenVMM and OpenHCL development.

You must be running a recent version of Windows 11. Windows 10 is no longer supported as a development platform, due to needed WHP APIs.

NOTE: OpenHCL does NOT build on Windows.

If you are interested in building OpenHCL, please follow the getting started guide for Linux / WSL2.

Installing Rust

To build OpenVMM, you first need to install Rust.

The OpenVMM project actively tracks the latest stable release of Rust, though it may take a week or two after a new stable is released until OpenVMM switches over to it.

Please follow the official instructions to do so.

Visual Studio C++ Build Tools and Windows SDK

If you don't already have it, you will need to install Visual Studio C++ Build tools or Visual Studio with the components "Desktop Development for C++" and the Windows SDK. Windows 11 SDK version 26100 is the latest version as of this update, but you should install the newest version if there is a newer version.

The C++ build tools can be installed via Visual Studio Installer -> Modify -> Individual Components -> MSVC v143 - VS 2022 C++ x64/x86 build tools (latest).

The Windows SDK can be installed via Visual Studio Installer -> Modify -> Individual Components -> Windows 11 SDK (10.0.26100.0).

The C++ build tools and Windows SDK can be installed at the same time.

Or, you can install the tool via the powershell command below.

PS> winget install Microsoft.VisualStudio.2022.Community --override "--quiet --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows11SDK.26100"

Aarch64 support

To build ARM64, you need an additional dependency. This can be installed via Visual Studio Installer -> Modify -> Individual Components -> MSVC v143 - VS 2022 C++ ARM64/ARM64EC build tools (latest).

Or, you can install the tool via the powershell command below.

PS> winget install Microsoft.VisualStudio.2022.Community --override "--quiet --add Microsoft.VisualStudio.Component.VC.Tools.ARM64"

Cloning the OpenVMM source

If you haven't already installed git, you can download it here.

PS> git clone https://github.com/microsoft/openvmm.git

Next Steps

You are now ready to build OpenVMM!