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
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"
41 #include "vnc-palette.h"
42 #include "vnc-enc-zrle.h"
43 #include "qapi-types.h"
45 // #define _VNC_DEBUG 1
48 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
50 #define VNC_DEBUG(fmt, ...) do { } while (0)
53 /*****************************************************************************
55 * Core data structures
57 *****************************************************************************/
66 typedef struct VncState VncState
;
67 typedef struct VncJob VncJob
;
68 typedef struct VncRect VncRect
;
69 typedef struct VncRectEntry VncRectEntry
;
71 typedef int VncReadEvent(VncState
*vs
, uint8_t *data
, size_t len
);
73 typedef void VncWritePixels(VncState
*vs
, void *data
, int size
);
75 typedef void VncSendHextileTile(VncState
*vs
,
76 int x
, int y
, int w
, int h
,
79 int *has_bg
, int *has_fg
);
81 /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
82 * by one bit in the dirty bitmap, should be a power of 2 */
83 #define VNC_DIRTY_PIXELS_PER_BIT 16
85 /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
87 #define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
88 #define VNC_MAX_HEIGHT 2048
90 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
91 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
93 /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
94 * VNC_DIRTY_BITS due to alignment */
95 #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
97 #define VNC_STAT_RECT 64
98 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
99 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
101 #define VNC_AUTH_CHALLENGE_SIZE 16
103 typedef struct VncDisplay VncDisplay
;
105 #include "vnc-auth-vencrypt.h"
106 #ifdef CONFIG_VNC_SASL
107 #include "vnc-auth-sasl.h"
113 /* time of last 10 updates, to find update frequency */
114 struct timeval times
[10];
117 double freq
; /* Update frequency (in Hz) */
118 bool updated
; /* Already updated during this refresh */
121 typedef struct VncRectStat VncRectStat
;
125 struct timeval last_freq_check
;
126 DECLARE_BITMAP(dirty
[VNC_MAX_HEIGHT
],
127 VNC_MAX_WIDTH
/ VNC_DIRTY_PIXELS_PER_BIT
);
128 VncRectStat stats
[VNC_STAT_ROWS
][VNC_STAT_COLS
];
130 pixman_format_code_t format
;
133 typedef enum VncShareMode
{
134 VNC_SHARE_MODE_CONNECTING
= 1,
135 VNC_SHARE_MODE_SHARED
,
136 VNC_SHARE_MODE_EXCLUSIVE
,
137 VNC_SHARE_MODE_DISCONNECTED
,
140 typedef enum VncSharePolicy
{
141 VNC_SHARE_POLICY_IGNORE
= 1,
142 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE
,
143 VNC_SHARE_POLICY_FORCE_SHARED
,
148 QTAILQ_HEAD(, VncState
) clients
;
152 int connections_limit
;
153 VncSharePolicy share_policy
;
158 DisplayChangeListener dcl
;
159 kbd_layout_t
*kbd_layout
;
165 uint8_t *cursor_mask
;
167 struct VncSurface guest
; /* guest visible surface (aka ds->surface) */
168 pixman_image_t
*server
; /* vnc server surface */
171 QTAILQ_ENTRY(VncDisplay
) next
;
177 int subauth
; /* Used by VeNCrypt */
178 int ws_auth
; /* Used by websockets */
179 bool ws_tls
; /* Used by websockets */
182 QCryptoTLSCreds
*tlscreds
;
184 #ifdef CONFIG_VNC_SASL
189 typedef struct VncTight
{
198 #ifdef CONFIG_VNC_JPEG
201 #ifdef CONFIG_VNC_PNG
208 typedef struct VncHextile
{
209 VncSendHextileTile
*send_tile
;
212 typedef struct VncZlib
{
219 typedef struct VncZrle
{
229 typedef struct VncZywrle
{
230 int buf
[VNC_ZRLE_TILE_WIDTH
* VNC_ZRLE_TILE_HEIGHT
];
244 QLIST_ENTRY(VncRectEntry
) next
;
251 QLIST_HEAD(, VncRectEntry
) rectangles
;
252 QTAILQ_ENTRY(VncJob
) next
;
259 DECLARE_BITMAP(dirty
[VNC_MAX_HEIGHT
], VNC_DIRTY_BITS
);
260 uint8_t **lossy_rect
; /* Not an Array to avoid costly memcpy in
261 * vnc-jobs-async.c */
274 VncShareMode share_mode
;
276 uint32_t vnc_encoding
;
282 int subauth
; /* Used by VeNCrypt */
283 char challenge
[VNC_AUTH_CHALLENGE_SIZE
];
284 QCryptoTLSSession
*tls
;
285 #ifdef CONFIG_VNC_SASL
297 size_t ws_payload_remain
;
298 WsMask ws_payload_mask
;
299 /* current output mode information */
300 VncWritePixels
*write_pixels
;
301 PixelFormat client_pf
;
302 pixman_format_code_t client_format
;
305 CaptureVoiceOut
*audio_cap
;
306 struct audsettings as
;
308 VncReadEvent
*read_handler
;
309 size_t read_handler_expect
;
311 uint8_t modifiers_state
[256];
312 QEMUPutLEDEntry
*led
;
316 QemuMutex output_mutex
;
320 /* Encoding specific, if you add something here, don't forget to
321 * update vnc_async_encoding_start()
329 Notifier mouse_mode_notifier
;
331 QTAILQ_ENTRY(VncState
) next
;
335 /*****************************************************************************
337 * Authentication modes
339 *****************************************************************************/
342 VNC_AUTH_INVALID
= 0,
349 VNC_AUTH_TLS
= 18, /* Supported in GTK-VNC & VINO */
350 VNC_AUTH_VENCRYPT
= 19, /* Supported in GTK-VNC & VeNCrypt */
351 VNC_AUTH_SASL
= 20, /* Supported in GTK-VNC & VINO */
355 VNC_AUTH_VENCRYPT_PLAIN
= 256,
356 VNC_AUTH_VENCRYPT_TLSNONE
= 257,
357 VNC_AUTH_VENCRYPT_TLSVNC
= 258,
358 VNC_AUTH_VENCRYPT_TLSPLAIN
= 259,
359 VNC_AUTH_VENCRYPT_X509NONE
= 260,
360 VNC_AUTH_VENCRYPT_X509VNC
= 261,
361 VNC_AUTH_VENCRYPT_X509PLAIN
= 262,
362 VNC_AUTH_VENCRYPT_X509SASL
= 263,
363 VNC_AUTH_VENCRYPT_TLSSASL
= 264,
367 /*****************************************************************************
371 *****************************************************************************/
373 #define VNC_ENCODING_RAW 0x00000000
374 #define VNC_ENCODING_COPYRECT 0x00000001
375 #define VNC_ENCODING_RRE 0x00000002
376 #define VNC_ENCODING_CORRE 0x00000004
377 #define VNC_ENCODING_HEXTILE 0x00000005
378 #define VNC_ENCODING_ZLIB 0x00000006
379 #define VNC_ENCODING_TIGHT 0x00000007
380 #define VNC_ENCODING_ZLIBHEX 0x00000008
381 #define VNC_ENCODING_TRLE 0x0000000f
382 #define VNC_ENCODING_ZRLE 0x00000010
383 #define VNC_ENCODING_ZYWRLE 0x00000011
384 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
385 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
386 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
387 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
388 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
389 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
390 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
391 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
392 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
393 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
394 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
395 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
396 #define VNC_ENCODING_WMVi 0x574D5669
398 /*****************************************************************************
400 * Other tight constants
402 *****************************************************************************/
405 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
408 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
409 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
410 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
411 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
412 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
413 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
414 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
415 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
417 /*****************************************************************************
421 *****************************************************************************/
423 #define VNC_FEATURE_RESIZE 0
424 #define VNC_FEATURE_HEXTILE 1
425 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
426 #define VNC_FEATURE_WMVI 3
427 #define VNC_FEATURE_TIGHT 4
428 #define VNC_FEATURE_ZLIB 5
429 #define VNC_FEATURE_COPYRECT 6
430 #define VNC_FEATURE_RICH_CURSOR 7
431 #define VNC_FEATURE_TIGHT_PNG 8
432 #define VNC_FEATURE_ZRLE 9
433 #define VNC_FEATURE_ZYWRLE 10
434 #define VNC_FEATURE_LED_STATE 11
436 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
437 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
438 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
439 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
440 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
441 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
442 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
443 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
444 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
445 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
446 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
447 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
450 /* Client -> Server message IDs */
451 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
452 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
453 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
454 #define VNC_MSG_CLIENT_KEY_EVENT 4
455 #define VNC_MSG_CLIENT_POINTER_EVENT 5
456 #define VNC_MSG_CLIENT_CUT_TEXT 6
457 #define VNC_MSG_CLIENT_VMWARE_0 127
458 #define VNC_MSG_CLIENT_CALL_CONTROL 249
459 #define VNC_MSG_CLIENT_XVP 250
460 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
461 #define VNC_MSG_CLIENT_TIGHT 252
462 #define VNC_MSG_CLIENT_GII 253
463 #define VNC_MSG_CLIENT_VMWARE_1 254
464 #define VNC_MSG_CLIENT_QEMU 255
466 /* Server -> Client message IDs */
467 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
468 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
469 #define VNC_MSG_SERVER_BELL 2
470 #define VNC_MSG_SERVER_CUT_TEXT 3
471 #define VNC_MSG_SERVER_VMWARE_0 127
472 #define VNC_MSG_SERVER_CALL_CONTROL 249
473 #define VNC_MSG_SERVER_XVP 250
474 #define VNC_MSG_SERVER_TIGHT 252
475 #define VNC_MSG_SERVER_GII 253
476 #define VNC_MSG_SERVER_VMWARE_1 254
477 #define VNC_MSG_SERVER_QEMU 255
481 /* QEMU client -> server message IDs */
482 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
483 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
485 /* QEMU server -> client message IDs */
486 #define VNC_MSG_SERVER_QEMU_AUDIO 1
490 /* QEMU client -> server audio message IDs */
491 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
492 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
493 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
495 /* QEMU server -> client audio message IDs */
496 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
497 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
498 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
501 /*****************************************************************************
505 *****************************************************************************/
507 /* Event loop functions */
508 void vnc_client_read(void *opaque
);
509 void vnc_client_write(void *opaque
);
511 ssize_t
vnc_client_read_buf(VncState
*vs
, uint8_t *data
, size_t datalen
);
512 ssize_t
vnc_client_write_buf(VncState
*vs
, const uint8_t *data
, size_t datalen
);
513 ssize_t
vnc_tls_pull(char *buf
, size_t len
, void *opaque
);
514 ssize_t
vnc_tls_push(const char *buf
, size_t len
, void *opaque
);
516 /* Protocol I/O functions */
517 void vnc_write(VncState
*vs
, const void *data
, size_t len
);
518 void vnc_write_u32(VncState
*vs
, uint32_t value
);
519 void vnc_write_s32(VncState
*vs
, int32_t value
);
520 void vnc_write_u16(VncState
*vs
, uint16_t value
);
521 void vnc_write_u8(VncState
*vs
, uint8_t value
);
522 void vnc_flush(VncState
*vs
);
523 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
);
524 void vnc_disconnect_finish(VncState
*vs
);
525 void vnc_init_state(VncState
*vs
);
528 /* Buffer I/O functions */
529 uint32_t read_u32(uint8_t *data
, size_t offset
);
531 /* Protocol stage functions */
532 void vnc_client_error(VncState
*vs
);
533 ssize_t
vnc_client_io_error(VncState
*vs
, ssize_t ret
, int last_errno
);
535 void start_client_init(VncState
*vs
);
536 void start_auth_vnc(VncState
*vs
);
538 /* Buffer management */
539 void buffer_reserve(Buffer
*buffer
, size_t len
);
540 void buffer_reset(Buffer
*buffer
);
541 void buffer_free(Buffer
*buffer
);
542 void buffer_append(Buffer
*buffer
, const void *data
, size_t len
);
543 void buffer_advance(Buffer
*buf
, size_t len
);
544 uint8_t *buffer_end(Buffer
*buffer
);
549 char *vnc_socket_local_addr(const char *format
, int fd
);
550 char *vnc_socket_remote_addr(const char *format
, int fd
);
552 static inline uint32_t vnc_has_feature(VncState
*vs
, int feature
) {
553 return (vs
->features
& (1 << feature
));
557 void vnc_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
,
560 /* server fb is in PIXMAN_x8r8g8b8 */
561 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
562 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
563 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
565 void *vnc_server_fb_ptr(VncDisplay
*vd
, int x
, int y
);
566 int vnc_server_fb_stride(VncDisplay
*vd
);
568 void vnc_convert_pixel(VncState
*vs
, uint8_t *buf
, uint32_t v
);
569 double vnc_update_freq(VncState
*vs
, int x
, int y
, int w
, int h
);
570 void vnc_sent_lossy_rect(VncState
*vs
, int x
, int y
, int w
, int h
);
573 int vnc_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
575 int vnc_raw_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
577 int vnc_hextile_send_framebuffer_update(VncState
*vs
, int x
,
578 int y
, int w
, int h
);
579 void vnc_hextile_set_pixel_conversion(VncState
*vs
, int generic
);
581 void *vnc_zlib_zalloc(void *x
, unsigned items
, unsigned size
);
582 void vnc_zlib_zfree(void *x
, void *addr
);
583 int vnc_zlib_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
584 void vnc_zlib_clear(VncState
*vs
);
586 int vnc_tight_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
587 int vnc_tight_png_send_framebuffer_update(VncState
*vs
, int x
, int y
,
589 void vnc_tight_clear(VncState
*vs
);
591 int vnc_zrle_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
592 int vnc_zywrle_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
593 void vnc_zrle_clear(VncState
*vs
);
595 #endif /* __QEMU_VNC_H */