2 * QEMU VNC display driver
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
30 #include "qemu-common.h"
31 #include "qemu/queue.h"
32 #include "qemu/thread.h"
33 #include "ui/console.h"
34 #include "monitor/monitor.h"
35 #include "audio/audio.h"
36 #include "qemu/bitmap.h"
41 #include "vnc-palette.h"
42 #include "vnc-enc-zrle.h"
44 // #define _VNC_DEBUG 1
47 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
49 #define VNC_DEBUG(fmt, ...) do { } while (0)
52 /*****************************************************************************
54 * Core data structures
56 *****************************************************************************/
65 typedef struct VncState VncState;
66 typedef struct VncJob VncJob;
67 typedef struct VncRect VncRect;
68 typedef struct VncRectEntry VncRectEntry;
70 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
72 typedef void VncWritePixels(VncState *vs, void *data, int size);
74 typedef void VncSendHextileTile(VncState *vs,
75 int x, int y, int w, int h,
78 int *has_bg, int *has_fg);
80 /* VNC_MAX_WIDTH must be a multiple of 16. */
81 #define VNC_MAX_WIDTH 2560
82 #define VNC_MAX_HEIGHT 2048
84 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
85 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / 16)
87 #define VNC_STAT_RECT 64
88 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
89 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
91 #define VNC_AUTH_CHALLENGE_SIZE 16
93 typedef struct VncDisplay VncDisplay;
97 #include "vnc-auth-vencrypt.h"
99 #ifdef CONFIG_VNC_SASL
100 #include "vnc-auth-sasl.h"
108 /* time of last 10 updates, to find update frequency */
109 struct timeval times[10];
112 double freq; /* Update frequency (in Hz) */
113 bool updated; /* Already updated during this refresh */
116 typedef struct VncRectStat VncRectStat;
120 struct timeval last_freq_check;
121 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_MAX_WIDTH / 16);
122 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
124 pixman_format_code_t format;
127 typedef enum VncShareMode {
128 VNC_SHARE_MODE_CONNECTING = 1,
129 VNC_SHARE_MODE_SHARED,
130 VNC_SHARE_MODE_EXCLUSIVE,
131 VNC_SHARE_MODE_DISCONNECTED,
134 typedef enum VncSharePolicy {
135 VNC_SHARE_POLICY_IGNORE = 1,
136 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
137 VNC_SHARE_POLICY_FORCE_SHARED,
142 QTAILQ_HEAD(, VncState) clients;
144 VncSharePolicy share_policy;
152 DisplayChangeListener dcl;
153 kbd_layout_t *kbd_layout;
159 uint8_t *cursor_mask;
161 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
162 pixman_image_t *server; /* vnc server surface */
170 #ifdef CONFIG_VNC_TLS
171 int subauth; /* Used by VeNCrypt */
174 #ifdef CONFIG_VNC_SASL
179 typedef struct VncTight {
188 #ifdef CONFIG_VNC_JPEG
191 #ifdef CONFIG_VNC_PNG
198 typedef struct VncHextile {
199 VncSendHextileTile *send_tile;
202 typedef struct VncZlib {
209 typedef struct VncZrle {
219 typedef struct VncZywrle {
220 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
234 QLIST_ENTRY(VncRectEntry) next;
241 QLIST_HEAD(, VncRectEntry) rectangles;
242 QTAILQ_ENTRY(VncJob) next;
249 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
250 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
251 * vnc-jobs-async.c */
262 VncShareMode share_mode;
264 uint32_t vnc_encoding;
270 char challenge[VNC_AUTH_CHALLENGE_SIZE];
271 #ifdef CONFIG_VNC_TLS
272 int subauth; /* Used by VeNCrypt */
275 #ifdef CONFIG_VNC_SASL
279 #ifdef CONFIG_VNC_TLS
281 #endif /* CONFIG_VNC_TLS */
284 #endif /* CONFIG_VNC_WS */
294 /* current output mode information */
295 VncWritePixels *write_pixels;
296 PixelFormat client_pf;
297 pixman_format_code_t client_format;
300 CaptureVoiceOut *audio_cap;
301 struct audsettings as;
303 VncReadEvent *read_handler;
304 size_t read_handler_expect;
306 uint8_t modifiers_state[256];
307 QEMUPutLEDEntry *led;
311 QemuMutex output_mutex;
315 /* Encoding specific, if you add something here, don't forget to
316 * update vnc_async_encoding_start()
324 Notifier mouse_mode_notifier;
326 QTAILQ_ENTRY(VncState) next;
330 /*****************************************************************************
332 * Authentication modes
334 *****************************************************************************/
337 VNC_AUTH_INVALID = 0,
344 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
345 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
346 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
350 VNC_AUTH_VENCRYPT_PLAIN = 256,
351 VNC_AUTH_VENCRYPT_TLSNONE = 257,
352 VNC_AUTH_VENCRYPT_TLSVNC = 258,
353 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
354 VNC_AUTH_VENCRYPT_X509NONE = 260,
355 VNC_AUTH_VENCRYPT_X509VNC = 261,
356 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
357 VNC_AUTH_VENCRYPT_X509SASL = 263,
358 VNC_AUTH_VENCRYPT_TLSSASL = 264,
362 /*****************************************************************************
366 *****************************************************************************/
368 #define VNC_ENCODING_RAW 0x00000000
369 #define VNC_ENCODING_COPYRECT 0x00000001
370 #define VNC_ENCODING_RRE 0x00000002
371 #define VNC_ENCODING_CORRE 0x00000004
372 #define VNC_ENCODING_HEXTILE 0x00000005
373 #define VNC_ENCODING_ZLIB 0x00000006
374 #define VNC_ENCODING_TIGHT 0x00000007
375 #define VNC_ENCODING_ZLIBHEX 0x00000008
376 #define VNC_ENCODING_TRLE 0x0000000f
377 #define VNC_ENCODING_ZRLE 0x00000010
378 #define VNC_ENCODING_ZYWRLE 0x00000011
379 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
380 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
381 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
382 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
383 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
384 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
385 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
386 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
387 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
388 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
389 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
390 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
391 #define VNC_ENCODING_WMVi 0x574D5669
393 /*****************************************************************************
395 * Other tight constants
397 *****************************************************************************/
400 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
403 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
404 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
405 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
406 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
407 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
408 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
409 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
410 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
412 /*****************************************************************************
416 *****************************************************************************/
418 #define VNC_FEATURE_RESIZE 0
419 #define VNC_FEATURE_HEXTILE 1
420 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
421 #define VNC_FEATURE_WMVI 3
422 #define VNC_FEATURE_TIGHT 4
423 #define VNC_FEATURE_ZLIB 5
424 #define VNC_FEATURE_COPYRECT 6
425 #define VNC_FEATURE_RICH_CURSOR 7
426 #define VNC_FEATURE_TIGHT_PNG 8
427 #define VNC_FEATURE_ZRLE 9
428 #define VNC_FEATURE_ZYWRLE 10
429 #define VNC_FEATURE_LED_STATE 11
431 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
432 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
433 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
434 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
435 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
436 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
437 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
438 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
439 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
440 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
441 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
442 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
445 /* Client -> Server message IDs */
446 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
447 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
448 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
449 #define VNC_MSG_CLIENT_KEY_EVENT 4
450 #define VNC_MSG_CLIENT_POINTER_EVENT 5
451 #define VNC_MSG_CLIENT_CUT_TEXT 6
452 #define VNC_MSG_CLIENT_VMWARE_0 127
453 #define VNC_MSG_CLIENT_CALL_CONTROL 249
454 #define VNC_MSG_CLIENT_XVP 250
455 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
456 #define VNC_MSG_CLIENT_TIGHT 252
457 #define VNC_MSG_CLIENT_GII 253
458 #define VNC_MSG_CLIENT_VMWARE_1 254
459 #define VNC_MSG_CLIENT_QEMU 255
461 /* Server -> Client message IDs */
462 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
463 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
464 #define VNC_MSG_SERVER_BELL 2
465 #define VNC_MSG_SERVER_CUT_TEXT 3
466 #define VNC_MSG_SERVER_VMWARE_0 127
467 #define VNC_MSG_SERVER_CALL_CONTROL 249
468 #define VNC_MSG_SERVER_XVP 250
469 #define VNC_MSG_SERVER_TIGHT 252
470 #define VNC_MSG_SERVER_GII 253
471 #define VNC_MSG_SERVER_VMWARE_1 254
472 #define VNC_MSG_SERVER_QEMU 255
476 /* QEMU client -> server message IDs */
477 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
478 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
480 /* QEMU server -> client message IDs */
481 #define VNC_MSG_SERVER_QEMU_AUDIO 1
485 /* QEMU client -> server audio message IDs */
486 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
487 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
488 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
490 /* QEMU server -> client audio message IDs */
491 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
492 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
493 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
496 /*****************************************************************************
500 *****************************************************************************/
502 /* Event loop functions */
503 void vnc_client_read(void *opaque);
504 void vnc_client_write(void *opaque);
506 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
507 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
509 /* Protocol I/O functions */
510 void vnc_write(VncState *vs, const void *data, size_t len);
511 void vnc_write_u32(VncState *vs, uint32_t value);
512 void vnc_write_s32(VncState *vs, int32_t value);
513 void vnc_write_u16(VncState *vs, uint16_t value);
514 void vnc_write_u8(VncState *vs, uint8_t value);
515 void vnc_flush(VncState *vs);
516 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
517 void vnc_disconnect_finish(VncState *vs);
518 void vnc_init_state(VncState *vs);
521 /* Buffer I/O functions */
522 uint32_t read_u32(uint8_t *data, size_t offset);
524 /* Protocol stage functions */
525 void vnc_client_error(VncState *vs);
526 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
528 void start_client_init(VncState *vs);
529 void start_auth_vnc(VncState *vs);
531 /* Buffer management */
532 void buffer_reserve(Buffer *buffer, size_t len);
533 void buffer_reset(Buffer *buffer);
534 void buffer_free(Buffer *buffer);
535 void buffer_append(Buffer *buffer, const void *data, size_t len);
536 void buffer_advance(Buffer *buf, size_t len);
537 uint8_t *buffer_end(Buffer *buffer);
542 char *vnc_socket_local_addr(const char *format, int fd);
543 char *vnc_socket_remote_addr(const char *format, int fd);
545 static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
546 return (vs->features & (1 << feature));
550 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
553 /* server fb is in PIXMAN_x8r8g8b8 */
554 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
555 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
556 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
558 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
559 int vnc_server_fb_stride(VncDisplay *vd);
561 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
562 double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
563 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
566 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
568 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
570 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
571 int y, int w, int h);
572 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
574 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
575 void vnc_zlib_zfree(void *x, void *addr);
576 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
577 void vnc_zlib_clear(VncState *vs);
579 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
580 int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
582 void vnc_tight_clear(VncState *vs);
584 int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
585 int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
586 void vnc_zrle_clear(VncState *vs);
588 #endif /* __QEMU_VNC_H */