Instruct the docs.rs documentation builder to pass --cfg
RUTSDOC_disable_feature_compat_errors in RUSTFLAGS when building
documentation, so that builds dont fail because of compile_error!() and
incompatible features [1].
[1]: https://docs.rs/crate/vhost/0.14.0/builds/2193201
Signed-off-by: Patrick Roy <patrick.roy@linux.dev>
Introduce a dummy feature to hack around `cargo doc --all-features`
always hitting the compile_error!(...) in vhost/src/lib.rs about
incompatible features.
This is happening because when documenting vhost-user-backend, cargo
does not pass --cfg doc to dependencies, meaning the cfg(not(doc))
attribute that is supposed to eliminate this compile_error!() invokation
when building docs does not actually trigger. Hence cargo doc fails.
Introduce a custom cfg, which we tell docs.rs to set during
documentation build, which disables the compile_error!(). Our CI also
sets this flag for the rustdoc step (via an ugly `sed` in the pipeline
definition). This cfg is also set by rust-vmm-ci for the cargo doc step.
Note that we need both cfg(not(doc)) and
cfg(not(RUTSDOC_disable_feature_compat_errors)), because lib.rs gets
processed twice, onces by rustc (where the --cfg is passed via
RUSTFLAGS), and once by rustdoc itself, where RUSTFLAGS are ignored, and
instead the cfg(doc) macro comes into play (but rustdoc is only ran on
the crate for which we are actually generating docs, not the
dependencies).
Signed-off-by: Patrick Roy <patrick.roy@linux.dev>
Now that rust-vmm-ci uses cargo-all-features, we can deal with the
incompatiblity of the xen and postcopy features by simply marking them
as incompatible in Cargo.toml, instead of needing to define separate CI
steps.
note: this commit currently symlinks rust-vmm-ci-tests.json to
rust-vmm-ci/.buildkite/test_descriptions.json, and removes all tests
from custom-tests.json. This is to illustrate that the new setup works
without changes to the buildkite pipeline. Once that is confirmed, the
pipeline should be updated to just use the rust-vmm-ci test generaiton
routine, and the entire .buildkite directory can be removed.
Signed-off-by: Patrick Roy <patrick.roy@linux.dev>
Set it up so that it does not try to combine the xen and postcopy
features, and also ignore the test-only test_utils feature.
Signed-off-by: Patrick Roy <patrick.roy@linux.dev>
By using ioctl_with_ref() instead of ioctl_with_mut_ref(), we attempted
to mutate through an immutable reference, so rustc was well within its
rights to assume that `vring_state` does not change across the ioctl
call, and hence optimize the return value of the function to simply be
the value that `vring_state.num` was initialized to (which is 0).
Signed-off-by: Patrick Roy <patrick.roy@linux.dev>
The vhost-device devices all call VhostUserDaemon::serve in a loop, to
handle reconnections. This is not ideal, because a new listener is
created each loop iteration, which means that each time, the old
socket is unlinked and a new one is created. This means that there's
a potential race where a frontend attempts to connect to the backend
before the new socket is created.
A more robust way to achieve this would be to have the devices create
their own listeners, and pass the same one to VhostUserDaemon::start
on each loop iteration, instead of letting VhostUserDaemon::serve
create it repeatedly. This was not previously possible though,
because VhostUserDaemon::start consumed the listener, even though it
didn't need to.
Because it's now possible to call VhostUserDaemon::start multiple
times with the same socket, I've removed the TODO about handling
reconnection.
Signed-off-by: Alyssa Ross <hi@alyssa.is>
warning: hiding a lifetime that's elided elsewhere is confusing
--> vhost/src/vhost_user/frontend.rs:131:13
|
131 | fn node(&self) -> MutexGuard<FrontendInternal> {
| ^^^^^ ---------------------------- the same lifetime is hidden here
| |
| the lifetime is elided here
|
= help: the same lifetime is referred to in inconsistent ways, making the signature confusing
= note: `#[warn(mismatched_lifetime_syntaxes)]` on by default
help: use `'_` for type paths
|
131 | fn node(&self) -> MutexGuard<'_, FrontendInternal> {
| +++
Signed-off-by: Alyssa Ross <hi@alyssa.is>
Eventfd is Linux-specific. To support more platforms, we replace it with
the EventNotifier/EventConsumer abstractions.
EventSender and EventReceiver are wrappers that encapsulate eventfd functionality
Use pipefd to replace eventfd in the test.
Signed-off-by: Wenyu Huang <huangwenyuu@outlook.com>
Update to v0.15.0 which supports sock_ctrl_msg on POSIX and adds
a cross platform event notification that uses EventFd when available
or pipe().
Because sock_ctrl_msg modifies the recv_with_fds, we need to modify the test
in vhost/src/vhost-user/connection.rs at the same time
Signed-off-by: Wenyu Huang <huangwenyuu@outlook.com>
It was already possible to do this as follows:
unsafe { Listener::from_raw_fd(listener.into_raw_fd()) }
This just factors the From implementation out of the FromRawFd
implementation so it's possible to do the conversion without an
unnecessary unsafe in application code.
Signed-off-by: Alyssa Ross <hi@alyssa.is>
clippy in the new rust toolchain (1.87) in our CI is highlighting
something to improve.
Mostly done with `cargo clippy --fix` + silence
`clippy::match_overlapping_arm` since EWOULDBLOCK equals to EGAIN on
linux.
Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
Building docs (as on docs.rs) has been broken since 8ee8739. This commit
introduces POSTCOPY and made this feature mutually exclusive with xen.
As docs are build for all features the corresponding check will be
triggered and the docs can not be built.
This patch extends the check to allow both "postcopy" and "xen" to be
enabled when building docs.
Signed-off-by: Christian Speich <christian@spei.ch>
There are several typos when using "truncate" on some messages and on the error type \`FileTruncateError\`.
Signed-off-by: Nelson Wong <wong.nel@protonmail.com>
There is a new warning reported by nightly compiler about mismatched
lifetime syntaxes. Add the missing lifetime where ever required.
Signed-off-by: Jinank Jain <jinankjain@microsoft.com>
This release
1. Adds support for `VHOST_USER_GET_SHARED_OBJECT`
2. Updates to vhost to 0.14.0, vm-memory 0.16.2 and vmm-sys-util to
0.14.0
Signed-off-by: Babis Chalios <bchalios@amazon.es>
This release:
1. Adds support for `VHOST_USER_GET_SHARED_OBJECT`
2. Fixes the reply header for an error case in POSTCOPY_ADVISE
3. `VHOST_USER_PROTOCOL_F_REPLY_ACK` is now always supported by backends
4. Bumps vm-memory to 0.16.2 and vmm-sys-util to 0.14.0
Signed-off-by: Babis Chalios <bchalios@amazon.es>
I observed hangs in the following situation when using Cloud
Hypervisor with virtiofsd:
1. Start virtiofsd
2. Start Cloud Hypervisor instance 1, connected to virtiofsd.
3. Start Cloud Hypervisor instance 2, waiting for migration.
4. Migrate VM from Cloud Hypervisor instance 1 to 2.
5. Start virtiofsd again.
The hangs happened because Cloud Hypervisor remembered, as part of the
migration data, which vhost-user protocol features the backend for its
fs device supported. Instance 2 therefore never sent
GET_PROTOCOL_FEATURES to the second invocation of virtiofsd. This
should work, but it didn't, because update_reply_ack_flag() checked
whether self.protocol_features contained GET_PROTOCOL_FEATURES, but
self.protocol_features is only filled in when GET_PROTOCOL_FEATURES is
called. As a result, Cloud Hypervisor expected a reply that virtiofsd
would never send.
Since REPLY_ACK is handled entirely by the vhost-user library, and not
by the backend, there's no need to ask the backend whether it supports
REPLY_ACK in the first place, so we can just drop the check for that
from update_reply_ack_flag(). We know that we always support it, so
we just need to check whether the backend has acked it. This fixes
the hang described above.
Since we will now always reply if the backend acks the feature,
REPLY_ACK is now always included in the set of features returned by
GET_PROTOCOL_FEATURES, just like with XEN_MMAP (when enabled).
Signed-off-by: Alyssa Ross <hi@alyssa.is>
Updates the requirements on [nix](https://github.com/nix-rust/nix) to permit the latest version.
Updates `nix` to 0.30.1
- [Changelog](https://github.com/nix-rust/nix/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nix-rust/nix/compare/v0.29.0...v0.30.1)
---
updated-dependencies:
- dependency-name: nix
dependency-version: 0.30.1
dependency-type: direct:production
dependency-group: vhost
...
Signed-off-by: dependabot[bot] <support@github.com>
[SG] adapted the memfd_create call to comply with the new nix v0.30
interface
Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
Update vm-sys-util crate from 0.12.1 to 0.14.0. Also, bump vm-memory to
latest 0.16.2 which uses that vmm-sys-util version.
Signed-off-by: Babis Chalios <bchalios@amazon.es>
For use in QEMU, I would like GuestMemoryRegion to return a BitmapSlice
instead of a &Bitmap. This adds some flexibility that QEMU needs in
order to support a single global dirty bitmap that is sliced by the
various GuestMemoryRegions.
However, this removes access to the BitmapReplace trait, because it is of
course not possible to replace a slice of the bitmap only. Fortunately,
vhost is built around the GM<> type alias, which has a pluggable bitmap
type but hardcodes the backend:
type GM<B> = GuestMemoryAtomic<GuestMemoryMmap<B>>;
and therefore `region` is known to be a GuestRegionMmap. Adding a
single dereference of the GuestRegionMmap returns the MmapRegion to
which the bitmap is attached, thus calling MmapRegion::bitmap() instead
of <GuestRegionMmap as GuestRegion>::bitmap().
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Our CI is being upgraded to Rust 1.85 and this will produce new warnings
from clippy like this one:
error: this `map_or` can be simplified
--> vhost/src/vhost_kern/mod.rs:79:12
|
79 | if GuestAddress(config_data.desc_table_addr)
| ____________^
80 | | .checked_add(desc_table_size)
81 | | .map_or(true, |v| !m.address_in_range(v))
| |_____________________________________________________^
|
= help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_map_or
= note: `-D clippy::unnecessary-map-or` implied by `-D warnings`
= help: to override `-D warnings` add `#[allow(clippy::unnecessary_map_or)]`
help: use is_none_or instead
|
79 ~ if GuestAddress(config_data.desc_table_addr)
80 + .checked_add(desc_table_size).is_none_or(|v| !m.address_in_range(v))
|
Apply the advice using `cargo clippy --fix`.
Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
New clippy version in the CI highlighted some code to improve.
This patch is generated using `clippy --fix ...`.
Fixed 2 type of warnings:
1 - error: the following explicit lifetimes could be elided: 'a
--> vhost-user-backend/src/bitmap.rs:109:6
|
109 | impl<'a> WithBitmapSlice<'a> for BitmapMmapRegion {
2 - error: unnecessary closure used to substitute value for `Option::None`
--> vhost-user-backend/src/handler.rs:356:21
|
356 | let vring = self
| _____________________^
357 | | .vrings
358 | | .get(index as usize)
359 | | .ok_or_else(|| VhostUserError::InvalidParam)?;
Signed-off-by: Stefano Garzarella <sgarzare@redhat.com>
Add frontend support of `VHOST_GET_SHARED_OBJECT` message
to request a file descriptor from the backend.
Signed-off-by: Dorinda Bassey <dbassey@redhat.com>
Add support for the `VHOST_USER_GET_SHARED_OBJECT` request
in the backend. The GET_SHARED_OBJECT message is only usable
when VhostUserProtocolFeatures::SHARED_OBJECT feature is
negotiated. This support involves implementing a new method
`get_shared_object` to enable the frontend to retrieve a fd
from the backend about shared objects. When the frontend
sends this `GET_SHARED_OBJECT` message to the backend, the
backend opens a fd for use, and sends it's fd to the frontend.
The implementation of the `get_shared_object` method is
optional, and ensure that the function `get_shared_object`
returns an error if the backend does not implement it.
If the back-end supports shared objects, it should return
a `File` representing the fd.
Signed-off-by: Dorinda Bassey <dbassey@redhat.com>
