[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;
};

typedef enum VncShareMode {
    VNC_SHARE_MODE_CONNECTING = 1,
    VNC_SHARE_MODE_SHARED,
    VNC_SHARE_MODE_EXCLUSIVE,
    VNC_SHARE_MODE_DISCONNECTED,
} VncShareMode;

typedef enum VncSharePolicy {
    VNC_SHARE_POLICY_IGNORE = 1,
    VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
    VNC_SHARE_POLICY_FORCE_SHARED,
} VncSharePolicy;

struct VncDisplay
{
    QTAILQ_HEAD(, VncState) clients;
    int num_exclusive;
    VncSharePolicy share_policy;
    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;
    VncShareMode share_mode;

    uint32_t vnc_encoding;

    int major;
    int minor;

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