13e230dd2SCorentin Chary /* 23e230dd2SCorentin Chary * QEMU VNC display driver 33e230dd2SCorentin Chary * 43e230dd2SCorentin Chary * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws> 53e230dd2SCorentin Chary * Copyright (C) 2006 Fabrice Bellard 63e230dd2SCorentin Chary * Copyright (C) 2009 Red Hat, Inc 73e230dd2SCorentin Chary * 83e230dd2SCorentin Chary * Permission is hereby granted, free of charge, to any person obtaining a copy 93e230dd2SCorentin Chary * of this software and associated documentation files (the "Software"), to deal 103e230dd2SCorentin Chary * in the Software without restriction, including without limitation the rights 113e230dd2SCorentin Chary * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 123e230dd2SCorentin Chary * copies of the Software, and to permit persons to whom the Software is 133e230dd2SCorentin Chary * furnished to do so, subject to the following conditions: 143e230dd2SCorentin Chary * 153e230dd2SCorentin Chary * The above copyright notice and this permission notice shall be included in 163e230dd2SCorentin Chary * all copies or substantial portions of the Software. 173e230dd2SCorentin Chary * 183e230dd2SCorentin Chary * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 193e230dd2SCorentin Chary * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 203e230dd2SCorentin Chary * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 213e230dd2SCorentin Chary * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 223e230dd2SCorentin Chary * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 233e230dd2SCorentin Chary * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 243e230dd2SCorentin Chary * THE SOFTWARE. 253e230dd2SCorentin Chary */ 263e230dd2SCorentin Chary 272a6a4076SMarkus Armbruster #ifndef QEMU_VNC_H 282a6a4076SMarkus Armbruster #define QEMU_VNC_H 293e230dd2SCorentin Chary 303e230dd2SCorentin Chary #include "qemu-common.h" 319af23989SMarkus Armbruster #include "qapi/qapi-types-ui.h" 321de7afc9SPaolo Bonzini #include "qemu/queue.h" 331de7afc9SPaolo Bonzini #include "qemu/thread.h" 3428ecbaeeSPaolo Bonzini #include "ui/console.h" 353e230dd2SCorentin Chary #include "audio/audio.h" 361de7afc9SPaolo Bonzini #include "qemu/bitmap.h" 373e305e4aSDaniel P. Berrange #include "crypto/tlssession.h" 3888c5f205SDaniel P. Berrange #include "qemu/buffer.h" 3904d2529dSDaniel P. Berrange #include "io/channel-socket.h" 402cc45228SDaniel P. Berrange #include "io/channel-tls.h" 4113e1d0e7SDaniel P. Berrange #include "io/net-listener.h" 423e230dd2SCorentin Chary #include <zlib.h> 433e230dd2SCorentin Chary 443e230dd2SCorentin Chary #include "keymaps.h" 45148954faSCorentin Chary #include "vnc-palette.h" 46148954faSCorentin Chary #include "vnc-enc-zrle.h" 47*c2f2ba49SGerd Hoffmann #include "ui/kbd-state.h" 483e230dd2SCorentin Chary 493e230dd2SCorentin Chary // #define _VNC_DEBUG 1 503e230dd2SCorentin Chary 513e230dd2SCorentin Chary #ifdef _VNC_DEBUG 523e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0) 533e230dd2SCorentin Chary #else 543e230dd2SCorentin Chary #define VNC_DEBUG(fmt, ...) do { } while (0) 553e230dd2SCorentin Chary #endif 563e230dd2SCorentin Chary 573e230dd2SCorentin Chary /***************************************************************************** 583e230dd2SCorentin Chary * 593e230dd2SCorentin Chary * Core data structures 603e230dd2SCorentin Chary * 613e230dd2SCorentin Chary *****************************************************************************/ 623e230dd2SCorentin Chary 633e230dd2SCorentin Chary typedef struct VncState VncState; 64bd023f95SCorentin Chary typedef struct VncJob VncJob; 65bd023f95SCorentin Chary typedef struct VncRect VncRect; 66bd023f95SCorentin Chary typedef struct VncRectEntry VncRectEntry; 673e230dd2SCorentin Chary 683e230dd2SCorentin Chary typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len); 693e230dd2SCorentin Chary 709f64916dSGerd Hoffmann typedef void VncWritePixels(VncState *vs, void *data, int size); 713e230dd2SCorentin Chary 723e230dd2SCorentin Chary typedef void VncSendHextileTile(VncState *vs, 733e230dd2SCorentin Chary int x, int y, int w, int h, 743e230dd2SCorentin Chary void *last_bg, 753e230dd2SCorentin Chary void *last_fg, 763e230dd2SCorentin Chary int *has_bg, int *has_fg); 773e230dd2SCorentin Chary 78b4c85ddcSPeter Lieven /* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented 79bea60dd7SPeter Lieven * by one bit in the dirty bitmap, should be a power of 2 */ 80b4c85ddcSPeter Lieven #define VNC_DIRTY_PIXELS_PER_BIT 16 81b4c85ddcSPeter Lieven 82bea60dd7SPeter Lieven /* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */ 83bea60dd7SPeter Lieven 84bea60dd7SPeter Lieven #define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT) 85bea60dd7SPeter Lieven #define VNC_MAX_HEIGHT 2048 86bea60dd7SPeter Lieven 8723bfe28fSStefan Weil /* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */ 88b4c85ddcSPeter Lieven #define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT) 893e230dd2SCorentin Chary 9012b316d4SPeter Lieven /* VNC_DIRTY_BPL (BPL = bits per line) might be greater than 9112b316d4SPeter Lieven * VNC_DIRTY_BITS due to alignment */ 9212b316d4SPeter Lieven #define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE) 9312b316d4SPeter Lieven 94999342a0SCorentin Chary #define VNC_STAT_RECT 64 95999342a0SCorentin Chary #define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT) 96999342a0SCorentin Chary #define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT) 97999342a0SCorentin Chary 983e230dd2SCorentin Chary #define VNC_AUTH_CHALLENGE_SIZE 16 993e230dd2SCorentin Chary 1003e230dd2SCorentin Chary typedef struct VncDisplay VncDisplay; 1013e230dd2SCorentin Chary 1023e230dd2SCorentin Chary #include "vnc-auth-vencrypt.h" 1033e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 1043e230dd2SCorentin Chary #include "vnc-auth-sasl.h" 1053e230dd2SCorentin Chary #endif 1067536ee4bSTim Hardeck #include "vnc-ws.h" 1073e230dd2SCorentin Chary 108999342a0SCorentin Chary struct VncRectStat 109999342a0SCorentin Chary { 110999342a0SCorentin Chary /* time of last 10 updates, to find update frequency */ 111999342a0SCorentin Chary struct timeval times[10]; 112999342a0SCorentin Chary int idx; 113999342a0SCorentin Chary 114999342a0SCorentin Chary double freq; /* Update frequency (in Hz) */ 115999342a0SCorentin Chary bool updated; /* Already updated during this refresh */ 116999342a0SCorentin Chary }; 117999342a0SCorentin Chary 118999342a0SCorentin Chary typedef struct VncRectStat VncRectStat; 119999342a0SCorentin Chary 1203e230dd2SCorentin Chary struct VncSurface 1213e230dd2SCorentin Chary { 122999342a0SCorentin Chary struct timeval last_freq_check; 123bea60dd7SPeter Lieven DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], 124bea60dd7SPeter Lieven VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT); 125999342a0SCorentin Chary VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS]; 1269f64916dSGerd Hoffmann pixman_image_t *fb; 1279f64916dSGerd Hoffmann pixman_format_code_t format; 1283e230dd2SCorentin Chary }; 1293e230dd2SCorentin Chary 1308cf36489SGerd Hoffmann typedef enum VncShareMode { 1318cf36489SGerd Hoffmann VNC_SHARE_MODE_CONNECTING = 1, 1328cf36489SGerd Hoffmann VNC_SHARE_MODE_SHARED, 1338cf36489SGerd Hoffmann VNC_SHARE_MODE_EXCLUSIVE, 1348cf36489SGerd Hoffmann VNC_SHARE_MODE_DISCONNECTED, 1358cf36489SGerd Hoffmann } VncShareMode; 1368cf36489SGerd Hoffmann 1378cf36489SGerd Hoffmann typedef enum VncSharePolicy { 1388cf36489SGerd Hoffmann VNC_SHARE_POLICY_IGNORE = 1, 1398cf36489SGerd Hoffmann VNC_SHARE_POLICY_ALLOW_EXCLUSIVE, 1408cf36489SGerd Hoffmann VNC_SHARE_POLICY_FORCE_SHARED, 1418cf36489SGerd Hoffmann } VncSharePolicy; 1428cf36489SGerd Hoffmann 1433e230dd2SCorentin Chary struct VncDisplay 1443e230dd2SCorentin Chary { 1453e230dd2SCorentin Chary QTAILQ_HEAD(, VncState) clients; 146e5f34cddSGerd Hoffmann int num_connecting; 147e5f34cddSGerd Hoffmann int num_shared; 1488cf36489SGerd Hoffmann int num_exclusive; 149e5f34cddSGerd Hoffmann int connections_limit; 1508cf36489SGerd Hoffmann VncSharePolicy share_policy; 15113e1d0e7SDaniel P. Berrange QIONetListener *listener; 15213e1d0e7SDaniel P. Berrange QIONetListener *wslistener; 153d39fa6d8SGerd Hoffmann DisplaySurface *ds; 15421ef45d7SGerd Hoffmann DisplayChangeListener dcl; 1553e230dd2SCorentin Chary kbd_layout_t *kbd_layout; 1563e230dd2SCorentin Chary int lock_key_sync; 157a54f0d2bSPierre Ossman QEMUPutLEDEntry *led; 158a54f0d2bSPierre Ossman int ledstate; 159*c2f2ba49SGerd Hoffmann QKbdState *kbd; 160bd023f95SCorentin Chary QemuMutex mutex; 1613e230dd2SCorentin Chary 1623e230dd2SCorentin Chary QEMUCursor *cursor; 1633e230dd2SCorentin Chary int cursor_msize; 1643e230dd2SCorentin Chary uint8_t *cursor_mask; 1653e230dd2SCorentin Chary 1663e230dd2SCorentin Chary struct VncSurface guest; /* guest visible surface (aka ds->surface) */ 1679f64916dSGerd Hoffmann pixman_image_t *server; /* vnc server surface */ 1683e230dd2SCorentin Chary 169d616ccc5SGerd Hoffmann const char *id; 170d616ccc5SGerd Hoffmann QTAILQ_ENTRY(VncDisplay) next; 171bf7aa45eSGerd Hoffmann bool is_unix; 1723e230dd2SCorentin Chary char *password; 1733c9405a0SGerd Hoffmann time_t expires; 1743e230dd2SCorentin Chary int auth; 175d169f04bSDaniel P. Berrange int subauth; /* Used by VeNCrypt */ 176f9148c8aSDaniel P. Berrange int ws_auth; /* Used by websockets */ 177eda24e18SDaniel P. Berrange int ws_subauth; /* Used by websockets */ 1783e230dd2SCorentin Chary bool lossy; 17980e0c8c3SCorentin Chary bool non_adaptive; 1803e305e4aSDaniel P. Berrange QCryptoTLSCreds *tlscreds; 1813e305e4aSDaniel P. Berrange char *tlsaclname; 1823e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 1833e230dd2SCorentin Chary VncDisplaySASL sasl; 1843e230dd2SCorentin Chary #endif 1853e230dd2SCorentin Chary }; 1863e230dd2SCorentin Chary 187d1af0e05SCorentin Chary typedef struct VncTight { 188d1af0e05SCorentin Chary int type; 189d1af0e05SCorentin Chary uint8_t quality; 190d1af0e05SCorentin Chary uint8_t compression; 191d1af0e05SCorentin Chary uint8_t pixel24; 192d1af0e05SCorentin Chary Buffer tight; 193d1af0e05SCorentin Chary Buffer tmp; 194d1af0e05SCorentin Chary Buffer zlib; 195d1af0e05SCorentin Chary Buffer gradient; 196d1af0e05SCorentin Chary #ifdef CONFIG_VNC_JPEG 197d1af0e05SCorentin Chary Buffer jpeg; 198d1af0e05SCorentin Chary #endif 199d1af0e05SCorentin Chary #ifdef CONFIG_VNC_PNG 200d1af0e05SCorentin Chary Buffer png; 201d1af0e05SCorentin Chary #endif 202d1af0e05SCorentin Chary int levels[4]; 203d1af0e05SCorentin Chary z_stream stream[4]; 204d1af0e05SCorentin Chary } VncTight; 205d1af0e05SCorentin Chary 206d1af0e05SCorentin Chary typedef struct VncHextile { 207d1af0e05SCorentin Chary VncSendHextileTile *send_tile; 208d1af0e05SCorentin Chary } VncHextile; 209d1af0e05SCorentin Chary 210d1af0e05SCorentin Chary typedef struct VncZlib { 211d1af0e05SCorentin Chary Buffer zlib; 212d1af0e05SCorentin Chary Buffer tmp; 213d1af0e05SCorentin Chary z_stream stream; 214d1af0e05SCorentin Chary int level; 215d1af0e05SCorentin Chary } VncZlib; 216d1af0e05SCorentin Chary 217148954faSCorentin Chary typedef struct VncZrle { 218148954faSCorentin Chary int type; 219148954faSCorentin Chary Buffer fb; 220148954faSCorentin Chary Buffer zrle; 221148954faSCorentin Chary Buffer tmp; 222148954faSCorentin Chary Buffer zlib; 223148954faSCorentin Chary z_stream stream; 224148954faSCorentin Chary VncPalette palette; 225148954faSCorentin Chary } VncZrle; 226148954faSCorentin Chary 227148954faSCorentin Chary typedef struct VncZywrle { 228148954faSCorentin Chary int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT]; 229148954faSCorentin Chary } VncZywrle; 230148954faSCorentin Chary 231bd023f95SCorentin Chary struct VncRect 232bd023f95SCorentin Chary { 233bd023f95SCorentin Chary int x; 234bd023f95SCorentin Chary int y; 235bd023f95SCorentin Chary int w; 236bd023f95SCorentin Chary int h; 237bd023f95SCorentin Chary }; 238bd023f95SCorentin Chary 239bd023f95SCorentin Chary struct VncRectEntry 240bd023f95SCorentin Chary { 241bd023f95SCorentin Chary struct VncRect rect; 242bd023f95SCorentin Chary QLIST_ENTRY(VncRectEntry) next; 243bd023f95SCorentin Chary }; 244bd023f95SCorentin Chary 245bd023f95SCorentin Chary struct VncJob 246bd023f95SCorentin Chary { 247bd023f95SCorentin Chary VncState *vs; 248bd023f95SCorentin Chary 249bd023f95SCorentin Chary QLIST_HEAD(, VncRectEntry) rectangles; 250bd023f95SCorentin Chary QTAILQ_ENTRY(VncJob) next; 251bd023f95SCorentin Chary }; 252bd023f95SCorentin Chary 253fef1bbadSDaniel P. Berrange typedef enum { 254fef1bbadSDaniel P. Berrange VNC_STATE_UPDATE_NONE, 255fef1bbadSDaniel P. Berrange VNC_STATE_UPDATE_INCREMENTAL, 256fef1bbadSDaniel P. Berrange VNC_STATE_UPDATE_FORCE, 257fef1bbadSDaniel P. Berrange } VncStateUpdate; 258fef1bbadSDaniel P. Berrange 259f31f9c10SGerd Hoffmann #define VNC_MAGIC ((uint64_t)0x05b3f069b3d204bb) 260f31f9c10SGerd Hoffmann 2613e230dd2SCorentin Chary struct VncState 2623e230dd2SCorentin Chary { 263f31f9c10SGerd Hoffmann uint64_t magic; 26404d2529dSDaniel P. Berrange QIOChannelSocket *sioc; /* The underlying socket */ 26504d2529dSDaniel P. Berrange QIOChannel *ioc; /* The channel currently used for I/O */ 26604d2529dSDaniel P. Berrange guint ioc_tag; 26704d2529dSDaniel P. Berrange gboolean disconnecting; 2683e230dd2SCorentin Chary 26923bfe28fSStefan Weil DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS); 2707d964c9dSCorentin Chary uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in 2717d964c9dSCorentin Chary * vnc-jobs-async.c */ 2723e230dd2SCorentin Chary 2733e230dd2SCorentin Chary VncDisplay *vd; 274fef1bbadSDaniel P. Berrange VncStateUpdate update; /* Most recent pending request from client */ 275ada8d2e4SDaniel P. Berrange VncStateUpdate job_update; /* Currently processed by job thread */ 27663658280SGerd Hoffmann int has_dirty; 2773e230dd2SCorentin Chary uint32_t features; 2783e230dd2SCorentin Chary int absolute; 2793e230dd2SCorentin Chary int last_x; 2803e230dd2SCorentin Chary int last_y; 28114768ebaSGerd Hoffmann uint32_t last_bmask; 2824c956bd8SDaniel P. Berrange size_t client_width; /* limited to u16 by RFB proto */ 2834c956bd8SDaniel P. Berrange size_t client_height; /* limited to u16 by RFB proto */ 2848cf36489SGerd Hoffmann VncShareMode share_mode; 2853e230dd2SCorentin Chary 2863e230dd2SCorentin Chary uint32_t vnc_encoding; 2873e230dd2SCorentin Chary 2883e230dd2SCorentin Chary int major; 2893e230dd2SCorentin Chary int minor; 2903e230dd2SCorentin Chary 2917e7e2ebcSDaniel P. Berrange int auth; 292d169f04bSDaniel P. Berrange int subauth; /* Used by VeNCrypt */ 2933e230dd2SCorentin Chary char challenge[VNC_AUTH_CHALLENGE_SIZE]; 2942cc45228SDaniel P. Berrange QCryptoTLSSession *tls; /* Borrowed pointer from channel, don't free */ 2953e230dd2SCorentin Chary #ifdef CONFIG_VNC_SASL 2963e230dd2SCorentin Chary VncStateSASL sasl; 2973e230dd2SCorentin Chary #endif 2987536ee4bSTim Hardeck bool encode_ws; 2997536ee4bSTim Hardeck bool websocket; 3003e230dd2SCorentin Chary 30105eb4a25SMarc-André Lureau #ifdef CONFIG_VNC 302fb6ba0d5SWenchao Xia VncClientInfo *info; 30305eb4a25SMarc-André Lureau #endif 3043e230dd2SCorentin Chary 305ada8d2e4SDaniel P. Berrange /* Job thread bottom half has put data for a forced update 306ada8d2e4SDaniel P. Berrange * into the output buffer. This offset points to the end of 307ada8d2e4SDaniel P. Berrange * the update data in the output buffer. This lets us determine 308ada8d2e4SDaniel P. Berrange * when a force update is fully sent to the client, allowing 309ada8d2e4SDaniel P. Berrange * us to process further forced updates. */ 310ada8d2e4SDaniel P. Berrange size_t force_update_offset; 311e2b72cb6SDaniel P. Berrange /* We allow multiple incremental updates or audio capture 312e2b72cb6SDaniel P. Berrange * samples to be queued in output buffer, provided the 313e2b72cb6SDaniel P. Berrange * buffer size doesn't exceed this threshold. The value 314e2b72cb6SDaniel P. Berrange * is calculating dynamically based on framebuffer size 315e2b72cb6SDaniel P. Berrange * and audio sample settings in vnc_update_throttle_offset() */ 316e2b72cb6SDaniel P. Berrange size_t throttle_output_offset; 3173e230dd2SCorentin Chary Buffer output; 3183e230dd2SCorentin Chary Buffer input; 3193e230dd2SCorentin Chary /* current output mode information */ 3203e230dd2SCorentin Chary VncWritePixels *write_pixels; 3219f64916dSGerd Hoffmann PixelFormat client_pf; 3229f64916dSGerd Hoffmann pixman_format_code_t client_format; 3239f64916dSGerd Hoffmann bool client_be; 3243e230dd2SCorentin Chary 3253e230dd2SCorentin Chary CaptureVoiceOut *audio_cap; 3263e230dd2SCorentin Chary struct audsettings as; 3273e230dd2SCorentin Chary 3283e230dd2SCorentin Chary VncReadEvent *read_handler; 3293e230dd2SCorentin Chary size_t read_handler_expect; 3303e230dd2SCorentin Chary 331bd023f95SCorentin Chary bool abort; 332bd023f95SCorentin Chary QemuMutex output_mutex; 333175b2a6eSCorentin Chary QEMUBH *bh; 334175b2a6eSCorentin Chary Buffer jobs_buffer; 335bd023f95SCorentin Chary 336bd023f95SCorentin Chary /* Encoding specific, if you add something here, don't forget to 337bd023f95SCorentin Chary * update vnc_async_encoding_start() 338bd023f95SCorentin Chary */ 339d1af0e05SCorentin Chary VncTight tight; 340d1af0e05SCorentin Chary VncZlib zlib; 341d1af0e05SCorentin Chary VncHextile hextile; 342148954faSCorentin Chary VncZrle zrle; 343148954faSCorentin Chary VncZywrle zywrle; 3443e230dd2SCorentin Chary 3453e230dd2SCorentin Chary Notifier mouse_mode_notifier; 3463e230dd2SCorentin Chary 3473e230dd2SCorentin Chary QTAILQ_ENTRY(VncState) next; 3483e230dd2SCorentin Chary }; 3493e230dd2SCorentin Chary 3503e230dd2SCorentin Chary 3513e230dd2SCorentin Chary /***************************************************************************** 3523e230dd2SCorentin Chary * 3533e230dd2SCorentin Chary * Authentication modes 3543e230dd2SCorentin Chary * 3553e230dd2SCorentin Chary *****************************************************************************/ 3563e230dd2SCorentin Chary 3573e230dd2SCorentin Chary enum { 3583e230dd2SCorentin Chary VNC_AUTH_INVALID = 0, 3593e230dd2SCorentin Chary VNC_AUTH_NONE = 1, 3603e230dd2SCorentin Chary VNC_AUTH_VNC = 2, 3613e230dd2SCorentin Chary VNC_AUTH_RA2 = 5, 3623e230dd2SCorentin Chary VNC_AUTH_RA2NE = 6, 3633e230dd2SCorentin Chary VNC_AUTH_TIGHT = 16, 3643e230dd2SCorentin Chary VNC_AUTH_ULTRA = 17, 3653e230dd2SCorentin Chary VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */ 3663e230dd2SCorentin Chary VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */ 3673e230dd2SCorentin Chary VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */ 3683e230dd2SCorentin Chary }; 3693e230dd2SCorentin Chary 3703e230dd2SCorentin Chary enum { 3713e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_PLAIN = 256, 3723e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSNONE = 257, 3733e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSVNC = 258, 3743e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSPLAIN = 259, 3753e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509NONE = 260, 3763e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509VNC = 261, 3773e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509PLAIN = 262, 3783e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_X509SASL = 263, 3793e230dd2SCorentin Chary VNC_AUTH_VENCRYPT_TLSSASL = 264, 3803e230dd2SCorentin Chary }; 3813e230dd2SCorentin Chary 3823e230dd2SCorentin Chary 3833e230dd2SCorentin Chary /***************************************************************************** 3843e230dd2SCorentin Chary * 3853e230dd2SCorentin Chary * Encoding types 3863e230dd2SCorentin Chary * 3873e230dd2SCorentin Chary *****************************************************************************/ 3883e230dd2SCorentin Chary 3893e230dd2SCorentin Chary #define VNC_ENCODING_RAW 0x00000000 3903e230dd2SCorentin Chary #define VNC_ENCODING_COPYRECT 0x00000001 3913e230dd2SCorentin Chary #define VNC_ENCODING_RRE 0x00000002 3923e230dd2SCorentin Chary #define VNC_ENCODING_CORRE 0x00000004 3933e230dd2SCorentin Chary #define VNC_ENCODING_HEXTILE 0x00000005 3943e230dd2SCorentin Chary #define VNC_ENCODING_ZLIB 0x00000006 3953e230dd2SCorentin Chary #define VNC_ENCODING_TIGHT 0x00000007 3963e230dd2SCorentin Chary #define VNC_ENCODING_ZLIBHEX 0x00000008 3973e230dd2SCorentin Chary #define VNC_ENCODING_TRLE 0x0000000f 3983e230dd2SCorentin Chary #define VNC_ENCODING_ZRLE 0x00000010 3993e230dd2SCorentin Chary #define VNC_ENCODING_ZYWRLE 0x00000011 4003e230dd2SCorentin Chary #define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */ 4013e230dd2SCorentin Chary #define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */ 4023e230dd2SCorentin Chary #define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */ 4033e230dd2SCorentin Chary #define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */ 4043e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */ 4053e230dd2SCorentin Chary #define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */ 4063e230dd2SCorentin Chary #define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */ 4073e230dd2SCorentin Chary #define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */ 4083e230dd2SCorentin Chary #define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */ 4093e230dd2SCorentin Chary #define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */ 410efe556adSCorentin Chary #define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */ 411ab99e5c1SLei Li #define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */ 4123e230dd2SCorentin Chary #define VNC_ENCODING_WMVi 0x574D5669 4133e230dd2SCorentin Chary 4143e230dd2SCorentin Chary /***************************************************************************** 4153e230dd2SCorentin Chary * 4163e230dd2SCorentin Chary * Other tight constants 4173e230dd2SCorentin Chary * 4183e230dd2SCorentin Chary *****************************************************************************/ 4193e230dd2SCorentin Chary 4203e230dd2SCorentin Chary /* 4213e230dd2SCorentin Chary * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC. 4223e230dd2SCorentin Chary */ 4233e230dd2SCorentin Chary 4243e230dd2SCorentin Chary #define VNC_TIGHT_CCB_RESET_MASK (0x0f) 4253e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4) 4263e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4) 4273e230dd2SCorentin Chary #define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4) 428efe556adSCorentin Chary #define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4) 4293e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4) 4303e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4) 4313e230dd2SCorentin Chary #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4) 4323e230dd2SCorentin Chary 4333e230dd2SCorentin Chary /***************************************************************************** 4343e230dd2SCorentin Chary * 4353e230dd2SCorentin Chary * Features 4363e230dd2SCorentin Chary * 4373e230dd2SCorentin Chary *****************************************************************************/ 4383e230dd2SCorentin Chary 4393e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE 0 4403e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE 1 4413e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE 2 4423e230dd2SCorentin Chary #define VNC_FEATURE_WMVI 3 4433e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT 4 4443e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB 5 4453e230dd2SCorentin Chary #define VNC_FEATURE_COPYRECT 6 4463e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR 7 447efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG 8 448148954faSCorentin Chary #define VNC_FEATURE_ZRLE 9 449148954faSCorentin Chary #define VNC_FEATURE_ZYWRLE 10 450ab99e5c1SLei Li #define VNC_FEATURE_LED_STATE 11 4513e230dd2SCorentin Chary 4523e230dd2SCorentin Chary #define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE) 4533e230dd2SCorentin Chary #define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE) 4543e230dd2SCorentin Chary #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE) 4553e230dd2SCorentin Chary #define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI) 4563e230dd2SCorentin Chary #define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT) 4573e230dd2SCorentin Chary #define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB) 4583e230dd2SCorentin Chary #define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT) 4593e230dd2SCorentin Chary #define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR) 460efe556adSCorentin Chary #define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG) 461148954faSCorentin Chary #define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE) 462148954faSCorentin Chary #define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE) 463ab99e5c1SLei Li #define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE) 4643e230dd2SCorentin Chary 4653e230dd2SCorentin Chary 4663e230dd2SCorentin Chary /* Client -> Server message IDs */ 4673e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0 4683e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_ENCODINGS 2 4693e230dd2SCorentin Chary #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3 4703e230dd2SCorentin Chary #define VNC_MSG_CLIENT_KEY_EVENT 4 4713e230dd2SCorentin Chary #define VNC_MSG_CLIENT_POINTER_EVENT 5 4723e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CUT_TEXT 6 4733e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_0 127 4743e230dd2SCorentin Chary #define VNC_MSG_CLIENT_CALL_CONTROL 249 4753e230dd2SCorentin Chary #define VNC_MSG_CLIENT_XVP 250 4763e230dd2SCorentin Chary #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251 4773e230dd2SCorentin Chary #define VNC_MSG_CLIENT_TIGHT 252 4783e230dd2SCorentin Chary #define VNC_MSG_CLIENT_GII 253 4793e230dd2SCorentin Chary #define VNC_MSG_CLIENT_VMWARE_1 254 4803e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU 255 4813e230dd2SCorentin Chary 4823e230dd2SCorentin Chary /* Server -> Client message IDs */ 4833e230dd2SCorentin Chary #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0 4843e230dd2SCorentin Chary #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1 4853e230dd2SCorentin Chary #define VNC_MSG_SERVER_BELL 2 4863e230dd2SCorentin Chary #define VNC_MSG_SERVER_CUT_TEXT 3 4873e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_0 127 4883e230dd2SCorentin Chary #define VNC_MSG_SERVER_CALL_CONTROL 249 4893e230dd2SCorentin Chary #define VNC_MSG_SERVER_XVP 250 4903e230dd2SCorentin Chary #define VNC_MSG_SERVER_TIGHT 252 4913e230dd2SCorentin Chary #define VNC_MSG_SERVER_GII 253 4923e230dd2SCorentin Chary #define VNC_MSG_SERVER_VMWARE_1 254 4933e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU 255 4943e230dd2SCorentin Chary 4953e230dd2SCorentin Chary 4963e230dd2SCorentin Chary 4973e230dd2SCorentin Chary /* QEMU client -> server message IDs */ 4983e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0 4993e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO 1 5003e230dd2SCorentin Chary 5013e230dd2SCorentin Chary /* QEMU server -> client message IDs */ 5023e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO 1 5033e230dd2SCorentin Chary 5043e230dd2SCorentin Chary 5053e230dd2SCorentin Chary 5063e230dd2SCorentin Chary /* QEMU client -> server audio message IDs */ 5073e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0 5083e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1 5093e230dd2SCorentin Chary #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2 5103e230dd2SCorentin Chary 5113e230dd2SCorentin Chary /* QEMU server -> client audio message IDs */ 5123e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_END 0 5133e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1 5143e230dd2SCorentin Chary #define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2 5153e230dd2SCorentin Chary 5163e230dd2SCorentin Chary 5173e230dd2SCorentin Chary /***************************************************************************** 5183e230dd2SCorentin Chary * 5193e230dd2SCorentin Chary * Internal APIs 5203e230dd2SCorentin Chary * 5213e230dd2SCorentin Chary *****************************************************************************/ 5223e230dd2SCorentin Chary 5233e230dd2SCorentin Chary /* Event loop functions */ 52404d2529dSDaniel P. Berrange gboolean vnc_client_io(QIOChannel *ioc, 52504d2529dSDaniel P. Berrange GIOCondition condition, 52604d2529dSDaniel P. Berrange void *opaque); 5273e230dd2SCorentin Chary 52830b80fd5SDaniel P. Berrange size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen); 52930b80fd5SDaniel P. Berrange size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen); 5303e230dd2SCorentin Chary 5313e230dd2SCorentin Chary /* Protocol I/O functions */ 5323e230dd2SCorentin Chary void vnc_write(VncState *vs, const void *data, size_t len); 5333e230dd2SCorentin Chary void vnc_write_u32(VncState *vs, uint32_t value); 5343e230dd2SCorentin Chary void vnc_write_s32(VncState *vs, int32_t value); 5353e230dd2SCorentin Chary void vnc_write_u16(VncState *vs, uint16_t value); 5363e230dd2SCorentin Chary void vnc_write_u8(VncState *vs, uint8_t value); 5373e230dd2SCorentin Chary void vnc_flush(VncState *vs); 5383e230dd2SCorentin Chary void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting); 5397536ee4bSTim Hardeck void vnc_disconnect_finish(VncState *vs); 540dbee9897SDaniel P. Berrange void vnc_start_protocol(VncState *vs); 5413e230dd2SCorentin Chary 5423e230dd2SCorentin Chary 5433e230dd2SCorentin Chary /* Buffer I/O functions */ 5443e230dd2SCorentin Chary uint32_t read_u32(uint8_t *data, size_t offset); 5453e230dd2SCorentin Chary 5463e230dd2SCorentin Chary /* Protocol stage functions */ 5473e230dd2SCorentin Chary void vnc_client_error(VncState *vs); 54830b80fd5SDaniel P. Berrange size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp); 5493e230dd2SCorentin Chary 5503e230dd2SCorentin Chary void start_client_init(VncState *vs); 5513e230dd2SCorentin Chary void start_auth_vnc(VncState *vs); 5523e230dd2SCorentin Chary 5533e230dd2SCorentin Chary 5543e230dd2SCorentin Chary /* Misc helpers */ 5553e230dd2SCorentin Chary 556efe556adSCorentin Chary static inline uint32_t vnc_has_feature(VncState *vs, int feature) { 557efe556adSCorentin Chary return (vs->features & (1 << feature)); 558efe556adSCorentin Chary } 559efe556adSCorentin Chary 5603e230dd2SCorentin Chary /* Framebuffer */ 5613e230dd2SCorentin Chary void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h, 5623e230dd2SCorentin Chary int32_t encoding); 5633e230dd2SCorentin Chary 5649f64916dSGerd Hoffmann /* server fb is in PIXMAN_x8r8g8b8 */ 5659f64916dSGerd Hoffmann #define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8) 5669f64916dSGerd Hoffmann #define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT)) 5679f64916dSGerd Hoffmann #define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8) 5689f64916dSGerd Hoffmann 5699f64916dSGerd Hoffmann void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y); 5709f64916dSGerd Hoffmann int vnc_server_fb_stride(VncDisplay *vd); 5719f64916dSGerd Hoffmann 5723e230dd2SCorentin Chary void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v); 573999342a0SCorentin Chary double vnc_update_freq(VncState *vs, int x, int y, int w, int h); 5747d964c9dSCorentin Chary void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h); 5753e230dd2SCorentin Chary 5763e230dd2SCorentin Chary /* Encodings */ 577bd023f95SCorentin Chary int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 578bd023f95SCorentin Chary 5793e230dd2SCorentin Chary int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 5803e230dd2SCorentin Chary 5813e230dd2SCorentin Chary int vnc_hextile_send_framebuffer_update(VncState *vs, int x, 5823e230dd2SCorentin Chary int y, int w, int h); 5833e230dd2SCorentin Chary void vnc_hextile_set_pixel_conversion(VncState *vs, int generic); 5843e230dd2SCorentin Chary 5853e230dd2SCorentin Chary void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size); 5863e230dd2SCorentin Chary void vnc_zlib_zfree(void *x, void *addr); 5873e230dd2SCorentin Chary int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 5883e230dd2SCorentin Chary void vnc_zlib_clear(VncState *vs); 5893e230dd2SCorentin Chary 5903e230dd2SCorentin Chary int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 591efe556adSCorentin Chary int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y, 592efe556adSCorentin Chary int w, int h); 5933e230dd2SCorentin Chary void vnc_tight_clear(VncState *vs); 5943e230dd2SCorentin Chary 595148954faSCorentin Chary int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 596148954faSCorentin Chary int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h); 597148954faSCorentin Chary void vnc_zrle_clear(VncState *vs); 598148954faSCorentin Chary 5992a6a4076SMarkus Armbruster #endif /* QEMU_VNC_H */ 600