hypervisor-rs icon indicating copy to clipboard operation
hypervisor-rs copied to clipboard

Rust API to the OS X Hypervisor framework for hardware-accelerated virtualization

hypervisor-rs

hypervisor is a Rust library that taps into functionality that enables hardware-accelerated execution of virtual machines on OS X.

It binds to the Hypervisor framework on OS X, and exposes a safe Rust interface through the hypervisor module, and an unsafe foreign function interface through the hypervisor::ffi module.

Documentation

Prerequisites

To use this library, you need

  • OS X Yosemite (10.10), or newer

  • an Intel processor with the VT-x feature set that includes Extended Page Tables (EPT) and the Unrestricted Mode. To verify this, run and expect the following in your Terminal:

    $ sysctl kern.hv_support
    kern.hv_support: 1
    

Status

  • [x] Accessing x86 registers
  • [x] Accessing model-specific registers (MSRs)
  • [x] Mapping guest physical memory segments into guest physical address space
  • [x] Virtual CPUs
    • [x] Executing and interrupting
    • [x] Force flushing cached state
    • [x] Invalidating translation lookaside buffer (TLB)
    • [x] Accessing floating point (FP) and SIMD state
    • [x] Obtaining cumulative execution time
    • [x] Synchronizing guest timestamp-counters (TSC)
  • [x] Accessing fields of Virtual Machine Control Structures (VMCS)