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