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 utilizes the rutabaga crate v0.1.4 specifically the virglrenderer and gfxstream features.

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
VIRTIO_GPU_CMD_RESOURCE_ASSIGN_UUID

Add more tests to improve the code coverage
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>

staging/vhost-device-gpu/README.md

epilys

Suggestion: use the rustfmt.toml file from the sound device and run cargo +nightly fmt, this will format all comments, doc comments, imports, etc as well.

staging/vhost-device-gpu/CHANGELOG.md

staging/vhost-device-gpu/Cargo.toml

staging/vhost-device-gpu/README.md

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

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

staging/vhost-device-gpu/README.md

dorindabassey · 2024-10-30T08:07:46Z

Suggestion: use the rustfmt.toml file from the sound device and run cargo +nightly fmt, this will format all comments, doc comments, imports, etc as well.

Thank you for the review, I addressed them let me know if I missed any change.

epilys

Thanks for your patience 🫠 I recognize these are a lot of nits and addressing them takes time...

staging/vhost-device-gpu/CHANGELOG.md

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

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

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

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

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

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

dorindabassey · 2024-11-18T14:43:18Z

Hi @epilys @stefano-garzarella @bilelmoussaoui
we've (I and @mtjhrc) adressed the comments and changes and I think this PR is in a good shape. Can you let me know if there are any more issues to address on this PR?

stefano-garzarella · 2024-11-18T14:50:24Z

@dorindabassey can you rebase?

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

epilys

LGTM! Left minor comments and some questions about endianness for virtio gpu commands.

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

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

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

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

bilelmoussaoui

otherwise lgtm (from rust perspective obviously)

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

dorindabassey · 2024-11-20T10:20:49Z

Hi @stefano-garzarella @epilys, @bilelmoussaoui, I've rebased this PR and I think it's in a good shape now. Can you let me know if there are any more issues to address on this PR?

epilys

LGTM for merging, if you want to update the rust-vmm dependencies before merging this PR that also LGTM.

staging/vhost-device-gpu/Cargo.toml

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 device uses the rutabaga_gfx crate to offer two rendering backends: 1. Virglrenderer: - Rutabaga translates OpenGL API and Vulkan calls to an intermediate representation and allows for OpenGL acceleration on the host. 2. Gfxstream: - GLES and Vulkan calls are forwarded to the host. These backends can be used by simply changing the `--gpu-mode` 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 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>

stefano-garzarella

LGTM!

bilelmoussaoui

LGTM from my side as well

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 Outdated 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 force-pushed the vhost-gpu branch from 7c6e34e to 557dc96 Compare October 24, 2024 15:52

stefano-garzarella reviewed Oct 25, 2024

View reviewed changes

staging/vhost-device-gpu/README.md Show resolved Hide resolved

dorindabassey force-pushed the vhost-gpu branch 2 times, most recently from aa25731 to 11c9057 Compare October 29, 2024 15:08

epilys requested changes Oct 29, 2024

View reviewed changes

dorindabassey force-pushed the vhost-gpu branch from 11c9057 to 370a632 Compare October 30, 2024 08:04

dorindabassey force-pushed the vhost-gpu branch from 370a632 to 2100b8f Compare October 30, 2024 08:20

epilys requested changes Oct 30, 2024

View reviewed changes

staging/vhost-device-gpu/CHANGELOG.md Outdated Show resolved Hide resolved

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

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

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

bilelmoussaoui reviewed Oct 30, 2024

View reviewed changes

dorindabassey force-pushed the vhost-gpu branch from 2100b8f to 2c122e6 Compare October 31, 2024 14:20

epilys reviewed Nov 18, 2024

View reviewed changes

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

epilys requested changes Nov 18, 2024

View reviewed changes

bilelmoussaoui reviewed Nov 19, 2024

View reviewed changes

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

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

dorindabassey force-pushed the vhost-gpu branch 2 times, most recently from 2190df3 to 21335fe Compare November 20, 2024 10:16

epilys previously approved these changes Nov 20, 2024

View reviewed changes

staging/vhost-device-gpu/Cargo.toml Outdated Show resolved Hide resolved

dorindabassey dismissed epilys’s stale review via 3e1afa9 November 20, 2024 13:05

dorindabassey force-pushed the vhost-gpu branch from 21335fe to 3e1afa9 Compare November 20, 2024 13:05

dorindabassey force-pushed the vhost-gpu branch from 3e1afa9 to e8856d7 Compare November 20, 2024 13:19

stefano-garzarella enabled auto-merge (rebase) November 20, 2024 13:34

stefano-garzarella approved these changes Nov 20, 2024

View reviewed changes

bilelmoussaoui approved these changes Nov 20, 2024

View reviewed changes

epilys approved these changes Nov 20, 2024

View reviewed changes

stefano-garzarella merged commit 391e32b into rust-vmm:main Nov 20, 2024
2 checks passed

mtjhrc mentioned this pull request Nov 20, 2024

Consider changing the vhost-user-backend API rust-vmm/vhost#279

Open

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

epilys left a comment

dorindabassey commented Oct 30, 2024

epilys left a comment

dorindabassey commented Nov 18, 2024

stefano-garzarella commented Nov 18, 2024

epilys left a comment •

edited

Loading

bilelmoussaoui left a comment

dorindabassey commented Nov 20, 2024

epilys left a comment

stefano-garzarella left a comment

bilelmoussaoui left a comment

vhost-device-gpu: Add Initial Implementation #668

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

epilys left a comment

Choose a reason for hiding this comment

dorindabassey commented Oct 30, 2024

epilys left a comment

Choose a reason for hiding this comment

dorindabassey commented Nov 18, 2024

stefano-garzarella commented Nov 18, 2024

epilys left a comment • edited Loading

Choose a reason for hiding this comment

bilelmoussaoui left a comment

Choose a reason for hiding this comment

dorindabassey commented Nov 20, 2024

epilys left a comment

Choose a reason for hiding this comment

stefano-garzarella left a comment

Choose a reason for hiding this comment

bilelmoussaoui left a comment

Choose a reason for hiding this comment

dorindabassey commented Jun 6, 2024 •

edited

Loading

epilys left a comment •

edited

Loading

epilys left a comment •

edited

Loading