2 * Copyright (C) 2010 Red Hat, Inc.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation; either version 2 or
7 * (at your option) version 3 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
18 #include "qemu-common.h"
19 #include "ui/qemu-spice.h"
20 #include "qemu/timer.h"
21 #include "qemu/queue.h"
22 #include "monitor/monitor.h"
23 #include "ui/console.h"
24 #include "sysemu/sysemu.h"
27 #include "ui/spice-display.h"
31 static void GCC_FMT_ATTR(2, 3) dprint(int level, const char *fmt, ...)
37 vfprintf(stderr, fmt, args);
42 int qemu_spice_rect_is_empty(const QXLRect* r)
44 return r->top == r->bottom || r->left == r->right;
47 void qemu_spice_rect_union(QXLRect *dest, const QXLRect *r)
49 if (qemu_spice_rect_is_empty(r)) {
53 if (qemu_spice_rect_is_empty(dest)) {
58 dest->top = MIN(dest->top, r->top);
59 dest->left = MIN(dest->left, r->left);
60 dest->bottom = MAX(dest->bottom, r->bottom);
61 dest->right = MAX(dest->right, r->right);
64 QXLCookie *qxl_cookie_new(int type, uint64_t io)
68 cookie = g_malloc0(sizeof(*cookie));
74 void qemu_spice_add_memslot(SimpleSpiceDisplay *ssd, QXLDevMemSlot *memslot,
77 trace_qemu_spice_add_memslot(ssd->qxl.id, memslot->slot_id,
78 memslot->virt_start, memslot->virt_end,
81 if (async != QXL_SYNC) {
82 spice_qxl_add_memslot_async(&ssd->qxl, memslot,
83 (uintptr_t)qxl_cookie_new(QXL_COOKIE_TYPE_IO,
84 QXL_IO_MEMSLOT_ADD_ASYNC));
86 spice_qxl_add_memslot(&ssd->qxl, memslot);
90 void qemu_spice_del_memslot(SimpleSpiceDisplay *ssd, uint32_t gid, uint32_t sid)
92 trace_qemu_spice_del_memslot(ssd->qxl.id, gid, sid);
93 spice_qxl_del_memslot(&ssd->qxl, gid, sid);
96 void qemu_spice_create_primary_surface(SimpleSpiceDisplay *ssd, uint32_t id,
97 QXLDevSurfaceCreate *surface,
100 trace_qemu_spice_create_primary_surface(ssd->qxl.id, id, surface, async);
101 if (async != QXL_SYNC) {
102 spice_qxl_create_primary_surface_async(&ssd->qxl, id, surface,
103 (uintptr_t)qxl_cookie_new(QXL_COOKIE_TYPE_IO,
104 QXL_IO_CREATE_PRIMARY_ASYNC));
106 spice_qxl_create_primary_surface(&ssd->qxl, id, surface);
110 void qemu_spice_destroy_primary_surface(SimpleSpiceDisplay *ssd,
111 uint32_t id, qxl_async_io async)
113 trace_qemu_spice_destroy_primary_surface(ssd->qxl.id, id, async);
114 if (async != QXL_SYNC) {
115 spice_qxl_destroy_primary_surface_async(&ssd->qxl, id,
116 (uintptr_t)qxl_cookie_new(QXL_COOKIE_TYPE_IO,
117 QXL_IO_DESTROY_PRIMARY_ASYNC));
119 spice_qxl_destroy_primary_surface(&ssd->qxl, id);
123 void qemu_spice_wakeup(SimpleSpiceDisplay *ssd)
125 trace_qemu_spice_wakeup(ssd->qxl.id);
126 spice_qxl_wakeup(&ssd->qxl);
129 static void qemu_spice_create_one_update(SimpleSpiceDisplay *ssd,
132 SimpleSpiceUpdate *update;
133 QXLDrawable *drawable;
137 struct timespec time_space;
138 pixman_image_t *dest;
140 trace_qemu_spice_create_update(
141 rect->left, rect->right,
142 rect->top, rect->bottom);
144 update = g_malloc0(sizeof(*update));
145 drawable = &update->drawable;
146 image = &update->image;
147 cmd = &update->ext.cmd;
149 bw = rect->right - rect->left;
150 bh = rect->bottom - rect->top;
151 update->bitmap = g_malloc(bw * bh * 4);
153 drawable->bbox = *rect;
154 drawable->clip.type = SPICE_CLIP_TYPE_NONE;
155 drawable->effect = QXL_EFFECT_OPAQUE;
156 drawable->release_info.id = (uintptr_t)(&update->ext);
157 drawable->type = QXL_DRAW_COPY;
158 drawable->surfaces_dest[0] = -1;
159 drawable->surfaces_dest[1] = -1;
160 drawable->surfaces_dest[2] = -1;
161 clock_gettime(CLOCK_MONOTONIC, &time_space);
162 /* time in milliseconds from epoch. */
163 drawable->mm_time = time_space.tv_sec * 1000
164 + time_space.tv_nsec / 1000 / 1000;
166 drawable->u.copy.rop_descriptor = SPICE_ROPD_OP_PUT;
167 drawable->u.copy.src_bitmap = (uintptr_t)image;
168 drawable->u.copy.src_area.right = bw;
169 drawable->u.copy.src_area.bottom = bh;
171 QXL_SET_IMAGE_ID(image, QXL_IMAGE_GROUP_DEVICE, ssd->unique++);
172 image->descriptor.type = SPICE_IMAGE_TYPE_BITMAP;
173 image->bitmap.flags = QXL_BITMAP_DIRECT | QXL_BITMAP_TOP_DOWN;
174 image->bitmap.stride = bw * 4;
175 image->descriptor.width = image->bitmap.x = bw;
176 image->descriptor.height = image->bitmap.y = bh;
177 image->bitmap.data = (uintptr_t)(update->bitmap);
178 image->bitmap.palette = 0;
179 image->bitmap.format = SPICE_BITMAP_FMT_32BIT;
181 dest = pixman_image_create_bits(PIXMAN_x8r8g8b8, bw, bh,
182 (void *)update->bitmap, bw * 4);
183 pixman_image_composite(PIXMAN_OP_SRC, ssd->surface, NULL, ssd->mirror,
184 rect->left, rect->top, 0, 0,
185 rect->left, rect->top, bw, bh);
186 pixman_image_composite(PIXMAN_OP_SRC, ssd->mirror, NULL, dest,
187 rect->left, rect->top, 0, 0,
189 pixman_image_unref(dest);
191 cmd->type = QXL_CMD_DRAW;
192 cmd->data = (uintptr_t)drawable;
194 QTAILQ_INSERT_TAIL(&ssd->updates, update, next);
197 static void qemu_spice_create_update(SimpleSpiceDisplay *ssd)
199 static const int blksize = 32;
200 int blocks = (surface_width(ssd->ds) + blksize - 1) / blksize;
201 int dirty_top[blocks];
202 int y, yoff, x, xoff, blk, bw;
203 int bpp = surface_bytes_per_pixel(ssd->ds);
204 uint8_t *guest, *mirror;
206 if (qemu_spice_rect_is_empty(&ssd->dirty)) {
210 if (ssd->surface == NULL) {
211 ssd->surface = pixman_image_ref(ssd->ds->image);
212 ssd->mirror = qemu_pixman_mirror_create(ssd->ds->format,
216 for (blk = 0; blk < blocks; blk++) {
220 guest = surface_data(ssd->ds);
221 mirror = (void *)pixman_image_get_data(ssd->mirror);
222 for (y = ssd->dirty.top; y < ssd->dirty.bottom; y++) {
223 yoff = y * surface_stride(ssd->ds);
224 for (x = ssd->dirty.left; x < ssd->dirty.right; x += blksize) {
227 bw = MIN(blksize, ssd->dirty.right - x);
228 if (memcmp(guest + yoff + xoff,
229 mirror + yoff + xoff,
231 if (dirty_top[blk] != -1) {
233 .top = dirty_top[blk],
238 qemu_spice_create_one_update(ssd, &update);
242 if (dirty_top[blk] == -1) {
249 for (x = ssd->dirty.left; x < ssd->dirty.right; x += blksize) {
251 bw = MIN(blksize, ssd->dirty.right - x);
252 if (dirty_top[blk] != -1) {
254 .top = dirty_top[blk],
255 .bottom = ssd->dirty.bottom,
259 qemu_spice_create_one_update(ssd, &update);
264 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
267 static SimpleSpiceCursor*
268 qemu_spice_create_cursor_update(SimpleSpiceDisplay *ssd,
271 size_t size = c ? c->width * c->height * 4 : 0;
272 SimpleSpiceCursor *update;
277 update = g_malloc0(sizeof(*update) + size);
279 cursor = &update->cursor;
280 cmd = &update->ext.cmd;
283 ccmd->type = QXL_CURSOR_SET;
284 ccmd->u.set.position.x = ssd->ptr_x;
285 ccmd->u.set.position.y = ssd->ptr_y;
286 ccmd->u.set.visible = true;
287 ccmd->u.set.shape = (uintptr_t)cursor;
288 cursor->header.unique = ssd->unique++;
289 cursor->header.type = SPICE_CURSOR_TYPE_ALPHA;
290 cursor->header.width = c->width;
291 cursor->header.height = c->height;
292 cursor->header.hot_spot_x = c->hot_x;
293 cursor->header.hot_spot_y = c->hot_y;
294 cursor->data_size = size;
295 cursor->chunk.data_size = size;
296 memcpy(cursor->chunk.data, c->data, size);
298 ccmd->type = QXL_CURSOR_MOVE;
299 ccmd->u.position.x = ssd->ptr_x;
300 ccmd->u.position.y = ssd->ptr_y;
302 ccmd->release_info.id = (uintptr_t)(&update->ext);
304 cmd->type = QXL_CMD_CURSOR;
305 cmd->data = (uintptr_t)ccmd;
311 * Called from spice server thread context (via interface_release_resource)
312 * We do *not* hold the global qemu mutex here, so extra care is needed
313 * when calling qemu functions. QEMU interfaces used:
314 * - g_free (underlying glibc free is re-entrant).
316 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update)
318 g_free(update->bitmap);
322 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd)
324 QXLDevMemSlot memslot;
326 dprint(1, "%s/%d:\n", __func__, ssd->qxl.id);
328 memset(&memslot, 0, sizeof(memslot));
329 memslot.slot_group_id = MEMSLOT_GROUP_HOST;
330 memslot.virt_end = ~0;
331 qemu_spice_add_memslot(ssd, &memslot, QXL_SYNC);
334 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd)
336 QXLDevSurfaceCreate surface;
337 uint64_t surface_size;
339 memset(&surface, 0, sizeof(surface));
341 surface_size = (uint64_t) surface_width(ssd->ds) *
342 surface_height(ssd->ds) * 4;
343 assert(surface_size > 0);
344 assert(surface_size < INT_MAX);
345 if (ssd->bufsize < surface_size) {
346 ssd->bufsize = surface_size;
348 ssd->buf = g_malloc(ssd->bufsize);
351 dprint(1, "%s/%d: %ux%u (size %" PRIu64 "/%d)\n", __func__, ssd->qxl.id,
352 surface_width(ssd->ds), surface_height(ssd->ds),
353 surface_size, ssd->bufsize);
355 surface.format = SPICE_SURFACE_FMT_32_xRGB;
356 surface.width = surface_width(ssd->ds);
357 surface.height = surface_height(ssd->ds);
358 surface.stride = -surface.width * 4;
359 surface.mouse_mode = true;
362 surface.mem = (uintptr_t)ssd->buf;
363 surface.group_id = MEMSLOT_GROUP_HOST;
365 qemu_spice_create_primary_surface(ssd, 0, &surface, QXL_SYNC);
368 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd)
370 dprint(1, "%s/%d:\n", __func__, ssd->qxl.id);
372 qemu_spice_destroy_primary_surface(ssd, 0, QXL_SYNC);
375 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd)
377 qemu_mutex_init(&ssd->lock);
378 QTAILQ_INIT(&ssd->updates);
381 if (ssd->num_surfaces == 0) {
382 ssd->num_surfaces = 1024;
386 /* display listener callbacks */
388 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
389 int x, int y, int w, int h)
393 dprint(2, "%s/%d: x %d y %d w %d h %d\n", __func__,
394 ssd->qxl.id, x, y, w, h);
395 update_area.left = x,
396 update_area.right = x + w;
398 update_area.bottom = y + h;
400 if (qemu_spice_rect_is_empty(&ssd->dirty)) {
403 qemu_spice_rect_union(&ssd->dirty, &update_area);
406 void qemu_spice_display_switch(SimpleSpiceDisplay *ssd,
407 DisplaySurface *surface)
409 SimpleSpiceUpdate *update;
412 dprint(1, "%s/%d:\n", __func__, ssd->qxl.id);
414 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
416 pixman_image_unref(ssd->surface);
418 pixman_image_unref(ssd->mirror);
422 qemu_mutex_lock(&ssd->lock);
423 need_destroy = (ssd->ds != NULL);
425 while ((update = QTAILQ_FIRST(&ssd->updates)) != NULL) {
426 QTAILQ_REMOVE(&ssd->updates, update, next);
427 qemu_spice_destroy_update(ssd, update);
429 qemu_mutex_unlock(&ssd->lock);
431 qemu_spice_destroy_host_primary(ssd);
434 qemu_spice_create_host_primary(ssd);
437 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
441 static void qemu_spice_cursor_refresh_unlocked(SimpleSpiceDisplay *ssd)
444 assert(ssd->dcl.con);
445 dpy_cursor_define(ssd->dcl.con, ssd->cursor);
446 cursor_put(ssd->cursor);
449 if (ssd->mouse_x != -1 && ssd->mouse_y != -1) {
450 assert(ssd->dcl.con);
451 dpy_mouse_set(ssd->dcl.con, ssd->mouse_x, ssd->mouse_y, 1);
457 void qemu_spice_cursor_refresh_bh(void *opaque)
459 SimpleSpiceDisplay *ssd = opaque;
461 qemu_mutex_lock(&ssd->lock);
462 qemu_spice_cursor_refresh_unlocked(ssd);
463 qemu_mutex_unlock(&ssd->lock);
466 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd)
468 dprint(3, "%s/%d:\n", __func__, ssd->qxl.id);
469 graphic_hw_update(ssd->dcl.con);
471 qemu_mutex_lock(&ssd->lock);
472 if (QTAILQ_EMPTY(&ssd->updates) && ssd->ds) {
473 qemu_spice_create_update(ssd);
476 qemu_mutex_unlock(&ssd->lock);
480 qemu_spice_wakeup(ssd);
481 dprint(2, "%s/%d: notify\n", __func__, ssd->qxl.id);
485 /* spice display interface callbacks */
487 static void interface_attach_worker(QXLInstance *sin, QXLWorker *qxl_worker)
489 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
491 dprint(1, "%s/%d:\n", __func__, ssd->qxl.id);
492 ssd->worker = qxl_worker;
495 static void interface_set_compression_level(QXLInstance *sin, int level)
497 dprint(1, "%s/%d:\n", __func__, sin->id);
501 static void interface_set_mm_time(QXLInstance *sin, uint32_t mm_time)
503 dprint(3, "%s/%d:\n", __func__, sin->id);
507 static void interface_get_init_info(QXLInstance *sin, QXLDevInitInfo *info)
509 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
511 info->memslot_gen_bits = MEMSLOT_GENERATION_BITS;
512 info->memslot_id_bits = MEMSLOT_SLOT_BITS;
513 info->num_memslots = NUM_MEMSLOTS;
514 info->num_memslots_groups = NUM_MEMSLOTS_GROUPS;
515 info->internal_groupslot_id = 0;
516 info->qxl_ram_size = 16 * 1024 * 1024;
517 info->n_surfaces = ssd->num_surfaces;
520 static int interface_get_command(QXLInstance *sin, struct QXLCommandExt *ext)
522 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
523 SimpleSpiceUpdate *update;
526 dprint(3, "%s/%d:\n", __func__, ssd->qxl.id);
528 qemu_mutex_lock(&ssd->lock);
529 update = QTAILQ_FIRST(&ssd->updates);
530 if (update != NULL) {
531 QTAILQ_REMOVE(&ssd->updates, update, next);
535 qemu_mutex_unlock(&ssd->lock);
540 static int interface_req_cmd_notification(QXLInstance *sin)
542 dprint(1, "%s/%d:\n", __func__, sin->id);
546 static void interface_release_resource(QXLInstance *sin,
547 struct QXLReleaseInfoExt rext)
549 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
550 SimpleSpiceUpdate *update;
551 SimpleSpiceCursor *cursor;
554 dprint(2, "%s/%d:\n", __func__, ssd->qxl.id);
555 ext = (void *)(intptr_t)(rext.info->id);
556 switch (ext->cmd.type) {
558 update = container_of(ext, SimpleSpiceUpdate, ext);
559 qemu_spice_destroy_update(ssd, update);
562 cursor = container_of(ext, SimpleSpiceCursor, ext);
566 g_assert_not_reached();
570 static int interface_get_cursor_command(QXLInstance *sin, struct QXLCommandExt *ext)
572 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
575 dprint(3, "%s/%d:\n", __func__, ssd->qxl.id);
577 qemu_mutex_lock(&ssd->lock);
578 if (ssd->ptr_define) {
579 *ext = ssd->ptr_define->ext;
580 ssd->ptr_define = NULL;
582 } else if (ssd->ptr_move) {
583 *ext = ssd->ptr_move->ext;
584 ssd->ptr_move = NULL;
589 qemu_mutex_unlock(&ssd->lock);
593 static int interface_req_cursor_notification(QXLInstance *sin)
595 dprint(1, "%s:\n", __FUNCTION__);
599 static void interface_notify_update(QXLInstance *sin, uint32_t update_id)
601 fprintf(stderr, "%s: abort()\n", __FUNCTION__);
605 static int interface_flush_resources(QXLInstance *sin)
607 fprintf(stderr, "%s: abort()\n", __FUNCTION__);
612 static void interface_update_area_complete(QXLInstance *sin,
614 QXLRect *dirty, uint32_t num_updated_rects)
616 /* should never be called, used in qxl native mode only */
617 fprintf(stderr, "%s: abort()\n", __func__);
621 /* called from spice server thread context only */
622 static void interface_async_complete(QXLInstance *sin, uint64_t cookie_token)
624 /* should never be called, used in qxl native mode only */
625 fprintf(stderr, "%s: abort()\n", __func__);
629 static void interface_set_client_capabilities(QXLInstance *sin,
630 uint8_t client_present,
633 dprint(3, "%s:\n", __func__);
636 static int interface_client_monitors_config(QXLInstance *sin,
637 VDAgentMonitorsConfig *mc)
639 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
648 * FIXME: multihead is tricky due to the way
649 * spice has multihead implemented.
651 memset(&info, 0, sizeof(info));
652 if (mc->num_of_monitors > 0) {
653 info.width = mc->monitors[0].width;
654 info.height = mc->monitors[0].height;
656 rc = dpy_set_ui_info(ssd->dcl.con, &info);
657 dprint(1, "%s/%d: size %dx%d, rc %d <--- ==========================\n",
658 __func__, ssd->qxl.id, info.width, info.height, rc);
660 return 0; /* == not supported by guest */
666 static const QXLInterface dpy_interface = {
667 .base.type = SPICE_INTERFACE_QXL,
668 .base.description = "qemu simple display",
669 .base.major_version = SPICE_INTERFACE_QXL_MAJOR,
670 .base.minor_version = SPICE_INTERFACE_QXL_MINOR,
672 .attache_worker = interface_attach_worker,
673 .set_compression_level = interface_set_compression_level,
674 .set_mm_time = interface_set_mm_time,
675 .get_init_info = interface_get_init_info,
677 /* the callbacks below are called from spice server thread context */
678 .get_command = interface_get_command,
679 .req_cmd_notification = interface_req_cmd_notification,
680 .release_resource = interface_release_resource,
681 .get_cursor_command = interface_get_cursor_command,
682 .req_cursor_notification = interface_req_cursor_notification,
683 .notify_update = interface_notify_update,
684 .flush_resources = interface_flush_resources,
685 .async_complete = interface_async_complete,
686 .update_area_complete = interface_update_area_complete,
687 .set_client_capabilities = interface_set_client_capabilities,
688 .client_monitors_config = interface_client_monitors_config,
691 static void display_update(DisplayChangeListener *dcl,
692 int x, int y, int w, int h)
694 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
695 qemu_spice_display_update(ssd, x, y, w, h);
698 static void display_switch(DisplayChangeListener *dcl,
699 struct DisplaySurface *surface)
701 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
702 qemu_spice_display_switch(ssd, surface);
705 static void display_refresh(DisplayChangeListener *dcl)
707 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
708 qemu_spice_display_refresh(ssd);
711 static void display_mouse_set(DisplayChangeListener *dcl,
712 int x, int y, int on)
714 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
716 qemu_mutex_lock(&ssd->lock);
720 g_free(ssd->ptr_move);
722 ssd->ptr_move = qemu_spice_create_cursor_update(ssd, NULL);
723 qemu_mutex_unlock(&ssd->lock);
726 static void display_mouse_define(DisplayChangeListener *dcl,
729 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
731 qemu_mutex_lock(&ssd->lock);
733 g_free(ssd->ptr_move);
734 ssd->ptr_move = NULL;
736 if (ssd->ptr_define) {
737 g_free(ssd->ptr_define);
739 ssd->ptr_define = qemu_spice_create_cursor_update(ssd, c);
740 qemu_mutex_unlock(&ssd->lock);
743 static const DisplayChangeListenerOps display_listener_ops = {
745 .dpy_gfx_update = display_update,
746 .dpy_gfx_switch = display_switch,
747 .dpy_refresh = display_refresh,
748 .dpy_mouse_set = display_mouse_set,
749 .dpy_cursor_define = display_mouse_define,
752 static void qemu_spice_display_init_one(QemuConsole *con)
754 SimpleSpiceDisplay *ssd = g_new0(SimpleSpiceDisplay, 1);
756 qemu_spice_display_init_common(ssd);
758 ssd->qxl.base.sif = &dpy_interface.base;
759 qemu_spice_add_display_interface(&ssd->qxl, con);
762 qemu_spice_create_host_memslot(ssd);
764 ssd->dcl.ops = &display_listener_ops;
766 register_displaychangelistener(&ssd->dcl);
769 void qemu_spice_display_init(void)
775 con = qemu_console_lookup_by_index(i);
776 if (!con || !qemu_console_is_graphic(con)) {
779 if (qemu_spice_have_display_interface(con)) {
782 qemu_spice_display_init_one(con);