File: README.md

package info (click to toggle)
rust-tokio-vsock 0.7.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 180 kB
  • sloc: makefile: 42
file content (41 lines) | stat: -rw-r--r-- 714 bytes parent folder | download
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
37
38
39
40
41
# tokio-vsock

Asynchronous Virtio socket support for Rust. The implementation is 
based off of Tokio and Mio's `TCPListener` and `TCPStream` interfaces.

## Use Cases

The most common use case for tokio-vsock would be writing agents for microvm
applications. Examples would include container runtimes.

## Usage

Refer to the crate [documentation](https://docs.rs/tokio-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
```