vhost-device-gpu: Add Initial Implementation #668

dorindabassey · 2024-06-06T16:30:14Z

Summary of the PR

I and @mtjhrc have been working on this PR that adds a new crate - vhost-device-gpu.
This vhost-device-gpu crate provides a vhost-user backend daemon for VIRTIO GPU device emulation as specified in the
VIRTIO Spec v.1.2

This crate utilizes the rutabaga crate Imported from crosvm commit: 02110bc6fcc6af70329f410aef8859ec70dd9224
rutabaga_gfx: fixes for crrev.com/c/5279413

The rutabaga crate is vendored because it contains minor modifications to rutabaga_gfx to make it compatible with vhost-device-gpu eventually we would use the upstream version when things are more stable.

This crate includes some modifications from crosvm and libkruns virtio-gpu device

This crate depends on this PR that implements support for QEMU's vhost-user-gpu protocol.

Supported features are:
Using gfxstream component from rutabaga.
Using virglrenderer component from rutabaga.
support the GPU device operations as specified by the virtio specification

TODO and nice to have items:
Add support for the remaining GPU device operations:

VIRTIO_GPU_CMD_RESOURCE_CREATE_BLOB
VIRTIO_GPU_CMD_SET_SCANOUT_BLOB

add support for directly sharing display output resource using dmabuf instead of copying it by using transfer_read operation.

Fixes: #598

Requirements

Before submitting your PR, please make sure you addressed the following
requirements:

All commits in this PR have Signed-Off-By trailers (with
git commit -s), and the commit message has max 60 characters for the
summary and max 75 characters for each description line.
All added/changed functionality has a corresponding unit/integration
test.
All added/changed public-facing functionality has entries in the "Upcoming
Release" section of CHANGELOG.md (if no such section exists, please create one).
Any newly added unsafe code is properly documented.

stefano-garzarella · 2024-06-06T16:36:47Z

@dorindabassey @mtjhrc great! Thanks for this PR. IIUC this is still WIP, so I marked as Draft, feel free to mark this ready when you want ;-)

dorindabassey · 2024-06-06T16:45:06Z

@dorindabassey @mtjhrc great! Thanks for this PR. IIUC this is still WIP, so I marked as Draft, feel free to mark this ready when you want ;-)

yes, Thanks. I see that it's failing on the CI, once that's resolved we can mark it ready.

stefano-garzarella · 2024-06-06T16:49:01Z

@dorindabassey @mtjhrc great! Thanks for this PR. IIUC this is still WIP, so I marked as Draft, feel free to mark this ready when you want ;-)

yes, Thanks. I see that it's failing on the CI, once that's resolved we can mark it ready.

Sure, but IMHO we should merge rust-vmm/vhost#239 first before marking this ready.

epilys

This is a complex device, you did such monumental effort!

Since it's large I'd have to re-read it a couple of times.

staging/vhost-device-gpu/README.md

staging/vhost-device-gpu/src/device.rs

staging/vhost-device-gpu/src/virtio_gpu.rs

staging/vhost-device-gpu/rutabaga_gfx/ffi/build.rs

dorindabassey · 2024-06-07T07:11:22Z

@dorindabassey @mtjhrc great! Thanks for this PR. IIUC this is still WIP, so I marked as Draft, feel free to mark this ready when you want ;-)

yes, Thanks. I see that it's failing on the CI, once that's resolved we can mark it ready.

Sure, but IMHO we should merge rust-vmm/vhost#239 first before marking this ready.

you're right, we can wait to merge the first PR.

the vhost-device-gpu crate linked here rust-vmm/vhost-device#668 contains rutabaga_gfx that requires epoxy library Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

staging/vhost-device-gpu/src/protocol.rs

This version adds fixes for libepoxy dependencies which is required for vhost-device-gpu crate more info about the crate can be found here: rust-vmm/vhost-device#668 Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

This version includes libepoxy dependencies which is required for vhost-device-gpu crate more info about the crate can be found here: rust-vmm/vhost-device#668 link to the container PR that adds libepoxy where the tag is generated can be found here: rust-vmm/rust-vmm-container#103 Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

the vhost-device-gpu crate linked here rust-vmm/vhost-device#668 contains rutabaga_gfx and the system library packages for rutabaga_gfx crate which is not available in the used ubuntu image, so install the neccessary packages that are available in ubuntu's repositories while for unavailable packages: build and install it manually. Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

The vhost-device-gpu crate linked here rust-vmm/vhost-device#668 contains rutabaga_gfx and the system library packages for rutabaga_gfx crate which is not available in the used ubuntu image, so install the neccessary packages that are available in ubuntu's repositories while for unavailable packages: build and install it manually. Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

This version includes vhost-device-gpu dependencies which is required for vhost-device-gpu crate more info about the crate can be found here: rust-vmm/vhost-device#668 link to the container PR that adds libepoxy where the tag is generated can be found here: rust-vmm/rust-vmm-container#107 Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

This version includes vhost-device-gpu dependencies which is required for vhost-device-gpu crate more info about the crate can be found here: rust-vmm/vhost-device#668 link to the PR that adds these dependencies where the tag is generated can be found here: rust-vmm/rust-vmm-container#107 Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

The vhost-device-gpu crate linked here rust-vmm/vhost-device#668 contains rutabaga_gfx and needs some packages and virglrenderer greater that 1.0.0 which is not available in the used ubuntu image, so install the neccessary packages that are available in ubuntu's repositories and for unavailable packages build and install it manually. Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

This version includes vhost-device-gpu dependencies which is required for vhost-device-gpu crate more info about the crate can be found here: rust-vmm/vhost-device#668 link to the PR that adds these dependencies where the tag is generated can be found here: rust-vmm/rust-vmm-container#110 Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

This program is a vhost-user backend daemon that provides VIRTIO GPU device emulation as specified in the VIRTIO Spec v.1.2 https://docs.oasis-open.org/virtio/virtio/v1.2/csd01/virtio-v1.2-csd01.html This crate utilizes the rutabaga crate from crosvm with some minor modification to rutabaga crate to fix compilation. This crate depends on this PR[rust-vmm/vhost#239] that implements support for QEMU's vhost-user-gpu protocol. This crate supports both gfxstream and virglrenderer library either of these libraries can be used by simply changing the `renderer` command line option. This crate also includes some modifications from libkrun virtio-gpu device https://github.com/containers/libkrun/tree/main/src/devices/src/virtio/gpu This device can be tested following the instructions explained in the README.md file under staging/vhost-device-gpu/. Fixes: rust-vmm#598 Co-authored-by: Dorinda Bassey <dbassey@redhat.com> Co-authored-by: Matej Hrica <mhrica@redhat.com> Signed-off-by: Dorinda Bassey <dbassey@redhat.com> Signed-off-by: Matej Hrica <mhrica@redhat.com>

update rust-vmm-ci manually skip this commit during merge Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

This version includes vhost-device-gpu dependencies which is required for vhost-device-gpu crate more info about the crate can be found here: rust-vmm/vhost-device#668 link to the PR that adds these dependencies where the tag is generated can be found here: rust-vmm/rust-vmm-container#110 Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

bilelmoussaoui · 2024-08-12T18:28:18Z

staging/vhost-device-gpu/src/lib.rs

+    pub fn get_socket_path(&self) -> PathBuf {
+        PathBuf::from(&self.socket_path.clone())
+    }


Suggested change

pub fn get_socket_path(&self) -> PathBuf {

PathBuf::from(&self.socket_path.clone())

}

pub fn get_socket_path(&self) -> std::path::Path {

self.socket_path.as_path()

}

bilelmoussaoui · 2024-08-12T18:28:49Z

staging/vhost-device-gpu/src/lib.rs

+}
+
+#[derive(Debug)]
+pub enum GpuError {


You should implement the std::error::Error trait

or use thiserror::Error

dorindabassey requested review from stsquad, vireshk, stefano-garzarella and epilys as code owners June 6, 2024 16:30

stefano-garzarella marked this pull request as draft June 6, 2024 16:36

dorindabassey force-pushed the vhost-gpu branch from 99a78da to 1b4b71b Compare June 6, 2024 16:37

epilys reviewed Jun 7, 2024

View reviewed changes

dorindabassey mentioned this pull request Jun 7, 2024

Add libepoxy dependencies for vhost-device-gpu rust-vmm/rust-vmm-container#103

Merged

4 tasks

dorindabassey force-pushed the vhost-gpu branch from 1b4b71b to 539e482 Compare June 10, 2024 14:39

dorindabassey force-pushed the vhost-gpu branch from 539e482 to 5007760 Compare June 18, 2024 11:26

epilys reviewed Jun 18, 2024

View reviewed changes

staging/vhost-device-gpu/src/protocol.rs Show resolved Hide resolved

dorindabassey force-pushed the vhost-gpu branch from 5007760 to 03e8486 Compare July 23, 2024 16:12

dorindabassey mentioned this pull request Jul 24, 2024

update container version to v35 rust-vmm/rust-vmm-ci#158

Merged

4 tasks

dorindabassey force-pushed the vhost-gpu branch from 03e8486 to 892d1bd Compare July 29, 2024 16:01

dorindabassey mentioned this pull request Jul 29, 2024

Build and install packages required by rutabaga_gfx rust-vmm/rust-vmm-container#107

Merged

4 tasks

dorindabassey mentioned this pull request Aug 5, 2024

update container version to v37 rust-vmm/rust-vmm-ci#160

Merged

4 tasks

dorindabassey force-pushed the vhost-gpu branch 3 times, most recently from 82ced48 to 95202dd Compare August 5, 2024 14:36

dorindabassey mentioned this pull request Aug 8, 2024

Build and install additional packages for rutabaga_gfx rust-vmm/rust-vmm-container#110

Merged

4 tasks

dorindabassey mentioned this pull request Aug 9, 2024

update container version to v38 rust-vmm/rust-vmm-ci#161

Merged

4 tasks

Dorinda Bassey added 2 commits August 9, 2024 14:26

update rust-vmm-ci manually

97d7966

update rust-vmm-ci manually skip this commit during merge Signed-off-by: Dorinda Bassey <dbassey@redhat.com>

dorindabassey force-pushed the vhost-gpu branch from 95202dd to 97d7966 Compare August 9, 2024 12:35

bilelmoussaoui reviewed Aug 12, 2024

View reviewed changes

dorindabassey marked this pull request as ready for review August 13, 2024 11:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

vhost-device-gpu: Add Initial Implementation #668

vhost-device-gpu: Add Initial Implementation #668

dorindabassey commented Jun 6, 2024 •

edited

Loading

stefano-garzarella commented Jun 6, 2024

dorindabassey commented Jun 6, 2024

stefano-garzarella commented Jun 6, 2024

epilys left a comment •

edited

Loading

dorindabassey commented Jun 7, 2024

bilelmoussaoui Aug 12, 2024

bilelmoussaoui Aug 12, 2024

bilelmoussaoui Aug 12, 2024

vhost-device-gpu: Add Initial Implementation #668

Are you sure you want to change the base?

vhost-device-gpu: Add Initial Implementation #668

Conversation

dorindabassey commented Jun 6, 2024 • edited Loading

Summary of the PR

Requirements

stefano-garzarella commented Jun 6, 2024

dorindabassey commented Jun 6, 2024

stefano-garzarella commented Jun 6, 2024

epilys left a comment • edited Loading

Choose a reason for hiding this comment

dorindabassey commented Jun 7, 2024

bilelmoussaoui Aug 12, 2024

Choose a reason for hiding this comment

bilelmoussaoui Aug 12, 2024

Choose a reason for hiding this comment

bilelmoussaoui Aug 12, 2024

Choose a reason for hiding this comment

dorindabassey commented Jun 6, 2024 •

edited

Loading

epilys left a comment •

edited

Loading