xref: /qemu/include/ui/spice-display.h (revision 71d388d420e68ac77cd42f15f7e68cf5a6fb01b2)
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 "console.h"
24 #include "pflib.h"
25 #include "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 #define NUM_SURFACES 1024
36 
37 /*
38  * Internal enum to differenciate between options for
39  * io calls that have a sync (old) version and an _async (new)
40  * version:
41  *  QXL_SYNC: use the old version
42  *  QXL_ASYNC: use the new version and make sure there are no two
43  *   happening at the same time. This is used for guest initiated
44  *   calls
45  */
46 typedef enum qxl_async_io {
47     QXL_SYNC,
48     QXL_ASYNC,
49 } qxl_async_io;
50 
51 enum {
52     QXL_COOKIE_TYPE_IO,
53     QXL_COOKIE_TYPE_RENDER_UPDATE_AREA,
54 };
55 
56 typedef struct QXLCookie {
57     int      type;
58     uint64_t io;
59     union {
60         uint32_t surface_id;
61         QXLRect area;
62         struct {
63             QXLRect area;
64             int redraw;
65         } render;
66     } u;
67 } QXLCookie;
68 
69 QXLCookie *qxl_cookie_new(int type, uint64_t io);
70 
71 typedef struct SimpleSpiceDisplay SimpleSpiceDisplay;
72 typedef struct SimpleSpiceUpdate SimpleSpiceUpdate;
73 
74 struct SimpleSpiceDisplay {
75     DisplayState *ds;
76     void *buf;
77     int bufsize;
78     QXLWorker *worker;
79     QXLInstance qxl;
80     uint32_t unique;
81     QemuPfConv *conv;
82 
83     QXLRect dirty;
84     int notify;
85 #if SPICE_SERVER_VERSION < 0x000b02 /* before 0.11.2 */
86     int running;
87 #endif
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     SimpleSpiceUpdate *update;
96     QEMUCursor *cursor;
97     int mouse_x, mouse_y;
98 };
99 
100 struct SimpleSpiceUpdate {
101     QXLDrawable drawable;
102     QXLImage image;
103     QXLCommandExt ext;
104     uint8_t *bitmap;
105 };
106 
107 int qemu_spice_rect_is_empty(const QXLRect* r);
108 void qemu_spice_rect_union(QXLRect *dest, const QXLRect *r);
109 
110 void qemu_spice_destroy_update(SimpleSpiceDisplay *sdpy, SimpleSpiceUpdate *update);
111 void qemu_spice_create_host_memslot(SimpleSpiceDisplay *ssd);
112 void qemu_spice_create_host_primary(SimpleSpiceDisplay *ssd);
113 void qemu_spice_destroy_host_primary(SimpleSpiceDisplay *ssd);
114 void qemu_spice_vm_change_state_handler(void *opaque, int running,
115                                         RunState state);
116 void qemu_spice_display_init_common(SimpleSpiceDisplay *ssd, DisplayState *ds);
117 
118 void qemu_spice_display_update(SimpleSpiceDisplay *ssd,
119                                int x, int y, int w, int h);
120 void qemu_spice_display_resize(SimpleSpiceDisplay *ssd);
121 void qemu_spice_display_refresh(SimpleSpiceDisplay *ssd);
122 void qemu_spice_cursor_refresh_unlocked(SimpleSpiceDisplay *ssd);
123 
124 void qemu_spice_add_memslot(SimpleSpiceDisplay *ssd, QXLDevMemSlot *memslot,
125                             qxl_async_io async);
126 void qemu_spice_del_memslot(SimpleSpiceDisplay *ssd, uint32_t gid,
127                             uint32_t sid);
128 void qemu_spice_create_primary_surface(SimpleSpiceDisplay *ssd, uint32_t id,
129                                        QXLDevSurfaceCreate *surface,
130                                        qxl_async_io async);
131 void qemu_spice_destroy_primary_surface(SimpleSpiceDisplay *ssd,
132                                         uint32_t id, qxl_async_io async);
133 void qemu_spice_wakeup(SimpleSpiceDisplay *ssd);
134 #if SPICE_SERVER_VERSION >= 0x000b02 /* before 0.11.2 */
135 void qemu_spice_display_start(void);
136 void qemu_spice_display_stop(void);
137 #endif
138 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd);
139