ui/spice-display.c

   1 /*
   2  * Copyright (C) 2010 Red Hat, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 #include <pthread.h>
  19
  20 #include "qemu-common.h"
  21 #include "qemu-spice.h"
  22 #include "qemu-timer.h"
  23 #include "qemu-queue.h"
  24 #include "monitor.h"
  25 #include "console.h"
  26 #include "sysemu.h"
  27
  28 #include "spice-display.h"
  29
  30 static int debug = 0;
  31
  32 static void GCC_FMT_ATTR(2, 3) dprint(int level, const char *fmt, ...)
  33 {
  34     va_list args;
  35
  36     if (level <= debug) {
  37         va_start(args, fmt);
  38         vfprintf(stderr, fmt, args);
  39         va_end(args);
  40     }
  41 }
  42
  43 int qemu_spice_rect_is_empty(const QXLRect* r)
  44 {
  45     return r->top == r->bottom || r->left == r->right;
  46 }
  47
  48 void qemu_spice_rect_union(QXLRect *dest, const QXLRect *r)
  49 {
  50     if (qemu_spice_rect_is_empty(r)) {
  51         return;
  52     }
  53
  54     if (qemu_spice_rect_is_empty(dest)) {
  55         *dest = *r;
  56         return;
  57     }
  58
  59     dest->top = MIN(dest->top, r->top);
  60     dest->left = MIN(dest->left, r->left);
  61     dest->bottom = MAX(dest->bottom, r->bottom);
  62     dest->right = MAX(dest->right, r->right);
  63 }
  64
  65 void qemu_spice_add_memslot(SimpleSpiceDisplay *ssd, QXLDevMemSlot *memslot,
  66                             qxl_async_io async)
  67 {
  68     if (async != QXL_SYNC) {
  69 #if SPICE_INTERFACE_QXL_MINOR >= 1
  70         spice_qxl_add_memslot_async(&ssd->qxl, memslot, 0);
  71 #else
  72         abort();
  73 #endif
  74     } else {
  75         ssd->worker->add_memslot(ssd->worker, memslot);
  76     }
  77 }
  78
  79 void qemu_spice_del_memslot(SimpleSpiceDisplay *ssd, uint32_t gid, uint32_t sid)
  80 {
  81     ssd->worker->del_memslot(ssd->worker, gid, sid);
  82 }
  83
  84 void qemu_spice_create_primary_surface(SimpleSpiceDisplay *ssd, uint32_t id,
  85                                        QXLDevSurfaceCreate *surface,
  86                                        qxl_async_io async)
  87 {
  88     if (async != QXL_SYNC) {
  89 #if SPICE_INTERFACE_QXL_MINOR >= 1
  90         spice_qxl_create_primary_surface_async(&ssd->qxl, id, surface, 0);
  91 #else
  92         abort();
  93 #endif
  94     } else {
  95         ssd->worker->create_primary_surface(ssd->worker, id, surface);
  96     }
  97 }
  98
  99
 100 void qemu_spice_destroy_primary_surface(SimpleSpiceDisplay *ssd,
 101                                         uint32_t id, qxl_async_io async)
 102 {
 103     if (async != QXL_SYNC) {
 104 #if SPICE_INTERFACE_QXL_MINOR >= 1
 105         spice_qxl_destroy_primary_surface_async(&ssd->qxl, id, 0);
 106 #else
 107         abort();
 108 #endif
 109     } else {
 110         ssd->worker->destroy_primary_surface(ssd->worker, id);
 111     }
 112 }
 113
 114 void qemu_spice_wakeup(SimpleSpiceDisplay *ssd)
 115 {
 116     ssd->worker->wakeup(ssd->worker);
 117 }
 118
 119 void qemu_spice_start(SimpleSpiceDisplay *ssd)
 120 {
 121     ssd->worker->start(ssd->worker);
 122 }
 123
 124 void qemu_spice_stop(SimpleSpiceDisplay *ssd)
 125 {
 126     ssd->worker->stop(ssd->worker);
 127 }
 128
 129 static SimpleSpiceUpdate *qemu_spice_create_update(SimpleSpiceDisplay *ssd)
 130 {
 131     SimpleSpiceUpdate *update;
 132     QXLDrawable *drawable;
 133     QXLImage *image;
 134     QXLCommand *cmd;
 135     uint8_t *src, *dst;
 136     int by, bw, bh;
 137     struct timespec time_space;
 138
 139     if (qemu_spice_rect_is_empty(&ssd->dirty)) {
 140         return NULL;
 141     };
 142
 143     dprint(2, "%s: lr %d -> %d,  tb -> %d -> %d\n", __FUNCTION__,
 144            ssd->dirty.left, ssd->dirty.right,
 145            ssd->dirty.top, ssd->dirty.bottom);
 146
 147     update   = qemu_mallocz(sizeof(*update));
 148     drawable = &update->drawable;
 149     image    = &update->image;
 150     cmd      = &update->ext.cmd;
 151
 152     bw       = ssd->dirty.right - ssd->dirty.left;
 153     bh       = ssd->dirty.bottom - ssd->dirty.top;
 154     update->bitmap = qemu_malloc(bw * bh * 4);
 155
 156     drawable->bbox            = ssd->dirty;
 157     drawable->clip.type       = SPICE_CLIP_TYPE_NONE;
 158     drawable->effect          = QXL_EFFECT_OPAQUE;
 159     drawable->release_info.id = (intptr_t)update;
 160     drawable->type            = QXL_DRAW_COPY;
 161     drawable->surfaces_dest[0] = -1;
 162     drawable->surfaces_dest[1] = -1;
 163     drawable->surfaces_dest[2] = -1;
 164     clock_gettime(CLOCK_MONOTONIC, &time_space);
 165     /* time in milliseconds from epoch. */
 166     drawable->mm_time = time_space.tv_sec * 1000
 167                       + time_space.tv_nsec / 1000 / 1000;
 168
 169     drawable->u.copy.rop_descriptor  = SPICE_ROPD_OP_PUT;
 170     drawable->u.copy.src_bitmap      = (intptr_t)image;
 171     drawable->u.copy.src_area.right  = bw;
 172     drawable->u.copy.src_area.bottom = bh;
 173
 174     QXL_SET_IMAGE_ID(image, QXL_IMAGE_GROUP_DEVICE, ssd->unique++);
 175     image->descriptor.type   = SPICE_IMAGE_TYPE_BITMAP;
 176     image->bitmap.flags      = QXL_BITMAP_DIRECT | QXL_BITMAP_TOP_DOWN;
 177     image->bitmap.stride     = bw * 4;
 178     image->descriptor.width  = image->bitmap.x = bw;
 179     image->descriptor.height = image->bitmap.y = bh;
 180     image->bitmap.data = (intptr_t)(update->bitmap);
 181     image->bitmap.palette = 0;
 182     image->bitmap.format = SPICE_BITMAP_FMT_32BIT;
 183
 184     if (ssd->conv == NULL) {
 185         PixelFormat dst = qemu_default_pixelformat(32);
 186         ssd->conv = qemu_pf_conv_get(&dst, &ssd->ds->surface->pf);
 187         assert(ssd->conv);
 188     }
 189
 190     src = ds_get_data(ssd->ds) +
 191         ssd->dirty.top * ds_get_linesize(ssd->ds) +
 192         ssd->dirty.left * ds_get_bytes_per_pixel(ssd->ds);
 193     dst = update->bitmap;
 194     for (by = 0; by < bh; by++) {
 195         qemu_pf_conv_run(ssd->conv, dst, src, bw);
 196         src += ds_get_linesize(ssd->ds);
 197         dst += image->bitmap.stride;
 198     }
 199
 200     cmd->type = QXL_CMD_DRAW;
 201     cmd->data = (intptr_t)drawable;
 202
 203     memset(&ssd->dirty, 0, sizeof(ssd->dirty));
 204     return update;
 205 }
 206
 207 /*
 208  * Called from spice server thread context (via interface_release_ressource)
 209  * We do *not* hold the global qemu mutex here, so extra care is needed
 210  * when calling qemu functions.  Qemu interfaces used:
 211  *    - qemu_free (underlying glibc free is re-entrant).
 212  */
 213 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update)
 214 {
 215     qemu_free(update->bitmap);
 216     qemu_free(update);
 217 }
 218
 219 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd)
 220 {
 221     QXLDevMemSlot memslot;
 222
 223     dprint(1, "%s:\n", __FUNCTION__);
 224
 225     memset(&memslot, 0, sizeof(memslot));
 226     memslot.slot_group_id = MEMSLOT_GROUP_HOST;
 227     memslot.virt_end = ~0;
 228     qemu_spice_add_memslot(ssd, &memslot, QXL_SYNC);
 229 }
 230
 231 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd)
 232 {
 233     QXLDevSurfaceCreate surface;
 234
 235     dprint(1, "%s: %dx%d\n", __FUNCTION__,
 236            ds_get_width(ssd->ds), ds_get_height(ssd->ds));
 237
 238     surface.format     = SPICE_SURFACE_FMT_32_xRGB;
 239     surface.width      = ds_get_width(ssd->ds);
 240     surface.height     = ds_get_height(ssd->ds);
 241     surface.stride     = -surface.width * 4;
 242     surface.mouse_mode = true;
 243     surface.flags      = 0;
 244     surface.type       = 0;
 245     surface.mem        = (intptr_t)ssd->buf;
 246     surface.group_id   = MEMSLOT_GROUP_HOST;
 247
 248     qemu_spice_create_primary_surface(ssd, 0, &surface, QXL_SYNC);
 249 }
 250
 251 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd)
 252 {
 253     dprint(1, "%s:\n", __FUNCTION__);
 254
 255     qemu_spice_destroy_primary_surface(ssd, 0, QXL_SYNC);
 256 }
 257
 258 void qemu_spice_vm_change_state_handler(void *opaque, int running, int reason)
 259 {
 260     SimpleSpiceDisplay *ssd = opaque;
 261
 262     if (running) {
 263         qemu_spice_start(ssd);
 264     } else {
 265         qemu_spice_stop(ssd);
 266     }
 267     ssd->running = running;
 268 }
 269
 270 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd, DisplayState *ds)
 271 {
 272     ssd->ds = ds;
 273     qemu_mutex_init(&ssd->lock);
 274     ssd->mouse_x = -1;
 275     ssd->mouse_y = -1;
 276     ssd->bufsize = (16 * 1024 * 1024);
 277     ssd->buf = qemu_malloc(ssd->bufsize);
 278 }
 279
 280 /* display listener callbacks */
 281
 282 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
 283                                int x, int y, int w, int h)
 284 {
 285     QXLRect update_area;
 286
 287     dprint(2, "%s: x %d y %d w %d h %d\n", __FUNCTION__, x, y, w, h);
 288     update_area.left = x,
 289     update_area.right = x + w;
 290     update_area.top = y;
 291     update_area.bottom = y + h;
 292
 293     if (qemu_spice_rect_is_empty(&ssd->dirty)) {
 294         ssd->notify++;
 295     }
 296     qemu_spice_rect_union(&ssd->dirty, &update_area);
 297 }
 298
 299 void qemu_spice_display_resize(SimpleSpiceDisplay *ssd)
 300 {
 301     dprint(1, "%s:\n", __FUNCTION__);
 302
 303     memset(&ssd->dirty, 0, sizeof(ssd->dirty));
 304     qemu_pf_conv_put(ssd->conv);
 305     ssd->conv = NULL;
 306
 307     qemu_mutex_lock(&ssd->lock);
 308     if (ssd->update != NULL) {
 309         qemu_spice_destroy_update(ssd, ssd->update);
 310         ssd->update = NULL;
 311     }
 312     qemu_mutex_unlock(&ssd->lock);
 313     qemu_spice_destroy_host_primary(ssd);
 314     qemu_spice_create_host_primary(ssd);
 315
 316     memset(&ssd->dirty, 0, sizeof(ssd->dirty));
 317     ssd->notify++;
 318 }
 319
 320 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd)
 321 {
 322     dprint(3, "%s:\n", __FUNCTION__);
 323     vga_hw_update();
 324
 325     qemu_mutex_lock(&ssd->lock);
 326     if (ssd->update == NULL) {
 327         ssd->update = qemu_spice_create_update(ssd);
 328         ssd->notify++;
 329     }
 330     if (ssd->cursor) {
 331         ssd->ds->cursor_define(ssd->cursor);
 332         cursor_put(ssd->cursor);
 333         ssd->cursor = NULL;
 334     }
 335     if (ssd->mouse_x != -1 && ssd->mouse_y != -1) {
 336         ssd->ds->mouse_set(ssd->mouse_x, ssd->mouse_y, 1);
 337         ssd->mouse_x = -1;
 338         ssd->mouse_y = -1;
 339     }
 340     qemu_mutex_unlock(&ssd->lock);
 341
 342     if (ssd->notify) {
 343         ssd->notify = 0;
 344         qemu_spice_wakeup(ssd);
 345         dprint(2, "%s: notify\n", __FUNCTION__);
 346     }
 347 }
 348
 349 /* spice display interface callbacks */
 350
 351 static void interface_attach_worker(QXLInstance *sin, QXLWorker *qxl_worker)
 352 {
 353     SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
 354
 355     dprint(1, "%s:\n", __FUNCTION__);
 356     ssd->worker = qxl_worker;
 357 }
 358
 359 static void interface_set_compression_level(QXLInstance *sin, int level)
 360 {
 361     dprint(1, "%s:\n", __FUNCTION__);
 362     /* nothing to do */
 363 }
 364
 365 static void interface_set_mm_time(QXLInstance *sin, uint32_t mm_time)
 366 {
 367     dprint(3, "%s:\n", __FUNCTION__);
 368     /* nothing to do */
 369 }
 370
 371 static void interface_get_init_info(QXLInstance *sin, QXLDevInitInfo *info)
 372 {
 373     SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
 374
 375     info->memslot_gen_bits = MEMSLOT_GENERATION_BITS;
 376     info->memslot_id_bits  = MEMSLOT_SLOT_BITS;
 377     info->num_memslots = NUM_MEMSLOTS;
 378     info->num_memslots_groups = NUM_MEMSLOTS_GROUPS;
 379     info->internal_groupslot_id = 0;
 380     info->qxl_ram_size = ssd->bufsize;
 381     info->n_surfaces = NUM_SURFACES;
 382 }
 383
 384 static int interface_get_command(QXLInstance *sin, struct QXLCommandExt *ext)
 385 {
 386     SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
 387     SimpleSpiceUpdate *update;
 388     int ret = false;
 389
 390     dprint(3, "%s:\n", __FUNCTION__);
 391
 392     qemu_mutex_lock(&ssd->lock);
 393     if (ssd->update != NULL) {
 394         update = ssd->update;
 395         ssd->update = NULL;
 396         *ext = update->ext;
 397         ret = true;
 398     }
 399     qemu_mutex_unlock(&ssd->lock);
 400
 401     return ret;
 402 }
 403
 404 static int interface_req_cmd_notification(QXLInstance *sin)
 405 {
 406     dprint(1, "%s:\n", __FUNCTION__);
 407     return 1;
 408 }
 409
 410 static void interface_release_resource(QXLInstance *sin,
 411                                        struct QXLReleaseInfoExt ext)
 412 {
 413     SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
 414     uintptr_t id;
 415
 416     dprint(2, "%s:\n", __FUNCTION__);
 417     id = ext.info->id;
 418     qemu_spice_destroy_update(ssd, (void*)id);
 419 }
 420
 421 static int interface_get_cursor_command(QXLInstance *sin, struct QXLCommandExt *ext)
 422 {
 423     dprint(3, "%s:\n", __FUNCTION__);
 424     return false;
 425 }
 426
 427 static int interface_req_cursor_notification(QXLInstance *sin)
 428 {
 429     dprint(1, "%s:\n", __FUNCTION__);
 430     return 1;
 431 }
 432
 433 static void interface_notify_update(QXLInstance *sin, uint32_t update_id)
 434 {
 435     fprintf(stderr, "%s: abort()\n", __FUNCTION__);
 436     abort();
 437 }
 438
 439 static int interface_flush_resources(QXLInstance *sin)
 440 {
 441     fprintf(stderr, "%s: abort()\n", __FUNCTION__);
 442     abort();
 443     return 0;
 444 }
 445
 446 static const QXLInterface dpy_interface = {
 447     .base.type               = SPICE_INTERFACE_QXL,
 448     .base.description        = "qemu simple display",
 449     .base.major_version      = SPICE_INTERFACE_QXL_MAJOR,
 450     .base.minor_version      = SPICE_INTERFACE_QXL_MINOR,
 451
 452     .attache_worker          = interface_attach_worker,
 453     .set_compression_level   = interface_set_compression_level,
 454     .set_mm_time             = interface_set_mm_time,
 455     .get_init_info           = interface_get_init_info,
 456
 457     /* the callbacks below are called from spice server thread context */
 458     .get_command             = interface_get_command,
 459     .req_cmd_notification    = interface_req_cmd_notification,
 460     .release_resource        = interface_release_resource,
 461     .get_cursor_command      = interface_get_cursor_command,
 462     .req_cursor_notification = interface_req_cursor_notification,
 463     .notify_update           = interface_notify_update,
 464     .flush_resources         = interface_flush_resources,
 465 };
 466
 467 static SimpleSpiceDisplay sdpy;
 468
 469 static void display_update(struct DisplayState *ds, int x, int y, int w, int h)
 470 {
 471     qemu_spice_display_update(&sdpy, x, y, w, h);
 472 }
 473
 474 static void display_resize(struct DisplayState *ds)
 475 {
 476     qemu_spice_display_resize(&sdpy);
 477 }
 478
 479 static void display_refresh(struct DisplayState *ds)
 480 {
 481     qemu_spice_display_refresh(&sdpy);
 482 }
 483
 484 static DisplayChangeListener display_listener = {
 485     .dpy_update  = display_update,
 486     .dpy_resize  = display_resize,
 487     .dpy_refresh = display_refresh,
 488 };
 489
 490 void qemu_spice_display_init(DisplayState *ds)
 491 {
 492     assert(sdpy.ds == NULL);
 493     qemu_spice_display_init_common(&sdpy, ds);
 494     register_displaychangelistener(ds, &display_listener);
 495
 496     sdpy.qxl.base.sif = &dpy_interface.base;
 497     qemu_spice_add_interface(&sdpy.qxl.base);
 498     assert(sdpy.worker);
 499
 500     qemu_add_vm_change_state_handler(qemu_spice_vm_change_state_handler, &sdpy);
 501     qemu_spice_create_host_memslot(&sdpy);
 502     qemu_spice_create_host_primary(&sdpy);
 503 }