2 * Copyright (C) 2010 Red Hat, Inc.
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License as
6 * published by the Free Software Foundation; either version 2 or
7 * (at your option) version 3 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 #include <spice-experimental.h>
23 #include "qemu-common.h"
24 #include "qemu-spice.h"
25 #include "qemu-timer.h"
26 #include "qemu-queue.h"
27 #include "qemu-x509.h"
28 #include "qemu_socket.h"
34 #include "migration.h"
40 static SpiceServer
*spice_server
;
41 static Notifier migration_state
;
42 static const char *auth
= "spice";
43 static char *auth_passwd
;
44 static time_t auth_expires
= TIME_MAX
;
49 QTAILQ_ENTRY(SpiceTimer
) next
;
51 static QTAILQ_HEAD(, SpiceTimer
) timers
= QTAILQ_HEAD_INITIALIZER(timers
);
53 static SpiceTimer
*timer_add(SpiceTimerFunc func
, void *opaque
)
57 timer
= qemu_mallocz(sizeof(*timer
));
58 timer
->timer
= qemu_new_timer_ms(rt_clock
, func
, opaque
);
59 QTAILQ_INSERT_TAIL(&timers
, timer
, next
);
63 static void timer_start(SpiceTimer
*timer
, uint32_t ms
)
65 qemu_mod_timer(timer
->timer
, qemu_get_clock_ms(rt_clock
) + ms
);
68 static void timer_cancel(SpiceTimer
*timer
)
70 qemu_del_timer(timer
->timer
);
73 static void timer_remove(SpiceTimer
*timer
)
75 qemu_del_timer(timer
->timer
);
76 qemu_free_timer(timer
->timer
);
77 QTAILQ_REMOVE(&timers
, timer
, next
);
86 QTAILQ_ENTRY(SpiceWatch
) next
;
88 static QTAILQ_HEAD(, SpiceWatch
) watches
= QTAILQ_HEAD_INITIALIZER(watches
);
90 static void watch_read(void *opaque
)
92 SpiceWatch
*watch
= opaque
;
93 watch
->func(watch
->fd
, SPICE_WATCH_EVENT_READ
, watch
->opaque
);
96 static void watch_write(void *opaque
)
98 SpiceWatch
*watch
= opaque
;
99 watch
->func(watch
->fd
, SPICE_WATCH_EVENT_WRITE
, watch
->opaque
);
102 static void watch_update_mask(SpiceWatch
*watch
, int event_mask
)
104 IOHandler
*on_read
= NULL
;
105 IOHandler
*on_write
= NULL
;
107 watch
->event_mask
= event_mask
;
108 if (watch
->event_mask
& SPICE_WATCH_EVENT_READ
) {
109 on_read
= watch_read
;
111 if (watch
->event_mask
& SPICE_WATCH_EVENT_WRITE
) {
112 on_write
= watch_write
;
114 qemu_set_fd_handler(watch
->fd
, on_read
, on_write
, watch
);
117 static SpiceWatch
*watch_add(int fd
, int event_mask
, SpiceWatchFunc func
, void *opaque
)
121 watch
= qemu_mallocz(sizeof(*watch
));
124 watch
->opaque
= opaque
;
125 QTAILQ_INSERT_TAIL(&watches
, watch
, next
);
127 watch_update_mask(watch
, event_mask
);
131 static void watch_remove(SpiceWatch
*watch
)
133 watch_update_mask(watch
, 0);
134 QTAILQ_REMOVE(&watches
, watch
, next
);
138 #if SPICE_INTERFACE_CORE_MINOR >= 3
140 typedef struct ChannelList ChannelList
;
142 SpiceChannelEventInfo
*info
;
143 QTAILQ_ENTRY(ChannelList
) link
;
145 static QTAILQ_HEAD(, ChannelList
) channel_list
= QTAILQ_HEAD_INITIALIZER(channel_list
);
147 static void channel_list_add(SpiceChannelEventInfo
*info
)
151 item
= qemu_mallocz(sizeof(*item
));
153 QTAILQ_INSERT_TAIL(&channel_list
, item
, link
);
156 static void channel_list_del(SpiceChannelEventInfo
*info
)
160 QTAILQ_FOREACH(item
, &channel_list
, link
) {
161 if (item
->info
!= info
) {
164 QTAILQ_REMOVE(&channel_list
, item
, link
);
170 static void add_addr_info(QDict
*dict
, struct sockaddr
*addr
, int len
)
172 char host
[NI_MAXHOST
], port
[NI_MAXSERV
];
175 getnameinfo(addr
, len
, host
, sizeof(host
), port
, sizeof(port
),
176 NI_NUMERICHOST
| NI_NUMERICSERV
);
177 family
= inet_strfamily(addr
->sa_family
);
179 qdict_put(dict
, "host", qstring_from_str(host
));
180 qdict_put(dict
, "port", qstring_from_str(port
));
181 qdict_put(dict
, "family", qstring_from_str(family
));
184 static void add_channel_info(QDict
*dict
, SpiceChannelEventInfo
*info
)
186 int tls
= info
->flags
& SPICE_CHANNEL_EVENT_FLAG_TLS
;
188 qdict_put(dict
, "connection-id", qint_from_int(info
->connection_id
));
189 qdict_put(dict
, "channel-type", qint_from_int(info
->type
));
190 qdict_put(dict
, "channel-id", qint_from_int(info
->id
));
191 qdict_put(dict
, "tls", qbool_from_int(tls
));
194 static QList
*channel_list_get(void)
201 QTAILQ_FOREACH(item
, &channel_list
, link
) {
203 add_addr_info(dict
, &item
->info
->paddr
, item
->info
->plen
);
204 add_channel_info(dict
, item
->info
);
205 qlist_append(list
, dict
);
210 static void channel_event(int event
, SpiceChannelEventInfo
*info
)
212 static const int qevent
[] = {
213 [ SPICE_CHANNEL_EVENT_CONNECTED
] = QEVENT_SPICE_CONNECTED
,
214 [ SPICE_CHANNEL_EVENT_INITIALIZED
] = QEVENT_SPICE_INITIALIZED
,
215 [ SPICE_CHANNEL_EVENT_DISCONNECTED
] = QEVENT_SPICE_DISCONNECTED
,
217 QDict
*server
, *client
;
220 client
= qdict_new();
221 add_addr_info(client
, &info
->paddr
, info
->plen
);
223 server
= qdict_new();
224 add_addr_info(server
, &info
->laddr
, info
->llen
);
226 if (event
== SPICE_CHANNEL_EVENT_INITIALIZED
) {
227 qdict_put(server
, "auth", qstring_from_str(auth
));
228 add_channel_info(client
, info
);
229 channel_list_add(info
);
231 if (event
== SPICE_CHANNEL_EVENT_DISCONNECTED
) {
232 channel_list_del(info
);
235 data
= qobject_from_jsonf("{ 'client': %p, 'server': %p }",
236 QOBJECT(client
), QOBJECT(server
));
237 monitor_protocol_event(qevent
[event
], data
);
238 qobject_decref(data
);
241 #else /* SPICE_INTERFACE_CORE_MINOR >= 3 */
243 static QList
*channel_list_get(void)
248 #endif /* SPICE_INTERFACE_CORE_MINOR >= 3 */
250 static SpiceCoreInterface core_interface
= {
251 .base
.type
= SPICE_INTERFACE_CORE
,
252 .base
.description
= "qemu core services",
253 .base
.major_version
= SPICE_INTERFACE_CORE_MAJOR
,
254 .base
.minor_version
= SPICE_INTERFACE_CORE_MINOR
,
256 .timer_add
= timer_add
,
257 .timer_start
= timer_start
,
258 .timer_cancel
= timer_cancel
,
259 .timer_remove
= timer_remove
,
261 .watch_add
= watch_add
,
262 .watch_update_mask
= watch_update_mask
,
263 .watch_remove
= watch_remove
,
265 #if SPICE_INTERFACE_CORE_MINOR >= 3
266 .channel_event
= channel_event
,
270 /* config string parsing */
272 static int name2enum(const char *string
, const char *table
[], int entries
)
277 for (i
= 0; i
< entries
; i
++) {
281 if (strcmp(string
, table
[i
]) != 0) {
290 static int parse_name(const char *string
, const char *optname
,
291 const char *table
[], int entries
)
293 int value
= name2enum(string
, table
, entries
);
298 fprintf(stderr
, "spice: invalid %s: %s\n", optname
, string
);
302 static const char *stream_video_names
[] = {
303 [ SPICE_STREAM_VIDEO_OFF
] = "off",
304 [ SPICE_STREAM_VIDEO_ALL
] = "all",
305 [ SPICE_STREAM_VIDEO_FILTER
] = "filter",
307 #define parse_stream_video(_name) \
308 name2enum(_name, stream_video_names, ARRAY_SIZE(stream_video_names))
310 static const char *compression_names
[] = {
311 [ SPICE_IMAGE_COMPRESS_OFF
] = "off",
312 [ SPICE_IMAGE_COMPRESS_AUTO_GLZ
] = "auto_glz",
313 [ SPICE_IMAGE_COMPRESS_AUTO_LZ
] = "auto_lz",
314 [ SPICE_IMAGE_COMPRESS_QUIC
] = "quic",
315 [ SPICE_IMAGE_COMPRESS_GLZ
] = "glz",
316 [ SPICE_IMAGE_COMPRESS_LZ
] = "lz",
318 #define parse_compression(_name) \
319 parse_name(_name, "image compression", \
320 compression_names, ARRAY_SIZE(compression_names))
322 static const char *wan_compression_names
[] = {
323 [ SPICE_WAN_COMPRESSION_AUTO
] = "auto",
324 [ SPICE_WAN_COMPRESSION_NEVER
] = "never",
325 [ SPICE_WAN_COMPRESSION_ALWAYS
] = "always",
327 #define parse_wan_compression(_name) \
328 parse_name(_name, "wan compression", \
329 wan_compression_names, ARRAY_SIZE(wan_compression_names))
331 /* functions for the rest of qemu */
333 static void info_spice_iter(QObject
*obj
, void *opaque
)
336 Monitor
*mon
= opaque
;
338 client
= qobject_to_qdict(obj
);
339 monitor_printf(mon
, "Channel:\n");
340 monitor_printf(mon
, " address: %s:%s%s\n",
341 qdict_get_str(client
, "host"),
342 qdict_get_str(client
, "port"),
343 qdict_get_bool(client
, "tls") ? " [tls]" : "");
344 monitor_printf(mon
, " session: %" PRId64
"\n",
345 qdict_get_int(client
, "connection-id"));
346 monitor_printf(mon
, " channel: %d:%d\n",
347 (int)qdict_get_int(client
, "channel-type"),
348 (int)qdict_get_int(client
, "channel-id"));
351 void do_info_spice_print(Monitor
*mon
, const QObject
*data
)
358 server
= qobject_to_qdict(data
);
359 if (qdict_get_bool(server
, "enabled") == 0) {
360 monitor_printf(mon
, "Server: disabled\n");
364 monitor_printf(mon
, "Server:\n");
365 host
= qdict_get_str(server
, "host");
366 port
= qdict_get_try_int(server
, "port", -1);
368 monitor_printf(mon
, " address: %s:%d\n", host
, port
);
370 port
= qdict_get_try_int(server
, "tls-port", -1);
372 monitor_printf(mon
, " address: %s:%d [tls]\n", host
, port
);
374 monitor_printf(mon
, " auth: %s\n", qdict_get_str(server
, "auth"));
375 monitor_printf(mon
, " compiled: %s\n",
376 qdict_get_str(server
, "compiled-version"));
378 channels
= qdict_get_qlist(server
, "channels");
379 if (qlist_empty(channels
)) {
380 monitor_printf(mon
, "Channels: none\n");
382 qlist_iter(channels
, info_spice_iter
, mon
);
386 void do_info_spice(Monitor
*mon
, QObject
**ret_data
)
388 QemuOpts
*opts
= QTAILQ_FIRST(&qemu_spice_opts
.head
);
393 char version_string
[20]; /* 12 = |255.255.255\0| is the max */
396 *ret_data
= qobject_from_jsonf("{ 'enabled': false }");
400 addr
= qemu_opt_get(opts
, "addr");
401 port
= qemu_opt_get_number(opts
, "port", 0);
402 tls_port
= qemu_opt_get_number(opts
, "tls-port", 0);
403 clist
= channel_list_get();
405 server
= qdict_new();
406 qdict_put(server
, "enabled", qbool_from_int(true));
407 qdict_put(server
, "auth", qstring_from_str(auth
));
408 qdict_put(server
, "host", qstring_from_str(addr
? addr
: "0.0.0.0"));
409 snprintf(version_string
, sizeof(version_string
), "%d.%d.%d",
410 (SPICE_SERVER_VERSION
& 0xff0000) >> 16,
411 (SPICE_SERVER_VERSION
& 0xff00) >> 8,
412 SPICE_SERVER_VERSION
& 0xff);
413 qdict_put(server
, "compiled-version", qstring_from_str(version_string
));
415 qdict_put(server
, "port", qint_from_int(port
));
418 qdict_put(server
, "tls-port", qint_from_int(tls_port
));
421 qdict_put(server
, "channels", clist
);
424 *ret_data
= QOBJECT(server
);
427 static void migration_state_notifier(Notifier
*notifier
, void *data
)
429 int state
= get_migration_state();
431 if (state
== MIG_STATE_COMPLETED
) {
432 #if SPICE_SERVER_VERSION >= 0x000701 /* 0.7.1 */
433 spice_server_migrate_switch(spice_server
);
438 int qemu_spice_migrate_info(const char *hostname
, int port
, int tls_port
,
441 return spice_server_migrate_info(spice_server
, hostname
,
442 port
, tls_port
, subject
);
445 static int add_channel(const char *name
, const char *value
, void *opaque
)
450 if (strcmp(name
, "tls-channel") == 0) {
451 security
= SPICE_CHANNEL_SECURITY_SSL
;
453 if (strcmp(name
, "plaintext-channel") == 0) {
454 security
= SPICE_CHANNEL_SECURITY_NONE
;
459 if (strcmp(value
, "default") == 0) {
460 rc
= spice_server_set_channel_security(spice_server
, NULL
, security
);
462 rc
= spice_server_set_channel_security(spice_server
, value
, security
);
465 fprintf(stderr
, "spice: failed to set channel security for %s\n", value
);
471 void qemu_spice_init(void)
473 QemuOpts
*opts
= QTAILQ_FIRST(&qemu_spice_opts
.head
);
474 const char *password
, *str
, *x509_dir
, *addr
,
475 *x509_key_password
= NULL
,
476 *x509_dh_file
= NULL
,
478 char *x509_key_file
= NULL
,
479 *x509_cert_file
= NULL
,
480 *x509_cacert_file
= NULL
;
481 int port
, tls_port
, len
, addr_flags
;
482 spice_image_compression_t compression
;
483 spice_wan_compression_t wan_compr
;
488 port
= qemu_opt_get_number(opts
, "port", 0);
489 tls_port
= qemu_opt_get_number(opts
, "tls-port", 0);
490 if (!port
&& !tls_port
) {
491 fprintf(stderr
, "neither port nor tls-port specified for spice.");
494 if (port
< 0 || port
> 65535) {
495 fprintf(stderr
, "spice port is out of range");
498 if (tls_port
< 0 || tls_port
> 65535) {
499 fprintf(stderr
, "spice tls-port is out of range");
502 password
= qemu_opt_get(opts
, "password");
505 x509_dir
= qemu_opt_get(opts
, "x509-dir");
506 if (NULL
== x509_dir
) {
509 len
= strlen(x509_dir
) + 32;
511 str
= qemu_opt_get(opts
, "x509-key-file");
513 x509_key_file
= qemu_strdup(str
);
515 x509_key_file
= qemu_malloc(len
);
516 snprintf(x509_key_file
, len
, "%s/%s", x509_dir
, X509_SERVER_KEY_FILE
);
519 str
= qemu_opt_get(opts
, "x509-cert-file");
521 x509_cert_file
= qemu_strdup(str
);
523 x509_cert_file
= qemu_malloc(len
);
524 snprintf(x509_cert_file
, len
, "%s/%s", x509_dir
, X509_SERVER_CERT_FILE
);
527 str
= qemu_opt_get(opts
, "x509-cacert-file");
529 x509_cacert_file
= qemu_strdup(str
);
531 x509_cacert_file
= qemu_malloc(len
);
532 snprintf(x509_cacert_file
, len
, "%s/%s", x509_dir
, X509_CA_CERT_FILE
);
535 x509_key_password
= qemu_opt_get(opts
, "x509-key-password");
536 x509_dh_file
= qemu_opt_get(opts
, "x509-dh-file");
537 tls_ciphers
= qemu_opt_get(opts
, "tls-ciphers");
540 addr
= qemu_opt_get(opts
, "addr");
542 if (qemu_opt_get_bool(opts
, "ipv4", 0)) {
543 addr_flags
|= SPICE_ADDR_FLAG_IPV4_ONLY
;
544 } else if (qemu_opt_get_bool(opts
, "ipv6", 0)) {
545 addr_flags
|= SPICE_ADDR_FLAG_IPV6_ONLY
;
548 spice_server
= spice_server_new();
549 spice_server_set_addr(spice_server
, addr
? addr
: "", addr_flags
);
551 spice_server_set_port(spice_server
, port
);
554 spice_server_set_tls(spice_server
, tls_port
,
563 spice_server_set_ticket(spice_server
, password
, 0, 0, 0);
565 if (qemu_opt_get_bool(opts
, "sasl", 0)) {
566 #if SPICE_SERVER_VERSION >= 0x000900 /* 0.9.0 */
567 if (spice_server_set_sasl_appname(spice_server
, "qemu") == -1 ||
568 spice_server_set_sasl(spice_server
, 1) == -1) {
569 fprintf(stderr
, "spice: failed to enable sasl\n");
573 fprintf(stderr
, "spice: sasl is not available (spice >= 0.9 required)\n");
577 if (qemu_opt_get_bool(opts
, "disable-ticketing", 0)) {
579 spice_server_set_noauth(spice_server
);
582 #if SPICE_SERVER_VERSION >= 0x000801
583 if (qemu_opt_get_bool(opts
, "disable-copy-paste", 0)) {
584 spice_server_set_agent_copypaste(spice_server
, false);
588 compression
= SPICE_IMAGE_COMPRESS_AUTO_GLZ
;
589 str
= qemu_opt_get(opts
, "image-compression");
591 compression
= parse_compression(str
);
593 spice_server_set_image_compression(spice_server
, compression
);
595 wan_compr
= SPICE_WAN_COMPRESSION_AUTO
;
596 str
= qemu_opt_get(opts
, "jpeg-wan-compression");
598 wan_compr
= parse_wan_compression(str
);
600 spice_server_set_jpeg_compression(spice_server
, wan_compr
);
602 wan_compr
= SPICE_WAN_COMPRESSION_AUTO
;
603 str
= qemu_opt_get(opts
, "zlib-glz-wan-compression");
605 wan_compr
= parse_wan_compression(str
);
607 spice_server_set_zlib_glz_compression(spice_server
, wan_compr
);
609 str
= qemu_opt_get(opts
, "streaming-video");
611 int streaming_video
= parse_stream_video(str
);
612 spice_server_set_streaming_video(spice_server
, streaming_video
);
615 spice_server_set_agent_mouse
616 (spice_server
, qemu_opt_get_bool(opts
, "agent-mouse", 1));
617 spice_server_set_playback_compression
618 (spice_server
, qemu_opt_get_bool(opts
, "playback-compression", 1));
620 qemu_opt_foreach(opts
, add_channel
, NULL
, 0);
622 if (0 != spice_server_init(spice_server
, &core_interface
)) {
623 fprintf(stderr
, "failed to initialize spice server");
628 migration_state
.notify
= migration_state_notifier
;
629 add_migration_state_change_notifier(&migration_state
);
631 qemu_spice_input_init();
632 qemu_spice_audio_init();
634 qemu_free(x509_key_file
);
635 qemu_free(x509_cert_file
);
636 qemu_free(x509_cacert_file
);
639 int qemu_spice_add_interface(SpiceBaseInstance
*sin
)
642 if (QTAILQ_FIRST(&qemu_spice_opts
.head
) != NULL
) {
643 fprintf(stderr
, "Oops: spice configured but not active\n");
647 * Create a spice server instance.
648 * It does *not* listen on the network.
649 * It handles QXL local rendering only.
651 * With a command line like '-vnc :0 -vga qxl' you'll end up here.
653 spice_server
= spice_server_new();
654 spice_server_init(spice_server
, &core_interface
);
656 return spice_server_add_interface(spice_server
, sin
);
659 static int qemu_spice_set_ticket(bool fail_if_conn
, bool disconnect_if_conn
)
661 time_t lifetime
, now
= time(NULL
);
664 if (now
< auth_expires
) {
665 passwd
= auth_passwd
;
666 lifetime
= (auth_expires
- now
);
667 if (lifetime
> INT_MAX
) {
674 return spice_server_set_ticket(spice_server
, passwd
, lifetime
,
675 fail_if_conn
, disconnect_if_conn
);
678 int qemu_spice_set_passwd(const char *passwd
,
679 bool fail_if_conn
, bool disconnect_if_conn
)
682 auth_passwd
= strdup(passwd
);
683 return qemu_spice_set_ticket(fail_if_conn
, disconnect_if_conn
);
686 int qemu_spice_set_pw_expire(time_t expires
)
688 auth_expires
= expires
;
689 return qemu_spice_set_ticket(false, false);
692 static void spice_register_config(void)
694 qemu_add_opts(&qemu_spice_opts
);
696 machine_init(spice_register_config
);
698 static void spice_initialize(void)
702 device_init(spice_initialize
);