pxcloud/vhost-device
5
0
Fork 0
mirror of https://github.com/rust-vmm/vhost-device.git synced 2025-12-26 14:41:23 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
32c7b0710f
vhost-device/staging/vhost-device-gpu
History
Dorinda Bassey 391e32b82f vhost-device-gpu: Add Initial Implementation 
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>
2024-11-20 15:02:02 +01:00
..
src vhost-device-gpu: Add Initial Implementation 2024-11-20 15:02:02 +01:00
Cargo.toml vhost-device-gpu: Add Initial Implementation 2024-11-20 15:02:02 +01:00
CHANGELOG.md vhost-device-gpu: Add Initial Implementation 2024-11-20 15:02:02 +01:00
LICENSE-APACHE vhost-device-gpu: Add Initial Implementation 2024-11-20 15:02:02 +01:00
LICENSE-BSD-3-Clause vhost-device-gpu: Add Initial Implementation 2024-11-20 15:02:02 +01:00
README.md vhost-device-gpu: Add Initial Implementation 2024-11-20 15:02:02 +01:00
rustfmt.toml vhost-device-gpu: Add Initial Implementation 2024-11-20 15:02:02 +01:00

README.md

vhost-device-gpu - GPU emulation backend daemon

Synopsis

vhost-device-gpu --socket-path <SOCKET>

Description

A virtio-gpu device using the vhost-user protocol.

Options

       -s, --socket-path <SOCKET>
              vhost-user Unix domain socket path

       -h, --help
              Print help

       -V, --version
              Print version

Limitations

We are currently only supporting sharing the display output to QEMU through a socket using the transfer_read operation triggered by VIRTIO_GPU_CMD_TRANSFER_FROM_HOST_3D to transfer data from and to virtio-gpu 3d resources. It'll be nice to have support for directly sharing display output resource using dmabuf.

This device does not yet support the VIRTIO_GPU_CMD_RESOURCE_CREATE_BLOB, VIRTIO_GPU_CMD_SET_SCANOUT_BLOB and VIRTIO_GPU_CMD_RESOURCE_ASSIGN_UUID features.

Currently this crate requires some necessary bits in order to move the crate out of staging:

  • Achieving a minimum of ~87% code coverage in the main vhost-device repository, which requires some additional unit tests to increase code coverage.
  • Addition of CLI arguments to specify the exact number of capsets and use a default capset configuration when no capset is specified rather than using hard-coded capset value.

Features

The device leverages the rutabaga_gfx crate to provide virglrenderer and gfxstream rendering. With Virglrenderer, Rutabaga translates OpenGL API and Vulkan calls to an intermediate representation and allows for OpenGL acceleration on the host. With the gfxstream rendering mode, GLES and Vulkan calls are forwarded to the host with minimal modification.

Examples

First start the daemon on the host machine using either of the 2 gpu modes:

  1. virgl-renderer
  2. gfxstream
host# vhost-device-gpu --socket-path /tmp/gpu.socket --gpu-mode virgl-renderer

With QEMU, there are two device front-ends you can use with this device. You can either use vhost-user-gpu-pci or vhost-user-vga, which also implements VGA, that allows you to see boot messages before the guest initializes the GPU. You can also use different display outputs (for example gtk or dbus). By default, QEMU also adds another VGA output, use -vga none to make sure it is disabled.

  1. Using vhost-user-gpu-pci

Start QEMU with the following flags:

-chardev socket,id=vgpu,path=/tmp/gpu.socket \
-device vhost-user-gpu-pci,chardev=vgpu,id=vgpu \
-object memory-backend-memfd,share=on,id=mem0,size=4G, \
-machine q35,memory-backend=mem0,accel=kvm \
-display gtk,gl=on,show-cursor=on \
-vga none
  1. Using vhost-user-vga

Start QEMU with the following flags:

-chardev socket,id=vgpu,path=/tmp/gpu.socket \
-device vhost-user-vga,chardev=vgpu,id=vgpu \
-object memory-backend-memfd,share=on,id=mem0,size=4G, \
-machine q35,memory-backend=mem0,accel=kvm \
-display gtk,gl=on,show-cursor=on \
-vga none

License

This project is licensed under either of