xref: /openbmc/qemu/include/ui/spice-display.h (revision 2d7fedeb)
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     QXLWorker *worker;
90     QXLInstance qxl;
91     uint32_t unique;
92     pixman_image_t *surface;
93     pixman_image_t *mirror;
94     int32_t num_surfaces;
95 
96     QXLRect dirty;
97     int notify;
98 
99     /*
100      * All struct members below this comment can be accessed from
101      * both spice server and qemu (iothread) context and any access
102      * to them must be protected by the lock.
103      */
104     QemuMutex lock;
105     QTAILQ_HEAD(, SimpleSpiceUpdate) updates;
106 
107     /* cursor (without qxl): displaychangelistener -> spice server */
108     SimpleSpiceCursor *ptr_define;
109     SimpleSpiceCursor *ptr_move;
110     int16_t ptr_x, ptr_y;
111     int16_t hot_x, hot_y;
112 
113     /* cursor (with qxl): qxl local renderer -> displaychangelistener */
114     QEMUCursor *cursor;
115     int mouse_x, mouse_y;
116     QEMUBH *cursor_bh;
117 
118 #ifdef HAVE_SPICE_GL
119     /* opengl rendering */
120     QEMUBH *gl_unblock_bh;
121     QEMUTimer *gl_unblock_timer;
122     int dmabuf_fd;
123 #endif
124 };
125 
126 struct SimpleSpiceUpdate {
127     QXLDrawable drawable;
128     QXLImage image;
129     QXLCommandExt ext;
130     uint8_t *bitmap;
131     QTAILQ_ENTRY(SimpleSpiceUpdate) next;
132 };
133 
134 struct SimpleSpiceCursor {
135     QXLCursorCmd cmd;
136     QXLCommandExt ext;
137     QXLCursor cursor;
138 };
139 
140 int qemu_spice_rect_is_empty(const QXLRect* r);
141 void qemu_spice_rect_union(QXLRect *dest, const QXLRect *r);
142 
143 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update);
144 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd);
145 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd);
146 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd);
147 void qemu_spice_vm_change_state_handler(void *opaque, int running,
148                                         RunState state);
149 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd);
150 
151 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
152                                int x, int y, int w, int h);
153 void qemu_spice_display_switch(SimpleSpiceDisplay *ssd,
154                                DisplaySurface *surface);
155 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd);
156 void qemu_spice_cursor_refresh_bh(void *opaque);
157 
158 void qemu_spice_add_memslot(SimpleSpiceDisplay *ssd, QXLDevMemSlot *memslot,
159                             qxl_async_io async);
160 void qemu_spice_del_memslot(SimpleSpiceDisplay *ssd, uint32_t gid,
161                             uint32_t sid);
162 void qemu_spice_create_primary_surface(SimpleSpiceDisplay *ssd, uint32_t id,
163                                        QXLDevSurfaceCreate *surface,
164                                        qxl_async_io async);
165 void qemu_spice_destroy_primary_surface(SimpleSpiceDisplay *ssd,
166                                         uint32_t id, qxl_async_io async);
167 void qemu_spice_wakeup(SimpleSpiceDisplay *ssd);
168 void qemu_spice_display_start(void);
169 void qemu_spice_display_stop(void);
170 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd);
171