1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25#include "qemu/osdep.h"
26#include "chardev/char.h"
27#include "io/channel-socket.h"
28#include "io/channel-tls.h"
29#include "io/channel-websock.h"
30#include "io/net-listener.h"
31#include "qemu/error-report.h"
32#include "qemu/module.h"
33#include "qemu/option.h"
34#include "qapi/error.h"
35#include "qapi/clone-visitor.h"
36#include "qapi/qapi-visit-sockets.h"
37
38#include "chardev/char-io.h"
39
40
41
42
43#define TCP_MAX_FDS 16
44
45typedef struct {
46 char buf[21];
47 size_t buflen;
48} TCPChardevTelnetInit;
49
50typedef enum {
51 TCP_CHARDEV_STATE_DISCONNECTED,
52 TCP_CHARDEV_STATE_CONNECTING,
53 TCP_CHARDEV_STATE_CONNECTED,
54} TCPChardevState;
55
56typedef struct {
57 Chardev parent;
58 QIOChannel *ioc;
59 QIOChannelSocket *sioc;
60 QIONetListener *listener;
61 GSource *hup_source;
62 QCryptoTLSCreds *tls_creds;
63 char *tls_authz;
64 TCPChardevState state;
65 int max_size;
66 int do_telnetopt;
67 int do_nodelay;
68 int *read_msgfds;
69 size_t read_msgfds_num;
70 int *write_msgfds;
71 size_t write_msgfds_num;
72
73 SocketAddress *addr;
74 bool is_listen;
75 bool is_telnet;
76 bool is_tn3270;
77 GSource *telnet_source;
78 TCPChardevTelnetInit *telnet_init;
79
80 bool is_websock;
81
82 GSource *reconnect_timer;
83 int64_t reconnect_time;
84 bool connect_err_reported;
85
86 QIOTask *connect_task;
87} SocketChardev;
88
89#define SOCKET_CHARDEV(obj) \
90 OBJECT_CHECK(SocketChardev, (obj), TYPE_CHARDEV_SOCKET)
91
92static gboolean socket_reconnect_timeout(gpointer opaque);
93static void tcp_chr_telnet_init(Chardev *chr);
94
95static void tcp_chr_change_state(SocketChardev *s, TCPChardevState state)
96{
97 switch (state) {
98 case TCP_CHARDEV_STATE_DISCONNECTED:
99 break;
100 case TCP_CHARDEV_STATE_CONNECTING:
101 assert(s->state == TCP_CHARDEV_STATE_DISCONNECTED);
102 break;
103 case TCP_CHARDEV_STATE_CONNECTED:
104 assert(s->state == TCP_CHARDEV_STATE_CONNECTING);
105 break;
106 }
107 s->state = state;
108}
109
110static void tcp_chr_reconn_timer_cancel(SocketChardev *s)
111{
112 if (s->reconnect_timer) {
113 g_source_destroy(s->reconnect_timer);
114 g_source_unref(s->reconnect_timer);
115 s->reconnect_timer = NULL;
116 }
117}
118
119static void qemu_chr_socket_restart_timer(Chardev *chr)
120{
121 SocketChardev *s = SOCKET_CHARDEV(chr);
122 char *name;
123
124 assert(s->state == TCP_CHARDEV_STATE_DISCONNECTED);
125 assert(!s->reconnect_timer);
126 name = g_strdup_printf("chardev-socket-reconnect-%s", chr->label);
127 s->reconnect_timer = qemu_chr_timeout_add_ms(chr,
128 s->reconnect_time * 1000,
129 socket_reconnect_timeout,
130 chr);
131 g_source_set_name(s->reconnect_timer, name);
132 g_free(name);
133}
134
135static void check_report_connect_error(Chardev *chr,
136 Error *err)
137{
138 SocketChardev *s = SOCKET_CHARDEV(chr);
139
140 if (!s->connect_err_reported) {
141 error_reportf_err(err,
142 "Unable to connect character device %s: ",
143 chr->label);
144 s->connect_err_reported = true;
145 } else {
146 error_free(err);
147 }
148 qemu_chr_socket_restart_timer(chr);
149}
150
151static void tcp_chr_accept(QIONetListener *listener,
152 QIOChannelSocket *cioc,
153 void *opaque);
154
155static int tcp_chr_read_poll(void *opaque);
156static void tcp_chr_disconnect_locked(Chardev *chr);
157
158
159static int tcp_chr_write(Chardev *chr, const uint8_t *buf, int len)
160{
161 SocketChardev *s = SOCKET_CHARDEV(chr);
162
163 if (s->state == TCP_CHARDEV_STATE_CONNECTED) {
164 int ret = io_channel_send_full(s->ioc, buf, len,
165 s->write_msgfds,
166 s->write_msgfds_num);
167
168
169
170
171 if (!(ret < 0 && EAGAIN == errno)
172 && s->write_msgfds_num) {
173 g_free(s->write_msgfds);
174 s->write_msgfds = 0;
175 s->write_msgfds_num = 0;
176 }
177
178 if (ret < 0 && errno != EAGAIN) {
179 if (tcp_chr_read_poll(chr) <= 0) {
180 tcp_chr_disconnect_locked(chr);
181 return len;
182 }
183 }
184
185 return ret;
186 } else {
187
188 return len;
189 }
190}
191
192static int tcp_chr_read_poll(void *opaque)
193{
194 Chardev *chr = CHARDEV(opaque);
195 SocketChardev *s = SOCKET_CHARDEV(opaque);
196 if (s->state != TCP_CHARDEV_STATE_CONNECTED) {
197 return 0;
198 }
199 s->max_size = qemu_chr_be_can_write(chr);
200 return s->max_size;
201}
202
203static void tcp_chr_process_IAC_bytes(Chardev *chr,
204 SocketChardev *s,
205 uint8_t *buf, int *size)
206{
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224 int i;
225 int j = 0;
226
227 for (i = 0; i < *size; i++) {
228 if (s->do_telnetopt > 1) {
229 if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
230
231 if (j != i) {
232 buf[j] = buf[i];
233 }
234 j++;
235 s->do_telnetopt = 1;
236 } else {
237 if ((unsigned char)buf[i] == IAC_BREAK
238 && s->do_telnetopt == 2) {
239
240 qemu_chr_be_event(chr, CHR_EVENT_BREAK);
241 s->do_telnetopt++;
242 } else if (s->is_tn3270 && ((unsigned char)buf[i] == IAC_EOR
243 || (unsigned char)buf[i] == IAC_SB
244 || (unsigned char)buf[i] == IAC_SE)
245 && s->do_telnetopt == 2) {
246 buf[j++] = IAC;
247 buf[j++] = buf[i];
248 s->do_telnetopt++;
249 } else if (s->is_tn3270 && ((unsigned char)buf[i] == IAC_IP
250 || (unsigned char)buf[i] == IAC_NOP)
251 && s->do_telnetopt == 2) {
252
253 s->do_telnetopt++;
254 }
255 s->do_telnetopt++;
256 }
257 if (s->do_telnetopt >= 4) {
258 s->do_telnetopt = 1;
259 }
260 } else {
261 if ((unsigned char)buf[i] == IAC) {
262 s->do_telnetopt = 2;
263 } else {
264 if (j != i) {
265 buf[j] = buf[i];
266 }
267 j++;
268 }
269 }
270 }
271 *size = j;
272}
273
274static int tcp_get_msgfds(Chardev *chr, int *fds, int num)
275{
276 SocketChardev *s = SOCKET_CHARDEV(chr);
277
278 int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
279
280 assert(num <= TCP_MAX_FDS);
281
282 if (to_copy) {
283 int i;
284
285 memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
286
287
288 for (i = to_copy; i < s->read_msgfds_num; i++) {
289 close(s->read_msgfds[i]);
290 }
291
292 g_free(s->read_msgfds);
293 s->read_msgfds = 0;
294 s->read_msgfds_num = 0;
295 }
296
297 return to_copy;
298}
299
300static int tcp_set_msgfds(Chardev *chr, int *fds, int num)
301{
302 SocketChardev *s = SOCKET_CHARDEV(chr);
303
304
305 g_free(s->write_msgfds);
306 s->write_msgfds = NULL;
307 s->write_msgfds_num = 0;
308
309 if ((s->state != TCP_CHARDEV_STATE_CONNECTED) ||
310 !qio_channel_has_feature(s->ioc,
311 QIO_CHANNEL_FEATURE_FD_PASS)) {
312 return -1;
313 }
314
315 if (num) {
316 s->write_msgfds = g_new(int, num);
317 memcpy(s->write_msgfds, fds, num * sizeof(int));
318 }
319
320 s->write_msgfds_num = num;
321
322 return 0;
323}
324
325static ssize_t tcp_chr_recv(Chardev *chr, char *buf, size_t len)
326{
327 SocketChardev *s = SOCKET_CHARDEV(chr);
328 struct iovec iov = { .iov_base = buf, .iov_len = len };
329 int ret;
330 size_t i;
331 int *msgfds = NULL;
332 size_t msgfds_num = 0;
333
334 if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
335 ret = qio_channel_readv_full(s->ioc, &iov, 1,
336 &msgfds, &msgfds_num,
337 NULL);
338 } else {
339 ret = qio_channel_readv_full(s->ioc, &iov, 1,
340 NULL, NULL,
341 NULL);
342 }
343
344 if (ret == QIO_CHANNEL_ERR_BLOCK) {
345 errno = EAGAIN;
346 ret = -1;
347 } else if (ret == -1) {
348 errno = EIO;
349 }
350
351 if (msgfds_num) {
352
353 for (i = 0; i < s->read_msgfds_num; i++) {
354 close(s->read_msgfds[i]);
355 }
356
357 if (s->read_msgfds_num) {
358 g_free(s->read_msgfds);
359 }
360
361 s->read_msgfds = msgfds;
362 s->read_msgfds_num = msgfds_num;
363 }
364
365 for (i = 0; i < s->read_msgfds_num; i++) {
366 int fd = s->read_msgfds[i];
367 if (fd < 0) {
368 continue;
369 }
370
371
372 qemu_set_block(fd);
373
374#ifndef MSG_CMSG_CLOEXEC
375 qemu_set_cloexec(fd);
376#endif
377 }
378
379 return ret;
380}
381
382static GSource *tcp_chr_add_watch(Chardev *chr, GIOCondition cond)
383{
384 SocketChardev *s = SOCKET_CHARDEV(chr);
385 return qio_channel_create_watch(s->ioc, cond);
386}
387
388static void remove_hup_source(SocketChardev *s)
389{
390 if (s->hup_source != NULL) {
391 g_source_destroy(s->hup_source);
392 g_source_unref(s->hup_source);
393 s->hup_source = NULL;
394 }
395}
396
397static void tcp_chr_free_connection(Chardev *chr)
398{
399 SocketChardev *s = SOCKET_CHARDEV(chr);
400 int i;
401
402 if (s->read_msgfds_num) {
403 for (i = 0; i < s->read_msgfds_num; i++) {
404 close(s->read_msgfds[i]);
405 }
406 g_free(s->read_msgfds);
407 s->read_msgfds = NULL;
408 s->read_msgfds_num = 0;
409 }
410
411 remove_hup_source(s);
412
413 tcp_set_msgfds(chr, NULL, 0);
414 remove_fd_in_watch(chr);
415 object_unref(OBJECT(s->sioc));
416 s->sioc = NULL;
417 object_unref(OBJECT(s->ioc));
418 s->ioc = NULL;
419 g_free(chr->filename);
420 chr->filename = NULL;
421 tcp_chr_change_state(s, TCP_CHARDEV_STATE_DISCONNECTED);
422}
423
424static const char *qemu_chr_socket_protocol(SocketChardev *s)
425{
426 if (s->is_telnet) {
427 return "telnet";
428 }
429 return s->is_websock ? "websocket" : "tcp";
430}
431
432static char *qemu_chr_socket_address(SocketChardev *s, const char *prefix)
433{
434 switch (s->addr->type) {
435 case SOCKET_ADDRESS_TYPE_INET:
436 return g_strdup_printf("%s%s:%s:%s%s", prefix,
437 qemu_chr_socket_protocol(s),
438 s->addr->u.inet.host,
439 s->addr->u.inet.port,
440 s->is_listen ? ",server" : "");
441 break;
442 case SOCKET_ADDRESS_TYPE_UNIX:
443 return g_strdup_printf("%sunix:%s%s", prefix,
444 s->addr->u.q_unix.path,
445 s->is_listen ? ",server" : "");
446 break;
447 case SOCKET_ADDRESS_TYPE_FD:
448 return g_strdup_printf("%sfd:%s%s", prefix, s->addr->u.fd.str,
449 s->is_listen ? ",server" : "");
450 break;
451 case SOCKET_ADDRESS_TYPE_VSOCK:
452 return g_strdup_printf("%svsock:%s:%s", prefix,
453 s->addr->u.vsock.cid,
454 s->addr->u.vsock.port);
455 default:
456 abort();
457 }
458}
459
460static void update_disconnected_filename(SocketChardev *s)
461{
462 Chardev *chr = CHARDEV(s);
463
464 g_free(chr->filename);
465 if (s->addr) {
466 chr->filename = qemu_chr_socket_address(s, "disconnected:");
467 } else {
468 chr->filename = g_strdup("disconnected:socket");
469 }
470}
471
472
473
474
475
476
477static void tcp_chr_disconnect_locked(Chardev *chr)
478{
479 SocketChardev *s = SOCKET_CHARDEV(chr);
480 bool emit_close = s->state == TCP_CHARDEV_STATE_CONNECTED;
481
482 tcp_chr_free_connection(chr);
483
484 if (s->listener) {
485 qio_net_listener_set_client_func_full(s->listener, tcp_chr_accept,
486 chr, NULL, chr->gcontext);
487 }
488 update_disconnected_filename(s);
489 if (emit_close) {
490 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
491 }
492 if (s->reconnect_time) {
493 qemu_chr_socket_restart_timer(chr);
494 }
495}
496
497static void tcp_chr_disconnect(Chardev *chr)
498{
499 qemu_mutex_lock(&chr->chr_write_lock);
500 tcp_chr_disconnect_locked(chr);
501 qemu_mutex_unlock(&chr->chr_write_lock);
502}
503
504static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
505{
506 Chardev *chr = CHARDEV(opaque);
507 SocketChardev *s = SOCKET_CHARDEV(opaque);
508 uint8_t buf[CHR_READ_BUF_LEN];
509 int len, size;
510
511 if ((s->state != TCP_CHARDEV_STATE_CONNECTED) ||
512 s->max_size <= 0) {
513 return TRUE;
514 }
515 len = sizeof(buf);
516 if (len > s->max_size) {
517 len = s->max_size;
518 }
519 size = tcp_chr_recv(chr, (void *)buf, len);
520 if (size == 0 || (size == -1 && errno != EAGAIN)) {
521
522 tcp_chr_disconnect(chr);
523 } else if (size > 0) {
524 if (s->do_telnetopt) {
525 tcp_chr_process_IAC_bytes(chr, s, buf, &size);
526 }
527 if (size > 0) {
528 qemu_chr_be_write(chr, buf, size);
529 }
530 }
531
532 return TRUE;
533}
534
535static gboolean tcp_chr_hup(QIOChannel *channel,
536 GIOCondition cond,
537 void *opaque)
538{
539 Chardev *chr = CHARDEV(opaque);
540 tcp_chr_disconnect(chr);
541 return G_SOURCE_REMOVE;
542}
543
544static int tcp_chr_sync_read(Chardev *chr, const uint8_t *buf, int len)
545{
546 SocketChardev *s = SOCKET_CHARDEV(chr);
547 int size;
548
549 if (s->state != TCP_CHARDEV_STATE_CONNECTED) {
550 return 0;
551 }
552
553 qio_channel_set_blocking(s->ioc, true, NULL);
554 size = tcp_chr_recv(chr, (void *) buf, len);
555 qio_channel_set_blocking(s->ioc, false, NULL);
556 if (size == 0) {
557
558 tcp_chr_disconnect(chr);
559 }
560
561 return size;
562}
563
564static char *qemu_chr_compute_filename(SocketChardev *s)
565{
566 struct sockaddr_storage *ss = &s->sioc->localAddr;
567 struct sockaddr_storage *ps = &s->sioc->remoteAddr;
568 socklen_t ss_len = s->sioc->localAddrLen;
569 socklen_t ps_len = s->sioc->remoteAddrLen;
570 char shost[NI_MAXHOST], sserv[NI_MAXSERV];
571 char phost[NI_MAXHOST], pserv[NI_MAXSERV];
572 const char *left = "", *right = "";
573
574 switch (ss->ss_family) {
575#ifndef _WIN32
576 case AF_UNIX:
577 return g_strdup_printf("unix:%s%s",
578 ((struct sockaddr_un *)(ss))->sun_path,
579 s->is_listen ? ",server" : "");
580#endif
581 case AF_INET6:
582 left = "[";
583 right = "]";
584
585 case AF_INET:
586 getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
587 sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
588 getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
589 pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
590 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
591 qemu_chr_socket_protocol(s),
592 left, shost, right, sserv,
593 s->is_listen ? ",server" : "",
594 left, phost, right, pserv);
595
596 default:
597 return g_strdup_printf("unknown");
598 }
599}
600
601static void update_ioc_handlers(SocketChardev *s)
602{
603 Chardev *chr = CHARDEV(s);
604
605 if (s->state != TCP_CHARDEV_STATE_CONNECTED) {
606 return;
607 }
608
609 remove_fd_in_watch(chr);
610 chr->gsource = io_add_watch_poll(chr, s->ioc,
611 tcp_chr_read_poll,
612 tcp_chr_read, chr,
613 chr->gcontext);
614
615 remove_hup_source(s);
616 s->hup_source = qio_channel_create_watch(s->ioc, G_IO_HUP);
617 g_source_set_callback(s->hup_source, (GSourceFunc)tcp_chr_hup,
618 chr, NULL);
619 g_source_attach(s->hup_source, chr->gcontext);
620}
621
622static void tcp_chr_connect(void *opaque)
623{
624 Chardev *chr = CHARDEV(opaque);
625 SocketChardev *s = SOCKET_CHARDEV(opaque);
626
627 g_free(chr->filename);
628 chr->filename = qemu_chr_compute_filename(s);
629
630 tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTED);
631 update_ioc_handlers(s);
632 qemu_chr_be_event(chr, CHR_EVENT_OPENED);
633}
634
635static void tcp_chr_telnet_destroy(SocketChardev *s)
636{
637 if (s->telnet_source) {
638 g_source_destroy(s->telnet_source);
639 g_source_unref(s->telnet_source);
640 s->telnet_source = NULL;
641 }
642}
643
644static void tcp_chr_update_read_handler(Chardev *chr)
645{
646 SocketChardev *s = SOCKET_CHARDEV(chr);
647
648 if (s->listener && s->state == TCP_CHARDEV_STATE_DISCONNECTED) {
649
650
651
652
653
654 qio_net_listener_set_client_func_full(s->listener, tcp_chr_accept,
655 chr, NULL, chr->gcontext);
656 }
657
658 if (s->telnet_source) {
659 tcp_chr_telnet_init(CHARDEV(s));
660 }
661
662 update_ioc_handlers(s);
663}
664
665static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
666 GIOCondition cond G_GNUC_UNUSED,
667 gpointer user_data)
668{
669 SocketChardev *s = user_data;
670 Chardev *chr = CHARDEV(s);
671 TCPChardevTelnetInit *init = s->telnet_init;
672 ssize_t ret;
673
674 assert(init);
675
676 ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
677 if (ret < 0) {
678 if (ret == QIO_CHANNEL_ERR_BLOCK) {
679 ret = 0;
680 } else {
681 tcp_chr_disconnect(chr);
682 goto end;
683 }
684 }
685 init->buflen -= ret;
686
687 if (init->buflen == 0) {
688 tcp_chr_connect(chr);
689 goto end;
690 }
691
692 memmove(init->buf, init->buf + ret, init->buflen);
693
694 return G_SOURCE_CONTINUE;
695
696end:
697 g_free(s->telnet_init);
698 s->telnet_init = NULL;
699 g_source_unref(s->telnet_source);
700 s->telnet_source = NULL;
701 return G_SOURCE_REMOVE;
702}
703
704static void tcp_chr_telnet_init(Chardev *chr)
705{
706 SocketChardev *s = SOCKET_CHARDEV(chr);
707 TCPChardevTelnetInit *init;
708 size_t n = 0;
709
710
711 tcp_chr_telnet_destroy(s);
712
713 if (s->telnet_init) {
714
715 goto cont;
716 }
717
718 s->telnet_init = g_new0(TCPChardevTelnetInit, 1);
719 init = s->telnet_init;
720
721#define IACSET(x, a, b, c) \
722 do { \
723 x[n++] = a; \
724 x[n++] = b; \
725 x[n++] = c; \
726 } while (0)
727
728 if (!s->is_tn3270) {
729 init->buflen = 12;
730
731
732 IACSET(init->buf, 0xff, 0xfb, 0x01);
733 IACSET(init->buf, 0xff, 0xfb, 0x03);
734 IACSET(init->buf, 0xff, 0xfb, 0x00);
735 IACSET(init->buf, 0xff, 0xfd, 0x00);
736 } else {
737 init->buflen = 21;
738
739 IACSET(init->buf, 0xff, 0xfd, 0x19);
740 IACSET(init->buf, 0xff, 0xfb, 0x19);
741 IACSET(init->buf, 0xff, 0xfd, 0x00);
742 IACSET(init->buf, 0xff, 0xfb, 0x00);
743 IACSET(init->buf, 0xff, 0xfd, 0x18);
744 IACSET(init->buf, 0xff, 0xfa, 0x18);
745 IACSET(init->buf, 0x01, 0xff, 0xf0);
746 }
747
748#undef IACSET
749
750cont:
751 s->telnet_source = qio_channel_add_watch_source(s->ioc, G_IO_OUT,
752 tcp_chr_telnet_init_io,
753 s, NULL,
754 chr->gcontext);
755}
756
757
758static void tcp_chr_websock_handshake(QIOTask *task, gpointer user_data)
759{
760 Chardev *chr = user_data;
761 SocketChardev *s = user_data;
762
763 if (qio_task_propagate_error(task, NULL)) {
764 tcp_chr_disconnect(chr);
765 } else {
766 if (s->do_telnetopt) {
767 tcp_chr_telnet_init(chr);
768 } else {
769 tcp_chr_connect(chr);
770 }
771 }
772}
773
774
775static void tcp_chr_websock_init(Chardev *chr)
776{
777 SocketChardev *s = SOCKET_CHARDEV(chr);
778 QIOChannelWebsock *wioc = NULL;
779 gchar *name;
780
781 wioc = qio_channel_websock_new_server(s->ioc);
782
783 name = g_strdup_printf("chardev-websocket-server-%s", chr->label);
784 qio_channel_set_name(QIO_CHANNEL(wioc), name);
785 g_free(name);
786 object_unref(OBJECT(s->ioc));
787 s->ioc = QIO_CHANNEL(wioc);
788
789 qio_channel_websock_handshake(wioc, tcp_chr_websock_handshake, chr, NULL);
790}
791
792
793static void tcp_chr_tls_handshake(QIOTask *task,
794 gpointer user_data)
795{
796 Chardev *chr = user_data;
797 SocketChardev *s = user_data;
798
799 if (qio_task_propagate_error(task, NULL)) {
800 tcp_chr_disconnect(chr);
801 } else {
802 if (s->is_websock) {
803 tcp_chr_websock_init(chr);
804 } else if (s->do_telnetopt) {
805 tcp_chr_telnet_init(chr);
806 } else {
807 tcp_chr_connect(chr);
808 }
809 }
810}
811
812
813static void tcp_chr_tls_init(Chardev *chr)
814{
815 SocketChardev *s = SOCKET_CHARDEV(chr);
816 QIOChannelTLS *tioc;
817 Error *err = NULL;
818 gchar *name;
819
820 if (s->is_listen) {
821 tioc = qio_channel_tls_new_server(
822 s->ioc, s->tls_creds,
823 s->tls_authz,
824 &err);
825 } else {
826 tioc = qio_channel_tls_new_client(
827 s->ioc, s->tls_creds,
828 s->addr->u.inet.host,
829 &err);
830 }
831 if (tioc == NULL) {
832 error_free(err);
833 tcp_chr_disconnect(chr);
834 return;
835 }
836 name = g_strdup_printf("chardev-tls-%s-%s",
837 s->is_listen ? "server" : "client",
838 chr->label);
839 qio_channel_set_name(QIO_CHANNEL(tioc), name);
840 g_free(name);
841 object_unref(OBJECT(s->ioc));
842 s->ioc = QIO_CHANNEL(tioc);
843
844 qio_channel_tls_handshake(tioc,
845 tcp_chr_tls_handshake,
846 chr,
847 NULL,
848 chr->gcontext);
849}
850
851
852static void tcp_chr_set_client_ioc_name(Chardev *chr,
853 QIOChannelSocket *sioc)
854{
855 SocketChardev *s = SOCKET_CHARDEV(chr);
856 char *name;
857 name = g_strdup_printf("chardev-tcp-%s-%s",
858 s->is_listen ? "server" : "client",
859 chr->label);
860 qio_channel_set_name(QIO_CHANNEL(sioc), name);
861 g_free(name);
862
863}
864
865static int tcp_chr_new_client(Chardev *chr, QIOChannelSocket *sioc)
866{
867 SocketChardev *s = SOCKET_CHARDEV(chr);
868
869 if (s->state != TCP_CHARDEV_STATE_CONNECTING) {
870 return -1;
871 }
872
873 s->ioc = QIO_CHANNEL(sioc);
874 object_ref(OBJECT(sioc));
875 s->sioc = sioc;
876 object_ref(OBJECT(sioc));
877
878 qio_channel_set_blocking(s->ioc, false, NULL);
879
880 if (s->do_nodelay) {
881 qio_channel_set_delay(s->ioc, false);
882 }
883 if (s->listener) {
884 qio_net_listener_set_client_func_full(s->listener, NULL, NULL,
885 NULL, chr->gcontext);
886 }
887
888 if (s->tls_creds) {
889 tcp_chr_tls_init(chr);
890 } else if (s->is_websock) {
891 tcp_chr_websock_init(chr);
892 } else if (s->do_telnetopt) {
893 tcp_chr_telnet_init(chr);
894 } else {
895 tcp_chr_connect(chr);
896 }
897
898 return 0;
899}
900
901
902static int tcp_chr_add_client(Chardev *chr, int fd)
903{
904 int ret;
905 QIOChannelSocket *sioc;
906 SocketChardev *s = SOCKET_CHARDEV(chr);
907
908 if (s->state != TCP_CHARDEV_STATE_DISCONNECTED) {
909 return -1;
910 }
911
912 sioc = qio_channel_socket_new_fd(fd, NULL);
913 if (!sioc) {
914 return -1;
915 }
916 tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
917 tcp_chr_set_client_ioc_name(chr, sioc);
918 ret = tcp_chr_new_client(chr, sioc);
919 object_unref(OBJECT(sioc));
920 return ret;
921}
922
923static void tcp_chr_accept(QIONetListener *listener,
924 QIOChannelSocket *cioc,
925 void *opaque)
926{
927 Chardev *chr = CHARDEV(opaque);
928 SocketChardev *s = SOCKET_CHARDEV(chr);
929
930 tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
931 tcp_chr_set_client_ioc_name(chr, cioc);
932 tcp_chr_new_client(chr, cioc);
933}
934
935
936static int tcp_chr_connect_client_sync(Chardev *chr, Error **errp)
937{
938 SocketChardev *s = SOCKET_CHARDEV(chr);
939 QIOChannelSocket *sioc = qio_channel_socket_new();
940 tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
941 tcp_chr_set_client_ioc_name(chr, sioc);
942 if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
943 tcp_chr_change_state(s, TCP_CHARDEV_STATE_DISCONNECTED);
944 object_unref(OBJECT(sioc));
945 return -1;
946 }
947 tcp_chr_new_client(chr, sioc);
948 object_unref(OBJECT(sioc));
949 return 0;
950}
951
952
953static void tcp_chr_accept_server_sync(Chardev *chr)
954{
955 SocketChardev *s = SOCKET_CHARDEV(chr);
956 QIOChannelSocket *sioc;
957 info_report("QEMU waiting for connection on: %s",
958 chr->filename);
959 tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
960 sioc = qio_net_listener_wait_client(s->listener);
961 tcp_chr_set_client_ioc_name(chr, sioc);
962 tcp_chr_new_client(chr, sioc);
963 object_unref(OBJECT(sioc));
964}
965
966
967static int tcp_chr_wait_connected(Chardev *chr, Error **errp)
968{
969 SocketChardev *s = SOCKET_CHARDEV(chr);
970 const char *opts[] = { "telnet", "tn3270", "websock", "tls-creds" };
971 bool optset[] = { s->is_telnet, s->is_tn3270, s->is_websock, s->tls_creds };
972 size_t i;
973
974 QEMU_BUILD_BUG_ON(G_N_ELEMENTS(opts) != G_N_ELEMENTS(optset));
975 for (i = 0; i < G_N_ELEMENTS(opts); i++) {
976 if (optset[i]) {
977 error_setg(errp,
978 "'%s' option is incompatible with waiting for "
979 "connection completion", opts[i]);
980 return -1;
981 }
982 }
983
984 tcp_chr_reconn_timer_cancel(s);
985
986
987
988
989
990
991
992
993
994
995
996
997 if (s->state == TCP_CHARDEV_STATE_CONNECTING) {
998 if (!s->connect_task) {
999 error_setg(errp,
1000 "Unexpected 'connecting' state without connect task "
1001 "while waiting for connection completion");
1002 return -1;
1003 }
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015 g_main_context_acquire(chr->gcontext);
1016 qio_task_wait_thread(s->connect_task);
1017 g_main_context_release(chr->gcontext);
1018
1019
1020
1021
1022
1023
1024 assert(!s->connect_task);
1025
1026
1027
1028
1029
1030
1031 }
1032
1033 while (s->state != TCP_CHARDEV_STATE_CONNECTED) {
1034 if (s->is_listen) {
1035 tcp_chr_accept_server_sync(chr);
1036 } else {
1037 Error *err = NULL;
1038 if (tcp_chr_connect_client_sync(chr, &err) < 0) {
1039 if (s->reconnect_time) {
1040 error_free(err);
1041 g_usleep(s->reconnect_time * 1000ULL * 1000ULL);
1042 } else {
1043 error_propagate(errp, err);
1044 return -1;
1045 }
1046 }
1047 }
1048 }
1049
1050 return 0;
1051}
1052
1053static void char_socket_finalize(Object *obj)
1054{
1055 Chardev *chr = CHARDEV(obj);
1056 SocketChardev *s = SOCKET_CHARDEV(obj);
1057
1058 tcp_chr_free_connection(chr);
1059 tcp_chr_reconn_timer_cancel(s);
1060 qapi_free_SocketAddress(s->addr);
1061 tcp_chr_telnet_destroy(s);
1062 g_free(s->telnet_init);
1063 if (s->listener) {
1064 qio_net_listener_set_client_func_full(s->listener, NULL, NULL,
1065 NULL, chr->gcontext);
1066 object_unref(OBJECT(s->listener));
1067 }
1068 if (s->tls_creds) {
1069 object_unref(OBJECT(s->tls_creds));
1070 }
1071 g_free(s->tls_authz);
1072
1073 qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
1074}
1075
1076static void qemu_chr_socket_connected(QIOTask *task, void *opaque)
1077{
1078 QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
1079 Chardev *chr = CHARDEV(opaque);
1080 SocketChardev *s = SOCKET_CHARDEV(chr);
1081 Error *err = NULL;
1082
1083 s->connect_task = NULL;
1084
1085 if (qio_task_propagate_error(task, &err)) {
1086 tcp_chr_change_state(s, TCP_CHARDEV_STATE_DISCONNECTED);
1087 check_report_connect_error(chr, err);
1088 goto cleanup;
1089 }
1090
1091 s->connect_err_reported = false;
1092 tcp_chr_new_client(chr, sioc);
1093
1094cleanup:
1095 object_unref(OBJECT(sioc));
1096}
1097
1098
1099static void tcp_chr_connect_client_task(QIOTask *task,
1100 gpointer opaque)
1101{
1102 QIOChannelSocket *ioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
1103 SocketAddress *addr = opaque;
1104 Error *err = NULL;
1105
1106 qio_channel_socket_connect_sync(ioc, addr, &err);
1107
1108 qio_task_set_error(task, err);
1109}
1110
1111
1112static void tcp_chr_connect_client_async(Chardev *chr)
1113{
1114 SocketChardev *s = SOCKET_CHARDEV(chr);
1115 QIOChannelSocket *sioc;
1116
1117 tcp_chr_change_state(s, TCP_CHARDEV_STATE_CONNECTING);
1118 sioc = qio_channel_socket_new();
1119 tcp_chr_set_client_ioc_name(chr, sioc);
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129 s->connect_task = qio_task_new(OBJECT(sioc),
1130 qemu_chr_socket_connected,
1131 chr, NULL);
1132 qio_task_run_in_thread(s->connect_task,
1133 tcp_chr_connect_client_task,
1134 s->addr,
1135 NULL,
1136 chr->gcontext);
1137}
1138
1139static gboolean socket_reconnect_timeout(gpointer opaque)
1140{
1141 Chardev *chr = CHARDEV(opaque);
1142 SocketChardev *s = SOCKET_CHARDEV(opaque);
1143
1144 qemu_mutex_lock(&chr->chr_write_lock);
1145 g_source_unref(s->reconnect_timer);
1146 s->reconnect_timer = NULL;
1147 qemu_mutex_unlock(&chr->chr_write_lock);
1148
1149 if (chr->be_open) {
1150 return false;
1151 }
1152
1153 tcp_chr_connect_client_async(chr);
1154
1155 return false;
1156}
1157
1158
1159static int qmp_chardev_open_socket_server(Chardev *chr,
1160 bool is_telnet,
1161 bool is_waitconnect,
1162 Error **errp)
1163{
1164 SocketChardev *s = SOCKET_CHARDEV(chr);
1165 char *name;
1166 if (is_telnet) {
1167 s->do_telnetopt = 1;
1168 }
1169 s->listener = qio_net_listener_new();
1170
1171 name = g_strdup_printf("chardev-tcp-listener-%s", chr->label);
1172 qio_net_listener_set_name(s->listener, name);
1173 g_free(name);
1174
1175 if (qio_net_listener_open_sync(s->listener, s->addr, 1, errp) < 0) {
1176 object_unref(OBJECT(s->listener));
1177 s->listener = NULL;
1178 return -1;
1179 }
1180
1181 qapi_free_SocketAddress(s->addr);
1182 s->addr = socket_local_address(s->listener->sioc[0]->fd, errp);
1183 update_disconnected_filename(s);
1184
1185 if (is_waitconnect) {
1186 tcp_chr_accept_server_sync(chr);
1187 } else {
1188 qio_net_listener_set_client_func_full(s->listener,
1189 tcp_chr_accept,
1190 chr, NULL,
1191 chr->gcontext);
1192 }
1193
1194 return 0;
1195}
1196
1197
1198static int qmp_chardev_open_socket_client(Chardev *chr,
1199 int64_t reconnect,
1200 Error **errp)
1201{
1202 SocketChardev *s = SOCKET_CHARDEV(chr);
1203
1204 if (reconnect > 0) {
1205 s->reconnect_time = reconnect;
1206 tcp_chr_connect_client_async(chr);
1207 return 0;
1208 } else {
1209 return tcp_chr_connect_client_sync(chr, errp);
1210 }
1211}
1212
1213
1214static bool qmp_chardev_validate_socket(ChardevSocket *sock,
1215 SocketAddress *addr,
1216 Error **errp)
1217{
1218
1219 switch (addr->type) {
1220 case SOCKET_ADDRESS_TYPE_FD:
1221 if (sock->has_reconnect) {
1222 error_setg(errp,
1223 "'reconnect' option is incompatible with "
1224 "'fd' address type");
1225 return false;
1226 }
1227 if (sock->has_tls_creds &&
1228 !(sock->has_server && sock->server)) {
1229 error_setg(errp,
1230 "'tls_creds' option is incompatible with "
1231 "'fd' address type as client");
1232 return false;
1233 }
1234 break;
1235
1236 case SOCKET_ADDRESS_TYPE_UNIX:
1237 if (sock->has_tls_creds) {
1238 error_setg(errp,
1239 "'tls_creds' option is incompatible with "
1240 "'unix' address type");
1241 return false;
1242 }
1243 break;
1244
1245 case SOCKET_ADDRESS_TYPE_INET:
1246 break;
1247
1248 case SOCKET_ADDRESS_TYPE_VSOCK:
1249 if (sock->has_tls_creds) {
1250 error_setg(errp,
1251 "'tls_creds' option is incompatible with "
1252 "'vsock' address type");
1253 return false;
1254 }
1255
1256 default:
1257 break;
1258 }
1259
1260 if (sock->has_tls_authz && !sock->has_tls_creds) {
1261 error_setg(errp, "'tls_authz' option requires 'tls_creds' option");
1262 return false;
1263 }
1264
1265
1266 if (!sock->has_server || sock->server) {
1267 if (sock->has_reconnect) {
1268 error_setg(errp,
1269 "'reconnect' option is incompatible with "
1270 "socket in server listen mode");
1271 return false;
1272 }
1273 } else {
1274 if (sock->has_websocket && sock->websocket) {
1275 error_setg(errp, "%s", "Websocket client is not implemented");
1276 return false;
1277 }
1278 if (sock->has_wait) {
1279 warn_report("'wait' option is deprecated with "
1280 "socket in client connect mode");
1281 if (sock->wait) {
1282 error_setg(errp, "%s",
1283 "'wait' option is incompatible with "
1284 "socket in client connect mode");
1285 return false;
1286 }
1287 }
1288 }
1289
1290 return true;
1291}
1292
1293
1294static void qmp_chardev_open_socket(Chardev *chr,
1295 ChardevBackend *backend,
1296 bool *be_opened,
1297 Error **errp)
1298{
1299 SocketChardev *s = SOCKET_CHARDEV(chr);
1300 ChardevSocket *sock = backend->u.socket.data;
1301 bool do_nodelay = sock->has_nodelay ? sock->nodelay : false;
1302 bool is_listen = sock->has_server ? sock->server : true;
1303 bool is_telnet = sock->has_telnet ? sock->telnet : false;
1304 bool is_tn3270 = sock->has_tn3270 ? sock->tn3270 : false;
1305 bool is_waitconnect = sock->has_wait ? sock->wait : false;
1306 bool is_websock = sock->has_websocket ? sock->websocket : false;
1307 int64_t reconnect = sock->has_reconnect ? sock->reconnect : 0;
1308 SocketAddress *addr;
1309
1310 s->is_listen = is_listen;
1311 s->is_telnet = is_telnet;
1312 s->is_tn3270 = is_tn3270;
1313 s->is_websock = is_websock;
1314 s->do_nodelay = do_nodelay;
1315 if (sock->tls_creds) {
1316 Object *creds;
1317 creds = object_resolve_path_component(
1318 object_get_objects_root(), sock->tls_creds);
1319 if (!creds) {
1320 error_setg(errp, "No TLS credentials with id '%s'",
1321 sock->tls_creds);
1322 return;
1323 }
1324 s->tls_creds = (QCryptoTLSCreds *)
1325 object_dynamic_cast(creds,
1326 TYPE_QCRYPTO_TLS_CREDS);
1327 if (!s->tls_creds) {
1328 error_setg(errp, "Object with id '%s' is not TLS credentials",
1329 sock->tls_creds);
1330 return;
1331 }
1332 object_ref(OBJECT(s->tls_creds));
1333 if (is_listen) {
1334 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
1335 error_setg(errp, "%s",
1336 "Expected TLS credentials for server endpoint");
1337 return;
1338 }
1339 } else {
1340 if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
1341 error_setg(errp, "%s",
1342 "Expected TLS credentials for client endpoint");
1343 return;
1344 }
1345 }
1346 }
1347 s->tls_authz = g_strdup(sock->tls_authz);
1348
1349 s->addr = addr = socket_address_flatten(sock->addr);
1350
1351 if (!qmp_chardev_validate_socket(sock, addr, errp)) {
1352 return;
1353 }
1354
1355 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
1356
1357 if (addr->type == SOCKET_ADDRESS_TYPE_UNIX) {
1358 qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
1359 }
1360
1361
1362 *be_opened = false;
1363
1364 update_disconnected_filename(s);
1365
1366 if (s->is_listen) {
1367 if (qmp_chardev_open_socket_server(chr, is_telnet || is_tn3270,
1368 is_waitconnect, errp) < 0) {
1369 return;
1370 }
1371 } else {
1372 if (qmp_chardev_open_socket_client(chr, reconnect, errp) < 0) {
1373 return;
1374 }
1375 }
1376}
1377
1378static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
1379 Error **errp)
1380{
1381 const char *path = qemu_opt_get(opts, "path");
1382 const char *host = qemu_opt_get(opts, "host");
1383 const char *port = qemu_opt_get(opts, "port");
1384 const char *fd = qemu_opt_get(opts, "fd");
1385 SocketAddressLegacy *addr;
1386 ChardevSocket *sock;
1387
1388 if ((!!path + !!fd + !!host) != 1) {
1389 error_setg(errp,
1390 "Exactly one of 'path', 'fd' or 'host' required");
1391 return;
1392 }
1393
1394 if (host && !port) {
1395 error_setg(errp, "chardev: socket: no port given");
1396 return;
1397 }
1398
1399 backend->type = CHARDEV_BACKEND_KIND_SOCKET;
1400 sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
1401 qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
1402
1403 sock->has_nodelay = qemu_opt_get(opts, "delay");
1404 sock->nodelay = !qemu_opt_get_bool(opts, "delay", true);
1405
1406
1407
1408
1409 sock->has_server = true;
1410 sock->server = qemu_opt_get_bool(opts, "server", false);
1411 sock->has_telnet = qemu_opt_get(opts, "telnet");
1412 sock->telnet = qemu_opt_get_bool(opts, "telnet", false);
1413 sock->has_tn3270 = qemu_opt_get(opts, "tn3270");
1414 sock->tn3270 = qemu_opt_get_bool(opts, "tn3270", false);
1415 sock->has_websocket = qemu_opt_get(opts, "websocket");
1416 sock->websocket = qemu_opt_get_bool(opts, "websocket", false);
1417
1418
1419
1420
1421 sock->has_wait = qemu_opt_find(opts, "wait") || sock->server;
1422 sock->wait = qemu_opt_get_bool(opts, "wait", true);
1423 sock->has_reconnect = qemu_opt_find(opts, "reconnect");
1424 sock->reconnect = qemu_opt_get_number(opts, "reconnect", 0);
1425 sock->has_tls_creds = qemu_opt_get(opts, "tls-creds");
1426 sock->tls_creds = g_strdup(qemu_opt_get(opts, "tls-creds"));
1427 sock->has_tls_authz = qemu_opt_get(opts, "tls-authz");
1428 sock->tls_authz = g_strdup(qemu_opt_get(opts, "tls-authz"));
1429
1430 addr = g_new0(SocketAddressLegacy, 1);
1431 if (path) {
1432 UnixSocketAddress *q_unix;
1433 addr->type = SOCKET_ADDRESS_LEGACY_KIND_UNIX;
1434 q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
1435 q_unix->path = g_strdup(path);
1436 } else if (host) {
1437 addr->type = SOCKET_ADDRESS_LEGACY_KIND_INET;
1438 addr->u.inet.data = g_new(InetSocketAddress, 1);
1439 *addr->u.inet.data = (InetSocketAddress) {
1440 .host = g_strdup(host),
1441 .port = g_strdup(port),
1442 .has_to = qemu_opt_get(opts, "to"),
1443 .to = qemu_opt_get_number(opts, "to", 0),
1444 .has_ipv4 = qemu_opt_get(opts, "ipv4"),
1445 .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
1446 .has_ipv6 = qemu_opt_get(opts, "ipv6"),
1447 .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
1448 };
1449 } else if (fd) {
1450 addr->type = SOCKET_ADDRESS_LEGACY_KIND_FD;
1451 addr->u.fd.data = g_new(String, 1);
1452 addr->u.fd.data->str = g_strdup(fd);
1453 } else {
1454 g_assert_not_reached();
1455 }
1456 sock->addr = addr;
1457}
1458
1459static void
1460char_socket_get_addr(Object *obj, Visitor *v, const char *name,
1461 void *opaque, Error **errp)
1462{
1463 SocketChardev *s = SOCKET_CHARDEV(obj);
1464
1465 visit_type_SocketAddress(v, name, &s->addr, errp);
1466}
1467
1468static bool
1469char_socket_get_connected(Object *obj, Error **errp)
1470{
1471 SocketChardev *s = SOCKET_CHARDEV(obj);
1472
1473 return s->state == TCP_CHARDEV_STATE_CONNECTED;
1474}
1475
1476static void char_socket_class_init(ObjectClass *oc, void *data)
1477{
1478 ChardevClass *cc = CHARDEV_CLASS(oc);
1479
1480 cc->parse = qemu_chr_parse_socket;
1481 cc->open = qmp_chardev_open_socket;
1482 cc->chr_wait_connected = tcp_chr_wait_connected;
1483 cc->chr_write = tcp_chr_write;
1484 cc->chr_sync_read = tcp_chr_sync_read;
1485 cc->chr_disconnect = tcp_chr_disconnect;
1486 cc->get_msgfds = tcp_get_msgfds;
1487 cc->set_msgfds = tcp_set_msgfds;
1488 cc->chr_add_client = tcp_chr_add_client;
1489 cc->chr_add_watch = tcp_chr_add_watch;
1490 cc->chr_update_read_handler = tcp_chr_update_read_handler;
1491
1492 object_class_property_add(oc, "addr", "SocketAddress",
1493 char_socket_get_addr, NULL,
1494 NULL, NULL, &error_abort);
1495
1496 object_class_property_add_bool(oc, "connected", char_socket_get_connected,
1497 NULL, &error_abort);
1498}
1499
1500static const TypeInfo char_socket_type_info = {
1501 .name = TYPE_CHARDEV_SOCKET,
1502 .parent = TYPE_CHARDEV,
1503 .instance_size = sizeof(SocketChardev),
1504 .instance_finalize = char_socket_finalize,
1505 .class_init = char_socket_class_init,
1506};
1507
1508static void register_types(void)
1509{
1510 type_register_static(&char_socket_type_info);
1511}
1512
1513type_init(register_types);
1514