spice: Add -spice disable-agent-file-transfer cmdline option (rhbz#961850)
[qemu/ar7.git] / ui / spice-display.c
blob82d8b9f9a5fa118ac8b8b6299daf6b5b772bf370
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 ssd->worker->add_memslot(ssd->worker, 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 ssd->worker->del_memslot(ssd->worker, 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 ssd->worker->create_primary_surface(ssd->worker, 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 ssd->worker->destroy_primary_surface(ssd->worker, id);
123 void qemu_spice_wakeup(SimpleSpiceDisplay *ssd)
125 trace_qemu_spice_wakeup(ssd->qxl.id);
126 ssd->worker->wakeup(ssd->worker);
129 static int spice_display_is_running;
131 void qemu_spice_display_start(void)
133 spice_display_is_running = true;
136 void qemu_spice_display_stop(void)
138 spice_display_is_running = false;
141 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd)
143 return spice_display_is_running;
146 static void qemu_spice_create_one_update(SimpleSpiceDisplay *ssd,
147 QXLRect *rect)
149 SimpleSpiceUpdate *update;
150 QXLDrawable *drawable;
151 QXLImage *image;
152 QXLCommand *cmd;
153 int bw, bh;
154 struct timespec time_space;
155 pixman_image_t *dest;
157 trace_qemu_spice_create_update(
158 rect->left, rect->right,
159 rect->top, rect->bottom);
161 update = g_malloc0(sizeof(*update));
162 drawable = &update->drawable;
163 image = &update->image;
164 cmd = &update->ext.cmd;
166 bw = rect->right - rect->left;
167 bh = rect->bottom - rect->top;
168 update->bitmap = g_malloc(bw * bh * 4);
170 drawable->bbox = *rect;
171 drawable->clip.type = SPICE_CLIP_TYPE_NONE;
172 drawable->effect = QXL_EFFECT_OPAQUE;
173 drawable->release_info.id = (uintptr_t)update;
174 drawable->type = QXL_DRAW_COPY;
175 drawable->surfaces_dest[0] = -1;
176 drawable->surfaces_dest[1] = -1;
177 drawable->surfaces_dest[2] = -1;
178 clock_gettime(CLOCK_MONOTONIC, &time_space);
179 /* time in milliseconds from epoch. */
180 drawable->mm_time = time_space.tv_sec * 1000
181 + time_space.tv_nsec / 1000 / 1000;
183 drawable->u.copy.rop_descriptor = SPICE_ROPD_OP_PUT;
184 drawable->u.copy.src_bitmap = (uintptr_t)image;
185 drawable->u.copy.src_area.right = bw;
186 drawable->u.copy.src_area.bottom = bh;
188 QXL_SET_IMAGE_ID(image, QXL_IMAGE_GROUP_DEVICE, ssd->unique++);
189 image->descriptor.type = SPICE_IMAGE_TYPE_BITMAP;
190 image->bitmap.flags = QXL_BITMAP_DIRECT | QXL_BITMAP_TOP_DOWN;
191 image->bitmap.stride = bw * 4;
192 image->descriptor.width = image->bitmap.x = bw;
193 image->descriptor.height = image->bitmap.y = bh;
194 image->bitmap.data = (uintptr_t)(update->bitmap);
195 image->bitmap.palette = 0;
196 image->bitmap.format = SPICE_BITMAP_FMT_32BIT;
198 dest = pixman_image_create_bits(PIXMAN_x8r8g8b8, bw, bh,
199 (void *)update->bitmap, bw * 4);
200 pixman_image_composite(PIXMAN_OP_SRC, ssd->surface, NULL, ssd->mirror,
201 rect->left, rect->top, 0, 0,
202 rect->left, rect->top, bw, bh);
203 pixman_image_composite(PIXMAN_OP_SRC, ssd->mirror, NULL, dest,
204 rect->left, rect->top, 0, 0,
205 0, 0, bw, bh);
206 pixman_image_unref(dest);
208 cmd->type = QXL_CMD_DRAW;
209 cmd->data = (uintptr_t)drawable;
211 QTAILQ_INSERT_TAIL(&ssd->updates, update, next);
214 static void qemu_spice_create_update(SimpleSpiceDisplay *ssd)
216 static const int blksize = 32;
217 int blocks = (surface_width(ssd->ds) + blksize - 1) / blksize;
218 int dirty_top[blocks];
219 int y, yoff, x, xoff, blk, bw;
220 int bpp = surface_bytes_per_pixel(ssd->ds);
221 uint8_t *guest, *mirror;
223 if (qemu_spice_rect_is_empty(&ssd->dirty)) {
224 return;
227 if (ssd->surface == NULL) {
228 ssd->surface = pixman_image_ref(ssd->ds->image);
229 ssd->mirror = qemu_pixman_mirror_create(ssd->ds->format,
230 ssd->ds->image);
233 for (blk = 0; blk < blocks; blk++) {
234 dirty_top[blk] = -1;
237 guest = surface_data(ssd->ds);
238 mirror = (void *)pixman_image_get_data(ssd->mirror);
239 for (y = ssd->dirty.top; y < ssd->dirty.bottom; y++) {
240 yoff = y * surface_stride(ssd->ds);
241 for (x = ssd->dirty.left; x < ssd->dirty.right; x += blksize) {
242 xoff = x * bpp;
243 blk = x / blksize;
244 bw = MIN(blksize, ssd->dirty.right - x);
245 if (memcmp(guest + yoff + xoff,
246 mirror + yoff + xoff,
247 bw * bpp) == 0) {
248 if (dirty_top[blk] != -1) {
249 QXLRect update = {
250 .top = dirty_top[blk],
251 .bottom = y,
252 .left = x,
253 .right = x + bw,
255 qemu_spice_create_one_update(ssd, &update);
256 dirty_top[blk] = -1;
258 } else {
259 if (dirty_top[blk] == -1) {
260 dirty_top[blk] = y;
266 for (x = ssd->dirty.left; x < ssd->dirty.right; x += blksize) {
267 blk = x / blksize;
268 bw = MIN(blksize, ssd->dirty.right - x);
269 if (dirty_top[blk] != -1) {
270 QXLRect update = {
271 .top = dirty_top[blk],
272 .bottom = ssd->dirty.bottom,
273 .left = x,
274 .right = x + bw,
276 qemu_spice_create_one_update(ssd, &update);
277 dirty_top[blk] = -1;
281 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
285 * Called from spice server thread context (via interface_release_resource)
286 * We do *not* hold the global qemu mutex here, so extra care is needed
287 * when calling qemu functions. QEMU interfaces used:
288 * - g_free (underlying glibc free is re-entrant).
290 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update)
292 g_free(update->bitmap);
293 g_free(update);
296 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd)
298 QXLDevMemSlot memslot;
300 dprint(1, "%s:\n", __FUNCTION__);
302 memset(&memslot, 0, sizeof(memslot));
303 memslot.slot_group_id = MEMSLOT_GROUP_HOST;
304 memslot.virt_end = ~0;
305 qemu_spice_add_memslot(ssd, &memslot, QXL_SYNC);
308 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd)
310 QXLDevSurfaceCreate surface;
312 memset(&surface, 0, sizeof(surface));
314 dprint(1, "%s: %dx%d\n", __FUNCTION__,
315 surface_width(ssd->ds), surface_height(ssd->ds));
317 surface.format = SPICE_SURFACE_FMT_32_xRGB;
318 surface.width = surface_width(ssd->ds);
319 surface.height = surface_height(ssd->ds);
320 surface.stride = -surface.width * 4;
321 surface.mouse_mode = true;
322 surface.flags = 0;
323 surface.type = 0;
324 surface.mem = (uintptr_t)ssd->buf;
325 surface.group_id = MEMSLOT_GROUP_HOST;
327 qemu_spice_create_primary_surface(ssd, 0, &surface, QXL_SYNC);
330 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd)
332 dprint(1, "%s:\n", __FUNCTION__);
334 qemu_spice_destroy_primary_surface(ssd, 0, QXL_SYNC);
337 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd)
339 qemu_mutex_init(&ssd->lock);
340 QTAILQ_INIT(&ssd->updates);
341 ssd->mouse_x = -1;
342 ssd->mouse_y = -1;
343 if (ssd->num_surfaces == 0) {
344 ssd->num_surfaces = 1024;
346 ssd->bufsize = (16 * 1024 * 1024);
347 ssd->buf = g_malloc(ssd->bufsize);
350 /* display listener callbacks */
352 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
353 int x, int y, int w, int h)
355 QXLRect update_area;
357 dprint(2, "%s: x %d y %d w %d h %d\n", __FUNCTION__, x, y, w, h);
358 update_area.left = x,
359 update_area.right = x + w;
360 update_area.top = y;
361 update_area.bottom = y + h;
363 if (qemu_spice_rect_is_empty(&ssd->dirty)) {
364 ssd->notify++;
366 qemu_spice_rect_union(&ssd->dirty, &update_area);
369 void qemu_spice_display_switch(SimpleSpiceDisplay *ssd,
370 DisplaySurface *surface)
372 SimpleSpiceUpdate *update;
374 dprint(1, "%s:\n", __FUNCTION__);
376 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
377 if (ssd->surface) {
378 pixman_image_unref(ssd->surface);
379 ssd->surface = NULL;
380 pixman_image_unref(ssd->mirror);
381 ssd->mirror = NULL;
384 qemu_mutex_lock(&ssd->lock);
385 ssd->ds = surface;
386 while ((update = QTAILQ_FIRST(&ssd->updates)) != NULL) {
387 QTAILQ_REMOVE(&ssd->updates, update, next);
388 qemu_spice_destroy_update(ssd, update);
390 qemu_mutex_unlock(&ssd->lock);
391 qemu_spice_destroy_host_primary(ssd);
392 qemu_spice_create_host_primary(ssd);
394 memset(&ssd->dirty, 0, sizeof(ssd->dirty));
395 ssd->notify++;
398 void qemu_spice_cursor_refresh_unlocked(SimpleSpiceDisplay *ssd)
400 if (ssd->cursor) {
401 assert(ssd->dcl.con);
402 dpy_cursor_define(ssd->dcl.con, ssd->cursor);
403 cursor_put(ssd->cursor);
404 ssd->cursor = NULL;
406 if (ssd->mouse_x != -1 && ssd->mouse_y != -1) {
407 assert(ssd->dcl.con);
408 dpy_mouse_set(ssd->dcl.con, ssd->mouse_x, ssd->mouse_y, 1);
409 ssd->mouse_x = -1;
410 ssd->mouse_y = -1;
414 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd)
416 dprint(3, "%s:\n", __func__);
417 graphic_hw_update(ssd->dcl.con);
419 qemu_mutex_lock(&ssd->lock);
420 if (QTAILQ_EMPTY(&ssd->updates) && ssd->ds) {
421 qemu_spice_create_update(ssd);
422 ssd->notify++;
424 qemu_spice_cursor_refresh_unlocked(ssd);
425 qemu_mutex_unlock(&ssd->lock);
427 if (ssd->notify) {
428 ssd->notify = 0;
429 qemu_spice_wakeup(ssd);
430 dprint(2, "%s: notify\n", __FUNCTION__);
434 /* spice display interface callbacks */
436 static void interface_attach_worker(QXLInstance *sin, QXLWorker *qxl_worker)
438 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
440 dprint(1, "%s:\n", __FUNCTION__);
441 ssd->worker = qxl_worker;
444 static void interface_set_compression_level(QXLInstance *sin, int level)
446 dprint(1, "%s:\n", __FUNCTION__);
447 /* nothing to do */
450 static void interface_set_mm_time(QXLInstance *sin, uint32_t mm_time)
452 dprint(3, "%s:\n", __FUNCTION__);
453 /* nothing to do */
456 static void interface_get_init_info(QXLInstance *sin, QXLDevInitInfo *info)
458 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
460 info->memslot_gen_bits = MEMSLOT_GENERATION_BITS;
461 info->memslot_id_bits = MEMSLOT_SLOT_BITS;
462 info->num_memslots = NUM_MEMSLOTS;
463 info->num_memslots_groups = NUM_MEMSLOTS_GROUPS;
464 info->internal_groupslot_id = 0;
465 info->qxl_ram_size = ssd->bufsize;
466 info->n_surfaces = ssd->num_surfaces;
469 static int interface_get_command(QXLInstance *sin, struct QXLCommandExt *ext)
471 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
472 SimpleSpiceUpdate *update;
473 int ret = false;
475 dprint(3, "%s:\n", __FUNCTION__);
477 qemu_mutex_lock(&ssd->lock);
478 update = QTAILQ_FIRST(&ssd->updates);
479 if (update != NULL) {
480 QTAILQ_REMOVE(&ssd->updates, update, next);
481 *ext = update->ext;
482 ret = true;
484 qemu_mutex_unlock(&ssd->lock);
486 return ret;
489 static int interface_req_cmd_notification(QXLInstance *sin)
491 dprint(1, "%s:\n", __FUNCTION__);
492 return 1;
495 static void interface_release_resource(QXLInstance *sin,
496 struct QXLReleaseInfoExt ext)
498 SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
499 uintptr_t id;
501 dprint(2, "%s:\n", __FUNCTION__);
502 id = ext.info->id;
503 qemu_spice_destroy_update(ssd, (void*)id);
506 static int interface_get_cursor_command(QXLInstance *sin, struct QXLCommandExt *ext)
508 dprint(3, "%s:\n", __FUNCTION__);
509 return false;
512 static int interface_req_cursor_notification(QXLInstance *sin)
514 dprint(1, "%s:\n", __FUNCTION__);
515 return 1;
518 static void interface_notify_update(QXLInstance *sin, uint32_t update_id)
520 fprintf(stderr, "%s: abort()\n", __FUNCTION__);
521 abort();
524 static int interface_flush_resources(QXLInstance *sin)
526 fprintf(stderr, "%s: abort()\n", __FUNCTION__);
527 abort();
528 return 0;
531 static void interface_update_area_complete(QXLInstance *sin,
532 uint32_t surface_id,
533 QXLRect *dirty, uint32_t num_updated_rects)
535 /* should never be called, used in qxl native mode only */
536 fprintf(stderr, "%s: abort()\n", __func__);
537 abort();
540 /* called from spice server thread context only */
541 static void interface_async_complete(QXLInstance *sin, uint64_t cookie_token)
543 /* should never be called, used in qxl native mode only */
544 fprintf(stderr, "%s: abort()\n", __func__);
545 abort();
548 static void interface_set_client_capabilities(QXLInstance *sin,
549 uint8_t client_present,
550 uint8_t caps[58])
552 dprint(3, "%s:\n", __func__);
555 static int interface_client_monitors_config(QXLInstance *sin,
556 VDAgentMonitorsConfig *monitors_config)
558 dprint(3, "%s:\n", __func__);
559 return 0; /* == not supported by guest */
562 static const QXLInterface dpy_interface = {
563 .base.type = SPICE_INTERFACE_QXL,
564 .base.description = "qemu simple display",
565 .base.major_version = SPICE_INTERFACE_QXL_MAJOR,
566 .base.minor_version = SPICE_INTERFACE_QXL_MINOR,
568 .attache_worker = interface_attach_worker,
569 .set_compression_level = interface_set_compression_level,
570 .set_mm_time = interface_set_mm_time,
571 .get_init_info = interface_get_init_info,
573 /* the callbacks below are called from spice server thread context */
574 .get_command = interface_get_command,
575 .req_cmd_notification = interface_req_cmd_notification,
576 .release_resource = interface_release_resource,
577 .get_cursor_command = interface_get_cursor_command,
578 .req_cursor_notification = interface_req_cursor_notification,
579 .notify_update = interface_notify_update,
580 .flush_resources = interface_flush_resources,
581 .async_complete = interface_async_complete,
582 .update_area_complete = interface_update_area_complete,
583 .set_client_capabilities = interface_set_client_capabilities,
584 .client_monitors_config = interface_client_monitors_config,
587 static void display_update(DisplayChangeListener *dcl,
588 int x, int y, int w, int h)
590 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
591 qemu_spice_display_update(ssd, x, y, w, h);
594 static void display_switch(DisplayChangeListener *dcl,
595 struct DisplaySurface *surface)
597 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
598 qemu_spice_display_switch(ssd, surface);
601 static void display_refresh(DisplayChangeListener *dcl)
603 SimpleSpiceDisplay *ssd = container_of(dcl, SimpleSpiceDisplay, dcl);
604 qemu_spice_display_refresh(ssd);
607 static const DisplayChangeListenerOps display_listener_ops = {
608 .dpy_name = "spice",
609 .dpy_gfx_update = display_update,
610 .dpy_gfx_switch = display_switch,
611 .dpy_refresh = display_refresh,
614 void qemu_spice_display_init(DisplayState *ds)
616 SimpleSpiceDisplay *ssd = g_new0(SimpleSpiceDisplay, 1);
618 qemu_spice_display_init_common(ssd);
620 ssd->qxl.base.sif = &dpy_interface.base;
621 qemu_spice_add_interface(&ssd->qxl.base);
622 assert(ssd->worker);
624 qemu_spice_create_host_memslot(ssd);
626 ssd->dcl.ops = &display_listener_ops;
627 ssd->dcl.con = qemu_console_lookup_by_index(0);
628 register_displaychangelistener(&ssd->dcl);
630 qemu_spice_create_host_primary(ssd);