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