[qemu.git] / ui / vnc.h

/*
 * QEMU VNC display driver
 *
 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
 * Copyright (C) 2006 Fabrice Bellard
 * Copyright (C) 2009 Red Hat, Inc
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef __QEMU_VNC_H
#define __QEMU_VNC_H

#include "qemu-common.h"
#include "qemu-queue.h"
#ifdef CONFIG_VNC_THREAD
#include "qemu-thread.h"
#endif
#include "console.h"
#include "monitor.h"
#include "audio/audio.h"
#include "bitmap.h"
#include <zlib.h>
#include <stdbool.h>

#include "keymaps.h"
#include "vnc-palette.h"
#include "vnc-enc-zrle.h"

// #define _VNC_DEBUG 1

#ifdef _VNC_DEBUG
#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
#else
#define VNC_DEBUG(fmt, ...) do { } while (0)
#endif

/*****************************************************************************
 *
 * Core data structures
 *
 *****************************************************************************/

typedef struct Buffer
{
    size_t capacity;
    size_t offset;
    uint8_t *buffer;
} Buffer;

typedef struct VncState VncState;
typedef struct VncJob VncJob;
typedef struct VncRect VncRect;
typedef struct VncRectEntry VncRectEntry;

typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);

typedef void VncWritePixels(VncState *vs, struct PixelFormat *pf, void *data, int size);

typedef void VncSendHextileTile(VncState *vs,
                                int x, int y, int w, int h,
                                void *last_bg,
                                void *last_fg,
                                int *has_bg, int *has_fg);

/* VNC_MAX_WIDTH must be a multiple of 16. */
#define VNC_MAX_WIDTH 2560
#define VNC_MAX_HEIGHT 2048

/* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / 16)

#define VNC_STAT_RECT  64
#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)

#define VNC_AUTH_CHALLENGE_SIZE 16

typedef struct VncDisplay VncDisplay;

#ifdef CONFIG_VNC_TLS
#include "vnc-tls.h"
#include "vnc-auth-vencrypt.h"
#endif
#ifdef CONFIG_VNC_SASL
#include "vnc-auth-sasl.h"
#endif

struct VncRectStat
{
    /* time of last 10 updates, to find update frequency */
    struct timeval times[10];
    int idx;

    double freq;        /* Update frequency (in Hz) */
    bool updated;       /* Already updated during this refresh */
};

typedef struct VncRectStat VncRectStat;

struct VncSurface
{
    struct timeval last_freq_check;
    DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_MAX_WIDTH / 16);
    VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
    DisplaySurface *ds;
};

struct VncDisplay
{
    QTAILQ_HEAD(, VncState) clients;
    QEMUTimer *timer;
    int timer_interval;
    int lsock;
    DisplayState *ds;
    kbd_layout_t *kbd_layout;
    int lock_key_sync;
#ifdef CONFIG_VNC_THREAD
    QemuMutex mutex;
#endif

    QEMUCursor *cursor;
    int cursor_msize;
    uint8_t *cursor_mask;

    struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
    DisplaySurface *server;  /* vnc server surface */

    char *display;
    char *password;
    time_t expires;
    int auth;
    bool lossy;
    bool non_adaptive;
#ifdef CONFIG_VNC_TLS
    int subauth; /* Used by VeNCrypt */
    VncDisplayTLS tls;
#endif
#ifdef CONFIG_VNC_SASL
    VncDisplaySASL sasl;
#endif
};

typedef struct VncTight {
    int type;
    uint8_t quality;
    uint8_t compression;
    uint8_t pixel24;
    Buffer tight;
    Buffer tmp;
    Buffer zlib;
    Buffer gradient;
#ifdef CONFIG_VNC_JPEG
    Buffer jpeg;
#endif
#ifdef CONFIG_VNC_PNG
    Buffer png;
#endif
    int levels[4];
    z_stream stream[4];
} VncTight;

typedef struct VncHextile {
    VncSendHextileTile *send_tile;
} VncHextile;

typedef struct VncZlib {
    Buffer zlib;
    Buffer tmp;
    z_stream stream;
    int level;
} VncZlib;

typedef struct VncZrle {
    int type;
    Buffer fb;
    Buffer zrle;
    Buffer tmp;
    Buffer zlib;
    z_stream stream;
    VncPalette palette;
} VncZrle;

typedef struct VncZywrle {
    int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
} VncZywrle;

#ifdef CONFIG_VNC_THREAD
struct VncRect
{
    int x;
    int y;
    int w;
    int h;
};

struct VncRectEntry
{
    struct VncRect rect;
    QLIST_ENTRY(VncRectEntry) next;
};

struct VncJob
{
    VncState *vs;

    QLIST_HEAD(, VncRectEntry) rectangles;
    QTAILQ_ENTRY(VncJob) next;
};
#else
struct VncJob
{
    VncState *vs;
    int rectangles;
    size_t saved_offset;
};
#endif

struct VncState
{
    int csock;

    DisplayState *ds;
    DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
    uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
                           * vnc-jobs-async.c */

    VncDisplay *vd;
    int need_update;
    int force_update;
    uint32_t features;
    int absolute;
    int last_x;
    int last_y;
    int client_width;
    int client_height;

    uint32_t vnc_encoding;

    int major;
    int minor;

    char challenge[VNC_AUTH_CHALLENGE_SIZE];
#ifdef CONFIG_VNC_TLS
    VncStateTLS tls;
#endif
#ifdef CONFIG_VNC_SASL
    VncStateSASL sasl;
#endif

    QObject *info;

    Buffer output;
    Buffer input;
    /* current output mode information */
    VncWritePixels *write_pixels;
    DisplaySurface clientds;

    CaptureVoiceOut *audio_cap;
    struct audsettings as;

    VncReadEvent *read_handler;
    size_t read_handler_expect;
    /* input */
    uint8_t modifiers_state[256];
    QEMUPutLEDEntry *led;

    bool abort;
#ifndef CONFIG_VNC_THREAD
    VncJob job;
#else
    QemuMutex output_mutex;
#endif

    /* Encoding specific, if you add something here, don't forget to
     *  update vnc_async_encoding_start()
     */
    VncTight tight;
    VncZlib zlib;
    VncHextile hextile;
    VncZrle zrle;
    VncZywrle zywrle;

    Notifier mouse_mode_notifier;

    QTAILQ_ENTRY(VncState) next;
};


/*****************************************************************************
 *
 * Authentication modes
 *
 *****************************************************************************/

enum {
    VNC_AUTH_INVALID = 0,
    VNC_AUTH_NONE = 1,
    VNC_AUTH_VNC = 2,
    VNC_AUTH_RA2 = 5,
    VNC_AUTH_RA2NE = 6,
    VNC_AUTH_TIGHT = 16,
    VNC_AUTH_ULTRA = 17,
    VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
    VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
    VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
};

enum {
    VNC_AUTH_VENCRYPT_PLAIN = 256,
    VNC_AUTH_VENCRYPT_TLSNONE = 257,
    VNC_AUTH_VENCRYPT_TLSVNC = 258,
    VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
    VNC_AUTH_VENCRYPT_X509NONE = 260,
    VNC_AUTH_VENCRYPT_X509VNC = 261,
    VNC_AUTH_VENCRYPT_X509PLAIN = 262,
    VNC_AUTH_VENCRYPT_X509SASL = 263,
    VNC_AUTH_VENCRYPT_TLSSASL = 264,
};


/*****************************************************************************
 *
 * Encoding types
 *
 *****************************************************************************/

#define VNC_ENCODING_RAW                  0x00000000
#define VNC_ENCODING_COPYRECT             0x00000001
#define VNC_ENCODING_RRE                  0x00000002
#define VNC_ENCODING_CORRE                0x00000004
#define VNC_ENCODING_HEXTILE              0x00000005
#define VNC_ENCODING_ZLIB                 0x00000006
#define VNC_ENCODING_TIGHT                0x00000007
#define VNC_ENCODING_ZLIBHEX              0x00000008
#define VNC_ENCODING_TRLE                 0x0000000f
#define VNC_ENCODING_ZRLE                 0x00000010
#define VNC_ENCODING_ZYWRLE               0x00000011
#define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
#define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
#define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
#define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
#define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
#define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
#define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
#define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
#define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
#define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
#define VNC_ENCODING_TIGHT_PNG            0xFFFFFEFC /* -260 */
#define VNC_ENCODING_WMVi                 0x574D5669

/*****************************************************************************
 *
 * Other tight constants
 *
 *****************************************************************************/

/*
 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
 */

#define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
#define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
#define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
#define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
#define VNC_TIGHT_CCB_TYPE_PNG     (0x0A << 4)
#define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
#define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)

/*****************************************************************************
 *
 * Features
 *
 *****************************************************************************/

#define VNC_FEATURE_RESIZE                   0
#define VNC_FEATURE_HEXTILE                  1
#define VNC_FEATURE_POINTER_TYPE_CHANGE      2
#define VNC_FEATURE_WMVI                     3
#define VNC_FEATURE_TIGHT                    4
#define VNC_FEATURE_ZLIB                     5
#define VNC_FEATURE_COPYRECT                 6
#define VNC_FEATURE_RICH_CURSOR              7
#define VNC_FEATURE_TIGHT_PNG                8
#define VNC_FEATURE_ZRLE                     9
#define VNC_FEATURE_ZYWRLE                  10

#define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
#define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
#define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
#define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
#define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
#define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
#define VNC_FEATURE_RICH_CURSOR_MASK         (1 << VNC_FEATURE_RICH_CURSOR)
#define VNC_FEATURE_TIGHT_PNG_MASK           (1 << VNC_FEATURE_TIGHT_PNG)
#define VNC_FEATURE_ZRLE_MASK                (1 << VNC_FEATURE_ZRLE)
#define VNC_FEATURE_ZYWRLE_MASK              (1 << VNC_FEATURE_ZYWRLE)


/* Client -> Server message IDs */
#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT           0
#define VNC_MSG_CLIENT_SET_ENCODINGS              2
#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
#define VNC_MSG_CLIENT_KEY_EVENT                  4
#define VNC_MSG_CLIENT_POINTER_EVENT              5
#define VNC_MSG_CLIENT_CUT_TEXT                   6
#define VNC_MSG_CLIENT_VMWARE_0                   127
#define VNC_MSG_CLIENT_CALL_CONTROL               249
#define VNC_MSG_CLIENT_XVP                        250
#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE           251
#define VNC_MSG_CLIENT_TIGHT                      252
#define VNC_MSG_CLIENT_GII                        253
#define VNC_MSG_CLIENT_VMWARE_1                   254
#define VNC_MSG_CLIENT_QEMU                       255

/* Server -> Client message IDs */
#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE         0
#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES     1
#define VNC_MSG_SERVER_BELL                       2
#define VNC_MSG_SERVER_CUT_TEXT                   3
#define VNC_MSG_SERVER_VMWARE_0                   127
#define VNC_MSG_SERVER_CALL_CONTROL               249
#define VNC_MSG_SERVER_XVP                        250
#define VNC_MSG_SERVER_TIGHT                      252
#define VNC_MSG_SERVER_GII                        253
#define VNC_MSG_SERVER_VMWARE_1                   254
#define VNC_MSG_SERVER_QEMU                       255


/* QEMU client -> server message IDs */
#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT         0
#define VNC_MSG_CLIENT_QEMU_AUDIO                 1

/* QEMU server -> client message IDs */
#define VNC_MSG_SERVER_QEMU_AUDIO                 1


/* QEMU client -> server audio message IDs */
#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE          0
#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE         1
#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT      2

/* QEMU server -> client audio message IDs */
#define VNC_MSG_SERVER_QEMU_AUDIO_END             0
#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN           1
#define VNC_MSG_SERVER_QEMU_AUDIO_DATA            2


/*****************************************************************************
 *
 * Internal APIs
 *
 *****************************************************************************/

/* Event loop functions */
void vnc_client_read(void *opaque);
void vnc_client_write(void *opaque);

long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);

/* Protocol I/O functions */
void vnc_write(VncState *vs, const void *data, size_t len);
void vnc_write_u32(VncState *vs, uint32_t value);
void vnc_write_s32(VncState *vs, int32_t value);
void vnc_write_u16(VncState *vs, uint16_t value);
void vnc_write_u8(VncState *vs, uint8_t value);
void vnc_flush(VncState *vs);
void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);


/* Buffer I/O functions */
uint8_t read_u8(uint8_t *data, size_t offset);
uint16_t read_u16(uint8_t *data, size_t offset);
int32_t read_s32(uint8_t *data, size_t offset);
uint32_t read_u32(uint8_t *data, size_t offset);

/* Protocol stage functions */
void vnc_client_error(VncState *vs);
int vnc_client_io_error(VncState *vs, int ret, int last_errno);

void start_client_init(VncState *vs);
void start_auth_vnc(VncState *vs);

/* Buffer management */
void buffer_reserve(Buffer *buffer, size_t len);
int buffer_empty(Buffer *buffer);
uint8_t *buffer_end(Buffer *buffer);
void buffer_reset(Buffer *buffer);
void buffer_free(Buffer *buffer);
void buffer_append(Buffer *buffer, const void *data, size_t len);


/* Misc helpers */

char *vnc_socket_local_addr(const char *format, int fd);
char *vnc_socket_remote_addr(const char *format, int fd);

static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
    return (vs->features & (1 << feature));
}

/* Framebuffer */
void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
                            int32_t encoding);

void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);

/* Encodings */
int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);

int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);

int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
                                         int y, int w, int h);
void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);

void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
void vnc_zlib_zfree(void *x, void *addr);
int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
void vnc_zlib_clear(VncState *vs);

int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
                                          int w, int h);
void vnc_tight_clear(VncState *vs);

int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
void vnc_zrle_clear(VncState *vs);

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