host-libusb: remove bootindex property from qdev to qom
[qemu.git] / ui / vnc.h
blob334de9ddb1ba823d2b7e092ce20bdf3bf3cfaf41
1 /*
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
24 * THE SOFTWARE.
27 #ifndef __QEMU_VNC_H
28 #define __QEMU_VNC_H
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 <zlib.h>
37 #include <stdbool.h>
39 #include "keymaps.h"
40 #include "vnc-palette.h"
41 #include "vnc-enc-zrle.h"
42 #include "qapi-types.h"
44 // #define _VNC_DEBUG 1
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
52 /*****************************************************************************
54 * Core data structures
56 *****************************************************************************/
58 typedef struct Buffer
60 size_t capacity;
61 size_t offset;
62 uint8_t *buffer;
63 } Buffer;
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,
76 void *last_bg,
77 void *last_fg,
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
105 #include "vnc-tls.h"
106 #include "vnc-auth-vencrypt.h"
107 #endif
108 #ifdef CONFIG_VNC_SASL
109 #include "vnc-auth-sasl.h"
110 #endif
111 #ifdef CONFIG_VNC_WS
112 #include "vnc-ws.h"
113 #endif
115 struct VncRectStat
117 /* time of last 10 updates, to find update frequency */
118 struct timeval times[10];
119 int idx;
121 double freq; /* Update frequency (in Hz) */
122 bool updated; /* Already updated during this refresh */
125 typedef struct VncRectStat VncRectStat;
127 struct VncSurface
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];
133 pixman_image_t *fb;
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,
142 } VncShareMode;
144 typedef enum VncSharePolicy {
145 VNC_SHARE_POLICY_IGNORE = 1,
146 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
147 VNC_SHARE_POLICY_FORCE_SHARED,
148 } VncSharePolicy;
150 struct VncDisplay
152 QTAILQ_HEAD(, VncState) clients;
153 int num_exclusive;
154 VncSharePolicy share_policy;
155 int lsock;
156 #ifdef CONFIG_VNC_WS
157 int lwebsock;
158 bool websocket;
159 char *ws_display;
160 #endif
161 DisplaySurface *ds;
162 DisplayChangeListener dcl;
163 kbd_layout_t *kbd_layout;
164 int lock_key_sync;
165 QemuMutex mutex;
167 QEMUCursor *cursor;
168 int cursor_msize;
169 uint8_t *cursor_mask;
171 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
172 pixman_image_t *server; /* vnc server surface */
174 char *display;
175 char *password;
176 time_t expires;
177 int auth;
178 bool lossy;
179 bool non_adaptive;
180 #ifdef CONFIG_VNC_TLS
181 int subauth; /* Used by VeNCrypt */
182 VncDisplayTLS tls;
183 #endif
184 #ifdef CONFIG_VNC_SASL
185 VncDisplaySASL sasl;
186 #endif
189 typedef struct VncTight {
190 int type;
191 uint8_t quality;
192 uint8_t compression;
193 uint8_t pixel24;
194 Buffer tight;
195 Buffer tmp;
196 Buffer zlib;
197 Buffer gradient;
198 #ifdef CONFIG_VNC_JPEG
199 Buffer jpeg;
200 #endif
201 #ifdef CONFIG_VNC_PNG
202 Buffer png;
203 #endif
204 int levels[4];
205 z_stream stream[4];
206 } VncTight;
208 typedef struct VncHextile {
209 VncSendHextileTile *send_tile;
210 } VncHextile;
212 typedef struct VncZlib {
213 Buffer zlib;
214 Buffer tmp;
215 z_stream stream;
216 int level;
217 } VncZlib;
219 typedef struct VncZrle {
220 int type;
221 Buffer fb;
222 Buffer zrle;
223 Buffer tmp;
224 Buffer zlib;
225 z_stream stream;
226 VncPalette palette;
227 } VncZrle;
229 typedef struct VncZywrle {
230 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
231 } VncZywrle;
233 struct VncRect
235 int x;
236 int y;
237 int w;
238 int h;
241 struct VncRectEntry
243 struct VncRect rect;
244 QLIST_ENTRY(VncRectEntry) next;
247 struct VncJob
249 VncState *vs;
251 QLIST_HEAD(, VncRectEntry) rectangles;
252 QTAILQ_ENTRY(VncJob) next;
255 struct VncState
257 int csock;
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 */
263 VncDisplay *vd;
264 int need_update;
265 int force_update;
266 int has_dirty;
267 uint32_t features;
268 int absolute;
269 int last_x;
270 int last_y;
271 uint32_t last_bmask;
272 int client_width;
273 int client_height;
274 VncShareMode share_mode;
276 uint32_t vnc_encoding;
278 int major;
279 int minor;
281 int auth;
282 char challenge[VNC_AUTH_CHALLENGE_SIZE];
283 #ifdef CONFIG_VNC_TLS
284 int subauth; /* Used by VeNCrypt */
285 VncStateTLS tls;
286 #endif
287 #ifdef CONFIG_VNC_SASL
288 VncStateSASL sasl;
289 #endif
290 #ifdef CONFIG_VNC_WS
291 #ifdef CONFIG_VNC_TLS
292 VncStateTLS ws_tls;
293 #endif /* CONFIG_VNC_TLS */
294 bool encode_ws;
295 bool websocket;
296 #endif /* CONFIG_VNC_WS */
298 VncClientInfo *info;
300 Buffer output;
301 Buffer input;
302 #ifdef CONFIG_VNC_WS
303 Buffer ws_input;
304 Buffer ws_output;
305 #endif
306 /* current output mode information */
307 VncWritePixels *write_pixels;
308 PixelFormat client_pf;
309 pixman_format_code_t client_format;
310 bool client_be;
312 CaptureVoiceOut *audio_cap;
313 struct audsettings as;
315 VncReadEvent *read_handler;
316 size_t read_handler_expect;
317 /* input */
318 uint8_t modifiers_state[256];
319 QEMUPutLEDEntry *led;
321 bool abort;
322 bool initialized;
323 QemuMutex output_mutex;
324 QEMUBH *bh;
325 Buffer jobs_buffer;
327 /* Encoding specific, if you add something here, don't forget to
328 * update vnc_async_encoding_start()
330 VncTight tight;
331 VncZlib zlib;
332 VncHextile hextile;
333 VncZrle zrle;
334 VncZywrle zywrle;
336 Notifier mouse_mode_notifier;
338 QTAILQ_ENTRY(VncState) next;
342 /*****************************************************************************
344 * Authentication modes
346 *****************************************************************************/
348 enum {
349 VNC_AUTH_INVALID = 0,
350 VNC_AUTH_NONE = 1,
351 VNC_AUTH_VNC = 2,
352 VNC_AUTH_RA2 = 5,
353 VNC_AUTH_RA2NE = 6,
354 VNC_AUTH_TIGHT = 16,
355 VNC_AUTH_ULTRA = 17,
356 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
357 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
358 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
361 enum {
362 VNC_AUTH_VENCRYPT_PLAIN = 256,
363 VNC_AUTH_VENCRYPT_TLSNONE = 257,
364 VNC_AUTH_VENCRYPT_TLSVNC = 258,
365 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
366 VNC_AUTH_VENCRYPT_X509NONE = 260,
367 VNC_AUTH_VENCRYPT_X509VNC = 261,
368 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
369 VNC_AUTH_VENCRYPT_X509SASL = 263,
370 VNC_AUTH_VENCRYPT_TLSSASL = 264,
374 /*****************************************************************************
376 * Encoding types
378 *****************************************************************************/
380 #define VNC_ENCODING_RAW 0x00000000
381 #define VNC_ENCODING_COPYRECT 0x00000001
382 #define VNC_ENCODING_RRE 0x00000002
383 #define VNC_ENCODING_CORRE 0x00000004
384 #define VNC_ENCODING_HEXTILE 0x00000005
385 #define VNC_ENCODING_ZLIB 0x00000006
386 #define VNC_ENCODING_TIGHT 0x00000007
387 #define VNC_ENCODING_ZLIBHEX 0x00000008
388 #define VNC_ENCODING_TRLE 0x0000000f
389 #define VNC_ENCODING_ZRLE 0x00000010
390 #define VNC_ENCODING_ZYWRLE 0x00000011
391 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
392 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
393 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
394 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
395 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
396 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
397 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
398 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
399 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
400 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
401 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
402 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
403 #define VNC_ENCODING_WMVi 0x574D5669
405 /*****************************************************************************
407 * Other tight constants
409 *****************************************************************************/
412 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
415 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
416 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
417 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
418 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
419 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
420 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
421 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
422 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
424 /*****************************************************************************
426 * Features
428 *****************************************************************************/
430 #define VNC_FEATURE_RESIZE 0
431 #define VNC_FEATURE_HEXTILE 1
432 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
433 #define VNC_FEATURE_WMVI 3
434 #define VNC_FEATURE_TIGHT 4
435 #define VNC_FEATURE_ZLIB 5
436 #define VNC_FEATURE_COPYRECT 6
437 #define VNC_FEATURE_RICH_CURSOR 7
438 #define VNC_FEATURE_TIGHT_PNG 8
439 #define VNC_FEATURE_ZRLE 9
440 #define VNC_FEATURE_ZYWRLE 10
441 #define VNC_FEATURE_LED_STATE 11
443 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
444 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
445 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
446 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
447 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
448 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
449 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
450 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
451 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
452 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
453 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
454 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
457 /* Client -> Server message IDs */
458 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
459 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
460 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
461 #define VNC_MSG_CLIENT_KEY_EVENT 4
462 #define VNC_MSG_CLIENT_POINTER_EVENT 5
463 #define VNC_MSG_CLIENT_CUT_TEXT 6
464 #define VNC_MSG_CLIENT_VMWARE_0 127
465 #define VNC_MSG_CLIENT_CALL_CONTROL 249
466 #define VNC_MSG_CLIENT_XVP 250
467 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
468 #define VNC_MSG_CLIENT_TIGHT 252
469 #define VNC_MSG_CLIENT_GII 253
470 #define VNC_MSG_CLIENT_VMWARE_1 254
471 #define VNC_MSG_CLIENT_QEMU 255
473 /* Server -> Client message IDs */
474 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
475 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
476 #define VNC_MSG_SERVER_BELL 2
477 #define VNC_MSG_SERVER_CUT_TEXT 3
478 #define VNC_MSG_SERVER_VMWARE_0 127
479 #define VNC_MSG_SERVER_CALL_CONTROL 249
480 #define VNC_MSG_SERVER_XVP 250
481 #define VNC_MSG_SERVER_TIGHT 252
482 #define VNC_MSG_SERVER_GII 253
483 #define VNC_MSG_SERVER_VMWARE_1 254
484 #define VNC_MSG_SERVER_QEMU 255
488 /* QEMU client -> server message IDs */
489 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
490 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
492 /* QEMU server -> client message IDs */
493 #define VNC_MSG_SERVER_QEMU_AUDIO 1
497 /* QEMU client -> server audio message IDs */
498 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
499 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
500 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
502 /* QEMU server -> client audio message IDs */
503 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
504 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
505 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
508 /*****************************************************************************
510 * Internal APIs
512 *****************************************************************************/
514 /* Event loop functions */
515 void vnc_client_read(void *opaque);
516 void vnc_client_write(void *opaque);
518 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
519 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
521 /* Protocol I/O functions */
522 void vnc_write(VncState *vs, const void *data, size_t len);
523 void vnc_write_u32(VncState *vs, uint32_t value);
524 void vnc_write_s32(VncState *vs, int32_t value);
525 void vnc_write_u16(VncState *vs, uint16_t value);
526 void vnc_write_u8(VncState *vs, uint8_t value);
527 void vnc_flush(VncState *vs);
528 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
529 void vnc_disconnect_finish(VncState *vs);
530 void vnc_init_state(VncState *vs);
533 /* Buffer I/O functions */
534 uint32_t read_u32(uint8_t *data, size_t offset);
536 /* Protocol stage functions */
537 void vnc_client_error(VncState *vs);
538 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
540 void start_client_init(VncState *vs);
541 void start_auth_vnc(VncState *vs);
543 /* Buffer management */
544 void buffer_reserve(Buffer *buffer, size_t len);
545 void buffer_reset(Buffer *buffer);
546 void buffer_free(Buffer *buffer);
547 void buffer_append(Buffer *buffer, const void *data, size_t len);
548 void buffer_advance(Buffer *buf, size_t len);
549 uint8_t *buffer_end(Buffer *buffer);
552 /* Misc helpers */
554 char *vnc_socket_local_addr(const char *format, int fd);
555 char *vnc_socket_remote_addr(const char *format, int fd);
557 static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
558 return (vs->features & (1 << feature));
561 /* Framebuffer */
562 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
563 int32_t encoding);
565 /* server fb is in PIXMAN_x8r8g8b8 */
566 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
567 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
568 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
570 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
571 int vnc_server_fb_stride(VncDisplay *vd);
573 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
574 double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
575 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
577 /* Encodings */
578 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
580 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
582 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
583 int y, int w, int h);
584 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
586 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
587 void vnc_zlib_zfree(void *x, void *addr);
588 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
589 void vnc_zlib_clear(VncState *vs);
591 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
592 int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
593 int w, int h);
594 void vnc_tight_clear(VncState *vs);
596 int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
597 int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
598 void vnc_zrle_clear(VncState *vs);
600 #endif /* __QEMU_VNC_H */