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
;
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
));
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
);
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;
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
);
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
)
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
;
345 update_area
.bottom
= y
+ h
;
347 if (qemu_spice_rect_is_empty(&ssd
->dirty
)) {
350 qemu_spice_rect_union(&ssd
->dirty
, &update_area
);
353 void qemu_spice_display_switch(SimpleSpiceDisplay
*ssd
,
354 DisplaySurface
*surface
)
356 SimpleSpiceUpdate
*update
;
359 dprint(1, "%s/%d:\n", __func__
, ssd
->qxl
.id
);
361 memset(&ssd
->dirty
, 0, sizeof(ssd
->dirty
));
363 pixman_image_unref(ssd
->surface
);
365 pixman_image_unref(ssd
->mirror
);
369 qemu_mutex_lock(&ssd
->lock
);
370 need_destroy
= (ssd
->ds
!= NULL
);
372 while ((update
= QTAILQ_FIRST(&ssd
->updates
)) != NULL
) {
373 QTAILQ_REMOVE(&ssd
->updates
, update
, next
);
374 qemu_spice_destroy_update(ssd
, update
);
376 qemu_mutex_unlock(&ssd
->lock
);
378 qemu_spice_destroy_host_primary(ssd
);
381 qemu_spice_create_host_primary(ssd
);
384 memset(&ssd
->dirty
, 0, sizeof(ssd
->dirty
));
388 void qemu_spice_cursor_refresh_unlocked(SimpleSpiceDisplay
*ssd
)
391 assert(ssd
->dcl
.con
);
392 dpy_cursor_define(ssd
->dcl
.con
, ssd
->cursor
);
393 cursor_put(ssd
->cursor
);
396 if (ssd
->mouse_x
!= -1 && ssd
->mouse_y
!= -1) {
397 assert(ssd
->dcl
.con
);
398 dpy_mouse_set(ssd
->dcl
.con
, ssd
->mouse_x
, ssd
->mouse_y
, 1);
404 void qemu_spice_display_refresh(SimpleSpiceDisplay
*ssd
)
406 dprint(3, "%s/%d:\n", __func__
, ssd
->qxl
.id
);
407 graphic_hw_update(ssd
->dcl
.con
);
409 qemu_mutex_lock(&ssd
->lock
);
410 if (QTAILQ_EMPTY(&ssd
->updates
) && ssd
->ds
) {
411 qemu_spice_create_update(ssd
);
414 qemu_spice_cursor_refresh_unlocked(ssd
);
415 qemu_mutex_unlock(&ssd
->lock
);
419 qemu_spice_wakeup(ssd
);
420 dprint(2, "%s/%d: notify\n", __func__
, ssd
->qxl
.id
);
424 /* spice display interface callbacks */
426 static void interface_attach_worker(QXLInstance
*sin
, QXLWorker
*qxl_worker
)
428 SimpleSpiceDisplay
*ssd
= container_of(sin
, SimpleSpiceDisplay
, qxl
);
430 dprint(1, "%s/%d:\n", __func__
, ssd
->qxl
.id
);
431 ssd
->worker
= qxl_worker
;
434 static void interface_set_compression_level(QXLInstance
*sin
, int level
)
436 dprint(1, "%s/%d:\n", __func__
, sin
->id
);
440 static void interface_set_mm_time(QXLInstance
*sin
, uint32_t mm_time
)
442 dprint(3, "%s/%d:\n", __func__
, sin
->id
);
446 static void interface_get_init_info(QXLInstance
*sin
, QXLDevInitInfo
*info
)
448 SimpleSpiceDisplay
*ssd
= container_of(sin
, SimpleSpiceDisplay
, qxl
);
450 info
->memslot_gen_bits
= MEMSLOT_GENERATION_BITS
;
451 info
->memslot_id_bits
= MEMSLOT_SLOT_BITS
;
452 info
->num_memslots
= NUM_MEMSLOTS
;
453 info
->num_memslots_groups
= NUM_MEMSLOTS_GROUPS
;
454 info
->internal_groupslot_id
= 0;
455 info
->qxl_ram_size
= ssd
->bufsize
;
456 info
->n_surfaces
= ssd
->num_surfaces
;
459 static int interface_get_command(QXLInstance
*sin
, struct QXLCommandExt
*ext
)
461 SimpleSpiceDisplay
*ssd
= container_of(sin
, SimpleSpiceDisplay
, qxl
);
462 SimpleSpiceUpdate
*update
;
465 dprint(3, "%s/%d:\n", __func__
, ssd
->qxl
.id
);
467 qemu_mutex_lock(&ssd
->lock
);
468 update
= QTAILQ_FIRST(&ssd
->updates
);
469 if (update
!= NULL
) {
470 QTAILQ_REMOVE(&ssd
->updates
, update
, next
);
474 qemu_mutex_unlock(&ssd
->lock
);
479 static int interface_req_cmd_notification(QXLInstance
*sin
)
481 dprint(1, "%s/%d:\n", __func__
, sin
->id
);
485 static void interface_release_resource(QXLInstance
*sin
,
486 struct QXLReleaseInfoExt ext
)
488 SimpleSpiceDisplay
*ssd
= container_of(sin
, SimpleSpiceDisplay
, qxl
);
491 dprint(2, "%s/%d:\n", __func__
, ssd
->qxl
.id
);
493 qemu_spice_destroy_update(ssd
, (void*)id
);
496 static int interface_get_cursor_command(QXLInstance
*sin
, struct QXLCommandExt
*ext
)
498 dprint(3, "%s:\n", __FUNCTION__
);
502 static int interface_req_cursor_notification(QXLInstance
*sin
)
504 dprint(1, "%s:\n", __FUNCTION__
);
508 static void interface_notify_update(QXLInstance
*sin
, uint32_t update_id
)
510 fprintf(stderr
, "%s: abort()\n", __FUNCTION__
);
514 static int interface_flush_resources(QXLInstance
*sin
)
516 fprintf(stderr
, "%s: abort()\n", __FUNCTION__
);
521 static void interface_update_area_complete(QXLInstance
*sin
,
523 QXLRect
*dirty
, uint32_t num_updated_rects
)
525 /* should never be called, used in qxl native mode only */
526 fprintf(stderr
, "%s: abort()\n", __func__
);
530 /* called from spice server thread context only */
531 static void interface_async_complete(QXLInstance
*sin
, uint64_t cookie_token
)
533 /* should never be called, used in qxl native mode only */
534 fprintf(stderr
, "%s: abort()\n", __func__
);
538 static void interface_set_client_capabilities(QXLInstance
*sin
,
539 uint8_t client_present
,
542 dprint(3, "%s:\n", __func__
);
545 static int interface_client_monitors_config(QXLInstance
*sin
,
546 VDAgentMonitorsConfig
*mc
)
548 SimpleSpiceDisplay
*ssd
= container_of(sin
, SimpleSpiceDisplay
, qxl
);
553 * FIXME: multihead is tricky due to the way
554 * spice has multihead implemented.
556 memset(&info
, 0, sizeof(info
));
557 if (mc
->num_of_monitors
> 0) {
558 info
.width
= mc
->monitors
[0].width
;
559 info
.height
= mc
->monitors
[0].height
;
561 rc
= dpy_set_ui_info(ssd
->dcl
.con
, &info
);
562 dprint(1, "%s/%d: size %dx%d, rc %d <--- ==========================\n",
563 __func__
, ssd
->qxl
.id
, info
.width
, info
.height
, rc
);
565 return 0; /* == not supported by guest */
571 static const QXLInterface dpy_interface
= {
572 .base
.type
= SPICE_INTERFACE_QXL
,
573 .base
.description
= "qemu simple display",
574 .base
.major_version
= SPICE_INTERFACE_QXL_MAJOR
,
575 .base
.minor_version
= SPICE_INTERFACE_QXL_MINOR
,
577 .attache_worker
= interface_attach_worker
,
578 .set_compression_level
= interface_set_compression_level
,
579 .set_mm_time
= interface_set_mm_time
,
580 .get_init_info
= interface_get_init_info
,
582 /* the callbacks below are called from spice server thread context */
583 .get_command
= interface_get_command
,
584 .req_cmd_notification
= interface_req_cmd_notification
,
585 .release_resource
= interface_release_resource
,
586 .get_cursor_command
= interface_get_cursor_command
,
587 .req_cursor_notification
= interface_req_cursor_notification
,
588 .notify_update
= interface_notify_update
,
589 .flush_resources
= interface_flush_resources
,
590 .async_complete
= interface_async_complete
,
591 .update_area_complete
= interface_update_area_complete
,
592 .set_client_capabilities
= interface_set_client_capabilities
,
593 .client_monitors_config
= interface_client_monitors_config
,
596 static void display_update(DisplayChangeListener
*dcl
,
597 int x
, int y
, int w
, int h
)
599 SimpleSpiceDisplay
*ssd
= container_of(dcl
, SimpleSpiceDisplay
, dcl
);
600 qemu_spice_display_update(ssd
, x
, y
, w
, h
);
603 static void display_switch(DisplayChangeListener
*dcl
,
604 struct DisplaySurface
*surface
)
606 SimpleSpiceDisplay
*ssd
= container_of(dcl
, SimpleSpiceDisplay
, dcl
);
607 qemu_spice_display_switch(ssd
, surface
);
610 static void display_refresh(DisplayChangeListener
*dcl
)
612 SimpleSpiceDisplay
*ssd
= container_of(dcl
, SimpleSpiceDisplay
, dcl
);
613 qemu_spice_display_refresh(ssd
);
616 static const DisplayChangeListenerOps display_listener_ops
= {
618 .dpy_gfx_update
= display_update
,
619 .dpy_gfx_switch
= display_switch
,
620 .dpy_refresh
= display_refresh
,
623 static void qemu_spice_display_init_one(QemuConsole
*con
)
625 SimpleSpiceDisplay
*ssd
= g_new0(SimpleSpiceDisplay
, 1);
627 qemu_spice_display_init_common(ssd
);
629 ssd
->qxl
.base
.sif
= &dpy_interface
.base
;
630 qemu_spice_add_display_interface(&ssd
->qxl
, con
);
633 qemu_spice_create_host_memslot(ssd
);
635 ssd
->dcl
.ops
= &display_listener_ops
;
637 register_displaychangelistener(&ssd
->dcl
);
640 void qemu_spice_display_init(void)
646 con
= qemu_console_lookup_by_index(i
);
647 if (!con
|| !qemu_console_is_graphic(con
)) {
650 if (qemu_spice_have_display_interface(con
)) {
653 qemu_spice_display_init_one(con
);