Skip to content
microsoftPublic

About

Cross-Platform Micro-VM Sandbox for Agentic Workloads

Topics

Resources

Code of conduct

Security policy

Stars

853 stars

Watchers

6 watching

Forks

Latest commit

 

History

3,779 Commits

Folders and files

Repository files navigation

NVX: An Ultra-Light Micro-VM Sandbox

NVX is an ultra-light micro-VM sandbox for running untrusted workloads with hardware-enforced isolation. It is built on top of OpenVMM and runs Linux as a guest.

NVX was jointly developed by the MSR Systems Research Group and Azure Research - Systems, building on research results from the Nanvix system.

This repository includes version pins for Linux, OpenVMM, and the Rust guest toolchain, along with the patches, guest source files, build tools, and benchmarks needed to use NVX. Alpine, Ubuntu, and Azure Linux ship the ten static guest binaries from nvx at their common /sbin/nvx-* paths.

Quick Start

Git and Rust are required; install Rust with rustup, which also installs Cargo. The commands below clone NVX, build nvx, the NVX command-line interface, and run a microVM. The first run downloads the prebuilt NVX package of the host's platform, from the release that CI built from the cloned revision when available, or from its nearest released first-parent ancestor otherwise, so the guest and OpenVMM need no build. The download uses the curl and tar of the host, which Windows 10 and later include. After you pull newer commits, nvx download installs their release; run downloads only into a checkout that holds no artifacts.

A successful boot prints NVX-GUEST-BOOT-OK: alpine and opens a root shell. The package also includes the Ubuntu and Azure Linux userlands: boot either with the same NVX kernel by adding --guest ubuntu or --guest azurelinux to nvx run. Exit cleanly from the guest with /sbin/nvx-exit 0. See the setup and run guides for detailed prerequisites and runtime options. To run without Rust, extract the package of a development release and run its bin/nvx. To build NVX from source instead, first initialize the openvmm submodule, which the clone below omits.

ℹ️ To run microVMs from a program of your own through the nvx library, see the library guide; for direct OpenVMM integration without nvx, see Run OpenVMM directly.

Linux / KVM

Requires KVM configured with read/write access to /dev/kvm.

git clone https://github.com/microsoft/nvx.git && cd nvx
cargo build --release --locked --features cli \
  --manifest-path nvx/Cargo.toml --target-dir nvx/target
nvx/target/release/nvx run

Linux / MSHV

Requires MSHV configured with read/write access to /dev/mshv.

git clone https://github.com/microsoft/nvx.git && cd nvx
cargo build --release --locked --features cli \
  --manifest-path nvx/Cargo.toml --target-dir nvx/target
nvx/target/release/nvx run --hypervisor mshv

Windows / WHP

Requires Windows Hypervisor Platform enabled.

git clone https://github.com/microsoft/nvx.git; Set-Location nvx
cargo build --release --locked --features cli `
    --manifest-path nvx/Cargo.toml --target-dir nvx/target
nvx\target\release\nvx.exe run

Documentation

Usage

  • Setup - Instructions for setting up your environment.
  • Build - Instructions for building NVX.
  • Run - Instructions for running NVX.
  • Benchmark - Instructions for benchmarking NVX.
  • Command-line reference - Complete nvx and scripts/nvx.py command and option reference.
  • NVX Rust crate - The nvx crate: the library of mechanisms and value types with which programs run NVX microVMs, and NVX's own programs, private to it.
  • Library guide - A cold boot, a restore, and a reattach through the nvx library, and what its caller owns.
  • Guest-agent guidelines - What an init agent owns in an NVX guest: its space, its executions, and its part in a capture and a restore.

Development

About

Cross-Platform Micro-VM Sandbox for Agentic Workloads

Topics

Resources

Code of conduct

Security policy

Stars

853 stars

Watchers

6 watching

Forks

Releases

Used by

Contributors

Languages