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 <zlib.h>
39#include <stdbool.h>
40
41#include "keymaps.h"
42#include "vnc-palette.h"
43#include "vnc-enc-zrle.h"
44#include "qapi-types.h"
45
46
47
48#ifdef _VNC_DEBUG
49#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
50#else
51#define VNC_DEBUG(fmt, ...) do { } while (0)
52#endif
53
54
55
56
57
58
59
60typedef struct VncState VncState;
61typedef struct VncJob VncJob;
62typedef struct VncRect VncRect;
63typedef struct VncRectEntry VncRectEntry;
64
65typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
66
67typedef void VncWritePixels(VncState *vs, void *data, int size);
68
69typedef void VncSendHextileTile(VncState *vs,
70 int x, int y, int w, int h,
71 void *last_bg,
72 void *last_fg,
73 int *has_bg, int *has_fg);
74
75
76
77#define VNC_DIRTY_PIXELS_PER_BIT 16
78
79
80
81#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
82#define VNC_MAX_HEIGHT 2048
83
84
85#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
86
87
88
89#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
90
91#define VNC_STAT_RECT 64
92#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
93#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
94
95#define VNC_AUTH_CHALLENGE_SIZE 16
96
97typedef struct VncDisplay VncDisplay;
98
99#include "vnc-auth-vencrypt.h"
100#ifdef CONFIG_VNC_SASL
101#include "vnc-auth-sasl.h"
102#endif
103#include "vnc-ws.h"
104
105struct VncRectStat
106{
107
108 struct timeval times[10];
109 int idx;
110
111 double freq;
112 bool updated;
113};
114
115typedef struct VncRectStat VncRectStat;
116
117struct VncSurface
118{
119 struct timeval last_freq_check;
120 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
121 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
122 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
123 pixman_image_t *fb;
124 pixman_format_code_t format;
125};
126
127typedef enum VncShareMode {
128 VNC_SHARE_MODE_CONNECTING = 1,
129 VNC_SHARE_MODE_SHARED,
130 VNC_SHARE_MODE_EXCLUSIVE,
131 VNC_SHARE_MODE_DISCONNECTED,
132} VncShareMode;
133
134typedef enum VncSharePolicy {
135 VNC_SHARE_POLICY_IGNORE = 1,
136 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
137 VNC_SHARE_POLICY_FORCE_SHARED,
138} VncSharePolicy;
139
140struct VncDisplay
141{
142 QTAILQ_HEAD(, VncState) clients;
143 int num_connecting;
144 int num_shared;
145 int num_exclusive;
146 int connections_limit;
147 VncSharePolicy share_policy;
148 int lsock;
149 int lwebsock;
150 bool ws_enabled;
151 DisplaySurface *ds;
152 DisplayChangeListener dcl;
153 kbd_layout_t *kbd_layout;
154 int lock_key_sync;
155 QemuMutex mutex;
156
157 QEMUCursor *cursor;
158 int cursor_msize;
159 uint8_t *cursor_mask;
160
161 struct VncSurface guest;
162 pixman_image_t *server;
163
164 const char *id;
165 QTAILQ_ENTRY(VncDisplay) next;
166 bool enabled;
167 bool is_unix;
168 char *password;
169 time_t expires;
170 int auth;
171 int subauth;
172 int ws_auth;
173 bool ws_tls;
174 bool lossy;
175 bool non_adaptive;
176 QCryptoTLSCreds *tlscreds;
177 char *tlsaclname;
178#ifdef CONFIG_VNC_SASL
179 VncDisplaySASL sasl;
180#endif
181};
182
183typedef struct VncTight {
184 int type;
185 uint8_t quality;
186 uint8_t compression;
187 uint8_t pixel24;
188 Buffer tight;
189 Buffer tmp;
190 Buffer zlib;
191 Buffer gradient;
192#ifdef CONFIG_VNC_JPEG
193 Buffer jpeg;
194#endif
195#ifdef CONFIG_VNC_PNG
196 Buffer png;
197#endif
198 int levels[4];
199 z_stream stream[4];
200} VncTight;
201
202typedef struct VncHextile {
203 VncSendHextileTile *send_tile;
204} VncHextile;
205
206typedef struct VncZlib {
207 Buffer zlib;
208 Buffer tmp;
209 z_stream stream;
210 int level;
211} VncZlib;
212
213typedef struct VncZrle {
214 int type;
215 Buffer fb;
216 Buffer zrle;
217 Buffer tmp;
218 Buffer zlib;
219 z_stream stream;
220 VncPalette palette;
221} VncZrle;
222
223typedef struct VncZywrle {
224 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
225} VncZywrle;
226
227struct VncRect
228{
229 int x;
230 int y;
231 int w;
232 int h;
233};
234
235struct VncRectEntry
236{
237 struct VncRect rect;
238 QLIST_ENTRY(VncRectEntry) next;
239};
240
241struct VncJob
242{
243 VncState *vs;
244
245 QLIST_HEAD(, VncRectEntry) rectangles;
246 QTAILQ_ENTRY(VncJob) next;
247};
248
249struct VncState
250{
251 int csock;
252
253 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
254 uint8_t **lossy_rect;
255
256
257 VncDisplay *vd;
258 int need_update;
259 int force_update;
260 int has_dirty;
261 uint32_t features;
262 int absolute;
263 int last_x;
264 int last_y;
265 uint32_t last_bmask;
266 int client_width;
267 int client_height;
268 VncShareMode share_mode;
269
270 uint32_t vnc_encoding;
271
272 int major;
273 int minor;
274
275 int auth;
276 int subauth;
277 char challenge[VNC_AUTH_CHALLENGE_SIZE];
278 QCryptoTLSSession *tls;
279#ifdef CONFIG_VNC_SASL
280 VncStateSASL sasl;
281#endif
282 bool encode_ws;
283 bool websocket;
284
285 VncClientInfo *info;
286
287 Buffer output;
288 Buffer input;
289 Buffer ws_input;
290 Buffer ws_output;
291 size_t ws_payload_remain;
292 WsMask ws_payload_mask;
293
294 VncWritePixels *write_pixels;
295 PixelFormat client_pf;
296 pixman_format_code_t client_format;
297 bool client_be;
298
299 CaptureVoiceOut *audio_cap;
300 struct audsettings as;
301
302 VncReadEvent *read_handler;
303 size_t read_handler_expect;
304
305 uint8_t modifiers_state[256];
306 QEMUPutLEDEntry *led;
307
308 bool abort;
309 bool initialized;
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
502void vnc_client_read(void *opaque);
503void vnc_client_write(void *opaque);
504
505ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
506ssize_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
507ssize_t vnc_tls_pull(char *buf, size_t len, void *opaque);
508ssize_t vnc_tls_push(const char *buf, size_t len, void *opaque);
509
510
511void vnc_write(VncState *vs, const void *data, size_t len);
512void vnc_write_u32(VncState *vs, uint32_t value);
513void vnc_write_s32(VncState *vs, int32_t value);
514void vnc_write_u16(VncState *vs, uint16_t value);
515void vnc_write_u8(VncState *vs, uint8_t value);
516void vnc_flush(VncState *vs);
517void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
518void vnc_disconnect_finish(VncState *vs);
519void vnc_init_state(VncState *vs);
520
521
522
523uint32_t read_u32(uint8_t *data, size_t offset);
524
525
526void vnc_client_error(VncState *vs);
527ssize_t vnc_client_io_error(VncState *vs, ssize_t ret, int last_errno);
528
529void start_client_init(VncState *vs);
530void start_auth_vnc(VncState *vs);
531
532
533
534
535char *vnc_socket_local_addr(const char *format, int fd);
536char *vnc_socket_remote_addr(const char *format, int fd);
537
538static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
539 return (vs->features & (1 << feature));
540}
541
542
543void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
544 int32_t encoding);
545
546
547#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
548#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
549#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
550
551void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
552int vnc_server_fb_stride(VncDisplay *vd);
553
554void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
555double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
556void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
557
558
559int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
560
561int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
562
563int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
564 int y, int w, int h);
565void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
566
567void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
568void vnc_zlib_zfree(void *x, void *addr);
569int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
570void vnc_zlib_clear(VncState *vs);
571
572int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
573int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
574 int w, int h);
575void vnc_tight_clear(VncState *vs);
576
577int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
578int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
579void vnc_zrle_clear(VncState *vs);
580
581#endif
582