qapi: Convert query-spice
[qemu/wangdongxu.git] / ui / spice-core.c
blobf556849ef9fb387abe080c056e70c556efc93c13
1 /*
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/>.
18 #include <spice.h>
19 #include <spice-experimental.h>
21 #include <netdb.h>
22 #include <pthread.h>
24 #include "qemu-common.h"
25 #include "qemu-spice.h"
26 #include "qemu-timer.h"
27 #include "qemu-queue.h"
28 #include "qemu-x509.h"
29 #include "qemu_socket.h"
30 #include "qmp-commands.h"
31 #include "qint.h"
32 #include "qbool.h"
33 #include "qstring.h"
34 #include "qjson.h"
35 #include "notify.h"
36 #include "migration.h"
37 #include "monitor.h"
38 #include "hw/hw.h"
40 /* core bits */
42 static SpiceServer *spice_server;
43 static Notifier migration_state;
44 static const char *auth = "spice";
45 static char *auth_passwd;
46 static time_t auth_expires = TIME_MAX;
47 int using_spice = 0;
49 static pthread_t me;
51 struct SpiceTimer {
52 QEMUTimer *timer;
53 QTAILQ_ENTRY(SpiceTimer) next;
55 static QTAILQ_HEAD(, SpiceTimer) timers = QTAILQ_HEAD_INITIALIZER(timers);
57 static SpiceTimer *timer_add(SpiceTimerFunc func, void *opaque)
59 SpiceTimer *timer;
61 timer = g_malloc0(sizeof(*timer));
62 timer->timer = qemu_new_timer_ms(rt_clock, func, opaque);
63 QTAILQ_INSERT_TAIL(&timers, timer, next);
64 return timer;
67 static void timer_start(SpiceTimer *timer, uint32_t ms)
69 qemu_mod_timer(timer->timer, qemu_get_clock_ms(rt_clock) + ms);
72 static void timer_cancel(SpiceTimer *timer)
74 qemu_del_timer(timer->timer);
77 static void timer_remove(SpiceTimer *timer)
79 qemu_del_timer(timer->timer);
80 qemu_free_timer(timer->timer);
81 QTAILQ_REMOVE(&timers, timer, next);
82 g_free(timer);
85 struct SpiceWatch {
86 int fd;
87 int event_mask;
88 SpiceWatchFunc func;
89 void *opaque;
90 QTAILQ_ENTRY(SpiceWatch) next;
92 static QTAILQ_HEAD(, SpiceWatch) watches = QTAILQ_HEAD_INITIALIZER(watches);
94 static void watch_read(void *opaque)
96 SpiceWatch *watch = opaque;
97 watch->func(watch->fd, SPICE_WATCH_EVENT_READ, watch->opaque);
100 static void watch_write(void *opaque)
102 SpiceWatch *watch = opaque;
103 watch->func(watch->fd, SPICE_WATCH_EVENT_WRITE, watch->opaque);
106 static void watch_update_mask(SpiceWatch *watch, int event_mask)
108 IOHandler *on_read = NULL;
109 IOHandler *on_write = NULL;
111 watch->event_mask = event_mask;
112 if (watch->event_mask & SPICE_WATCH_EVENT_READ) {
113 on_read = watch_read;
115 if (watch->event_mask & SPICE_WATCH_EVENT_WRITE) {
116 on_write = watch_write;
118 qemu_set_fd_handler(watch->fd, on_read, on_write, watch);
121 static SpiceWatch *watch_add(int fd, int event_mask, SpiceWatchFunc func, void *opaque)
123 SpiceWatch *watch;
125 watch = g_malloc0(sizeof(*watch));
126 watch->fd = fd;
127 watch->func = func;
128 watch->opaque = opaque;
129 QTAILQ_INSERT_TAIL(&watches, watch, next);
131 watch_update_mask(watch, event_mask);
132 return watch;
135 static void watch_remove(SpiceWatch *watch)
137 watch_update_mask(watch, 0);
138 QTAILQ_REMOVE(&watches, watch, next);
139 g_free(watch);
142 #if SPICE_INTERFACE_CORE_MINOR >= 3
144 typedef struct ChannelList ChannelList;
145 struct ChannelList {
146 SpiceChannelEventInfo *info;
147 QTAILQ_ENTRY(ChannelList) link;
149 static QTAILQ_HEAD(, ChannelList) channel_list = QTAILQ_HEAD_INITIALIZER(channel_list);
151 static void channel_list_add(SpiceChannelEventInfo *info)
153 ChannelList *item;
155 item = g_malloc0(sizeof(*item));
156 item->info = info;
157 QTAILQ_INSERT_TAIL(&channel_list, item, link);
160 static void channel_list_del(SpiceChannelEventInfo *info)
162 ChannelList *item;
164 QTAILQ_FOREACH(item, &channel_list, link) {
165 if (item->info != info) {
166 continue;
168 QTAILQ_REMOVE(&channel_list, item, link);
169 g_free(item);
170 return;
174 static void add_addr_info(QDict *dict, struct sockaddr *addr, int len)
176 char host[NI_MAXHOST], port[NI_MAXSERV];
177 const char *family;
179 getnameinfo(addr, len, host, sizeof(host), port, sizeof(port),
180 NI_NUMERICHOST | NI_NUMERICSERV);
181 family = inet_strfamily(addr->sa_family);
183 qdict_put(dict, "host", qstring_from_str(host));
184 qdict_put(dict, "port", qstring_from_str(port));
185 qdict_put(dict, "family", qstring_from_str(family));
188 static void add_channel_info(QDict *dict, SpiceChannelEventInfo *info)
190 int tls = info->flags & SPICE_CHANNEL_EVENT_FLAG_TLS;
192 qdict_put(dict, "connection-id", qint_from_int(info->connection_id));
193 qdict_put(dict, "channel-type", qint_from_int(info->type));
194 qdict_put(dict, "channel-id", qint_from_int(info->id));
195 qdict_put(dict, "tls", qbool_from_int(tls));
198 static void channel_event(int event, SpiceChannelEventInfo *info)
200 static const int qevent[] = {
201 [ SPICE_CHANNEL_EVENT_CONNECTED ] = QEVENT_SPICE_CONNECTED,
202 [ SPICE_CHANNEL_EVENT_INITIALIZED ] = QEVENT_SPICE_INITIALIZED,
203 [ SPICE_CHANNEL_EVENT_DISCONNECTED ] = QEVENT_SPICE_DISCONNECTED,
205 QDict *server, *client;
206 QObject *data;
209 * Spice server might have called us from spice worker thread
210 * context (happens on display channel disconnects). Spice should
211 * not do that. It isn't that easy to fix it in spice and even
212 * when it is fixed we still should cover the already released
213 * spice versions. So detect that we've been called from another
214 * thread and grab the iothread lock if so before calling qemu
215 * functions.
217 bool need_lock = !pthread_equal(me, pthread_self());
218 if (need_lock) {
219 qemu_mutex_lock_iothread();
222 client = qdict_new();
223 add_addr_info(client, &info->paddr, info->plen);
225 server = qdict_new();
226 add_addr_info(server, &info->laddr, info->llen);
228 if (event == SPICE_CHANNEL_EVENT_INITIALIZED) {
229 qdict_put(server, "auth", qstring_from_str(auth));
230 add_channel_info(client, info);
231 channel_list_add(info);
233 if (event == SPICE_CHANNEL_EVENT_DISCONNECTED) {
234 channel_list_del(info);
237 data = qobject_from_jsonf("{ 'client': %p, 'server': %p }",
238 QOBJECT(client), QOBJECT(server));
239 monitor_protocol_event(qevent[event], data);
240 qobject_decref(data);
242 if (need_lock) {
243 qemu_mutex_unlock_iothread();
247 #else /* SPICE_INTERFACE_CORE_MINOR >= 3 */
249 static QList *channel_list_get(void)
251 return NULL;
254 #endif /* SPICE_INTERFACE_CORE_MINOR >= 3 */
256 static SpiceCoreInterface core_interface = {
257 .base.type = SPICE_INTERFACE_CORE,
258 .base.description = "qemu core services",
259 .base.major_version = SPICE_INTERFACE_CORE_MAJOR,
260 .base.minor_version = SPICE_INTERFACE_CORE_MINOR,
262 .timer_add = timer_add,
263 .timer_start = timer_start,
264 .timer_cancel = timer_cancel,
265 .timer_remove = timer_remove,
267 .watch_add = watch_add,
268 .watch_update_mask = watch_update_mask,
269 .watch_remove = watch_remove,
271 #if SPICE_INTERFACE_CORE_MINOR >= 3
272 .channel_event = channel_event,
273 #endif
276 /* config string parsing */
278 static int name2enum(const char *string, const char *table[], int entries)
280 int i;
282 if (string) {
283 for (i = 0; i < entries; i++) {
284 if (!table[i]) {
285 continue;
287 if (strcmp(string, table[i]) != 0) {
288 continue;
290 return i;
293 return -1;
296 static int parse_name(const char *string, const char *optname,
297 const char *table[], int entries)
299 int value = name2enum(string, table, entries);
301 if (value != -1) {
302 return value;
304 fprintf(stderr, "spice: invalid %s: %s\n", optname, string);
305 exit(1);
308 static const char *stream_video_names[] = {
309 [ SPICE_STREAM_VIDEO_OFF ] = "off",
310 [ SPICE_STREAM_VIDEO_ALL ] = "all",
311 [ SPICE_STREAM_VIDEO_FILTER ] = "filter",
313 #define parse_stream_video(_name) \
314 name2enum(_name, stream_video_names, ARRAY_SIZE(stream_video_names))
316 static const char *compression_names[] = {
317 [ SPICE_IMAGE_COMPRESS_OFF ] = "off",
318 [ SPICE_IMAGE_COMPRESS_AUTO_GLZ ] = "auto_glz",
319 [ SPICE_IMAGE_COMPRESS_AUTO_LZ ] = "auto_lz",
320 [ SPICE_IMAGE_COMPRESS_QUIC ] = "quic",
321 [ SPICE_IMAGE_COMPRESS_GLZ ] = "glz",
322 [ SPICE_IMAGE_COMPRESS_LZ ] = "lz",
324 #define parse_compression(_name) \
325 parse_name(_name, "image compression", \
326 compression_names, ARRAY_SIZE(compression_names))
328 static const char *wan_compression_names[] = {
329 [ SPICE_WAN_COMPRESSION_AUTO ] = "auto",
330 [ SPICE_WAN_COMPRESSION_NEVER ] = "never",
331 [ SPICE_WAN_COMPRESSION_ALWAYS ] = "always",
333 #define parse_wan_compression(_name) \
334 parse_name(_name, "wan compression", \
335 wan_compression_names, ARRAY_SIZE(wan_compression_names))
337 /* functions for the rest of qemu */
339 static SpiceChannelList *qmp_query_spice_channels(void)
341 SpiceChannelList *cur_item = NULL, *head = NULL;
342 ChannelList *item;
344 QTAILQ_FOREACH(item, &channel_list, link) {
345 SpiceChannelList *chan;
346 char host[NI_MAXHOST], port[NI_MAXSERV];
348 chan = g_malloc0(sizeof(*chan));
349 chan->value = g_malloc0(sizeof(*chan->value));
351 getnameinfo(&item->info->paddr, item->info->plen,
352 host, sizeof(host), port, sizeof(port),
353 NI_NUMERICHOST | NI_NUMERICSERV);
354 chan->value->host = g_strdup(host);
355 chan->value->port = g_strdup(port);
356 chan->value->family = g_strdup(inet_strfamily(item->info->paddr.sa_family));
358 chan->value->connection_id = item->info->connection_id;
359 chan->value->channel_type = item->info->type;
360 chan->value->channel_id = item->info->id;
361 chan->value->tls = item->info->flags & SPICE_CHANNEL_EVENT_FLAG_TLS;
363 /* XXX: waiting for the qapi to support GSList */
364 if (!cur_item) {
365 head = cur_item = chan;
366 } else {
367 cur_item->next = chan;
368 cur_item = chan;
372 return head;
375 SpiceInfo *qmp_query_spice(Error **errp)
377 QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
378 int port, tls_port;
379 const char *addr;
380 SpiceInfo *info;
381 char version_string[20]; /* 12 = |255.255.255\0| is the max */
383 info = g_malloc0(sizeof(*info));
385 if (!spice_server) {
386 info->enabled = false;
387 return info;
390 info->enabled = true;
392 addr = qemu_opt_get(opts, "addr");
393 port = qemu_opt_get_number(opts, "port", 0);
394 tls_port = qemu_opt_get_number(opts, "tls-port", 0);
396 info->has_auth = true;
397 info->auth = g_strdup(auth);
399 info->has_host = true;
400 info->host = g_strdup(addr ? addr : "0.0.0.0");
402 info->has_compiled_version = true;
403 snprintf(version_string, sizeof(version_string), "%d.%d.%d",
404 (SPICE_SERVER_VERSION & 0xff0000) >> 16,
405 (SPICE_SERVER_VERSION & 0xff00) >> 8,
406 SPICE_SERVER_VERSION & 0xff);
407 info->compiled_version = g_strdup(version_string);
409 if (port) {
410 info->has_port = true;
411 info->port = port;
413 if (tls_port) {
414 info->has_tls_port = true;
415 info->tls_port = tls_port;
418 /* for compatibility with the original command */
419 info->has_channels = true;
420 info->channels = qmp_query_spice_channels();
422 return info;
425 static void migration_state_notifier(Notifier *notifier, void *data)
427 MigrationState *s = data;
429 if (migration_has_finished(s)) {
430 #if SPICE_SERVER_VERSION >= 0x000701 /* 0.7.1 */
431 spice_server_migrate_switch(spice_server);
432 #endif
436 int qemu_spice_migrate_info(const char *hostname, int port, int tls_port,
437 const char *subject)
439 return spice_server_migrate_info(spice_server, hostname,
440 port, tls_port, subject);
443 static int add_channel(const char *name, const char *value, void *opaque)
445 int security = 0;
446 int rc;
448 if (strcmp(name, "tls-channel") == 0) {
449 security = SPICE_CHANNEL_SECURITY_SSL;
451 if (strcmp(name, "plaintext-channel") == 0) {
452 security = SPICE_CHANNEL_SECURITY_NONE;
454 if (security == 0) {
455 return 0;
457 if (strcmp(value, "default") == 0) {
458 rc = spice_server_set_channel_security(spice_server, NULL, security);
459 } else {
460 rc = spice_server_set_channel_security(spice_server, value, security);
462 if (rc != 0) {
463 fprintf(stderr, "spice: failed to set channel security for %s\n", value);
464 exit(1);
466 return 0;
469 void qemu_spice_init(void)
471 QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
472 const char *password, *str, *x509_dir, *addr,
473 *x509_key_password = NULL,
474 *x509_dh_file = NULL,
475 *tls_ciphers = NULL;
476 char *x509_key_file = NULL,
477 *x509_cert_file = NULL,
478 *x509_cacert_file = NULL;
479 int port, tls_port, len, addr_flags;
480 spice_image_compression_t compression;
481 spice_wan_compression_t wan_compr;
483 me = pthread_self();
485 if (!opts) {
486 return;
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.");
492 exit(1);
494 if (port < 0 || port > 65535) {
495 fprintf(stderr, "spice port is out of range");
496 exit(1);
498 if (tls_port < 0 || tls_port > 65535) {
499 fprintf(stderr, "spice tls-port is out of range");
500 exit(1);
502 password = qemu_opt_get(opts, "password");
504 if (tls_port) {
505 x509_dir = qemu_opt_get(opts, "x509-dir");
506 if (NULL == x509_dir) {
507 x509_dir = ".";
509 len = strlen(x509_dir) + 32;
511 str = qemu_opt_get(opts, "x509-key-file");
512 if (str) {
513 x509_key_file = g_strdup(str);
514 } else {
515 x509_key_file = g_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");
520 if (str) {
521 x509_cert_file = g_strdup(str);
522 } else {
523 x509_cert_file = g_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");
528 if (str) {
529 x509_cacert_file = g_strdup(str);
530 } else {
531 x509_cacert_file = g_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");
541 addr_flags = 0;
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);
550 if (port) {
551 spice_server_set_port(spice_server, port);
553 if (tls_port) {
554 spice_server_set_tls(spice_server, tls_port,
555 x509_cacert_file,
556 x509_cert_file,
557 x509_key_file,
558 x509_key_password,
559 x509_dh_file,
560 tls_ciphers);
562 if (password) {
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");
570 exit(1);
572 #else
573 fprintf(stderr, "spice: sasl is not available (spice >= 0.9 required)\n");
574 exit(1);
575 #endif
577 if (qemu_opt_get_bool(opts, "disable-ticketing", 0)) {
578 auth = "none";
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);
586 #endif
588 compression = SPICE_IMAGE_COMPRESS_AUTO_GLZ;
589 str = qemu_opt_get(opts, "image-compression");
590 if (str) {
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");
597 if (str) {
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");
604 if (str) {
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");
610 if (str) {
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");
624 exit(1);
626 using_spice = 1;
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 g_free(x509_key_file);
635 g_free(x509_cert_file);
636 g_free(x509_cacert_file);
639 int qemu_spice_add_interface(SpiceBaseInstance *sin)
641 if (!spice_server) {
642 if (QTAILQ_FIRST(&qemu_spice_opts.head) != NULL) {
643 fprintf(stderr, "Oops: spice configured but not active\n");
644 exit(1);
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);
662 char *passwd;
664 if (now < auth_expires) {
665 passwd = auth_passwd;
666 lifetime = (auth_expires - now);
667 if (lifetime > INT_MAX) {
668 lifetime = INT_MAX;
670 } else {
671 passwd = NULL;
672 lifetime = 1;
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)
681 free(auth_passwd);
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)
700 qemu_spice_init();
702 device_init(spice_initialize);