2 * QEMU VNC display driver
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
6 * Copyright (C) 2009 Red Hat, Inc
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29 #include "qemu_socket.h"
30 #include "qemu-timer.h"
33 #define VNC_REFRESH_INTERVAL (1000 / 30)
35 #include "vnc_keysym.h"
38 #define count_bits(c, v) { \
39 for (c = 0; v; v >>= 1) \
46 static VncDisplay
*vnc_display
; /* needed for info vnc */
47 static DisplayChangeListener
*dcl
;
49 static char *addr_to_string(const char *format
,
50 struct sockaddr_storage
*sa
,
53 char host
[NI_MAXHOST
];
54 char serv
[NI_MAXSERV
];
58 if ((err
= getnameinfo((struct sockaddr
*)sa
, salen
,
61 NI_NUMERICHOST
| NI_NUMERICSERV
)) != 0) {
62 VNC_DEBUG("Cannot resolve address %d: %s\n",
63 err
, gai_strerror(err
));
67 /* Enough for the existing format + the 2 vars we're
69 addrlen
= strlen(format
) + strlen(host
) + strlen(serv
);
70 addr
= qemu_malloc(addrlen
+ 1);
71 snprintf(addr
, addrlen
, format
, host
, serv
);
78 char *vnc_socket_local_addr(const char *format
, int fd
) {
79 struct sockaddr_storage sa
;
83 if (getsockname(fd
, (struct sockaddr
*)&sa
, &salen
) < 0)
86 return addr_to_string(format
, &sa
, salen
);
90 char *vnc_socket_remote_addr(const char *format
, int fd
) {
91 struct sockaddr_storage sa
;
95 if (getpeername(fd
, (struct sockaddr
*)&sa
, &salen
) < 0)
98 return addr_to_string(format
, &sa
, salen
);
101 static const char *vnc_auth_name(VncDisplay
*vd
) {
103 case VNC_AUTH_INVALID
:
119 case VNC_AUTH_VENCRYPT
:
120 #ifdef CONFIG_VNC_TLS
121 switch (vd
->subauth
) {
122 case VNC_AUTH_VENCRYPT_PLAIN
:
123 return "vencrypt+plain";
124 case VNC_AUTH_VENCRYPT_TLSNONE
:
125 return "vencrypt+tls+none";
126 case VNC_AUTH_VENCRYPT_TLSVNC
:
127 return "vencrypt+tls+vnc";
128 case VNC_AUTH_VENCRYPT_TLSPLAIN
:
129 return "vencrypt+tls+plain";
130 case VNC_AUTH_VENCRYPT_X509NONE
:
131 return "vencrypt+x509+none";
132 case VNC_AUTH_VENCRYPT_X509VNC
:
133 return "vencrypt+x509+vnc";
134 case VNC_AUTH_VENCRYPT_X509PLAIN
:
135 return "vencrypt+x509+plain";
136 case VNC_AUTH_VENCRYPT_TLSSASL
:
137 return "vencrypt+tls+sasl";
138 case VNC_AUTH_VENCRYPT_X509SASL
:
139 return "vencrypt+x509+sasl";
152 static void do_info_vnc_client(Monitor
*mon
, VncState
*client
)
155 vnc_socket_remote_addr(" address: %s:%s\n",
160 monitor_printf(mon
, "Client:\n");
161 monitor_printf(mon
, "%s", clientAddr
);
164 #ifdef CONFIG_VNC_TLS
165 if (client
->tls
.session
&&
167 monitor_printf(mon
, " x509 dname: %s\n", client
->tls
.dname
);
169 monitor_printf(mon
, " x509 dname: none\n");
171 #ifdef CONFIG_VNC_SASL
172 if (client
->sasl
.conn
&&
173 client
->sasl
.username
)
174 monitor_printf(mon
, " username: %s\n", client
->sasl
.username
);
176 monitor_printf(mon
, " username: none\n");
180 void do_info_vnc(Monitor
*mon
)
182 if (vnc_display
== NULL
|| vnc_display
->display
== NULL
) {
183 monitor_printf(mon
, "Server: disabled\n");
185 char *serverAddr
= vnc_socket_local_addr(" address: %s:%s\n",
191 monitor_printf(mon
, "Server:\n");
192 monitor_printf(mon
, "%s", serverAddr
);
194 monitor_printf(mon
, " auth: %s\n", vnc_auth_name(vnc_display
));
196 if (vnc_display
->clients
) {
197 VncState
*client
= vnc_display
->clients
;
199 do_info_vnc_client(mon
, client
);
200 client
= client
->next
;
203 monitor_printf(mon
, "Client: none\n");
208 static inline uint32_t vnc_has_feature(VncState
*vs
, int feature
) {
209 return (vs
->features
& (1 << feature
));
213 1) Get the queue working for IO.
214 2) there is some weirdness when using the -S option (the screen is grey
215 and not totally invalidated
216 3) resolutions > 1024
219 static void vnc_update_client(void *opaque
);
221 static void vnc_colordepth(VncState
*vs
);
223 static inline void vnc_set_bit(uint32_t *d
, int k
)
225 d
[k
>> 5] |= 1 << (k
& 0x1f);
228 static inline void vnc_clear_bit(uint32_t *d
, int k
)
230 d
[k
>> 5] &= ~(1 << (k
& 0x1f));
233 static inline void vnc_set_bits(uint32_t *d
, int n
, int nb_words
)
243 d
[j
++] = (1 << n
) - 1;
248 static inline int vnc_get_bit(const uint32_t *d
, int k
)
250 return (d
[k
>> 5] >> (k
& 0x1f)) & 1;
253 static inline int vnc_and_bits(const uint32_t *d1
, const uint32_t *d2
,
257 for(i
= 0; i
< nb_words
; i
++) {
258 if ((d1
[i
] & d2
[i
]) != 0)
264 static void vnc_update(VncState
*vs
, int x
, int y
, int w
, int h
)
266 struct VncSurface
*s
= &vs
->guest
;
271 /* round x down to ensure the loop only spans one 16-pixel block per,
272 iteration. otherwise, if (x % 16) != 0, the last iteration may span
273 two 16-pixel blocks but we only mark the first as dirty
278 x
= MIN(x
, s
->ds
->width
);
279 y
= MIN(y
, s
->ds
->height
);
280 w
= MIN(x
+ w
, s
->ds
->width
) - x
;
281 h
= MIN(h
, s
->ds
->height
);
284 for (i
= 0; i
< w
; i
+= 16)
285 vnc_set_bit(s
->dirty
[y
], (x
+ i
) / 16);
288 static void vnc_dpy_update(DisplayState
*ds
, int x
, int y
, int w
, int h
)
290 VncDisplay
*vd
= ds
->opaque
;
291 VncState
*vs
= vd
->clients
;
293 vnc_update(vs
, x
, y
, w
, h
);
298 static void vnc_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
,
301 vnc_write_u16(vs
, x
);
302 vnc_write_u16(vs
, y
);
303 vnc_write_u16(vs
, w
);
304 vnc_write_u16(vs
, h
);
306 vnc_write_s32(vs
, encoding
);
309 void buffer_reserve(Buffer
*buffer
, size_t len
)
311 if ((buffer
->capacity
- buffer
->offset
) < len
) {
312 buffer
->capacity
+= (len
+ 1024);
313 buffer
->buffer
= qemu_realloc(buffer
->buffer
, buffer
->capacity
);
314 if (buffer
->buffer
== NULL
) {
315 fprintf(stderr
, "vnc: out of memory\n");
321 int buffer_empty(Buffer
*buffer
)
323 return buffer
->offset
== 0;
326 uint8_t *buffer_end(Buffer
*buffer
)
328 return buffer
->buffer
+ buffer
->offset
;
331 void buffer_reset(Buffer
*buffer
)
336 void buffer_append(Buffer
*buffer
, const void *data
, size_t len
)
338 memcpy(buffer
->buffer
+ buffer
->offset
, data
, len
);
339 buffer
->offset
+= len
;
342 static void vnc_resize(VncState
*vs
)
344 DisplayState
*ds
= vs
->ds
;
349 vs
->guest
.ds
= qemu_mallocz(sizeof(*vs
->guest
.ds
));
350 if (ds_get_bytes_per_pixel(ds
) != vs
->guest
.ds
->pf
.bytes_per_pixel
)
351 console_color_init(ds
);
353 size_changed
= ds_get_width(ds
) != vs
->guest
.ds
->width
||
354 ds_get_height(ds
) != vs
->guest
.ds
->height
;
355 *(vs
->guest
.ds
) = *(ds
->surface
);
357 if (vs
->csock
!= -1 && vnc_has_feature(vs
, VNC_FEATURE_RESIZE
)) {
358 vnc_write_u8(vs
, 0); /* msg id */
360 vnc_write_u16(vs
, 1); /* number of rects */
361 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(ds
), ds_get_height(ds
),
362 VNC_ENCODING_DESKTOPRESIZE
);
366 memset(vs
->guest
.dirty
, 0xFF, sizeof(vs
->guest
.dirty
));
370 vs
->server
.ds
= qemu_mallocz(sizeof(*vs
->server
.ds
));
371 if (vs
->server
.ds
->data
)
372 qemu_free(vs
->server
.ds
->data
);
373 *(vs
->server
.ds
) = *(ds
->surface
);
374 vs
->server
.ds
->data
= qemu_mallocz(vs
->server
.ds
->linesize
*
375 vs
->server
.ds
->height
);
376 memset(vs
->server
.dirty
, 0xFF, sizeof(vs
->guest
.dirty
));
379 static void vnc_dpy_resize(DisplayState
*ds
)
381 VncDisplay
*vd
= ds
->opaque
;
382 VncState
*vs
= vd
->clients
;
390 static void vnc_write_pixels_copy(VncState
*vs
, void *pixels
, int size
)
392 vnc_write(vs
, pixels
, size
);
395 /* slowest but generic code. */
396 static void vnc_convert_pixel(VncState
*vs
, uint8_t *buf
, uint32_t v
)
400 r
= ((((v
& vs
->server
.ds
->pf
.rmask
) >> vs
->server
.ds
->pf
.rshift
) << vs
->clientds
.pf
.rbits
) >>
401 vs
->server
.ds
->pf
.rbits
);
402 g
= ((((v
& vs
->server
.ds
->pf
.gmask
) >> vs
->server
.ds
->pf
.gshift
) << vs
->clientds
.pf
.gbits
) >>
403 vs
->server
.ds
->pf
.gbits
);
404 b
= ((((v
& vs
->server
.ds
->pf
.bmask
) >> vs
->server
.ds
->pf
.bshift
) << vs
->clientds
.pf
.bbits
) >>
405 vs
->server
.ds
->pf
.bbits
);
406 v
= (r
<< vs
->clientds
.pf
.rshift
) |
407 (g
<< vs
->clientds
.pf
.gshift
) |
408 (b
<< vs
->clientds
.pf
.bshift
);
409 switch(vs
->clientds
.pf
.bytes_per_pixel
) {
414 if (vs
->clientds
.flags
& QEMU_BIG_ENDIAN_FLAG
) {
424 if (vs
->clientds
.flags
& QEMU_BIG_ENDIAN_FLAG
) {
439 static void vnc_write_pixels_generic(VncState
*vs
, void *pixels1
, int size
)
443 if (vs
->server
.ds
->pf
.bytes_per_pixel
== 4) {
444 uint32_t *pixels
= pixels1
;
447 for(i
= 0; i
< n
; i
++) {
448 vnc_convert_pixel(vs
, buf
, pixels
[i
]);
449 vnc_write(vs
, buf
, vs
->clientds
.pf
.bytes_per_pixel
);
451 } else if (vs
->server
.ds
->pf
.bytes_per_pixel
== 2) {
452 uint16_t *pixels
= pixels1
;
455 for(i
= 0; i
< n
; i
++) {
456 vnc_convert_pixel(vs
, buf
, pixels
[i
]);
457 vnc_write(vs
, buf
, vs
->clientds
.pf
.bytes_per_pixel
);
459 } else if (vs
->server
.ds
->pf
.bytes_per_pixel
== 1) {
460 uint8_t *pixels
= pixels1
;
463 for(i
= 0; i
< n
; i
++) {
464 vnc_convert_pixel(vs
, buf
, pixels
[i
]);
465 vnc_write(vs
, buf
, vs
->clientds
.pf
.bytes_per_pixel
);
468 fprintf(stderr
, "vnc_write_pixels_generic: VncState color depth not supported\n");
472 static void send_framebuffer_update_raw(VncState
*vs
, int x
, int y
, int w
, int h
)
477 row
= vs
->server
.ds
->data
+ y
* ds_get_linesize(vs
->ds
) + x
* ds_get_bytes_per_pixel(vs
->ds
);
478 for (i
= 0; i
< h
; i
++) {
479 vs
->write_pixels(vs
, row
, w
* ds_get_bytes_per_pixel(vs
->ds
));
480 row
+= ds_get_linesize(vs
->ds
);
484 static void hextile_enc_cord(uint8_t *ptr
, int x
, int y
, int w
, int h
)
486 ptr
[0] = ((x
& 0x0F) << 4) | (y
& 0x0F);
487 ptr
[1] = (((w
- 1) & 0x0F) << 4) | ((h
- 1) & 0x0F);
491 #include "vnchextile.h"
495 #include "vnchextile.h"
499 #include "vnchextile.h"
504 #include "vnchextile.h"
510 #include "vnchextile.h"
516 #include "vnchextile.h"
520 static void send_framebuffer_update_hextile(VncState
*vs
, int x
, int y
, int w
, int h
)
524 uint8_t *last_fg
, *last_bg
;
526 last_fg
= (uint8_t *) qemu_malloc(vs
->server
.ds
->pf
.bytes_per_pixel
);
527 last_bg
= (uint8_t *) qemu_malloc(vs
->server
.ds
->pf
.bytes_per_pixel
);
529 for (j
= y
; j
< (y
+ h
); j
+= 16) {
530 for (i
= x
; i
< (x
+ w
); i
+= 16) {
531 vs
->send_hextile_tile(vs
, i
, j
,
532 MIN(16, x
+ w
- i
), MIN(16, y
+ h
- j
),
533 last_bg
, last_fg
, &has_bg
, &has_fg
);
541 static void vnc_zlib_init(VncState
*vs
)
544 for (i
=0; i
<(sizeof(vs
->zlib_stream
) / sizeof(z_stream
)); i
++)
545 vs
->zlib_stream
[i
].opaque
= NULL
;
548 static void vnc_zlib_start(VncState
*vs
)
550 buffer_reset(&vs
->zlib
);
552 // make the output buffer be the zlib buffer, so we can compress it later
553 vs
->zlib_tmp
= vs
->output
;
554 vs
->output
= vs
->zlib
;
557 static int vnc_zlib_stop(VncState
*vs
, int stream_id
)
559 z_streamp zstream
= &vs
->zlib_stream
[stream_id
];
562 // switch back to normal output/zlib buffers
563 vs
->zlib
= vs
->output
;
564 vs
->output
= vs
->zlib_tmp
;
566 // compress the zlib buffer
568 // initialize the stream
569 // XXX need one stream per session
570 if (zstream
->opaque
!= vs
) {
573 VNC_DEBUG("VNC: initializing zlib stream %d\n", stream_id
);
574 VNC_DEBUG("VNC: opaque = %p | vs = %p\n", zstream
->opaque
, vs
);
575 zstream
->zalloc
= Z_NULL
;
576 zstream
->zfree
= Z_NULL
;
578 err
= deflateInit2(zstream
, vs
->tight_compression
, Z_DEFLATED
, MAX_WBITS
,
579 MAX_MEM_LEVEL
, Z_DEFAULT_STRATEGY
);
582 fprintf(stderr
, "VNC: error initializing zlib\n");
586 zstream
->opaque
= vs
;
589 // XXX what to do if tight_compression changed in between?
591 // reserve memory in output buffer
592 buffer_reserve(&vs
->output
, vs
->zlib
.offset
+ 64);
595 zstream
->next_in
= vs
->zlib
.buffer
;
596 zstream
->avail_in
= vs
->zlib
.offset
;
597 zstream
->next_out
= vs
->output
.buffer
+ vs
->output
.offset
;
598 zstream
->avail_out
= vs
->output
.capacity
- vs
->output
.offset
;
599 zstream
->data_type
= Z_BINARY
;
600 previous_out
= zstream
->total_out
;
603 if (deflate(zstream
, Z_SYNC_FLUSH
) != Z_OK
) {
604 fprintf(stderr
, "VNC: error during zlib compression\n");
608 vs
->output
.offset
= vs
->output
.capacity
- zstream
->avail_out
;
609 return zstream
->total_out
- previous_out
;
612 static void send_framebuffer_update_zlib(VncState
*vs
, int x
, int y
, int w
, int h
)
614 int old_offset
, new_offset
, bytes_written
;
616 vnc_framebuffer_update(vs
, x
, y
, w
, h
, VNC_ENCODING_ZLIB
);
618 // remember where we put in the follow-up size
619 old_offset
= vs
->output
.offset
;
620 vnc_write_s32(vs
, 0);
622 // compress the stream
624 send_framebuffer_update_raw(vs
, x
, y
, w
, h
);
625 bytes_written
= vnc_zlib_stop(vs
, 0);
627 if (bytes_written
== -1)
631 new_offset
= vs
->output
.offset
;
632 vs
->output
.offset
= old_offset
;
633 vnc_write_u32(vs
, bytes_written
);
634 vs
->output
.offset
= new_offset
;
637 static void send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
)
639 switch(vs
->vnc_encoding
) {
640 case VNC_ENCODING_ZLIB
:
641 send_framebuffer_update_zlib(vs
, x
, y
, w
, h
);
643 case VNC_ENCODING_HEXTILE
:
644 vnc_framebuffer_update(vs
, x
, y
, w
, h
, VNC_ENCODING_HEXTILE
);
645 send_framebuffer_update_hextile(vs
, x
, y
, w
, h
);
648 vnc_framebuffer_update(vs
, x
, y
, w
, h
, VNC_ENCODING_RAW
);
649 send_framebuffer_update_raw(vs
, x
, y
, w
, h
);
654 static void vnc_copy(VncState
*vs
, int src_x
, int src_y
, int dst_x
, int dst_y
, int w
, int h
)
656 vs
->force_update
= 1;
657 vnc_update_client(vs
);
659 vnc_write_u8(vs
, 0); /* msg id */
661 vnc_write_u16(vs
, 1); /* number of rects */
662 vnc_framebuffer_update(vs
, dst_x
, dst_y
, w
, h
, VNC_ENCODING_COPYRECT
);
663 vnc_write_u16(vs
, src_x
);
664 vnc_write_u16(vs
, src_y
);
668 static void vnc_dpy_copy(DisplayState
*ds
, int src_x
, int src_y
, int dst_x
, int dst_y
, int w
, int h
)
670 VncDisplay
*vd
= ds
->opaque
;
671 VncState
*vs
= vd
->clients
;
673 if (vnc_has_feature(vs
, VNC_FEATURE_COPYRECT
))
674 vnc_copy(vs
, src_x
, src_y
, dst_x
, dst_y
, w
, h
);
676 vnc_update(vs
, dst_x
, dst_y
, w
, h
);
681 static int find_and_clear_dirty_height(struct VncSurface
*s
,
682 int y
, int last_x
, int x
)
686 for (h
= 1; h
< (s
->ds
->height
- y
); h
++) {
688 if (!vnc_get_bit(s
->dirty
[y
+ h
], last_x
))
690 for (tmp_x
= last_x
; tmp_x
< x
; tmp_x
++)
691 vnc_clear_bit(s
->dirty
[y
+ h
], tmp_x
);
697 static void vnc_update_client(void *opaque
)
699 VncState
*vs
= opaque
;
700 if (vs
->need_update
&& vs
->csock
!= -1) {
705 uint32_t width_mask
[VNC_DIRTY_WORDS
];
710 if (vs
->output
.offset
&& !vs
->audio_cap
&& !vs
->force_update
) {
711 /* kernel send buffers are full -> drop frames to throttle */
712 qemu_mod_timer(vs
->timer
, qemu_get_clock(rt_clock
) + VNC_REFRESH_INTERVAL
);
719 * Walk through the guest dirty map.
720 * Check and copy modified bits from guest to server surface.
721 * Update server dirty map.
723 vnc_set_bits(width_mask
, (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
724 cmp_bytes
= 16 * ds_get_bytes_per_pixel(vs
->ds
);
725 guest_row
= vs
->guest
.ds
->data
;
726 server_row
= vs
->server
.ds
->data
;
727 for (y
= 0; y
< vs
->guest
.ds
->height
; y
++) {
728 if (vnc_and_bits(vs
->guest
.dirty
[y
], width_mask
, VNC_DIRTY_WORDS
)) {
733 guest_ptr
= guest_row
;
734 server_ptr
= server_row
;
736 for (x
= 0; x
< vs
->guest
.ds
->width
;
737 x
+= 16, guest_ptr
+= cmp_bytes
, server_ptr
+= cmp_bytes
) {
738 if (!vnc_get_bit(vs
->guest
.dirty
[y
], (x
/ 16)))
740 vnc_clear_bit(vs
->guest
.dirty
[y
], (x
/ 16));
741 if (memcmp(server_ptr
, guest_ptr
, cmp_bytes
) == 0)
743 memcpy(server_ptr
, guest_ptr
, cmp_bytes
);
744 vnc_set_bit(vs
->server
.dirty
[y
], (x
/ 16));
748 guest_row
+= ds_get_linesize(vs
->ds
);
749 server_row
+= ds_get_linesize(vs
->ds
);
752 if (!has_dirty
&& !vs
->audio_cap
&& !vs
->force_update
) {
753 qemu_mod_timer(vs
->timer
, qemu_get_clock(rt_clock
) + VNC_REFRESH_INTERVAL
);
758 * Send screen updates to the vnc client using the server
759 * surface and server dirty map. guest surface updates
760 * happening in parallel don't disturb us, the next pass will
761 * send them to the client.
764 vnc_write_u8(vs
, 0); /* msg id */
766 saved_offset
= vs
->output
.offset
;
767 vnc_write_u16(vs
, 0);
769 for (y
= 0; y
< vs
->server
.ds
->height
; y
++) {
772 for (x
= 0; x
< vs
->server
.ds
->width
/ 16; x
++) {
773 if (vnc_get_bit(vs
->server
.dirty
[y
], x
)) {
777 vnc_clear_bit(vs
->server
.dirty
[y
], x
);
780 int h
= find_and_clear_dirty_height(&vs
->server
, y
, last_x
, x
);
781 send_framebuffer_update(vs
, last_x
* 16, y
, (x
- last_x
) * 16, h
);
788 int h
= find_and_clear_dirty_height(&vs
->server
, y
, last_x
, x
);
789 send_framebuffer_update(vs
, last_x
* 16, y
, (x
- last_x
) * 16, h
);
793 vs
->output
.buffer
[saved_offset
] = (n_rectangles
>> 8) & 0xFF;
794 vs
->output
.buffer
[saved_offset
+ 1] = n_rectangles
& 0xFF;
796 vs
->force_update
= 0;
800 if (vs
->csock
!= -1) {
801 qemu_mod_timer(vs
->timer
, qemu_get_clock(rt_clock
) + VNC_REFRESH_INTERVAL
);
807 static void audio_capture_notify(void *opaque
, audcnotification_e cmd
)
809 VncState
*vs
= opaque
;
812 case AUD_CNOTIFY_DISABLE
:
813 vnc_write_u8(vs
, 255);
815 vnc_write_u16(vs
, 0);
819 case AUD_CNOTIFY_ENABLE
:
820 vnc_write_u8(vs
, 255);
822 vnc_write_u16(vs
, 1);
828 static void audio_capture_destroy(void *opaque
)
832 static void audio_capture(void *opaque
, void *buf
, int size
)
834 VncState
*vs
= opaque
;
836 vnc_write_u8(vs
, 255);
838 vnc_write_u16(vs
, 2);
839 vnc_write_u32(vs
, size
);
840 vnc_write(vs
, buf
, size
);
844 static void audio_add(VncState
*vs
)
846 Monitor
*mon
= cur_mon
;
847 struct audio_capture_ops ops
;
850 monitor_printf(mon
, "audio already running\n");
854 ops
.notify
= audio_capture_notify
;
855 ops
.destroy
= audio_capture_destroy
;
856 ops
.capture
= audio_capture
;
858 vs
->audio_cap
= AUD_add_capture(NULL
, &vs
->as
, &ops
, vs
);
859 if (!vs
->audio_cap
) {
860 monitor_printf(mon
, "Failed to add audio capture\n");
864 static void audio_del(VncState
*vs
)
867 AUD_del_capture(vs
->audio_cap
, vs
);
868 vs
->audio_cap
= NULL
;
873 int vnc_client_io_error(VncState
*vs
, int ret
, int last_errno
)
875 if (ret
== 0 || ret
== -1) {
877 switch (last_errno
) {
889 VNC_DEBUG("Closing down client sock %d %d\n", ret
, ret
< 0 ? last_errno
: 0);
890 qemu_set_fd_handler2(vs
->csock
, NULL
, NULL
, NULL
, NULL
);
891 closesocket(vs
->csock
);
892 qemu_del_timer(vs
->timer
);
893 qemu_free_timer(vs
->timer
);
894 if (vs
->input
.buffer
) qemu_free(vs
->input
.buffer
);
895 if (vs
->output
.buffer
) qemu_free(vs
->output
.buffer
);
896 #ifdef CONFIG_VNC_TLS
897 vnc_tls_client_cleanup(vs
);
898 #endif /* CONFIG_VNC_TLS */
899 #ifdef CONFIG_VNC_SASL
900 vnc_sasl_client_cleanup(vs
);
901 #endif /* CONFIG_VNC_SASL */
904 VncState
*p
, *parent
= NULL
;
905 for (p
= vs
->vd
->clients
; p
!= NULL
; p
= p
->next
) {
908 parent
->next
= p
->next
;
910 vs
->vd
->clients
= p
->next
;
915 if (!vs
->vd
->clients
)
918 qemu_free(vs
->server
.ds
->data
);
919 qemu_free(vs
->server
.ds
);
920 qemu_free(vs
->guest
.ds
);
929 void vnc_client_error(VncState
*vs
)
931 vnc_client_io_error(vs
, -1, EINVAL
);
936 * Called to write a chunk of data to the client socket. The data may
937 * be the raw data, or may have already been encoded by SASL.
938 * The data will be written either straight onto the socket, or
939 * written via the GNUTLS wrappers, if TLS/SSL encryption is enabled
941 * NB, it is theoretically possible to have 2 layers of encryption,
942 * both SASL, and this TLS layer. It is highly unlikely in practice
943 * though, since SASL encryption will typically be a no-op if TLS
946 * Returns the number of bytes written, which may be less than
947 * the requested 'datalen' if the socket would block. Returns
948 * -1 on error, and disconnects the client socket.
950 long vnc_client_write_buf(VncState
*vs
, const uint8_t *data
, size_t datalen
)
953 #ifdef CONFIG_VNC_TLS
954 if (vs
->tls
.session
) {
955 ret
= gnutls_write(vs
->tls
.session
, data
, datalen
);
957 if (ret
== GNUTLS_E_AGAIN
)
964 #endif /* CONFIG_VNC_TLS */
965 ret
= send(vs
->csock
, data
, datalen
, 0);
966 VNC_DEBUG("Wrote wire %p %zd -> %ld\n", data
, datalen
, ret
);
967 return vnc_client_io_error(vs
, ret
, socket_error());
972 * Called to write buffered data to the client socket, when not
973 * using any SASL SSF encryption layers. Will write as much data
974 * as possible without blocking. If all buffered data is written,
975 * will switch the FD poll() handler back to read monitoring.
977 * Returns the number of bytes written, which may be less than
978 * the buffered output data if the socket would block. Returns
979 * -1 on error, and disconnects the client socket.
981 static long vnc_client_write_plain(VncState
*vs
)
985 #ifdef CONFIG_VNC_SASL
986 VNC_DEBUG("Write Plain: Pending output %p size %zd offset %zd. Wait SSF %d\n",
987 vs
->output
.buffer
, vs
->output
.capacity
, vs
->output
.offset
,
988 vs
->sasl
.waitWriteSSF
);
992 vs
->sasl
.waitWriteSSF
) {
993 ret
= vnc_client_write_buf(vs
, vs
->output
.buffer
, vs
->sasl
.waitWriteSSF
);
995 vs
->sasl
.waitWriteSSF
-= ret
;
997 #endif /* CONFIG_VNC_SASL */
998 ret
= vnc_client_write_buf(vs
, vs
->output
.buffer
, vs
->output
.offset
);
1002 memmove(vs
->output
.buffer
, vs
->output
.buffer
+ ret
, (vs
->output
.offset
- ret
));
1003 vs
->output
.offset
-= ret
;
1005 if (vs
->output
.offset
== 0) {
1006 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
1014 * First function called whenever there is data to be written to
1015 * the client socket. Will delegate actual work according to whether
1016 * SASL SSF layers are enabled (thus requiring encryption calls)
1018 void vnc_client_write(void *opaque
)
1021 VncState
*vs
= opaque
;
1023 #ifdef CONFIG_VNC_SASL
1024 if (vs
->sasl
.conn
&&
1026 !vs
->sasl
.waitWriteSSF
)
1027 ret
= vnc_client_write_sasl(vs
);
1029 #endif /* CONFIG_VNC_SASL */
1030 ret
= vnc_client_write_plain(vs
);
1033 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
)
1035 vs
->read_handler
= func
;
1036 vs
->read_handler_expect
= expecting
;
1041 * Called to read a chunk of data from the client socket. The data may
1042 * be the raw data, or may need to be further decoded by SASL.
1043 * The data will be read either straight from to the socket, or
1044 * read via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1046 * NB, it is theoretically possible to have 2 layers of encryption,
1047 * both SASL, and this TLS layer. It is highly unlikely in practice
1048 * though, since SASL encryption will typically be a no-op if TLS
1051 * Returns the number of bytes read, which may be less than
1052 * the requested 'datalen' if the socket would block. Returns
1053 * -1 on error, and disconnects the client socket.
1055 long vnc_client_read_buf(VncState
*vs
, uint8_t *data
, size_t datalen
)
1058 #ifdef CONFIG_VNC_TLS
1059 if (vs
->tls
.session
) {
1060 ret
= gnutls_read(vs
->tls
.session
, data
, datalen
);
1062 if (ret
== GNUTLS_E_AGAIN
)
1069 #endif /* CONFIG_VNC_TLS */
1070 ret
= recv(vs
->csock
, data
, datalen
, 0);
1071 VNC_DEBUG("Read wire %p %zd -> %ld\n", data
, datalen
, ret
);
1072 return vnc_client_io_error(vs
, ret
, socket_error());
1077 * Called to read data from the client socket to the input buffer,
1078 * when not using any SASL SSF encryption layers. Will read as much
1079 * data as possible without blocking.
1081 * Returns the number of bytes read. Returns -1 on error, and
1082 * disconnects the client socket.
1084 static long vnc_client_read_plain(VncState
*vs
)
1087 VNC_DEBUG("Read plain %p size %zd offset %zd\n",
1088 vs
->input
.buffer
, vs
->input
.capacity
, vs
->input
.offset
);
1089 buffer_reserve(&vs
->input
, 4096);
1090 ret
= vnc_client_read_buf(vs
, buffer_end(&vs
->input
), 4096);
1093 vs
->input
.offset
+= ret
;
1099 * First function called whenever there is more data to be read from
1100 * the client socket. Will delegate actual work according to whether
1101 * SASL SSF layers are enabled (thus requiring decryption calls)
1103 void vnc_client_read(void *opaque
)
1105 VncState
*vs
= opaque
;
1108 #ifdef CONFIG_VNC_SASL
1109 if (vs
->sasl
.conn
&& vs
->sasl
.runSSF
)
1110 ret
= vnc_client_read_sasl(vs
);
1112 #endif /* CONFIG_VNC_SASL */
1113 ret
= vnc_client_read_plain(vs
);
1117 while (vs
->read_handler
&& vs
->input
.offset
>= vs
->read_handler_expect
) {
1118 size_t len
= vs
->read_handler_expect
;
1121 ret
= vs
->read_handler(vs
, vs
->input
.buffer
, len
);
1122 if (vs
->csock
== -1)
1126 memmove(vs
->input
.buffer
, vs
->input
.buffer
+ len
, (vs
->input
.offset
- len
));
1127 vs
->input
.offset
-= len
;
1129 vs
->read_handler_expect
= ret
;
1134 void vnc_write(VncState
*vs
, const void *data
, size_t len
)
1136 buffer_reserve(&vs
->output
, len
);
1138 if (buffer_empty(&vs
->output
)) {
1139 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, vnc_client_write
, vs
);
1142 buffer_append(&vs
->output
, data
, len
);
1145 void vnc_write_s32(VncState
*vs
, int32_t value
)
1147 vnc_write_u32(vs
, *(uint32_t *)&value
);
1150 void vnc_write_u32(VncState
*vs
, uint32_t value
)
1154 buf
[0] = (value
>> 24) & 0xFF;
1155 buf
[1] = (value
>> 16) & 0xFF;
1156 buf
[2] = (value
>> 8) & 0xFF;
1157 buf
[3] = value
& 0xFF;
1159 vnc_write(vs
, buf
, 4);
1162 void vnc_write_u16(VncState
*vs
, uint16_t value
)
1166 buf
[0] = (value
>> 8) & 0xFF;
1167 buf
[1] = value
& 0xFF;
1169 vnc_write(vs
, buf
, 2);
1172 void vnc_write_u8(VncState
*vs
, uint8_t value
)
1174 vnc_write(vs
, (char *)&value
, 1);
1177 void vnc_flush(VncState
*vs
)
1179 if (vs
->output
.offset
)
1180 vnc_client_write(vs
);
1183 uint8_t read_u8(uint8_t *data
, size_t offset
)
1185 return data
[offset
];
1188 uint16_t read_u16(uint8_t *data
, size_t offset
)
1190 return ((data
[offset
] & 0xFF) << 8) | (data
[offset
+ 1] & 0xFF);
1193 int32_t read_s32(uint8_t *data
, size_t offset
)
1195 return (int32_t)((data
[offset
] << 24) | (data
[offset
+ 1] << 16) |
1196 (data
[offset
+ 2] << 8) | data
[offset
+ 3]);
1199 uint32_t read_u32(uint8_t *data
, size_t offset
)
1201 return ((data
[offset
] << 24) | (data
[offset
+ 1] << 16) |
1202 (data
[offset
+ 2] << 8) | data
[offset
+ 3]);
1205 static void client_cut_text(VncState
*vs
, size_t len
, uint8_t *text
)
1209 static void check_pointer_type_change(VncState
*vs
, int absolute
)
1211 if (vnc_has_feature(vs
, VNC_FEATURE_POINTER_TYPE_CHANGE
) && vs
->absolute
!= absolute
) {
1212 vnc_write_u8(vs
, 0);
1213 vnc_write_u8(vs
, 0);
1214 vnc_write_u16(vs
, 1);
1215 vnc_framebuffer_update(vs
, absolute
, 0,
1216 ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1217 VNC_ENCODING_POINTER_TYPE_CHANGE
);
1220 vs
->absolute
= absolute
;
1223 static void pointer_event(VncState
*vs
, int button_mask
, int x
, int y
)
1228 if (button_mask
& 0x01)
1229 buttons
|= MOUSE_EVENT_LBUTTON
;
1230 if (button_mask
& 0x02)
1231 buttons
|= MOUSE_EVENT_MBUTTON
;
1232 if (button_mask
& 0x04)
1233 buttons
|= MOUSE_EVENT_RBUTTON
;
1234 if (button_mask
& 0x08)
1236 if (button_mask
& 0x10)
1240 kbd_mouse_event(x
* 0x7FFF / (ds_get_width(vs
->ds
) - 1),
1241 y
* 0x7FFF / (ds_get_height(vs
->ds
) - 1),
1243 } else if (vnc_has_feature(vs
, VNC_FEATURE_POINTER_TYPE_CHANGE
)) {
1247 kbd_mouse_event(x
, y
, dz
, buttons
);
1249 if (vs
->last_x
!= -1)
1250 kbd_mouse_event(x
- vs
->last_x
,
1257 check_pointer_type_change(vs
, kbd_mouse_is_absolute());
1260 static void reset_keys(VncState
*vs
)
1263 for(i
= 0; i
< 256; i
++) {
1264 if (vs
->modifiers_state
[i
]) {
1266 kbd_put_keycode(0xe0);
1267 kbd_put_keycode(i
| 0x80);
1268 vs
->modifiers_state
[i
] = 0;
1273 static void press_key(VncState
*vs
, int keysym
)
1275 kbd_put_keycode(keysym2scancode(vs
->vd
->kbd_layout
, keysym
) & 0x7f);
1276 kbd_put_keycode(keysym2scancode(vs
->vd
->kbd_layout
, keysym
) | 0x80);
1279 static void do_key_event(VncState
*vs
, int down
, int keycode
, int sym
)
1281 /* QEMU console switch */
1283 case 0x2a: /* Left Shift */
1284 case 0x36: /* Right Shift */
1285 case 0x1d: /* Left CTRL */
1286 case 0x9d: /* Right CTRL */
1287 case 0x38: /* Left ALT */
1288 case 0xb8: /* Right ALT */
1290 vs
->modifiers_state
[keycode
] = 1;
1292 vs
->modifiers_state
[keycode
] = 0;
1294 case 0x02 ... 0x0a: /* '1' to '9' keys */
1295 if (down
&& vs
->modifiers_state
[0x1d] && vs
->modifiers_state
[0x38]) {
1296 /* Reset the modifiers sent to the current console */
1298 console_select(keycode
- 0x02);
1302 case 0x3a: /* CapsLock */
1303 case 0x45: /* NumLock */
1305 vs
->modifiers_state
[keycode
] ^= 1;
1309 if (keycode_is_keypad(vs
->vd
->kbd_layout
, keycode
)) {
1310 /* If the numlock state needs to change then simulate an additional
1311 keypress before sending this one. This will happen if the user
1312 toggles numlock away from the VNC window.
1314 if (keysym_is_numlock(vs
->vd
->kbd_layout
, sym
& 0xFFFF)) {
1315 if (!vs
->modifiers_state
[0x45]) {
1316 vs
->modifiers_state
[0x45] = 1;
1317 press_key(vs
, 0xff7f);
1320 if (vs
->modifiers_state
[0x45]) {
1321 vs
->modifiers_state
[0x45] = 0;
1322 press_key(vs
, 0xff7f);
1327 if (is_graphic_console()) {
1329 kbd_put_keycode(0xe0);
1331 kbd_put_keycode(keycode
& 0x7f);
1333 kbd_put_keycode(keycode
| 0x80);
1335 /* QEMU console emulation */
1338 case 0x2a: /* Left Shift */
1339 case 0x36: /* Right Shift */
1340 case 0x1d: /* Left CTRL */
1341 case 0x9d: /* Right CTRL */
1342 case 0x38: /* Left ALT */
1343 case 0xb8: /* Right ALT */
1347 kbd_put_keysym(QEMU_KEY_UP
);
1351 kbd_put_keysym(QEMU_KEY_DOWN
);
1355 kbd_put_keysym(QEMU_KEY_LEFT
);
1359 kbd_put_keysym(QEMU_KEY_RIGHT
);
1363 kbd_put_keysym(QEMU_KEY_DELETE
);
1367 kbd_put_keysym(QEMU_KEY_HOME
);
1371 kbd_put_keysym(QEMU_KEY_END
);
1375 kbd_put_keysym(QEMU_KEY_PAGEUP
);
1379 kbd_put_keysym(QEMU_KEY_PAGEDOWN
);
1382 kbd_put_keysym(sym
);
1389 static void key_event(VncState
*vs
, int down
, uint32_t sym
)
1393 if (sym
>= 'A' && sym
<= 'Z' && is_graphic_console())
1394 sym
= sym
- 'A' + 'a';
1396 keycode
= keysym2scancode(vs
->vd
->kbd_layout
, sym
& 0xFFFF);
1397 do_key_event(vs
, down
, keycode
, sym
);
1400 static void ext_key_event(VncState
*vs
, int down
,
1401 uint32_t sym
, uint16_t keycode
)
1403 /* if the user specifies a keyboard layout, always use it */
1404 if (keyboard_layout
)
1405 key_event(vs
, down
, sym
);
1407 do_key_event(vs
, down
, keycode
, sym
);
1410 static void framebuffer_update_request(VncState
*vs
, int incremental
,
1411 int x_position
, int y_position
,
1414 if (x_position
> ds_get_width(vs
->ds
))
1415 x_position
= ds_get_width(vs
->ds
);
1416 if (y_position
> ds_get_height(vs
->ds
))
1417 y_position
= ds_get_height(vs
->ds
);
1418 if (x_position
+ w
>= ds_get_width(vs
->ds
))
1419 w
= ds_get_width(vs
->ds
) - x_position
;
1420 if (y_position
+ h
>= ds_get_height(vs
->ds
))
1421 h
= ds_get_height(vs
->ds
) - y_position
;
1424 vs
->need_update
= 1;
1426 vs
->force_update
= 1;
1427 for (i
= 0; i
< h
; i
++) {
1428 vnc_set_bits(vs
->guest
.dirty
[y_position
+ i
],
1429 (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
1430 vnc_set_bits(vs
->server
.dirty
[y_position
+ i
],
1431 (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
1436 static void send_ext_key_event_ack(VncState
*vs
)
1438 vnc_write_u8(vs
, 0);
1439 vnc_write_u8(vs
, 0);
1440 vnc_write_u16(vs
, 1);
1441 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1442 VNC_ENCODING_EXT_KEY_EVENT
);
1446 static void send_ext_audio_ack(VncState
*vs
)
1448 vnc_write_u8(vs
, 0);
1449 vnc_write_u8(vs
, 0);
1450 vnc_write_u16(vs
, 1);
1451 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1452 VNC_ENCODING_AUDIO
);
1456 static void set_encodings(VncState
*vs
, int32_t *encodings
, size_t n_encodings
)
1459 unsigned int enc
= 0;
1463 vs
->vnc_encoding
= 0;
1464 vs
->tight_compression
= 9;
1465 vs
->tight_quality
= 9;
1468 for (i
= n_encodings
- 1; i
>= 0; i
--) {
1471 case VNC_ENCODING_RAW
:
1472 vs
->vnc_encoding
= enc
;
1474 case VNC_ENCODING_COPYRECT
:
1475 vs
->features
|= VNC_FEATURE_COPYRECT_MASK
;
1477 case VNC_ENCODING_HEXTILE
:
1478 vs
->features
|= VNC_FEATURE_HEXTILE_MASK
;
1479 vs
->vnc_encoding
= enc
;
1481 case VNC_ENCODING_ZLIB
:
1482 vs
->features
|= VNC_FEATURE_ZLIB_MASK
;
1483 vs
->vnc_encoding
= enc
;
1485 case VNC_ENCODING_DESKTOPRESIZE
:
1486 vs
->features
|= VNC_FEATURE_RESIZE_MASK
;
1488 case VNC_ENCODING_POINTER_TYPE_CHANGE
:
1489 vs
->features
|= VNC_FEATURE_POINTER_TYPE_CHANGE_MASK
;
1491 case VNC_ENCODING_EXT_KEY_EVENT
:
1492 send_ext_key_event_ack(vs
);
1494 case VNC_ENCODING_AUDIO
:
1495 send_ext_audio_ack(vs
);
1497 case VNC_ENCODING_WMVi
:
1498 vs
->features
|= VNC_FEATURE_WMVI_MASK
;
1500 case VNC_ENCODING_COMPRESSLEVEL0
... VNC_ENCODING_COMPRESSLEVEL0
+ 9:
1501 vs
->tight_compression
= (enc
& 0x0F);
1503 case VNC_ENCODING_QUALITYLEVEL0
... VNC_ENCODING_QUALITYLEVEL0
+ 9:
1504 vs
->tight_quality
= (enc
& 0x0F);
1507 VNC_DEBUG("Unknown encoding: %d (0x%.8x): %d\n", i
, enc
, enc
);
1512 check_pointer_type_change(vs
, kbd_mouse_is_absolute());
1515 static void set_pixel_conversion(VncState
*vs
)
1517 if ((vs
->clientds
.flags
& QEMU_BIG_ENDIAN_FLAG
) ==
1518 (vs
->ds
->surface
->flags
& QEMU_BIG_ENDIAN_FLAG
) &&
1519 !memcmp(&(vs
->clientds
.pf
), &(vs
->ds
->surface
->pf
), sizeof(PixelFormat
))) {
1520 vs
->write_pixels
= vnc_write_pixels_copy
;
1521 switch (vs
->ds
->surface
->pf
.bits_per_pixel
) {
1523 vs
->send_hextile_tile
= send_hextile_tile_8
;
1526 vs
->send_hextile_tile
= send_hextile_tile_16
;
1529 vs
->send_hextile_tile
= send_hextile_tile_32
;
1533 vs
->write_pixels
= vnc_write_pixels_generic
;
1534 switch (vs
->ds
->surface
->pf
.bits_per_pixel
) {
1536 vs
->send_hextile_tile
= send_hextile_tile_generic_8
;
1539 vs
->send_hextile_tile
= send_hextile_tile_generic_16
;
1542 vs
->send_hextile_tile
= send_hextile_tile_generic_32
;
1548 static void set_pixel_format(VncState
*vs
,
1549 int bits_per_pixel
, int depth
,
1550 int big_endian_flag
, int true_color_flag
,
1551 int red_max
, int green_max
, int blue_max
,
1552 int red_shift
, int green_shift
, int blue_shift
)
1554 if (!true_color_flag
) {
1555 vnc_client_error(vs
);
1559 vs
->clientds
= *(vs
->guest
.ds
);
1560 vs
->clientds
.pf
.rmax
= red_max
;
1561 count_bits(vs
->clientds
.pf
.rbits
, red_max
);
1562 vs
->clientds
.pf
.rshift
= red_shift
;
1563 vs
->clientds
.pf
.rmask
= red_max
<< red_shift
;
1564 vs
->clientds
.pf
.gmax
= green_max
;
1565 count_bits(vs
->clientds
.pf
.gbits
, green_max
);
1566 vs
->clientds
.pf
.gshift
= green_shift
;
1567 vs
->clientds
.pf
.gmask
= green_max
<< green_shift
;
1568 vs
->clientds
.pf
.bmax
= blue_max
;
1569 count_bits(vs
->clientds
.pf
.bbits
, blue_max
);
1570 vs
->clientds
.pf
.bshift
= blue_shift
;
1571 vs
->clientds
.pf
.bmask
= blue_max
<< blue_shift
;
1572 vs
->clientds
.pf
.bits_per_pixel
= bits_per_pixel
;
1573 vs
->clientds
.pf
.bytes_per_pixel
= bits_per_pixel
/ 8;
1574 vs
->clientds
.pf
.depth
= bits_per_pixel
== 32 ? 24 : bits_per_pixel
;
1575 vs
->clientds
.flags
= big_endian_flag
? QEMU_BIG_ENDIAN_FLAG
: 0x00;
1577 set_pixel_conversion(vs
);
1579 vga_hw_invalidate();
1583 static void pixel_format_message (VncState
*vs
) {
1584 char pad
[3] = { 0, 0, 0 };
1586 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.bits_per_pixel
); /* bits-per-pixel */
1587 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.depth
); /* depth */
1589 #ifdef WORDS_BIGENDIAN
1590 vnc_write_u8(vs
, 1); /* big-endian-flag */
1592 vnc_write_u8(vs
, 0); /* big-endian-flag */
1594 vnc_write_u8(vs
, 1); /* true-color-flag */
1595 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.rmax
); /* red-max */
1596 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.gmax
); /* green-max */
1597 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.bmax
); /* blue-max */
1598 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.rshift
); /* red-shift */
1599 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.gshift
); /* green-shift */
1600 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.bshift
); /* blue-shift */
1601 if (vs
->ds
->surface
->pf
.bits_per_pixel
== 32)
1602 vs
->send_hextile_tile
= send_hextile_tile_32
;
1603 else if (vs
->ds
->surface
->pf
.bits_per_pixel
== 16)
1604 vs
->send_hextile_tile
= send_hextile_tile_16
;
1605 else if (vs
->ds
->surface
->pf
.bits_per_pixel
== 8)
1606 vs
->send_hextile_tile
= send_hextile_tile_8
;
1607 vs
->clientds
= *(vs
->ds
->surface
);
1608 vs
->clientds
.flags
&= ~QEMU_ALLOCATED_FLAG
;
1609 vs
->write_pixels
= vnc_write_pixels_copy
;
1611 vnc_write(vs
, pad
, 3); /* padding */
1614 static void vnc_dpy_setdata(DisplayState
*ds
)
1616 /* We don't have to do anything */
1619 static void vnc_colordepth(VncState
*vs
)
1621 if (vnc_has_feature(vs
, VNC_FEATURE_WMVI
)) {
1622 /* Sending a WMVi message to notify the client*/
1623 vnc_write_u8(vs
, 0); /* msg id */
1624 vnc_write_u8(vs
, 0);
1625 vnc_write_u16(vs
, 1); /* number of rects */
1626 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
),
1627 ds_get_height(vs
->ds
), VNC_ENCODING_WMVi
);
1628 pixel_format_message(vs
);
1631 set_pixel_conversion(vs
);
1635 static int protocol_client_msg(VncState
*vs
, uint8_t *data
, size_t len
)
1645 set_pixel_format(vs
, read_u8(data
, 4), read_u8(data
, 5),
1646 read_u8(data
, 6), read_u8(data
, 7),
1647 read_u16(data
, 8), read_u16(data
, 10),
1648 read_u16(data
, 12), read_u8(data
, 14),
1649 read_u8(data
, 15), read_u8(data
, 16));
1656 limit
= read_u16(data
, 2);
1658 return 4 + (limit
* 4);
1660 limit
= read_u16(data
, 2);
1662 for (i
= 0; i
< limit
; i
++) {
1663 int32_t val
= read_s32(data
, 4 + (i
* 4));
1664 memcpy(data
+ 4 + (i
* 4), &val
, sizeof(val
));
1667 set_encodings(vs
, (int32_t *)(data
+ 4), limit
);
1673 framebuffer_update_request(vs
,
1674 read_u8(data
, 1), read_u16(data
, 2), read_u16(data
, 4),
1675 read_u16(data
, 6), read_u16(data
, 8));
1681 key_event(vs
, read_u8(data
, 1), read_u32(data
, 4));
1687 pointer_event(vs
, read_u8(data
, 1), read_u16(data
, 2), read_u16(data
, 4));
1694 uint32_t dlen
= read_u32(data
, 4);
1699 client_cut_text(vs
, read_u32(data
, 4), data
+ 8);
1705 switch (read_u8(data
, 1)) {
1710 ext_key_event(vs
, read_u16(data
, 2),
1711 read_u32(data
, 4), read_u32(data
, 8));
1717 switch (read_u16 (data
, 2)) {
1727 switch (read_u8(data
, 4)) {
1728 case 0: vs
->as
.fmt
= AUD_FMT_U8
; break;
1729 case 1: vs
->as
.fmt
= AUD_FMT_S8
; break;
1730 case 2: vs
->as
.fmt
= AUD_FMT_U16
; break;
1731 case 3: vs
->as
.fmt
= AUD_FMT_S16
; break;
1732 case 4: vs
->as
.fmt
= AUD_FMT_U32
; break;
1733 case 5: vs
->as
.fmt
= AUD_FMT_S32
; break;
1735 printf("Invalid audio format %d\n", read_u8(data
, 4));
1736 vnc_client_error(vs
);
1739 vs
->as
.nchannels
= read_u8(data
, 5);
1740 if (vs
->as
.nchannels
!= 1 && vs
->as
.nchannels
!= 2) {
1741 printf("Invalid audio channel coount %d\n",
1743 vnc_client_error(vs
);
1746 vs
->as
.freq
= read_u32(data
, 6);
1749 printf ("Invalid audio message %d\n", read_u8(data
, 4));
1750 vnc_client_error(vs
);
1756 printf("Msg: %d\n", read_u16(data
, 0));
1757 vnc_client_error(vs
);
1762 printf("Msg: %d\n", data
[0]);
1763 vnc_client_error(vs
);
1767 vnc_read_when(vs
, protocol_client_msg
, 1);
1771 static int protocol_client_init(VncState
*vs
, uint8_t *data
, size_t len
)
1776 vnc_write_u16(vs
, ds_get_width(vs
->ds
));
1777 vnc_write_u16(vs
, ds_get_height(vs
->ds
));
1779 pixel_format_message(vs
);
1782 size
= snprintf(buf
, sizeof(buf
), "QEMU (%s)", qemu_name
);
1784 size
= snprintf(buf
, sizeof(buf
), "QEMU");
1786 vnc_write_u32(vs
, size
);
1787 vnc_write(vs
, buf
, size
);
1790 vnc_read_when(vs
, protocol_client_msg
, 1);
1795 void start_client_init(VncState
*vs
)
1797 vnc_read_when(vs
, protocol_client_init
, 1);
1800 static void make_challenge(VncState
*vs
)
1804 srand(time(NULL
)+getpid()+getpid()*987654+rand());
1806 for (i
= 0 ; i
< sizeof(vs
->challenge
) ; i
++)
1807 vs
->challenge
[i
] = (int) (256.0*rand()/(RAND_MAX
+1.0));
1810 static int protocol_client_auth_vnc(VncState
*vs
, uint8_t *data
, size_t len
)
1812 unsigned char response
[VNC_AUTH_CHALLENGE_SIZE
];
1814 unsigned char key
[8];
1816 if (!vs
->vd
->password
|| !vs
->vd
->password
[0]) {
1817 VNC_DEBUG("No password configured on server");
1818 vnc_write_u32(vs
, 1); /* Reject auth */
1819 if (vs
->minor
>= 8) {
1820 static const char err
[] = "Authentication failed";
1821 vnc_write_u32(vs
, sizeof(err
));
1822 vnc_write(vs
, err
, sizeof(err
));
1825 vnc_client_error(vs
);
1829 memcpy(response
, vs
->challenge
, VNC_AUTH_CHALLENGE_SIZE
);
1831 /* Calculate the expected challenge response */
1832 pwlen
= strlen(vs
->vd
->password
);
1833 for (i
=0; i
<sizeof(key
); i
++)
1834 key
[i
] = i
<pwlen
? vs
->vd
->password
[i
] : 0;
1836 for (j
= 0; j
< VNC_AUTH_CHALLENGE_SIZE
; j
+= 8)
1837 des(response
+j
, response
+j
);
1839 /* Compare expected vs actual challenge response */
1840 if (memcmp(response
, data
, VNC_AUTH_CHALLENGE_SIZE
) != 0) {
1841 VNC_DEBUG("Client challenge reponse did not match\n");
1842 vnc_write_u32(vs
, 1); /* Reject auth */
1843 if (vs
->minor
>= 8) {
1844 static const char err
[] = "Authentication failed";
1845 vnc_write_u32(vs
, sizeof(err
));
1846 vnc_write(vs
, err
, sizeof(err
));
1849 vnc_client_error(vs
);
1851 VNC_DEBUG("Accepting VNC challenge response\n");
1852 vnc_write_u32(vs
, 0); /* Accept auth */
1855 start_client_init(vs
);
1860 void start_auth_vnc(VncState
*vs
)
1863 /* Send client a 'random' challenge */
1864 vnc_write(vs
, vs
->challenge
, sizeof(vs
->challenge
));
1867 vnc_read_when(vs
, protocol_client_auth_vnc
, sizeof(vs
->challenge
));
1871 static int protocol_client_auth(VncState
*vs
, uint8_t *data
, size_t len
)
1873 /* We only advertise 1 auth scheme at a time, so client
1874 * must pick the one we sent. Verify this */
1875 if (data
[0] != vs
->vd
->auth
) { /* Reject auth */
1876 VNC_DEBUG("Reject auth %d because it didn't match advertized\n", (int)data
[0]);
1877 vnc_write_u32(vs
, 1);
1878 if (vs
->minor
>= 8) {
1879 static const char err
[] = "Authentication failed";
1880 vnc_write_u32(vs
, sizeof(err
));
1881 vnc_write(vs
, err
, sizeof(err
));
1883 vnc_client_error(vs
);
1884 } else { /* Accept requested auth */
1885 VNC_DEBUG("Client requested auth %d\n", (int)data
[0]);
1886 switch (vs
->vd
->auth
) {
1888 VNC_DEBUG("Accept auth none\n");
1889 if (vs
->minor
>= 8) {
1890 vnc_write_u32(vs
, 0); /* Accept auth completion */
1893 start_client_init(vs
);
1897 VNC_DEBUG("Start VNC auth\n");
1901 #ifdef CONFIG_VNC_TLS
1902 case VNC_AUTH_VENCRYPT
:
1903 VNC_DEBUG("Accept VeNCrypt auth\n");;
1904 start_auth_vencrypt(vs
);
1906 #endif /* CONFIG_VNC_TLS */
1908 #ifdef CONFIG_VNC_SASL
1910 VNC_DEBUG("Accept SASL auth\n");
1911 start_auth_sasl(vs
);
1913 #endif /* CONFIG_VNC_SASL */
1915 default: /* Should not be possible, but just in case */
1916 VNC_DEBUG("Reject auth %d server code bug\n", vs
->vd
->auth
);
1917 vnc_write_u8(vs
, 1);
1918 if (vs
->minor
>= 8) {
1919 static const char err
[] = "Authentication failed";
1920 vnc_write_u32(vs
, sizeof(err
));
1921 vnc_write(vs
, err
, sizeof(err
));
1923 vnc_client_error(vs
);
1929 static int protocol_version(VncState
*vs
, uint8_t *version
, size_t len
)
1933 memcpy(local
, version
, 12);
1936 if (sscanf(local
, "RFB %03d.%03d\n", &vs
->major
, &vs
->minor
) != 2) {
1937 VNC_DEBUG("Malformed protocol version %s\n", local
);
1938 vnc_client_error(vs
);
1941 VNC_DEBUG("Client request protocol version %d.%d\n", vs
->major
, vs
->minor
);
1942 if (vs
->major
!= 3 ||
1948 VNC_DEBUG("Unsupported client version\n");
1949 vnc_write_u32(vs
, VNC_AUTH_INVALID
);
1951 vnc_client_error(vs
);
1954 /* Some broken clients report v3.4 or v3.5, which spec requires to be treated
1955 * as equivalent to v3.3 by servers
1957 if (vs
->minor
== 4 || vs
->minor
== 5)
1960 if (vs
->minor
== 3) {
1961 if (vs
->vd
->auth
== VNC_AUTH_NONE
) {
1962 VNC_DEBUG("Tell client auth none\n");
1963 vnc_write_u32(vs
, vs
->vd
->auth
);
1965 start_client_init(vs
);
1966 } else if (vs
->vd
->auth
== VNC_AUTH_VNC
) {
1967 VNC_DEBUG("Tell client VNC auth\n");
1968 vnc_write_u32(vs
, vs
->vd
->auth
);
1972 VNC_DEBUG("Unsupported auth %d for protocol 3.3\n", vs
->vd
->auth
);
1973 vnc_write_u32(vs
, VNC_AUTH_INVALID
);
1975 vnc_client_error(vs
);
1978 VNC_DEBUG("Telling client we support auth %d\n", vs
->vd
->auth
);
1979 vnc_write_u8(vs
, 1); /* num auth */
1980 vnc_write_u8(vs
, vs
->vd
->auth
);
1981 vnc_read_when(vs
, protocol_client_auth
, 1);
1988 static void vnc_connect(VncDisplay
*vd
, int csock
)
1990 VncState
*vs
= qemu_mallocz(sizeof(VncState
));
1993 VNC_DEBUG("New client on socket %d\n", csock
);
1995 socket_set_nonblock(vs
->csock
);
1996 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
2000 vs
->timer
= qemu_new_timer(rt_clock
, vnc_update_client
, vs
);
2004 vs
->as
.freq
= 44100;
2005 vs
->as
.nchannels
= 2;
2006 vs
->as
.fmt
= AUD_FMT_S16
;
2007 vs
->as
.endianness
= 0;
2010 vnc_write(vs
, "RFB 003.008\n", 12);
2012 vnc_read_when(vs
, protocol_version
, 12);
2013 vnc_update_client(vs
);
2016 vs
->next
= vd
->clients
;
2020 static void vnc_listen_read(void *opaque
)
2022 VncDisplay
*vs
= opaque
;
2023 struct sockaddr_in addr
;
2024 socklen_t addrlen
= sizeof(addr
);
2029 int csock
= accept(vs
->lsock
, (struct sockaddr
*)&addr
, &addrlen
);
2031 vnc_connect(vs
, csock
);
2035 void vnc_display_init(DisplayState
*ds
)
2039 vs
= qemu_mallocz(sizeof(VncState
));
2040 dcl
= qemu_mallocz(sizeof(DisplayChangeListener
));
2050 if (keyboard_layout
)
2051 vs
->kbd_layout
= init_keyboard_layout(name2keysym
, keyboard_layout
);
2053 vs
->kbd_layout
= init_keyboard_layout(name2keysym
, "en-us");
2055 if (!vs
->kbd_layout
)
2058 dcl
->dpy_copy
= vnc_dpy_copy
;
2059 dcl
->dpy_update
= vnc_dpy_update
;
2060 dcl
->dpy_resize
= vnc_dpy_resize
;
2061 dcl
->dpy_setdata
= vnc_dpy_setdata
;
2062 register_displaychangelistener(ds
, dcl
);
2066 void vnc_display_close(DisplayState
*ds
)
2068 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2073 qemu_free(vs
->display
);
2076 if (vs
->lsock
!= -1) {
2077 qemu_set_fd_handler2(vs
->lsock
, NULL
, NULL
, NULL
, NULL
);
2081 vs
->auth
= VNC_AUTH_INVALID
;
2082 #ifdef CONFIG_VNC_TLS
2083 vs
->subauth
= VNC_AUTH_INVALID
;
2084 vs
->tls
.x509verify
= 0;
2088 int vnc_display_password(DisplayState
*ds
, const char *password
)
2090 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2093 qemu_free(vs
->password
);
2094 vs
->password
= NULL
;
2096 if (password
&& password
[0]) {
2097 if (!(vs
->password
= qemu_strdup(password
)))
2104 int vnc_display_open(DisplayState
*ds
, const char *display
)
2106 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2107 const char *options
;
2111 #ifdef CONFIG_VNC_TLS
2112 int tls
= 0, x509
= 0;
2114 #ifdef CONFIG_VNC_SASL
2122 vnc_display_close(ds
);
2123 if (strcmp(display
, "none") == 0)
2126 if (!(vs
->display
= strdup(display
)))
2130 while ((options
= strchr(options
, ','))) {
2132 if (strncmp(options
, "password", 8) == 0) {
2133 password
= 1; /* Require password auth */
2134 } else if (strncmp(options
, "reverse", 7) == 0) {
2136 } else if (strncmp(options
, "to=", 3) == 0) {
2137 to_port
= atoi(options
+3) + 5900;
2138 #ifdef CONFIG_VNC_SASL
2139 } else if (strncmp(options
, "sasl", 4) == 0) {
2140 sasl
= 1; /* Require SASL auth */
2142 #ifdef CONFIG_VNC_TLS
2143 } else if (strncmp(options
, "tls", 3) == 0) {
2144 tls
= 1; /* Require TLS */
2145 } else if (strncmp(options
, "x509", 4) == 0) {
2147 x509
= 1; /* Require x509 certificates */
2148 if (strncmp(options
, "x509verify", 10) == 0)
2149 vs
->tls
.x509verify
= 1; /* ...and verify client certs */
2151 /* Now check for 'x509=/some/path' postfix
2152 * and use that to setup x509 certificate/key paths */
2153 start
= strchr(options
, '=');
2154 end
= strchr(options
, ',');
2155 if (start
&& (!end
|| (start
< end
))) {
2156 int len
= end
? end
-(start
+1) : strlen(start
+1);
2157 char *path
= qemu_strndup(start
+ 1, len
);
2159 VNC_DEBUG("Trying certificate path '%s'\n", path
);
2160 if (vnc_tls_set_x509_creds_dir(vs
, path
) < 0) {
2161 fprintf(stderr
, "Failed to find x509 certificates/keys in %s\n", path
);
2163 qemu_free(vs
->display
);
2169 fprintf(stderr
, "No certificate path provided\n");
2170 qemu_free(vs
->display
);
2175 } else if (strncmp(options
, "acl", 3) == 0) {
2180 #ifdef CONFIG_VNC_TLS
2181 if (acl
&& x509
&& vs
->tls
.x509verify
) {
2182 if (!(vs
->tls
.acl
= qemu_acl_init("vnc.x509dname"))) {
2183 fprintf(stderr
, "Failed to create x509 dname ACL\n");
2188 #ifdef CONFIG_VNC_SASL
2190 if (!(vs
->sasl
.acl
= qemu_acl_init("vnc.username"))) {
2191 fprintf(stderr
, "Failed to create username ACL\n");
2198 * Combinations we support here:
2200 * - no-auth (clear text, no auth)
2201 * - password (clear text, weak auth)
2202 * - sasl (encrypt, good auth *IF* using Kerberos via GSSAPI)
2203 * - tls (encrypt, weak anonymous creds, no auth)
2204 * - tls + password (encrypt, weak anonymous creds, weak auth)
2205 * - tls + sasl (encrypt, weak anonymous creds, good auth)
2206 * - tls + x509 (encrypt, good x509 creds, no auth)
2207 * - tls + x509 + password (encrypt, good x509 creds, weak auth)
2208 * - tls + x509 + sasl (encrypt, good x509 creds, good auth)
2210 * NB1. TLS is a stackable auth scheme.
2211 * NB2. the x509 schemes have option to validate a client cert dname
2214 #ifdef CONFIG_VNC_TLS
2216 vs
->auth
= VNC_AUTH_VENCRYPT
;
2218 VNC_DEBUG("Initializing VNC server with x509 password auth\n");
2219 vs
->subauth
= VNC_AUTH_VENCRYPT_X509VNC
;
2221 VNC_DEBUG("Initializing VNC server with TLS password auth\n");
2222 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSVNC
;
2225 #endif /* CONFIG_VNC_TLS */
2226 VNC_DEBUG("Initializing VNC server with password auth\n");
2227 vs
->auth
= VNC_AUTH_VNC
;
2228 #ifdef CONFIG_VNC_TLS
2229 vs
->subauth
= VNC_AUTH_INVALID
;
2231 #endif /* CONFIG_VNC_TLS */
2232 #ifdef CONFIG_VNC_SASL
2234 #ifdef CONFIG_VNC_TLS
2236 vs
->auth
= VNC_AUTH_VENCRYPT
;
2238 VNC_DEBUG("Initializing VNC server with x509 SASL auth\n");
2239 vs
->subauth
= VNC_AUTH_VENCRYPT_X509SASL
;
2241 VNC_DEBUG("Initializing VNC server with TLS SASL auth\n");
2242 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSSASL
;
2245 #endif /* CONFIG_VNC_TLS */
2246 VNC_DEBUG("Initializing VNC server with SASL auth\n");
2247 vs
->auth
= VNC_AUTH_SASL
;
2248 #ifdef CONFIG_VNC_TLS
2249 vs
->subauth
= VNC_AUTH_INVALID
;
2251 #endif /* CONFIG_VNC_TLS */
2252 #endif /* CONFIG_VNC_SASL */
2254 #ifdef CONFIG_VNC_TLS
2256 vs
->auth
= VNC_AUTH_VENCRYPT
;
2258 VNC_DEBUG("Initializing VNC server with x509 no auth\n");
2259 vs
->subauth
= VNC_AUTH_VENCRYPT_X509NONE
;
2261 VNC_DEBUG("Initializing VNC server with TLS no auth\n");
2262 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSNONE
;
2266 VNC_DEBUG("Initializing VNC server with no auth\n");
2267 vs
->auth
= VNC_AUTH_NONE
;
2268 #ifdef CONFIG_VNC_TLS
2269 vs
->subauth
= VNC_AUTH_INVALID
;
2274 #ifdef CONFIG_VNC_SASL
2275 if ((saslErr
= sasl_server_init(NULL
, "qemu")) != SASL_OK
) {
2276 fprintf(stderr
, "Failed to initialize SASL auth %s",
2277 sasl_errstring(saslErr
, NULL
, NULL
));
2285 /* connect to viewer */
2286 if (strncmp(display
, "unix:", 5) == 0)
2287 vs
->lsock
= unix_connect(display
+5);
2289 vs
->lsock
= inet_connect(display
, SOCK_STREAM
);
2290 if (-1 == vs
->lsock
) {
2295 int csock
= vs
->lsock
;
2297 vnc_connect(vs
, csock
);
2302 /* listen for connects */
2304 dpy
= qemu_malloc(256);
2305 if (strncmp(display
, "unix:", 5) == 0) {
2306 pstrcpy(dpy
, 256, "unix:");
2307 vs
->lsock
= unix_listen(display
+5, dpy
+5, 256-5);
2309 vs
->lsock
= inet_listen(display
, dpy
, 256, SOCK_STREAM
, 5900);
2311 if (-1 == vs
->lsock
) {
2319 return qemu_set_fd_handler2(vs
->lsock
, NULL
, vnc_listen_read
, NULL
, vs
);