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 QIOChannelSocket *lsock;
150 guint lsock_tag;
151 QIOChannelSocket *lwebsock;
152 guint lwebsock_tag;
153 bool ws_enabled;
154 DisplaySurface *ds;
155 DisplayChangeListener dcl;
156 kbd_layout_t *kbd_layout;
157 int lock_key_sync;
158 QemuMutex mutex;
159
160 QEMUCursor *cursor;
161 int cursor_msize;
162 uint8_t *cursor_mask;
163
164 struct VncSurface guest;
165 pixman_image_t *server;
166
167 const char *id;
168 QTAILQ_ENTRY(VncDisplay) next;
169 bool enabled;
170 bool is_unix;
171 char *password;
172 time_t expires;
173 int auth;
174 int subauth;
175 int ws_auth;
176 bool ws_tls;
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
252struct VncState
253{
254 QIOChannelSocket *sioc;
255 QIOChannel *ioc;
256 guint ioc_tag;
257 gboolean disconnecting;
258
259 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
260 uint8_t **lossy_rect;
261
262
263 VncDisplay *vd;
264 int need_update;
265 int force_update;
266 int has_dirty;
267 uint32_t features;
268 int absolute;
269 int last_x;
270 int last_y;
271 uint32_t last_bmask;
272 int client_width;
273 int client_height;
274 VncShareMode share_mode;
275
276 uint32_t vnc_encoding;
277
278 int major;
279 int minor;
280
281 int auth;
282 int subauth;
283 char challenge[VNC_AUTH_CHALLENGE_SIZE];
284 QCryptoTLSSession *tls;
285#ifdef CONFIG_VNC_SASL
286 VncStateSASL sasl;
287#endif
288 bool encode_ws;
289 bool websocket;
290
291 VncClientInfo *info;
292
293 Buffer output;
294 Buffer input;
295
296 VncWritePixels *write_pixels;
297 PixelFormat client_pf;
298 pixman_format_code_t client_format;
299 bool client_be;
300
301 CaptureVoiceOut *audio_cap;
302 struct audsettings as;
303
304 VncReadEvent *read_handler;
305 size_t read_handler_expect;
306
307 uint8_t modifiers_state[256];
308 QEMUPutLEDEntry *led;
309
310 bool abort;
311 bool initialized;
312 QemuMutex output_mutex;
313 QEMUBH *bh;
314 Buffer jobs_buffer;
315
316
317
318
319 VncTight tight;
320 VncZlib zlib;
321 VncHextile hextile;
322 VncZrle zrle;
323 VncZywrle zywrle;
324
325 Notifier mouse_mode_notifier;
326
327 QTAILQ_ENTRY(VncState) next;
328};
329
330
331
332
333
334
335
336
337enum {
338 VNC_AUTH_INVALID = 0,
339 VNC_AUTH_NONE = 1,
340 VNC_AUTH_VNC = 2,
341 VNC_AUTH_RA2 = 5,
342 VNC_AUTH_RA2NE = 6,
343 VNC_AUTH_TIGHT = 16,
344 VNC_AUTH_ULTRA = 17,
345 VNC_AUTH_TLS = 18,
346 VNC_AUTH_VENCRYPT = 19,
347 VNC_AUTH_SASL = 20,
348};
349
350enum {
351 VNC_AUTH_VENCRYPT_PLAIN = 256,
352 VNC_AUTH_VENCRYPT_TLSNONE = 257,
353 VNC_AUTH_VENCRYPT_TLSVNC = 258,
354 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
355 VNC_AUTH_VENCRYPT_X509NONE = 260,
356 VNC_AUTH_VENCRYPT_X509VNC = 261,
357 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
358 VNC_AUTH_VENCRYPT_X509SASL = 263,
359 VNC_AUTH_VENCRYPT_TLSSASL = 264,
360};
361
362
363
364
365
366
367
368
369#define VNC_ENCODING_RAW 0x00000000
370#define VNC_ENCODING_COPYRECT 0x00000001
371#define VNC_ENCODING_RRE 0x00000002
372#define VNC_ENCODING_CORRE 0x00000004
373#define VNC_ENCODING_HEXTILE 0x00000005
374#define VNC_ENCODING_ZLIB 0x00000006
375#define VNC_ENCODING_TIGHT 0x00000007
376#define VNC_ENCODING_ZLIBHEX 0x00000008
377#define VNC_ENCODING_TRLE 0x0000000f
378#define VNC_ENCODING_ZRLE 0x00000010
379#define VNC_ENCODING_ZYWRLE 0x00000011
380#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00
381#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0
382#define VNC_ENCODING_XCURSOR 0xFFFFFF10
383#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11
384#define VNC_ENCODING_POINTER_POS 0xFFFFFF18
385#define VNC_ENCODING_LASTRECT 0xFFFFFF20
386#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21
387#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF
388#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE
389#define VNC_ENCODING_AUDIO 0XFFFFFEFD
390#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC
391#define VNC_ENCODING_LED_STATE 0XFFFFFEFB
392#define VNC_ENCODING_WMVi 0x574D5669
393
394
395
396
397
398
399
400
401
402
403
404#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
405#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
406#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
407#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
408#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
409#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
410#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
411#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
412
413
414
415
416
417
418
419#define VNC_FEATURE_RESIZE 0
420#define VNC_FEATURE_HEXTILE 1
421#define VNC_FEATURE_POINTER_TYPE_CHANGE 2
422#define VNC_FEATURE_WMVI 3
423#define VNC_FEATURE_TIGHT 4
424#define VNC_FEATURE_ZLIB 5
425#define VNC_FEATURE_COPYRECT 6
426#define VNC_FEATURE_RICH_CURSOR 7
427#define VNC_FEATURE_TIGHT_PNG 8
428#define VNC_FEATURE_ZRLE 9
429#define VNC_FEATURE_ZYWRLE 10
430#define VNC_FEATURE_LED_STATE 11
431
432#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
433#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
434#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
435#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
436#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
437#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
438#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
439#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
440#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
441#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
442#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
443#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
444
445
446
447#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
448#define VNC_MSG_CLIENT_SET_ENCODINGS 2
449#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
450#define VNC_MSG_CLIENT_KEY_EVENT 4
451#define VNC_MSG_CLIENT_POINTER_EVENT 5
452#define VNC_MSG_CLIENT_CUT_TEXT 6
453#define VNC_MSG_CLIENT_VMWARE_0 127
454#define VNC_MSG_CLIENT_CALL_CONTROL 249
455#define VNC_MSG_CLIENT_XVP 250
456#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
457#define VNC_MSG_CLIENT_TIGHT 252
458#define VNC_MSG_CLIENT_GII 253
459#define VNC_MSG_CLIENT_VMWARE_1 254
460#define VNC_MSG_CLIENT_QEMU 255
461
462
463#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
464#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
465#define VNC_MSG_SERVER_BELL 2
466#define VNC_MSG_SERVER_CUT_TEXT 3
467#define VNC_MSG_SERVER_VMWARE_0 127
468#define VNC_MSG_SERVER_CALL_CONTROL 249
469#define VNC_MSG_SERVER_XVP 250
470#define VNC_MSG_SERVER_TIGHT 252
471#define VNC_MSG_SERVER_GII 253
472#define VNC_MSG_SERVER_VMWARE_1 254
473#define VNC_MSG_SERVER_QEMU 255
474
475
476
477
478#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
479#define VNC_MSG_CLIENT_QEMU_AUDIO 1
480
481
482#define VNC_MSG_SERVER_QEMU_AUDIO 1
483
484
485
486
487#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
488#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
489#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
490
491
492#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
493#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
494#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
495
496
497
498
499
500
501
502
503
504gboolean vnc_client_io(QIOChannel *ioc,
505 GIOCondition condition,
506 void *opaque);
507
508ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
509ssize_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
510
511
512void vnc_write(VncState *vs, const void *data, size_t len);
513void vnc_write_u32(VncState *vs, uint32_t value);
514void vnc_write_s32(VncState *vs, int32_t value);
515void vnc_write_u16(VncState *vs, uint16_t value);
516void vnc_write_u8(VncState *vs, uint8_t value);
517void vnc_flush(VncState *vs);
518void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
519void vnc_disconnect_finish(VncState *vs);
520void vnc_init_state(VncState *vs);
521
522
523
524uint32_t read_u32(uint8_t *data, size_t offset);
525
526
527void vnc_client_error(VncState *vs);
528ssize_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp);
529
530void start_client_init(VncState *vs);
531void start_auth_vnc(VncState *vs);
532
533
534
535
536static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
537 return (vs->features & (1 << feature));
538}
539
540
541void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
542 int32_t encoding);
543
544
545#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
546#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
547#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
548
549void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
550int vnc_server_fb_stride(VncDisplay *vd);
551
552void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
553double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
554void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
555
556
557int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
558
559int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
560
561int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
562 int y, int w, int h);
563void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
564
565void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
566void vnc_zlib_zfree(void *x, void *addr);
567int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
568void vnc_zlib_clear(VncState *vs);
569
570int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
571int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
572 int w, int h);
573void vnc_tight_clear(VncState *vs);
574
575int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
576int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
577void vnc_zrle_clear(VncState *vs);
578
579#endif
580