Commit Graph

84 Commits

Author SHA1 Message Date
Priyansh Rathi
decfd8bd73 vsock: Add VM groups in sibling communication
Restrict the VMs a given VM can communicate with by introducing VM groups.
A group is simply a list of names assigned to the device in the
configuration. A VM can communicate with another VM only if the list of
group names assigned to their devices have atleast one group name in
common.

Signed-off-by: Priyansh Rathi <techiepriyansh@gmail.com>
2023-08-07 16:38:10 +05:30
Priyansh Rathi
bd59ff2462 vsock: Allow optional fields in config file
Currently need to provide all the fields in the yaml config file,
otherwise the application panics. Modify this behaviour to allow not
specifying the optional fields to make it consistent with specifying the
configuration using only CLI arguments.

Signed-off-by: Priyansh Rathi <techiepriyansh@gmail.com>
2023-08-07 16:38:10 +05:30
dependabot[bot]
005bdfa17a build(deps): bump num_enum from 0.5.11 to 0.6.1
Bumps [num_enum](https://github.com/illicitonion/num_enum) from 0.5.11 to 0.6.1.
- [Commits](https://github.com/illicitonion/num_enum/compare/0.5.11...0.6.1)

---
updated-dependencies:
- dependency-name: num_enum
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-31 10:37:24 +05:30
Jeongik Cha
637969d0e7 vsock: Increase NUM_QUEUES to 3
In virtio standard, vsock uses 3 vqs. crosvm expects 3 vqs from
vhost-user-vsock impl, but this vhost-user-vsock device sets up
only 2 vqs because event vq isn't handled. And it causes crash in
crosvm. To avoid crash in crosvm, I increase NUM_QUEUES to 3

Signed-off-by: Jeongik Cha <jeongik@google.com>
2023-07-28 09:58:36 +05:30
Jeongik Cha
c2ba07dc06 vsock: add warning message for EVT_QUEUE_EVENT
EVT_QUEUE_EVENT is an unexpected message from current impl, so add
warning for that

Signed-off-by: Jeongik Cha <jeongik@google.com>
2023-07-28 09:58:36 +05:30
Jeongik Cha
f2acb05c33 vsock: Set BACKEND_EVENT based on NUM_QUEUES
BACKEND_EVENT value depends on NUM_QUEUES, because it is the next value
of NUM_QUEUES, so set it based on NUM_QUEUES

Signed-off-by: Jeongik Cha <jeongik@google.com>
2023-07-28 09:58:36 +05:30
Jeongik Cha
9f10349f99 vsock: always epoll_register with cloned stream fd
VsockConnection::stream which is cloned is always used for
epoll_register, except add_new_guest_conn. Only in add_new_guest_conn,
the original stream is used.

Because a stream's raw fd is used for the key of listener_map, it cannot
find proper listener after the first packet.

Signed-off-by: Jeongik Cha <jeongik@google.com>
2023-07-27 16:40:40 +05:30
Stefano Garzarella
6305c66f22 scsi: replaced some leftover of vhost-user-scsi
There was some reference left in the documentation and sources to
"vhost-user-scsi" that we had changed during the rebase.
Let's change them to "vhost-device-scsi".

Everything should be safe.

We leave "vhost-user-scsi" in
crates/scsi/src/scsi/emulation/response_data.rs because it looks like
an identifier with some constant size. We will fix in the future.

Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
2023-07-24 12:15:23 +05:30
Stefano Garzarella
df9094d94d vsock: rename the package to vhost-device-vsock
All other devices follow the "vhost-device-*" pattern, while for
vsock we used "vhost-user-vsock". Let's rename this as well to be
consistent.

Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
2023-07-24 12:15:23 +05:30
Stefano Garzarella
540cc8758c vsock: add myself as an author
Harsha did most of the work, but I helped arrange the final
pieces and maintain it.

Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
2023-07-24 12:15:23 +05:30
Stefano Garzarella
66e1173d6d rng: fix clippy warning
`timer` variable does not need to be mutable as clippy reported:

    warning: variable does not need to be mutable
       --> crates/rng/src/vhu_rng.rs:127:17
        |
    127 |             let mut timer = &mut self.timer;

Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
2023-07-24 12:15:23 +05:30
Priyansh Rathi
6feb938c50 vsock: Try processing raw packets on other events too
Currently, the `raw_pkts_queue` is processed only when a
`SIBLING_VM_EVENT` is received. But it may happen that the
`raw_pkts_queue` could not be processed completely due to insufficient
space in the RX virtqueue at that time. So, try to process raw packets on
other events too similar to what happens in the RX of standard packets.

Signed-off-by: Priyansh Rathi <techiepriyansh@gmail.com>
2023-07-20 13:29:13 +05:30
Priyansh Rathi
e55b520cb2 vsock: Resolve deadlock in sibling VM communication
The deadlock occurs when two sibling VMs simultaneously try to send each
other packets. The `VhostUserVsockThread`s corresponding to both the VMs
hold their own locks while executing `thread_backend.send_pkt` and then
try to lock each other to access their counterpart's `raw_pkts_queue`.
This ultimately results in a deadlock.

Resolved by separating the mutex over `raw_pkts_queue` from the mutex over
`VhostUserVsockThread`.

Signed-off-by: Priyansh Rathi <techiepriyansh@gmail.com>
2023-07-20 13:29:13 +05:30
Viresh Kumar
bf75205478 crates: Don't warn for vhost_user::Error::Disconnected
The vhost_user::Error::Disconnected error code is returned by the
daemon if the VM is shutting down. Don't Warn the user in this case but
just point out that VM may be shutting down.

Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
2023-07-20 13:06:31 +05:30
Erik Schilling
3cab62ea02 rng: also pretty print configuration errors
If the parsed commandline options cannot be converted into a
`VuRngConfig` we would only get a .unwrap() error message.

Chain this before the check of the daemon launch.

Suggested-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-07-11 13:30:01 +05:30
Erik Schilling
a9de87a1ce tree-wide: bubble up errors from daemon threads
There was a mix of just unwrapping (panicking) and catching and logging
errors. The unwrapping is not allowing for particulary pretty error
handling, so let's bubble the errors up by not crashing the thread,
but by just returning a Result<()> than is received when joining the
threads.

Not all .unwrap() uses were translated since a followup PR (#389) will
rework that code anyway (and get rid of the .unwrap() in the process).

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-07-11 13:30:01 +05:30
Erik Schilling
2b1b3644da tree-wide: drop the Eq trait from Error
I plan to add some wrapper errors around vhost errors. These end up
nesting other errors all the way to std::error::Error, which has no
Eq trait.

The implementations were only used for comparisions in tests. While
there is a assert_matches!() in nightly [1] it seems unlikely that
further testing lib additions are getting standarized soon (or ever).

One could use assert!(matches!()), but that would worsen the error
messages for test failures. Hence, during review [2] we agreed on
introducing the assert_matches crate. It got no dependencies and
allows us to keep the good error messages while not needing to depend
on nightly.

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>

[1] https://doc.rust-lang.org/std/assert_matches/macro.assert_matches.html
[2] https://github.com/rust-vmm/vhost-device/pull/388#discussion_r1257831748
2023-07-11 13:30:01 +05:30
Erik Schilling
9332a933f8 tree-wide: actually pretty-print error messages
We setup pretty-printing with all the thiserror-based Error structs, but
then only bubble the error up to the main, where it just gets printed
with the `Debug` trait.

This "catches" the error in the main and performs pretty printing using
the `Display` trait.

Before:

    Error: FailedCreatingListener(SocketError(Os { code: 98, kind:
        AddrInUse, message: "Address already in use" }))

After:

    [2023-07-06T17:20:47Z ERROR vhost_device_scsi] Failed creating
        listener: socket error: Address already in use (os error 98)

vhost-device-vsock is a bit special since it does not let error messages
bubble up to the main. It also does .unwrap() in most places, but it
_does_  pretty print errors during the main request handling part.

Had to slightly adjust the coverage since we have no tests for the main
functions.

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-07-11 13:30:01 +05:30
Manos Pitsidianakis
8a1deef49a vsock: use tempfile in tests
Tests were run in a series before the previous commit because of a
testing failure (#232), and masked a bug. This is not necessary anymore
since the bug was fixed in the previous commit.

Instead of reverting to running the tests without the #[serial]
attribute, make every test self-contained by using unique temp
directories in each test run.

Test files that refer to sockets need to be unique because they risk
sharing filenames with other tests after refactoring. Since these tests
create/use/free resources, they should take care not to litter /tmp/ and
not share any file with other tests.

This commit uses a unique temp dir as location of test run files instead
of `/tmp/`. It adds a new dev-dependency, `tempfile`.

Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
2023-07-11 13:01:41 +05:30
Manos Pitsidianakis
7f809eeab8 vsock: fix use-after-close RawFd unsafe {} use
Using a raw file descriptor in `stream_map` caused two `UnixStream`
instances have a shared single reference to the underlying stream
socket. Use UnixStream::try_clone instead which duplicates the file
descriptor while still referring to the same stream.

Fixes #232

Signed-off-by: Manos Pitsidianakis <manos.pitsidianakis@linaro.org>
2023-07-11 13:01:41 +05:30
Ramyak Mehra
e24d3e52fc vsock: reduce credit update messages sent to guest
Earlier we were sending credit update messages to guest
everytime data was read, now we send it only if the available
space is less than 1/4th of the tx buffer size.

benchmarks:

host->guest[Gbps]

before   1.45
after    1.51

guest->host[Gbps]

before   5.68
after    6.07

Note: I did 3 runs of 10 secs and took average of all,
they are relative results.

Fixes #317

Signed-off-by: Ramyak Mehra <rmehra_be19@thapar.edu>

[SG: fixed S-o-b and small things in the commit description]

Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
2023-07-11 12:29:18 +05:30
Erik Schilling
7a371edc3e Add CHANGELOG.md to all crates
In order to prepare for an initial release of the crates, this adds a
CHANGELOG.md for tracking changes in the future releases.

The template was copied from the vhost crate [1].

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>

[1] 900b9a5c41/crates/vhost/CHANGELOG.md
2023-07-07 22:06:45 +05:30
Viresh Kumar
462a621485 Add support for Xen builds
Various rust-vmm dependencies now support Xen platforms under a new
feature `xen`. Add the same here for all the crates.

Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
2023-07-06 16:37:36 +05:30
Erik Schilling
0bb783601e Symlink license files into crate folders
Once we publish crates to crates.io, only the crate subfolder is
uploaded. Symlink the license files in in order to include them during
packaging.

`cargo package` will replace the symlinks with the actual files during
packaging, so crates.io will include the license file.

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-07-04 14:56:52 +05:30
Erik Schilling
2ebba0910c build(deps): switch to released virtio-bindings
This version brings the SCSI bindings and allows us to drop the git
dependency (which was complicating the packaging situation).

Thanks-to: Jiang Liu <gerry@linux.alibaba.com>
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-07-04 13:24:16 +05:30
Viresh Kumar
ad40227827 vsock: Fix build error with epoll-4.3.2
With epoll-4.3.2, bitflags moves to 2.3.3 from 1.3.2 and breaks the
build with following error:

error[E0369]: binary operation `!=` cannot be applied to type `Events`

Fix those by using the .bits() functions.

Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
2023-07-03 13:37:19 +05:30
dependabot[bot]
41f4cb1ab2 build(deps): bump epoll from 4.3.1 to 4.3.2
Bumps [epoll](https://github.com/nathansizemore/epoll) from 4.3.1 to 4.3.2.
- [Release notes](https://github.com/nathansizemore/epoll/releases)
- [Commits](https://github.com/nathansizemore/epoll/commits)

---
updated-dependencies:
- dependency-name: epoll
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-07-03 13:37:19 +05:30
Priyansh Rathi
4346438bff vsock: Compare packet src_cid with the configured guest CID
Cross-check the packet `src_cid` with the CID configured for the guest.
This will forbid a VM from impersonating another.

Signed-off-by: Priyansh Rathi <techiepriyansh@gmail.com>
2023-07-03 11:33:13 +05:30
Priyansh Rathi
d6b953e958 vsock: Implement sibling VM communication
Adds support for communication between sibling VMs that use the
vhost-user-vsock devices from the same vhost-user-vsock application.

Tested with nc-vsock patched to set `.svm_flags = VMADDR_FLAG_TO_HOST`:

host$ vhost-user-vsock \
      --vm guest-cid=3,uds-path=/tmp/vm3.vsock,socket=/tmp/vhost3.socket \
      --vm guest-cid=4,uds-path=/tmp/vm4.vsock,socket=/tmp/vhost4.socket

vm_cid3$ nc-vsock -l 1234
vm_cid4$ nc-vsock 3 1234

Signed-off-by: Priyansh Rathi <techiepriyansh@gmail.com>
2023-07-03 11:33:13 +05:30
Priyansh Rathi
015ccff9fc vsock: Handle the single VM case same as multiple VMs
In future, we could add the ability to change the configuration at runtime
and allow new guests to be added even without having to restart the
daemon. So it is reasonable to not differentiate between the single and
multiple VM cases, even with only one guest.

Signed-off-by: Priyansh Rathi <techiepriyansh@gmail.com>
2023-07-03 11:33:13 +05:30
dependabot[bot]
a893caa0d6 build(deps): bump clap from 4.3.5 to 4.3.8
Bumps [clap](https://github.com/clap-rs/clap) from 4.3.5 to 4.3.8.
- [Release notes](https://github.com/clap-rs/clap/releases)
- [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md)
- [Commits](https://github.com/clap-rs/clap/compare/v4.3.5...v4.3.8)

---
updated-dependencies:
- dependency-name: clap
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-06-26 11:22:46 +05:30
Erik Schilling
8ac1ce45c1 gpio: use libgpiod from crates.io
This simplifies the packaging and allows using existing tooling to
manage further updates.

The lock file was updated with:

    cargo update -p libgpiod --aggressive

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-06-14 20:07:27 +05:30
dependabot[bot]
93bdb73af2 build(deps): bump serial_test from 1.0.0 to 2.0.0
Bumps [serial_test](https://github.com/palfrey/serial_test) from 1.0.0 to 2.0.0.
- [Release notes](https://github.com/palfrey/serial_test/releases)
- [Commits](https://github.com/palfrey/serial_test/compare/v1.0.0...v2.0.0)

---
updated-dependencies:
- dependency-name: serial_test
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-06-14 12:55:57 +05:30
Priyansh Rathi
a4aabb15e1 vsock: Add support for multiple guests
Adds support for instantiating multiple `VhostUserVsockBackend`s parallely
to handle multiple guests. Extends the CLI interface to accept the config
for multiple VMs in addition to the yaml config file with the `--vm`
argument as follows:

vhost-user-vsock \
--vm guest_cid=3,socket=/tmp/vhost3.socket,uds_path=/tmp/vm3.vsock \
--vm guest_cid=4,socket=/tmp/vhost4.socket,uds_path=/tmp/vm4.vsock

Signed-off-by: Priyansh Rathi <techiepriyansh@gmail.com>
2023-06-08 13:09:16 +05:30
Erik Schilling
f50e7147df scsi: mention out-of-tree fuzzing infrastructure
Polishing this up for inclusion is currently not high on the priority
list, but we can at least link it.

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-06-05 14:55:32 +05:30
Erik Schilling
8bb862d415 scsi: add some helper scripts for testing
This provides some tooling for running blktests. The README.md contains
documentation about the architecture.

I am seeing some race-conditions that sometimes lead to boot
freezes [1], so this is not really ready for automatic evaluation during
a CI pipeline.

[1] https://linaro.atlassian.net/browse/ORKO-37

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
Link: https://linaro.atlassian.net/browse/ORKO-17
2023-06-05 14:55:32 +05:30
Erik Schilling
a6382dd937 scsi: add support for SYNCHRONIZE CACHE(10)
While the command also allows syncing individual regions of a LUN, we
do not support that here and simply sync the entire file.

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-06-05 14:55:32 +05:30
Erik Schilling
07b103b4d6 scsi: add support for WRITE SAME(16)
WRITE SAME allows writing a block for a repeated number of times.

Mostly, it can also be used to deallocate parts of the block device
(the fstrim functionality uses this). We do not support that aspect
yet. Instead, we will just stupidly repeat the pattern as many times
as we are told.

A future, smarter implementation could just punch a hole into the
backend instead of filling it with zeros.

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-06-05 14:55:32 +05:30
Erik Schilling
3adff11c94 scsi: add support for WRITE(10)
This adds write support. Being very similar to READ(10) in structure,
much of the code is very similar.

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-06-05 14:55:32 +05:30
Erik Schilling
4c8a2bc3ac scsi: Advertise support for CONFIG
The config that we send is based on the current QEMU defaults
(as of 60ca584b8af0de525656f959991a440f8c191f12).

This allows testing using Alex Bennee's vhost-user-generic series and
will be required for hypervisors that do not come with the stubs that
QEMU has (eg: Xen).

Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
Link: https://lore.kernel.org/all/20230414160433.2096866-1-alex.bennee@linaro.org/
2023-06-05 14:55:32 +05:30
Gaelan Steele
ad82d45928 scsi: Add documentation
Co-developed-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Gaelan Steele <gbs@canishe.com>
2023-06-05 14:55:32 +05:30
Erik Schilling
c07b42b662 scsi: Add tests for daemon and virtio code
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
2023-06-05 14:55:32 +05:30
Gaelan Steele
7abcad198b scsi: Add virtio daemon
This adds the virtio-specific parts that use the previously formed
interfaces and scsi emulation in order to build a daemon that offers files
from the host system as drives to the guest.

The vast majority of this work was done by Gaelan Steele as part of a
GSoC project [1][2].

[1] https://github.com/rust-vmm/vhost-device/pull/4
[2] https://gist.github.com/Gaelan/febec4e4606e1320026a0924c3bf74d0

Co-developed-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Gaelan Steele <gbs@canishe.com>
2023-06-05 14:55:32 +05:30
Gaelan Steele
1de6d02fb8 scsi: Add tests for the emulated target
The vast majority of this work was done by Gaelan Steele as part of a
GSoC project [1][2].

[1] https://github.com/rust-vmm/vhost-device/pull/4
[2] https://gist.github.com/Gaelan/febec4e4606e1320026a0924c3bf74d0

Co-developed-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Gaelan Steele <gbs@canishe.com>
2023-06-05 14:55:32 +05:30
Gaelan Steele
be1eaf3f79 scsi: Add an file-based target implementation
This implements the previously defined interface by emulating the commands
against a file-backed block device.

The vast majority of this work was done by Gaelan Steele as part of a
GSoC project [1][2].

[1] https://github.com/rust-vmm/vhost-device/pull/4
[2] https://gist.github.com/Gaelan/febec4e4606e1320026a0924c3bf74d0

Co-developed-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Gaelan Steele <gbs@canishe.com>
2023-06-05 14:55:32 +05:30
Gaelan Steele
a72a0a74e0 scsi: Add high-level scsi abstraction
This defines the basic interface that any scsi device will have to
implement (along with some sensing constants that may be useful to share).

The vast majority of this work was done by Gaelan Steele as part of a
GSoC project [1][2].

[1] https://github.com/rust-vmm/vhost-device/pull/4
[2] https://gist.github.com/Gaelan/febec4e4606e1320026a0924c3bf74d0

Co-developed-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Gaelan Steele <gbs@canishe.com>
2023-06-05 14:55:32 +05:30
Gaelan Steele
98c99b604e scsi: Initial boilerplate.
Co-developed-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Erik Schilling <erik.schilling@linaro.org>
Signed-off-by: Gaelan Steele <gbs@canishe.com>
2023-06-05 14:55:32 +05:30
Viresh Kumar
675789ef69 Update versions of all rust-vmm crates
Update versions of all rust-vmm crates to get away with build issues.

Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
2023-05-29 12:30:14 +05:30
dependabot[bot]
bea6e0981c build(deps): bump vhost from 0.6.0 to 0.7.0
Bumps [vhost](https://github.com/rust-vmm/vhost) from 0.6.0 to 0.7.0.
- [Release notes](https://github.com/rust-vmm/vhost/releases)
- [Commits](https://github.com/rust-vmm/vhost/compare/vhost-v0.6.0...vhost-v0.7.0)

---
updated-dependencies:
- dependency-name: vhost
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-05-29 12:30:14 +05:30
Li Zebin
d39e99cdd7 docs: fix the wrong file link in vsock README.md
Signed-off-by: Li Zebin <cutelizebin@gmail.com>
2023-05-22 09:37:33 +02:00