savevm: Small comment about why timer QEMUFile/VMState code is in savevm.c
[qemu/ar7.git] / ui / spice-display.c
blob9bb42f1461a1a8fb7fd0a989772f98f66f30e0bc
1 /*
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"
25 #include "trace.h"
27 #include "ui/spice-display.h"
29 static int debug = 0;
31 static void GCC_FMT_ATTR(2, 3) dprint(int level, const char *fmt, ...)
33 va_list args;
35 if (level <= debug) {
36 va_start(args, fmt);
37 vfprintf(stderr, fmt, args);
38 va_end(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)) {
50 return;
53 if (qemu_spice_rect_is_empty(dest)) {
54 *dest = *r;
55 return;
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)
66 QXLCookie *cookie;
68 cookie = g_malloc0(sizeof(*cookie));
69 cookie->type = type;
70 cookie->io = io;
71 return cookie;
74 void qemu_spice_add_memslot(SimpleSpiceDisplay *ssd, QXLDevMemSlot *memslot,
75 qxl_async_io async)
77 trace_qemu_spice_add_memslot(ssd->qxl.id, memslot->slot_id,
78 memslot->virt_start, memslot->virt_end,
79 async);
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));
85 } else {
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,
98 qxl_async_io async)
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));
105 } else {
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));
118 } else {
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,
130 QXLRect *rect)
132 SimpleSpiceUpdate *update;
133 QXLDrawable *drawable;
134 QXLImage *image;
135 QXLCommand *cmd;
136 int bw, bh;
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;
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,
188 0, 0, bw, bh);
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)) {
207 return;
210 if (ssd->surface == NULL) {
211 ssd->surface = pixman_image_ref(ssd->ds->image);
212 ssd->mirror = qemu_pixman_mirror_create(ssd->ds->format,
213 ssd->ds->image);
216 for (blk = 0; blk < blocks; blk++) {
217 dirty_top[blk] = -1;
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) {
225 xoff = x * bpp;
226 blk = x / blksize;
227 bw = MIN(blksize, ssd->dirty.right - x);
228 if (memcmp(guest + yoff + xoff,
229 mirror + yoff + xoff,
230 bw * bpp) == 0) {
231 if (dirty_top[blk] != -1) {
232 QXLRect update = {
233 .top = dirty_top[blk],
234 .bottom = y,
235 .left = x,
236 .right = x + bw,
238 qemu_spice_create_one_update(ssd, &update);
239 dirty_top[blk] = -1;
241 } else {
242 if (dirty_top[blk] == -1) {
243 dirty_top[blk] = y;
249 for (x = ssd->dirty.left; x < ssd->dirty.right; x += blksize) {
250 blk = x / blksize;
251 bw = MIN(blksize, ssd->dirty.right - x);
252 if (dirty_top[blk] != -1) {
253 QXLRect update = {
254 .top = dirty_top[blk],
255 .bottom = ssd->dirty.bottom,
256 .left = x,
257 .right = x + bw,
259 qemu_spice_create_one_update(ssd, &update);
260 dirty_top[blk] = -1;
264 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
268 * Called from spice server thread context (via interface_release_resource)
269 * We do *not* hold the global qemu mutex here, so extra care is needed
270 * when calling qemu functions. QEMU interfaces used:
271 * - g_free (underlying glibc free is re-entrant).
273 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update)
275 g_free(update->bitmap);
276 g_free(update);
279 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd)
281 QXLDevMemSlot memslot;
283 dprint(1, "%s/%d:\n", __func__, ssd->qxl.id);
285 memset(&memslot, 0, sizeof(memslot));
286 memslot.slot_group_id = MEMSLOT_GROUP_HOST;
287 memslot.virt_end = ~0;
288 qemu_spice_add_memslot(ssd, &memslot, QXL_SYNC);
291 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd)
293 QXLDevSurfaceCreate surface;
295 memset(&surface, 0, sizeof(surface));
297 dprint(1, "%s/%d: %dx%d\n", __func__, ssd->qxl.id,
298 surface_width(ssd->ds), surface_height(ssd->ds));
300 surface.format = SPICE_SURFACE_FMT_32_xRGB;
301 surface.width = surface_width(ssd->ds);
302 surface.height = surface_height(ssd->ds);
303 surface.stride = -surface.width * 4;
304 surface.mouse_mode = true;
305 surface.flags = 0;
306 surface.type = 0;
307 surface.mem = (uintptr_t)ssd->buf;
308 surface.group_id = MEMSLOT_GROUP_HOST;
310 qemu_spice_create_primary_surface(ssd, 0, &surface, QXL_SYNC);
313 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd)
315 dprint(1, "%s/%d:\n", __func__, ssd->qxl.id);
317 qemu_spice_destroy_primary_surface(ssd, 0, QXL_SYNC);
320 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd)
322 qemu_mutex_init(&ssd->lock);
323 QTAILQ_INIT(&ssd->updates);
324 ssd->mouse_x = -1;
325 ssd->mouse_y = -1;
326 if (ssd->num_surfaces == 0) {
327 ssd->num_surfaces = 1024;
329 ssd->bufsize = (16 * 1024 * 1024);
330 ssd->buf = g_malloc(ssd->bufsize);
333 /* display listener callbacks */
335 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
336 int x, int y, int w, int h)
338 QXLRect update_area;
340 dprint(2, "%s/%d: x %d y %d w %d h %d\n", __func__,
341 ssd->qxl.id, x, y, w, h);
342 update_area.left = x,
343 update_area.right = x + w;
344 update_area.top = y;
345 update_area.bottom = y + h;
347 if (qemu_spice_rect_is_empty(&ssd->dirty)) {
348 ssd->notify++;
350 qemu_spice_rect_union(&ssd->dirty, &update_area);
353 void qemu_spice_display_switch(SimpleSpiceDisplay *ssd,
354 DisplaySurface *surface)
356 SimpleSpiceUpdate *update;
358 dprint(1, "%s/%d:\n", __func__, ssd->qxl.id);
360 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
361 if (ssd->surface) {
362 pixman_image_unref(ssd->surface);
363 ssd->surface = NULL;
364 pixman_image_unref(ssd->mirror);
365 ssd->mirror = NULL;
368 qemu_mutex_lock(&ssd->lock);
369 ssd->ds = surface;
370 while ((update = QTAILQ_FIRST(&ssd->updates)) != NULL) {
371 QTAILQ_REMOVE(&ssd->updates, update, next);
372 qemu_spice_destroy_update(ssd, update);
374 qemu_mutex_unlock(&ssd->lock);
375 qemu_spice_destroy_host_primary(ssd);
376 qemu_spice_create_host_primary(ssd);
378 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
379 ssd->notify++;
382 void qemu_spice_cursor_refresh_unlocked(SimpleSpiceDisplay *ssd)
384 if (ssd->cursor) {
385 assert(ssd->dcl.con);
386 dpy_cursor_define(ssd->dcl.con, ssd->cursor);
387 cursor_put(ssd->cursor);
388 ssd->cursor = NULL;
390 if (ssd->mouse_x != -1 && ssd->mouse_y != -1) {
391 assert(ssd->dcl.con);
392 dpy_mouse_set(ssd->dcl.con, ssd->mouse_x, ssd->mouse_y, 1);
393 ssd->mouse_x = -1;
394 ssd->mouse_y = -1;
398 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd)
400 dprint(3, "%s/%d:\n", __func__, ssd->qxl.id);
401 graphic_hw_update(ssd->dcl.con);
403 qemu_mutex_lock(&ssd->lock);
404 if (QTAILQ_EMPTY(&ssd->updates) && ssd->ds) {
405 qemu_spice_create_update(ssd);
406 ssd->notify++;
408 qemu_spice_cursor_refresh_unlocked(ssd);
409 qemu_mutex_unlock(&ssd->lock);
411 if (ssd->notify) {
412 ssd->notify = 0;
413 qemu_spice_wakeup(ssd);
414 dprint(2, "%s/%d: notify\n", __func__, ssd->qxl.id);
418 /* spice display interface callbacks */
420 static void interface_attach_worker(QXLInstance *sin, QXLWorker *qxl_worker)
422 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
424 dprint(1, "%s/%d:\n", __func__, ssd->qxl.id);
425 ssd->worker = qxl_worker;
428 static void interface_set_compression_level(QXLInstance *sin, int level)
430 dprint(1, "%s/%d:\n", __func__, sin->id);
431 /* nothing to do */
434 static void interface_set_mm_time(QXLInstance *sin, uint32_t mm_time)
436 dprint(3, "%s/%d:\n", __func__, sin->id);
437 /* nothing to do */
440 static void interface_get_init_info(QXLInstance *sin, QXLDevInitInfo *info)
442 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
444 info->memslot_gen_bits = MEMSLOT_GENERATION_BITS;
445 info->memslot_id_bits = MEMSLOT_SLOT_BITS;
446 info->num_memslots = NUM_MEMSLOTS;
447 info->num_memslots_groups = NUM_MEMSLOTS_GROUPS;
448 info->internal_groupslot_id = 0;
449 info->qxl_ram_size = ssd->bufsize;
450 info->n_surfaces = ssd->num_surfaces;
453 static int interface_get_command(QXLInstance *sin, struct QXLCommandExt *ext)
455 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
456 SimpleSpiceUpdate *update;
457 int ret = false;
459 dprint(3, "%s/%d:\n", __func__, ssd->qxl.id);
461 qemu_mutex_lock(&ssd->lock);
462 update = QTAILQ_FIRST(&ssd->updates);
463 if (update != NULL) {
464 QTAILQ_REMOVE(&ssd->updates, update, next);
465 *ext = update->ext;
466 ret = true;
468 qemu_mutex_unlock(&ssd->lock);
470 return ret;
473 static int interface_req_cmd_notification(QXLInstance *sin)
475 dprint(1, "%s/%d:\n", __func__, sin->id);
476 return 1;
479 static void interface_release_resource(QXLInstance *sin,
480 struct QXLReleaseInfoExt ext)
482 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
483 uintptr_t id;
485 dprint(2, "%s/%d:\n", __func__, ssd->qxl.id);
486 id = ext.info->id;
487 qemu_spice_destroy_update(ssd, (void*)id);
490 static int interface_get_cursor_command(QXLInstance *sin, struct QXLCommandExt *ext)
492 dprint(3, "%s:\n", __FUNCTION__);
493 return false;
496 static int interface_req_cursor_notification(QXLInstance *sin)
498 dprint(1, "%s:\n", __FUNCTION__);
499 return 1;
502 static void interface_notify_update(QXLInstance *sin, uint32_t update_id)
504 fprintf(stderr, "%s: abort()\n", __FUNCTION__);
505 abort();
508 static int interface_flush_resources(QXLInstance *sin)
510 fprintf(stderr, "%s: abort()\n", __FUNCTION__);
511 abort();
512 return 0;
515 static void interface_update_area_complete(QXLInstance *sin,
516 uint32_t surface_id,
517 QXLRect *dirty, uint32_t num_updated_rects)
519 /* should never be called, used in qxl native mode only */
520 fprintf(stderr, "%s: abort()\n", __func__);
521 abort();
524 /* called from spice server thread context only */
525 static void interface_async_complete(QXLInstance *sin, uint64_t cookie_token)
527 /* should never be called, used in qxl native mode only */
528 fprintf(stderr, "%s: abort()\n", __func__);
529 abort();
532 static void interface_set_client_capabilities(QXLInstance *sin,
533 uint8_t client_present,
534 uint8_t caps[58])
536 dprint(3, "%s:\n", __func__);
539 static int interface_client_monitors_config(QXLInstance *sin,
540 VDAgentMonitorsConfig *monitors_config)
542 dprint(3, "%s:\n", __func__);
543 return 0; /* == not supported by guest */
546 static const QXLInterface dpy_interface = {
547 .base.type = SPICE_INTERFACE_QXL,
548 .base.description = "qemu simple display",
549 .base.major_version = SPICE_INTERFACE_QXL_MAJOR,
550 .base.minor_version = SPICE_INTERFACE_QXL_MINOR,
552 .attache_worker = interface_attach_worker,
553 .set_compression_level = interface_set_compression_level,
554 .set_mm_time = interface_set_mm_time,
555 .get_init_info = interface_get_init_info,
557 /* the callbacks below are called from spice server thread context */
558 .get_command = interface_get_command,
559 .req_cmd_notification = interface_req_cmd_notification,
560 .release_resource = interface_release_resource,
561 .get_cursor_command = interface_get_cursor_command,
562 .req_cursor_notification = interface_req_cursor_notification,
563 .notify_update = interface_notify_update,
564 .flush_resources = interface_flush_resources,
565 .async_complete = interface_async_complete,
566 .update_area_complete = interface_update_area_complete,
567 .set_client_capabilities = interface_set_client_capabilities,
568 .client_monitors_config = interface_client_monitors_config,
571 static void display_update(DisplayChangeListener *dcl,
572 int x, int y, int w, int h)
574 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
575 qemu_spice_display_update(ssd, x, y, w, h);
578 static void display_switch(DisplayChangeListener *dcl,
579 struct DisplaySurface *surface)
581 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
582 qemu_spice_display_switch(ssd, surface);
585 static void display_refresh(DisplayChangeListener *dcl)
587 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
588 qemu_spice_display_refresh(ssd);
591 static const DisplayChangeListenerOps display_listener_ops = {
592 .dpy_name = "spice",
593 .dpy_gfx_update = display_update,
594 .dpy_gfx_switch = display_switch,
595 .dpy_refresh = display_refresh,
598 static void qemu_spice_display_init_one(QemuConsole *con)
600 SimpleSpiceDisplay *ssd = g_new0(SimpleSpiceDisplay, 1);
602 qemu_spice_display_init_common(ssd);
604 ssd->qxl.base.sif = &dpy_interface.base;
605 qemu_spice_add_display_interface(&ssd->qxl, con);
606 assert(ssd->worker);
608 qemu_spice_create_host_memslot(ssd);
610 ssd->dcl.ops = &display_listener_ops;
611 ssd->dcl.con = con;
612 register_displaychangelistener(&ssd->dcl);
614 qemu_spice_create_host_primary(ssd);
617 void qemu_spice_display_init(void)
619 QemuConsole *con;
620 int i;
622 for (i = 0;; i++) {
623 con = qemu_console_lookup_by_index(i);
624 if (!con || !qemu_console_is_graphic(con)) {
625 break;
627 if (qemu_spice_have_display_interface(con)) {
628 continue;
630 qemu_spice_display_init_one(con);