[mirror_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"
#include "qemu/thread.h"
#include "ui/console.h"
#include "audio/audio.h"
#include "qemu/bitmap.h"
#include "crypto/tlssession.h"
#include "qemu/buffer.h"
#include "io/channel-socket.h"
#include "io/channel-tls.h"
#include <zlib.h>

#include "keymaps.h"
#include "vnc-palette.h"
#include "vnc-enc-zrle.h"
#include "qapi-types.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 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, 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_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
 * by one bit in the dirty bitmap, should be a power of 2 */
#define VNC_DIRTY_PIXELS_PER_BIT 16

/* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */

#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
#define VNC_MAX_HEIGHT 2048

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

/* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
 * VNC_DIRTY_BITS due to alignment */
#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)

#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;

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

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 / VNC_DIRTY_PIXELS_PER_BIT);
    VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
    pixman_image_t *fb;
    pixman_format_code_t format;
};

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_connecting;
    int num_shared;
    int num_exclusive;
    int connections_limit;
    VncSharePolicy share_policy;
    size_t nlsock;
    QIOChannelSocket **lsock;
    guint *lsock_tag;
    size_t nlwebsock;
    QIOChannelSocket **lwebsock;
    guint *lwebsock_tag;
    DisplaySurface *ds;
    DisplayChangeListener dcl;
    kbd_layout_t *kbd_layout;
    int lock_key_sync;
    QEMUPutLEDEntry *led;
    int ledstate;
    int key_delay_ms;
    QemuMutex mutex;

    QEMUCursor *cursor;
    int cursor_msize;
    uint8_t *cursor_mask;

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

    const char *id;
    QTAILQ_ENTRY(VncDisplay) next;
    bool is_unix;
    char *password;
    time_t expires;
    int auth;
    int subauth; /* Used by VeNCrypt */
    int ws_auth; /* Used by websockets */
    int ws_subauth; /* Used by websockets */
    bool lossy;
    bool non_adaptive;
    QCryptoTLSCreds *tlscreds;
    char *tlsaclname;
#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;

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

struct VncState
{
    QIOChannelSocket *sioc; /* The underlying socket */
    QIOChannel *ioc; /* The channel currently used for I/O */
    guint ioc_tag;
    gboolean disconnecting;

    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;
    int has_dirty;
    uint32_t features;
    int absolute;
    int last_x;
    int last_y;
    uint32_t last_bmask;
    int client_width;
    int client_height;
    VncShareMode share_mode;

    uint32_t vnc_encoding;

    int major;
    int minor;

    int auth;
    int subauth; /* Used by VeNCrypt */
    char challenge[VNC_AUTH_CHALLENGE_SIZE];
    QCryptoTLSSession *tls; /* Borrowed pointer from channel, don't free */
#ifdef CONFIG_VNC_SASL
    VncStateSASL sasl;
#endif
    bool encode_ws;
    bool websocket;

    VncClientInfo *info;

    Buffer output;
    Buffer input;
    /* current output mode information */
    VncWritePixels *write_pixels;
    PixelFormat client_pf;
    pixman_format_code_t client_format;
    bool client_be;

    CaptureVoiceOut *audio_cap;
    struct audsettings as;

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

    bool abort;
    QemuMutex output_mutex;
    QEMUBH *bh;
    Buffer jobs_buffer;

    /* 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_LED_STATE            0XFFFFFEFB /* -261 */
#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_LED_STATE               11

#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)
#define VNC_FEATURE_LED_STATE_MASK           (1 << VNC_FEATURE_LED_STATE)


/* 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 */
gboolean vnc_client_io(QIOChannel *ioc,
                       GIOCondition condition,
                       void *opaque);

ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
ssize_t 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);
void vnc_disconnect_finish(VncState *vs);
void vnc_start_protocol(VncState *vs);


/* Buffer I/O functions */
uint32_t read_u32(uint8_t *data, size_t offset);

/* Protocol stage functions */
void vnc_client_error(VncState *vs);
ssize_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp);

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


/* Misc helpers */

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);

/* server fb is in PIXMAN_x8r8g8b8 */
#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
#define VNC_SERVER_FB_BITS   (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
#define VNC_SERVER_FB_BYTES  ((VNC_SERVER_FB_BITS+7)/8)

void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
int vnc_server_fb_stride(VncDisplay *vd);

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
	1	/*
	2	* QEMU VNC display driver
	3	*
	4	* Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
	5	* Copyright (C) 2006 Fabrice Bellard
	6	* Copyright (C) 2009 Red Hat, Inc
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	21	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	24	* THE SOFTWARE.
	25	*/
	26
	27	#ifndef QEMU_VNC_H
	28	#define QEMU_VNC_H
	29
	30	#include "qemu-common.h"
	31	#include "qemu/queue.h"
	32	#include "qemu/thread.h"
	33	#include "ui/console.h"
	34	#include "audio/audio.h"
	35	#include "qemu/bitmap.h"
	36	#include "crypto/tlssession.h"
	37	#include "qemu/buffer.h"
	38	#include "io/channel-socket.h"
	39	#include "io/channel-tls.h"
	40	#include <zlib.h>
	41
	42	#include "keymaps.h"
	43	#include "vnc-palette.h"
	44	#include "vnc-enc-zrle.h"
	45	#include "qapi-types.h"
	46
	47	// #define _VNC_DEBUG 1
	48
	49	#ifdef _VNC_DEBUG
	50	#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
	51	#else
	52	#define VNC_DEBUG(fmt, ...) do { } while (0)
	53	#endif
	54
	55	/*****************************************************************************
	56	*
	57	* Core data structures
	58	*
	59	*****************************************************************************/
	60
	61	typedef struct VncState VncState;
	62	typedef struct VncJob VncJob;
	63	typedef struct VncRect VncRect;
	64	typedef struct VncRectEntry VncRectEntry;
	65
	66	typedef int VncReadEvent(VncState vs, uint8_t data, size_t len);
	67
	68	typedef void VncWritePixels(VncState vs, void data, int size);
	69
	70	typedef void VncSendHextileTile(VncState *vs,
	71	int x, int y, int w, int h,
	72	void *last_bg,
	73	void *last_fg,
	74	int has_bg, int has_fg);
	75
	76	/* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
	77	* by one bit in the dirty bitmap, should be a power of 2 */
	78	#define VNC_DIRTY_PIXELS_PER_BIT 16
	79
	80	/* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
	81
	82	#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
	83	#define VNC_MAX_HEIGHT 2048
	84
	85	/* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
	86	#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
	87
	88	/* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
	89	* VNC_DIRTY_BITS due to alignment */
	90	#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
	91
	92	#define VNC_STAT_RECT 64
	93	#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
	94	#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
	95
	96	#define VNC_AUTH_CHALLENGE_SIZE 16
	97
	98	typedef struct VncDisplay VncDisplay;
	99
	100	#include "vnc-auth-vencrypt.h"
	101	#ifdef CONFIG_VNC_SASL
	102	#include "vnc-auth-sasl.h"
	103	#endif
	104	#include "vnc-ws.h"
	105
	106	struct VncRectStat
	107	{
	108	/* time of last 10 updates, to find update frequency */
	109	struct timeval times[10];
	110	int idx;
	111
	112	double freq; /* Update frequency (in Hz) */
	113	bool updated; /* Already updated during this refresh */
	114	};
	115
	116	typedef struct VncRectStat VncRectStat;
	117
	118	struct VncSurface
	119	{
	120	struct timeval last_freq_check;
	121	DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
	122	VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
	123	VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
	124	pixman_image_t *fb;
	125	pixman_format_code_t format;
	126	};
	127
	128	typedef enum VncShareMode {
	129	VNC_SHARE_MODE_CONNECTING = 1,
	130	VNC_SHARE_MODE_SHARED,
	131	VNC_SHARE_MODE_EXCLUSIVE,
	132	VNC_SHARE_MODE_DISCONNECTED,
	133	} VncShareMode;
	134
	135	typedef enum VncSharePolicy {
	136	VNC_SHARE_POLICY_IGNORE = 1,
	137	VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
	138	VNC_SHARE_POLICY_FORCE_SHARED,
	139	} VncSharePolicy;
	140
	141	struct VncDisplay
	142	{
	143	QTAILQ_HEAD(, VncState) clients;
	144	int num_connecting;
	145	int num_shared;
	146	int num_exclusive;
	147	int connections_limit;
	148	VncSharePolicy share_policy;
	149	size_t nlsock;
	150	QIOChannelSocket **lsock;
	151	guint *lsock_tag;
	152	size_t nlwebsock;
	153	QIOChannelSocket **lwebsock;
	154	guint *lwebsock_tag;
	155	DisplaySurface *ds;
	156	DisplayChangeListener dcl;
	157	kbd_layout_t *kbd_layout;
	158	int lock_key_sync;
	159	QEMUPutLEDEntry *led;
	160	int ledstate;
	161	int key_delay_ms;
	162	QemuMutex mutex;
	163
	164	QEMUCursor *cursor;
	165	int cursor_msize;
	166	uint8_t *cursor_mask;
	167
	168	struct VncSurface guest; /* guest visible surface (aka ds->surface) */
	169	pixman_image_t server; / vnc server surface */
	170
	171	const char *id;
	172	QTAILQ_ENTRY(VncDisplay) next;
	173	bool is_unix;
	174	char *password;
	175	time_t expires;
	176	int auth;
	177	int subauth; /* Used by VeNCrypt */
	178	int ws_auth; /* Used by websockets */
	179	int ws_subauth; /* Used by websockets */
	180	bool lossy;
	181	bool non_adaptive;
	182	QCryptoTLSCreds *tlscreds;
	183	char *tlsaclname;
	184	#ifdef CONFIG_VNC_SASL
	185	VncDisplaySASL sasl;
	186	#endif
	187	};
	188
	189	typedef struct VncTight {
	190	int type;
	191	uint8_t quality;
	192	uint8_t compression;
	193	uint8_t pixel24;
	194	Buffer tight;
	195	Buffer tmp;
	196	Buffer zlib;
	197	Buffer gradient;
	198	#ifdef CONFIG_VNC_JPEG
	199	Buffer jpeg;
	200	#endif
	201	#ifdef CONFIG_VNC_PNG
	202	Buffer png;
	203	#endif
	204	int levels[4];
	205	z_stream stream[4];
	206	} VncTight;
	207
	208	typedef struct VncHextile {
	209	VncSendHextileTile *send_tile;
	210	} VncHextile;
	211
	212	typedef struct VncZlib {
	213	Buffer zlib;
	214	Buffer tmp;
	215	z_stream stream;
	216	int level;
	217	} VncZlib;
	218
	219	typedef struct VncZrle {
	220	int type;
	221	Buffer fb;
	222	Buffer zrle;
	223	Buffer tmp;
	224	Buffer zlib;
	225	z_stream stream;
	226	VncPalette palette;
	227	} VncZrle;
	228
	229	typedef struct VncZywrle {
	230	int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
	231	} VncZywrle;
	232
	233	struct VncRect
	234	{
	235	int x;
	236	int y;
	237	int w;
	238	int h;
	239	};
	240
	241	struct VncRectEntry
	242	{
	243	struct VncRect rect;
	244	QLIST_ENTRY(VncRectEntry) next;
	245	};
	246
	247	struct VncJob
	248	{
	249	VncState *vs;
	250
	251	QLIST_HEAD(, VncRectEntry) rectangles;
	252	QTAILQ_ENTRY(VncJob) next;
	253	};
	254
	255	struct VncState
	256	{
	257	QIOChannelSocket sioc; / The underlying socket */
	258	QIOChannel ioc; / The channel currently used for I/O */
	259	guint ioc_tag;
	260	gboolean disconnecting;
	261
	262	DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
	263	uint8_t *lossy_rect; / Not an Array to avoid costly memcpy in
	264	* vnc-jobs-async.c */
	265
	266	VncDisplay *vd;
	267	int need_update;
	268	int force_update;
	269	int has_dirty;
	270	uint32_t features;
	271	int absolute;
	272	int last_x;
	273	int last_y;
	274	uint32_t last_bmask;
	275	int client_width;
	276	int client_height;
	277	VncShareMode share_mode;
	278
	279	uint32_t vnc_encoding;
	280
	281	int major;
	282	int minor;
	283
	284	int auth;
	285	int subauth; /* Used by VeNCrypt */
	286	char challenge[VNC_AUTH_CHALLENGE_SIZE];
	287	QCryptoTLSSession tls; / Borrowed pointer from channel, don't free */
	288	#ifdef CONFIG_VNC_SASL
	289	VncStateSASL sasl;
	290	#endif
	291	bool encode_ws;
	292	bool websocket;
	293
	294	VncClientInfo *info;
	295
	296	Buffer output;
	297	Buffer input;
	298	/* current output mode information */
	299	VncWritePixels *write_pixels;
	300	PixelFormat client_pf;
	301	pixman_format_code_t client_format;
	302	bool client_be;
	303
	304	CaptureVoiceOut *audio_cap;
	305	struct audsettings as;
	306
	307	VncReadEvent *read_handler;
	308	size_t read_handler_expect;
	309	/* input */
	310	uint8_t modifiers_state[256];
	311
	312	bool abort;
	313	QemuMutex output_mutex;
	314	QEMUBH *bh;
	315	Buffer jobs_buffer;
	316
	317	/* Encoding specific, if you add something here, don't forget to
	318	* update vnc_async_encoding_start()
	319	*/
	320	VncTight tight;
	321	VncZlib zlib;
	322	VncHextile hextile;
	323	VncZrle zrle;
	324	VncZywrle zywrle;
	325
	326	Notifier mouse_mode_notifier;
	327
	328	QTAILQ_ENTRY(VncState) next;
	329	};
	330
	331
	332	/*****************************************************************************
	333	*
	334	* Authentication modes
	335	*
	336	*****************************************************************************/
	337
	338	enum {
	339	VNC_AUTH_INVALID = 0,
	340	VNC_AUTH_NONE = 1,
	341	VNC_AUTH_VNC = 2,
	342	VNC_AUTH_RA2 = 5,
	343	VNC_AUTH_RA2NE = 6,
	344	VNC_AUTH_TIGHT = 16,
	345	VNC_AUTH_ULTRA = 17,
	346	VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
	347	VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
	348	VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
	349	};
	350
	351	enum {
	352	VNC_AUTH_VENCRYPT_PLAIN = 256,
	353	VNC_AUTH_VENCRYPT_TLSNONE = 257,
	354	VNC_AUTH_VENCRYPT_TLSVNC = 258,
	355	VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
	356	VNC_AUTH_VENCRYPT_X509NONE = 260,
	357	VNC_AUTH_VENCRYPT_X509VNC = 261,
	358	VNC_AUTH_VENCRYPT_X509PLAIN = 262,
	359	VNC_AUTH_VENCRYPT_X509SASL = 263,
	360	VNC_AUTH_VENCRYPT_TLSSASL = 264,
	361	};
	362
	363
	364	/*****************************************************************************
	365	*
	366	* Encoding types
	367	*
	368	*****************************************************************************/
	369
	370	#define VNC_ENCODING_RAW 0x00000000
	371	#define VNC_ENCODING_COPYRECT 0x00000001
	372	#define VNC_ENCODING_RRE 0x00000002
	373	#define VNC_ENCODING_CORRE 0x00000004
	374	#define VNC_ENCODING_HEXTILE 0x00000005
	375	#define VNC_ENCODING_ZLIB 0x00000006
	376	#define VNC_ENCODING_TIGHT 0x00000007
	377	#define VNC_ENCODING_ZLIBHEX 0x00000008
	378	#define VNC_ENCODING_TRLE 0x0000000f
	379	#define VNC_ENCODING_ZRLE 0x00000010
	380	#define VNC_ENCODING_ZYWRLE 0x00000011
	381	#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
	382	#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
	383	#define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
	384	#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
	385	#define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
	386	#define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
	387	#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
	388	#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
	389	#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
	390	#define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
	391	#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
	392	#define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
	393	#define VNC_ENCODING_WMVi 0x574D5669
	394
	395	/*****************************************************************************
	396	*
	397	* Other tight constants
	398	*
	399	*****************************************************************************/
	400
	401	/*
	402	* Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
	403	*/
	404
	405	#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
	406	#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
	407	#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
	408	#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
	409	#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
	410	#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
	411	#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
	412	#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
	413
	414	/*****************************************************************************
	415	*
	416	* Features
	417	*
	418	*****************************************************************************/
	419
	420	#define VNC_FEATURE_RESIZE 0
	421	#define VNC_FEATURE_HEXTILE 1
	422	#define VNC_FEATURE_POINTER_TYPE_CHANGE 2
	423	#define VNC_FEATURE_WMVI 3
	424	#define VNC_FEATURE_TIGHT 4
	425	#define VNC_FEATURE_ZLIB 5
	426	#define VNC_FEATURE_COPYRECT 6
	427	#define VNC_FEATURE_RICH_CURSOR 7
	428	#define VNC_FEATURE_TIGHT_PNG 8
	429	#define VNC_FEATURE_ZRLE 9
	430	#define VNC_FEATURE_ZYWRLE 10
	431	#define VNC_FEATURE_LED_STATE 11
	432
	433	#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
	434	#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
	435	#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
	436	#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
	437	#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
	438	#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
	439	#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
	440	#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
	441	#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
	442	#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
	443	#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
	444	#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
	445
	446
	447	/* Client -> Server message IDs */
	448	#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
	449	#define VNC_MSG_CLIENT_SET_ENCODINGS 2
	450	#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
	451	#define VNC_MSG_CLIENT_KEY_EVENT 4
	452	#define VNC_MSG_CLIENT_POINTER_EVENT 5
	453	#define VNC_MSG_CLIENT_CUT_TEXT 6
	454	#define VNC_MSG_CLIENT_VMWARE_0 127
	455	#define VNC_MSG_CLIENT_CALL_CONTROL 249
	456	#define VNC_MSG_CLIENT_XVP 250
	457	#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
	458	#define VNC_MSG_CLIENT_TIGHT 252
	459	#define VNC_MSG_CLIENT_GII 253
	460	#define VNC_MSG_CLIENT_VMWARE_1 254
	461	#define VNC_MSG_CLIENT_QEMU 255
	462
	463	/* Server -> Client message IDs */
	464	#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
	465	#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
	466	#define VNC_MSG_SERVER_BELL 2
	467	#define VNC_MSG_SERVER_CUT_TEXT 3
	468	#define VNC_MSG_SERVER_VMWARE_0 127
	469	#define VNC_MSG_SERVER_CALL_CONTROL 249
	470	#define VNC_MSG_SERVER_XVP 250
	471	#define VNC_MSG_SERVER_TIGHT 252
	472	#define VNC_MSG_SERVER_GII 253
	473	#define VNC_MSG_SERVER_VMWARE_1 254
	474	#define VNC_MSG_SERVER_QEMU 255
	475
	476
	477
	478	/* QEMU client -> server message IDs */
	479	#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
	480	#define VNC_MSG_CLIENT_QEMU_AUDIO 1
	481
	482	/* QEMU server -> client message IDs */
	483	#define VNC_MSG_SERVER_QEMU_AUDIO 1
	484
	485
	486
	487	/* QEMU client -> server audio message IDs */
	488	#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
	489	#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
	490	#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
	491
	492	/* QEMU server -> client audio message IDs */
	493	#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
	494	#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
	495	#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
	496
	497
	498	/*****************************************************************************
	499	*
	500	* Internal APIs
	501	*
	502	*****************************************************************************/
	503
	504	/* Event loop functions */
	505	gboolean vnc_client_io(QIOChannel *ioc,
	506	GIOCondition condition,
	507	void *opaque);
	508
	509	ssize_t vnc_client_read_buf(VncState vs, uint8_t data, size_t datalen);
	510	ssize_t vnc_client_write_buf(VncState vs, const uint8_t data, size_t datalen);
	511
	512	/* Protocol I/O functions */
	513	void vnc_write(VncState vs, const void data, size_t len);
	514	void vnc_write_u32(VncState *vs, uint32_t value);
	515	void vnc_write_s32(VncState *vs, int32_t value);
	516	void vnc_write_u16(VncState *vs, uint16_t value);
	517	void vnc_write_u8(VncState *vs, uint8_t value);
	518	void vnc_flush(VncState *vs);
	519	void vnc_read_when(VncState vs, VncReadEvent func, size_t expecting);
	520	void vnc_disconnect_finish(VncState *vs);
	521	void vnc_start_protocol(VncState *vs);
	522
	523
	524	/* Buffer I/O functions */
	525	uint32_t read_u32(uint8_t *data, size_t offset);
	526
	527	/* Protocol stage functions */
	528	void vnc_client_error(VncState *vs);
	529	ssize_t vnc_client_io_error(VncState vs, ssize_t ret, Error *errp);
	530
	531	void start_client_init(VncState *vs);
	532	void start_auth_vnc(VncState *vs);
	533
	534
	535	/* Misc helpers */
	536
	537	static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
	538	return (vs->features & (1 << feature));
	539	}
	540
	541	/* Framebuffer */
	542	void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
	543	int32_t encoding);
	544
	545	/* server fb is in PIXMAN_x8r8g8b8 */
	546	#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
	547	#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
	548	#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
	549
	550	void vnc_server_fb_ptr(VncDisplay vd, int x, int y);
	551	int vnc_server_fb_stride(VncDisplay *vd);
	552
	553	void vnc_convert_pixel(VncState vs, uint8_t buf, uint32_t v);
	554	double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
	555	void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
	556
	557	/* Encodings */
	558	int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	559
	560	int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	561
	562	int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
	563	int y, int w, int h);
	564	void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
	565
	566	void vnc_zlib_zalloc(void x, unsigned items, unsigned size);
	567	void vnc_zlib_zfree(void x, void addr);
	568	int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	569	void vnc_zlib_clear(VncState *vs);
	570
	571	int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	572	int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
	573	int w, int h);
	574	void vnc_tight_clear(VncState *vs);
	575
	576	int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	577	int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
	578	void vnc_zrle_clear(VncState *vs);
	579
	580	#endif /* QEMU_VNC_H */