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"
34 #include "audio/audio.h"
39 // #define _VNC_DEBUG 1
42 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
44 #define VNC_DEBUG(fmt, ...) do { } while (0)
47 /*****************************************************************************
49 * Core data structures
51 *****************************************************************************/
60 typedef struct VncState VncState
;
62 typedef int VncReadEvent(VncState
*vs
, uint8_t *data
, size_t len
);
64 typedef void VncWritePixels(VncState
*vs
, struct PixelFormat
*pf
, void *data
, int size
);
66 typedef void VncSendHextileTile(VncState
*vs
,
67 int x
, int y
, int w
, int h
,
70 int *has_bg
, int *has_fg
);
72 #define VNC_MAX_WIDTH 2560
73 #define VNC_MAX_HEIGHT 2048
74 #define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
76 #define VNC_AUTH_CHALLENGE_SIZE 16
78 typedef struct VncDisplay VncDisplay
;
82 #include "vnc-auth-vencrypt.h"
84 #ifdef CONFIG_VNC_SASL
85 #include "vnc-auth-sasl.h"
90 uint32_t dirty
[VNC_MAX_HEIGHT
][VNC_DIRTY_WORDS
];
96 QTAILQ_HEAD(, VncState
) clients
;
101 kbd_layout_t
*kbd_layout
;
106 uint8_t *cursor_mask
;
108 struct VncSurface guest
; /* guest visible surface (aka ds->surface) */
109 DisplaySurface
*server
; /* vnc server surface */
114 #ifdef CONFIG_VNC_TLS
115 int subauth
; /* Used by VeNCrypt */
118 #ifdef CONFIG_VNC_SASL
128 uint32_t dirty
[VNC_MAX_HEIGHT
][VNC_DIRTY_WORDS
];
138 uint32_t vnc_encoding
;
143 char challenge
[VNC_AUTH_CHALLENGE_SIZE
];
144 #ifdef CONFIG_VNC_TLS
147 #ifdef CONFIG_VNC_SASL
155 /* current output mode information */
156 VncWritePixels
*write_pixels
;
157 DisplaySurface clientds
;
159 CaptureVoiceOut
*audio_cap
;
160 struct audsettings as
;
162 VncReadEvent
*read_handler
;
163 size_t read_handler_expect
;
165 uint8_t modifiers_state
[256];
166 QEMUPutLEDEntry
*led
;
168 /* Encoding specific */
171 uint8_t tight_quality
;
172 uint8_t tight_compression
;
175 VncSendHextileTile
*send_hextile_tile
;
180 z_stream zlib_stream
;
183 Notifier mouse_mode_notifier
;
185 QTAILQ_ENTRY(VncState
) next
;
189 /*****************************************************************************
191 * Authentication modes
193 *****************************************************************************/
196 VNC_AUTH_INVALID
= 0,
203 VNC_AUTH_TLS
= 18, /* Supported in GTK-VNC & VINO */
204 VNC_AUTH_VENCRYPT
= 19, /* Supported in GTK-VNC & VeNCrypt */
205 VNC_AUTH_SASL
= 20, /* Supported in GTK-VNC & VINO */
209 VNC_AUTH_VENCRYPT_PLAIN
= 256,
210 VNC_AUTH_VENCRYPT_TLSNONE
= 257,
211 VNC_AUTH_VENCRYPT_TLSVNC
= 258,
212 VNC_AUTH_VENCRYPT_TLSPLAIN
= 259,
213 VNC_AUTH_VENCRYPT_X509NONE
= 260,
214 VNC_AUTH_VENCRYPT_X509VNC
= 261,
215 VNC_AUTH_VENCRYPT_X509PLAIN
= 262,
216 VNC_AUTH_VENCRYPT_X509SASL
= 263,
217 VNC_AUTH_VENCRYPT_TLSSASL
= 264,
221 /*****************************************************************************
225 *****************************************************************************/
227 #define VNC_ENCODING_RAW 0x00000000
228 #define VNC_ENCODING_COPYRECT 0x00000001
229 #define VNC_ENCODING_RRE 0x00000002
230 #define VNC_ENCODING_CORRE 0x00000004
231 #define VNC_ENCODING_HEXTILE 0x00000005
232 #define VNC_ENCODING_ZLIB 0x00000006
233 #define VNC_ENCODING_TIGHT 0x00000007
234 #define VNC_ENCODING_ZLIBHEX 0x00000008
235 #define VNC_ENCODING_TRLE 0x0000000f
236 #define VNC_ENCODING_ZRLE 0x00000010
237 #define VNC_ENCODING_ZYWRLE 0x00000011
238 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
239 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
240 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
241 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
242 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
243 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
244 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
245 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
246 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
247 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
248 #define VNC_ENCODING_WMVi 0x574D5669
250 /*****************************************************************************
252 * Other tight constants
254 *****************************************************************************/
257 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
260 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
261 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
262 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
263 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
264 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
265 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
266 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
268 /*****************************************************************************
272 *****************************************************************************/
274 #define VNC_FEATURE_RESIZE 0
275 #define VNC_FEATURE_HEXTILE 1
276 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
277 #define VNC_FEATURE_WMVI 3
278 #define VNC_FEATURE_TIGHT 4
279 #define VNC_FEATURE_ZLIB 5
280 #define VNC_FEATURE_COPYRECT 6
281 #define VNC_FEATURE_RICH_CURSOR 7
283 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
284 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
285 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
286 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
287 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
288 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
289 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
290 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
293 /* Client -> Server message IDs */
294 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
295 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
296 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
297 #define VNC_MSG_CLIENT_KEY_EVENT 4
298 #define VNC_MSG_CLIENT_POINTER_EVENT 5
299 #define VNC_MSG_CLIENT_CUT_TEXT 6
300 #define VNC_MSG_CLIENT_VMWARE_0 127
301 #define VNC_MSG_CLIENT_CALL_CONTROL 249
302 #define VNC_MSG_CLIENT_XVP 250
303 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
304 #define VNC_MSG_CLIENT_TIGHT 252
305 #define VNC_MSG_CLIENT_GII 253
306 #define VNC_MSG_CLIENT_VMWARE_1 254
307 #define VNC_MSG_CLIENT_QEMU 255
309 /* Server -> Client message IDs */
310 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
311 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
312 #define VNC_MSG_SERVER_BELL 2
313 #define VNC_MSG_SERVER_CUT_TEXT 3
314 #define VNC_MSG_SERVER_VMWARE_0 127
315 #define VNC_MSG_SERVER_CALL_CONTROL 249
316 #define VNC_MSG_SERVER_XVP 250
317 #define VNC_MSG_SERVER_TIGHT 252
318 #define VNC_MSG_SERVER_GII 253
319 #define VNC_MSG_SERVER_VMWARE_1 254
320 #define VNC_MSG_SERVER_QEMU 255
324 /* QEMU client -> server message IDs */
325 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
326 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
328 /* QEMU server -> client message IDs */
329 #define VNC_MSG_SERVER_QEMU_AUDIO 1
333 /* QEMU client -> server audio message IDs */
334 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
335 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
336 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
338 /* QEMU server -> client audio message IDs */
339 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
340 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
341 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
344 /*****************************************************************************
348 *****************************************************************************/
350 /* Event loop functions */
351 void vnc_client_read(void *opaque
);
352 void vnc_client_write(void *opaque
);
354 long vnc_client_read_buf(VncState
*vs
, uint8_t *data
, size_t datalen
);
355 long vnc_client_write_buf(VncState
*vs
, const uint8_t *data
, size_t datalen
);
357 /* Protocol I/O functions */
358 void vnc_write(VncState
*vs
, const void *data
, size_t len
);
359 void vnc_write_u32(VncState
*vs
, uint32_t value
);
360 void vnc_write_s32(VncState
*vs
, int32_t value
);
361 void vnc_write_u16(VncState
*vs
, uint16_t value
);
362 void vnc_write_u8(VncState
*vs
, uint8_t value
);
363 void vnc_flush(VncState
*vs
);
364 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
);
367 /* Buffer I/O functions */
368 uint8_t read_u8(uint8_t *data
, size_t offset
);
369 uint16_t read_u16(uint8_t *data
, size_t offset
);
370 int32_t read_s32(uint8_t *data
, size_t offset
);
371 uint32_t read_u32(uint8_t *data
, size_t offset
);
373 /* Protocol stage functions */
374 void vnc_client_error(VncState
*vs
);
375 int vnc_client_io_error(VncState
*vs
, int ret
, int last_errno
);
377 void start_client_init(VncState
*vs
);
378 void start_auth_vnc(VncState
*vs
);
380 /* Buffer management */
381 void buffer_reserve(Buffer
*buffer
, size_t len
);
382 int buffer_empty(Buffer
*buffer
);
383 uint8_t *buffer_end(Buffer
*buffer
);
384 void buffer_reset(Buffer
*buffer
);
385 void buffer_append(Buffer
*buffer
, const void *data
, size_t len
);
390 char *vnc_socket_local_addr(const char *format
, int fd
);
391 char *vnc_socket_remote_addr(const char *format
, int fd
);
394 void vnc_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
,
397 void vnc_convert_pixel(VncState
*vs
, uint8_t *buf
, uint32_t v
);
400 void vnc_raw_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
402 void vnc_hextile_send_framebuffer_update(VncState
*vs
, int x
,
403 int y
, int w
, int h
);
404 void vnc_hextile_set_pixel_conversion(VncState
*vs
, int generic
);
406 void vnc_zlib_init(VncState
*vs
);
407 void vnc_zlib_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
);
409 #endif /* __QEMU_VNC_H */