2 * vhost-user GPU Device
4 * Copyright Red Hat, Inc. 2018
7 * Marc-André Lureau <marcandre.lureau@redhat.com>
9 * This work is licensed under the terms of the GNU GPL, version 2 or later.
10 * See the COPYING file in the top-level directory.
13 #include "qemu/osdep.h"
14 #include "qemu/error-report.h"
15 #include "qemu/sockets.h"
16 #include "hw/qdev-properties.h"
17 #include "hw/virtio/virtio-gpu.h"
18 #include "chardev/char-fe.h"
19 #include "qapi/error.h"
20 #include "migration/blocker.h"
22 typedef enum VhostUserGpuRequest
{
23 VHOST_USER_GPU_NONE
= 0,
24 VHOST_USER_GPU_GET_PROTOCOL_FEATURES
,
25 VHOST_USER_GPU_SET_PROTOCOL_FEATURES
,
26 VHOST_USER_GPU_GET_DISPLAY_INFO
,
27 VHOST_USER_GPU_CURSOR_POS
,
28 VHOST_USER_GPU_CURSOR_POS_HIDE
,
29 VHOST_USER_GPU_CURSOR_UPDATE
,
30 VHOST_USER_GPU_SCANOUT
,
31 VHOST_USER_GPU_UPDATE
,
32 VHOST_USER_GPU_DMABUF_SCANOUT
,
33 VHOST_USER_GPU_DMABUF_UPDATE
,
34 VHOST_USER_GPU_GET_EDID
,
35 } VhostUserGpuRequest
;
37 typedef struct VhostUserGpuDisplayInfoReply
{
38 struct virtio_gpu_resp_display_info info
;
39 } VhostUserGpuDisplayInfoReply
;
41 typedef struct VhostUserGpuCursorPos
{
45 } QEMU_PACKED VhostUserGpuCursorPos
;
47 typedef struct VhostUserGpuCursorUpdate
{
48 VhostUserGpuCursorPos pos
;
51 uint32_t data
[64 * 64];
52 } QEMU_PACKED VhostUserGpuCursorUpdate
;
54 typedef struct VhostUserGpuScanout
{
58 } QEMU_PACKED VhostUserGpuScanout
;
60 typedef struct VhostUserGpuUpdate
{
67 } QEMU_PACKED VhostUserGpuUpdate
;
69 typedef struct VhostUserGpuDMABUFScanout
{
80 } QEMU_PACKED VhostUserGpuDMABUFScanout
;
82 typedef struct VhostUserGpuEdidRequest
{
84 } QEMU_PACKED VhostUserGpuEdidRequest
;
86 typedef struct VhostUserGpuMsg
{
87 uint32_t request
; /* VhostUserGpuRequest */
89 uint32_t size
; /* the following payload size */
91 VhostUserGpuCursorPos cursor_pos
;
92 VhostUserGpuCursorUpdate cursor_update
;
93 VhostUserGpuScanout scanout
;
94 VhostUserGpuUpdate update
;
95 VhostUserGpuDMABUFScanout dmabuf_scanout
;
96 VhostUserGpuEdidRequest edid_req
;
97 struct virtio_gpu_resp_edid resp_edid
;
98 struct virtio_gpu_resp_display_info display_info
;
101 } QEMU_PACKED VhostUserGpuMsg
;
103 static VhostUserGpuMsg m
__attribute__ ((unused
));
104 #define VHOST_USER_GPU_HDR_SIZE \
105 (sizeof(m.request) + sizeof(m.size) + sizeof(m.flags))
107 #define VHOST_USER_GPU_MSG_FLAG_REPLY 0x4
109 #define VHOST_USER_GPU_PROTOCOL_F_EDID 0
111 static void vhost_user_gpu_update_blocked(VhostUserGPU
*g
, bool blocked
);
114 vhost_user_gpu_handle_cursor(VhostUserGPU
*g
, VhostUserGpuMsg
*msg
)
116 VhostUserGpuCursorPos
*pos
= &msg
->payload
.cursor_pos
;
117 struct virtio_gpu_scanout
*s
;
119 if (pos
->scanout_id
>= g
->parent_obj
.conf
.max_outputs
) {
122 s
= &g
->parent_obj
.scanout
[pos
->scanout_id
];
124 if (msg
->request
== VHOST_USER_GPU_CURSOR_UPDATE
) {
125 VhostUserGpuCursorUpdate
*up
= &msg
->payload
.cursor_update
;
126 if (!s
->current_cursor
) {
127 s
->current_cursor
= cursor_alloc(64, 64);
130 s
->current_cursor
->hot_x
= up
->hot_x
;
131 s
->current_cursor
->hot_y
= up
->hot_y
;
133 memcpy(s
->current_cursor
->data
, up
->data
,
134 64 * 64 * sizeof(uint32_t));
136 dpy_cursor_define(s
->con
, s
->current_cursor
);
139 dpy_mouse_set(s
->con
, pos
->x
, pos
->y
,
140 msg
->request
!= VHOST_USER_GPU_CURSOR_POS_HIDE
);
144 vhost_user_gpu_send_msg(VhostUserGPU
*g
, const VhostUserGpuMsg
*msg
)
146 qemu_chr_fe_write(&g
->vhost_chr
, (uint8_t *)msg
,
147 VHOST_USER_GPU_HDR_SIZE
+ msg
->size
);
151 vhost_user_gpu_unblock(VhostUserGPU
*g
)
153 VhostUserGpuMsg msg
= {
154 .request
= VHOST_USER_GPU_DMABUF_UPDATE
,
155 .flags
= VHOST_USER_GPU_MSG_FLAG_REPLY
,
158 vhost_user_gpu_send_msg(g
, &msg
);
162 vhost_user_gpu_handle_display(VhostUserGPU
*g
, VhostUserGpuMsg
*msg
)
164 QemuConsole
*con
= NULL
;
165 struct virtio_gpu_scanout
*s
;
167 switch (msg
->request
) {
168 case VHOST_USER_GPU_GET_PROTOCOL_FEATURES
: {
169 VhostUserGpuMsg reply
= {
170 .request
= msg
->request
,
171 .flags
= VHOST_USER_GPU_MSG_FLAG_REPLY
,
172 .size
= sizeof(uint64_t),
174 .u64
= (1 << VHOST_USER_GPU_PROTOCOL_F_EDID
)
178 vhost_user_gpu_send_msg(g
, &reply
);
181 case VHOST_USER_GPU_SET_PROTOCOL_FEATURES
: {
184 case VHOST_USER_GPU_GET_DISPLAY_INFO
: {
185 struct virtio_gpu_resp_display_info display_info
= { {} };
186 VhostUserGpuMsg reply
= {
187 .request
= msg
->request
,
188 .flags
= VHOST_USER_GPU_MSG_FLAG_REPLY
,
189 .size
= sizeof(struct virtio_gpu_resp_display_info
),
192 display_info
.hdr
.type
= VIRTIO_GPU_RESP_OK_DISPLAY_INFO
;
193 virtio_gpu_base_fill_display_info(VIRTIO_GPU_BASE(g
), &display_info
);
194 memcpy(&reply
.payload
.display_info
, &display_info
,
195 sizeof(display_info
));
196 vhost_user_gpu_send_msg(g
, &reply
);
199 case VHOST_USER_GPU_GET_EDID
: {
200 VhostUserGpuEdidRequest
*m
= &msg
->payload
.edid_req
;
201 struct virtio_gpu_resp_edid resp
= { {} };
202 VhostUserGpuMsg reply
= {
203 .request
= msg
->request
,
204 .flags
= VHOST_USER_GPU_MSG_FLAG_REPLY
,
205 .size
= sizeof(reply
.payload
.resp_edid
),
208 if (m
->scanout_id
>= g
->parent_obj
.conf
.max_outputs
) {
209 error_report("invalid scanout: %d", m
->scanout_id
);
213 resp
.hdr
.type
= VIRTIO_GPU_RESP_OK_EDID
;
214 virtio_gpu_base_generate_edid(VIRTIO_GPU_BASE(g
), m
->scanout_id
, &resp
);
215 memcpy(&reply
.payload
.resp_edid
, &resp
, sizeof(resp
));
216 vhost_user_gpu_send_msg(g
, &reply
);
219 case VHOST_USER_GPU_SCANOUT
: {
220 VhostUserGpuScanout
*m
= &msg
->payload
.scanout
;
222 if (m
->scanout_id
>= g
->parent_obj
.conf
.max_outputs
) {
226 g
->parent_obj
.enable
= 1;
227 s
= &g
->parent_obj
.scanout
[m
->scanout_id
];
231 dpy_gfx_replace_surface(con
, NULL
);
233 s
->ds
= qemu_create_displaysurface(m
->width
, m
->height
);
234 /* replace surface on next update */
239 case VHOST_USER_GPU_DMABUF_SCANOUT
: {
240 VhostUserGpuDMABUFScanout
*m
= &msg
->payload
.dmabuf_scanout
;
241 int fd
= qemu_chr_fe_get_msgfd(&g
->vhost_chr
);
244 if (m
->scanout_id
>= g
->parent_obj
.conf
.max_outputs
) {
245 error_report("invalid scanout: %d", m
->scanout_id
);
252 g
->parent_obj
.enable
= 1;
253 con
= g
->parent_obj
.scanout
[m
->scanout_id
].con
;
254 dmabuf
= &g
->dmabuf
[m
->scanout_id
];
255 if (dmabuf
->fd
>= 0) {
259 dpy_gl_release_dmabuf(con
, dmabuf
);
261 dpy_gl_scanout_disable(con
);
264 *dmabuf
= (QemuDmaBuf
) {
266 .width
= m
->fd_width
,
267 .height
= m
->fd_height
,
268 .stride
= m
->fd_stride
,
269 .fourcc
= m
->fd_drm_fourcc
,
270 .y0_top
= m
->fd_flags
& VIRTIO_GPU_RESOURCE_FLAG_Y_0_TOP
,
272 dpy_gl_scanout_dmabuf(con
, dmabuf
);
275 case VHOST_USER_GPU_DMABUF_UPDATE
: {
276 VhostUserGpuUpdate
*m
= &msg
->payload
.update
;
278 if (m
->scanout_id
>= g
->parent_obj
.conf
.max_outputs
||
279 !g
->parent_obj
.scanout
[m
->scanout_id
].con
) {
280 error_report("invalid scanout update: %d", m
->scanout_id
);
281 vhost_user_gpu_unblock(g
);
285 con
= g
->parent_obj
.scanout
[m
->scanout_id
].con
;
286 if (!console_has_gl(con
)) {
287 error_report("console doesn't support GL!");
288 vhost_user_gpu_unblock(g
);
291 g
->backend_blocked
= true;
292 dpy_gl_update(con
, m
->x
, m
->y
, m
->width
, m
->height
);
295 case VHOST_USER_GPU_UPDATE
: {
296 VhostUserGpuUpdate
*m
= &msg
->payload
.update
;
298 if (m
->scanout_id
>= g
->parent_obj
.conf
.max_outputs
) {
301 s
= &g
->parent_obj
.scanout
[m
->scanout_id
];
303 pixman_image_t
*image
=
304 pixman_image_create_bits(PIXMAN_x8r8g8b8
,
310 pixman_image_composite(PIXMAN_OP_SRC
,
311 image
, NULL
, s
->ds
->image
,
312 0, 0, 0, 0, m
->x
, m
->y
, m
->width
, m
->height
);
314 pixman_image_unref(image
);
315 if (qemu_console_surface(con
) != s
->ds
) {
316 dpy_gfx_replace_surface(con
, s
->ds
);
318 dpy_gfx_update(con
, m
->x
, m
->y
, m
->width
, m
->height
);
323 g_warning("unhandled message %d %d", msg
->request
, msg
->size
);
326 if (con
&& qemu_console_is_gl_blocked(con
)) {
327 vhost_user_gpu_update_blocked(g
, true);
332 vhost_user_gpu_chr_read(void *opaque
)
334 VhostUserGPU
*g
= opaque
;
335 VhostUserGpuMsg
*msg
= NULL
;
336 VhostUserGpuRequest request
;
337 uint32_t size
, flags
;
340 r
= qemu_chr_fe_read_all(&g
->vhost_chr
,
341 (uint8_t *)&request
, sizeof(uint32_t));
342 if (r
!= sizeof(uint32_t)) {
343 error_report("failed to read msg header: %d, %d", r
, errno
);
347 r
= qemu_chr_fe_read_all(&g
->vhost_chr
,
348 (uint8_t *)&flags
, sizeof(uint32_t));
349 if (r
!= sizeof(uint32_t)) {
350 error_report("failed to read msg flags");
354 r
= qemu_chr_fe_read_all(&g
->vhost_chr
,
355 (uint8_t *)&size
, sizeof(uint32_t));
356 if (r
!= sizeof(uint32_t)) {
357 error_report("failed to read msg size");
361 msg
= g_malloc(VHOST_USER_GPU_HDR_SIZE
+ size
);
363 r
= qemu_chr_fe_read_all(&g
->vhost_chr
,
364 (uint8_t *)&msg
->payload
, size
);
366 error_report("failed to read msg payload %d != %d", r
, size
);
370 msg
->request
= request
;
374 if (request
== VHOST_USER_GPU_CURSOR_UPDATE
||
375 request
== VHOST_USER_GPU_CURSOR_POS
||
376 request
== VHOST_USER_GPU_CURSOR_POS_HIDE
) {
377 vhost_user_gpu_handle_cursor(g
, msg
);
379 vhost_user_gpu_handle_display(g
, msg
);
387 vhost_user_gpu_update_blocked(VhostUserGPU
*g
, bool blocked
)
389 qemu_set_fd_handler(g
->vhost_gpu_fd
,
390 blocked
? NULL
: vhost_user_gpu_chr_read
, NULL
, g
);
394 vhost_user_gpu_gl_flushed(VirtIOGPUBase
*b
)
396 VhostUserGPU
*g
= VHOST_USER_GPU(b
);
398 if (g
->backend_blocked
) {
399 vhost_user_gpu_unblock(g
);
400 g
->backend_blocked
= false;
403 vhost_user_gpu_update_blocked(g
, false);
407 vhost_user_gpu_do_set_socket(VhostUserGPU
*g
, Error
**errp
)
412 if (qemu_socketpair(PF_UNIX
, SOCK_STREAM
, 0, sv
) == -1) {
413 error_setg_errno(errp
, errno
, "socketpair() failed");
417 chr
= CHARDEV(object_new(TYPE_CHARDEV_SOCKET
));
418 if (!chr
|| qemu_chr_add_client(chr
, sv
[0]) == -1) {
419 error_setg(errp
, "Failed to make socket chardev");
422 if (!qemu_chr_fe_init(&g
->vhost_chr
, chr
, errp
)) {
425 if (vhost_user_gpu_set_socket(&g
->vhost
->dev
, sv
[1]) < 0) {
426 error_setg(errp
, "Failed to set vhost-user-gpu socket");
427 qemu_chr_fe_deinit(&g
->vhost_chr
, false);
431 g
->vhost_gpu_fd
= sv
[0];
432 vhost_user_gpu_update_blocked(g
, false);
440 object_unref(OBJECT(chr
));
446 vhost_user_gpu_get_config(VirtIODevice
*vdev
, uint8_t *config_data
)
448 VhostUserGPU
*g
= VHOST_USER_GPU(vdev
);
449 VirtIOGPUBase
*b
= VIRTIO_GPU_BASE(vdev
);
450 struct virtio_gpu_config
*vgconfig
=
451 (struct virtio_gpu_config
*)config_data
;
452 Error
*local_err
= NULL
;
455 memset(config_data
, 0, sizeof(struct virtio_gpu_config
));
457 ret
= vhost_dev_get_config(&g
->vhost
->dev
,
458 config_data
, sizeof(struct virtio_gpu_config
),
461 error_report_err(local_err
);
465 /* those fields are managed by qemu */
466 vgconfig
->num_scanouts
= b
->virtio_config
.num_scanouts
;
467 vgconfig
->events_read
= b
->virtio_config
.events_read
;
468 vgconfig
->events_clear
= b
->virtio_config
.events_clear
;
472 vhost_user_gpu_set_config(VirtIODevice
*vdev
,
473 const uint8_t *config_data
)
475 VhostUserGPU
*g
= VHOST_USER_GPU(vdev
);
476 VirtIOGPUBase
*b
= VIRTIO_GPU_BASE(vdev
);
477 const struct virtio_gpu_config
*vgconfig
=
478 (const struct virtio_gpu_config
*)config_data
;
481 if (vgconfig
->events_clear
) {
482 b
->virtio_config
.events_read
&= ~vgconfig
->events_clear
;
485 ret
= vhost_dev_set_config(&g
->vhost
->dev
, config_data
,
486 0, sizeof(struct virtio_gpu_config
),
487 VHOST_SET_CONFIG_TYPE_FRONTEND
);
489 error_report("vhost-user-gpu: set device config space failed");
495 vhost_user_gpu_set_status(VirtIODevice
*vdev
, uint8_t val
)
497 VhostUserGPU
*g
= VHOST_USER_GPU(vdev
);
500 if (val
& VIRTIO_CONFIG_S_DRIVER_OK
&& vdev
->vm_running
) {
501 if (!vhost_user_gpu_do_set_socket(g
, &err
)) {
502 error_report_err(err
);
505 vhost_user_backend_start(g
->vhost
);
507 /* unblock any wait and stop processing */
508 if (g
->vhost_gpu_fd
!= -1) {
509 vhost_user_gpu_update_blocked(g
, true);
510 qemu_chr_fe_deinit(&g
->vhost_chr
, true);
511 g
->vhost_gpu_fd
= -1;
513 vhost_user_backend_stop(g
->vhost
);
518 vhost_user_gpu_guest_notifier_pending(VirtIODevice
*vdev
, int idx
)
520 VhostUserGPU
*g
= VHOST_USER_GPU(vdev
);
523 * Add the check for configure interrupt, Use VIRTIO_CONFIG_IRQ_IDX -1
524 * as the macro of configure interrupt's IDX, If this driver does not
525 * support, the function will return
528 if (idx
== VIRTIO_CONFIG_IRQ_IDX
) {
531 return vhost_virtqueue_pending(&g
->vhost
->dev
, idx
);
535 vhost_user_gpu_guest_notifier_mask(VirtIODevice
*vdev
, int idx
, bool mask
)
537 VhostUserGPU
*g
= VHOST_USER_GPU(vdev
);
540 * Add the check for configure interrupt, Use VIRTIO_CONFIG_IRQ_IDX -1
541 * as the macro of configure interrupt's IDX, If this driver does not
542 * support, the function will return
545 if (idx
== VIRTIO_CONFIG_IRQ_IDX
) {
548 vhost_virtqueue_mask(&g
->vhost
->dev
, vdev
, idx
, mask
);
552 vhost_user_gpu_instance_init(Object
*obj
)
554 VhostUserGPU
*g
= VHOST_USER_GPU(obj
);
556 g
->vhost
= VHOST_USER_BACKEND(object_new(TYPE_VHOST_USER_BACKEND
));
557 object_property_add_alias(obj
, "chardev",
558 OBJECT(g
->vhost
), "chardev");
562 vhost_user_gpu_instance_finalize(Object
*obj
)
564 VhostUserGPU
*g
= VHOST_USER_GPU(obj
);
566 object_unref(OBJECT(g
->vhost
));
570 vhost_user_gpu_reset(VirtIODevice
*vdev
)
572 VhostUserGPU
*g
= VHOST_USER_GPU(vdev
);
574 virtio_gpu_base_reset(VIRTIO_GPU_BASE(vdev
));
576 vhost_user_backend_stop(g
->vhost
);
580 vhost_user_gpu_config_change(struct vhost_dev
*dev
)
582 error_report("vhost-user-gpu: unhandled backend config change");
586 static const VhostDevConfigOps config_ops
= {
587 .vhost_dev_config_notifier
= vhost_user_gpu_config_change
,
591 vhost_user_gpu_device_realize(DeviceState
*qdev
, Error
**errp
)
593 VhostUserGPU
*g
= VHOST_USER_GPU(qdev
);
594 VirtIODevice
*vdev
= VIRTIO_DEVICE(g
);
596 vhost_dev_set_config_notifier(&g
->vhost
->dev
, &config_ops
);
597 if (vhost_user_backend_dev_init(g
->vhost
, vdev
, 2, errp
) < 0) {
601 /* existing backend may send DMABUF, so let's add that requirement */
602 g
->parent_obj
.conf
.flags
|= 1 << VIRTIO_GPU_FLAG_DMABUF_ENABLED
;
603 if (virtio_has_feature(g
->vhost
->dev
.features
, VIRTIO_GPU_F_VIRGL
)) {
604 g
->parent_obj
.conf
.flags
|= 1 << VIRTIO_GPU_FLAG_VIRGL_ENABLED
;
606 if (virtio_has_feature(g
->vhost
->dev
.features
, VIRTIO_GPU_F_EDID
)) {
607 g
->parent_obj
.conf
.flags
|= 1 << VIRTIO_GPU_FLAG_EDID_ENABLED
;
609 error_report("EDID requested but the backend doesn't support it.");
610 g
->parent_obj
.conf
.flags
&= ~(1 << VIRTIO_GPU_FLAG_EDID_ENABLED
);
613 if (!virtio_gpu_base_device_realize(qdev
, NULL
, NULL
, errp
)) {
617 g
->vhost_gpu_fd
= -1;
620 static struct vhost_dev
*vhost_user_gpu_get_vhost(VirtIODevice
*vdev
)
622 VhostUserGPU
*g
= VHOST_USER_GPU(vdev
);
623 return &g
->vhost
->dev
;
626 static Property vhost_user_gpu_properties
[] = {
627 VIRTIO_GPU_BASE_PROPERTIES(VhostUserGPU
, parent_obj
.conf
),
628 DEFINE_PROP_END_OF_LIST(),
632 vhost_user_gpu_class_init(ObjectClass
*klass
, void *data
)
634 DeviceClass
*dc
= DEVICE_CLASS(klass
);
635 VirtioDeviceClass
*vdc
= VIRTIO_DEVICE_CLASS(klass
);
636 VirtIOGPUBaseClass
*vgc
= VIRTIO_GPU_BASE_CLASS(klass
);
638 vgc
->gl_flushed
= vhost_user_gpu_gl_flushed
;
640 vdc
->realize
= vhost_user_gpu_device_realize
;
641 vdc
->reset
= vhost_user_gpu_reset
;
642 vdc
->set_status
= vhost_user_gpu_set_status
;
643 vdc
->guest_notifier_mask
= vhost_user_gpu_guest_notifier_mask
;
644 vdc
->guest_notifier_pending
= vhost_user_gpu_guest_notifier_pending
;
645 vdc
->get_config
= vhost_user_gpu_get_config
;
646 vdc
->set_config
= vhost_user_gpu_set_config
;
647 vdc
->get_vhost
= vhost_user_gpu_get_vhost
;
649 device_class_set_props(dc
, vhost_user_gpu_properties
);
652 static const TypeInfo vhost_user_gpu_info
= {
653 .name
= TYPE_VHOST_USER_GPU
,
654 .parent
= TYPE_VIRTIO_GPU_BASE
,
655 .instance_size
= sizeof(VhostUserGPU
),
656 .instance_init
= vhost_user_gpu_instance_init
,
657 .instance_finalize
= vhost_user_gpu_instance_finalize
,
658 .class_init
= vhost_user_gpu_class_init
,
660 module_obj(TYPE_VHOST_USER_GPU
);
661 module_kconfig(VHOST_USER_GPU
);
663 static void vhost_user_gpu_register_types(void)
665 type_register_static(&vhost_user_gpu_info
);
668 type_init(vhost_user_gpu_register_types
)