blob: a86e0610e8fa07cf76f9abf4c7f1d471d7beb336 [file] [log] [blame]
aliguori19a490b2009-03-06 20:27:13 +00001/*
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
Markus Armbruster2a6a4072016-06-29 13:47:03 +020027#ifndef QEMU_VNC_H
28#define QEMU_VNC_H
aliguori19a490b2009-03-06 20:27:13 +000029
30#include "qemu-common.h"
Markus Armbruster9af23982018-02-11 10:36:01 +010031#include "qapi/qapi-types-ui.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010032#include "qemu/queue.h"
33#include "qemu/thread.h"
Paolo Bonzini28ecbae2012-11-28 12:06:30 +010034#include "ui/console.h"
aliguori19a490b2009-03-06 20:27:13 +000035#include "audio/audio.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010036#include "qemu/bitmap.h"
Daniel P. Berrange3e305e42015-08-06 14:39:32 +010037#include "crypto/tlssession.h"
Daniel P. Berrange88c5f202015-03-03 17:13:42 +000038#include "qemu/buffer.h"
Daniel P. Berrange04d25292015-02-27 16:20:57 +000039#include "io/channel-socket.h"
Daniel P. Berrange2cc45222015-03-02 19:01:05 +000040#include "io/channel-tls.h"
Daniel P. Berrange13e1d0e2018-02-01 16:45:14 +000041#include "io/net-listener.h"
aliguori19a490b2009-03-06 20:27:13 +000042#include <zlib.h>
43
aliguori19a490b2009-03-06 20:27:13 +000044#include "keymaps.h"
Corentin Chary148954f2011-02-04 09:06:01 +010045#include "vnc-palette.h"
46#include "vnc-enc-zrle.h"
aliguori19a490b2009-03-06 20:27:13 +000047
aliguori5fb6c7a2009-03-06 20:27:23 +000048// #define _VNC_DEBUG 1
49
50#ifdef _VNC_DEBUG
51#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
52#else
53#define VNC_DEBUG(fmt, ...) do { } while (0)
54#endif
55
aliguori19a490b2009-03-06 20:27:13 +000056/*****************************************************************************
57 *
58 * Core data structures
59 *
60 *****************************************************************************/
61
aliguori19a490b2009-03-06 20:27:13 +000062typedef struct VncState VncState;
Corentin Charybd023f92010-07-07 20:58:02 +020063typedef struct VncJob VncJob;
64typedef struct VncRect VncRect;
65typedef struct VncRectEntry VncRectEntry;
aliguori19a490b2009-03-06 20:27:13 +000066
67typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
68
Gerd Hoffmann9f649162012-10-10 13:29:43 +020069typedef void VncWritePixels(VncState *vs, void *data, int size);
aliguori19a490b2009-03-06 20:27:13 +000070
71typedef void VncSendHextileTile(VncState *vs,
72 int x, int y, int w, int h,
73 void *last_bg,
74 void *last_fg,
75 int *has_bg, int *has_fg);
76
Peter Lievenb4c85dd2014-01-08 10:08:33 +010077/* VNC_DIRTY_PIXELS_PER_BIT is the number of dirty pixels represented
Peter Lievenbea60dd2014-06-30 10:57:51 +020078 * by one bit in the dirty bitmap, should be a power of 2 */
Peter Lievenb4c85dd2014-01-08 10:08:33 +010079#define VNC_DIRTY_PIXELS_PER_BIT 16
80
Peter Lievenbea60dd2014-06-30 10:57:51 +020081/* VNC_MAX_WIDTH must be a multiple of VNC_DIRTY_PIXELS_PER_BIT. */
82
83#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
84#define VNC_MAX_HEIGHT 2048
85
Stefan Weil23bfe282011-03-03 21:37:55 +010086/* VNC_DIRTY_BITS is the number of bits in the dirty bitmap. */
Peter Lievenb4c85dd2014-01-08 10:08:33 +010087#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
aliguori19a490b2009-03-06 20:27:13 +000088
Peter Lieven12b316d2014-01-08 10:08:35 +010089/* VNC_DIRTY_BPL (BPL = bits per line) might be greater than
90 * VNC_DIRTY_BITS due to alignment */
91#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
92
Corentin Chary999342a2011-02-04 09:05:55 +010093#define VNC_STAT_RECT 64
94#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
95#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
96
aliguori19a490b2009-03-06 20:27:13 +000097#define VNC_AUTH_CHALLENGE_SIZE 16
98
99typedef struct VncDisplay VncDisplay;
100
aliguori5fb6c7a2009-03-06 20:27:23 +0000101#include "vnc-auth-vencrypt.h"
aliguori2f9606b2009-03-06 20:27:28 +0000102#ifdef CONFIG_VNC_SASL
103#include "vnc-auth-sasl.h"
104#endif
Tim Hardeck7536ee42013-01-21 11:04:44 +0100105#include "vnc-ws.h"
aliguori2f9606b2009-03-06 20:27:28 +0000106
Corentin Chary999342a2011-02-04 09:05:55 +0100107struct VncRectStat
108{
109 /* time of last 10 updates, to find update frequency */
110 struct timeval times[10];
111 int idx;
112
113 double freq; /* Update frequency (in Hz) */
114 bool updated; /* Already updated during this refresh */
115};
116
117typedef struct VncRectStat VncRectStat;
118
Stefano Stabellini1fc62412009-08-03 10:54:32 +0100119struct VncSurface
120{
Corentin Chary999342a2011-02-04 09:05:55 +0100121 struct timeval last_freq_check;
Peter Lievenbea60dd2014-06-30 10:57:51 +0200122 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
123 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
Corentin Chary999342a2011-02-04 09:05:55 +0100124 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
Gerd Hoffmann9f649162012-10-10 13:29:43 +0200125 pixman_image_t *fb;
126 pixman_format_code_t format;
Stefano Stabellini1fc62412009-08-03 10:54:32 +0100127};
aliguori5fb6c7a2009-03-06 20:27:23 +0000128
Gerd Hoffmann8cf36482011-11-24 18:10:49 +0100129typedef enum VncShareMode {
130 VNC_SHARE_MODE_CONNECTING = 1,
131 VNC_SHARE_MODE_SHARED,
132 VNC_SHARE_MODE_EXCLUSIVE,
133 VNC_SHARE_MODE_DISCONNECTED,
134} VncShareMode;
135
136typedef enum VncSharePolicy {
137 VNC_SHARE_POLICY_IGNORE = 1,
138 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
139 VNC_SHARE_POLICY_FORCE_SHARED,
140} VncSharePolicy;
141
aliguori19a490b2009-03-06 20:27:13 +0000142struct VncDisplay
143{
Amit Shah41b4bef2010-02-05 16:34:05 +0530144 QTAILQ_HEAD(, VncState) clients;
Gerd Hoffmanne5f34cd2014-10-02 12:09:34 +0200145 int num_connecting;
146 int num_shared;
Gerd Hoffmann8cf36482011-11-24 18:10:49 +0100147 int num_exclusive;
Gerd Hoffmanne5f34cd2014-10-02 12:09:34 +0200148 int connections_limit;
Gerd Hoffmann8cf36482011-11-24 18:10:49 +0100149 VncSharePolicy share_policy;
Daniel P. Berrange13e1d0e2018-02-01 16:45:14 +0000150 QIONetListener *listener;
151 QIONetListener *wslistener;
Gerd Hoffmannd39fa6d2013-02-28 17:16:48 +0100152 DisplaySurface *ds;
Gerd Hoffmann21ef45d2013-02-28 11:34:31 +0100153 DisplayChangeListener dcl;
Anthony Liguoric227f092009-10-01 16:12:16 -0500154 kbd_layout_t *kbd_layout;
Gerd Hoffmann3a0558b2010-03-10 17:12:02 +0100155 int lock_key_sync;
Pierre Ossmana54f0d22017-01-09 17:14:02 +0100156 QEMUPutLEDEntry *led;
157 int ledstate;
Gerd Hoffmannc5ce8332016-06-01 08:22:30 +0200158 int key_delay_ms;
Corentin Charybd023f92010-07-07 20:58:02 +0200159 QemuMutex mutex;
aliguori19a490b2009-03-06 20:27:13 +0000160
Gerd Hoffmannd467b672010-05-21 11:54:34 +0200161 QEMUCursor *cursor;
162 int cursor_msize;
163 uint8_t *cursor_mask;
164
Stefano Stabellini1fc62412009-08-03 10:54:32 +0100165 struct VncSurface guest; /* guest visible surface (aka ds->surface) */
Gerd Hoffmann9f649162012-10-10 13:29:43 +0200166 pixman_image_t *server; /* vnc server surface */
Stefano Stabellini1fc62412009-08-03 10:54:32 +0100167
Gerd Hoffmannd616ccc2014-07-29 12:14:08 +0200168 const char *id;
169 QTAILQ_ENTRY(VncDisplay) next;
Gerd Hoffmannbf7aa452015-02-19 10:46:49 +0100170 bool is_unix;
aliguori19a490b2009-03-06 20:27:13 +0000171 char *password;
Gerd Hoffmann3c9405a2010-10-07 11:50:45 +0200172 time_t expires;
aliguori19a490b2009-03-06 20:27:13 +0000173 int auth;
Daniel P. Berranged169f042015-03-17 13:42:55 +0000174 int subauth; /* Used by VeNCrypt */
Daniel P. Berrangef9148c82015-03-17 13:42:57 +0000175 int ws_auth; /* Used by websockets */
Daniel P. Berrangeeda24e12016-09-29 16:45:36 +0100176 int ws_subauth; /* Used by websockets */
Corentin Chary6f9c78c2010-07-07 20:57:51 +0200177 bool lossy;
Corentin Chary80e0c8c2011-02-04 09:06:08 +0100178 bool non_adaptive;
Daniel P. Berrange3e305e42015-08-06 14:39:32 +0100179 QCryptoTLSCreds *tlscreds;
180 char *tlsaclname;
aliguori76655d62009-03-06 20:27:37 +0000181#ifdef CONFIG_VNC_SASL
182 VncDisplaySASL sasl;
183#endif
aliguori19a490b2009-03-06 20:27:13 +0000184};
185
Corentin Charyd1af0e02010-07-07 20:57:59 +0200186typedef struct VncTight {
187 int type;
188 uint8_t quality;
189 uint8_t compression;
190 uint8_t pixel24;
191 Buffer tight;
192 Buffer tmp;
193 Buffer zlib;
194 Buffer gradient;
195#ifdef CONFIG_VNC_JPEG
196 Buffer jpeg;
197#endif
198#ifdef CONFIG_VNC_PNG
199 Buffer png;
200#endif
201 int levels[4];
202 z_stream stream[4];
203} VncTight;
204
205typedef struct VncHextile {
206 VncSendHextileTile *send_tile;
207} VncHextile;
208
209typedef struct VncZlib {
210 Buffer zlib;
211 Buffer tmp;
212 z_stream stream;
213 int level;
214} VncZlib;
215
Corentin Chary148954f2011-02-04 09:06:01 +0100216typedef struct VncZrle {
217 int type;
218 Buffer fb;
219 Buffer zrle;
220 Buffer tmp;
221 Buffer zlib;
222 z_stream stream;
223 VncPalette palette;
224} VncZrle;
225
226typedef struct VncZywrle {
227 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
228} VncZywrle;
229
Corentin Charybd023f92010-07-07 20:58:02 +0200230struct VncRect
231{
232 int x;
233 int y;
234 int w;
235 int h;
236};
237
238struct VncRectEntry
239{
240 struct VncRect rect;
241 QLIST_ENTRY(VncRectEntry) next;
242};
243
244struct VncJob
245{
246 VncState *vs;
247
248 QLIST_HEAD(, VncRectEntry) rectangles;
249 QTAILQ_ENTRY(VncJob) next;
250};
Corentin Charybd023f92010-07-07 20:58:02 +0200251
Daniel P. Berrangefef1bba2017-12-18 19:12:21 +0000252typedef enum {
253 VNC_STATE_UPDATE_NONE,
254 VNC_STATE_UPDATE_INCREMENTAL,
255 VNC_STATE_UPDATE_FORCE,
256} VncStateUpdate;
257
Gerd Hoffmannf31f9c12018-05-07 12:22:54 +0200258#define VNC_MAGIC ((uint64_t)0x05b3f069b3d204bb)
259
aliguori19a490b2009-03-06 20:27:13 +0000260struct VncState
261{
Gerd Hoffmannf31f9c12018-05-07 12:22:54 +0200262 uint64_t magic;
Daniel P. Berrange04d25292015-02-27 16:20:57 +0000263 QIOChannelSocket *sioc; /* The underlying socket */
264 QIOChannel *ioc; /* The channel currently used for I/O */
265 guint ioc_tag;
266 gboolean disconnecting;
aliguori6baebed2009-03-20 15:59:14 +0000267
Stefan Weil23bfe282011-03-03 21:37:55 +0100268 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
Corentin Chary7d964c92011-02-04 09:05:56 +0100269 uint8_t **lossy_rect; /* Not an Array to avoid costly memcpy in
270 * vnc-jobs-async.c */
aliguori6baebed2009-03-20 15:59:14 +0000271
aliguori19a490b2009-03-06 20:27:13 +0000272 VncDisplay *vd;
Daniel P. Berrangefef1bba2017-12-18 19:12:21 +0000273 VncStateUpdate update; /* Most recent pending request from client */
Daniel P. Berrangeada8d2e2017-12-18 19:12:25 +0000274 VncStateUpdate job_update; /* Currently processed by job thread */
Gerd Hoffmann63658282014-07-23 11:52:02 +0200275 int has_dirty;
aliguori19a490b2009-03-06 20:27:13 +0000276 uint32_t features;
277 int absolute;
278 int last_x;
279 int last_y;
Gerd Hoffmann14768eb2013-12-02 15:17:45 +0100280 uint32_t last_bmask;
Daniel P. Berrange4c956bd2018-01-18 15:52:54 +0000281 size_t client_width; /* limited to u16 by RFB proto */
282 size_t client_height; /* limited to u16 by RFB proto */
Gerd Hoffmann8cf36482011-11-24 18:10:49 +0100283 VncShareMode share_mode;
aliguori19a490b2009-03-06 20:27:13 +0000284
285 uint32_t vnc_encoding;
aliguori19a490b2009-03-06 20:27:13 +0000286
287 int major;
288 int minor;
289
Daniel P. Berrange7e7e2eb2011-06-23 13:31:41 +0100290 int auth;
Daniel P. Berranged169f042015-03-17 13:42:55 +0000291 int subauth; /* Used by VeNCrypt */
aliguori19a490b2009-03-06 20:27:13 +0000292 char challenge[VNC_AUTH_CHALLENGE_SIZE];
Daniel P. Berrange2cc45222015-03-02 19:01:05 +0000293 QCryptoTLSSession *tls; /* Borrowed pointer from channel, don't free */
aliguori2f9606b2009-03-06 20:27:28 +0000294#ifdef CONFIG_VNC_SASL
295 VncStateSASL sasl;
296#endif
Tim Hardeck7536ee42013-01-21 11:04:44 +0100297 bool encode_ws;
298 bool websocket;
aliguori19a490b2009-03-06 20:27:13 +0000299
Marc-André Lureau05eb4a22018-07-03 17:56:47 +0200300#ifdef CONFIG_VNC
Wenchao Xiafb6ba0d2014-06-18 08:43:49 +0200301 VncClientInfo *info;
Marc-André Lureau05eb4a22018-07-03 17:56:47 +0200302#endif
Luiz Capitulino4a80dba2010-01-14 14:50:56 -0200303
Daniel P. Berrangeada8d2e2017-12-18 19:12:25 +0000304 /* Job thread bottom half has put data for a forced update
305 * into the output buffer. This offset points to the end of
306 * the update data in the output buffer. This lets us determine
307 * when a force update is fully sent to the client, allowing
308 * us to process further forced updates. */
309 size_t force_update_offset;
Daniel P. Berrangee2b72cb2017-12-18 19:12:24 +0000310 /* We allow multiple incremental updates or audio capture
311 * samples to be queued in output buffer, provided the
312 * buffer size doesn't exceed this threshold. The value
313 * is calculating dynamically based on framebuffer size
314 * and audio sample settings in vnc_update_throttle_offset() */
315 size_t throttle_output_offset;
aliguori19a490b2009-03-06 20:27:13 +0000316 Buffer output;
317 Buffer input;
318 /* current output mode information */
319 VncWritePixels *write_pixels;
Gerd Hoffmann9f649162012-10-10 13:29:43 +0200320 PixelFormat client_pf;
321 pixman_format_code_t client_format;
322 bool client_be;
aliguori19a490b2009-03-06 20:27:13 +0000323
324 CaptureVoiceOut *audio_cap;
325 struct audsettings as;
326
327 VncReadEvent *read_handler;
328 size_t read_handler_expect;
329 /* input */
330 uint8_t modifiers_state[256];
331
Corentin Charybd023f92010-07-07 20:58:02 +0200332 bool abort;
Corentin Charybd023f92010-07-07 20:58:02 +0200333 QemuMutex output_mutex;
Corentin Chary175b2a62012-03-14 07:58:47 +0100334 QEMUBH *bh;
335 Buffer jobs_buffer;
Corentin Charybd023f92010-07-07 20:58:02 +0200336
337 /* Encoding specific, if you add something here, don't forget to
338 * update vnc_async_encoding_start()
339 */
Corentin Charyd1af0e02010-07-07 20:57:59 +0200340 VncTight tight;
341 VncZlib zlib;
342 VncHextile hextile;
Corentin Chary148954f2011-02-04 09:06:01 +0100343 VncZrle zrle;
344 VncZywrle zywrle;
aliguori19a490b2009-03-06 20:27:13 +0000345
Anthony Liguori37c34d92010-03-10 09:38:29 -0600346 Notifier mouse_mode_notifier;
347
Amit Shah41b4bef2010-02-05 16:34:05 +0530348 QTAILQ_ENTRY(VncState) next;
aliguori19a490b2009-03-06 20:27:13 +0000349};
350
aliguorie06679f2009-02-02 15:58:25 +0000351
352/*****************************************************************************
353 *
354 * Authentication modes
355 *
356 *****************************************************************************/
357
358enum {
359 VNC_AUTH_INVALID = 0,
360 VNC_AUTH_NONE = 1,
361 VNC_AUTH_VNC = 2,
362 VNC_AUTH_RA2 = 5,
363 VNC_AUTH_RA2NE = 6,
364 VNC_AUTH_TIGHT = 16,
365 VNC_AUTH_ULTRA = 17,
aliguori2f9606b2009-03-06 20:27:28 +0000366 VNC_AUTH_TLS = 18, /* Supported in GTK-VNC & VINO */
367 VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
368 VNC_AUTH_SASL = 20, /* Supported in GTK-VNC & VINO */
aliguorie06679f2009-02-02 15:58:25 +0000369};
370
aliguorie06679f2009-02-02 15:58:25 +0000371enum {
372 VNC_AUTH_VENCRYPT_PLAIN = 256,
373 VNC_AUTH_VENCRYPT_TLSNONE = 257,
374 VNC_AUTH_VENCRYPT_TLSVNC = 258,
375 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
376 VNC_AUTH_VENCRYPT_X509NONE = 260,
377 VNC_AUTH_VENCRYPT_X509VNC = 261,
378 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
aliguori2f9606b2009-03-06 20:27:28 +0000379 VNC_AUTH_VENCRYPT_X509SASL = 263,
380 VNC_AUTH_VENCRYPT_TLSSASL = 264,
aliguorie06679f2009-02-02 15:58:25 +0000381};
382
aliguorie06679f2009-02-02 15:58:25 +0000383
384/*****************************************************************************
385 *
386 * Encoding types
387 *
388 *****************************************************************************/
389
390#define VNC_ENCODING_RAW 0x00000000
391#define VNC_ENCODING_COPYRECT 0x00000001
392#define VNC_ENCODING_RRE 0x00000002
393#define VNC_ENCODING_CORRE 0x00000004
394#define VNC_ENCODING_HEXTILE 0x00000005
395#define VNC_ENCODING_ZLIB 0x00000006
396#define VNC_ENCODING_TIGHT 0x00000007
397#define VNC_ENCODING_ZLIBHEX 0x00000008
398#define VNC_ENCODING_TRLE 0x0000000f
399#define VNC_ENCODING_ZRLE 0x00000010
400#define VNC_ENCODING_ZYWRLE 0x00000011
401#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00 /* -256 */
402#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0 /* -32 */
403#define VNC_ENCODING_XCURSOR 0xFFFFFF10 /* -240 */
404#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11 /* -239 */
405#define VNC_ENCODING_POINTER_POS 0xFFFFFF18 /* -232 */
406#define VNC_ENCODING_LASTRECT 0xFFFFFF20 /* -224 */
407#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21 /* -223 */
408#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF /* -257 */
409#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE /* -258 */
410#define VNC_ENCODING_AUDIO 0XFFFFFEFD /* -259 */
Corentin Charyefe556a2010-07-07 20:57:56 +0200411#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC /* -260 */
Lei Liab99e5c2013-04-25 13:29:10 +0800412#define VNC_ENCODING_LED_STATE 0XFFFFFEFB /* -261 */
aliguorie06679f2009-02-02 15:58:25 +0000413#define VNC_ENCODING_WMVi 0x574D5669
414
415/*****************************************************************************
416 *
417 * Other tight constants
418 *
419 *****************************************************************************/
420
421/*
422 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
423 */
424
425#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
426#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
427#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
428#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
Corentin Charyefe556a2010-07-07 20:57:56 +0200429#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
aliguorie06679f2009-02-02 15:58:25 +0000430#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
431#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
432#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
433
434/*****************************************************************************
435 *
436 * Features
437 *
438 *****************************************************************************/
439
440#define VNC_FEATURE_RESIZE 0
441#define VNC_FEATURE_HEXTILE 1
442#define VNC_FEATURE_POINTER_TYPE_CHANGE 2
443#define VNC_FEATURE_WMVI 3
444#define VNC_FEATURE_TIGHT 4
445#define VNC_FEATURE_ZLIB 5
aliguori753b4052009-02-16 14:59:30 +0000446#define VNC_FEATURE_COPYRECT 6
Gerd Hoffmannd467b672010-05-21 11:54:34 +0200447#define VNC_FEATURE_RICH_CURSOR 7
Corentin Charyefe556a2010-07-07 20:57:56 +0200448#define VNC_FEATURE_TIGHT_PNG 8
Corentin Chary148954f2011-02-04 09:06:01 +0100449#define VNC_FEATURE_ZRLE 9
450#define VNC_FEATURE_ZYWRLE 10
Lei Liab99e5c2013-04-25 13:29:10 +0800451#define VNC_FEATURE_LED_STATE 11
aliguorie06679f2009-02-02 15:58:25 +0000452
453#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
454#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
455#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
456#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
457#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
458#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
aliguori753b4052009-02-16 14:59:30 +0000459#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
Gerd Hoffmannd467b672010-05-21 11:54:34 +0200460#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
Corentin Charyefe556a2010-07-07 20:57:56 +0200461#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
Corentin Chary148954f2011-02-04 09:06:01 +0100462#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
463#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
Lei Liab99e5c2013-04-25 13:29:10 +0800464#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
aliguorie06679f2009-02-02 15:58:25 +0000465
aliguori5fb6c7a2009-03-06 20:27:23 +0000466
Daniel P. Berrange46a183d2010-03-31 18:20:43 +0100467/* Client -> Server message IDs */
468#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
469#define VNC_MSG_CLIENT_SET_ENCODINGS 2
470#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
471#define VNC_MSG_CLIENT_KEY_EVENT 4
472#define VNC_MSG_CLIENT_POINTER_EVENT 5
473#define VNC_MSG_CLIENT_CUT_TEXT 6
474#define VNC_MSG_CLIENT_VMWARE_0 127
475#define VNC_MSG_CLIENT_CALL_CONTROL 249
476#define VNC_MSG_CLIENT_XVP 250
477#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
478#define VNC_MSG_CLIENT_TIGHT 252
479#define VNC_MSG_CLIENT_GII 253
480#define VNC_MSG_CLIENT_VMWARE_1 254
481#define VNC_MSG_CLIENT_QEMU 255
482
483/* Server -> Client message IDs */
484#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
485#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
486#define VNC_MSG_SERVER_BELL 2
487#define VNC_MSG_SERVER_CUT_TEXT 3
488#define VNC_MSG_SERVER_VMWARE_0 127
489#define VNC_MSG_SERVER_CALL_CONTROL 249
490#define VNC_MSG_SERVER_XVP 250
491#define VNC_MSG_SERVER_TIGHT 252
492#define VNC_MSG_SERVER_GII 253
493#define VNC_MSG_SERVER_VMWARE_1 254
494#define VNC_MSG_SERVER_QEMU 255
495
496
497
498/* QEMU client -> server message IDs */
499#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
500#define VNC_MSG_CLIENT_QEMU_AUDIO 1
501
502/* QEMU server -> client message IDs */
503#define VNC_MSG_SERVER_QEMU_AUDIO 1
504
505
506
507/* QEMU client -> server audio message IDs */
508#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
509#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
510#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
511
512/* QEMU server -> client audio message IDs */
513#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
514#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
515#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
516
517
aliguori5fb6c7a2009-03-06 20:27:23 +0000518/*****************************************************************************
519 *
520 * Internal APIs
521 *
522 *****************************************************************************/
523
524/* Event loop functions */
Daniel P. Berrange04d25292015-02-27 16:20:57 +0000525gboolean vnc_client_io(QIOChannel *ioc,
526 GIOCondition condition,
527 void *opaque);
aliguori5fb6c7a2009-03-06 20:27:23 +0000528
Daniel P. Berrange30b80fd2017-12-18 19:12:28 +0000529size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
530size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
aliguori5fb6c7a2009-03-06 20:27:23 +0000531
532/* Protocol I/O functions */
533void vnc_write(VncState *vs, const void *data, size_t len);
534void vnc_write_u32(VncState *vs, uint32_t value);
535void vnc_write_s32(VncState *vs, int32_t value);
536void vnc_write_u16(VncState *vs, uint16_t value);
537void vnc_write_u8(VncState *vs, uint8_t value);
538void vnc_flush(VncState *vs);
539void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
Tim Hardeck7536ee42013-01-21 11:04:44 +0100540void vnc_disconnect_finish(VncState *vs);
Daniel P. Berrangedbee9892016-09-29 16:45:40 +0100541void vnc_start_protocol(VncState *vs);
aliguori5fb6c7a2009-03-06 20:27:23 +0000542
543
544/* Buffer I/O functions */
aliguori5fb6c7a2009-03-06 20:27:23 +0000545uint32_t read_u32(uint8_t *data, size_t offset);
546
547/* Protocol stage functions */
548void vnc_client_error(VncState *vs);
Daniel P. Berrange30b80fd2017-12-18 19:12:28 +0000549size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp);
aliguori5fb6c7a2009-03-06 20:27:23 +0000550
551void start_client_init(VncState *vs);
552void start_auth_vnc(VncState *vs);
553
aliguori2f9606b2009-03-06 20:27:28 +0000554
555/* Misc helpers */
556
Corentin Charyefe556a2010-07-07 20:57:56 +0200557static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
558 return (vs->features & (1 << feature));
559}
560
Corentin Chary70a45682010-05-03 14:31:34 +0200561/* Framebuffer */
562void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
563 int32_t encoding);
564
Gerd Hoffmann9f649162012-10-10 13:29:43 +0200565/* server fb is in PIXMAN_x8r8g8b8 */
566#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
567#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
568#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
569
570void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
571int vnc_server_fb_stride(VncDisplay *vd);
572
Corentin Chary70a45682010-05-03 14:31:34 +0200573void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
Corentin Chary999342a2011-02-04 09:05:55 +0100574double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
Corentin Chary7d964c92011-02-04 09:05:56 +0100575void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
Corentin Chary70a45682010-05-03 14:31:34 +0200576
577/* Encodings */
Corentin Charybd023f92010-07-07 20:58:02 +0200578int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
579
Corentin Charya8852112010-05-19 09:24:09 +0200580int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
Corentin Chary70a45682010-05-03 14:31:34 +0200581
Corentin Charya8852112010-05-19 09:24:09 +0200582int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
Corentin Chary70a45682010-05-03 14:31:34 +0200583 int y, int w, int h);
584void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
585
Corentin Chary380282b2010-05-19 09:24:10 +0200586void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
587void vnc_zlib_zfree(void *x, void *addr);
Corentin Charya8852112010-05-19 09:24:09 +0200588int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
Corentin Chary161c4f22010-05-19 09:24:08 +0200589void vnc_zlib_clear(VncState *vs);
Corentin Chary70a45682010-05-03 14:31:34 +0200590
Corentin Chary380282b2010-05-19 09:24:10 +0200591int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
Corentin Charyefe556a2010-07-07 20:57:56 +0200592int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
593 int w, int h);
Corentin Chary380282b2010-05-19 09:24:10 +0200594void vnc_tight_clear(VncState *vs);
595
Corentin Chary148954f2011-02-04 09:06:01 +0100596int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
597int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
598void vnc_zrle_clear(VncState *vs);
599
Markus Armbruster2a6a4072016-06-29 13:47:03 +0200600#endif /* QEMU_VNC_H */