mirrors/alioth
1
0
Fork 0
mirror of https://github.com/google/alioth.git synced 2024-10-23 15:00:13 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
294 commits 1 branch 5 tags 3.6 MiB
Rust 99.5%
ASL 0.5%
Find a file
dependabot[bot] 83bb71214e build(deps): bump bitfield from 0.15.0 to 0.16.0 
Bumps [bitfield](https://github.com/dzamlo/rust-bitfield) from 0.15.0 to 0.16.0.
- [Changelog](https://github.com/dzamlo/rust-bitfield/blob/master/CHANGELOG.md)
- [Commits](https://github.com/dzamlo/rust-bitfield/compare/v0.15.0...v0.16.0)

---
updated-dependencies:
- dependency-name: bitfield
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-07-22 22:57:18 -07:00
.github chore: enable dependabot for cargo crates 2024-07-22 22:52:16 -07:00
alioth build(deps): bump bitfield from 0.15.0 to 0.16.0 2024-07-22 22:57:18 -07:00
alioth-cli feat(cli): add the flag for vfio devices 2024-07-20 23:35:38 -07:00
docs docs: fix typos and format the source 2024-07-14 11:44:32 -07:00
macros fix(errors): do not auto-transform trait objects 2024-07-06 13:51:44 -07:00
serde-aco fix(aco): report errors when ignoring inputs 2024-07-20 17:53:03 -07:00
.gitignore chore(git): ignore vsocde configs 2024-04-26 00:06:54 -07:00
Cargo.lock build(deps): bump bitfield from 0.15.0 to 0.16.0 2024-07-22 22:57:18 -07:00
Cargo.toml feat(hv)!: track error sources with snafu (1/n) 2024-06-09 10:11:22 -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

README.md

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.