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