No description
Find a file
Changyuan Lyu 5733913533 refactor(virtio): replace actions with states
Signed-off-by: Changyuan Lyu <changyuanl@google.com>
2024-08-20 23:35:29 -07:00
.github ci: change dependabot interval to weekly 2024-08-19 09:46:58 -07:00
alioth refactor(virtio): replace actions with states 2024-08-20 23:35:29 -07:00
alioth-cli doc(cli): fix the example in --object help 2024-07-30 08:05:55 -07: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 fix(aco)!: report an error if an id is not found 2024-08-01 22:37:58 -07:00
serde-aco-derive feat(aco): add trait Help and the derive macro 2024-07-28 13:45:39 -07:00
.gitignore chore(git): ignore vsocde configs 2024-04-26 00:06:54 -07:00
Cargo.lock build(deps): bump libc from 0.2.156 to 0.2.158 2024-08-19 09:36:01 -07:00
Cargo.toml feat(aco): add trait Help and the derive macro 2024-07-28 13:45:39 -07:00
LICENSE Initial release 2024-04-24 19:34:14 -07:00
README.md feat(cli): add the flag for vfio devices 2024-07-20 23:35:38 -07: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

Alioth

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

Alioth 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 \
        --mem-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).
  • 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

  • device passthrough with VFIO,
  • 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.