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 #if defined(CONFIG_OPENGL_DMABUF)
  28 # if SPICE_SERVER_VERSION >= 0x000d01 /* release 0.13.1 */
  29 #  define HAVE_SPICE_GL 1
  30 #  include "ui/egl-helpers.h"
  31 #  include "ui/egl-context.h"
  32 # endif
  33 #endif
  34
  35 #define NUM_MEMSLOTS 8
  36 #define MEMSLOT_GENERATION_BITS 8
  37 #define MEMSLOT_SLOT_BITS 8
  38
  39 #define MEMSLOT_GROUP_HOST  0
  40 #define MEMSLOT_GROUP_GUEST 1
  41 #define NUM_MEMSLOTS_GROUPS 2
  42
  43 /*
  44  * Internal enum to differenciate between options for
  45  * io calls that have a sync (old) version and an _async (new)
  46  * version:
  47  *  QXL_SYNC: use the old version
  48  *  QXL_ASYNC: use the new version and make sure there are no two
  49  *   happening at the same time. This is used for guest initiated
  50  *   calls
  51  */
  52 typedef enum qxl_async_io {
  53     QXL_SYNC,
  54     QXL_ASYNC,
  55 } qxl_async_io;
  56
  57 enum {
  58     QXL_COOKIE_TYPE_IO,
  59     QXL_COOKIE_TYPE_RENDER_UPDATE_AREA,
  60     QXL_COOKIE_TYPE_POST_LOAD_MONITORS_CONFIG,
  61     QXL_COOKIE_TYPE_GL_DRAW_DONE,
  62 };
  63
  64 typedef struct QXLCookie {
  65     int      type;
  66     uint64_t io;
  67     union {
  68         uint32_t surface_id;
  69         QXLRect area;
  70         struct {
  71             QXLRect area;
  72             int redraw;
  73         } render;
  74         void *data;
  75     } u;
  76 } QXLCookie;
  77
  78 QXLCookie *qxl_cookie_new(int type, uint64_t io);
  79
  80 typedef struct SimpleSpiceDisplay SimpleSpiceDisplay;
  81 typedef struct SimpleSpiceUpdate SimpleSpiceUpdate;
  82 typedef struct SimpleSpiceCursor SimpleSpiceCursor;
  83
  84 struct SimpleSpiceDisplay {
  85     DisplaySurface *ds;
  86     DisplayChangeListener dcl;
  87     void *buf;
  88     int bufsize;
  89     QXLInstance qxl;
  90     uint32_t unique;
  91     pixman_image_t *surface;
  92     pixman_image_t *mirror;
  93     int32_t num_surfaces;
  94
  95     QXLRect dirty;
  96     int notify;
  97
  98     /*
  99      * All struct members below this comment can be accessed from
 100      * both spice server and qemu (iothread) context and any access
 101      * to them must be protected by the lock.
 102      */
 103     QemuMutex lock;
 104     QTAILQ_HEAD(, SimpleSpiceUpdate) updates;
 105
 106     /* cursor (without qxl): displaychangelistener -> spice server */
 107     SimpleSpiceCursor *ptr_define;
 108     SimpleSpiceCursor *ptr_move;
 109     int16_t ptr_x, ptr_y;
 110     int16_t hot_x, hot_y;
 111
 112     /* cursor (with qxl): qxl local renderer -> displaychangelistener */
 113     QEMUCursor *cursor;
 114     int mouse_x, mouse_y;
 115     QEMUBH *cursor_bh;
 116
 117 #ifdef HAVE_SPICE_GL
 118     /* opengl rendering */
 119     QEMUBH *gl_unblock_bh;
 120     QEMUTimer *gl_unblock_timer;
 121     QemuGLShader *gls;
 122     int gl_updates;
 123     bool have_scanout;
 124     bool have_surface;
 125
 126     QemuDmaBuf *guest_dmabuf;
 127     bool guest_dmabuf_refresh;
 128     bool render_cursor;
 129
 130     egl_fb guest_fb;
 131     egl_fb blit_fb;
 132     egl_fb cursor_fb;
 133     bool have_hot;
 134 #endif
 135 };
 136
 137 struct SimpleSpiceUpdate {
 138     QXLDrawable drawable;
 139     QXLImage image;
 140     QXLCommandExt ext;
 141     uint8_t *bitmap;
 142     QTAILQ_ENTRY(SimpleSpiceUpdate) next;
 143 };
 144
 145 struct SimpleSpiceCursor {
 146     QXLCursorCmd cmd;
 147     QXLCommandExt ext;
 148     QXLCursor cursor;
 149 };
 150
 151 extern bool spice_opengl;
 152
 153 int qemu_spice_rect_is_empty(const QXLRect* r);
 154 void qemu_spice_rect_union(QXLRect *dest, const QXLRect *r);
 155
 156 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update);
 157 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd);
 158 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd);
 159 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd);
 160 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd);
 161
 162 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
 163                                int x, int y, int w, int h);
 164 void qemu_spice_display_switch(SimpleSpiceDisplay *ssd,
 165                                DisplaySurface *surface);
 166 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd);
 167 void qemu_spice_cursor_refresh_bh(void *opaque);
 168
 169 void qemu_spice_add_memslot(SimpleSpiceDisplay *ssd, QXLDevMemSlot *memslot,
 170                             qxl_async_io async);
 171 void qemu_spice_del_memslot(SimpleSpiceDisplay *ssd, uint32_t gid,
 172                             uint32_t sid);
 173 void qemu_spice_create_primary_surface(SimpleSpiceDisplay *ssd, uint32_t id,
 174                                        QXLDevSurfaceCreate *surface,
 175                                        qxl_async_io async);
 176 void qemu_spice_destroy_primary_surface(SimpleSpiceDisplay *ssd,
 177                                         uint32_t id, qxl_async_io async);
 178 void qemu_spice_wakeup(SimpleSpiceDisplay *ssd);
 179 void qemu_spice_display_start(void);
 180 void qemu_spice_display_stop(void);
 181 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd);
 182
 183 bool qemu_spice_fill_device_address(QemuConsole *con,
 184                                     char *device_address,
 185                                     size_t size);