mirrors/alioth
1
0
Fork 0
mirror of https://github.com/google/alioth.git synced 2024-11-24 04:09:36 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
432 commits 2 branches 6 tags 3.8 MiB
Rust 99.5%
ASL 0.5%
Find a file
Changyuan Lyu 08aa5a7012 docs: update README 
Signed-off-by: Changyuan Lyu <changyuanl@google.com>
2024-11-18 17:56:16 -08:00
.github ci: bump actions/cache from 4.1.1 to 4.1.2 2024-10-28 07:52:33 -07:00
alioth fix(vm): let device builders take immutable self 2024-11-16 22:35:54 -08:00
alioth-cli fix(vm): let device builders take immutable self 2024-11-16 22:35:54 -08:00
docs docs(sev): update sev guest instructions 2024-08-01 00:17:06 -07:00
macros feat(aco): add trait Help and the derive macro 2024-07-28 13:45:39 -07:00
serde-aco feat(help): implement Help for array types 2024-11-10 22:42:37 -08:00
serde-aco-derive chore: add description to serde-aco-derive 2024-09-02 20:46:22 -07:00
.gitignore chore(git): ignore vsocde configs 2024-04-26 00:06:54 -07:00
Cargo.lock chore(deps): Bump the patches group with 2 updates 2024-11-13 09:12:01 -08:00
Cargo.toml chore: bump version to 0.6.0 2024-10-29 22:01:52 -07:00
LICENSE Initial release 2024-04-24 19:34:14 -07:00
README.md docs: update README 2024-11-18 17:56:16 -08:00
rust-toolchain.toml build: use stable rust as default 2024-04-24 22:06:25 -07:00
rustfmt.toml Initial release 2024-04-24 19:34:14 -07:00

README.md

Alioth

GitHub Actions Workflow Status GitHub code size in bytes Crates.io Version Crates.io License

Alioth /AL-lee-oth/ is an experimental KVM-based type-2 hypervisor (virtual machine monitor) in Rust implemented from scratch.

Important

Disclaimer: Alioth is not an officially supported Google product.

Quick start

  • Install Alioth from source,

    cargo install alioth-cli --git https://github.com/google/alioth.git

  • Make an initramfs with u-root.

  • Boot a Linux kernel with 2 CPUs and 4 GiB memory,

    alioth -l info --log-to-file \
    run \
    --kernel /path/to/vmlinuz \
    --cmd-line "console=ttyS0" \
    --initramfs /path/to/initramfs \
    --memory size=4G \
    --num-cpu 2

Features

  • Runs on x86_64 and aarch64.
  • Boots confidential VMs with AMD SEV, SEV-ES, or SEV-SNP, see coco.md for details.
  • VirtIO devices
    • net backed by a tap device,
    • vsock backed by host /dev/vhost-vsock,
    • blk backed by a raw-formatted image,
    • entropy backed by host /dev/urandom,
    • fs backed by virtiofsd with experimental Direct Access (DAX),
    • (WIP) balloon with free page reporting.
  • PCI device passthrough based on VFIO/IOMMUFD.
  • Other devices
    • serial console: 16450 on x86_64, pl011 on aarch64,
    • fw_cfg (QEMU Firmware Configuration Device),
    • pvpanic.

TODOs

  • explore a better solution to ACPI DSDT to replace the pre-compiled AML bytes,
  • increase test coverage,
  • add missing documents,
  • (long term) port Alioth to Apple's Hypervisor framework,
  • performance, performance, and performance!

Acknowledgment

The virtualization implementation in Alioth takes the following projects as references,

The error handling practice is inspired by GreptimeDB's stack_trace_debug.