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