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/queue.h"
31 #include "qemu/thread.h"
32 #include "ui/console.h"
33 #include "audio/audio.h"
34 #include "qemu/bitmap.h"
35 #include "crypto/tlssession.h"
36 #include "qemu/buffer.h"
37 #include "io/channel-socket.h"
38 #include "io/channel-tls.h"
39 #include "io/net-listener.h"
40 #include "authz/base.h"
44 #include "vnc-palette.h"
45 #include "vnc-enc-zrle.h"
46 #include "ui/kbd-state.h"
48 // #define _VNC_DEBUG 1
51 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
53 #define VNC_DEBUG(fmt, ...) do { } while (0)
56 /*****************************************************************************
58 * Core data structures
60 *****************************************************************************/
62 typedef struct VncState VncState
;
63 typedef struct VncJob VncJob
;
64 typedef struct VncRect VncRect
;
65 typedef struct VncRectEntry VncRectEntry
;
67 typedef int VncReadEvent(VncState
*vs
, uint8_t *data
, size_t len
);
69 typedef void VncWritePixels(VncState
*vs
, void *data
, int size
);
71 typedef void VncSendHextileTile(VncState
*vs
,
72 int x
, int y
, int w
, int h
,
75 int *has_bg
, int *has_fg
);
77 /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
78 * by one bit in the dirty bitmap, should be a power of 2 */
79 #define VNC_DIRTY_PIXELS_PER_BIT 16
81 /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
83 #define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
84 #define VNC_MAX_HEIGHT 2048
86 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
87 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
89 /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
90 * VNC_DIRTY_BITS due to alignment */
91 #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
93 #define VNC_STAT_RECT 64
94 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
95 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
97 #define VNC_AUTH_CHALLENGE_SIZE 16
99 typedef struct VncDisplay VncDisplay
;
101 #include "vnc-auth-vencrypt.h"
102 #ifdef CONFIG_VNC_SASL
103 #include "vnc-auth-sasl.h"
109 /* time of last 10 updates, to find update frequency */
110 struct timeval times
[10];
113 double freq
; /* Update frequency (in Hz) */
114 bool updated
; /* Already updated during this refresh */
117 typedef struct VncRectStat VncRectStat
;
121 struct timeval last_freq_check
;
122 DECLARE_BITMAP(dirty
[VNC_MAX_HEIGHT
],
123 VNC_MAX_WIDTH
/ VNC_DIRTY_PIXELS_PER_BIT
);
124 VncRectStat stats
[VNC_STAT_ROWS
][VNC_STAT_COLS
];
126 pixman_format_code_t format
;
129 typedef enum VncShareMode
{
130 VNC_SHARE_MODE_CONNECTING
= 1,
131 VNC_SHARE_MODE_SHARED
,
132 VNC_SHARE_MODE_EXCLUSIVE
,
133 VNC_SHARE_MODE_DISCONNECTED
,
136 typedef enum VncSharePolicy
{
137 VNC_SHARE_POLICY_IGNORE
= 1,
138 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE
,
139 VNC_SHARE_POLICY_FORCE_SHARED
,
144 QTAILQ_HEAD(, VncState
) clients
;
148 int connections_limit
;
149 VncSharePolicy share_policy
;
150 QIONetListener
*listener
;
151 QIONetListener
*wslistener
;
153 DisplayChangeListener dcl
;
154 kbd_layout_t
*kbd_layout
;
156 QEMUPutLEDEntry
*led
;
163 uint8_t *cursor_mask
;
165 struct VncSurface guest
; /* guest visible surface (aka ds->surface) */
166 pixman_image_t
*server
; /* vnc server surface */
169 QTAILQ_ENTRY(VncDisplay
) next
;
174 int subauth
; /* Used by VeNCrypt */
175 int ws_auth
; /* Used by websockets */
176 int ws_subauth
; /* Used by websockets */
179 QCryptoTLSCreds
*tlscreds
;
182 #ifdef CONFIG_VNC_SASL
187 typedef struct VncTight
{
196 #ifdef CONFIG_VNC_JPEG
199 #ifdef CONFIG_VNC_PNG
206 typedef struct VncHextile
{
207 VncSendHextileTile
*send_tile
;
210 typedef struct VncZlib
{
217 typedef struct VncZrle
{
227 typedef struct VncZywrle
{
228 int buf
[VNC_ZRLE_TILE_WIDTH
* VNC_ZRLE_TILE_HEIGHT
];
242 QLIST_ENTRY(VncRectEntry
) next
;
249 QLIST_HEAD(, VncRectEntry
) rectangles
;
250 QTAILQ_ENTRY(VncJob
) next
;
254 VNC_STATE_UPDATE_NONE
,
255 VNC_STATE_UPDATE_INCREMENTAL
,
256 VNC_STATE_UPDATE_FORCE
,
259 #define VNC_MAGIC ((uint64_t)0x05b3f069b3d204bb)
264 QIOChannelSocket
*sioc
; /* The underlying socket */
265 QIOChannel
*ioc
; /* The channel currently used for I/O */
267 gboolean disconnecting
;
269 DECLARE_BITMAP(dirty
[VNC_MAX_HEIGHT
], VNC_DIRTY_BITS
);
270 uint8_t **lossy_rect
; /* Not an Array to avoid costly memcpy in
271 * vnc-jobs-async.c */
274 VncStateUpdate update
; /* Most recent pending request from client */
275 VncStateUpdate job_update
; /* Currently processed by job thread */
282 size_t client_width
; /* limited to u16 by RFB proto */
283 size_t client_height
; /* limited to u16 by RFB proto */
284 VncShareMode share_mode
;
286 uint32_t vnc_encoding
;
292 int subauth
; /* Used by VeNCrypt */
293 char challenge
[VNC_AUTH_CHALLENGE_SIZE
];
294 QCryptoTLSSession
*tls
; /* Borrowed pointer from channel, don't free */
295 #ifdef CONFIG_VNC_SASL
305 /* Job thread bottom half has put data for a forced update
306 * into the output buffer. This offset points to the end of
307 * the update data in the output buffer. This lets us determine
308 * when a force update is fully sent to the client, allowing
309 * us to process further forced updates. */
310 size_t force_update_offset
;
311 /* We allow multiple incremental updates or audio capture
312 * samples to be queued in output buffer, provided the
313 * buffer size doesn't exceed this threshold. The value
314 * is calculating dynamically based on framebuffer size
315 * and audio sample settings in vnc_update_throttle_offset() */
316 size_t throttle_output_offset
;
319 /* current output mode information */
320 VncWritePixels
*write_pixels
;
321 PixelFormat client_pf
;
322 pixman_format_code_t client_format
;
325 CaptureVoiceOut
*audio_cap
;
326 struct audsettings as
;
328 VncReadEvent
*read_handler
;
329 size_t read_handler_expect
;
332 QemuMutex output_mutex
;
336 /* Encoding specific, if you add something here, don't forget to
337 * update vnc_async_encoding_start()
345 Notifier mouse_mode_notifier
;
347 QTAILQ_ENTRY(VncState
) next
;
351 /*****************************************************************************
353 * Authentication modes
355 *****************************************************************************/
358 VNC_AUTH_INVALID
= 0,
365 VNC_AUTH_TLS
= 18, /* Supported in GTK-VNC & VINO */
366 VNC_AUTH_VENCRYPT
= 19, /* Supported in GTK-VNC & VeNCrypt */
367 VNC_AUTH_SASL
= 20, /* Supported in GTK-VNC & VINO */
371 VNC_AUTH_VENCRYPT_PLAIN
= 256,
372 VNC_AUTH_VENCRYPT_TLSNONE
= 257,
373 VNC_AUTH_VENCRYPT_TLSVNC
= 258,
374 VNC_AUTH_VENCRYPT_TLSPLAIN
= 259,
375 VNC_AUTH_VENCRYPT_X509NONE
= 260,
376 VNC_AUTH_VENCRYPT_X509VNC
= 261,
377 VNC_AUTH_VENCRYPT_X509PLAIN
= 262,
378 VNC_AUTH_VENCRYPT_X509SASL
= 263,
379 VNC_AUTH_VENCRYPT_TLSSASL
= 264,
383 /*****************************************************************************
387 *****************************************************************************/
389 #define VNC_ENCODING_RAW 0x00000000
390 #define VNC_ENCODING_COPYRECT 0x00000001
391 #define VNC_ENCODING_RRE 0x00000002
392 #define VNC_ENCODING_CORRE 0x00000004
393 #define VNC_ENCODING_HEXTILE 0x00000005
394 #define VNC_ENCODING_ZLIB 0x00000006
395 #define VNC_ENCODING_TIGHT 0x00000007
396 #define VNC_ENCODING_ZLIBHEX 0x00000008
397 #define VNC_ENCODING_TRLE 0x0000000f
398 #define VNC_ENCODING_ZRLE 0x00000010
399 #define VNC_ENCODING_ZYWRLE 0x00000011
400 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
401 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
402 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
403 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
404 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
405 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
406 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
407 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
408 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
409 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
410 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
411 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
412 #define VNC_ENCODING_WMVi 0x574D5669
414 /*****************************************************************************
416 * Other tight constants
418 *****************************************************************************/
421 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
424 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
425 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
426 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
427 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
428 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
429 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
430 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
431 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
433 /*****************************************************************************
437 *****************************************************************************/
439 #define VNC_FEATURE_RESIZE 0
440 #define VNC_FEATURE_HEXTILE 1
441 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
442 #define VNC_FEATURE_WMVI 3
443 #define VNC_FEATURE_TIGHT 4
444 #define VNC_FEATURE_ZLIB 5
445 #define VNC_FEATURE_COPYRECT 6
446 #define VNC_FEATURE_RICH_CURSOR 7
447 #define VNC_FEATURE_TIGHT_PNG 8
448 #define VNC_FEATURE_ZRLE 9
449 #define VNC_FEATURE_ZYWRLE 10
450 #define VNC_FEATURE_LED_STATE 11
452 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
453 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
454 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
455 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
456 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
457 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
458 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
459 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
460 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
461 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
462 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
463 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
466 /* Client -> Server message IDs */
467 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
468 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
469 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
470 #define VNC_MSG_CLIENT_KEY_EVENT 4
471 #define VNC_MSG_CLIENT_POINTER_EVENT 5
472 #define VNC_MSG_CLIENT_CUT_TEXT 6
473 #define VNC_MSG_CLIENT_VMWARE_0 127
474 #define VNC_MSG_CLIENT_CALL_CONTROL 249
475 #define VNC_MSG_CLIENT_XVP 250
476 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
477 #define VNC_MSG_CLIENT_TIGHT 252
478 #define VNC_MSG_CLIENT_GII 253
479 #define VNC_MSG_CLIENT_VMWARE_1 254
480 #define VNC_MSG_CLIENT_QEMU 255
482 /* Server -> Client message IDs */
483 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
484 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
485 #define VNC_MSG_SERVER_BELL 2
486 #define VNC_MSG_SERVER_CUT_TEXT 3
487 #define VNC_MSG_SERVER_VMWARE_0 127
488 #define VNC_MSG_SERVER_CALL_CONTROL 249
489 #define VNC_MSG_SERVER_XVP 250
490 #define VNC_MSG_SERVER_TIGHT 252
491 #define VNC_MSG_SERVER_GII 253
492 #define VNC_MSG_SERVER_VMWARE_1 254
493 #define VNC_MSG_SERVER_QEMU 255
497 /* QEMU client -> server message IDs */
498 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
499 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
501 /* QEMU server -> client message IDs */
502 #define VNC_MSG_SERVER_QEMU_AUDIO 1
506 /* QEMU client -> server audio message IDs */
507 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
508 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
509 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
511 /* QEMU server -> client audio message IDs */
512 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
513 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
514 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
517 /*****************************************************************************
521 *****************************************************************************/
523 /* Event loop functions */
524 gboolean
vnc_client_io(QIOChannel
*ioc
,
525 GIOCondition condition
,
528 size_t vnc_client_read_buf(VncState
*vs
, uint8_t *data
, size_t datalen
);
529 size_t vnc_client_write_buf(VncState
*vs
, const uint8_t *data
, size_t datalen
);
531 /* Protocol I/O functions */
532 void vnc_write(VncState
*vs
, const void *data
, size_t len
);
533 void vnc_write_u32(VncState
*vs
, uint32_t value
);
534 void vnc_write_s32(VncState
*vs
, int32_t value
);
535 void vnc_write_u16(VncState
*vs
, uint16_t value
);
536 void vnc_write_u8(VncState
*vs
, uint8_t value
);
537 void vnc_flush(VncState
*vs
);
538 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
);
539 void vnc_disconnect_finish(VncState
*vs
);
540 void vnc_start_protocol(VncState
*vs
);
543 /* Buffer I/O functions */
544 uint32_t read_u32(uint8_t *data
, size_t offset
);
546 /* Protocol stage functions */
547 void vnc_client_error(VncState
*vs
);
548 size_t vnc_client_io_error(VncState
*vs
, ssize_t ret
, Error
**errp
);
550 void start_client_init(VncState
*vs
);
551 void start_auth_vnc(VncState
*vs
);
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 */