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 "qapi/qapi-types-ui.h"
32#include "qemu/queue.h"
33#include "qemu/thread.h"
34#include "ui/console.h"
35#include "audio/audio.h"
36#include "qemu/bitmap.h"
37#include "crypto/tlssession.h"
38#include "qemu/buffer.h"
39#include "io/channel-socket.h"
40#include "io/channel-tls.h"
41#include "io/net-listener.h"
42#include <zlib.h>
43
44#include "keymaps.h"
45#include "vnc-palette.h"
46#include "vnc-enc-zrle.h"
47
48
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
56
57
58
59
60
61
62typedef struct VncState VncState;
63typedef struct VncJob VncJob;
64typedef struct VncRect VncRect;
65typedef struct VncRectEntry VncRectEntry;
66
67typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
68
69typedef void VncWritePixels(VncState *vs, void *data, int size);
70
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
77
78
79#define VNC_DIRTY_PIXELS_PER_BIT 16
80
81
82
83#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
84#define VNC_MAX_HEIGHT 2048
85
86
87#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
88
89
90
91#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
92
93#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
97#define VNC_AUTH_CHALLENGE_SIZE 16
98
99typedef struct VncDisplay VncDisplay;
100
101#include "vnc-auth-vencrypt.h"
102#ifdef CONFIG_VNC_SASL
103#include "vnc-auth-sasl.h"
104#endif
105#include "vnc-ws.h"
106
107struct VncRectStat
108{
109
110 struct timeval times[10];
111 int idx;
112
113 double freq;
114 bool updated;
115};
116
117typedef struct VncRectStat VncRectStat;
118
119struct VncSurface
120{
121 struct timeval last_freq_check;
122 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
123 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
124 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
125 pixman_image_t *fb;
126 pixman_format_code_t format;
127};
128
129typedef 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
142struct VncDisplay
143{
144 QTAILQ_HEAD(, VncState) clients;
145 int num_connecting;
146 int num_shared;
147 int num_exclusive;
148 int connections_limit;
149 VncSharePolicy share_policy;
150 QIONetListener *listener;
151 QIONetListener *wslistener;
152 DisplaySurface *ds;
153 DisplayChangeListener dcl;
154 kbd_layout_t *kbd_layout;
155 int lock_key_sync;
156 QEMUPutLEDEntry *led;
157 int ledstate;
158 int key_delay_ms;
159 QemuMutex mutex;
160
161 QEMUCursor *cursor;
162 int cursor_msize;
163 uint8_t *cursor_mask;
164
165 struct VncSurface guest;
166 pixman_image_t *server;
167
168 const char *id;
169 QTAILQ_ENTRY(VncDisplay) next;
170 bool is_unix;
171 char *password;
172 time_t expires;
173 int auth;
174 int subauth;
175 int ws_auth;
176 int ws_subauth;
177 bool lossy;
178 bool non_adaptive;
179 QCryptoTLSCreds *tlscreds;
180 char *tlsaclname;
181#ifdef CONFIG_VNC_SASL
182 VncDisplaySASL sasl;
183#endif
184};
185
186typedef 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
216typedef 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
230struct 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};
251
252typedef enum {
253 VNC_STATE_UPDATE_NONE,
254 VNC_STATE_UPDATE_INCREMENTAL,
255 VNC_STATE_UPDATE_FORCE,
256} VncStateUpdate;
257
258struct VncState
259{
260 QIOChannelSocket *sioc;
261 QIOChannel *ioc;
262 guint ioc_tag;
263 gboolean disconnecting;
264
265 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
266 uint8_t **lossy_rect;
267
268
269 VncDisplay *vd;
270 VncStateUpdate update;
271 VncStateUpdate job_update;
272 int has_dirty;
273 uint32_t features;
274 int absolute;
275 int last_x;
276 int last_y;
277 uint32_t last_bmask;
278 size_t client_width;
279 size_t client_height;
280 VncShareMode share_mode;
281
282 uint32_t vnc_encoding;
283
284 int major;
285 int minor;
286
287 int auth;
288 int subauth;
289 char challenge[VNC_AUTH_CHALLENGE_SIZE];
290 QCryptoTLSSession *tls;
291#ifdef CONFIG_VNC_SASL
292 VncStateSASL sasl;
293#endif
294 bool encode_ws;
295 bool websocket;
296
297 VncClientInfo *info;
298
299
300
301
302
303
304 size_t force_update_offset;
305
306
307
308
309
310 size_t throttle_output_offset;
311 Buffer output;
312 Buffer input;
313
314 VncWritePixels *write_pixels;
315 PixelFormat client_pf;
316 pixman_format_code_t client_format;
317 bool client_be;
318
319 CaptureVoiceOut *audio_cap;
320 struct audsettings as;
321
322 VncReadEvent *read_handler;
323 size_t read_handler_expect;
324
325 uint8_t modifiers_state[256];
326
327 bool abort;
328 QemuMutex output_mutex;
329 QEMUBH *bh;
330 Buffer jobs_buffer;
331
332
333
334
335 VncTight tight;
336 VncZlib zlib;
337 VncHextile hextile;
338 VncZrle zrle;
339 VncZywrle zywrle;
340
341 Notifier mouse_mode_notifier;
342
343 QTAILQ_ENTRY(VncState) next;
344};
345
346
347
348
349
350
351
352
353enum {
354 VNC_AUTH_INVALID = 0,
355 VNC_AUTH_NONE = 1,
356 VNC_AUTH_VNC = 2,
357 VNC_AUTH_RA2 = 5,
358 VNC_AUTH_RA2NE = 6,
359 VNC_AUTH_TIGHT = 16,
360 VNC_AUTH_ULTRA = 17,
361 VNC_AUTH_TLS = 18,
362 VNC_AUTH_VENCRYPT = 19,
363 VNC_AUTH_SASL = 20,
364};
365
366enum {
367 VNC_AUTH_VENCRYPT_PLAIN = 256,
368 VNC_AUTH_VENCRYPT_TLSNONE = 257,
369 VNC_AUTH_VENCRYPT_TLSVNC = 258,
370 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
371 VNC_AUTH_VENCRYPT_X509NONE = 260,
372 VNC_AUTH_VENCRYPT_X509VNC = 261,
373 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
374 VNC_AUTH_VENCRYPT_X509SASL = 263,
375 VNC_AUTH_VENCRYPT_TLSSASL = 264,
376};
377
378
379
380
381
382
383
384
385#define VNC_ENCODING_RAW 0x00000000
386#define VNC_ENCODING_COPYRECT 0x00000001
387#define VNC_ENCODING_RRE 0x00000002
388#define VNC_ENCODING_CORRE 0x00000004
389#define VNC_ENCODING_HEXTILE 0x00000005
390#define VNC_ENCODING_ZLIB 0x00000006
391#define VNC_ENCODING_TIGHT 0x00000007
392#define VNC_ENCODING_ZLIBHEX 0x00000008
393#define VNC_ENCODING_TRLE 0x0000000f
394#define VNC_ENCODING_ZRLE 0x00000010
395#define VNC_ENCODING_ZYWRLE 0x00000011
396#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00
397#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0
398#define VNC_ENCODING_XCURSOR 0xFFFFFF10
399#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11
400#define VNC_ENCODING_POINTER_POS 0xFFFFFF18
401#define VNC_ENCODING_LASTRECT 0xFFFFFF20
402#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21
403#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF
404#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE
405#define VNC_ENCODING_AUDIO 0XFFFFFEFD
406#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC
407#define VNC_ENCODING_LED_STATE 0XFFFFFEFB
408#define VNC_ENCODING_WMVi 0x574D5669
409
410
411
412
413
414
415
416
417
418
419
420#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
421#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
422#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
423#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
424#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
425#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
426#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
427#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
428
429
430
431
432
433
434
435#define VNC_FEATURE_RESIZE 0
436#define VNC_FEATURE_HEXTILE 1
437#define VNC_FEATURE_POINTER_TYPE_CHANGE 2
438#define VNC_FEATURE_WMVI 3
439#define VNC_FEATURE_TIGHT 4
440#define VNC_FEATURE_ZLIB 5
441#define VNC_FEATURE_COPYRECT 6
442#define VNC_FEATURE_RICH_CURSOR 7
443#define VNC_FEATURE_TIGHT_PNG 8
444#define VNC_FEATURE_ZRLE 9
445#define VNC_FEATURE_ZYWRLE 10
446#define VNC_FEATURE_LED_STATE 11
447
448#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
449#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
450#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
451#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
452#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
453#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
454#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
455#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
456#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
457#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
458#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
459#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
460
461
462
463#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
464#define VNC_MSG_CLIENT_SET_ENCODINGS 2
465#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
466#define VNC_MSG_CLIENT_KEY_EVENT 4
467#define VNC_MSG_CLIENT_POINTER_EVENT 5
468#define VNC_MSG_CLIENT_CUT_TEXT 6
469#define VNC_MSG_CLIENT_VMWARE_0 127
470#define VNC_MSG_CLIENT_CALL_CONTROL 249
471#define VNC_MSG_CLIENT_XVP 250
472#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
473#define VNC_MSG_CLIENT_TIGHT 252
474#define VNC_MSG_CLIENT_GII 253
475#define VNC_MSG_CLIENT_VMWARE_1 254
476#define VNC_MSG_CLIENT_QEMU 255
477
478
479#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
480#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
481#define VNC_MSG_SERVER_BELL 2
482#define VNC_MSG_SERVER_CUT_TEXT 3
483#define VNC_MSG_SERVER_VMWARE_0 127
484#define VNC_MSG_SERVER_CALL_CONTROL 249
485#define VNC_MSG_SERVER_XVP 250
486#define VNC_MSG_SERVER_TIGHT 252
487#define VNC_MSG_SERVER_GII 253
488#define VNC_MSG_SERVER_VMWARE_1 254
489#define VNC_MSG_SERVER_QEMU 255
490
491
492
493
494#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
495#define VNC_MSG_CLIENT_QEMU_AUDIO 1
496
497
498#define VNC_MSG_SERVER_QEMU_AUDIO 1
499
500
501
502
503#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
504#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
505#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
506
507
508#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
509#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
510#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
511
512
513
514
515
516
517
518
519
520gboolean vnc_client_io(QIOChannel *ioc,
521 GIOCondition condition,
522 void *opaque);
523
524size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
525size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
526
527
528void vnc_write(VncState *vs, const void *data, size_t len);
529void vnc_write_u32(VncState *vs, uint32_t value);
530void vnc_write_s32(VncState *vs, int32_t value);
531void vnc_write_u16(VncState *vs, uint16_t value);
532void vnc_write_u8(VncState *vs, uint8_t value);
533void vnc_flush(VncState *vs);
534void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
535void vnc_disconnect_finish(VncState *vs);
536void vnc_start_protocol(VncState *vs);
537
538
539
540uint32_t read_u32(uint8_t *data, size_t offset);
541
542
543void vnc_client_error(VncState *vs);
544size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp);
545
546void start_client_init(VncState *vs);
547void start_auth_vnc(VncState *vs);
548
549
550
551
552static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
553 return (vs->features & (1 << feature));
554}
555
556
557void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
558 int32_t encoding);
559
560
561#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
562#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
563#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
564
565void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
566int vnc_server_fb_stride(VncDisplay *vd);
567
568void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
569double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
570void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
571
572
573int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
574
575int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
576
577int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
578 int y, int w, int h);
579void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
580
581void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
582void vnc_zlib_zfree(void *x, void *addr);
583int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
584void vnc_zlib_clear(VncState *vs);
585
586int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
587int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
588 int w, int h);
589void vnc_tight_clear(VncState *vs);
590
591int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
592int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
593void vnc_zrle_clear(VncState *vs);
594
595#endif
596