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