aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 6f37ae52da8042ff6376afbc132c8a744942d6fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
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
```