Skip to content

feat(virtio): add generic vhost-user frontend device#5773

Open
meAmitPatil wants to merge 9 commits intofirecracker-microvm:mainfrom
superserve-ai:feat/generic-vhost-user
Open

feat(virtio): add generic vhost-user frontend device#5773
meAmitPatil wants to merge 9 commits intofirecracker-microvm:mainfrom
superserve-ai:feat/generic-vhost-user

Conversation

@meAmitPatil
Copy link
Copy Markdown

@meAmitPatil meAmitPatil commented Mar 18, 2026

Implement a generic vhost-user frontend device that is agnostic to the specific virtio device type being emulated. Unlike per-device-type frontends, this device delegates config space ownership entirely to the backend via the mandatory CONFIG protocol feature, allowing any virtio device type (e.g. virtio-fs, virtio-scsi) to be used without a
dedicated Firecracker frontend.

A VirtioDeviceType::VhostUserGeneric sentinel (0xFF) serves as the host-side MMIO map key, while a new mmio_device_type_id() trait method returns the real virtio type ID to the guest MMIO register. Queue count
is dynamic (Vec) since different device types need different configurations. Snapshotting is stubbed out, consistent with the existing vhost-user block device.

The device is configured via PUT /vhost-user-devices/{id} and tested end-to-end with virtiofsd — guest kernel recognises the device with the correct virtio type ID.

Closes #5687

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkbuild --all to verify that the PR passes
    build checks on all supported architectures.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
Comment on lines +97 to +99
- **Configuration space writes are not forwarded** to the backend. The
backend owns the configuration space in read-only mode from the guest
perspective.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a Firecracker limitation?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, This is an implementation limitation, not a protocol one. The vhost-user protocol supports forwarding writes via VHOST_USER_SET_CONFIG. I deferred it since most backends (virtiofsd, SPDK) don't rely on guest-initiated config writes, and the existing vhost-user block device in Firecracker follows the same pattern. Happy to add it in this PR if you think it should be included.

Comment on lines +100 to +102
- **The backend must be started before Firecracker.** Firecracker
connects to the socket during device configuration and will return an
error if the backend is not available.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before Firecracker is started, or before the device is attached? I’m guessing you mean the latter.

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're right, before the device is attached via the PUT /vhost-user-devices/{id} API call. Will fix the wording, thanks.

Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
@ShadowCurse
Copy link
Copy Markdown
Contributor

Hi @meAmitPatil, thank you for the PR. Unfortunately currently we don't have much bandwidth to give it a proper review, but after taking a quick look, it seems fine, but there are couple things to note:

  • We will need integration tests for this like we do with vhost-user-block
  • Since this is a generic device and it is very closely based on existing vhost-user-block, I think we should remove the duplication from existing vhost-user-block and use your generic backend for it instead.

Signed-off-by: Amit Patil <iamitpatil2001@gmail.com>
@meAmitPatil
Copy link
Copy Markdown
Author

Hi @meAmitPatil, thank you for the PR. Unfortunately currently we don't have much bandwidth to give it a proper review, but after taking a quick look, it seems fine, but there are couple things to note:

  • We will need integration tests for this like we do with vhost-user-block
  • Since this is a generic device and it is very closely based on existing vhost-user-block, I think we should remove the duplication from existing vhost-user-block and use your generic backend for it instead.

@ShadowCurse Thanks for taking a look! No worries on the review timeline. I've added integration tests. For the duplication refactor (using the generic backend for vhost-user-block), would you prefer that in this PR or as a
follow-up?

@ShadowCurse
Copy link
Copy Markdown
Contributor

For the duplication refactor (using the generic backend for vhost-user-block), would you prefer that in this PR or as a follow-up?

I see 2 ways here:

  1. Create generic impl first, use it for already existing vhost-user-block later (so the follow up PR strategy)
  2. Modify existing vhost-user-block to use generic code under the hood first, then expose generic path as a new device

I think option 2 is better since it removes a point in time when there is a big duplication of the vhost related code. It will also force generic code to be instantly compatible with the existing block device (in 1. case there can be a redundant refactoring of new generic code if some assumptions in it do not hold for block device).

I think both of these steps can be done in a single PR. Or at least both changes can start in a single PR, and if needed, it should be easy enough to split them.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Feature Request] Generic vhost-user

3 participants