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