Uhyve is a minimal, special-purpose hypervisor for the Hermit kernel.
- Install the Rust toolchain. The Rust Foundation provides installation instructions.
- Install Uhyve:
cargo install --locked uhyveTo check if your system supports virtualization, you can use the following command:
if egrep -c '(vmx|svm)' /proc/cpuinfo > /dev/null; then echo "Virtualization support found"; fiUhyve on Linux depends on the virtualization solution KVM (Kernel-based Virtual Machine). If the following command gives you some output, you are ready to go!
lsmod | grep kvmNote
If the above steps don't work, make sure that you have enabled virtualization in your UEFI/BIOS settings.
Warning
Currently, Uhyve is mainly developed for Linux. The macOS version has not been tested extensively and does not support all features of the Linux version.
You can install Apple's Xcode Command Line Tools using the following command:
xcode-select --installAdditionally, the included hypervisor bases on the Hypervisor Framework depending on OS X Yosemite (10.10) or newer.
To verify if your processor is able to support this framework, run the following in your Terminal:
sysctl kern.hv_supportThe output kern.hv_support: 1 indicates virtualization support.
Starting with Big Sur, all processes using the Hypervisor API must have the com.apple.security.hypervisor entitlement and therefore must be signed.
To build from source, simply checkout the code and use cargo build:
git clone https://github.com/hermit-os/uhyve.git
cd uhyve
cargo build --releaseuhyve can be self-signed using the following command:
codesign -s - --entitlements app.entitlements --force path_to_uhyve/uhyveThe file app.entitlements must have following content:
<?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>For further information, please consult Apple's Documentation.
Assuming that you have installed Uhyve, run the hypervisor to start the unikernel:
uhyve /path/to/the/unikernel/binaryNote
This repository ships a few binaries that can be used for testing.
If you want to compile Hermit binaries yourself (or create your own), take a look at the following repositories:
Uhyve can be configured using command line arguments and environment variables. This example launches a virtual machine with 4 GiB of memory and 4 cores:
uhyve -m 4GiB -c 4 path/to/unikernelFor more options, the default values, and the corresponding environment variables run:
uhyve --help- Uhyve isn't able to pass more than 128 environment variables to the unikernel.
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
As mentioned above, the Uhyve repository ships some binaries that can be used for testing purposes.
cargo run -- data/x86_64/rusty_demo
cargo run -- data/x86_64/hello_world
cargo run -- data/x86_64/hello_cBasic support of (single-core) applications is already integrated into Uhyve.
By specifying variable HERMIT_GDB_PORT=port, Uhyve is working as gdbserver and is waiting on port port for a connection to a gdb.
For instance, with the following command Uhyve is waiting on port 6677 for a connection.
HERMIT_GDB_PORT=6677 uhyve /path_to_the_unikernel/hello_worldIn principle, every gdb-capable IDE should be able to debug Hermit applications. (Eclipse, VSCode, ...)
The repository hermit-rs provides example configuration files to debug a Hermit application with Visual Studio Code, VSCodium or derivatives of Eclipse Theia.
