crosvm/README.md
Zach Reizner 639d96775c crosvm: Add crosvm main program
This program is used to boot a 64-bit kernel elf. It has support for
basic devices that are exposed to the kernel, including a block device.

TEST=cargo test;
     cargo run -- -m 512 -c 4 -d rootfs.squashfs -u -p "init=/bin/bash" vmlinux
BUG=chromium:712319

Change-Id: I25a8349a4624d8643fefe2ad70e517fe03b16b8c
Reviewed-on: https://chromium-review.googlesource.com/514417
Commit-Ready: Zach Reizner <zachr@chromium.org>
Tested-by: Zach Reizner <zachr@chromium.org>
Reviewed-by: Dylan Reid <dgreid@chromium.org>
2017-07-05 21:54:52 -07:00

25 lines
933 B
Markdown

# Chrome OS KVM
This component, known as crosvm, runs untrusted operating systems along with
virtualized devices. No actual hardware is emulated. This only runs VMs
through the Linux's KVM interface. What makes crosvm unique is a focus on
safety within the programming language and a sandbox around the virtual
devices to protect the kernel from attack in case of an exploit in the
devices.
## Overview
The crosvm source code is organized into crates, each with their own
unit tests. These crates are:
* `kernel_loader` Loads elf64 kernel files to a slice of memory.
* `kvm_sys` low-level (mostly) auto-generated structures and constants for using KVM
* `kvm` unsafe, low-level wrapper code for using kvm_sys
* `crosvm` the top-level binary front-end for using crosvm
* `x86_64` Support code specific to 64 bit intel machines.
## Usage
Currently there is no front-end, so the best you can do is run `cargo test` in
each crate.