qapi: Indent tagged doc comment sections properly
[qemu/armbru.git] / ui / spice-core.c
blob37b277fd09fee5e801066f8f7f00954674f2612a
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 "qemu/osdep.h"
19 #include <spice.h>
21 #include "sysemu/sysemu.h"
22 #include "sysemu/runstate.h"
23 #include "ui/qemu-spice.h"
24 #include "qemu/error-report.h"
25 #include "qemu/main-loop.h"
26 #include "qemu/module.h"
27 #include "qemu/thread.h"
28 #include "qemu/timer.h"
29 #include "qemu/queue.h"
30 #include "qemu-x509.h"
31 #include "qemu/sockets.h"
32 #include "qapi/error.h"
33 #include "qapi/qapi-commands-ui.h"
34 #include "qapi/qapi-events-ui.h"
35 #include "qemu/notify.h"
36 #include "qemu/option.h"
37 #include "crypto/secret_common.h"
38 #include "migration/misc.h"
39 #include "hw/pci/pci_bus.h"
40 #include "ui/spice-display.h"
42 /* core bits */
44 static SpiceServer *spice_server;
45 static Notifier migration_state;
46 static const char *auth = "spice";
47 static char *auth_passwd;
48 static time_t auth_expires = TIME_MAX;
49 static int spice_migration_completed;
50 static int spice_display_is_running;
51 static int spice_have_target_host;
53 static QemuThread me;
55 struct SpiceTimer {
56 QEMUTimer *timer;
59 static SpiceTimer *timer_add(SpiceTimerFunc func, void *opaque)
61 SpiceTimer *timer;
63 timer = g_malloc0(sizeof(*timer));
64 timer->timer = timer_new_ms(QEMU_CLOCK_REALTIME, func, opaque);
65 return timer;
68 static void timer_start(SpiceTimer *timer, uint32_t ms)
70 timer_mod(timer->timer, qemu_clock_get_ms(QEMU_CLOCK_REALTIME) + ms);
73 static void timer_cancel(SpiceTimer *timer)
75 timer_del(timer->timer);
78 static void timer_remove(SpiceTimer *timer)
80 timer_free(timer->timer);
81 g_free(timer);
84 struct SpiceWatch {
85 int fd;
86 SpiceWatchFunc func;
87 void *opaque;
90 static void watch_read(void *opaque)
92 SpiceWatch *watch = opaque;
93 int fd = watch->fd;
95 #ifdef WIN32
96 fd = _get_osfhandle(fd);
97 #endif
98 watch->func(fd, SPICE_WATCH_EVENT_READ, watch->opaque);
101 static void watch_write(void *opaque)
103 SpiceWatch *watch = opaque;
104 int fd = watch->fd;
106 #ifdef WIN32
107 fd = _get_osfhandle(fd);
108 #endif
109 watch->func(fd, SPICE_WATCH_EVENT_WRITE, watch->opaque);
112 static void watch_update_mask(SpiceWatch *watch, int event_mask)
114 IOHandler *on_read = NULL;
115 IOHandler *on_write = NULL;
117 if (event_mask & SPICE_WATCH_EVENT_READ) {
118 on_read = watch_read;
120 if (event_mask & SPICE_WATCH_EVENT_WRITE) {
121 on_write = watch_write;
123 qemu_set_fd_handler(watch->fd, on_read, on_write, watch);
126 static SpiceWatch *watch_add(int fd, int event_mask, SpiceWatchFunc func, void *opaque)
128 SpiceWatch *watch;
130 #ifdef WIN32
131 fd = _open_osfhandle(fd, _O_BINARY);
132 if (fd < 0) {
133 error_setg_win32(&error_warn, WSAGetLastError(), "Couldn't associate a FD with the SOCKET");
134 return NULL;
136 #endif
138 watch = g_malloc0(sizeof(*watch));
139 watch->fd = fd;
140 watch->func = func;
141 watch->opaque = opaque;
143 watch_update_mask(watch, event_mask);
144 return watch;
147 static void watch_remove(SpiceWatch *watch)
149 qemu_set_fd_handler(watch->fd, NULL, NULL, NULL);
150 #ifdef WIN32
151 /* SOCKET is owned by spice */
152 qemu_close_socket_osfhandle(watch->fd);
153 #endif
154 g_free(watch);
157 typedef struct ChannelList ChannelList;
158 struct ChannelList {
159 SpiceChannelEventInfo *info;
160 QTAILQ_ENTRY(ChannelList) link;
162 static QTAILQ_HEAD(, ChannelList) channel_list = QTAILQ_HEAD_INITIALIZER(channel_list);
164 static void channel_list_add(SpiceChannelEventInfo *info)
166 ChannelList *item;
168 item = g_malloc0(sizeof(*item));
169 item->info = info;
170 QTAILQ_INSERT_TAIL(&channel_list, item, link);
173 static void channel_list_del(SpiceChannelEventInfo *info)
175 ChannelList *item;
177 QTAILQ_FOREACH(item, &channel_list, link) {
178 if (item->info != info) {
179 continue;
181 QTAILQ_REMOVE(&channel_list, item, link);
182 g_free(item);
183 return;
187 static void add_addr_info(SpiceBasicInfo *info, struct sockaddr *addr, int len)
189 char host[NI_MAXHOST], port[NI_MAXSERV];
191 getnameinfo(addr, len, host, sizeof(host), port, sizeof(port),
192 NI_NUMERICHOST | NI_NUMERICSERV);
194 info->host = g_strdup(host);
195 info->port = g_strdup(port);
196 info->family = inet_netfamily(addr->sa_family);
199 static void add_channel_info(SpiceChannel *sc, SpiceChannelEventInfo *info)
201 int tls = info->flags & SPICE_CHANNEL_EVENT_FLAG_TLS;
203 sc->connection_id = info->connection_id;
204 sc->channel_type = info->type;
205 sc->channel_id = info->id;
206 sc->tls = !!tls;
209 static void channel_event(int event, SpiceChannelEventInfo *info)
211 SpiceServerInfo *server = g_malloc0(sizeof(*server));
212 SpiceChannel *client = g_malloc0(sizeof(*client));
215 * Spice server might have called us from spice worker thread
216 * context (happens on display channel disconnects). Spice should
217 * not do that. It isn't that easy to fix it in spice and even
218 * when it is fixed we still should cover the already released
219 * spice versions. So detect that we've been called from another
220 * thread and grab the BQL if so before calling qemu
221 * functions.
223 bool need_lock = !qemu_thread_is_self(&me);
224 if (need_lock) {
225 bql_lock();
228 if (info->flags & SPICE_CHANNEL_EVENT_FLAG_ADDR_EXT) {
229 add_addr_info(qapi_SpiceChannel_base(client),
230 (struct sockaddr *)&info->paddr_ext,
231 info->plen_ext);
232 add_addr_info(qapi_SpiceServerInfo_base(server),
233 (struct sockaddr *)&info->laddr_ext,
234 info->llen_ext);
235 } else {
236 error_report("spice: %s, extended address is expected",
237 __func__);
240 switch (event) {
241 case SPICE_CHANNEL_EVENT_CONNECTED:
242 qapi_event_send_spice_connected(qapi_SpiceServerInfo_base(server),
243 qapi_SpiceChannel_base(client));
244 break;
245 case SPICE_CHANNEL_EVENT_INITIALIZED:
246 if (auth) {
247 server->auth = g_strdup(auth);
249 add_channel_info(client, info);
250 channel_list_add(info);
251 qapi_event_send_spice_initialized(server, client);
252 break;
253 case SPICE_CHANNEL_EVENT_DISCONNECTED:
254 channel_list_del(info);
255 qapi_event_send_spice_disconnected(qapi_SpiceServerInfo_base(server),
256 qapi_SpiceChannel_base(client));
257 break;
258 default:
259 break;
262 if (need_lock) {
263 bql_unlock();
266 qapi_free_SpiceServerInfo(server);
267 qapi_free_SpiceChannel(client);
270 static SpiceCoreInterface core_interface = {
271 .base.type = SPICE_INTERFACE_CORE,
272 .base.description = "qemu core services",
273 .base.major_version = SPICE_INTERFACE_CORE_MAJOR,
274 .base.minor_version = SPICE_INTERFACE_CORE_MINOR,
276 .timer_add = timer_add,
277 .timer_start = timer_start,
278 .timer_cancel = timer_cancel,
279 .timer_remove = timer_remove,
281 .watch_add = watch_add,
282 .watch_update_mask = watch_update_mask,
283 .watch_remove = watch_remove,
285 .channel_event = channel_event,
288 static void migrate_connect_complete_cb(SpiceMigrateInstance *sin);
289 static void migrate_end_complete_cb(SpiceMigrateInstance *sin);
291 static const SpiceMigrateInterface migrate_interface = {
292 .base.type = SPICE_INTERFACE_MIGRATION,
293 .base.description = "migration",
294 .base.major_version = SPICE_INTERFACE_MIGRATION_MAJOR,
295 .base.minor_version = SPICE_INTERFACE_MIGRATION_MINOR,
296 .migrate_connect_complete = migrate_connect_complete_cb,
297 .migrate_end_complete = migrate_end_complete_cb,
300 static SpiceMigrateInstance spice_migrate;
302 static void migrate_connect_complete_cb(SpiceMigrateInstance *sin)
304 /* nothing, but libspice-server expects this cb being present. */
307 static void migrate_end_complete_cb(SpiceMigrateInstance *sin)
309 qapi_event_send_spice_migrate_completed();
310 spice_migration_completed = true;
313 /* config string parsing */
315 static int name2enum(const char *string, const char *table[], int entries)
317 int i;
319 if (string) {
320 for (i = 0; i < entries; i++) {
321 if (!table[i]) {
322 continue;
324 if (strcmp(string, table[i]) != 0) {
325 continue;
327 return i;
330 return -1;
333 static int parse_name(const char *string, const char *optname,
334 const char *table[], int entries)
336 int value = name2enum(string, table, entries);
338 if (value != -1) {
339 return value;
341 error_report("spice: invalid %s: %s", optname, string);
342 exit(1);
345 static const char *stream_video_names[] = {
346 [ SPICE_STREAM_VIDEO_OFF ] = "off",
347 [ SPICE_STREAM_VIDEO_ALL ] = "all",
348 [ SPICE_STREAM_VIDEO_FILTER ] = "filter",
350 #define parse_stream_video(_name) \
351 parse_name(_name, "stream video control", \
352 stream_video_names, ARRAY_SIZE(stream_video_names))
354 static const char *compression_names[] = {
355 [ SPICE_IMAGE_COMPRESS_OFF ] = "off",
356 [ SPICE_IMAGE_COMPRESS_AUTO_GLZ ] = "auto_glz",
357 [ SPICE_IMAGE_COMPRESS_AUTO_LZ ] = "auto_lz",
358 [ SPICE_IMAGE_COMPRESS_QUIC ] = "quic",
359 [ SPICE_IMAGE_COMPRESS_GLZ ] = "glz",
360 [ SPICE_IMAGE_COMPRESS_LZ ] = "lz",
362 #define parse_compression(_name) \
363 parse_name(_name, "image compression", \
364 compression_names, ARRAY_SIZE(compression_names))
366 static const char *wan_compression_names[] = {
367 [ SPICE_WAN_COMPRESSION_AUTO ] = "auto",
368 [ SPICE_WAN_COMPRESSION_NEVER ] = "never",
369 [ SPICE_WAN_COMPRESSION_ALWAYS ] = "always",
371 #define parse_wan_compression(_name) \
372 parse_name(_name, "wan compression", \
373 wan_compression_names, ARRAY_SIZE(wan_compression_names))
375 /* functions for the rest of qemu */
377 static SpiceChannelList *qmp_query_spice_channels(void)
379 SpiceChannelList *head = NULL, **tail = &head;
380 ChannelList *item;
382 QTAILQ_FOREACH(item, &channel_list, link) {
383 SpiceChannel *chan;
384 char host[NI_MAXHOST], port[NI_MAXSERV];
385 struct sockaddr *paddr;
386 socklen_t plen;
388 assert(item->info->flags & SPICE_CHANNEL_EVENT_FLAG_ADDR_EXT);
390 chan = g_malloc0(sizeof(*chan));
392 paddr = (struct sockaddr *)&item->info->paddr_ext;
393 plen = item->info->plen_ext;
394 getnameinfo(paddr, plen,
395 host, sizeof(host), port, sizeof(port),
396 NI_NUMERICHOST | NI_NUMERICSERV);
397 chan->host = g_strdup(host);
398 chan->port = g_strdup(port);
399 chan->family = inet_netfamily(paddr->sa_family);
401 chan->connection_id = item->info->connection_id;
402 chan->channel_type = item->info->type;
403 chan->channel_id = item->info->id;
404 chan->tls = item->info->flags & SPICE_CHANNEL_EVENT_FLAG_TLS;
406 QAPI_LIST_APPEND(tail, chan);
409 return head;
412 static QemuOptsList qemu_spice_opts = {
413 .name = "spice",
414 .head = QTAILQ_HEAD_INITIALIZER(qemu_spice_opts.head),
415 .merge_lists = true,
416 .desc = {
418 .name = "port",
419 .type = QEMU_OPT_NUMBER,
421 .name = "tls-port",
422 .type = QEMU_OPT_NUMBER,
424 .name = "addr",
425 .type = QEMU_OPT_STRING,
427 .name = "ipv4",
428 .type = QEMU_OPT_BOOL,
430 .name = "ipv6",
431 .type = QEMU_OPT_BOOL,
432 #ifdef SPICE_ADDR_FLAG_UNIX_ONLY
434 .name = "unix",
435 .type = QEMU_OPT_BOOL,
436 #endif
438 .name = "password-secret",
439 .type = QEMU_OPT_STRING,
441 .name = "disable-ticketing",
442 .type = QEMU_OPT_BOOL,
444 .name = "disable-copy-paste",
445 .type = QEMU_OPT_BOOL,
447 .name = "disable-agent-file-xfer",
448 .type = QEMU_OPT_BOOL,
450 .name = "sasl",
451 .type = QEMU_OPT_BOOL,
453 .name = "x509-dir",
454 .type = QEMU_OPT_STRING,
456 .name = "x509-key-file",
457 .type = QEMU_OPT_STRING,
459 .name = "x509-key-password",
460 .type = QEMU_OPT_STRING,
462 .name = "x509-cert-file",
463 .type = QEMU_OPT_STRING,
465 .name = "x509-cacert-file",
466 .type = QEMU_OPT_STRING,
468 .name = "x509-dh-key-file",
469 .type = QEMU_OPT_STRING,
471 .name = "tls-ciphers",
472 .type = QEMU_OPT_STRING,
474 .name = "tls-channel",
475 .type = QEMU_OPT_STRING,
477 .name = "plaintext-channel",
478 .type = QEMU_OPT_STRING,
480 .name = "image-compression",
481 .type = QEMU_OPT_STRING,
483 .name = "jpeg-wan-compression",
484 .type = QEMU_OPT_STRING,
486 .name = "zlib-glz-wan-compression",
487 .type = QEMU_OPT_STRING,
489 .name = "streaming-video",
490 .type = QEMU_OPT_STRING,
492 .name = "agent-mouse",
493 .type = QEMU_OPT_BOOL,
495 .name = "playback-compression",
496 .type = QEMU_OPT_BOOL,
498 .name = "seamless-migration",
499 .type = QEMU_OPT_BOOL,
501 .name = "display",
502 .type = QEMU_OPT_STRING,
504 .name = "head",
505 .type = QEMU_OPT_NUMBER,
506 #ifdef HAVE_SPICE_GL
508 .name = "gl",
509 .type = QEMU_OPT_BOOL,
511 .name = "rendernode",
512 .type = QEMU_OPT_STRING,
513 #endif
515 { /* end of list */ }
519 static SpiceInfo *qmp_query_spice_real(Error **errp)
521 QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
522 int port, tls_port;
523 const char *addr;
524 SpiceInfo *info;
525 unsigned int major;
526 unsigned int minor;
527 unsigned int micro;
529 info = g_malloc0(sizeof(*info));
531 if (!spice_server || !opts) {
532 info->enabled = false;
533 return info;
536 info->enabled = true;
537 info->migrated = spice_migration_completed;
539 addr = qemu_opt_get(opts, "addr");
540 port = qemu_opt_get_number(opts, "port", 0);
541 tls_port = qemu_opt_get_number(opts, "tls-port", 0);
543 info->auth = g_strdup(auth);
544 info->host = g_strdup(addr ? addr : "*");
546 major = (SPICE_SERVER_VERSION & 0xff0000) >> 16;
547 minor = (SPICE_SERVER_VERSION & 0xff00) >> 8;
548 micro = SPICE_SERVER_VERSION & 0xff;
549 info->compiled_version = g_strdup_printf("%d.%d.%d", major, minor, micro);
551 if (port) {
552 info->has_port = true;
553 info->port = port;
555 if (tls_port) {
556 info->has_tls_port = true;
557 info->tls_port = tls_port;
560 info->mouse_mode = spice_server_is_server_mouse(spice_server) ?
561 SPICE_QUERY_MOUSE_MODE_SERVER :
562 SPICE_QUERY_MOUSE_MODE_CLIENT;
564 /* for compatibility with the original command */
565 info->has_channels = true;
566 info->channels = qmp_query_spice_channels();
568 return info;
571 static void migration_state_notifier(Notifier *notifier, void *data)
573 MigrationState *s = data;
575 if (!spice_have_target_host) {
576 return;
579 if (migration_in_setup(s)) {
580 spice_server_migrate_start(spice_server);
581 } else if (migration_has_finished(s) ||
582 migration_in_postcopy_after_devices(s)) {
583 spice_server_migrate_end(spice_server, true);
584 spice_have_target_host = false;
585 } else if (migration_has_failed(s)) {
586 spice_server_migrate_end(spice_server, false);
587 spice_have_target_host = false;
591 int qemu_spice_migrate_info(const char *hostname, int port, int tls_port,
592 const char *subject)
594 int ret;
596 ret = spice_server_migrate_connect(spice_server, hostname,
597 port, tls_port, subject);
598 spice_have_target_host = true;
599 return ret;
602 static int add_channel(void *opaque, const char *name, const char *value,
603 Error **errp)
605 int security = 0;
606 int rc;
608 if (strcmp(name, "tls-channel") == 0) {
609 int *tls_port = opaque;
610 if (!*tls_port) {
611 error_setg(errp, "spice: tried to setup tls-channel"
612 " without specifying a TLS port");
613 return -1;
615 security = SPICE_CHANNEL_SECURITY_SSL;
617 if (strcmp(name, "plaintext-channel") == 0) {
618 security = SPICE_CHANNEL_SECURITY_NONE;
620 if (security == 0) {
621 return 0;
623 if (strcmp(value, "default") == 0) {
624 rc = spice_server_set_channel_security(spice_server, NULL, security);
625 } else {
626 rc = spice_server_set_channel_security(spice_server, value, security);
628 if (rc != 0) {
629 error_setg(errp, "spice: failed to set channel security for %s",
630 value);
631 return -1;
633 return 0;
636 static void vm_change_state_handler(void *opaque, bool running,
637 RunState state)
639 if (running) {
640 qemu_spice_display_start();
641 } else if (state != RUN_STATE_PAUSED) {
642 qemu_spice_display_stop();
646 void qemu_spice_display_init_done(void)
648 if (runstate_is_running()) {
649 qemu_spice_display_start();
651 qemu_add_vm_change_state_handler(vm_change_state_handler, NULL);
654 static void qemu_spice_init(void)
656 QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
657 char *password = NULL;
658 const char *passwordSecret;
659 const char *str, *x509_dir, *addr,
660 *x509_key_password = NULL,
661 *x509_dh_file = NULL,
662 *tls_ciphers = NULL;
663 char *x509_key_file = NULL,
664 *x509_cert_file = NULL,
665 *x509_cacert_file = NULL;
666 int port, tls_port, addr_flags;
667 spice_image_compression_t compression;
668 spice_wan_compression_t wan_compr;
669 bool seamless_migration;
671 qemu_thread_get_self(&me);
673 if (!opts) {
674 return;
676 port = qemu_opt_get_number(opts, "port", 0);
677 tls_port = qemu_opt_get_number(opts, "tls-port", 0);
678 if (port < 0 || port > 65535) {
679 error_report("spice port is out of range");
680 exit(1);
682 if (tls_port < 0 || tls_port > 65535) {
683 error_report("spice tls-port is out of range");
684 exit(1);
686 passwordSecret = qemu_opt_get(opts, "password-secret");
687 if (passwordSecret) {
688 password = qcrypto_secret_lookup_as_utf8(passwordSecret,
689 &error_fatal);
692 if (tls_port) {
693 x509_dir = qemu_opt_get(opts, "x509-dir");
694 if (!x509_dir) {
695 x509_dir = ".";
698 str = qemu_opt_get(opts, "x509-key-file");
699 if (str) {
700 x509_key_file = g_strdup(str);
701 } else {
702 x509_key_file = g_strdup_printf("%s/%s", x509_dir,
703 X509_SERVER_KEY_FILE);
706 str = qemu_opt_get(opts, "x509-cert-file");
707 if (str) {
708 x509_cert_file = g_strdup(str);
709 } else {
710 x509_cert_file = g_strdup_printf("%s/%s", x509_dir,
711 X509_SERVER_CERT_FILE);
714 str = qemu_opt_get(opts, "x509-cacert-file");
715 if (str) {
716 x509_cacert_file = g_strdup(str);
717 } else {
718 x509_cacert_file = g_strdup_printf("%s/%s", x509_dir,
719 X509_CA_CERT_FILE);
722 x509_key_password = qemu_opt_get(opts, "x509-key-password");
723 x509_dh_file = qemu_opt_get(opts, "x509-dh-key-file");
724 tls_ciphers = qemu_opt_get(opts, "tls-ciphers");
727 addr = qemu_opt_get(opts, "addr");
728 addr_flags = 0;
729 if (qemu_opt_get_bool(opts, "ipv4", 0)) {
730 addr_flags |= SPICE_ADDR_FLAG_IPV4_ONLY;
731 } else if (qemu_opt_get_bool(opts, "ipv6", 0)) {
732 addr_flags |= SPICE_ADDR_FLAG_IPV6_ONLY;
733 #ifdef SPICE_ADDR_FLAG_UNIX_ONLY
734 } else if (qemu_opt_get_bool(opts, "unix", 0)) {
735 addr_flags |= SPICE_ADDR_FLAG_UNIX_ONLY;
736 #endif
739 spice_server = spice_server_new();
740 spice_server_set_addr(spice_server, addr ? addr : "", addr_flags);
741 if (port) {
742 spice_server_set_port(spice_server, port);
744 if (tls_port) {
745 spice_server_set_tls(spice_server, tls_port,
746 x509_cacert_file,
747 x509_cert_file,
748 x509_key_file,
749 x509_key_password,
750 x509_dh_file,
751 tls_ciphers);
753 if (password) {
754 qemu_spice.set_passwd(password, false, false);
756 if (qemu_opt_get_bool(opts, "sasl", 0)) {
757 if (spice_server_set_sasl(spice_server, 1) == -1) {
758 error_report("spice: failed to enable sasl");
759 exit(1);
761 auth = "sasl";
763 if (qemu_opt_get_bool(opts, "disable-ticketing", 0)) {
764 auth = "none";
765 spice_server_set_noauth(spice_server);
768 if (qemu_opt_get_bool(opts, "disable-copy-paste", 0)) {
769 spice_server_set_agent_copypaste(spice_server, false);
772 if (qemu_opt_get_bool(opts, "disable-agent-file-xfer", 0)) {
773 spice_server_set_agent_file_xfer(spice_server, false);
776 compression = SPICE_IMAGE_COMPRESS_AUTO_GLZ;
777 str = qemu_opt_get(opts, "image-compression");
778 if (str) {
779 compression = parse_compression(str);
781 spice_server_set_image_compression(spice_server, compression);
783 wan_compr = SPICE_WAN_COMPRESSION_AUTO;
784 str = qemu_opt_get(opts, "jpeg-wan-compression");
785 if (str) {
786 wan_compr = parse_wan_compression(str);
788 spice_server_set_jpeg_compression(spice_server, wan_compr);
790 wan_compr = SPICE_WAN_COMPRESSION_AUTO;
791 str = qemu_opt_get(opts, "zlib-glz-wan-compression");
792 if (str) {
793 wan_compr = parse_wan_compression(str);
795 spice_server_set_zlib_glz_compression(spice_server, wan_compr);
797 str = qemu_opt_get(opts, "streaming-video");
798 if (str) {
799 int streaming_video = parse_stream_video(str);
800 spice_server_set_streaming_video(spice_server, streaming_video);
801 } else {
802 spice_server_set_streaming_video(spice_server, SPICE_STREAM_VIDEO_OFF);
805 spice_server_set_agent_mouse
806 (spice_server, qemu_opt_get_bool(opts, "agent-mouse", 1));
807 spice_server_set_playback_compression
808 (spice_server, qemu_opt_get_bool(opts, "playback-compression", 1));
810 qemu_opt_foreach(opts, add_channel, &tls_port, &error_fatal);
812 spice_server_set_name(spice_server, qemu_name ?: "QEMU " QEMU_VERSION);
813 spice_server_set_uuid(spice_server, (unsigned char *)&qemu_uuid);
815 seamless_migration = qemu_opt_get_bool(opts, "seamless-migration", 0);
816 spice_server_set_seamless_migration(spice_server, seamless_migration);
817 spice_server_set_sasl_appname(spice_server, "qemu");
818 if (spice_server_init(spice_server, &core_interface) != 0) {
819 error_report("failed to initialize spice server");
820 exit(1);
822 using_spice = 1;
824 migration_add_notifier(&migration_state, migration_state_notifier);
825 spice_migrate.base.sif = &migrate_interface.base;
826 qemu_spice.add_interface(&spice_migrate.base);
828 qemu_spice_input_init();
830 qemu_spice_display_stop();
832 g_free(x509_key_file);
833 g_free(x509_cert_file);
834 g_free(x509_cacert_file);
835 g_free(password);
837 #ifdef HAVE_SPICE_GL
838 if (qemu_opt_get_bool(opts, "gl", 0)) {
839 if ((port != 0) || (tls_port != 0)) {
840 error_report("SPICE GL support is local-only for now and "
841 "incompatible with -spice port/tls-port");
842 exit(1);
844 egl_init(qemu_opt_get(opts, "rendernode"), DISPLAYGL_MODE_ON, &error_fatal);
845 spice_opengl = 1;
847 #endif
850 static int qemu_spice_add_interface(SpiceBaseInstance *sin)
852 if (!spice_server) {
853 if (QTAILQ_FIRST(&qemu_spice_opts.head) != NULL) {
854 error_report("Oops: spice configured but not active");
855 exit(1);
858 * Create a spice server instance.
859 * It does *not* listen on the network.
860 * It handles QXL local rendering only.
862 * With a command line like '-vnc :0 -vga qxl' you'll end up here.
864 spice_server = spice_server_new();
865 spice_server_set_sasl_appname(spice_server, "qemu");
866 spice_server_init(spice_server, &core_interface);
867 qemu_add_vm_change_state_handler(vm_change_state_handler, NULL);
870 return spice_server_add_interface(spice_server, sin);
873 static GSList *spice_consoles;
875 bool qemu_spice_have_display_interface(QemuConsole *con)
877 if (g_slist_find(spice_consoles, con)) {
878 return true;
880 return false;
883 int qemu_spice_add_display_interface(QXLInstance *qxlin, QemuConsole *con)
885 if (g_slist_find(spice_consoles, con)) {
886 return -1;
888 qxlin->id = qemu_console_get_index(con);
889 spice_consoles = g_slist_append(spice_consoles, con);
890 return qemu_spice_add_interface(&qxlin->base);
893 static int qemu_spice_set_ticket(bool fail_if_conn, bool disconnect_if_conn)
895 time_t lifetime, now = time(NULL);
896 char *passwd;
898 if (now < auth_expires) {
899 passwd = auth_passwd;
900 lifetime = (auth_expires - now);
901 if (lifetime > INT_MAX) {
902 lifetime = INT_MAX;
904 } else {
905 passwd = NULL;
906 lifetime = 1;
908 return spice_server_set_ticket(spice_server, passwd, lifetime,
909 fail_if_conn, disconnect_if_conn);
912 static int qemu_spice_set_passwd(const char *passwd,
913 bool fail_if_conn, bool disconnect_if_conn)
915 if (strcmp(auth, "spice") != 0) {
916 return -1;
919 g_free(auth_passwd);
920 auth_passwd = g_strdup(passwd);
921 return qemu_spice_set_ticket(fail_if_conn, disconnect_if_conn);
924 static int qemu_spice_set_pw_expire(time_t expires)
926 auth_expires = expires;
927 return qemu_spice_set_ticket(false, false);
930 static int qemu_spice_display_add_client(int csock, int skipauth, int tls)
932 #ifdef WIN32
933 csock = qemu_close_socket_osfhandle(csock);
934 #endif
935 if (tls) {
936 return spice_server_add_ssl_client(spice_server, csock, skipauth);
937 } else {
938 return spice_server_add_client(spice_server, csock, skipauth);
942 void qemu_spice_display_start(void)
944 if (spice_display_is_running) {
945 return;
948 spice_display_is_running = true;
949 spice_server_vm_start(spice_server);
952 void qemu_spice_display_stop(void)
954 if (!spice_display_is_running) {
955 return;
958 spice_server_vm_stop(spice_server);
959 spice_display_is_running = false;
962 int qemu_spice_display_is_running(SimpleSpiceDisplay *ssd)
964 return spice_display_is_running;
967 static struct QemuSpiceOps real_spice_ops = {
968 .init = qemu_spice_init,
969 .display_init = qemu_spice_display_init,
970 .migrate_info = qemu_spice_migrate_info,
971 .set_passwd = qemu_spice_set_passwd,
972 .set_pw_expire = qemu_spice_set_pw_expire,
973 .display_add_client = qemu_spice_display_add_client,
974 .add_interface = qemu_spice_add_interface,
975 .qmp_query = qmp_query_spice_real,
978 static void spice_register_config(void)
980 qemu_spice = real_spice_ops;
981 qemu_add_opts(&qemu_spice_opts);
983 opts_init(spice_register_config);
984 module_opts("spice");
986 #ifdef HAVE_SPICE_GL
987 module_dep("ui-opengl");
988 #endif