]> git.proxmox.com Git - qemu.git/blob - ui/spice-core.c
notifier: Pass data argument to callback
[qemu.git] / ui / spice-core.c
1 /*
2 * Copyright (C) 2010 Red Hat, Inc.
3 *
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.
8 *
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.
13 *
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/>.
16 */
17
18 #include <spice.h>
19 #include <spice-experimental.h>
20
21 #include <netdb.h>
22
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"
29 #include "qint.h"
30 #include "qbool.h"
31 #include "qstring.h"
32 #include "qjson.h"
33 #include "notify.h"
34 #include "migration.h"
35 #include "monitor.h"
36 #include "hw/hw.h"
37
38 /* core bits */
39
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;
45 int using_spice = 0;
46
47 struct SpiceTimer {
48 QEMUTimer *timer;
49 QTAILQ_ENTRY(SpiceTimer) next;
50 };
51 static QTAILQ_HEAD(, SpiceTimer) timers = QTAILQ_HEAD_INITIALIZER(timers);
52
53 static SpiceTimer *timer_add(SpiceTimerFunc func, void *opaque)
54 {
55 SpiceTimer *timer;
56
57 timer = qemu_mallocz(sizeof(*timer));
58 timer->timer = qemu_new_timer_ms(rt_clock, func, opaque);
59 QTAILQ_INSERT_TAIL(&timers, timer, next);
60 return timer;
61 }
62
63 static void timer_start(SpiceTimer *timer, uint32_t ms)
64 {
65 qemu_mod_timer(timer->timer, qemu_get_clock_ms(rt_clock) + ms);
66 }
67
68 static void timer_cancel(SpiceTimer *timer)
69 {
70 qemu_del_timer(timer->timer);
71 }
72
73 static void timer_remove(SpiceTimer *timer)
74 {
75 qemu_del_timer(timer->timer);
76 qemu_free_timer(timer->timer);
77 QTAILQ_REMOVE(&timers, timer, next);
78 qemu_free(timer);
79 }
80
81 struct SpiceWatch {
82 int fd;
83 int event_mask;
84 SpiceWatchFunc func;
85 void *opaque;
86 QTAILQ_ENTRY(SpiceWatch) next;
87 };
88 static QTAILQ_HEAD(, SpiceWatch) watches = QTAILQ_HEAD_INITIALIZER(watches);
89
90 static void watch_read(void *opaque)
91 {
92 SpiceWatch *watch = opaque;
93 watch->func(watch->fd, SPICE_WATCH_EVENT_READ, watch->opaque);
94 }
95
96 static void watch_write(void *opaque)
97 {
98 SpiceWatch *watch = opaque;
99 watch->func(watch->fd, SPICE_WATCH_EVENT_WRITE, watch->opaque);
100 }
101
102 static void watch_update_mask(SpiceWatch *watch, int event_mask)
103 {
104 IOHandler *on_read = NULL;
105 IOHandler *on_write = NULL;
106
107 watch->event_mask = event_mask;
108 if (watch->event_mask & SPICE_WATCH_EVENT_READ) {
109 on_read = watch_read;
110 }
111 if (watch->event_mask & SPICE_WATCH_EVENT_WRITE) {
112 on_write = watch_write;
113 }
114 qemu_set_fd_handler(watch->fd, on_read, on_write, watch);
115 }
116
117 static SpiceWatch *watch_add(int fd, int event_mask, SpiceWatchFunc func, void *opaque)
118 {
119 SpiceWatch *watch;
120
121 watch = qemu_mallocz(sizeof(*watch));
122 watch->fd = fd;
123 watch->func = func;
124 watch->opaque = opaque;
125 QTAILQ_INSERT_TAIL(&watches, watch, next);
126
127 watch_update_mask(watch, event_mask);
128 return watch;
129 }
130
131 static void watch_remove(SpiceWatch *watch)
132 {
133 watch_update_mask(watch, 0);
134 QTAILQ_REMOVE(&watches, watch, next);
135 qemu_free(watch);
136 }
137
138 #if SPICE_INTERFACE_CORE_MINOR >= 3
139
140 typedef struct ChannelList ChannelList;
141 struct ChannelList {
142 SpiceChannelEventInfo *info;
143 QTAILQ_ENTRY(ChannelList) link;
144 };
145 static QTAILQ_HEAD(, ChannelList) channel_list = QTAILQ_HEAD_INITIALIZER(channel_list);
146
147 static void channel_list_add(SpiceChannelEventInfo *info)
148 {
149 ChannelList *item;
150
151 item = qemu_mallocz(sizeof(*item));
152 item->info = info;
153 QTAILQ_INSERT_TAIL(&channel_list, item, link);
154 }
155
156 static void channel_list_del(SpiceChannelEventInfo *info)
157 {
158 ChannelList *item;
159
160 QTAILQ_FOREACH(item, &channel_list, link) {
161 if (item->info != info) {
162 continue;
163 }
164 QTAILQ_REMOVE(&channel_list, item, link);
165 qemu_free(item);
166 return;
167 }
168 }
169
170 static void add_addr_info(QDict *dict, struct sockaddr *addr, int len)
171 {
172 char host[NI_MAXHOST], port[NI_MAXSERV];
173 const char *family;
174
175 getnameinfo(addr, len, host, sizeof(host), port, sizeof(port),
176 NI_NUMERICHOST | NI_NUMERICSERV);
177 family = inet_strfamily(addr->sa_family);
178
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));
182 }
183
184 static void add_channel_info(QDict *dict, SpiceChannelEventInfo *info)
185 {
186 int tls = info->flags & SPICE_CHANNEL_EVENT_FLAG_TLS;
187
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));
192 }
193
194 static QList *channel_list_get(void)
195 {
196 ChannelList *item;
197 QList *list;
198 QDict *dict;
199
200 list = qlist_new();
201 QTAILQ_FOREACH(item, &channel_list, link) {
202 dict = qdict_new();
203 add_addr_info(dict, &item->info->paddr, item->info->plen);
204 add_channel_info(dict, item->info);
205 qlist_append(list, dict);
206 }
207 return list;
208 }
209
210 static void channel_event(int event, SpiceChannelEventInfo *info)
211 {
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,
216 };
217 QDict *server, *client;
218 QObject *data;
219
220 client = qdict_new();
221 add_addr_info(client, &info->paddr, info->plen);
222
223 server = qdict_new();
224 add_addr_info(server, &info->laddr, info->llen);
225
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);
230 }
231 if (event == SPICE_CHANNEL_EVENT_DISCONNECTED) {
232 channel_list_del(info);
233 }
234
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);
239 }
240
241 #else /* SPICE_INTERFACE_CORE_MINOR >= 3 */
242
243 static QList *channel_list_get(void)
244 {
245 return NULL;
246 }
247
248 #endif /* SPICE_INTERFACE_CORE_MINOR >= 3 */
249
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,
255
256 .timer_add = timer_add,
257 .timer_start = timer_start,
258 .timer_cancel = timer_cancel,
259 .timer_remove = timer_remove,
260
261 .watch_add = watch_add,
262 .watch_update_mask = watch_update_mask,
263 .watch_remove = watch_remove,
264
265 #if SPICE_INTERFACE_CORE_MINOR >= 3
266 .channel_event = channel_event,
267 #endif
268 };
269
270 /* config string parsing */
271
272 static int name2enum(const char *string, const char *table[], int entries)
273 {
274 int i;
275
276 if (string) {
277 for (i = 0; i < entries; i++) {
278 if (!table[i]) {
279 continue;
280 }
281 if (strcmp(string, table[i]) != 0) {
282 continue;
283 }
284 return i;
285 }
286 }
287 return -1;
288 }
289
290 static int parse_name(const char *string, const char *optname,
291 const char *table[], int entries)
292 {
293 int value = name2enum(string, table, entries);
294
295 if (value != -1) {
296 return value;
297 }
298 fprintf(stderr, "spice: invalid %s: %s\n", optname, string);
299 exit(1);
300 }
301
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",
306 };
307 #define parse_stream_video(_name) \
308 name2enum(_name, stream_video_names, ARRAY_SIZE(stream_video_names))
309
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",
317 };
318 #define parse_compression(_name) \
319 parse_name(_name, "image compression", \
320 compression_names, ARRAY_SIZE(compression_names))
321
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",
326 };
327 #define parse_wan_compression(_name) \
328 parse_name(_name, "wan compression", \
329 wan_compression_names, ARRAY_SIZE(wan_compression_names))
330
331 /* functions for the rest of qemu */
332
333 static void info_spice_iter(QObject *obj, void *opaque)
334 {
335 QDict *client;
336 Monitor *mon = opaque;
337
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"));
349 }
350
351 void do_info_spice_print(Monitor *mon, const QObject *data)
352 {
353 QDict *server;
354 QList *channels;
355 const char *host;
356 int port;
357
358 server = qobject_to_qdict(data);
359 if (qdict_get_bool(server, "enabled") == 0) {
360 monitor_printf(mon, "Server: disabled\n");
361 return;
362 }
363
364 monitor_printf(mon, "Server:\n");
365 host = qdict_get_str(server, "host");
366 port = qdict_get_try_int(server, "port", -1);
367 if (port != -1) {
368 monitor_printf(mon, " address: %s:%d\n", host, port);
369 }
370 port = qdict_get_try_int(server, "tls-port", -1);
371 if (port != -1) {
372 monitor_printf(mon, " address: %s:%d [tls]\n", host, port);
373 }
374 monitor_printf(mon, " auth: %s\n", qdict_get_str(server, "auth"));
375
376 channels = qdict_get_qlist(server, "channels");
377 if (qlist_empty(channels)) {
378 monitor_printf(mon, "Channels: none\n");
379 } else {
380 qlist_iter(channels, info_spice_iter, mon);
381 }
382 }
383
384 void do_info_spice(Monitor *mon, QObject **ret_data)
385 {
386 QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
387 QDict *server;
388 QList *clist;
389 const char *addr;
390 int port, tls_port;
391
392 if (!spice_server) {
393 *ret_data = qobject_from_jsonf("{ 'enabled': false }");
394 return;
395 }
396
397 addr = qemu_opt_get(opts, "addr");
398 port = qemu_opt_get_number(opts, "port", 0);
399 tls_port = qemu_opt_get_number(opts, "tls-port", 0);
400 clist = channel_list_get();
401
402 server = qdict_new();
403 qdict_put(server, "enabled", qbool_from_int(true));
404 qdict_put(server, "auth", qstring_from_str(auth));
405 qdict_put(server, "host", qstring_from_str(addr ? addr : "0.0.0.0"));
406 if (port) {
407 qdict_put(server, "port", qint_from_int(port));
408 }
409 if (tls_port) {
410 qdict_put(server, "tls-port", qint_from_int(tls_port));
411 }
412 if (clist) {
413 qdict_put(server, "channels", clist);
414 }
415
416 *ret_data = QOBJECT(server);
417 }
418
419 static void migration_state_notifier(Notifier *notifier, void *data)
420 {
421 int state = get_migration_state();
422
423 if (state == MIG_STATE_COMPLETED) {
424 #if SPICE_SERVER_VERSION >= 0x000701 /* 0.7.1 */
425 spice_server_migrate_switch(spice_server);
426 #endif
427 }
428 }
429
430 int qemu_spice_migrate_info(const char *hostname, int port, int tls_port,
431 const char *subject)
432 {
433 return spice_server_migrate_info(spice_server, hostname,
434 port, tls_port, subject);
435 }
436
437 static int add_channel(const char *name, const char *value, void *opaque)
438 {
439 int security = 0;
440 int rc;
441
442 if (strcmp(name, "tls-channel") == 0) {
443 security = SPICE_CHANNEL_SECURITY_SSL;
444 }
445 if (strcmp(name, "plaintext-channel") == 0) {
446 security = SPICE_CHANNEL_SECURITY_NONE;
447 }
448 if (security == 0) {
449 return 0;
450 }
451 if (strcmp(value, "default") == 0) {
452 rc = spice_server_set_channel_security(spice_server, NULL, security);
453 } else {
454 rc = spice_server_set_channel_security(spice_server, value, security);
455 }
456 if (rc != 0) {
457 fprintf(stderr, "spice: failed to set channel security for %s\n", value);
458 exit(1);
459 }
460 return 0;
461 }
462
463 void qemu_spice_init(void)
464 {
465 QemuOpts *opts = QTAILQ_FIRST(&qemu_spice_opts.head);
466 const char *password, *str, *x509_dir, *addr,
467 *x509_key_password = NULL,
468 *x509_dh_file = NULL,
469 *tls_ciphers = NULL;
470 char *x509_key_file = NULL,
471 *x509_cert_file = NULL,
472 *x509_cacert_file = NULL;
473 int port, tls_port, len, addr_flags;
474 spice_image_compression_t compression;
475 spice_wan_compression_t wan_compr;
476
477 if (!opts) {
478 return;
479 }
480 port = qemu_opt_get_number(opts, "port", 0);
481 tls_port = qemu_opt_get_number(opts, "tls-port", 0);
482 if (!port && !tls_port) {
483 fprintf(stderr, "neither port nor tls-port specified for spice.");
484 exit(1);
485 }
486 if (port < 0 || port > 65535) {
487 fprintf(stderr, "spice port is out of range");
488 exit(1);
489 }
490 if (tls_port < 0 || tls_port > 65535) {
491 fprintf(stderr, "spice tls-port is out of range");
492 exit(1);
493 }
494 password = qemu_opt_get(opts, "password");
495
496 if (tls_port) {
497 x509_dir = qemu_opt_get(opts, "x509-dir");
498 if (NULL == x509_dir) {
499 x509_dir = ".";
500 }
501 len = strlen(x509_dir) + 32;
502
503 str = qemu_opt_get(opts, "x509-key-file");
504 if (str) {
505 x509_key_file = qemu_strdup(str);
506 } else {
507 x509_key_file = qemu_malloc(len);
508 snprintf(x509_key_file, len, "%s/%s", x509_dir, X509_SERVER_KEY_FILE);
509 }
510
511 str = qemu_opt_get(opts, "x509-cert-file");
512 if (str) {
513 x509_cert_file = qemu_strdup(str);
514 } else {
515 x509_cert_file = qemu_malloc(len);
516 snprintf(x509_cert_file, len, "%s/%s", x509_dir, X509_SERVER_CERT_FILE);
517 }
518
519 str = qemu_opt_get(opts, "x509-cacert-file");
520 if (str) {
521 x509_cacert_file = qemu_strdup(str);
522 } else {
523 x509_cacert_file = qemu_malloc(len);
524 snprintf(x509_cacert_file, len, "%s/%s", x509_dir, X509_CA_CERT_FILE);
525 }
526
527 x509_key_password = qemu_opt_get(opts, "x509-key-password");
528 x509_dh_file = qemu_opt_get(opts, "x509-dh-file");
529 tls_ciphers = qemu_opt_get(opts, "tls-ciphers");
530 }
531
532 addr = qemu_opt_get(opts, "addr");
533 addr_flags = 0;
534 if (qemu_opt_get_bool(opts, "ipv4", 0)) {
535 addr_flags |= SPICE_ADDR_FLAG_IPV4_ONLY;
536 } else if (qemu_opt_get_bool(opts, "ipv6", 0)) {
537 addr_flags |= SPICE_ADDR_FLAG_IPV6_ONLY;
538 }
539
540 spice_server = spice_server_new();
541 spice_server_set_addr(spice_server, addr ? addr : "", addr_flags);
542 if (port) {
543 spice_server_set_port(spice_server, port);
544 }
545 if (tls_port) {
546 spice_server_set_tls(spice_server, tls_port,
547 x509_cacert_file,
548 x509_cert_file,
549 x509_key_file,
550 x509_key_password,
551 x509_dh_file,
552 tls_ciphers);
553 }
554 if (password) {
555 spice_server_set_ticket(spice_server, password, 0, 0, 0);
556 }
557 if (qemu_opt_get_bool(opts, "sasl", 0)) {
558 #if SPICE_SERVER_VERSION >= 0x000900 /* 0.9.0 */
559 if (spice_server_set_sasl_appname(spice_server, "qemu") == -1 ||
560 spice_server_set_sasl(spice_server, 1) == -1) {
561 fprintf(stderr, "spice: failed to enable sasl\n");
562 exit(1);
563 }
564 #else
565 fprintf(stderr, "spice: sasl is not available (spice >= 0.9 required)\n");
566 exit(1);
567 #endif
568 }
569 if (qemu_opt_get_bool(opts, "disable-ticketing", 0)) {
570 auth = "none";
571 spice_server_set_noauth(spice_server);
572 }
573
574 #if SPICE_SERVER_VERSION >= 0x000801
575 if (qemu_opt_get_bool(opts, "disable-copy-paste", 0)) {
576 spice_server_set_agent_copypaste(spice_server, false);
577 }
578 #endif
579
580 compression = SPICE_IMAGE_COMPRESS_AUTO_GLZ;
581 str = qemu_opt_get(opts, "image-compression");
582 if (str) {
583 compression = parse_compression(str);
584 }
585 spice_server_set_image_compression(spice_server, compression);
586
587 wan_compr = SPICE_WAN_COMPRESSION_AUTO;
588 str = qemu_opt_get(opts, "jpeg-wan-compression");
589 if (str) {
590 wan_compr = parse_wan_compression(str);
591 }
592 spice_server_set_jpeg_compression(spice_server, wan_compr);
593
594 wan_compr = SPICE_WAN_COMPRESSION_AUTO;
595 str = qemu_opt_get(opts, "zlib-glz-wan-compression");
596 if (str) {
597 wan_compr = parse_wan_compression(str);
598 }
599 spice_server_set_zlib_glz_compression(spice_server, wan_compr);
600
601 str = qemu_opt_get(opts, "streaming-video");
602 if (str) {
603 int streaming_video = parse_stream_video(str);
604 spice_server_set_streaming_video(spice_server, streaming_video);
605 }
606
607 spice_server_set_agent_mouse
608 (spice_server, qemu_opt_get_bool(opts, "agent-mouse", 1));
609 spice_server_set_playback_compression
610 (spice_server, qemu_opt_get_bool(opts, "playback-compression", 1));
611
612 qemu_opt_foreach(opts, add_channel, NULL, 0);
613
614 if (0 != spice_server_init(spice_server, &core_interface)) {
615 fprintf(stderr, "failed to initialize spice server");
616 exit(1);
617 };
618 using_spice = 1;
619
620 migration_state.notify = migration_state_notifier;
621 add_migration_state_change_notifier(&migration_state);
622
623 qemu_spice_input_init();
624 qemu_spice_audio_init();
625
626 qemu_free(x509_key_file);
627 qemu_free(x509_cert_file);
628 qemu_free(x509_cacert_file);
629 }
630
631 int qemu_spice_add_interface(SpiceBaseInstance *sin)
632 {
633 if (!spice_server) {
634 if (QTAILQ_FIRST(&qemu_spice_opts.head) != NULL) {
635 fprintf(stderr, "Oops: spice configured but not active\n");
636 exit(1);
637 }
638 /*
639 * Create a spice server instance.
640 * It does *not* listen on the network.
641 * It handles QXL local rendering only.
642 *
643 * With a command line like '-vnc :0 -vga qxl' you'll end up here.
644 */
645 spice_server = spice_server_new();
646 spice_server_init(spice_server, &core_interface);
647 }
648 return spice_server_add_interface(spice_server, sin);
649 }
650
651 static int qemu_spice_set_ticket(bool fail_if_conn, bool disconnect_if_conn)
652 {
653 time_t lifetime, now = time(NULL);
654 char *passwd;
655
656 if (now < auth_expires) {
657 passwd = auth_passwd;
658 lifetime = (auth_expires - now);
659 if (lifetime > INT_MAX) {
660 lifetime = INT_MAX;
661 }
662 } else {
663 passwd = NULL;
664 lifetime = 1;
665 }
666 return spice_server_set_ticket(spice_server, passwd, lifetime,
667 fail_if_conn, disconnect_if_conn);
668 }
669
670 int qemu_spice_set_passwd(const char *passwd,
671 bool fail_if_conn, bool disconnect_if_conn)
672 {
673 free(auth_passwd);
674 auth_passwd = strdup(passwd);
675 return qemu_spice_set_ticket(fail_if_conn, disconnect_if_conn);
676 }
677
678 int qemu_spice_set_pw_expire(time_t expires)
679 {
680 auth_expires = expires;
681 return qemu_spice_set_ticket(false, false);
682 }
683
684 static void spice_register_config(void)
685 {
686 qemu_add_opts(&qemu_spice_opts);
687 }
688 machine_init(spice_register_config);
689
690 static void spice_initialize(void)
691 {
692 qemu_spice_init();
693 }
694 device_init(spice_initialize);