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"
40 #include "vnc-palette.h"
41 #include "vnc-enc-zrle.h"
42 #include "qapi-types.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_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
81 * by one bit in the dirty bitmap, should be a power of 2 */
82 #define VNC_DIRTY_PIXELS_PER_BIT 16
84 /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
86 #define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
87 #define VNC_MAX_HEIGHT 2048
89 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
90 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
92 /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
93 * VNC_DIRTY_BITS due to alignment */
94 #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
96 #define VNC_STAT_RECT 64
97 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
98 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
100 #define VNC_AUTH_CHALLENGE_SIZE 16
102 typedef struct VncDisplay VncDisplay
;
104 #ifdef CONFIG_VNC_TLS
106 #include "vnc-auth-vencrypt.h"
108 #ifdef CONFIG_VNC_SASL
109 #include "vnc-auth-sasl.h"
117 /* time of last 10 updates, to find update frequency */
118 struct timeval times
[10];
121 double freq
; /* Update frequency (in Hz) */
122 bool updated
; /* Already updated during this refresh */
125 typedef struct VncRectStat VncRectStat
;
129 struct timeval last_freq_check
;
130 DECLARE_BITMAP(dirty
[VNC_MAX_HEIGHT
],
131 VNC_MAX_WIDTH
/ VNC_DIRTY_PIXELS_PER_BIT
);
132 VncRectStat stats
[VNC_STAT_ROWS
][VNC_STAT_COLS
];
134 pixman_format_code_t format
;
137 typedef enum VncShareMode
{
138 VNC_SHARE_MODE_CONNECTING
= 1,
139 VNC_SHARE_MODE_SHARED
,
140 VNC_SHARE_MODE_EXCLUSIVE
,
141 VNC_SHARE_MODE_DISCONNECTED
,
144 typedef enum VncSharePolicy
{
145 VNC_SHARE_POLICY_IGNORE
= 1,
146 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE
,
147 VNC_SHARE_POLICY_FORCE_SHARED
,
152 QTAILQ_HEAD(, VncState
) clients
;
154 VncSharePolicy share_policy
;
162 DisplayChangeListener dcl
;
163 kbd_layout_t
*kbd_layout
;
169 uint8_t *cursor_mask
;
171 struct VncSurface guest
; /* guest visible surface (aka ds->surface) */
172 pixman_image_t
*server
; /* vnc server surface */
180 #ifdef CONFIG_VNC_TLS
181 int subauth
; /* Used by VeNCrypt */
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 */
273 VncShareMode share_mode
;
275 uint32_t vnc_encoding
;
281 char challenge
[VNC_AUTH_CHALLENGE_SIZE
];
282 #ifdef CONFIG_VNC_TLS
283 int subauth
; /* Used by VeNCrypt */
286 #ifdef CONFIG_VNC_SASL
290 #ifdef CONFIG_VNC_TLS
292 #endif /* CONFIG_VNC_TLS */
295 #endif /* CONFIG_VNC_WS */
305 /* current output mode information */
306 VncWritePixels
*write_pixels
;
307 PixelFormat client_pf
;
308 pixman_format_code_t client_format
;
311 CaptureVoiceOut
*audio_cap
;
312 struct audsettings as
;
314 VncReadEvent
*read_handler
;
315 size_t read_handler_expect
;
317 uint8_t modifiers_state
[256];
318 QEMUPutLEDEntry
*led
;
322 QemuMutex output_mutex
;
326 /* Encoding specific, if you add something here, don't forget to
327 * update vnc_async_encoding_start()
335 Notifier mouse_mode_notifier
;
337 QTAILQ_ENTRY(VncState
) next
;
341 /*****************************************************************************
343 * Authentication modes
345 *****************************************************************************/
348 VNC_AUTH_INVALID
= 0,
355 VNC_AUTH_TLS
= 18, /* Supported in GTK-VNC & VINO */
356 VNC_AUTH_VENCRYPT
= 19, /* Supported in GTK-VNC & VeNCrypt */
357 VNC_AUTH_SASL
= 20, /* Supported in GTK-VNC & VINO */
361 VNC_AUTH_VENCRYPT_PLAIN
= 256,
362 VNC_AUTH_VENCRYPT_TLSNONE
= 257,
363 VNC_AUTH_VENCRYPT_TLSVNC
= 258,
364 VNC_AUTH_VENCRYPT_TLSPLAIN
= 259,
365 VNC_AUTH_VENCRYPT_X509NONE
= 260,
366 VNC_AUTH_VENCRYPT_X509VNC
= 261,
367 VNC_AUTH_VENCRYPT_X509PLAIN
= 262,
368 VNC_AUTH_VENCRYPT_X509SASL
= 263,
369 VNC_AUTH_VENCRYPT_TLSSASL
= 264,
373 /*****************************************************************************
377 *****************************************************************************/
379 #define VNC_ENCODING_RAW 0x00000000
380 #define VNC_ENCODING_COPYRECT 0x00000001
381 #define VNC_ENCODING_RRE 0x00000002
382 #define VNC_ENCODING_CORRE 0x00000004
383 #define VNC_ENCODING_HEXTILE 0x00000005
384 #define VNC_ENCODING_ZLIB 0x00000006
385 #define VNC_ENCODING_TIGHT 0x00000007
386 #define VNC_ENCODING_ZLIBHEX 0x00000008
387 #define VNC_ENCODING_TRLE 0x0000000f
388 #define VNC_ENCODING_ZRLE 0x00000010
389 #define VNC_ENCODING_ZYWRLE 0x00000011
390 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
391 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
392 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
393 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
394 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
395 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
396 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
397 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
398 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
399 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
400 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
401 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
402 #define VNC_ENCODING_WMVi 0x574D5669
404 /*****************************************************************************
406 * Other tight constants
408 *****************************************************************************/
411 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
414 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
415 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
416 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
417 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
418 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
419 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
420 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
421 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
423 /*****************************************************************************
427 *****************************************************************************/
429 #define VNC_FEATURE_RESIZE 0
430 #define VNC_FEATURE_HEXTILE 1
431 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
432 #define VNC_FEATURE_WMVI 3
433 #define VNC_FEATURE_TIGHT 4
434 #define VNC_FEATURE_ZLIB 5
435 #define VNC_FEATURE_COPYRECT 6
436 #define VNC_FEATURE_RICH_CURSOR 7
437 #define VNC_FEATURE_TIGHT_PNG 8
438 #define VNC_FEATURE_ZRLE 9
439 #define VNC_FEATURE_ZYWRLE 10
440 #define VNC_FEATURE_LED_STATE 11
442 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
443 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
444 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
445 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
446 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
447 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
448 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
449 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
450 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
451 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
452 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
453 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
456 /* Client -> Server message IDs */
457 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
458 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
459 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
460 #define VNC_MSG_CLIENT_KEY_EVENT 4
461 #define VNC_MSG_CLIENT_POINTER_EVENT 5
462 #define VNC_MSG_CLIENT_CUT_TEXT 6
463 #define VNC_MSG_CLIENT_VMWARE_0 127
464 #define VNC_MSG_CLIENT_CALL_CONTROL 249
465 #define VNC_MSG_CLIENT_XVP 250
466 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
467 #define VNC_MSG_CLIENT_TIGHT 252
468 #define VNC_MSG_CLIENT_GII 253
469 #define VNC_MSG_CLIENT_VMWARE_1 254
470 #define VNC_MSG_CLIENT_QEMU 255
472 /* Server -> Client message IDs */
473 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
474 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
475 #define VNC_MSG_SERVER_BELL 2
476 #define VNC_MSG_SERVER_CUT_TEXT 3
477 #define VNC_MSG_SERVER_VMWARE_0 127
478 #define VNC_MSG_SERVER_CALL_CONTROL 249
479 #define VNC_MSG_SERVER_XVP 250
480 #define VNC_MSG_SERVER_TIGHT 252
481 #define VNC_MSG_SERVER_GII 253
482 #define VNC_MSG_SERVER_VMWARE_1 254
483 #define VNC_MSG_SERVER_QEMU 255
487 /* QEMU client -> server message IDs */
488 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
489 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
491 /* QEMU server -> client message IDs */
492 #define VNC_MSG_SERVER_QEMU_AUDIO 1
496 /* QEMU client -> server audio message IDs */
497 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
498 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
499 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
501 /* QEMU server -> client audio message IDs */
502 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
503 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
504 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
507 /*****************************************************************************
511 *****************************************************************************/
513 /* Event loop functions */
514 void vnc_client_read(void *opaque
);
515 void vnc_client_write(void *opaque
);
517 long vnc_client_read_buf(VncState
*vs
, uint8_t *data
, size_t datalen
);
518 long vnc_client_write_buf(VncState
*vs
, const uint8_t *data
, size_t datalen
);
520 /* Protocol I/O functions */
521 void vnc_write(VncState
*vs
, const void *data
, size_t len
);
522 void vnc_write_u32(VncState
*vs
, uint32_t value
);
523 void vnc_write_s32(VncState
*vs
, int32_t value
);
524 void vnc_write_u16(VncState
*vs
, uint16_t value
);
525 void vnc_write_u8(VncState
*vs
, uint8_t value
);
526 void vnc_flush(VncState
*vs
);
527 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
);
528 void vnc_disconnect_finish(VncState
*vs
);
529 void vnc_init_state(VncState
*vs
);
532 /* Buffer I/O functions */
533 uint32_t read_u32(uint8_t *data
, size_t offset
);
535 /* Protocol stage functions */
536 void vnc_client_error(VncState
*vs
);
537 int vnc_client_io_error(VncState
*vs
, int ret
, int last_errno
);
539 void start_client_init(VncState
*vs
);
540 void start_auth_vnc(VncState
*vs
);
542 /* Buffer management */
543 void buffer_reserve(Buffer
*buffer
, size_t len
);
544 void buffer_reset(Buffer
*buffer
);
545 void buffer_free(Buffer
*buffer
);
546 void buffer_append(Buffer
*buffer
, const void *data
, size_t len
);
547 void buffer_advance(Buffer
*buf
, size_t len
);
548 uint8_t *buffer_end(Buffer
*buffer
);
553 char *vnc_socket_local_addr(const char *format
, int fd
);
554 char *vnc_socket_remote_addr(const char *format
, int fd
);
556 static inline uint32_t vnc_has_feature(VncState
*vs
, int feature
) {
557 return (vs
->features
& (1 << feature
));
561 void vnc_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
,
564 /* server fb is in PIXMAN_x8r8g8b8 */
565 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
566 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
567 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
569 void *vnc_server_fb_ptr(VncDisplay
*vd
, int x
, int y
);
570 int vnc_server_fb_stride(VncDisplay
*vd
);
572 void vnc_convert_pixel(VncState
*vs
, uint8_t *buf
, uint32_t v
);
573 double vnc_update_freq(VncState
*vs
, int x
, int y
, int w
, int h
);
574 void vnc_sent_lossy_rect(VncState
*vs
, int x
, int y
, int w
, int h
);
577 int vnc_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
579 int vnc_raw_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
581 int vnc_hextile_send_framebuffer_update(VncState
*vs
, int x
,
582 int y
, int w
, int h
);
583 void vnc_hextile_set_pixel_conversion(VncState
*vs
, int generic
);
585 void *vnc_zlib_zalloc(void *x
, unsigned items
, unsigned size
);
586 void vnc_zlib_zfree(void *x
, void *addr
);
587 int vnc_zlib_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
588 void vnc_zlib_clear(VncState
*vs
);
590 int vnc_tight_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
591 int vnc_tight_png_send_framebuffer_update(VncState
*vs
, int x
, int y
,
593 void vnc_tight_clear(VncState
*vs
);
595 int vnc_zrle_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
596 int vnc_zywrle_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
597 void vnc_zrle_clear(VncState
*vs
);
599 #endif /* __QEMU_VNC_H */