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"
37 #include "qemu/buffer.h"
38 #include "io/channel-socket.h"
39 #include "io/channel-tls.h"
43 #include "vnc-palette.h"
44 #include "vnc-enc-zrle.h"
45 #include "qapi-types.h"
47 // #define _VNC_DEBUG 1
50 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
52 #define VNC_DEBUG(fmt, ...) do { } while (0)
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
,
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"
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_DIRTY_BITS
);
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
;
146 int connections_limit
;
147 VncSharePolicy share_policy
;
149 QIOChannelSocket
**lsock
;
152 QIOChannelSocket
**lwebsock
;
155 DisplayChangeListener dcl
;
156 kbd_layout_t
*kbd_layout
;
158 QEMUPutLEDEntry
*led
;
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
;
176 int subauth
; /* Used by VeNCrypt */
177 int ws_auth
; /* Used by websockets */
178 int ws_subauth
; /* Used by websockets */
181 QCryptoTLSCreds
*tlscreds
;
183 #ifdef CONFIG_VNC_SASL
188 typedef struct VncTight
{
197 #ifdef CONFIG_VNC_JPEG
200 #ifdef CONFIG_VNC_PNG
207 typedef struct VncHextile
{
208 VncSendHextileTile
*send_tile
;
211 typedef struct VncZlib
{
218 typedef struct VncZrle
{
228 typedef struct VncZywrle
{
229 int buf
[VNC_ZRLE_TILE_WIDTH
* VNC_ZRLE_TILE_HEIGHT
];
243 QLIST_ENTRY(VncRectEntry
) next
;
250 QLIST_HEAD(, VncRectEntry
) rectangles
;
251 QTAILQ_ENTRY(VncJob
) next
;
255 VNC_STATE_UPDATE_NONE
,
256 VNC_STATE_UPDATE_INCREMENTAL
,
257 VNC_STATE_UPDATE_FORCE
,
262 QIOChannelSocket
*sioc
; /* The underlying socket */
263 QIOChannel
*ioc
; /* The channel currently used for I/O */
265 gboolean disconnecting
;
267 DECLARE_BITMAP(dirty
[VNC_MAX_HEIGHT
], VNC_DIRTY_BITS
);
268 uint8_t **lossy_rect
; /* Not an Array to avoid costly memcpy in
269 * vnc-jobs-async.c */
272 VncStateUpdate update
; /* Most recent pending request from client */
273 VncStateUpdate job_update
; /* Currently processed by job thread */
282 VncShareMode share_mode
;
284 uint32_t vnc_encoding
;
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
301 /* Job thread bottom half has put data for a forced update
302 * into the output buffer. This offset points to the end of
303 * the update data in the output buffer. This lets us determine
304 * when a force update is fully sent to the client, allowing
305 * us to process further forced updates. */
306 size_t force_update_offset
;
307 /* We allow multiple incremental updates or audio capture
308 * samples to be queued in output buffer, provided the
309 * buffer size doesn't exceed this threshold. The value
310 * is calculating dynamically based on framebuffer size
311 * and audio sample settings in vnc_update_throttle_offset() */
312 size_t throttle_output_offset
;
315 /* current output mode information */
316 VncWritePixels
*write_pixels
;
317 PixelFormat client_pf
;
318 pixman_format_code_t client_format
;
321 CaptureVoiceOut
*audio_cap
;
322 struct audsettings as
;
324 VncReadEvent
*read_handler
;
325 size_t read_handler_expect
;
327 uint8_t modifiers_state
[256];
330 QemuMutex output_mutex
;
334 /* Encoding specific, if you add something here, don't forget to
335 * update vnc_async_encoding_start()
343 Notifier mouse_mode_notifier
;
345 QTAILQ_ENTRY(VncState
) next
;
349 /*****************************************************************************
351 * Authentication modes
353 *****************************************************************************/
356 VNC_AUTH_INVALID
= 0,
363 VNC_AUTH_TLS
= 18, /* Supported in GTK-VNC & VINO */
364 VNC_AUTH_VENCRYPT
= 19, /* Supported in GTK-VNC & VeNCrypt */
365 VNC_AUTH_SASL
= 20, /* Supported in GTK-VNC & VINO */
369 VNC_AUTH_VENCRYPT_PLAIN
= 256,
370 VNC_AUTH_VENCRYPT_TLSNONE
= 257,
371 VNC_AUTH_VENCRYPT_TLSVNC
= 258,
372 VNC_AUTH_VENCRYPT_TLSPLAIN
= 259,
373 VNC_AUTH_VENCRYPT_X509NONE
= 260,
374 VNC_AUTH_VENCRYPT_X509VNC
= 261,
375 VNC_AUTH_VENCRYPT_X509PLAIN
= 262,
376 VNC_AUTH_VENCRYPT_X509SASL
= 263,
377 VNC_AUTH_VENCRYPT_TLSSASL
= 264,
381 /*****************************************************************************
385 *****************************************************************************/
387 #define VNC_ENCODING_RAW 0x00000000
388 #define VNC_ENCODING_COPYRECT 0x00000001
389 #define VNC_ENCODING_RRE 0x00000002
390 #define VNC_ENCODING_CORRE 0x00000004
391 #define VNC_ENCODING_HEXTILE 0x00000005
392 #define VNC_ENCODING_ZLIB 0x00000006
393 #define VNC_ENCODING_TIGHT 0x00000007
394 #define VNC_ENCODING_ZLIBHEX 0x00000008
395 #define VNC_ENCODING_TRLE 0x0000000f
396 #define VNC_ENCODING_ZRLE 0x00000010
397 #define VNC_ENCODING_ZYWRLE 0x00000011
398 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
399 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
400 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
401 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
402 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
403 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
404 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
405 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
406 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
407 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
408 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
409 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
410 #define VNC_ENCODING_WMVi 0x574D5669
412 /*****************************************************************************
414 * Other tight constants
416 *****************************************************************************/
419 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
422 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
423 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
424 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
425 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
426 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
427 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
428 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
429 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
431 /*****************************************************************************
435 *****************************************************************************/
437 #define VNC_FEATURE_RESIZE 0
438 #define VNC_FEATURE_HEXTILE 1
439 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
440 #define VNC_FEATURE_WMVI 3
441 #define VNC_FEATURE_TIGHT 4
442 #define VNC_FEATURE_ZLIB 5
443 #define VNC_FEATURE_COPYRECT 6
444 #define VNC_FEATURE_RICH_CURSOR 7
445 #define VNC_FEATURE_TIGHT_PNG 8
446 #define VNC_FEATURE_ZRLE 9
447 #define VNC_FEATURE_ZYWRLE 10
448 #define VNC_FEATURE_LED_STATE 11
450 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
451 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
452 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
453 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
454 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
455 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
456 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
457 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
458 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
459 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
460 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
461 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
464 /* Client -> Server message IDs */
465 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
466 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
467 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
468 #define VNC_MSG_CLIENT_KEY_EVENT 4
469 #define VNC_MSG_CLIENT_POINTER_EVENT 5
470 #define VNC_MSG_CLIENT_CUT_TEXT 6
471 #define VNC_MSG_CLIENT_VMWARE_0 127
472 #define VNC_MSG_CLIENT_CALL_CONTROL 249
473 #define VNC_MSG_CLIENT_XVP 250
474 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
475 #define VNC_MSG_CLIENT_TIGHT 252
476 #define VNC_MSG_CLIENT_GII 253
477 #define VNC_MSG_CLIENT_VMWARE_1 254
478 #define VNC_MSG_CLIENT_QEMU 255
480 /* Server -> Client message IDs */
481 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
482 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
483 #define VNC_MSG_SERVER_BELL 2
484 #define VNC_MSG_SERVER_CUT_TEXT 3
485 #define VNC_MSG_SERVER_VMWARE_0 127
486 #define VNC_MSG_SERVER_CALL_CONTROL 249
487 #define VNC_MSG_SERVER_XVP 250
488 #define VNC_MSG_SERVER_TIGHT 252
489 #define VNC_MSG_SERVER_GII 253
490 #define VNC_MSG_SERVER_VMWARE_1 254
491 #define VNC_MSG_SERVER_QEMU 255
495 /* QEMU client -> server message IDs */
496 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
497 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
499 /* QEMU server -> client message IDs */
500 #define VNC_MSG_SERVER_QEMU_AUDIO 1
504 /* QEMU client -> server audio message IDs */
505 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
506 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
507 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
509 /* QEMU server -> client audio message IDs */
510 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
511 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
512 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
515 /*****************************************************************************
519 *****************************************************************************/
521 /* Event loop functions */
522 gboolean
vnc_client_io(QIOChannel
*ioc
,
523 GIOCondition condition
,
526 size_t vnc_client_read_buf(VncState
*vs
, void *data
, size_t datalen
);
527 size_t vnc_client_write_buf(VncState
*vs
, const void *data
, size_t datalen
);
529 /* Protocol I/O functions */
530 void vnc_write(VncState
*vs
, const void *data
, size_t len
);
531 void vnc_write_u32(VncState
*vs
, uint32_t value
);
532 void vnc_write_s32(VncState
*vs
, int32_t value
);
533 void vnc_write_u16(VncState
*vs
, uint16_t value
);
534 void vnc_write_u8(VncState
*vs
, uint8_t value
);
535 void vnc_flush(VncState
*vs
);
536 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
);
537 void vnc_disconnect_finish(VncState
*vs
);
538 void vnc_start_protocol(VncState
*vs
);
541 /* Buffer I/O functions */
542 uint32_t read_u32(uint8_t *data
, size_t offset
);
544 /* Protocol stage functions */
545 void vnc_client_error(VncState
*vs
);
546 size_t vnc_client_io_error(VncState
*vs
, ssize_t ret
, Error
**errp
);
548 void start_client_init(VncState
*vs
);
549 void start_auth_vnc(VncState
*vs
);
554 static inline uint32_t vnc_has_feature(VncState
*vs
, int feature
) {
555 return (vs
->features
& (1 << feature
));
559 void vnc_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
,
562 /* server fb is in PIXMAN_x8r8g8b8 */
563 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
564 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
565 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
567 void *vnc_server_fb_ptr(VncDisplay
*vd
, int x
, int y
);
568 int vnc_server_fb_stride(VncDisplay
*vd
);
570 void vnc_convert_pixel(VncState
*vs
, uint8_t *buf
, uint32_t v
);
571 double vnc_update_freq(VncState
*vs
, int x
, int y
, int w
, int h
);
572 void vnc_sent_lossy_rect(VncState
*vs
, int x
, int y
, int w
, int h
);
575 int vnc_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
577 int vnc_raw_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
579 int vnc_hextile_send_framebuffer_update(VncState
*vs
, int x
,
580 int y
, int w
, int h
);
581 void vnc_hextile_set_pixel_conversion(VncState
*vs
, int generic
);
583 void *vnc_zlib_zalloc(void *x
, unsigned items
, unsigned size
);
584 void vnc_zlib_zfree(void *x
, void *addr
);
585 int vnc_zlib_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
586 void vnc_zlib_clear(VncState
*vs
);
588 int vnc_tight_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
589 int vnc_tight_png_send_framebuffer_update(VncState
*vs
, int x
, int y
,
591 void vnc_tight_clear(VncState
*vs
);
593 int vnc_zrle_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
594 int vnc_zywrle_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
595 void vnc_zrle_clear(VncState
*vs
);
597 #endif /* QEMU_VNC_H */