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 "monitor/monitor.h"
35#include "audio/audio.h"
36#include "qemu/bitmap.h"
37#include <zlib.h>
38#include <stdbool.h>
39
40#include "keymaps.h"
41#include "vnc-palette.h"
42#include "vnc-enc-zrle.h"
43
44
45
46#ifdef _VNC_DEBUG
47#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
48#else
49#define VNC_DEBUG(fmt, ...) do { } while (0)
50#endif
51
52
53
54
55
56
57
58typedef struct Buffer
59{
60 size_t capacity;
61 size_t offset;
62 uint8_t *buffer;
63} Buffer;
64
65typedef struct VncState VncState;
66typedef struct VncJob VncJob;
67typedef struct VncRect VncRect;
68typedef struct VncRectEntry VncRectEntry;
69
70typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
71
72typedef void VncWritePixels(VncState *vs, void *data, int size);
73
74typedef void VncSendHextileTile(VncState *vs,
75 int x, int y, int w, int h,
76 void *last_bg,
77 void *last_fg,
78 int *has_bg, int *has_fg);
79
80
81#define VNC_MAX_WIDTH 2560
82#define VNC_MAX_HEIGHT 2048
83
84
85#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / 16)
86
87#define VNC_STAT_RECT 64
88#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
89#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
90
91#define VNC_AUTH_CHALLENGE_SIZE 16
92
93typedef struct VncDisplay VncDisplay;
94
95#ifdef CONFIG_VNC_TLS
96#include "vnc-tls.h"
97#include "vnc-auth-vencrypt.h"
98#endif
99#ifdef CONFIG_VNC_SASL
100#include "vnc-auth-sasl.h"
101#endif
102#ifdef CONFIG_VNC_WS
103#include "vnc-ws.h"
104#endif
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], VNC_MAX_WIDTH / 16);
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_exclusive;
144 VncSharePolicy share_policy;
145 int lsock;
146#ifdef CONFIG_VNC_WS
147 int lwebsock;
148 bool websocket;
149 char *ws_display;
150#endif
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 char *display;
165 char *password;
166 time_t expires;
167 int auth;
168 bool lossy;
169 bool non_adaptive;
170#ifdef CONFIG_VNC_TLS
171 int subauth;
172 VncDisplayTLS tls;
173#endif
174#ifdef CONFIG_VNC_SASL
175 VncDisplaySASL sasl;
176#endif
177};
178
179typedef struct VncTight {
180 int type;
181 uint8_t quality;
182 uint8_t compression;
183 uint8_t pixel24;
184 Buffer tight;
185 Buffer tmp;
186 Buffer zlib;
187 Buffer gradient;
188#ifdef CONFIG_VNC_JPEG
189 Buffer jpeg;
190#endif
191#ifdef CONFIG_VNC_PNG
192 Buffer png;
193#endif
194 int levels[4];
195 z_stream stream[4];
196} VncTight;
197
198typedef struct VncHextile {
199 VncSendHextileTile *send_tile;
200} VncHextile;
201
202typedef struct VncZlib {
203 Buffer zlib;
204 Buffer tmp;
205 z_stream stream;
206 int level;
207} VncZlib;
208
209typedef struct VncZrle {
210 int type;
211 Buffer fb;
212 Buffer zrle;
213 Buffer tmp;
214 Buffer zlib;
215 z_stream stream;
216 VncPalette palette;
217} VncZrle;
218
219typedef struct VncZywrle {
220 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
221} VncZywrle;
222
223struct VncRect
224{
225 int x;
226 int y;
227 int w;
228 int h;
229};
230
231struct VncRectEntry
232{
233 struct VncRect rect;
234 QLIST_ENTRY(VncRectEntry) next;
235};
236
237struct VncJob
238{
239 VncState *vs;
240
241 QLIST_HEAD(, VncRectEntry) rectangles;
242 QTAILQ_ENTRY(VncJob) next;
243};
244
245struct VncState
246{
247 int csock;
248
249 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
250 uint8_t **lossy_rect;
251
252
253 VncDisplay *vd;
254 int need_update;
255 int force_update;
256 uint32_t features;
257 int absolute;
258 int last_x;
259 int last_y;
260 int client_width;
261 int client_height;
262 VncShareMode share_mode;
263
264 uint32_t vnc_encoding;
265
266 int major;
267 int minor;
268
269 int auth;
270 char challenge[VNC_AUTH_CHALLENGE_SIZE];
271#ifdef CONFIG_VNC_TLS
272 int subauth;
273 VncStateTLS tls;
274#endif
275#ifdef CONFIG_VNC_SASL
276 VncStateSASL sasl;
277#endif
278#ifdef CONFIG_VNC_WS
279#ifdef CONFIG_VNC_TLS
280 VncStateTLS ws_tls;
281#endif
282 bool encode_ws;
283 bool websocket;
284#endif
285
286 QObject *info;
287
288 Buffer output;
289 Buffer input;
290#ifdef CONFIG_VNC_WS
291 Buffer ws_input;
292 Buffer ws_output;
293#endif
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 bool initialized;
311 QemuMutex output_mutex;
312 QEMUBH *bh;
313 Buffer jobs_buffer;
314
315
316
317
318 VncTight tight;
319 VncZlib zlib;
320 VncHextile hextile;
321 VncZrle zrle;
322 VncZywrle zywrle;
323
324 Notifier mouse_mode_notifier;
325
326 QTAILQ_ENTRY(VncState) next;
327};
328
329
330
331
332
333
334
335
336enum {
337 VNC_AUTH_INVALID = 0,
338 VNC_AUTH_NONE = 1,
339 VNC_AUTH_VNC = 2,
340 VNC_AUTH_RA2 = 5,
341 VNC_AUTH_RA2NE = 6,
342 VNC_AUTH_TIGHT = 16,
343 VNC_AUTH_ULTRA = 17,
344 VNC_AUTH_TLS = 18,
345 VNC_AUTH_VENCRYPT = 19,
346 VNC_AUTH_SASL = 20,
347};
348
349enum {
350 VNC_AUTH_VENCRYPT_PLAIN = 256,
351 VNC_AUTH_VENCRYPT_TLSNONE = 257,
352 VNC_AUTH_VENCRYPT_TLSVNC = 258,
353 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
354 VNC_AUTH_VENCRYPT_X509NONE = 260,
355 VNC_AUTH_VENCRYPT_X509VNC = 261,
356 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
357 VNC_AUTH_VENCRYPT_X509SASL = 263,
358 VNC_AUTH_VENCRYPT_TLSSASL = 264,
359};
360
361
362
363
364
365
366
367
368#define VNC_ENCODING_RAW 0x00000000
369#define VNC_ENCODING_COPYRECT 0x00000001
370#define VNC_ENCODING_RRE 0x00000002
371#define VNC_ENCODING_CORRE 0x00000004
372#define VNC_ENCODING_HEXTILE 0x00000005
373#define VNC_ENCODING_ZLIB 0x00000006
374#define VNC_ENCODING_TIGHT 0x00000007
375#define VNC_ENCODING_ZLIBHEX 0x00000008
376#define VNC_ENCODING_TRLE 0x0000000f
377#define VNC_ENCODING_ZRLE 0x00000010
378#define VNC_ENCODING_ZYWRLE 0x00000011
379#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00
380#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0
381#define VNC_ENCODING_XCURSOR 0xFFFFFF10
382#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11
383#define VNC_ENCODING_POINTER_POS 0xFFFFFF18
384#define VNC_ENCODING_LASTRECT 0xFFFFFF20
385#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21
386#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF
387#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE
388#define VNC_ENCODING_AUDIO 0XFFFFFEFD
389#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC
390#define VNC_ENCODING_LED_STATE 0XFFFFFEFB
391#define VNC_ENCODING_WMVi 0x574D5669
392
393
394
395
396
397
398
399
400
401
402
403#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
404#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
405#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
406#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
407#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
408#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
409#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
410#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
411
412
413
414
415
416
417
418#define VNC_FEATURE_RESIZE 0
419#define VNC_FEATURE_HEXTILE 1
420#define VNC_FEATURE_POINTER_TYPE_CHANGE 2
421#define VNC_FEATURE_WMVI 3
422#define VNC_FEATURE_TIGHT 4
423#define VNC_FEATURE_ZLIB 5
424#define VNC_FEATURE_COPYRECT 6
425#define VNC_FEATURE_RICH_CURSOR 7
426#define VNC_FEATURE_TIGHT_PNG 8
427#define VNC_FEATURE_ZRLE 9
428#define VNC_FEATURE_ZYWRLE 10
429#define VNC_FEATURE_LED_STATE 11
430
431#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
432#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
433#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
434#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
435#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
436#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
437#define VNC_FEATURE_COPYRECT_MASK (1 << VNC_FEATURE_COPYRECT)
438#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
439#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
440#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
441#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
442#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
443
444
445
446#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
447#define VNC_MSG_CLIENT_SET_ENCODINGS 2
448#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
449#define VNC_MSG_CLIENT_KEY_EVENT 4
450#define VNC_MSG_CLIENT_POINTER_EVENT 5
451#define VNC_MSG_CLIENT_CUT_TEXT 6
452#define VNC_MSG_CLIENT_VMWARE_0 127
453#define VNC_MSG_CLIENT_CALL_CONTROL 249
454#define VNC_MSG_CLIENT_XVP 250
455#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
456#define VNC_MSG_CLIENT_TIGHT 252
457#define VNC_MSG_CLIENT_GII 253
458#define VNC_MSG_CLIENT_VMWARE_1 254
459#define VNC_MSG_CLIENT_QEMU 255
460
461
462#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
463#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
464#define VNC_MSG_SERVER_BELL 2
465#define VNC_MSG_SERVER_CUT_TEXT 3
466#define VNC_MSG_SERVER_VMWARE_0 127
467#define VNC_MSG_SERVER_CALL_CONTROL 249
468#define VNC_MSG_SERVER_XVP 250
469#define VNC_MSG_SERVER_TIGHT 252
470#define VNC_MSG_SERVER_GII 253
471#define VNC_MSG_SERVER_VMWARE_1 254
472#define VNC_MSG_SERVER_QEMU 255
473
474
475
476
477#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
478#define VNC_MSG_CLIENT_QEMU_AUDIO 1
479
480
481#define VNC_MSG_SERVER_QEMU_AUDIO 1
482
483
484
485
486#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
487#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
488#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
489
490
491#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
492#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
493#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
494
495
496
497
498
499
500
501
502
503void vnc_client_read(void *opaque);
504void vnc_client_write(void *opaque);
505
506long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
507long 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_init_state(VncState *vs);
519
520
521
522uint32_t read_u32(uint8_t *data, size_t offset);
523
524
525void vnc_client_error(VncState *vs);
526int vnc_client_io_error(VncState *vs, int ret, int last_errno);
527
528void start_client_init(VncState *vs);
529void start_auth_vnc(VncState *vs);
530
531
532void buffer_reserve(Buffer *buffer, size_t len);
533void buffer_reset(Buffer *buffer);
534void buffer_free(Buffer *buffer);
535void buffer_append(Buffer *buffer, const void *data, size_t len);
536void buffer_advance(Buffer *buf, size_t len);
537uint8_t *buffer_end(Buffer *buffer);
538
539
540
541
542char *vnc_socket_local_addr(const char *format, int fd);
543char *vnc_socket_remote_addr(const char *format, int fd);
544
545static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
546 return (vs->features & (1 << feature));
547}
548
549
550void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
551 int32_t encoding);
552
553
554#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
555#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
556#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
557
558void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
559int vnc_server_fb_stride(VncDisplay *vd);
560
561void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
562double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
563void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
564
565
566int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
567
568int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
569
570int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
571 int y, int w, int h);
572void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
573
574void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
575void vnc_zlib_zfree(void *x, void *addr);
576int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
577void vnc_zlib_clear(VncState *vs);
578
579int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
580int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
581 int w, int h);
582void vnc_tight_clear(VncState *vs);
583
584int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
585int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
586void vnc_zrle_clear(VncState *vs);
587
588#endif
589