crosvm/README.md
Zach Reizner be9feaa3d2 add LICENSE and README
TEST=None
BUG=None

Change-Id: I78e61545c6db18ae37925d02f7b0d6538deb6275
Reviewed-on: https://chromium-review.googlesource.com/478458
Commit-Ready: Zach Reizner <zachr@chromium.org>
Tested-by: Zach Reizner <zachr@chromium.org>
Reviewed-by: Stephen Barber <smbarber@chromium.org>
Reviewed-by: Dylan Reid <dgreid@chromium.org>
2017-04-17 14:06:21 -07:00

22 lines
809 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:
* `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
## Usage
Currently there is no front-end, so the best you can do is run `cargo test` in
each crate.