https://github.com/rwth-os/xhypervisor

Rust API to the OS X Hypervisor framework for hardware-accelerated virtualization
https://github.com/rwth-os/xhypervisor

hypervisor macos osx virtualization x86-64

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/rwth-os/xhypervisor
• Owner: RWTH-OS
• License: mit
• Created: 2019-12-27T14:02:00.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-05-02T11:27:29.000Z (over 2 years ago)
• Last Synced: 2024-10-05T17:18:03.824Z (3 months ago)
• Topics: hypervisor, macos, osx, virtualization, x86-64
• Language: Rust
• Homepage:
• Size: 122 KB
• Stars: 21
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# xhypervisor

[![crates.io](https://img.shields.io/crates/v/xhypervisor.svg)](https://crates.io/crates/xhypervisor)

[![Docs.rs](https://docs.rs/mio/badge.svg)](https://docs.rs/xhypervisor)

[![License](https://img.shields.io/crates/l/xhypervisor.svg)](https://img.shields.io/crates/l/xhypervisor.svg)

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

It is a fork of [hypervisor-rs](https://github.com/saurvs/hypervisor-rs) and modified for the development of [uhyve](https://github.com/hermitcore/uhyve) and [ehyve](https://github.com/RWTH-OS/ehyve).

Derived from [ahv](https://github.com/Thog/ahv), we added the support of Apple's Hypervisor Framework on Apple Silicon.

It binds to the [Hypervisor](https://developer.apple.com/documentation/hypervisor) framework on OS X, and exposes a safe Rust interface through the `hypervisor` module, and an unsafe foreign function interface through the `xhypervisor::ffi` module.

A xhypervisor derived from the [16 bits VM](https://github.com/mist64/hvdos/blob/master/hvdos.c) is used as test example, which was original published in blog post [http://www.pagetable.com/?p=764](http://www.pagetable.com/?p=764).

## Prerequisites

To use this library, you need

* OS X Yosemite (10.10), or newer

* a Intel processor with the VT-x feature or an Apple Silicon processor with virtualization support. To verify this, run and expect the

following in your Terminal:

  ```shell

  $ sysctl kern.hv_support

  kern.hv_support: 1

  ```

## Status

- **WARNING:** The Apple Silicon support is in an early state

- [x] Accessing x86 registers

- [x] Accessing aarch64 registers

- [x] x86: 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] x86: Accessing fields of Virtual Machine Control Structures (VMCS)