Merge pull request #4 from RWTH-OS/aarch64

add support for Apple Silicon

Author: stlankes

.github/workflows/build.yml

@@ -0,0 +1,27 @@
+name: Build
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+  schedule:
+    - cron: '0 3 * * 1'
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  build:
+    name: Build
+    runs-on: macos-11
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install toolchain from rust-toolchain.toml
+      run: rustup show
+    - name: Install missing targets
+      run: rustup target add aarch64-apple-darwin x86_64-apple-darwin
+    - name: Build for x86_64
+      run: cargo build --target x86_64-apple-darwin
+    - name: Build for aarch64
+      run: cargo build --target aarch64-apple-darwin

.github/workflows/format.yml

@@ -0,0 +1,21 @@
+name: Format
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  format:
+    name: Format
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install toolchain from rust-toolchain.toml
+        run: rustup show
+      - name: Format
+        run: cargo fmt --all -- --check

Cargo.toml

@@ -1,17 +1,18 @@
 [package]
 name = "xhypervisor"
-version = "0.0.12"
+version = "0.2.0"
 authors = ["Stefan Lankes", "Saurav Sachidanand"]
+edition = "2021"
 
 license = "MIT"
 repository = "https://www.github.com/RWTH-OS/xhypervisor"
 documentation = "https://docs.rs/xhypervisor/"
 readme = "README.md"
 description = " Hardware-accelerated virtualization on OS X"
-keywords = ["hypervisor", "virtualization", "osx", "x86", "VT-x"]
+keywords = ["hypervisor", "virtualization", "osx", "x86", "VT-x", "aarch64"]
 
 build = "build.rs"
 
 [dependencies]
-libc = "0.2.66"
+libc = "0.2"
 thiserror = "1.0"

README.md

@@ -6,6 +6,7 @@
 
 `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.
 
@@ -17,17 +18,18 @@ 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
+* 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 model-specific registers (MSRs)
+- [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
@@ -36,4 +38,4 @@ following in your Terminal:
   - [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)
+- [x] x86: Accessing fields of Virtual Machine Control Structures (VMCS)

app.entitlements

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+    <key>com.apple.security.hypervisor</key>
+    <true/>
+</dict>
+</plist>

build.rs

@@ -1,3 +1,4 @@
 fn main() {
 	println!("cargo:rustc-link-lib=framework=Hypervisor");
+	println!("link-arg=-mmacosx-version-min=11.0");
 }