blockdev: Add missing bdrv_unref() in drive-backup
[qemu.git] / ui / vnc.h
blob2863f583aae06ea7c81e5e5e360690fe782d956d
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 "crypto/tlssession.h"
37 #include "qemu/buffer.h"
38 #include <zlib.h>
39 #include <stdbool.h>
41 #include "keymaps.h"
42 #include "vnc-palette.h"
43 #include "vnc-enc-zrle.h"
44 #include "qapi-types.h"
46 // #define _VNC_DEBUG 1
48 #ifdef _VNC_DEBUG
49 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
50 #else
51 #define VNC_DEBUG(fmt, ...) do { } while (0)
52 #endif
54 /*****************************************************************************
56 * Core data structures
58 *****************************************************************************/
60 typedef struct VncState VncState;
61 typedef struct VncJob VncJob;
62 typedef struct VncRect VncRect;
63 typedef struct VncRectEntry VncRectEntry;
65 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
67 typedef void VncWritePixels(VncState *vs, void *data, int size);
69 typedef void VncSendHextileTile(VncState *vs,
70 int x, int y, int w, int h,
71 void *last_bg,
72 void *last_fg,
73 int *has_bg, int *has_fg);
75 /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
76 * by one bit in the dirty bitmap, should be a power of 2 */
77 #define VNC_DIRTY_PIXELS_PER_BIT 16
79 /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
81 #define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
82 #define VNC_MAX_HEIGHT 2048
84 /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
85 #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
87 /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
88 * VNC_DIRTY_BITS due to alignment */
89 #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
91 #define VNC_STAT_RECT 64
92 #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
93 #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
95 #define VNC_AUTH_CHALLENGE_SIZE 16
97 typedef struct VncDisplay VncDisplay;
99 #include "vnc-auth-vencrypt.h"
100 #ifdef CONFIG_VNC_SASL
101 #include "vnc-auth-sasl.h"
102 #endif
103 #include "vnc-ws.h"
105 struct VncRectStat
107 /* time of last 10 updates, to find update frequency */
108 struct timeval times[10];
109 int idx;
111 double freq; /* Update frequency (in Hz) */
112 bool updated; /* Already updated during this refresh */
115 typedef struct VncRectStat VncRectStat;
117 struct VncSurface
119 struct timeval last_freq_check;
120 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
121 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
122 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
123 pixman_image_t *fb;
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,
132 } VncShareMode;
134 typedef enum VncSharePolicy {
135 VNC_SHARE_POLICY_IGNORE = 1,
136 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
137 VNC_SHARE_POLICY_FORCE_SHARED,
138 } VncSharePolicy;
140 struct VncDisplay
142 QTAILQ_HEAD(, VncState) clients;
143 int num_connecting;
144 int num_shared;
145 int num_exclusive;
146 int connections_limit;
147 VncSharePolicy share_policy;
148 int lsock;
149 int lwebsock;
150 bool ws_enabled;
151 DisplaySurface *ds;
152 DisplayChangeListener dcl;
153 kbd_layout_t *kbd_layout;
154 int lock_key_sync;
155 QemuMutex mutex;
157 QEMUCursor *cursor;
158 int cursor_msize;
159 uint8_t *cursor_mask;
161 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
162 pixman_image_t *server; /* vnc server surface */
164 const char *id;
165 QTAILQ_ENTRY(VncDisplay) next;
166 bool enabled;
167 bool is_unix;
168 char *password;
169 time_t expires;
170 int auth;
171 int subauth; /* Used by VeNCrypt */
172 int ws_auth; /* Used by websockets */
173 bool ws_tls; /* Used by websockets */
174 bool lossy;
175 bool non_adaptive;
176 QCryptoTLSCreds *tlscreds;
177 char *tlsaclname;
178 #ifdef CONFIG_VNC_SASL
179 VncDisplaySASL sasl;
180 #endif
183 typedef struct VncTight {
184 int type;
185 uint8_t quality;
186 uint8_t compression;
187 uint8_t pixel24;
188 Buffer tight;
189 Buffer tmp;
190 Buffer zlib;
191 Buffer gradient;
192 #ifdef CONFIG_VNC_JPEG
193 Buffer jpeg;
194 #endif
195 #ifdef CONFIG_VNC_PNG
196 Buffer png;
197 #endif
198 int levels[4];
199 z_stream stream[4];
200 } VncTight;
202 typedef struct VncHextile {
203 VncSendHextileTile *send_tile;
204 } VncHextile;
206 typedef struct VncZlib {
207 Buffer zlib;
208 Buffer tmp;
209 z_stream stream;
210 int level;
211 } VncZlib;
213 typedef struct VncZrle {
214 int type;
215 Buffer fb;
216 Buffer zrle;
217 Buffer tmp;
218 Buffer zlib;
219 z_stream stream;
220 VncPalette palette;
221 } VncZrle;
223 typedef struct VncZywrle {
224 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
225 } VncZywrle;
227 struct VncRect
229 int x;
230 int y;
231 int w;
232 int h;
235 struct VncRectEntry
237 struct VncRect rect;
238 QLIST_ENTRY(VncRectEntry) next;
241 struct VncJob
243 VncState *vs;
245 QLIST_HEAD(, VncRectEntry) rectangles;
246 QTAILQ_ENTRY(VncJob) next;
249 struct VncState
251 int csock;
253 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
254 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
255 * vnc-jobs-async.c */
257 VncDisplay *vd;
258 int need_update;
259 int force_update;
260 int has_dirty;
261 uint32_t features;
262 int absolute;
263 int last_x;
264 int last_y;
265 uint32_t last_bmask;
266 int client_width;
267 int client_height;
268 VncShareMode share_mode;
270 uint32_t vnc_encoding;
272 int major;
273 int minor;
275 int auth;
276 int subauth; /* Used by VeNCrypt */
277 char challenge[VNC_AUTH_CHALLENGE_SIZE];
278 QCryptoTLSSession *tls;
279 #ifdef CONFIG_VNC_SASL
280 VncStateSASL sasl;
281 #endif
282 bool encode_ws;
283 bool websocket;
285 VncClientInfo *info;
287 Buffer output;
288 Buffer input;
289 Buffer ws_input;
290 Buffer ws_output;
291 size_t ws_payload_remain;
292 WsMask ws_payload_mask;
293 /* current output mode information */
294 VncWritePixels *write_pixels;
295 PixelFormat client_pf;
296 pixman_format_code_t client_format;
297 bool client_be;
299 CaptureVoiceOut *audio_cap;
300 struct audsettings as;
302 VncReadEvent *read_handler;
303 size_t read_handler_expect;
304 /* input */
305 uint8_t modifiers_state[256];
306 QEMUPutLEDEntry *led;
308 bool abort;
309 bool initialized;
310 QemuMutex output_mutex;
311 QEMUBH *bh;
312 Buffer jobs_buffer;
314 /* Encoding specific, if you add something here, don't forget to
315 * update vnc_async_encoding_start()
317 VncTight tight;
318 VncZlib zlib;
319 VncHextile hextile;
320 VncZrle zrle;
321 VncZywrle zywrle;
323 Notifier mouse_mode_notifier;
325 QTAILQ_ENTRY(VncState) next;
329 /*****************************************************************************
331 * Authentication modes
333 *****************************************************************************/
335 enum {
336 VNC_AUTH_INVALID = 0,
337 VNC_AUTH_NONE = 1,
338 VNC_AUTH_VNC = 2,
339 VNC_AUTH_RA2 = 5,
340 VNC_AUTH_RA2NE = 6,
341 VNC_AUTH_TIGHT = 16,
342 VNC_AUTH_ULTRA = 17,
343 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
344 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
345 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
348 enum {
349 VNC_AUTH_VENCRYPT_PLAIN = 256,
350 VNC_AUTH_VENCRYPT_TLSNONE = 257,
351 VNC_AUTH_VENCRYPT_TLSVNC = 258,
352 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
353 VNC_AUTH_VENCRYPT_X509NONE = 260,
354 VNC_AUTH_VENCRYPT_X509VNC = 261,
355 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
356 VNC_AUTH_VENCRYPT_X509SASL = 263,
357 VNC_AUTH_VENCRYPT_TLSSASL = 264,
361 /*****************************************************************************
363 * Encoding types
365 *****************************************************************************/
367 #define VNC_ENCODING_RAW 0x00000000
368 #define VNC_ENCODING_COPYRECT 0x00000001
369 #define VNC_ENCODING_RRE 0x00000002
370 #define VNC_ENCODING_CORRE 0x00000004
371 #define VNC_ENCODING_HEXTILE 0x00000005
372 #define VNC_ENCODING_ZLIB 0x00000006
373 #define VNC_ENCODING_TIGHT 0x00000007
374 #define VNC_ENCODING_ZLIBHEX 0x00000008
375 #define VNC_ENCODING_TRLE 0x0000000f
376 #define VNC_ENCODING_ZRLE 0x00000010
377 #define VNC_ENCODING_ZYWRLE 0x00000011
378 #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
379 #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
380 #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
381 #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
382 #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
383 #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
384 #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
385 #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
386 #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
387 #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
388 #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
389 #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
390 #define VNC_ENCODING_WMVi 0x574D5669
392 /*****************************************************************************
394 * Other tight constants
396 *****************************************************************************/
399 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
402 #define VNC_TIGHT_CCB_RESET_MASK (0x0f)
403 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
404 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
405 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
406 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
407 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
408 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
409 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
411 /*****************************************************************************
413 * Features
415 *****************************************************************************/
417 #define VNC_FEATURE_RESIZE 0
418 #define VNC_FEATURE_HEXTILE 1
419 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2
420 #define VNC_FEATURE_WMVI 3
421 #define VNC_FEATURE_TIGHT 4
422 #define VNC_FEATURE_ZLIB 5
423 #define VNC_FEATURE_COPYRECT 6
424 #define VNC_FEATURE_RICH_CURSOR 7
425 #define VNC_FEATURE_TIGHT_PNG 8
426 #define VNC_FEATURE_ZRLE 9
427 #define VNC_FEATURE_ZYWRLE 10
428 #define VNC_FEATURE_LED_STATE 11
430 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
431 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
432 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
433 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
434 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
435 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
436 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
437 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
438 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
439 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
440 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
441 #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
444 /* Client -> Server message IDs */
445 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
446 #define VNC_MSG_CLIENT_SET_ENCODINGS 2
447 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
448 #define VNC_MSG_CLIENT_KEY_EVENT 4
449 #define VNC_MSG_CLIENT_POINTER_EVENT 5
450 #define VNC_MSG_CLIENT_CUT_TEXT 6
451 #define VNC_MSG_CLIENT_VMWARE_0 127
452 #define VNC_MSG_CLIENT_CALL_CONTROL 249
453 #define VNC_MSG_CLIENT_XVP 250
454 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
455 #define VNC_MSG_CLIENT_TIGHT 252
456 #define VNC_MSG_CLIENT_GII 253
457 #define VNC_MSG_CLIENT_VMWARE_1 254
458 #define VNC_MSG_CLIENT_QEMU 255
460 /* Server -> Client message IDs */
461 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
462 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
463 #define VNC_MSG_SERVER_BELL 2
464 #define VNC_MSG_SERVER_CUT_TEXT 3
465 #define VNC_MSG_SERVER_VMWARE_0 127
466 #define VNC_MSG_SERVER_CALL_CONTROL 249
467 #define VNC_MSG_SERVER_XVP 250
468 #define VNC_MSG_SERVER_TIGHT 252
469 #define VNC_MSG_SERVER_GII 253
470 #define VNC_MSG_SERVER_VMWARE_1 254
471 #define VNC_MSG_SERVER_QEMU 255
475 /* QEMU client -> server message IDs */
476 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
477 #define VNC_MSG_CLIENT_QEMU_AUDIO 1
479 /* QEMU server -> client message IDs */
480 #define VNC_MSG_SERVER_QEMU_AUDIO 1
484 /* QEMU client -> server audio message IDs */
485 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
486 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
487 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
489 /* QEMU server -> client audio message IDs */
490 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0
491 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
492 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
495 /*****************************************************************************
497 * Internal APIs
499 *****************************************************************************/
501 /* Event loop functions */
502 void vnc_client_read(void *opaque);
503 void vnc_client_write(void *opaque);
505 ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
506 ssize_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
507 ssize_t vnc_tls_pull(char *buf, size_t len, void *opaque);
508 ssize_t vnc_tls_push(const char *buf, size_t len, void *opaque);
510 /* Protocol I/O functions */
511 void vnc_write(VncState *vs, const void *data, size_t len);
512 void vnc_write_u32(VncState *vs, uint32_t value);
513 void vnc_write_s32(VncState *vs, int32_t value);
514 void vnc_write_u16(VncState *vs, uint16_t value);
515 void vnc_write_u8(VncState *vs, uint8_t value);
516 void vnc_flush(VncState *vs);
517 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
518 void vnc_disconnect_finish(VncState *vs);
519 void vnc_init_state(VncState *vs);
522 /* Buffer I/O functions */
523 uint32_t read_u32(uint8_t *data, size_t offset);
525 /* Protocol stage functions */
526 void vnc_client_error(VncState *vs);
527 ssize_t vnc_client_io_error(VncState *vs, ssize_t ret, int last_errno);
529 void start_client_init(VncState *vs);
530 void start_auth_vnc(VncState *vs);
533 /* Misc helpers */
535 char *vnc_socket_local_addr(const char *format, int fd);
536 char *vnc_socket_remote_addr(const char *format, int fd);
538 static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
539 return (vs->features & (1 << feature));
542 /* Framebuffer */
543 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
544 int32_t encoding);
546 /* server fb is in PIXMAN_x8r8g8b8 */
547 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
548 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
549 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
551 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
552 int vnc_server_fb_stride(VncDisplay *vd);
554 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
555 double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
556 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
558 /* Encodings */
559 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
561 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
563 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
564 int y, int w, int h);
565 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
567 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
568 void vnc_zlib_zfree(void *x, void *addr);
569 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
570 void vnc_zlib_clear(VncState *vs);
572 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
573 int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
574 int w, int h);
575 void vnc_tight_clear(VncState *vs);
577 int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
578 int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
579 void vnc_zrle_clear(VncState *vs);
581 #endif /* __QEMU_VNC_H */