ui: introduce enum to track VNC client framebuffer update request state
[qemu/ar7.git] / ui / vnc.h
blobb9d310e640417d22276d2675c83dcbd9211271bd
1 /*
2 * QEMU VNC display driver
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
6 * Copyright (C) 2009 Red Hat, Inc
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
27 #ifndef QEMU_VNC_H
28 #define QEMU_VNC_H
30 #include "qemu-common.h"
31 #include "qemu/queue.h"
32 #include "qemu/thread.h"
33 #include "ui/console.h"
34 #include "audio/audio.h"
35 #include "qemu/bitmap.h"
36 #include "crypto/tlssession.h"
37 #include "qemu/buffer.h"
38 #include "io/channel-socket.h"
39 #include "io/channel-tls.h"
40 #include <zlib.h>
42 #include "keymaps.h"
43 #include "vnc-palette.h"
44 #include "vnc-enc-zrle.h"
45 #include "qapi-types.h"
47 // #define _VNC_DEBUG 1
49 #ifdef _VNC_DEBUG
50 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
51 #else
52 #define VNC_DEBUG(fmt, ...) do { } while (0)
53 #endif
55 /*****************************************************************************
57 * Core data structures
59 *****************************************************************************/
61 typedef struct VncState VncState;
62 typedef struct VncJob VncJob;
63 typedef struct VncRect VncRect;
64 typedef struct VncRectEntry VncRectEntry;
66 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
68 typedef void VncWritePixels(VncState *vs, void *data, int size);
70 typedef void VncSendHextileTile(VncState *vs,
71 int x, int y, int w, int h,
72 void *last_bg,
73 void *last_fg,
74 int *has_bg, int *has_fg);
76 /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
77 * by one bit in the dirty bitmap, should be a power of 2 */
78 #define VNC_DIRTY_PIXELS_PER_BIT 16
80 /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
82 #define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
83 #define VNC_MAX_HEIGHT 2048
85 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
86 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
88 /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
89 * VNC_DIRTY_BITS due to alignment */
90 #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
92 #define VNC_STAT_RECT 64
93 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
94 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
96 #define VNC_AUTH_CHALLENGE_SIZE 16
98 typedef struct VncDisplay VncDisplay;
100 #include "vnc-auth-vencrypt.h"
101 #ifdef CONFIG_VNC_SASL
102 #include "vnc-auth-sasl.h"
103 #endif
104 #include "vnc-ws.h"
106 struct VncRectStat
108 /* time of last 10 updates, to find update frequency */
109 struct timeval times[10];
110 int idx;
112 double freq; /* Update frequency (in Hz) */
113 bool updated; /* Already updated during this refresh */
116 typedef struct VncRectStat VncRectStat;
118 struct VncSurface
120 struct timeval last_freq_check;
121 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
122 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
123 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
124 pixman_image_t *fb;
125 pixman_format_code_t format;
128 typedef enum VncShareMode {
129 VNC_SHARE_MODE_CONNECTING = 1,
130 VNC_SHARE_MODE_SHARED,
131 VNC_SHARE_MODE_EXCLUSIVE,
132 VNC_SHARE_MODE_DISCONNECTED,
133 } VncShareMode;
135 typedef enum VncSharePolicy {
136 VNC_SHARE_POLICY_IGNORE = 1,
137 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
138 VNC_SHARE_POLICY_FORCE_SHARED,
139 } VncSharePolicy;
141 struct VncDisplay
143 QTAILQ_HEAD(, VncState) clients;
144 int num_connecting;
145 int num_shared;
146 int num_exclusive;
147 int connections_limit;
148 VncSharePolicy share_policy;
149 size_t nlsock;
150 QIOChannelSocket **lsock;
151 guint *lsock_tag;
152 size_t nlwebsock;
153 QIOChannelSocket **lwebsock;
154 guint *lwebsock_tag;
155 DisplaySurface *ds;
156 DisplayChangeListener dcl;
157 kbd_layout_t *kbd_layout;
158 int lock_key_sync;
159 QEMUPutLEDEntry *led;
160 int ledstate;
161 int key_delay_ms;
162 QemuMutex mutex;
164 QEMUCursor *cursor;
165 int cursor_msize;
166 uint8_t *cursor_mask;
168 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
169 pixman_image_t *server; /* vnc server surface */
171 const char *id;
172 QTAILQ_ENTRY(VncDisplay) next;
173 bool is_unix;
174 char *password;
175 time_t expires;
176 int auth;
177 int subauth; /* Used by VeNCrypt */
178 int ws_auth; /* Used by websockets */
179 int ws_subauth; /* Used by websockets */
180 bool lossy;
181 bool non_adaptive;
182 QCryptoTLSCreds *tlscreds;
183 char *tlsaclname;
184 #ifdef CONFIG_VNC_SASL
185 VncDisplaySASL sasl;
186 #endif
189 typedef struct VncTight {
190 int type;
191 uint8_t quality;
192 uint8_t compression;
193 uint8_t pixel24;
194 Buffer tight;
195 Buffer tmp;
196 Buffer zlib;
197 Buffer gradient;
198 #ifdef CONFIG_VNC_JPEG
199 Buffer jpeg;
200 #endif
201 #ifdef CONFIG_VNC_PNG
202 Buffer png;
203 #endif
204 int levels[4];
205 z_stream stream[4];
206 } VncTight;
208 typedef struct VncHextile {
209 VncSendHextileTile *send_tile;
210 } VncHextile;
212 typedef struct VncZlib {
213 Buffer zlib;
214 Buffer tmp;
215 z_stream stream;
216 int level;
217 } VncZlib;
219 typedef struct VncZrle {
220 int type;
221 Buffer fb;
222 Buffer zrle;
223 Buffer tmp;
224 Buffer zlib;
225 z_stream stream;
226 VncPalette palette;
227 } VncZrle;
229 typedef struct VncZywrle {
230 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
231 } VncZywrle;
233 struct VncRect
235 int x;
236 int y;
237 int w;
238 int h;
241 struct VncRectEntry
243 struct VncRect rect;
244 QLIST_ENTRY(VncRectEntry) next;
247 struct VncJob
249 VncState *vs;
251 QLIST_HEAD(, VncRectEntry) rectangles;
252 QTAILQ_ENTRY(VncJob) next;
255 typedef enum {
256 VNC_STATE_UPDATE_NONE,
257 VNC_STATE_UPDATE_INCREMENTAL,
258 VNC_STATE_UPDATE_FORCE,
259 } VncStateUpdate;
261 struct VncState
263 QIOChannelSocket *sioc; /* The underlying socket */
264 QIOChannel *ioc; /* The channel currently used for I/O */
265 guint ioc_tag;
266 gboolean disconnecting;
268 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
269 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
270 * vnc-jobs-async.c */
272 VncDisplay *vd;
273 VncStateUpdate update; /* Most recent pending request from client */
274 int has_dirty;
275 uint32_t features;
276 int absolute;
277 int last_x;
278 int last_y;
279 uint32_t last_bmask;
280 int client_width;
281 int client_height;
282 VncShareMode share_mode;
284 uint32_t vnc_encoding;
286 int major;
287 int minor;
289 int auth;
290 int subauth; /* Used by VeNCrypt */
291 char challenge[VNC_AUTH_CHALLENGE_SIZE];
292 QCryptoTLSSession *tls; /* Borrowed pointer from channel, don't free */
293 #ifdef CONFIG_VNC_SASL
294 VncStateSASL sasl;
295 #endif
296 bool encode_ws;
297 bool websocket;
299 VncClientInfo *info;
301 Buffer output;
302 Buffer input;
303 /* current output mode information */
304 VncWritePixels *write_pixels;
305 PixelFormat client_pf;
306 pixman_format_code_t client_format;
307 bool client_be;
309 CaptureVoiceOut *audio_cap;
310 struct audsettings as;
312 VncReadEvent *read_handler;
313 size_t read_handler_expect;
314 /* input */
315 uint8_t modifiers_state[256];
317 bool abort;
318 QemuMutex output_mutex;
319 QEMUBH *bh;
320 Buffer jobs_buffer;
322 /* Encoding specific, if you add something here, don't forget to
323 * update vnc_async_encoding_start()
325 VncTight tight;
326 VncZlib zlib;
327 VncHextile hextile;
328 VncZrle zrle;
329 VncZywrle zywrle;
331 Notifier mouse_mode_notifier;
333 QTAILQ_ENTRY(VncState) next;
337 /*****************************************************************************
339 * Authentication modes
341 *****************************************************************************/
343 enum {
344 VNC_AUTH_INVALID = 0,
345 VNC_AUTH_NONE = 1,
346 VNC_AUTH_VNC = 2,
347 VNC_AUTH_RA2 = 5,
348 VNC_AUTH_RA2NE = 6,
349 VNC_AUTH_TIGHT = 16,
350 VNC_AUTH_ULTRA = 17,
351 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
352 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
353 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
356 enum {
357 VNC_AUTH_VENCRYPT_PLAIN = 256,
358 VNC_AUTH_VENCRYPT_TLSNONE = 257,
359 VNC_AUTH_VENCRYPT_TLSVNC = 258,
360 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
361 VNC_AUTH_VENCRYPT_X509NONE = 260,
362 VNC_AUTH_VENCRYPT_X509VNC = 261,
363 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
364 VNC_AUTH_VENCRYPT_X509SASL = 263,
365 VNC_AUTH_VENCRYPT_TLSSASL = 264,
369 /*****************************************************************************
371 * Encoding types
373 *****************************************************************************/
375 #define VNC_ENCODING_RAW 0x00000000
376 #define VNC_ENCODING_COPYRECT 0x00000001
377 #define VNC_ENCODING_RRE 0x00000002
378 #define VNC_ENCODING_CORRE 0x00000004
379 #define VNC_ENCODING_HEXTILE 0x00000005
380 #define VNC_ENCODING_ZLIB 0x00000006
381 #define VNC_ENCODING_TIGHT 0x00000007
382 #define VNC_ENCODING_ZLIBHEX 0x00000008
383 #define VNC_ENCODING_TRLE 0x0000000f
384 #define VNC_ENCODING_ZRLE 0x00000010
385 #define VNC_ENCODING_ZYWRLE 0x00000011
386 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
387 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
388 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
389 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
390 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
391 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
392 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
393 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
394 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
395 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
396 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
397 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
398 #define VNC_ENCODING_WMVi 0x574D5669
400 /*****************************************************************************
402 * Other tight constants
404 *****************************************************************************/
407 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
410 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
411 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
412 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
413 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
414 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
415 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
416 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
417 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
419 /*****************************************************************************
421 * Features
423 *****************************************************************************/
425 #define VNC_FEATURE_RESIZE 0
426 #define VNC_FEATURE_HEXTILE 1
427 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
428 #define VNC_FEATURE_WMVI 3
429 #define VNC_FEATURE_TIGHT 4
430 #define VNC_FEATURE_ZLIB 5
431 #define VNC_FEATURE_COPYRECT 6
432 #define VNC_FEATURE_RICH_CURSOR 7
433 #define VNC_FEATURE_TIGHT_PNG 8
434 #define VNC_FEATURE_ZRLE 9
435 #define VNC_FEATURE_ZYWRLE 10
436 #define VNC_FEATURE_LED_STATE 11
438 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
439 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
440 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
441 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
442 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
443 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
444 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
445 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
446 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
447 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
448 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
449 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
452 /* Client -> Server message IDs */
453 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
454 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
455 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
456 #define VNC_MSG_CLIENT_KEY_EVENT 4
457 #define VNC_MSG_CLIENT_POINTER_EVENT 5
458 #define VNC_MSG_CLIENT_CUT_TEXT 6
459 #define VNC_MSG_CLIENT_VMWARE_0 127
460 #define VNC_MSG_CLIENT_CALL_CONTROL 249
461 #define VNC_MSG_CLIENT_XVP 250
462 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
463 #define VNC_MSG_CLIENT_TIGHT 252
464 #define VNC_MSG_CLIENT_GII 253
465 #define VNC_MSG_CLIENT_VMWARE_1 254
466 #define VNC_MSG_CLIENT_QEMU 255
468 /* Server -> Client message IDs */
469 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
470 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
471 #define VNC_MSG_SERVER_BELL 2
472 #define VNC_MSG_SERVER_CUT_TEXT 3
473 #define VNC_MSG_SERVER_VMWARE_0 127
474 #define VNC_MSG_SERVER_CALL_CONTROL 249
475 #define VNC_MSG_SERVER_XVP 250
476 #define VNC_MSG_SERVER_TIGHT 252
477 #define VNC_MSG_SERVER_GII 253
478 #define VNC_MSG_SERVER_VMWARE_1 254
479 #define VNC_MSG_SERVER_QEMU 255
483 /* QEMU client -> server message IDs */
484 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
485 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
487 /* QEMU server -> client message IDs */
488 #define VNC_MSG_SERVER_QEMU_AUDIO 1
492 /* QEMU client -> server audio message IDs */
493 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
494 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
495 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
497 /* QEMU server -> client audio message IDs */
498 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
499 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
500 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
503 /*****************************************************************************
505 * Internal APIs
507 *****************************************************************************/
509 /* Event loop functions */
510 gboolean vnc_client_io(QIOChannel *ioc,
511 GIOCondition condition,
512 void *opaque);
514 ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
515 ssize_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
517 /* Protocol I/O functions */
518 void vnc_write(VncState *vs, const void *data, size_t len);
519 void vnc_write_u32(VncState *vs, uint32_t value);
520 void vnc_write_s32(VncState *vs, int32_t value);
521 void vnc_write_u16(VncState *vs, uint16_t value);
522 void vnc_write_u8(VncState *vs, uint8_t value);
523 void vnc_flush(VncState *vs);
524 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
525 void vnc_disconnect_finish(VncState *vs);
526 void vnc_start_protocol(VncState *vs);
529 /* Buffer I/O functions */
530 uint32_t read_u32(uint8_t *data, size_t offset);
532 /* Protocol stage functions */
533 void vnc_client_error(VncState *vs);
534 ssize_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp);
536 void start_client_init(VncState *vs);
537 void start_auth_vnc(VncState *vs);
540 /* Misc helpers */
542 static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
543 return (vs->features & (1 << feature));
546 /* Framebuffer */
547 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
548 int32_t encoding);
550 /* server fb is in PIXMAN_x8r8g8b8 */
551 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
552 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
553 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
555 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
556 int vnc_server_fb_stride(VncDisplay *vd);
558 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
559 double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
560 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
562 /* Encodings */
563 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
565 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
567 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
568 int y, int w, int h);
569 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
571 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
572 void vnc_zlib_zfree(void *x, void *addr);
573 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
574 void vnc_zlib_clear(VncState *vs);
576 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
577 int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
578 int w, int h);
579 void vnc_tight_clear(VncState *vs);
581 int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
582 int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
583 void vnc_zrle_clear(VncState *vs);
585 #endif /* QEMU_VNC_H */