include/ui/spice-display.h

   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 <spice/ipc_ring.h>
  19 #include <spice/enums.h>
  20 #include <spice/qxl_dev.h>
  21
  22 #include "qemu/thread.h"
  23 #include "ui/qemu-pixman.h"
  24 #include "ui/console.h"
  25 #include "sysemu/sysemu.h"
  26
  27 #define NUM_MEMSLOTS 8
  28 #define MEMSLOT_GENERATION_BITS 8
  29 #define MEMSLOT_SLOT_BITS 8
  30
  31 #define MEMSLOT_GROUP_HOST  0
  32 #define MEMSLOT_GROUP_GUEST 1
  33 #define NUM_MEMSLOTS_GROUPS 2
  34
  35 /*
  36  * Internal enum to differenciate between options for
  37  * io calls that have a sync (old) version and an _async (new)
  38  * version:
  39  *  QXL_SYNC: use the old version
  40  *  QXL_ASYNC: use the new version and make sure there are no two
  41  *   happening at the same time. This is used for guest initiated
  42  *   calls
  43  */
  44 typedef enum qxl_async_io {
  45     QXL_SYNC,
  46     QXL_ASYNC,
  47 } qxl_async_io;
  48
  49 enum {
  50     QXL_COOKIE_TYPE_IO,
  51     QXL_COOKIE_TYPE_RENDER_UPDATE_AREA,
  52     QXL_COOKIE_TYPE_POST_LOAD_MONITORS_CONFIG,
  53 };
  54
  55 typedef struct QXLCookie {
  56     int      type;
  57     uint64_t io;
  58     union {
  59         uint32_t surface_id;
  60         QXLRect area;
  61         struct {
  62             QXLRect area;
  63             int redraw;
  64         } render;
  65     } u;
  66 } QXLCookie;
  67
  68 QXLCookie *qxl_cookie_new(int type, uint64_t io);
  69
  70 typedef struct SimpleSpiceDisplay SimpleSpiceDisplay;
  71 typedef struct SimpleSpiceUpdate SimpleSpiceUpdate;
  72 typedef struct SimpleSpiceCursor SimpleSpiceCursor;
  73
  74 struct SimpleSpiceDisplay {
  75     DisplaySurface *ds;
  76     DisplayChangeListener dcl;
  77     void *buf;
  78     int bufsize;
  79     QXLWorker *worker;
  80     QXLInstance qxl;
  81     uint32_t unique;
  82     pixman_image_t *surface;
  83     pixman_image_t *mirror;
  84     int32_t num_surfaces;
  85
  86     QXLRect dirty;
  87     int notify;
  88
  89     /*
  90      * All struct members below this comment can be accessed from
  91      * both spice server and qemu (iothread) context and any access
  92      * to them must be protected by the lock.
  93      */
  94     QemuMutex lock;
  95     QTAILQ_HEAD(, SimpleSpiceUpdate) updates;
  96
  97     /* cursor (without qxl): displaychangelistener -> spice server */
  98     SimpleSpiceCursor *ptr_define;
  99     SimpleSpiceCursor *ptr_move;
 100     uint16_t ptr_x, ptr_y;
 101
 102     /* cursor (with qxl): qxl local renderer -> displaychangelistener */
 103     QEMUCursor *cursor;
 104     int mouse_x, mouse_y;
 105     QEMUBH *cursor_bh;
 106 };
 107
 108 struct SimpleSpiceUpdate {
 109     QXLDrawable drawable;
 110     QXLImage image;
 111     QXLCommandExt ext;
 112     uint8_t *bitmap;
 113     QTAILQ_ENTRY(SimpleSpiceUpdate) next;
 114 };
 115
 116 struct SimpleSpiceCursor {
 117     QXLCursorCmd cmd;
 118     QXLCommandExt ext;
 119     QXLCursor cursor;
 120 };
 121
 122 int qemu_spice_rect_is_empty(const QXLRect* r);
 123 void qemu_spice_rect_union(QXLRect *dest, const QXLRect *r);
 124
 125 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update);
 126 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd);
 127 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd);
 128 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd);
 129 void qemu_spice_vm_change_state_handler(void *opaque, int running,
 130                                         RunState state);
 131 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd);
 132
 133 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
 134                                int x, int y, int w, int h);
 135 void qemu_spice_display_switch(SimpleSpiceDisplay *ssd,
 136                                DisplaySurface *surface);
 137 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd);
 138 void qemu_spice_cursor_refresh_bh(void *opaque);
 139
 140 void qemu_spice_add_memslot(SimpleSpiceDisplay *ssd, QXLDevMemSlot *memslot,
 141                             qxl_async_io async);
 142 void qemu_spice_del_memslot(SimpleSpiceDisplay *ssd, uint32_t gid,
 143                             uint32_t sid);
 144 void qemu_spice_create_primary_surface(SimpleSpiceDisplay *ssd, uint32_t id,
 145                                        QXLDevSurfaceCreate *surface,
 146                                        qxl_async_io async);
 147 void qemu_spice_destroy_primary_surface(SimpleSpiceDisplay *ssd,
 148                                         uint32_t id, qxl_async_io async);
 149 void qemu_spice_wakeup(SimpleSpiceDisplay *ssd);
 150 void qemu_spice_display_start(void);
 151 void qemu_spice_display_stop(void);
 152 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd);