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 static SimpleSpiceUpdate *qemu_spice_create_update(SimpleSpiceDisplay *ssd)
  66 {
  67     SimpleSpiceUpdate *update;
  68     QXLDrawable *drawable;
  69     QXLImage *image;
  70     QXLCommand *cmd;
  71     uint8_t *src, *dst;
  72     int by, bw, bh;
  73
  74     if (qemu_spice_rect_is_empty(&ssd->dirty)) {
  75         return NULL;
  76     };
  77
  78     dprint(2, "%s: lr %d -> %d,  tb -> %d -> %d\n", __FUNCTION__,
  79            ssd->dirty.left, ssd->dirty.right,
  80            ssd->dirty.top, ssd->dirty.bottom);
  81
  82     update   = qemu_mallocz(sizeof(*update));
  83     drawable = &update->drawable;
  84     image    = &update->image;
  85     cmd      = &update->ext.cmd;
  86
  87     bw       = ssd->dirty.right - ssd->dirty.left;
  88     bh       = ssd->dirty.bottom - ssd->dirty.top;
  89     update->bitmap = qemu_malloc(bw * bh * 4);
  90
  91     drawable->bbox            = ssd->dirty;
  92     drawable->clip.type       = SPICE_CLIP_TYPE_NONE;
  93     drawable->effect          = QXL_EFFECT_OPAQUE;
  94     drawable->release_info.id = (intptr_t)update;
  95     drawable->type            = QXL_DRAW_COPY;
  96     drawable->surfaces_dest[0] = -1;
  97     drawable->surfaces_dest[1] = -1;
  98     drawable->surfaces_dest[2] = -1;
  99
 100     drawable->u.copy.rop_descriptor  = SPICE_ROPD_OP_PUT;
 101     drawable->u.copy.src_bitmap      = (intptr_t)image;
 102     drawable->u.copy.src_area.right  = bw;
 103     drawable->u.copy.src_area.bottom = bh;
 104
 105     QXL_SET_IMAGE_ID(image, QXL_IMAGE_GROUP_DEVICE, ssd->unique++);
 106     image->descriptor.type   = SPICE_IMAGE_TYPE_BITMAP;
 107     image->bitmap.flags      = QXL_BITMAP_DIRECT | QXL_BITMAP_TOP_DOWN;
 108     image->bitmap.stride     = bw * 4;
 109     image->descriptor.width  = image->bitmap.x = bw;
 110     image->descriptor.height = image->bitmap.y = bh;
 111     image->bitmap.data = (intptr_t)(update->bitmap);
 112     image->bitmap.palette = 0;
 113     image->bitmap.format = SPICE_BITMAP_FMT_32BIT;
 114
 115     if (ssd->conv == NULL) {
 116         PixelFormat dst = qemu_default_pixelformat(32);
 117         ssd->conv = qemu_pf_conv_get(&dst, &ssd->ds->surface->pf);
 118         assert(ssd->conv);
 119     }
 120
 121     src = ds_get_data(ssd->ds) +
 122         ssd->dirty.top * ds_get_linesize(ssd->ds) +
 123         ssd->dirty.left * ds_get_bytes_per_pixel(ssd->ds);
 124     dst = update->bitmap;
 125     for (by = 0; by < bh; by++) {
 126         qemu_pf_conv_run(ssd->conv, dst, src, bw);
 127         src += ds_get_linesize(ssd->ds);
 128         dst += image->bitmap.stride;
 129     }
 130
 131     cmd->type = QXL_CMD_DRAW;
 132     cmd->data = (intptr_t)drawable;
 133
 134     memset(&ssd->dirty, 0, sizeof(ssd->dirty));
 135     return update;
 136 }
 137
 138 /*
 139  * Called from spice server thread context (via interface_release_ressource)
 140  * We do *not* hold the global qemu mutex here, so extra care is needed
 141  * when calling qemu functions.  Qemu interfaces used:
 142  *    - qemu_free (underlying glibc free is re-entrant).
 143  */
 144 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update)
 145 {
 146     qemu_free(update->bitmap);
 147     qemu_free(update);
 148 }
 149
 150 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd)
 151 {
 152     QXLDevMemSlot memslot;
 153
 154     dprint(1, "%s:\n", __FUNCTION__);
 155
 156     memset(&memslot, 0, sizeof(memslot));
 157     memslot.slot_group_id = MEMSLOT_GROUP_HOST;
 158     memslot.virt_end = ~0;
 159     ssd->worker->add_memslot(ssd->worker, &memslot);
 160 }
 161
 162 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd)
 163 {
 164     QXLDevSurfaceCreate surface;
 165
 166     dprint(1, "%s: %dx%d\n", __FUNCTION__,
 167            ds_get_width(ssd->ds), ds_get_height(ssd->ds));
 168
 169     surface.format     = SPICE_SURFACE_FMT_32_xRGB;
 170     surface.width      = ds_get_width(ssd->ds);
 171     surface.height     = ds_get_height(ssd->ds);
 172     surface.stride     = -surface.width * 4;
 173     surface.mouse_mode = true;
 174     surface.flags      = 0;
 175     surface.type       = 0;
 176     surface.mem        = (intptr_t)ssd->buf;
 177     surface.group_id   = MEMSLOT_GROUP_HOST;
 178
 179     qemu_mutex_unlock_iothread();
 180     ssd->worker->create_primary_surface(ssd->worker, 0, &surface);
 181     qemu_mutex_lock_iothread();
 182 }
 183
 184 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd)
 185 {
 186     dprint(1, "%s:\n", __FUNCTION__);
 187
 188     qemu_mutex_unlock_iothread();
 189     ssd->worker->destroy_primary_surface(ssd->worker, 0);
 190     qemu_mutex_lock_iothread();
 191 }
 192
 193 void qemu_spice_vm_change_state_handler(void *opaque, int running, int reason)
 194 {
 195     SimpleSpiceDisplay *ssd = opaque;
 196
 197     if (running) {
 198         ssd->worker->start(ssd->worker);
 199     } else {
 200         qemu_mutex_unlock_iothread();
 201         ssd->worker->stop(ssd->worker);
 202         qemu_mutex_lock_iothread();
 203     }
 204     ssd->running = running;
 205 }
 206
 207 /* display listener callbacks */
 208
 209 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
 210                                int x, int y, int w, int h)
 211 {
 212     QXLRect update_area;
 213
 214     dprint(2, "%s: x %d y %d w %d h %d\n", __FUNCTION__, x, y, w, h);
 215     update_area.left = x,
 216     update_area.right = x + w;
 217     update_area.top = y;
 218     update_area.bottom = y + h;
 219
 220     if (qemu_spice_rect_is_empty(&ssd->dirty)) {
 221         ssd->notify++;
 222     }
 223     qemu_spice_rect_union(&ssd->dirty, &update_area);
 224 }
 225
 226 void qemu_spice_display_resize(SimpleSpiceDisplay *ssd)
 227 {
 228     dprint(1, "%s:\n", __FUNCTION__);
 229
 230     memset(&ssd->dirty, 0, sizeof(ssd->dirty));
 231     qemu_pf_conv_put(ssd->conv);
 232     ssd->conv = NULL;
 233
 234     qemu_mutex_lock(&ssd->lock);
 235     if (ssd->update != NULL) {
 236         qemu_spice_destroy_update(ssd, ssd->update);
 237         ssd->update = NULL;
 238     }
 239     qemu_mutex_unlock(&ssd->lock);
 240     qemu_spice_destroy_host_primary(ssd);
 241     qemu_spice_create_host_primary(ssd);
 242
 243     memset(&ssd->dirty, 0, sizeof(ssd->dirty));
 244     ssd->notify++;
 245 }
 246
 247 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd)
 248 {
 249     dprint(3, "%s:\n", __FUNCTION__);
 250     vga_hw_update();
 251
 252     qemu_mutex_lock(&ssd->lock);
 253     if (ssd->update == NULL) {
 254         ssd->update = qemu_spice_create_update(ssd);
 255         ssd->notify++;
 256     }
 257     qemu_mutex_unlock(&ssd->lock);
 258
 259     if (ssd->notify) {
 260         ssd->notify = 0;
 261         ssd->worker->wakeup(ssd->worker);
 262         dprint(2, "%s: notify\n", __FUNCTION__);
 263     }
 264 }
 265
 266 /* spice display interface callbacks */
 267
 268 static void interface_attach_worker(QXLInstance *sin, QXLWorker *qxl_worker)
 269 {
 270     SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
 271
 272     dprint(1, "%s:\n", __FUNCTION__);
 273     ssd->worker = qxl_worker;
 274 }
 275
 276 static void interface_set_compression_level(QXLInstance *sin, int level)
 277 {
 278     dprint(1, "%s:\n", __FUNCTION__);
 279     /* nothing to do */
 280 }
 281
 282 static void interface_set_mm_time(QXLInstance *sin, uint32_t mm_time)
 283 {
 284     dprint(3, "%s:\n", __FUNCTION__);
 285     /* nothing to do */
 286 }
 287
 288 static void interface_get_init_info(QXLInstance *sin, QXLDevInitInfo *info)
 289 {
 290     SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
 291
 292     info->memslot_gen_bits = MEMSLOT_GENERATION_BITS;
 293     info->memslot_id_bits  = MEMSLOT_SLOT_BITS;
 294     info->num_memslots = NUM_MEMSLOTS;
 295     info->num_memslots_groups = NUM_MEMSLOTS_GROUPS;
 296     info->internal_groupslot_id = 0;
 297     info->qxl_ram_size = ssd->bufsize;
 298     info->n_surfaces = NUM_SURFACES;
 299 }
 300
 301 static int interface_get_command(QXLInstance *sin, struct QXLCommandExt *ext)
 302 {
 303     SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
 304     SimpleSpiceUpdate *update;
 305     int ret = false;
 306
 307     dprint(3, "%s:\n", __FUNCTION__);
 308
 309     qemu_mutex_lock(&ssd->lock);
 310     if (ssd->update != NULL) {
 311         update = ssd->update;
 312         ssd->update = NULL;
 313         *ext = update->ext;
 314         ret = true;
 315     }
 316     qemu_mutex_unlock(&ssd->lock);
 317
 318     return ret;
 319 }
 320
 321 static int interface_req_cmd_notification(QXLInstance *sin)
 322 {
 323     dprint(1, "%s:\n", __FUNCTION__);
 324     return 1;
 325 }
 326
 327 static void interface_release_resource(QXLInstance *sin,
 328                                        struct QXLReleaseInfoExt ext)
 329 {
 330     SimpleSpiceDisplay *ssd = container_of(sin, SimpleSpiceDisplay, qxl);
 331     uintptr_t id;
 332
 333     dprint(2, "%s:\n", __FUNCTION__);
 334     id = ext.info->id;
 335     qemu_spice_destroy_update(ssd, (void*)id);
 336 }
 337
 338 static int interface_get_cursor_command(QXLInstance *sin, struct QXLCommandExt *ext)
 339 {
 340     dprint(3, "%s:\n", __FUNCTION__);
 341     return false;
 342 }
 343
 344 static int interface_req_cursor_notification(QXLInstance *sin)
 345 {
 346     dprint(1, "%s:\n", __FUNCTION__);
 347     return 1;
 348 }
 349
 350 static void interface_notify_update(QXLInstance *sin, uint32_t update_id)
 351 {
 352     fprintf(stderr, "%s: abort()\n", __FUNCTION__);
 353     abort();
 354 }
 355
 356 static int interface_flush_resources(QXLInstance *sin)
 357 {
 358     fprintf(stderr, "%s: abort()\n", __FUNCTION__);
 359     abort();
 360     return 0;
 361 }
 362
 363 static const QXLInterface dpy_interface = {
 364     .base.type               = SPICE_INTERFACE_QXL,
 365     .base.description        = "qemu simple display",
 366     .base.major_version      = SPICE_INTERFACE_QXL_MAJOR,
 367     .base.minor_version      = SPICE_INTERFACE_QXL_MINOR,
 368
 369     .attache_worker          = interface_attach_worker,
 370     .set_compression_level   = interface_set_compression_level,
 371     .set_mm_time             = interface_set_mm_time,
 372     .get_init_info           = interface_get_init_info,
 373
 374     /* the callbacks below are called from spice server thread context */
 375     .get_command             = interface_get_command,
 376     .req_cmd_notification    = interface_req_cmd_notification,
 377     .release_resource        = interface_release_resource,
 378     .get_cursor_command      = interface_get_cursor_command,
 379     .req_cursor_notification = interface_req_cursor_notification,
 380     .notify_update           = interface_notify_update,
 381     .flush_resources         = interface_flush_resources,
 382 };
 383
 384 static SimpleSpiceDisplay sdpy;
 385
 386 static void display_update(struct DisplayState *ds, int x, int y, int w, int h)
 387 {
 388     qemu_spice_display_update(&sdpy, x, y, w, h);
 389 }
 390
 391 static void display_resize(struct DisplayState *ds)
 392 {
 393     qemu_spice_display_resize(&sdpy);
 394 }
 395
 396 static void display_refresh(struct DisplayState *ds)
 397 {
 398     qemu_spice_display_refresh(&sdpy);
 399 }
 400
 401 static DisplayChangeListener display_listener = {
 402     .dpy_update  = display_update,
 403     .dpy_resize  = display_resize,
 404     .dpy_refresh = display_refresh,
 405 };
 406
 407 void qemu_spice_display_init(DisplayState *ds)
 408 {
 409     assert(sdpy.ds == NULL);
 410     sdpy.ds = ds;
 411     qemu_mutex_init(&sdpy.lock);
 412     sdpy.bufsize = (16 * 1024 * 1024);
 413     sdpy.buf = qemu_malloc(sdpy.bufsize);
 414     register_displaychangelistener(ds, &display_listener);
 415
 416     sdpy.qxl.base.sif = &dpy_interface.base;
 417     qemu_spice_add_interface(&sdpy.qxl.base);
 418     assert(sdpy.worker);
 419
 420     qemu_add_vm_change_state_handler(qemu_spice_vm_change_state_handler, &sdpy);
 421     qemu_spice_create_host_memslot(&sdpy);
 422     qemu_spice_create_host_primary(&sdpy);
 423 }