diff options
author | Andrew Walbran <qwandor@google.com> | 2020-09-28 15:12:58 +0100 |
---|---|---|
committer | Andrew Walbran <qwandor@google.com> | 2020-10-20 12:34:44 +0100 |
commit | 641348654deac902ddb0212cbb414c516d37ff49 (patch) | |
tree | 42dafdc8ac23493aa189bbf8a0de6dd233e5a9f4 /README.md | |
parent | 36c28ee478d2408f6aeab04a9ba2cc3a5d4e06f8 (diff) | |
download | vsock-641348654deac902ddb0212cbb414c516d37ff49.tar.gz |
Import vsock crate.
Bug: 171249434
Change-Id: I1b86487a9681af1007beb8a3b4dda64586ddde79
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e25c4b0 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# vsock-rs + +Virtio socket support for Rust. Implements VsockListener and VsockStream +which are analogous to the `std::net::TcpListener` and `std::net::TcpStream` types. + +## Usage + +Refer to the crate [documentation](https://docs.rs/vsock). + +## Testing + +### Prerequisites + +You will need a recent qemu-system-x86_64 build in your path. + +### Host + +Setup the required virtio kernel modules: + +``` +make kmod +``` + +Start the test vm, you can shutdown the vm with the keyboard shortcut ```Ctrl+A``` and then ```x```: + +``` +make vm +``` + +### Tests + +Run the test suite with: + +``` +make check +```
\ No newline at end of file |