1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
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
58
59
60
61typedef struct VncState VncState;
62typedef struct VncJob VncJob;
63typedef struct VncRect VncRect;
64typedef struct VncRectEntry VncRectEntry;
65
66typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
67
68typedef void VncWritePixels(VncState *vs, void *data, int size);
69
70typedef 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
77
78#define VNC_DIRTY_PIXELS_PER_BIT 16
79
80
81
82#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
83#define VNC_MAX_HEIGHT 2048
84
85
86#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
87
88
89
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
98typedef 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
106struct VncRectStat
107{
108
109 struct timeval times[10];
110 int idx;
111
112 double freq;
113 bool updated;
114};
115
116typedef struct VncRectStat VncRectStat;
117
118struct 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
128typedef 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
135typedef enum VncSharePolicy {
136 VNC_SHARE_POLICY_IGNORE = 1,
137 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
138 VNC_SHARE_POLICY_FORCE_SHARED,
139} VncSharePolicy;
140
141struct 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;
169 pixman_image_t *server;
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;
178 int ws_auth;
179 int ws_subauth;
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
189typedef 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
208typedef struct VncHextile {
209 VncSendHextileTile *send_tile;
210} VncHextile;
211
212typedef struct VncZlib {
213 Buffer zlib;
214 Buffer tmp;
215 z_stream stream;
216 int level;
217} VncZlib;
218
219typedef 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
229typedef struct VncZywrle {
230 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
231} VncZywrle;
232
233struct VncRect
234{
235 int x;
236 int y;
237 int w;
238 int h;
239};
240
241struct VncRectEntry
242{
243 struct VncRect rect;
244 QLIST_ENTRY(VncRectEntry) next;
245};
246
247struct VncJob
248{
249 VncState *vs;
250
251 QLIST_HEAD(, VncRectEntry) rectangles;
252 QTAILQ_ENTRY(VncJob) next;
253};
254
255typedef enum {
256 VNC_STATE_UPDATE_NONE,
257 VNC_STATE_UPDATE_INCREMENTAL,
258 VNC_STATE_UPDATE_FORCE,
259} VncStateUpdate;
260
261struct VncState
262{
263 QIOChannelSocket *sioc;
264 QIOChannel *ioc;
265 guint ioc_tag;
266 gboolean disconnecting;
267
268 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
269 uint8_t **lossy_rect;
270
271
272 VncDisplay *vd;
273 VncStateUpdate update;
274 VncStateUpdate job_update;
275 int has_dirty;
276 uint32_t features;
277 int absolute;
278 int last_x;
279 int last_y;
280 uint32_t last_bmask;
281 size_t client_width;
282 size_t client_height;
283 VncShareMode share_mode;
284
285 uint32_t vnc_encoding;
286
287 int major;
288 int minor;
289
290 int auth;
291 int subauth;
292 char challenge[VNC_AUTH_CHALLENGE_SIZE];
293 QCryptoTLSSession *tls;
294#ifdef CONFIG_VNC_SASL
295 VncStateSASL sasl;
296#endif
297 bool encode_ws;
298 bool websocket;
299
300 VncClientInfo *info;
301
302
303
304
305
306
307 size_t force_update_offset;
308
309
310
311
312
313 size_t throttle_output_offset;
314 Buffer output;
315 Buffer input;
316
317 VncWritePixels *write_pixels;
318 PixelFormat client_pf;
319 pixman_format_code_t client_format;
320 bool client_be;
321
322 CaptureVoiceOut *audio_cap;
323 struct audsettings as;
324
325 VncReadEvent *read_handler;
326 size_t read_handler_expect;
327
328 uint8_t modifiers_state[256];
329
330 bool abort;
331 QemuMutex output_mutex;
332 QEMUBH *bh;
333 Buffer jobs_buffer;
334
335
336
337
338 VncTight tight;
339 VncZlib zlib;
340 VncHextile hextile;
341 VncZrle zrle;
342 VncZywrle zywrle;
343
344 Notifier mouse_mode_notifier;
345
346 QTAILQ_ENTRY(VncState) next;
347};
348
349
350
351
352
353
354
355
356enum {
357 VNC_AUTH_INVALID = 0,
358 VNC_AUTH_NONE = 1,
359 VNC_AUTH_VNC = 2,
360 VNC_AUTH_RA2 = 5,
361 VNC_AUTH_RA2NE = 6,
362 VNC_AUTH_TIGHT = 16,
363 VNC_AUTH_ULTRA = 17,
364 VNC_AUTH_TLS = 18,
365 VNC_AUTH_VENCRYPT = 19,
366 VNC_AUTH_SASL = 20,
367};
368
369enum {
370 VNC_AUTH_VENCRYPT_PLAIN = 256,
371 VNC_AUTH_VENCRYPT_TLSNONE = 257,
372 VNC_AUTH_VENCRYPT_TLSVNC = 258,
373 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
374 VNC_AUTH_VENCRYPT_X509NONE = 260,
375 VNC_AUTH_VENCRYPT_X509VNC = 261,
376 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
377 VNC_AUTH_VENCRYPT_X509SASL = 263,
378 VNC_AUTH_VENCRYPT_TLSSASL = 264,
379};
380
381
382
383
384
385
386
387
388#define VNC_ENCODING_RAW 0x00000000
389#define VNC_ENCODING_COPYRECT 0x00000001
390#define VNC_ENCODING_RRE 0x00000002
391#define VNC_ENCODING_CORRE 0x00000004
392#define VNC_ENCODING_HEXTILE 0x00000005
393#define VNC_ENCODING_ZLIB 0x00000006
394#define VNC_ENCODING_TIGHT 0x00000007
395#define VNC_ENCODING_ZLIBHEX 0x00000008
396#define VNC_ENCODING_TRLE 0x0000000f
397#define VNC_ENCODING_ZRLE 0x00000010
398#define VNC_ENCODING_ZYWRLE 0x00000011
399#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00
400#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0
401#define VNC_ENCODING_XCURSOR 0xFFFFFF10
402#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11
403#define VNC_ENCODING_POINTER_POS 0xFFFFFF18
404#define VNC_ENCODING_LASTRECT 0xFFFFFF20
405#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21
406#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF
407#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE
408#define VNC_ENCODING_AUDIO 0XFFFFFEFD
409#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC
410#define VNC_ENCODING_LED_STATE 0XFFFFFEFB
411#define VNC_ENCODING_WMVi 0x574D5669
412
413
414
415
416
417
418
419
420
421
422
423#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
424#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
425#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
426#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
427#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
428#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
429#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
430#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
431
432
433
434
435
436
437
438#define VNC_FEATURE_RESIZE 0
439#define VNC_FEATURE_HEXTILE 1
440#define VNC_FEATURE_POINTER_TYPE_CHANGE 2
441#define VNC_FEATURE_WMVI 3
442#define VNC_FEATURE_TIGHT 4
443#define VNC_FEATURE_ZLIB 5
444#define VNC_FEATURE_COPYRECT 6
445#define VNC_FEATURE_RICH_CURSOR 7
446#define VNC_FEATURE_TIGHT_PNG 8
447#define VNC_FEATURE_ZRLE 9
448#define VNC_FEATURE_ZYWRLE 10
449#define VNC_FEATURE_LED_STATE 11
450
451#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
452#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
453#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
454#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
455#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
456#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
457#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
458#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
459#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
460#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
461#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
462#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
463
464
465
466#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
467#define VNC_MSG_CLIENT_SET_ENCODINGS 2
468#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
469#define VNC_MSG_CLIENT_KEY_EVENT 4
470#define VNC_MSG_CLIENT_POINTER_EVENT 5
471#define VNC_MSG_CLIENT_CUT_TEXT 6
472#define VNC_MSG_CLIENT_VMWARE_0 127
473#define VNC_MSG_CLIENT_CALL_CONTROL 249
474#define VNC_MSG_CLIENT_XVP 250
475#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
476#define VNC_MSG_CLIENT_TIGHT 252
477#define VNC_MSG_CLIENT_GII 253
478#define VNC_MSG_CLIENT_VMWARE_1 254
479#define VNC_MSG_CLIENT_QEMU 255
480
481
482#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
483#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
484#define VNC_MSG_SERVER_BELL 2
485#define VNC_MSG_SERVER_CUT_TEXT 3
486#define VNC_MSG_SERVER_VMWARE_0 127
487#define VNC_MSG_SERVER_CALL_CONTROL 249
488#define VNC_MSG_SERVER_XVP 250
489#define VNC_MSG_SERVER_TIGHT 252
490#define VNC_MSG_SERVER_GII 253
491#define VNC_MSG_SERVER_VMWARE_1 254
492#define VNC_MSG_SERVER_QEMU 255
493
494
495
496
497#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
498#define VNC_MSG_CLIENT_QEMU_AUDIO 1
499
500
501#define VNC_MSG_SERVER_QEMU_AUDIO 1
502
503
504
505
506#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
507#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
508#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
509
510
511#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
512#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
513#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
514
515
516
517
518
519
520
521
522
523gboolean vnc_client_io(QIOChannel *ioc,
524 GIOCondition condition,
525 void *opaque);
526
527size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
528size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
529
530
531void vnc_write(VncState *vs, const void *data, size_t len);
532void vnc_write_u32(VncState *vs, uint32_t value);
533void vnc_write_s32(VncState *vs, int32_t value);
534void vnc_write_u16(VncState *vs, uint16_t value);
535void vnc_write_u8(VncState *vs, uint8_t value);
536void vnc_flush(VncState *vs);
537void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
538void vnc_disconnect_finish(VncState *vs);
539void vnc_start_protocol(VncState *vs);
540
541
542
543uint32_t read_u32(uint8_t *data, size_t offset);
544
545
546void vnc_client_error(VncState *vs);
547size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp);
548
549void start_client_init(VncState *vs);
550void start_auth_vnc(VncState *vs);
551
552
553
554
555static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
556 return (vs->features & (1 << feature));
557}
558
559
560void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
561 int32_t encoding);
562
563
564#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
565#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
566#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
567
568void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
569int vnc_server_fb_stride(VncDisplay *vd);
570
571void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
572double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
573void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
574
575
576int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
577
578int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
579
580int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
581 int y, int w, int h);
582void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
583
584void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
585void vnc_zlib_zfree(void *x, void *addr);
586int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
587void vnc_zlib_clear(VncState *vs);
588
589int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
590int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
591 int w, int h);
592void vnc_tight_clear(VncState *vs);
593
594int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
595int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
596void vnc_zrle_clear(VncState *vs);
597
598#endif
599