README.md
1# vsock-rs
2
3Virtio socket support for Rust. Implements VsockListener and VsockStream
4which are analogous to the `std::net::TcpListener` and `std::net::TcpStream` types.
5
6## Usage
7
8Refer to the crate [documentation](https://docs.rs/vsock).
9
10## Testing
11
12### Prerequisites
13
14You will need a recent `qemu-system-x86_64` build in your path.
15
16### Host
17
18Setup the required virtio kernel modules:
19
20```
21make kmod
22```
23
24Start the test vm, you can shutdown the vm with the keyboard shortcut `Ctrl+A` and then `x`:
25
26```
27make vm
28```
29
30### Tests
31
32Run the test suite with:
33
34```
35make check
36```
37