]> git.proxmox.com Git - qemu.git/blob - ui/vnc.h
Merge remote-tracking branch 'mst/tags/for_anthony' into staging
[qemu.git] / ui / vnc.h
1 /*
2 * QEMU VNC display driver
3 *
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
6 * Copyright (C) 2009 Red Hat, Inc
7 *
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:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
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
24 * THE SOFTWARE.
25 */
26
27 #ifndef __QEMU_VNC_H
28 #define __QEMU_VNC_H
29
30 #include "qemu-common.h"
31 #include "qemu/queue.h"
32 #include "qemu/thread.h"
33 #include "ui/console.h"
34 #include "monitor/monitor.h"
35 #include "audio/audio.h"
36 #include "qemu/bitmap.h"
37 #include <zlib.h>
38 #include <stdbool.h>
39
40 #include "keymaps.h"
41 #include "vnc-palette.h"
42 #include "vnc-enc-zrle.h"
43
44 // #define _VNC_DEBUG 1
45
46 #ifdef _VNC_DEBUG
47 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
48 #else
49 #define VNC_DEBUG(fmt, ...) do { } while (0)
50 #endif
51
52 /*****************************************************************************
53 *
54 * Core data structures
55 *
56 *****************************************************************************/
57
58 typedef struct Buffer
59 {
60 size_t capacity;
61 size_t offset;
62 uint8_t *buffer;
63 } Buffer;
64
65 typedef struct VncState VncState;
66 typedef struct VncJob VncJob;
67 typedef struct VncRect VncRect;
68 typedef struct VncRectEntry VncRectEntry;
69
70 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
71
72 typedef void VncWritePixels(VncState *vs, void *data, int size);
73
74 typedef void VncSendHextileTile(VncState *vs,
75 int x, int y, int w, int h,
76 void *last_bg,
77 void *last_fg,
78 int *has_bg, int *has_fg);
79
80 /* VNC_MAX_WIDTH must be a multiple of 16. */
81 #define VNC_MAX_WIDTH 2560
82 #define VNC_MAX_HEIGHT 2048
83
84 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
85 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / 16)
86
87 #define VNC_STAT_RECT 64
88 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
89 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
90
91 #define VNC_AUTH_CHALLENGE_SIZE 16
92
93 typedef struct VncDisplay VncDisplay;
94
95 #ifdef CONFIG_VNC_TLS
96 #include "vnc-tls.h"
97 #include "vnc-auth-vencrypt.h"
98 #endif
99 #ifdef CONFIG_VNC_SASL
100 #include "vnc-auth-sasl.h"
101 #endif
102 #ifdef CONFIG_VNC_WS
103 #include "vnc-ws.h"
104 #endif
105
106 struct VncRectStat
107 {
108 /* time of last 10 updates, to find update frequency */
109 struct timeval times[10];
110 int idx;
111
112 double freq; /* Update frequency (in Hz) */
113 bool updated; /* Already updated during this refresh */
114 };
115
116 typedef struct VncRectStat VncRectStat;
117
118 struct VncSurface
119 {
120 struct timeval last_freq_check;
121 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_MAX_WIDTH / 16);
122 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
123 pixman_image_t *fb;
124 pixman_format_code_t format;
125 };
126
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,
132 } VncShareMode;
133
134 typedef enum VncSharePolicy {
135 VNC_SHARE_POLICY_IGNORE = 1,
136 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
137 VNC_SHARE_POLICY_FORCE_SHARED,
138 } VncSharePolicy;
139
140 struct VncDisplay
141 {
142 QTAILQ_HEAD(, VncState) clients;
143 int num_exclusive;
144 VncSharePolicy share_policy;
145 int lsock;
146 #ifdef CONFIG_VNC_WS
147 int lwebsock;
148 bool websocket;
149 char *ws_display;
150 #endif
151 DisplaySurface *ds;
152 DisplayChangeListener dcl;
153 kbd_layout_t *kbd_layout;
154 int lock_key_sync;
155 QemuMutex mutex;
156
157 QEMUCursor *cursor;
158 int cursor_msize;
159 uint8_t *cursor_mask;
160
161 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
162 pixman_image_t *server; /* vnc server surface */
163
164 char *display;
165 char *password;
166 time_t expires;
167 int auth;
168 bool lossy;
169 bool non_adaptive;
170 #ifdef CONFIG_VNC_TLS
171 int subauth; /* Used by VeNCrypt */
172 VncDisplayTLS tls;
173 #endif
174 #ifdef CONFIG_VNC_SASL
175 VncDisplaySASL sasl;
176 #endif
177 };
178
179 typedef struct VncTight {
180 int type;
181 uint8_t quality;
182 uint8_t compression;
183 uint8_t pixel24;
184 Buffer tight;
185 Buffer tmp;
186 Buffer zlib;
187 Buffer gradient;
188 #ifdef CONFIG_VNC_JPEG
189 Buffer jpeg;
190 #endif
191 #ifdef CONFIG_VNC_PNG
192 Buffer png;
193 #endif
194 int levels[4];
195 z_stream stream[4];
196 } VncTight;
197
198 typedef struct VncHextile {
199 VncSendHextileTile *send_tile;
200 } VncHextile;
201
202 typedef struct VncZlib {
203 Buffer zlib;
204 Buffer tmp;
205 z_stream stream;
206 int level;
207 } VncZlib;
208
209 typedef struct VncZrle {
210 int type;
211 Buffer fb;
212 Buffer zrle;
213 Buffer tmp;
214 Buffer zlib;
215 z_stream stream;
216 VncPalette palette;
217 } VncZrle;
218
219 typedef struct VncZywrle {
220 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
221 } VncZywrle;
222
223 struct VncRect
224 {
225 int x;
226 int y;
227 int w;
228 int h;
229 };
230
231 struct VncRectEntry
232 {
233 struct VncRect rect;
234 QLIST_ENTRY(VncRectEntry) next;
235 };
236
237 struct VncJob
238 {
239 VncState *vs;
240
241 QLIST_HEAD(, VncRectEntry) rectangles;
242 QTAILQ_ENTRY(VncJob) next;
243 };
244
245 struct VncState
246 {
247 int csock;
248
249 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
250 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
251 * vnc-jobs-async.c */
252
253 VncDisplay *vd;
254 int need_update;
255 int force_update;
256 uint32_t features;
257 int absolute;
258 int last_x;
259 int last_y;
260 int client_width;
261 int client_height;
262 VncShareMode share_mode;
263
264 uint32_t vnc_encoding;
265
266 int major;
267 int minor;
268
269 int auth;
270 char challenge[VNC_AUTH_CHALLENGE_SIZE];
271 #ifdef CONFIG_VNC_TLS
272 int subauth; /* Used by VeNCrypt */
273 VncStateTLS tls;
274 #endif
275 #ifdef CONFIG_VNC_SASL
276 VncStateSASL sasl;
277 #endif
278 #ifdef CONFIG_VNC_WS
279 bool encode_ws;
280 bool websocket;
281 #endif
282
283 QObject *info;
284
285 Buffer output;
286 Buffer input;
287 #ifdef CONFIG_VNC_WS
288 Buffer ws_input;
289 Buffer ws_output;
290 #endif
291 /* current output mode information */
292 VncWritePixels *write_pixels;
293 PixelFormat client_pf;
294 pixman_format_code_t client_format;
295 bool client_be;
296
297 CaptureVoiceOut *audio_cap;
298 struct audsettings as;
299
300 VncReadEvent *read_handler;
301 size_t read_handler_expect;
302 /* input */
303 uint8_t modifiers_state[256];
304 QEMUPutLEDEntry *led;
305
306 bool abort;
307 bool initialized;
308 QemuMutex output_mutex;
309 QEMUBH *bh;
310 Buffer jobs_buffer;
311
312 /* Encoding specific, if you add something here, don't forget to
313 * update vnc_async_encoding_start()
314 */
315 VncTight tight;
316 VncZlib zlib;
317 VncHextile hextile;
318 VncZrle zrle;
319 VncZywrle zywrle;
320
321 Notifier mouse_mode_notifier;
322
323 QTAILQ_ENTRY(VncState) next;
324 };
325
326
327 /*****************************************************************************
328 *
329 * Authentication modes
330 *
331 *****************************************************************************/
332
333 enum {
334 VNC_AUTH_INVALID = 0,
335 VNC_AUTH_NONE = 1,
336 VNC_AUTH_VNC = 2,
337 VNC_AUTH_RA2 = 5,
338 VNC_AUTH_RA2NE = 6,
339 VNC_AUTH_TIGHT = 16,
340 VNC_AUTH_ULTRA = 17,
341 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
342 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
343 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
344 };
345
346 enum {
347 VNC_AUTH_VENCRYPT_PLAIN = 256,
348 VNC_AUTH_VENCRYPT_TLSNONE = 257,
349 VNC_AUTH_VENCRYPT_TLSVNC = 258,
350 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
351 VNC_AUTH_VENCRYPT_X509NONE = 260,
352 VNC_AUTH_VENCRYPT_X509VNC = 261,
353 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
354 VNC_AUTH_VENCRYPT_X509SASL = 263,
355 VNC_AUTH_VENCRYPT_TLSSASL = 264,
356 };
357
358
359 /*****************************************************************************
360 *
361 * Encoding types
362 *
363 *****************************************************************************/
364
365 #define VNC_ENCODING_RAW 0x00000000
366 #define VNC_ENCODING_COPYRECT 0x00000001
367 #define VNC_ENCODING_RRE 0x00000002
368 #define VNC_ENCODING_CORRE 0x00000004
369 #define VNC_ENCODING_HEXTILE 0x00000005
370 #define VNC_ENCODING_ZLIB 0x00000006
371 #define VNC_ENCODING_TIGHT 0x00000007
372 #define VNC_ENCODING_ZLIBHEX 0x00000008
373 #define VNC_ENCODING_TRLE 0x0000000f
374 #define VNC_ENCODING_ZRLE 0x00000010
375 #define VNC_ENCODING_ZYWRLE 0x00000011
376 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
377 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
378 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
379 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
380 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
381 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
382 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
383 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
384 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
385 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
386 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
387 #define VNC_ENCODING_WMVi 0x574D5669
388
389 /*****************************************************************************
390 *
391 * Other tight constants
392 *
393 *****************************************************************************/
394
395 /*
396 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
397 */
398
399 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
400 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
401 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
402 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
403 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
404 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
405 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
406 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
407
408 /*****************************************************************************
409 *
410 * Features
411 *
412 *****************************************************************************/
413
414 #define VNC_FEATURE_RESIZE 0
415 #define VNC_FEATURE_HEXTILE 1
416 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
417 #define VNC_FEATURE_WMVI 3
418 #define VNC_FEATURE_TIGHT 4
419 #define VNC_FEATURE_ZLIB 5
420 #define VNC_FEATURE_COPYRECT 6
421 #define VNC_FEATURE_RICH_CURSOR 7
422 #define VNC_FEATURE_TIGHT_PNG 8
423 #define VNC_FEATURE_ZRLE 9
424 #define VNC_FEATURE_ZYWRLE 10
425
426 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
427 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
428 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
429 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
430 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
431 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
432 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
433 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
434 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
435 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
436 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
437
438
439 /* Client -> Server message IDs */
440 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
441 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
442 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
443 #define VNC_MSG_CLIENT_KEY_EVENT 4
444 #define VNC_MSG_CLIENT_POINTER_EVENT 5
445 #define VNC_MSG_CLIENT_CUT_TEXT 6
446 #define VNC_MSG_CLIENT_VMWARE_0 127
447 #define VNC_MSG_CLIENT_CALL_CONTROL 249
448 #define VNC_MSG_CLIENT_XVP 250
449 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
450 #define VNC_MSG_CLIENT_TIGHT 252
451 #define VNC_MSG_CLIENT_GII 253
452 #define VNC_MSG_CLIENT_VMWARE_1 254
453 #define VNC_MSG_CLIENT_QEMU 255
454
455 /* Server -> Client message IDs */
456 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
457 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
458 #define VNC_MSG_SERVER_BELL 2
459 #define VNC_MSG_SERVER_CUT_TEXT 3
460 #define VNC_MSG_SERVER_VMWARE_0 127
461 #define VNC_MSG_SERVER_CALL_CONTROL 249
462 #define VNC_MSG_SERVER_XVP 250
463 #define VNC_MSG_SERVER_TIGHT 252
464 #define VNC_MSG_SERVER_GII 253
465 #define VNC_MSG_SERVER_VMWARE_1 254
466 #define VNC_MSG_SERVER_QEMU 255
467
468
469
470 /* QEMU client -> server message IDs */
471 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
472 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
473
474 /* QEMU server -> client message IDs */
475 #define VNC_MSG_SERVER_QEMU_AUDIO 1
476
477
478
479 /* QEMU client -> server audio message IDs */
480 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
481 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
482 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
483
484 /* QEMU server -> client audio message IDs */
485 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
486 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
487 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
488
489
490 /*****************************************************************************
491 *
492 * Internal APIs
493 *
494 *****************************************************************************/
495
496 /* Event loop functions */
497 void vnc_client_read(void *opaque);
498 void vnc_client_write(void *opaque);
499
500 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
501 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
502
503 /* Protocol I/O functions */
504 void vnc_write(VncState *vs, const void *data, size_t len);
505 void vnc_write_u32(VncState *vs, uint32_t value);
506 void vnc_write_s32(VncState *vs, int32_t value);
507 void vnc_write_u16(VncState *vs, uint16_t value);
508 void vnc_write_u8(VncState *vs, uint8_t value);
509 void vnc_flush(VncState *vs);
510 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
511 void vnc_disconnect_finish(VncState *vs);
512 void vnc_init_state(VncState *vs);
513
514
515 /* Buffer I/O functions */
516 uint32_t read_u32(uint8_t *data, size_t offset);
517
518 /* Protocol stage functions */
519 void vnc_client_error(VncState *vs);
520 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
521
522 void start_client_init(VncState *vs);
523 void start_auth_vnc(VncState *vs);
524
525 /* Buffer management */
526 void buffer_reserve(Buffer *buffer, size_t len);
527 void buffer_reset(Buffer *buffer);
528 void buffer_free(Buffer *buffer);
529 void buffer_append(Buffer *buffer, const void *data, size_t len);
530 void buffer_advance(Buffer *buf, size_t len);
531 uint8_t *buffer_end(Buffer *buffer);
532
533
534 /* Misc helpers */
535
536 char *vnc_socket_local_addr(const char *format, int fd);
537 char *vnc_socket_remote_addr(const char *format, int fd);
538
539 static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
540 return (vs->features & (1 << feature));
541 }
542
543 /* Framebuffer */
544 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
545 int32_t encoding);
546
547 /* server fb is in PIXMAN_x8r8g8b8 */
548 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
549 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
550 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
551
552 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
553 int vnc_server_fb_stride(VncDisplay *vd);
554
555 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
556 double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
557 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
558
559 /* Encodings */
560 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
561
562 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
563
564 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
565 int y, int w, int h);
566 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
567
568 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
569 void vnc_zlib_zfree(void *x, void *addr);
570 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
571 void vnc_zlib_clear(VncState *vs);
572
573 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
574 int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
575 int w, int h);
576 void vnc_tight_clear(VncState *vs);
577
578 int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
579 int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
580 void vnc_zrle_clear(VncState *vs);
581
582 #endif /* __QEMU_VNC_H */