xref: /openbmc/qemu/chardev/char-socket.c (revision 4fad446b)
1 /*
2  * QEMU System Emulator
3  *
4  * Copyright (c) 2003-2008 Fabrice Bellard
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 #include "qemu/osdep.h"
25 #include "chardev/char.h"
26 #include "io/channel-socket.h"
27 #include "io/channel-tls.h"
28 #include "io/net-listener.h"
29 #include "qemu/error-report.h"
30 #include "qapi/error.h"
31 #include "qapi/clone-visitor.h"
32 
33 #include "chardev/char-io.h"
34 
35 /***********************************************************/
36 /* TCP Net console */
37 
38 #define TCP_MAX_FDS 16
39 
40 typedef struct {
41     Chardev parent;
42     QIOChannel *ioc; /* Client I/O channel */
43     QIOChannelSocket *sioc; /* Client master channel */
44     QIONetListener *listener;
45     QCryptoTLSCreds *tls_creds;
46     int connected;
47     int max_size;
48     int do_telnetopt;
49     int do_nodelay;
50     int *read_msgfds;
51     size_t read_msgfds_num;
52     int *write_msgfds;
53     size_t write_msgfds_num;
54 
55     SocketAddress *addr;
56     bool is_listen;
57     bool is_telnet;
58     bool is_tn3270;
59 
60     guint reconnect_timer;
61     int64_t reconnect_time;
62     bool connect_err_reported;
63 } SocketChardev;
64 
65 #define SOCKET_CHARDEV(obj)                                     \
66     OBJECT_CHECK(SocketChardev, (obj), TYPE_CHARDEV_SOCKET)
67 
68 static gboolean socket_reconnect_timeout(gpointer opaque);
69 
70 static void qemu_chr_socket_restart_timer(Chardev *chr)
71 {
72     SocketChardev *s = SOCKET_CHARDEV(chr);
73     char *name;
74 
75     assert(s->connected == 0);
76     s->reconnect_timer = g_timeout_add_seconds(s->reconnect_time,
77                                                socket_reconnect_timeout, chr);
78     name = g_strdup_printf("chardev-socket-reconnect-%s", chr->label);
79     g_source_set_name_by_id(s->reconnect_timer, name);
80     g_free(name);
81 }
82 
83 static void check_report_connect_error(Chardev *chr,
84                                        Error *err)
85 {
86     SocketChardev *s = SOCKET_CHARDEV(chr);
87 
88     if (!s->connect_err_reported) {
89         error_report("Unable to connect character device %s: %s",
90                      chr->label, error_get_pretty(err));
91         s->connect_err_reported = true;
92     }
93     qemu_chr_socket_restart_timer(chr);
94 }
95 
96 static void tcp_chr_accept(QIONetListener *listener,
97                            QIOChannelSocket *cioc,
98                            void *opaque);
99 
100 static int tcp_chr_read_poll(void *opaque);
101 static void tcp_chr_disconnect(Chardev *chr);
102 
103 /* Called with chr_write_lock held.  */
104 static int tcp_chr_write(Chardev *chr, const uint8_t *buf, int len)
105 {
106     SocketChardev *s = SOCKET_CHARDEV(chr);
107 
108     if (s->connected) {
109         int ret =  io_channel_send_full(s->ioc, buf, len,
110                                         s->write_msgfds,
111                                         s->write_msgfds_num);
112 
113         /* free the written msgfds, no matter what */
114         if (s->write_msgfds_num) {
115             g_free(s->write_msgfds);
116             s->write_msgfds = 0;
117             s->write_msgfds_num = 0;
118         }
119 
120         if (ret < 0 && errno != EAGAIN) {
121             if (tcp_chr_read_poll(chr) <= 0) {
122                 tcp_chr_disconnect(chr);
123                 return len;
124             } /* else let the read handler finish it properly */
125         }
126 
127         return ret;
128     } else {
129         /* XXX: indicate an error ? */
130         return len;
131     }
132 }
133 
134 static int tcp_chr_read_poll(void *opaque)
135 {
136     Chardev *chr = CHARDEV(opaque);
137     SocketChardev *s = SOCKET_CHARDEV(opaque);
138     if (!s->connected) {
139         return 0;
140     }
141     s->max_size = qemu_chr_be_can_write(chr);
142     return s->max_size;
143 }
144 
145 static void tcp_chr_process_IAC_bytes(Chardev *chr,
146                                       SocketChardev *s,
147                                       uint8_t *buf, int *size)
148 {
149     /* Handle any telnet or tn3270 client's basic IAC options.
150      * For telnet options, it satisfies char by char mode with no echo.
151      * For tn3270 options, it satisfies binary mode with EOR.
152      * All IAC options will be removed from the buf and the do_opt
153      * pointer will be used to track the state of the width of the
154      * IAC information.
155      *
156      * RFC854: "All TELNET commands consist of at least a two byte sequence.
157      * The commands dealing with option negotiation are three byte sequences,
158      * the third byte being the code for the option referenced."
159      * "IAC BREAK", "IAC IP", "IAC NOP" and the double IAC are two bytes.
160      * "IAC SB", "IAC SE" and "IAC EOR" are saved to split up data boundary
161      * for tn3270.
162      * NOP, Break and Interrupt Process(IP) might be encountered during a TN3270
163      * session, and NOP and IP need to be done later.
164      */
165 
166     int i;
167     int j = 0;
168 
169     for (i = 0; i < *size; i++) {
170         if (s->do_telnetopt > 1) {
171             if ((unsigned char)buf[i] == IAC && s->do_telnetopt == 2) {
172                 /* Double IAC means send an IAC */
173                 if (j != i) {
174                     buf[j] = buf[i];
175                 }
176                 j++;
177                 s->do_telnetopt = 1;
178             } else {
179                 if ((unsigned char)buf[i] == IAC_BREAK
180                     && s->do_telnetopt == 2) {
181                     /* Handle IAC break commands by sending a serial break */
182                     qemu_chr_be_event(chr, CHR_EVENT_BREAK);
183                     s->do_telnetopt++;
184                 } else if (s->is_tn3270 && ((unsigned char)buf[i] == IAC_EOR
185                            || (unsigned char)buf[i] == IAC_SB
186                            || (unsigned char)buf[i] == IAC_SE)
187                            && s->do_telnetopt == 2) {
188                     buf[j++] = IAC;
189                     buf[j++] = buf[i];
190                     s->do_telnetopt++;
191                 } else if (s->is_tn3270 && ((unsigned char)buf[i] == IAC_IP
192                            || (unsigned char)buf[i] == IAC_NOP)
193                            && s->do_telnetopt == 2) {
194                     /* TODO: IP and NOP need to be implemented later. */
195                     s->do_telnetopt++;
196                 }
197                 s->do_telnetopt++;
198             }
199             if (s->do_telnetopt >= 4) {
200                 s->do_telnetopt = 1;
201             }
202         } else {
203             if ((unsigned char)buf[i] == IAC) {
204                 s->do_telnetopt = 2;
205             } else {
206                 if (j != i) {
207                     buf[j] = buf[i];
208                 }
209                 j++;
210             }
211         }
212     }
213     *size = j;
214 }
215 
216 static int tcp_get_msgfds(Chardev *chr, int *fds, int num)
217 {
218     SocketChardev *s = SOCKET_CHARDEV(chr);
219 
220     int to_copy = (s->read_msgfds_num < num) ? s->read_msgfds_num : num;
221 
222     assert(num <= TCP_MAX_FDS);
223 
224     if (to_copy) {
225         int i;
226 
227         memcpy(fds, s->read_msgfds, to_copy * sizeof(int));
228 
229         /* Close unused fds */
230         for (i = to_copy; i < s->read_msgfds_num; i++) {
231             close(s->read_msgfds[i]);
232         }
233 
234         g_free(s->read_msgfds);
235         s->read_msgfds = 0;
236         s->read_msgfds_num = 0;
237     }
238 
239     return to_copy;
240 }
241 
242 static int tcp_set_msgfds(Chardev *chr, int *fds, int num)
243 {
244     SocketChardev *s = SOCKET_CHARDEV(chr);
245 
246     /* clear old pending fd array */
247     g_free(s->write_msgfds);
248     s->write_msgfds = NULL;
249     s->write_msgfds_num = 0;
250 
251     if (!s->connected ||
252         !qio_channel_has_feature(s->ioc,
253                                  QIO_CHANNEL_FEATURE_FD_PASS)) {
254         return -1;
255     }
256 
257     if (num) {
258         s->write_msgfds = g_new(int, num);
259         memcpy(s->write_msgfds, fds, num * sizeof(int));
260     }
261 
262     s->write_msgfds_num = num;
263 
264     return 0;
265 }
266 
267 static ssize_t tcp_chr_recv(Chardev *chr, char *buf, size_t len)
268 {
269     SocketChardev *s = SOCKET_CHARDEV(chr);
270     struct iovec iov = { .iov_base = buf, .iov_len = len };
271     int ret;
272     size_t i;
273     int *msgfds = NULL;
274     size_t msgfds_num = 0;
275 
276     if (qio_channel_has_feature(s->ioc, QIO_CHANNEL_FEATURE_FD_PASS)) {
277         ret = qio_channel_readv_full(s->ioc, &iov, 1,
278                                      &msgfds, &msgfds_num,
279                                      NULL);
280     } else {
281         ret = qio_channel_readv_full(s->ioc, &iov, 1,
282                                      NULL, NULL,
283                                      NULL);
284     }
285 
286     if (ret == QIO_CHANNEL_ERR_BLOCK) {
287         errno = EAGAIN;
288         ret = -1;
289     } else if (ret == -1) {
290         errno = EIO;
291     }
292 
293     if (msgfds_num) {
294         /* close and clean read_msgfds */
295         for (i = 0; i < s->read_msgfds_num; i++) {
296             close(s->read_msgfds[i]);
297         }
298 
299         if (s->read_msgfds_num) {
300             g_free(s->read_msgfds);
301         }
302 
303         s->read_msgfds = msgfds;
304         s->read_msgfds_num = msgfds_num;
305     }
306 
307     for (i = 0; i < s->read_msgfds_num; i++) {
308         int fd = s->read_msgfds[i];
309         if (fd < 0) {
310             continue;
311         }
312 
313         /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
314         qemu_set_block(fd);
315 
316 #ifndef MSG_CMSG_CLOEXEC
317         qemu_set_cloexec(fd);
318 #endif
319     }
320 
321     return ret;
322 }
323 
324 static GSource *tcp_chr_add_watch(Chardev *chr, GIOCondition cond)
325 {
326     SocketChardev *s = SOCKET_CHARDEV(chr);
327     return qio_channel_create_watch(s->ioc, cond);
328 }
329 
330 static void tcp_chr_free_connection(Chardev *chr)
331 {
332     SocketChardev *s = SOCKET_CHARDEV(chr);
333     int i;
334 
335     if (s->read_msgfds_num) {
336         for (i = 0; i < s->read_msgfds_num; i++) {
337             close(s->read_msgfds[i]);
338         }
339         g_free(s->read_msgfds);
340         s->read_msgfds = NULL;
341         s->read_msgfds_num = 0;
342     }
343 
344     tcp_set_msgfds(chr, NULL, 0);
345     remove_fd_in_watch(chr);
346     object_unref(OBJECT(s->sioc));
347     s->sioc = NULL;
348     object_unref(OBJECT(s->ioc));
349     s->ioc = NULL;
350     g_free(chr->filename);
351     chr->filename = NULL;
352     s->connected = 0;
353 }
354 
355 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
356                                   bool is_listen, bool is_telnet)
357 {
358     switch (addr->type) {
359     case SOCKET_ADDRESS_TYPE_INET:
360         return g_strdup_printf("%s%s:%s:%s%s", prefix,
361                                is_telnet ? "telnet" : "tcp",
362                                addr->u.inet.host,
363                                addr->u.inet.port,
364                                is_listen ? ",server" : "");
365         break;
366     case SOCKET_ADDRESS_TYPE_UNIX:
367         return g_strdup_printf("%sunix:%s%s", prefix,
368                                addr->u.q_unix.path,
369                                is_listen ? ",server" : "");
370         break;
371     case SOCKET_ADDRESS_TYPE_FD:
372         return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd.str,
373                                is_listen ? ",server" : "");
374         break;
375     case SOCKET_ADDRESS_TYPE_VSOCK:
376         return g_strdup_printf("%svsock:%s:%s", prefix,
377                                addr->u.vsock.cid,
378                                addr->u.vsock.port);
379     default:
380         abort();
381     }
382 }
383 
384 static void update_disconnected_filename(SocketChardev *s)
385 {
386     Chardev *chr = CHARDEV(s);
387 
388     g_free(chr->filename);
389     chr->filename = SocketAddress_to_str("disconnected:", s->addr,
390                                          s->is_listen, s->is_telnet);
391 }
392 
393 /* NB may be called even if tcp_chr_connect has not been
394  * reached, due to TLS or telnet initialization failure,
395  * so can *not* assume s->connected == true
396  */
397 static void tcp_chr_disconnect(Chardev *chr)
398 {
399     SocketChardev *s = SOCKET_CHARDEV(chr);
400     bool emit_close = s->connected;
401 
402     tcp_chr_free_connection(chr);
403 
404     if (s->listener) {
405         qio_net_listener_set_client_func(s->listener, tcp_chr_accept,
406                                          chr, NULL);
407     }
408     update_disconnected_filename(s);
409     if (emit_close) {
410         qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
411     }
412     if (s->reconnect_time) {
413         qemu_chr_socket_restart_timer(chr);
414     }
415 }
416 
417 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
418 {
419     Chardev *chr = CHARDEV(opaque);
420     SocketChardev *s = SOCKET_CHARDEV(opaque);
421     uint8_t buf[CHR_READ_BUF_LEN];
422     int len, size;
423 
424     if (!s->connected || s->max_size <= 0) {
425         return TRUE;
426     }
427     len = sizeof(buf);
428     if (len > s->max_size) {
429         len = s->max_size;
430     }
431     size = tcp_chr_recv(chr, (void *)buf, len);
432     if (size == 0 || size == -1) {
433         /* connection closed */
434         tcp_chr_disconnect(chr);
435     } else if (size > 0) {
436         if (s->do_telnetopt) {
437             tcp_chr_process_IAC_bytes(chr, s, buf, &size);
438         }
439         if (size > 0) {
440             qemu_chr_be_write(chr, buf, size);
441         }
442     }
443 
444     return TRUE;
445 }
446 
447 static int tcp_chr_sync_read(Chardev *chr, const uint8_t *buf, int len)
448 {
449     SocketChardev *s = SOCKET_CHARDEV(chr);
450     int size;
451 
452     if (!s->connected) {
453         return 0;
454     }
455 
456     qio_channel_set_blocking(s->ioc, true, NULL);
457     size = tcp_chr_recv(chr, (void *) buf, len);
458     qio_channel_set_blocking(s->ioc, false, NULL);
459     if (size == 0) {
460         /* connection closed */
461         tcp_chr_disconnect(chr);
462     }
463 
464     return size;
465 }
466 
467 static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,
468                              struct sockaddr_storage *ps, socklen_t ps_len,
469                              bool is_listen, bool is_telnet)
470 {
471     char shost[NI_MAXHOST], sserv[NI_MAXSERV];
472     char phost[NI_MAXHOST], pserv[NI_MAXSERV];
473     const char *left = "", *right = "";
474 
475     switch (ss->ss_family) {
476 #ifndef _WIN32
477     case AF_UNIX:
478         return g_strdup_printf("unix:%s%s",
479                                ((struct sockaddr_un *)(ss))->sun_path,
480                                is_listen ? ",server" : "");
481 #endif
482     case AF_INET6:
483         left  = "[";
484         right = "]";
485         /* fall through */
486     case AF_INET:
487         getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
488                     sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
489         getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
490                     pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
491         return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
492                                is_telnet ? "telnet" : "tcp",
493                                left, shost, right, sserv,
494                                is_listen ? ",server" : "",
495                                left, phost, right, pserv);
496 
497     default:
498         return g_strdup_printf("unknown");
499     }
500 }
501 
502 static void tcp_chr_connect(void *opaque)
503 {
504     Chardev *chr = CHARDEV(opaque);
505     SocketChardev *s = SOCKET_CHARDEV(opaque);
506 
507     g_free(chr->filename);
508     chr->filename = sockaddr_to_str(
509         &s->sioc->localAddr, s->sioc->localAddrLen,
510         &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
511         s->is_listen, s->is_telnet);
512 
513     s->connected = 1;
514     if (s->ioc) {
515         chr->gsource = io_add_watch_poll(chr, s->ioc,
516                                            tcp_chr_read_poll,
517                                            tcp_chr_read,
518                                            chr, chr->gcontext);
519     }
520     qemu_chr_be_event(chr, CHR_EVENT_OPENED);
521 }
522 
523 static void tcp_chr_update_read_handler(Chardev *chr)
524 {
525     SocketChardev *s = SOCKET_CHARDEV(chr);
526 
527     if (!s->connected) {
528         return;
529     }
530 
531     remove_fd_in_watch(chr);
532     if (s->ioc) {
533         chr->gsource = io_add_watch_poll(chr, s->ioc,
534                                            tcp_chr_read_poll,
535                                            tcp_chr_read, chr,
536                                            chr->gcontext);
537     }
538 }
539 
540 typedef struct {
541     Chardev *chr;
542     char buf[21];
543     size_t buflen;
544 } TCPChardevTelnetInit;
545 
546 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
547                                        GIOCondition cond G_GNUC_UNUSED,
548                                        gpointer user_data)
549 {
550     TCPChardevTelnetInit *init = user_data;
551     ssize_t ret;
552 
553     ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
554     if (ret < 0) {
555         if (ret == QIO_CHANNEL_ERR_BLOCK) {
556             ret = 0;
557         } else {
558             tcp_chr_disconnect(init->chr);
559             return FALSE;
560         }
561     }
562     init->buflen -= ret;
563 
564     if (init->buflen == 0) {
565         tcp_chr_connect(init->chr);
566         return FALSE;
567     }
568 
569     memmove(init->buf, init->buf + ret, init->buflen);
570 
571     return TRUE;
572 }
573 
574 static void tcp_chr_telnet_init(Chardev *chr)
575 {
576     SocketChardev *s = SOCKET_CHARDEV(chr);
577     TCPChardevTelnetInit *init = g_new0(TCPChardevTelnetInit, 1);
578     size_t n = 0;
579 
580 #define IACSET(x, a, b, c)                      \
581     do {                                        \
582         x[n++] = a;                             \
583         x[n++] = b;                             \
584         x[n++] = c;                             \
585     } while (0)
586 
587     init->chr = chr;
588     if (!s->is_tn3270) {
589         init->buflen = 12;
590         /* Prep the telnet negotion to put telnet in binary,
591          * no echo, single char mode */
592         IACSET(init->buf, 0xff, 0xfb, 0x01);  /* IAC WILL ECHO */
593         IACSET(init->buf, 0xff, 0xfb, 0x03);  /* IAC WILL Suppress go ahead */
594         IACSET(init->buf, 0xff, 0xfb, 0x00);  /* IAC WILL Binary */
595         IACSET(init->buf, 0xff, 0xfd, 0x00);  /* IAC DO Binary */
596     } else {
597         init->buflen = 21;
598         /* Prep the TN3270 negotion based on RFC1576 */
599         IACSET(init->buf, 0xff, 0xfd, 0x19);  /* IAC DO EOR */
600         IACSET(init->buf, 0xff, 0xfb, 0x19);  /* IAC WILL EOR */
601         IACSET(init->buf, 0xff, 0xfd, 0x00);  /* IAC DO BINARY */
602         IACSET(init->buf, 0xff, 0xfb, 0x00);  /* IAC WILL BINARY */
603         IACSET(init->buf, 0xff, 0xfd, 0x18);  /* IAC DO TERMINAL TYPE */
604         IACSET(init->buf, 0xff, 0xfa, 0x18);  /* IAC SB TERMINAL TYPE */
605         IACSET(init->buf, 0x01, 0xff, 0xf0);  /* SEND IAC SE */
606     }
607 
608 #undef IACSET
609 
610     qio_channel_add_watch(
611         s->ioc, G_IO_OUT,
612         tcp_chr_telnet_init_io,
613         init, NULL);
614 }
615 
616 
617 static void tcp_chr_tls_handshake(QIOTask *task,
618                                   gpointer user_data)
619 {
620     Chardev *chr = user_data;
621     SocketChardev *s = user_data;
622 
623     if (qio_task_propagate_error(task, NULL)) {
624         tcp_chr_disconnect(chr);
625     } else {
626         /* tn3270 does not support TLS yet */
627         if (s->do_telnetopt && !s->is_tn3270) {
628             tcp_chr_telnet_init(chr);
629         } else {
630             tcp_chr_connect(chr);
631         }
632     }
633 }
634 
635 
636 static void tcp_chr_tls_init(Chardev *chr)
637 {
638     SocketChardev *s = SOCKET_CHARDEV(chr);
639     QIOChannelTLS *tioc;
640     Error *err = NULL;
641     gchar *name;
642 
643     if (s->is_listen) {
644         tioc = qio_channel_tls_new_server(
645             s->ioc, s->tls_creds,
646             NULL, /* XXX Use an ACL */
647             &err);
648     } else {
649         tioc = qio_channel_tls_new_client(
650             s->ioc, s->tls_creds,
651             s->addr->u.inet.host,
652             &err);
653     }
654     if (tioc == NULL) {
655         error_free(err);
656         tcp_chr_disconnect(chr);
657         return;
658     }
659     name = g_strdup_printf("chardev-tls-%s-%s",
660                            s->is_listen ? "server" : "client",
661                            chr->label);
662     qio_channel_set_name(QIO_CHANNEL(tioc), name);
663     g_free(name);
664     object_unref(OBJECT(s->ioc));
665     s->ioc = QIO_CHANNEL(tioc);
666 
667     qio_channel_tls_handshake(tioc,
668                               tcp_chr_tls_handshake,
669                               chr,
670                               NULL);
671 }
672 
673 
674 static void tcp_chr_set_client_ioc_name(Chardev *chr,
675                                         QIOChannelSocket *sioc)
676 {
677     SocketChardev *s = SOCKET_CHARDEV(chr);
678     char *name;
679     name = g_strdup_printf("chardev-tcp-%s-%s",
680                            s->is_listen ? "server" : "client",
681                            chr->label);
682     qio_channel_set_name(QIO_CHANNEL(sioc), name);
683     g_free(name);
684 
685 }
686 
687 static int tcp_chr_new_client(Chardev *chr, QIOChannelSocket *sioc)
688 {
689     SocketChardev *s = SOCKET_CHARDEV(chr);
690 
691     if (s->ioc != NULL) {
692         return -1;
693     }
694 
695     s->ioc = QIO_CHANNEL(sioc);
696     object_ref(OBJECT(sioc));
697     s->sioc = sioc;
698     object_ref(OBJECT(sioc));
699 
700     qio_channel_set_blocking(s->ioc, false, NULL);
701 
702     if (s->do_nodelay) {
703         qio_channel_set_delay(s->ioc, false);
704     }
705     if (s->listener) {
706         qio_net_listener_set_client_func(s->listener, NULL, NULL, NULL);
707     }
708 
709     if (s->tls_creds) {
710         tcp_chr_tls_init(chr);
711     } else {
712         if (s->do_telnetopt) {
713             tcp_chr_telnet_init(chr);
714         } else {
715             tcp_chr_connect(chr);
716         }
717     }
718 
719     return 0;
720 }
721 
722 
723 static int tcp_chr_add_client(Chardev *chr, int fd)
724 {
725     int ret;
726     QIOChannelSocket *sioc;
727 
728     sioc = qio_channel_socket_new_fd(fd, NULL);
729     if (!sioc) {
730         return -1;
731     }
732     tcp_chr_set_client_ioc_name(chr, sioc);
733     ret = tcp_chr_new_client(chr, sioc);
734     object_unref(OBJECT(sioc));
735     return ret;
736 }
737 
738 static void tcp_chr_accept(QIONetListener *listener,
739                            QIOChannelSocket *cioc,
740                            void *opaque)
741 {
742     Chardev *chr = CHARDEV(opaque);
743 
744     tcp_chr_set_client_ioc_name(chr, cioc);
745     tcp_chr_new_client(chr, cioc);
746 }
747 
748 static int tcp_chr_wait_connected(Chardev *chr, Error **errp)
749 {
750     SocketChardev *s = SOCKET_CHARDEV(chr);
751     QIOChannelSocket *sioc;
752 
753     /* It can't wait on s->connected, since it is set asynchronously
754      * in TLS and telnet cases, only wait for an accepted socket */
755     while (!s->ioc) {
756         if (s->is_listen) {
757             info_report("QEMU waiting for connection on: %s",
758                         chr->filename);
759             sioc = qio_net_listener_wait_client(s->listener);
760             tcp_chr_set_client_ioc_name(chr, sioc);
761             tcp_chr_new_client(chr, sioc);
762             object_unref(OBJECT(sioc));
763         } else {
764             sioc = qio_channel_socket_new();
765             tcp_chr_set_client_ioc_name(chr, sioc);
766             if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
767                 object_unref(OBJECT(sioc));
768                 return -1;
769             }
770             tcp_chr_new_client(chr, sioc);
771             object_unref(OBJECT(sioc));
772         }
773     }
774 
775     return 0;
776 }
777 
778 static void char_socket_finalize(Object *obj)
779 {
780     Chardev *chr = CHARDEV(obj);
781     SocketChardev *s = SOCKET_CHARDEV(obj);
782 
783     tcp_chr_free_connection(chr);
784 
785     if (s->reconnect_timer) {
786         g_source_remove(s->reconnect_timer);
787         s->reconnect_timer = 0;
788     }
789     qapi_free_SocketAddress(s->addr);
790     if (s->listener) {
791         qio_net_listener_set_client_func(s->listener, NULL, NULL, NULL);
792         object_unref(OBJECT(s->listener));
793     }
794     if (s->tls_creds) {
795         object_unref(OBJECT(s->tls_creds));
796     }
797 
798     qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
799 }
800 
801 static void qemu_chr_socket_connected(QIOTask *task, void *opaque)
802 {
803     QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
804     Chardev *chr = CHARDEV(opaque);
805     SocketChardev *s = SOCKET_CHARDEV(chr);
806     Error *err = NULL;
807 
808     if (qio_task_propagate_error(task, &err)) {
809         check_report_connect_error(chr, err);
810         error_free(err);
811         goto cleanup;
812     }
813 
814     s->connect_err_reported = false;
815     tcp_chr_new_client(chr, sioc);
816 
817 cleanup:
818     object_unref(OBJECT(sioc));
819 }
820 
821 static gboolean socket_reconnect_timeout(gpointer opaque)
822 {
823     Chardev *chr = CHARDEV(opaque);
824     SocketChardev *s = SOCKET_CHARDEV(opaque);
825     QIOChannelSocket *sioc;
826 
827     s->reconnect_timer = 0;
828 
829     if (chr->be_open) {
830         return false;
831     }
832 
833     sioc = qio_channel_socket_new();
834     tcp_chr_set_client_ioc_name(chr, sioc);
835     qio_channel_socket_connect_async(sioc, s->addr,
836                                      qemu_chr_socket_connected,
837                                      chr, NULL);
838 
839     return false;
840 }
841 
842 static void qmp_chardev_open_socket(Chardev *chr,
843                                     ChardevBackend *backend,
844                                     bool *be_opened,
845                                     Error **errp)
846 {
847     SocketChardev *s = SOCKET_CHARDEV(chr);
848     ChardevSocket *sock = backend->u.socket.data;
849     bool do_nodelay     = sock->has_nodelay ? sock->nodelay : false;
850     bool is_listen      = sock->has_server  ? sock->server  : true;
851     bool is_telnet      = sock->has_telnet  ? sock->telnet  : false;
852     bool is_tn3270      = sock->has_tn3270  ? sock->tn3270  : false;
853     bool is_waitconnect = sock->has_wait    ? sock->wait    : false;
854     int64_t reconnect   = sock->has_reconnect ? sock->reconnect : 0;
855     QIOChannelSocket *sioc = NULL;
856     SocketAddress *addr;
857 
858     s->is_listen = is_listen;
859     s->is_telnet = is_telnet;
860     s->is_tn3270 = is_tn3270;
861     s->do_nodelay = do_nodelay;
862     if (sock->tls_creds) {
863         Object *creds;
864         creds = object_resolve_path_component(
865             object_get_objects_root(), sock->tls_creds);
866         if (!creds) {
867             error_setg(errp, "No TLS credentials with id '%s'",
868                        sock->tls_creds);
869             goto error;
870         }
871         s->tls_creds = (QCryptoTLSCreds *)
872             object_dynamic_cast(creds,
873                                 TYPE_QCRYPTO_TLS_CREDS);
874         if (!s->tls_creds) {
875             error_setg(errp, "Object with id '%s' is not TLS credentials",
876                        sock->tls_creds);
877             goto error;
878         }
879         object_ref(OBJECT(s->tls_creds));
880         if (is_listen) {
881             if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
882                 error_setg(errp, "%s",
883                            "Expected TLS credentials for server endpoint");
884                 goto error;
885             }
886         } else {
887             if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
888                 error_setg(errp, "%s",
889                            "Expected TLS credentials for client endpoint");
890                 goto error;
891             }
892         }
893     }
894 
895     s->addr = addr = socket_address_flatten(sock->addr);
896 
897     qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
898     /* TODO SOCKET_ADDRESS_FD where fd has AF_UNIX */
899     if (addr->type == SOCKET_ADDRESS_TYPE_UNIX) {
900         qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
901     }
902 
903     /* be isn't opened until we get a connection */
904     *be_opened = false;
905 
906     update_disconnected_filename(s);
907 
908     if (is_listen) {
909         if (is_telnet || is_tn3270) {
910             s->do_telnetopt = 1;
911         }
912     } else if (reconnect > 0) {
913         s->reconnect_time = reconnect;
914     }
915 
916     if (s->reconnect_time) {
917         sioc = qio_channel_socket_new();
918         tcp_chr_set_client_ioc_name(chr, sioc);
919         qio_channel_socket_connect_async(sioc, s->addr,
920                                          qemu_chr_socket_connected,
921                                          chr, NULL);
922     } else {
923         if (s->is_listen) {
924             char *name;
925             s->listener = qio_net_listener_new();
926 
927             name = g_strdup_printf("chardev-tcp-listener-%s", chr->label);
928             qio_net_listener_set_name(s->listener, name);
929             g_free(name);
930 
931             if (qio_net_listener_open_sync(s->listener, s->addr, errp) < 0) {
932                 object_unref(OBJECT(s->listener));
933                 s->listener = NULL;
934                 goto error;
935             }
936 
937             qapi_free_SocketAddress(s->addr);
938             s->addr = socket_local_address(s->listener->sioc[0]->fd, errp);
939             update_disconnected_filename(s);
940 
941             if (is_waitconnect &&
942                 qemu_chr_wait_connected(chr, errp) < 0) {
943                 return;
944             }
945             if (!s->ioc) {
946                 qio_net_listener_set_client_func(s->listener, tcp_chr_accept,
947                                                  chr, NULL);
948             }
949         } else if (qemu_chr_wait_connected(chr, errp) < 0) {
950             goto error;
951         }
952     }
953 
954     return;
955 
956 error:
957     if (sioc) {
958         object_unref(OBJECT(sioc));
959     }
960 }
961 
962 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
963                                   Error **errp)
964 {
965     bool is_listen      = qemu_opt_get_bool(opts, "server", false);
966     bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
967     bool is_telnet      = qemu_opt_get_bool(opts, "telnet", false);
968     bool is_tn3270      = qemu_opt_get_bool(opts, "tn3270", false);
969     bool do_nodelay     = !qemu_opt_get_bool(opts, "delay", true);
970     int64_t reconnect   = qemu_opt_get_number(opts, "reconnect", 0);
971     const char *path = qemu_opt_get(opts, "path");
972     const char *host = qemu_opt_get(opts, "host");
973     const char *port = qemu_opt_get(opts, "port");
974     const char *tls_creds = qemu_opt_get(opts, "tls-creds");
975     SocketAddressLegacy *addr;
976     ChardevSocket *sock;
977 
978     backend->type = CHARDEV_BACKEND_KIND_SOCKET;
979     if (!path) {
980         if (!host) {
981             error_setg(errp, "chardev: socket: no host given");
982             return;
983         }
984         if (!port) {
985             error_setg(errp, "chardev: socket: no port given");
986             return;
987         }
988     } else {
989         if (tls_creds) {
990             error_setg(errp, "TLS can only be used over TCP socket");
991             return;
992         }
993     }
994 
995     sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
996     qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
997 
998     sock->has_nodelay = true;
999     sock->nodelay = do_nodelay;
1000     sock->has_server = true;
1001     sock->server = is_listen;
1002     sock->has_telnet = true;
1003     sock->telnet = is_telnet;
1004     sock->has_tn3270 = true;
1005     sock->tn3270 = is_tn3270;
1006     sock->has_wait = true;
1007     sock->wait = is_waitconnect;
1008     sock->has_reconnect = true;
1009     sock->reconnect = reconnect;
1010     sock->tls_creds = g_strdup(tls_creds);
1011 
1012     addr = g_new0(SocketAddressLegacy, 1);
1013     if (path) {
1014         UnixSocketAddress *q_unix;
1015         addr->type = SOCKET_ADDRESS_LEGACY_KIND_UNIX;
1016         q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
1017         q_unix->path = g_strdup(path);
1018     } else {
1019         addr->type = SOCKET_ADDRESS_LEGACY_KIND_INET;
1020         addr->u.inet.data = g_new(InetSocketAddress, 1);
1021         *addr->u.inet.data = (InetSocketAddress) {
1022             .host = g_strdup(host),
1023             .port = g_strdup(port),
1024             .has_to = qemu_opt_get(opts, "to"),
1025             .to = qemu_opt_get_number(opts, "to", 0),
1026             .has_ipv4 = qemu_opt_get(opts, "ipv4"),
1027             .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
1028             .has_ipv6 = qemu_opt_get(opts, "ipv6"),
1029             .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
1030         };
1031     }
1032     sock->addr = addr;
1033 }
1034 
1035 static void
1036 char_socket_get_addr(Object *obj, Visitor *v, const char *name,
1037                      void *opaque, Error **errp)
1038 {
1039     SocketChardev *s = SOCKET_CHARDEV(obj);
1040 
1041     visit_type_SocketAddress(v, name, &s->addr, errp);
1042 }
1043 
1044 static bool
1045 char_socket_get_connected(Object *obj, Error **errp)
1046 {
1047     SocketChardev *s = SOCKET_CHARDEV(obj);
1048 
1049     return s->connected;
1050 }
1051 
1052 static void char_socket_class_init(ObjectClass *oc, void *data)
1053 {
1054     ChardevClass *cc = CHARDEV_CLASS(oc);
1055 
1056     cc->parse = qemu_chr_parse_socket;
1057     cc->open = qmp_chardev_open_socket;
1058     cc->chr_wait_connected = tcp_chr_wait_connected;
1059     cc->chr_write = tcp_chr_write;
1060     cc->chr_sync_read = tcp_chr_sync_read;
1061     cc->chr_disconnect = tcp_chr_disconnect;
1062     cc->get_msgfds = tcp_get_msgfds;
1063     cc->set_msgfds = tcp_set_msgfds;
1064     cc->chr_add_client = tcp_chr_add_client;
1065     cc->chr_add_watch = tcp_chr_add_watch;
1066     cc->chr_update_read_handler = tcp_chr_update_read_handler;
1067 
1068     object_class_property_add(oc, "addr", "SocketAddress",
1069                               char_socket_get_addr, NULL,
1070                               NULL, NULL, &error_abort);
1071 
1072     object_class_property_add_bool(oc, "connected", char_socket_get_connected,
1073                                    NULL, &error_abort);
1074 }
1075 
1076 static const TypeInfo char_socket_type_info = {
1077     .name = TYPE_CHARDEV_SOCKET,
1078     .parent = TYPE_CHARDEV,
1079     .instance_size = sizeof(SocketChardev),
1080     .instance_finalize = char_socket_finalize,
1081     .class_init = char_socket_class_init,
1082 };
1083 
1084 static void register_types(void)
1085 {
1086     type_register_static(&char_socket_type_info);
1087 }
1088 
1089 type_init(register_types);
1090