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 QEMUTimer *timer; 146 int timer_interval; 147 int lsock; 148 #ifdef CONFIG_VNC_WS 149 int lwebsock; 150 bool websocket; 151 char *ws_display; 152 #endif 153 DisplaySurface *ds; 154 DisplayChangeListener dcl; 155 kbd_layout_t *kbd_layout; 156 int lock_key_sync; 157 QemuMutex mutex; 158 159 QEMUCursor *cursor; 160 int cursor_msize; 161 uint8_t *cursor_mask; 162 163 struct VncSurface guest; /* guest visible surface (aka ds->surface) */ 164 pixman_image_t *server; /* vnc server surface */ 165 166 char *display; 167 char *password; 168 time_t expires; 169 int auth; 170 bool lossy; 171 bool non_adaptive; 172 #ifdef CONFIG_VNC_TLS 173 int subauth; /* Used by VeNCrypt */ 174 VncDisplayTLS tls; 175 #endif 176 #ifdef CONFIG_VNC_SASL 177 VncDisplaySASL sasl; 178 #endif 179 }; 180 181 typedef struct VncTight { 182 int type; 183 uint8_t quality; 184 uint8_t compression; 185 uint8_t pixel24; 186 Buffer tight; 187 Buffer tmp; 188 Buffer zlib; 189 Buffer gradient; 190 #ifdef CONFIG_VNC_JPEG 191 Buffer jpeg; 192 #endif 193 #ifdef CONFIG_VNC_PNG 194 Buffer png; 195 #endif 196 int levels[4]; 197 z_stream stream[4]; 198 } VncTight; 199 200 typedef struct VncHextile { 201 VncSendHextileTile *send_tile; 202 } VncHextile; 203 204 typedef struct VncZlib { 205 Buffer zlib; 206 Buffer tmp; 207 z_stream stream; 208 int level; 209 } VncZlib; 210 211 typedef struct VncZrle { 212 int type; 213 Buffer fb; 214 Buffer zrle; 215 Buffer tmp; 216 Buffer zlib; 217 z_stream stream; 218 VncPalette palette; 219 } VncZrle; 220 221 typedef struct VncZywrle { 222 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT]; 223 } VncZywrle; 224 225 struct VncRect 226 { 227 int x; 228 int y; 229 int w; 230 int h; 231 }; 232 233 struct VncRectEntry 234 { 235 struct VncRect rect; 236 QLIST_ENTRY(VncRectEntry) next; 237 }; 238 239 struct VncJob 240 { 241 VncState *vs; 242 243 QLIST_HEAD(, VncRectEntry) rectangles; 244 QTAILQ_ENTRY(VncJob) next; 245 }; 246 247 struct VncState 248 { 249 int csock; 250 251 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS); 252 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in 253 * vnc-jobs-async.c */ 254 255 VncDisplay *vd; 256 int need_update; 257 int force_update; 258 uint32_t features; 259 int absolute; 260 int last_x; 261 int last_y; 262 int client_width; 263 int client_height; 264 VncShareMode share_mode; 265 266 uint32_t vnc_encoding; 267 268 int major; 269 int minor; 270 271 int auth; 272 char challenge[VNC_AUTH_CHALLENGE_SIZE]; 273 #ifdef CONFIG_VNC_TLS 274 int subauth; /* Used by VeNCrypt */ 275 VncStateTLS tls; 276 #endif 277 #ifdef CONFIG_VNC_SASL 278 VncStateSASL sasl; 279 #endif 280 #ifdef CONFIG_VNC_WS 281 bool encode_ws; 282 bool websocket; 283 #endif 284 285 QObject *info; 286 287 Buffer output; 288 Buffer input; 289 #ifdef CONFIG_VNC_WS 290 Buffer ws_input; 291 Buffer ws_output; 292 #endif 293 /* current output mode information */ 294 VncWritePixels *write_pixels; 295 PixelFormat client_pf; 296 pixman_format_code_t client_format; 297 bool client_be; 298 299 CaptureVoiceOut *audio_cap; 300 struct audsettings as; 301 302 VncReadEvent *read_handler; 303 size_t read_handler_expect; 304 /* input */ 305 uint8_t modifiers_state[256]; 306 QEMUPutLEDEntry *led; 307 308 bool abort; 309 bool initialized; 310 QemuMutex output_mutex; 311 QEMUBH *bh; 312 Buffer jobs_buffer; 313 314 /* Encoding specific, if you add something here, don't forget to 315 * update vnc_async_encoding_start() 316 */ 317 VncTight tight; 318 VncZlib zlib; 319 VncHextile hextile; 320 VncZrle zrle; 321 VncZywrle zywrle; 322 323 Notifier mouse_mode_notifier; 324 325 QTAILQ_ENTRY(VncState) next; 326 }; 327 328 329 /***************************************************************************** 330 * 331 * Authentication modes 332 * 333 *****************************************************************************/ 334 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 */ 346 }; 347 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, 358 }; 359 360 361 /***************************************************************************** 362 * 363 * Encoding types 364 * 365 *****************************************************************************/ 366 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_WMVi 0x574D5669 390 391 /***************************************************************************** 392 * 393 * Other tight constants 394 * 395 *****************************************************************************/ 396 397 /* 398 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC. 399 */ 400 401 #define VNC_TIGHT_CCB_RESET_MASK (0x0f) 402 #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4) 403 #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4) 404 #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4) 405 #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4) 406 #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4) 407 #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4) 408 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4) 409 410 /***************************************************************************** 411 * 412 * Features 413 * 414 *****************************************************************************/ 415 416 #define VNC_FEATURE_RESIZE 0 417 #define VNC_FEATURE_HEXTILE 1 418 #define VNC_FEATURE_POINTER_TYPE_CHANGE 2 419 #define VNC_FEATURE_WMVI 3 420 #define VNC_FEATURE_TIGHT 4 421 #define VNC_FEATURE_ZLIB 5 422 #define VNC_FEATURE_COPYRECT 6 423 #define VNC_FEATURE_RICH_CURSOR 7 424 #define VNC_FEATURE_TIGHT_PNG 8 425 #define VNC_FEATURE_ZRLE 9 426 #define VNC_FEATURE_ZYWRLE 10 427 428 #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE) 429 #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE) 430 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE) 431 #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI) 432 #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT) 433 #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB) 434 #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT) 435 #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR) 436 #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG) 437 #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE) 438 #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE) 439 440 441 /* Client -> Server message IDs */ 442 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0 443 #define VNC_MSG_CLIENT_SET_ENCODINGS 2 444 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3 445 #define VNC_MSG_CLIENT_KEY_EVENT 4 446 #define VNC_MSG_CLIENT_POINTER_EVENT 5 447 #define VNC_MSG_CLIENT_CUT_TEXT 6 448 #define VNC_MSG_CLIENT_VMWARE_0 127 449 #define VNC_MSG_CLIENT_CALL_CONTROL 249 450 #define VNC_MSG_CLIENT_XVP 250 451 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251 452 #define VNC_MSG_CLIENT_TIGHT 252 453 #define VNC_MSG_CLIENT_GII 253 454 #define VNC_MSG_CLIENT_VMWARE_1 254 455 #define VNC_MSG_CLIENT_QEMU 255 456 457 /* Server -> Client message IDs */ 458 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0 459 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1 460 #define VNC_MSG_SERVER_BELL 2 461 #define VNC_MSG_SERVER_CUT_TEXT 3 462 #define VNC_MSG_SERVER_VMWARE_0 127 463 #define VNC_MSG_SERVER_CALL_CONTROL 249 464 #define VNC_MSG_SERVER_XVP 250 465 #define VNC_MSG_SERVER_TIGHT 252 466 #define VNC_MSG_SERVER_GII 253 467 #define VNC_MSG_SERVER_VMWARE_1 254 468 #define VNC_MSG_SERVER_QEMU 255 469 470 471 472 /* QEMU client -> server message IDs */ 473 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0 474 #define VNC_MSG_CLIENT_QEMU_AUDIO 1 475 476 /* QEMU server -> client message IDs */ 477 #define VNC_MSG_SERVER_QEMU_AUDIO 1 478 479 480 481 /* QEMU client -> server audio message IDs */ 482 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0 483 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1 484 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2 485 486 /* QEMU server -> client audio message IDs */ 487 #define VNC_MSG_SERVER_QEMU_AUDIO_END 0 488 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1 489 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2 490 491 492 /***************************************************************************** 493 * 494 * Internal APIs 495 * 496 *****************************************************************************/ 497 498 /* Event loop functions */ 499 void vnc_client_read(void *opaque); 500 void vnc_client_write(void *opaque); 501 502 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen); 503 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen); 504 505 /* Protocol I/O functions */ 506 void vnc_write(VncState *vs, const void *data, size_t len); 507 void vnc_write_u32(VncState *vs, uint32_t value); 508 void vnc_write_s32(VncState *vs, int32_t value); 509 void vnc_write_u16(VncState *vs, uint16_t value); 510 void vnc_write_u8(VncState *vs, uint8_t value); 511 void vnc_flush(VncState *vs); 512 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting); 513 void vnc_disconnect_finish(VncState *vs); 514 void vnc_init_state(VncState *vs); 515 516 517 /* Buffer I/O functions */ 518 uint32_t read_u32(uint8_t *data, size_t offset); 519 520 /* Protocol stage functions */ 521 void vnc_client_error(VncState *vs); 522 int vnc_client_io_error(VncState *vs, int ret, int last_errno); 523 524 void start_client_init(VncState *vs); 525 void start_auth_vnc(VncState *vs); 526 527 /* Buffer management */ 528 void buffer_reserve(Buffer *buffer, size_t len); 529 void buffer_reset(Buffer *buffer); 530 void buffer_free(Buffer *buffer); 531 void buffer_append(Buffer *buffer, const void *data, size_t len); 532 void buffer_advance(Buffer *buf, size_t len); 533 uint8_t *buffer_end(Buffer *buffer); 534 535 536 /* Misc helpers */ 537 538 char *vnc_socket_local_addr(const char *format, int fd); 539 char *vnc_socket_remote_addr(const char *format, int fd); 540 541 static inline uint32_t vnc_has_feature(VncState *vs, int feature) { 542 return (vs->features & (1 << feature)); 543 } 544 545 /* Framebuffer */ 546 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h, 547 int32_t encoding); 548 549 /* server fb is in PIXMAN_x8r8g8b8 */ 550 #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8) 551 #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT)) 552 #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8) 553 554 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y); 555 int vnc_server_fb_stride(VncDisplay *vd); 556 557 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v); 558 double vnc_update_freq(VncState *vs, int x, int y, int w, int h); 559 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h); 560 561 /* Encodings */ 562 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 563 564 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 565 566 int vnc_hextile_send_framebuffer_update(VncState *vs, int x, 567 int y, int w, int h); 568 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic); 569 570 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size); 571 void vnc_zlib_zfree(void *x, void *addr); 572 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 573 void vnc_zlib_clear(VncState *vs); 574 575 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 576 int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y, 577 int w, int h); 578 void vnc_tight_clear(VncState *vs); 579 580 int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 581 int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 582 void vnc_zrle_clear(VncState *vs); 583 584 #endif /* __QEMU_VNC_H */ 585