chardev/char-socket.c

   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 "sysemu/char.h"
  26 #include "io/channel-socket.h"
  27 #include "io/channel-tls.h"
  28 #include "qemu/error-report.h"
  29 #include "qapi/error.h"
  30 #include "qapi/clone-visitor.h"
  31
  32 #include "char-io.h"
  33
  34 /***********************************************************/
  35 /* TCP Net console */
  36
  37 #define TCP_MAX_FDS 16
  38
  39 typedef struct {
  40     Chardev parent;
  41     QIOChannel *ioc; /* Client I/O channel */
  42     QIOChannelSocket *sioc; /* Client master channel */
  43     QIOChannelSocket *listen_ioc;
  44     guint listen_tag;
  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 gboolean tcp_chr_accept(QIOChannel *chan,
  97                                GIOCondition cond,
  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->connected) {
 336         return;
 337     }
 338
 339     if (s->read_msgfds_num) {
 340         for (i = 0; i < s->read_msgfds_num; i++) {
 341             close(s->read_msgfds[i]);
 342         }
 343         g_free(s->read_msgfds);
 344         s->read_msgfds = NULL;
 345         s->read_msgfds_num = 0;
 346     }
 347
 348     tcp_set_msgfds(chr, NULL, 0);
 349     remove_fd_in_watch(chr, NULL);
 350     object_unref(OBJECT(s->sioc));
 351     s->sioc = NULL;
 352     object_unref(OBJECT(s->ioc));
 353     s->ioc = NULL;
 354     g_free(chr->filename);
 355     chr->filename = NULL;
 356     s->connected = 0;
 357 }
 358
 359 static char *SocketAddress_to_str(const char *prefix, SocketAddress *addr,
 360                                   bool is_listen, bool is_telnet)
 361 {
 362     switch (addr->type) {
 363     case SOCKET_ADDRESS_KIND_INET:
 364         return g_strdup_printf("%s%s:%s:%s%s", prefix,
 365                                is_telnet ? "telnet" : "tcp",
 366                                addr->u.inet.data->host,
 367                                addr->u.inet.data->port,
 368                                is_listen ? ",server" : "");
 369         break;
 370     case SOCKET_ADDRESS_KIND_UNIX:
 371         return g_strdup_printf("%sunix:%s%s", prefix,
 372                                addr->u.q_unix.data->path,
 373                                is_listen ? ",server" : "");
 374         break;
 375     case SOCKET_ADDRESS_KIND_FD:
 376         return g_strdup_printf("%sfd:%s%s", prefix, addr->u.fd.data->str,
 377                                is_listen ? ",server" : "");
 378         break;
 379     case SOCKET_ADDRESS_KIND_VSOCK:
 380         return g_strdup_printf("%svsock:%s:%s", prefix,
 381                                addr->u.vsock.data->cid,
 382                                addr->u.vsock.data->port);
 383     default:
 384         abort();
 385     }
 386 }
 387
 388 static void tcp_chr_disconnect(Chardev *chr)
 389 {
 390     SocketChardev *s = SOCKET_CHARDEV(chr);
 391
 392     if (!s->connected) {
 393         return;
 394     }
 395
 396     tcp_chr_free_connection(chr);
 397
 398     if (s->listen_ioc) {
 399         s->listen_tag = qio_channel_add_watch(
 400             QIO_CHANNEL(s->listen_ioc), G_IO_IN, tcp_chr_accept, chr, NULL);
 401     }
 402     chr->filename = SocketAddress_to_str("disconnected:", s->addr,
 403                                          s->is_listen, s->is_telnet);
 404     qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
 405     if (s->reconnect_time) {
 406         qemu_chr_socket_restart_timer(chr);
 407     }
 408 }
 409
 410 static gboolean tcp_chr_read(QIOChannel *chan, GIOCondition cond, void *opaque)
 411 {
 412     Chardev *chr = CHARDEV(opaque);
 413     SocketChardev *s = SOCKET_CHARDEV(opaque);
 414     uint8_t buf[CHR_READ_BUF_LEN];
 415     int len, size;
 416
 417     if (!s->connected || s->max_size <= 0) {
 418         return TRUE;
 419     }
 420     len = sizeof(buf);
 421     if (len > s->max_size) {
 422         len = s->max_size;
 423     }
 424     size = tcp_chr_recv(chr, (void *)buf, len);
 425     if (size == 0 || size == -1) {
 426         /* connection closed */
 427         tcp_chr_disconnect(chr);
 428     } else if (size > 0) {
 429         if (s->do_telnetopt) {
 430             tcp_chr_process_IAC_bytes(chr, s, buf, &size);
 431         }
 432         if (size > 0) {
 433             qemu_chr_be_write(chr, buf, size);
 434         }
 435     }
 436
 437     return TRUE;
 438 }
 439
 440 static int tcp_chr_sync_read(Chardev *chr, const uint8_t *buf, int len)
 441 {
 442     SocketChardev *s = SOCKET_CHARDEV(chr);
 443     int size;
 444
 445     if (!s->connected) {
 446         return 0;
 447     }
 448
 449     size = tcp_chr_recv(chr, (void *) buf, len);
 450     if (size == 0) {
 451         /* connection closed */
 452         tcp_chr_disconnect(chr);
 453     }
 454
 455     return size;
 456 }
 457
 458 static char *sockaddr_to_str(struct sockaddr_storage *ss, socklen_t ss_len,
 459                              struct sockaddr_storage *ps, socklen_t ps_len,
 460                              bool is_listen, bool is_telnet)
 461 {
 462     char shost[NI_MAXHOST], sserv[NI_MAXSERV];
 463     char phost[NI_MAXHOST], pserv[NI_MAXSERV];
 464     const char *left = "", *right = "";
 465
 466     switch (ss->ss_family) {
 467 #ifndef _WIN32
 468     case AF_UNIX:
 469         return g_strdup_printf("unix:%s%s",
 470                                ((struct sockaddr_un *)(ss))->sun_path,
 471                                is_listen ? ",server" : "");
 472 #endif
 473     case AF_INET6:
 474         left  = "[";
 475         right = "]";
 476         /* fall through */
 477     case AF_INET:
 478         getnameinfo((struct sockaddr *) ss, ss_len, shost, sizeof(shost),
 479                     sserv, sizeof(sserv), NI_NUMERICHOST | NI_NUMERICSERV);
 480         getnameinfo((struct sockaddr *) ps, ps_len, phost, sizeof(phost),
 481                     pserv, sizeof(pserv), NI_NUMERICHOST | NI_NUMERICSERV);
 482         return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
 483                                is_telnet ? "telnet" : "tcp",
 484                                left, shost, right, sserv,
 485                                is_listen ? ",server" : "",
 486                                left, phost, right, pserv);
 487
 488     default:
 489         return g_strdup_printf("unknown");
 490     }
 491 }
 492
 493 static void tcp_chr_connect(void *opaque)
 494 {
 495     Chardev *chr = CHARDEV(opaque);
 496     SocketChardev *s = SOCKET_CHARDEV(opaque);
 497
 498     g_free(chr->filename);
 499     chr->filename = sockaddr_to_str(
 500         &s->sioc->localAddr, s->sioc->localAddrLen,
 501         &s->sioc->remoteAddr, s->sioc->remoteAddrLen,
 502         s->is_listen, s->is_telnet);
 503
 504     s->connected = 1;
 505     if (s->ioc) {
 506         chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
 507                                            tcp_chr_read_poll,
 508                                            tcp_chr_read,
 509                                            chr, NULL);
 510     }
 511     qemu_chr_be_generic_open(chr);
 512 }
 513
 514 static void tcp_chr_update_read_handler(Chardev *chr,
 515                                         GMainContext *context)
 516 {
 517     SocketChardev *s = SOCKET_CHARDEV(chr);
 518
 519     if (!s->connected) {
 520         return;
 521     }
 522
 523     remove_fd_in_watch(chr, NULL);
 524     if (s->ioc) {
 525         chr->fd_in_tag = io_add_watch_poll(chr, s->ioc,
 526                                            tcp_chr_read_poll,
 527                                            tcp_chr_read, chr,
 528                                            context);
 529     }
 530 }
 531
 532 typedef struct {
 533     Chardev *chr;
 534     char buf[21];
 535     size_t buflen;
 536 } TCPChardevTelnetInit;
 537
 538 static gboolean tcp_chr_telnet_init_io(QIOChannel *ioc,
 539                                        GIOCondition cond G_GNUC_UNUSED,
 540                                        gpointer user_data)
 541 {
 542     TCPChardevTelnetInit *init = user_data;
 543     ssize_t ret;
 544
 545     ret = qio_channel_write(ioc, init->buf, init->buflen, NULL);
 546     if (ret < 0) {
 547         if (ret == QIO_CHANNEL_ERR_BLOCK) {
 548             ret = 0;
 549         } else {
 550             tcp_chr_disconnect(init->chr);
 551             return FALSE;
 552         }
 553     }
 554     init->buflen -= ret;
 555
 556     if (init->buflen == 0) {
 557         tcp_chr_connect(init->chr);
 558         return FALSE;
 559     }
 560
 561     memmove(init->buf, init->buf + ret, init->buflen);
 562
 563     return TRUE;
 564 }
 565
 566 static void tcp_chr_telnet_init(Chardev *chr)
 567 {
 568     SocketChardev *s = SOCKET_CHARDEV(chr);
 569     TCPChardevTelnetInit *init = g_new0(TCPChardevTelnetInit, 1);
 570     size_t n = 0;
 571
 572 #define IACSET(x, a, b, c)                      \
 573     do {                                        \
 574         x[n++] = a;                             \
 575         x[n++] = b;                             \
 576         x[n++] = c;                             \
 577     } while (0)
 578
 579     init->chr = chr;
 580     if (!s->is_tn3270) {
 581         init->buflen = 12;
 582         /* Prep the telnet negotion to put telnet in binary,
 583          * no echo, single char mode */
 584         IACSET(init->buf, 0xff, 0xfb, 0x01);  /* IAC WILL ECHO */
 585         IACSET(init->buf, 0xff, 0xfb, 0x03);  /* IAC WILL Suppress go ahead */
 586         IACSET(init->buf, 0xff, 0xfb, 0x00);  /* IAC WILL Binary */
 587         IACSET(init->buf, 0xff, 0xfd, 0x00);  /* IAC DO Binary */
 588     } else {
 589         init->buflen = 21;
 590         /* Prep the TN3270 negotion based on RFC1576 */
 591         IACSET(init->buf, 0xff, 0xfd, 0x19);  /* IAC DO EOR */
 592         IACSET(init->buf, 0xff, 0xfb, 0x19);  /* IAC WILL EOR */
 593         IACSET(init->buf, 0xff, 0xfd, 0x00);  /* IAC DO BINARY */
 594         IACSET(init->buf, 0xff, 0xfb, 0x00);  /* IAC WILL BINARY */
 595         IACSET(init->buf, 0xff, 0xfd, 0x18);  /* IAC DO TERMINAL TYPE */
 596         IACSET(init->buf, 0xff, 0xfa, 0x18);  /* IAC SB TERMINAL TYPE */
 597         IACSET(init->buf, 0x01, 0xff, 0xf0);  /* SEND IAC SE */
 598     }
 599
 600 #undef IACSET
 601
 602     qio_channel_add_watch(
 603         s->ioc, G_IO_OUT,
 604         tcp_chr_telnet_init_io,
 605         init, NULL);
 606 }
 607
 608
 609 static void tcp_chr_tls_handshake(QIOTask *task,
 610                                   gpointer user_data)
 611 {
 612     Chardev *chr = user_data;
 613     SocketChardev *s = user_data;
 614
 615     if (qio_task_propagate_error(task, NULL)) {
 616         tcp_chr_disconnect(chr);
 617     } else {
 618         /* tn3270 does not support TLS yet */
 619         if (s->do_telnetopt && !s->is_tn3270) {
 620             tcp_chr_telnet_init(chr);
 621         } else {
 622             tcp_chr_connect(chr);
 623         }
 624     }
 625 }
 626
 627
 628 static void tcp_chr_tls_init(Chardev *chr)
 629 {
 630     SocketChardev *s = SOCKET_CHARDEV(chr);
 631     QIOChannelTLS *tioc;
 632     Error *err = NULL;
 633     gchar *name;
 634
 635     if (s->is_listen) {
 636         tioc = qio_channel_tls_new_server(
 637             s->ioc, s->tls_creds,
 638             NULL, /* XXX Use an ACL */
 639             &err);
 640     } else {
 641         tioc = qio_channel_tls_new_client(
 642             s->ioc, s->tls_creds,
 643             s->addr->u.inet.data->host,
 644             &err);
 645     }
 646     if (tioc == NULL) {
 647         error_free(err);
 648         tcp_chr_disconnect(chr);
 649         return;
 650     }
 651     name = g_strdup_printf("chardev-tls-%s-%s",
 652                            s->is_listen ? "server" : "client",
 653                            chr->label);
 654     qio_channel_set_name(QIO_CHANNEL(tioc), name);
 655     g_free(name);
 656     object_unref(OBJECT(s->ioc));
 657     s->ioc = QIO_CHANNEL(tioc);
 658
 659     qio_channel_tls_handshake(tioc,
 660                               tcp_chr_tls_handshake,
 661                               chr,
 662                               NULL);
 663 }
 664
 665
 666 static void tcp_chr_set_client_ioc_name(Chardev *chr,
 667                                         QIOChannelSocket *sioc)
 668 {
 669     SocketChardev *s = SOCKET_CHARDEV(chr);
 670     char *name;
 671     name = g_strdup_printf("chardev-tcp-%s-%s",
 672                            s->is_listen ? "server" : "client",
 673                            chr->label);
 674     qio_channel_set_name(QIO_CHANNEL(sioc), name);
 675     g_free(name);
 676
 677 }
 678
 679 static int tcp_chr_new_client(Chardev *chr, QIOChannelSocket *sioc)
 680 {
 681     SocketChardev *s = SOCKET_CHARDEV(chr);
 682
 683     if (s->ioc != NULL) {
 684         return -1;
 685     }
 686
 687     s->ioc = QIO_CHANNEL(sioc);
 688     object_ref(OBJECT(sioc));
 689     s->sioc = sioc;
 690     object_ref(OBJECT(sioc));
 691
 692     qio_channel_set_blocking(s->ioc, false, NULL);
 693
 694     if (s->do_nodelay) {
 695         qio_channel_set_delay(s->ioc, false);
 696     }
 697     if (s->listen_tag) {
 698         g_source_remove(s->listen_tag);
 699         s->listen_tag = 0;
 700     }
 701
 702     if (s->tls_creds) {
 703         tcp_chr_tls_init(chr);
 704     } else {
 705         if (s->do_telnetopt) {
 706             tcp_chr_telnet_init(chr);
 707         } else {
 708             tcp_chr_connect(chr);
 709         }
 710     }
 711
 712     return 0;
 713 }
 714
 715
 716 static int tcp_chr_add_client(Chardev *chr, int fd)
 717 {
 718     int ret;
 719     QIOChannelSocket *sioc;
 720
 721     sioc = qio_channel_socket_new_fd(fd, NULL);
 722     if (!sioc) {
 723         return -1;
 724     }
 725     tcp_chr_set_client_ioc_name(chr, sioc);
 726     ret = tcp_chr_new_client(chr, sioc);
 727     object_unref(OBJECT(sioc));
 728     return ret;
 729 }
 730
 731 static gboolean tcp_chr_accept(QIOChannel *channel,
 732                                GIOCondition cond,
 733                                void *opaque)
 734 {
 735     Chardev *chr = CHARDEV(opaque);
 736     QIOChannelSocket *sioc;
 737
 738     sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(channel),
 739                                      NULL);
 740     if (!sioc) {
 741         return TRUE;
 742     }
 743
 744     tcp_chr_new_client(chr, sioc);
 745
 746     object_unref(OBJECT(sioc));
 747
 748     return TRUE;
 749 }
 750
 751 static int tcp_chr_wait_connected(Chardev *chr, Error **errp)
 752 {
 753     SocketChardev *s = SOCKET_CHARDEV(chr);
 754     QIOChannelSocket *sioc;
 755
 756     /* It can't wait on s->connected, since it is set asynchronously
 757      * in TLS and telnet cases, only wait for an accepted socket */
 758     while (!s->ioc) {
 759         if (s->is_listen) {
 760             error_report("QEMU waiting for connection on: %s",
 761                          chr->filename);
 762             qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), true, NULL);
 763             tcp_chr_accept(QIO_CHANNEL(s->listen_ioc), G_IO_IN, chr);
 764             qio_channel_set_blocking(QIO_CHANNEL(s->listen_ioc), false, NULL);
 765         } else {
 766             sioc = qio_channel_socket_new();
 767             tcp_chr_set_client_ioc_name(chr, sioc);
 768             if (qio_channel_socket_connect_sync(sioc, s->addr, errp) < 0) {
 769                 object_unref(OBJECT(sioc));
 770                 return -1;
 771             }
 772             tcp_chr_new_client(chr, sioc);
 773             object_unref(OBJECT(sioc));
 774         }
 775     }
 776
 777     return 0;
 778 }
 779
 780 static void char_socket_finalize(Object *obj)
 781 {
 782     Chardev *chr = CHARDEV(obj);
 783     SocketChardev *s = SOCKET_CHARDEV(obj);
 784
 785     tcp_chr_free_connection(chr);
 786
 787     if (s->reconnect_timer) {
 788         g_source_remove(s->reconnect_timer);
 789         s->reconnect_timer = 0;
 790     }
 791     qapi_free_SocketAddress(s->addr);
 792     if (s->listen_tag) {
 793         g_source_remove(s->listen_tag);
 794         s->listen_tag = 0;
 795     }
 796     if (s->listen_ioc) {
 797         object_unref(OBJECT(s->listen_ioc));
 798     }
 799     if (s->tls_creds) {
 800         object_unref(OBJECT(s->tls_creds));
 801     }
 802
 803     qemu_chr_be_event(chr, CHR_EVENT_CLOSED);
 804 }
 805
 806 static void qemu_chr_socket_connected(QIOTask *task, void *opaque)
 807 {
 808     QIOChannelSocket *sioc = QIO_CHANNEL_SOCKET(qio_task_get_source(task));
 809     Chardev *chr = CHARDEV(opaque);
 810     SocketChardev *s = SOCKET_CHARDEV(chr);
 811     Error *err = NULL;
 812
 813     if (qio_task_propagate_error(task, &err)) {
 814         check_report_connect_error(chr, err);
 815         error_free(err);
 816         goto cleanup;
 817     }
 818
 819     s->connect_err_reported = false;
 820     tcp_chr_new_client(chr, sioc);
 821
 822 cleanup:
 823     object_unref(OBJECT(sioc));
 824 }
 825
 826 static gboolean socket_reconnect_timeout(gpointer opaque)
 827 {
 828     Chardev *chr = CHARDEV(opaque);
 829     SocketChardev *s = SOCKET_CHARDEV(opaque);
 830     QIOChannelSocket *sioc;
 831
 832     s->reconnect_timer = 0;
 833
 834     if (chr->be_open) {
 835         return false;
 836     }
 837
 838     sioc = qio_channel_socket_new();
 839     tcp_chr_set_client_ioc_name(chr, sioc);
 840     qio_channel_socket_connect_async(sioc, s->addr,
 841                                      qemu_chr_socket_connected,
 842                                      chr, NULL);
 843
 844     return false;
 845 }
 846
 847 static void qmp_chardev_open_socket(Chardev *chr,
 848                                     ChardevBackend *backend,
 849                                     bool *be_opened,
 850                                     Error **errp)
 851 {
 852     SocketChardev *s = SOCKET_CHARDEV(chr);
 853     ChardevSocket *sock = backend->u.socket.data;
 854     SocketAddress *addr = sock->addr;
 855     bool do_nodelay     = sock->has_nodelay ? sock->nodelay : false;
 856     bool is_listen      = sock->has_server  ? sock->server  : true;
 857     bool is_telnet      = sock->has_telnet  ? sock->telnet  : false;
 858     bool is_tn3270      = sock->has_tn3270  ? sock->tn3270  : false;
 859     bool is_waitconnect = sock->has_wait    ? sock->wait    : false;
 860     int64_t reconnect   = sock->has_reconnect ? sock->reconnect : 0;
 861     QIOChannelSocket *sioc = NULL;
 862
 863     s->is_listen = is_listen;
 864     s->is_telnet = is_telnet;
 865     s->is_tn3270 = is_tn3270;
 866     s->do_nodelay = do_nodelay;
 867     if (sock->tls_creds) {
 868         Object *creds;
 869         creds = object_resolve_path_component(
 870             object_get_objects_root(), sock->tls_creds);
 871         if (!creds) {
 872             error_setg(errp, "No TLS credentials with id '%s'",
 873                        sock->tls_creds);
 874             goto error;
 875         }
 876         s->tls_creds = (QCryptoTLSCreds *)
 877             object_dynamic_cast(creds,
 878                                 TYPE_QCRYPTO_TLS_CREDS);
 879         if (!s->tls_creds) {
 880             error_setg(errp, "Object with id '%s' is not TLS credentials",
 881                        sock->tls_creds);
 882             goto error;
 883         }
 884         object_ref(OBJECT(s->tls_creds));
 885         if (is_listen) {
 886             if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
 887                 error_setg(errp, "%s",
 888                            "Expected TLS credentials for server endpoint");
 889                 goto error;
 890             }
 891         } else {
 892             if (s->tls_creds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT) {
 893                 error_setg(errp, "%s",
 894                            "Expected TLS credentials for client endpoint");
 895                 goto error;
 896             }
 897         }
 898     }
 899
 900     s->addr = QAPI_CLONE(SocketAddress, sock->addr);
 901
 902     qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_RECONNECTABLE);
 903     /* TODO SOCKET_ADDRESS_FD where fd has AF_UNIX */
 904     if (addr->type == SOCKET_ADDRESS_KIND_UNIX) {
 905         qemu_chr_set_feature(chr, QEMU_CHAR_FEATURE_FD_PASS);
 906     }
 907
 908     /* be isn't opened until we get a connection */
 909     *be_opened = false;
 910
 911     chr->filename = SocketAddress_to_str("disconnected:",
 912                                          addr, is_listen, is_telnet);
 913
 914     if (is_listen) {
 915         if (is_telnet || is_tn3270) {
 916             s->do_telnetopt = 1;
 917         }
 918     } else if (reconnect > 0) {
 919         s->reconnect_time = reconnect;
 920     }
 921
 922     if (s->reconnect_time) {
 923         sioc = qio_channel_socket_new();
 924         tcp_chr_set_client_ioc_name(chr, sioc);
 925         qio_channel_socket_connect_async(sioc, s->addr,
 926                                          qemu_chr_socket_connected,
 927                                          chr, NULL);
 928     } else {
 929         if (s->is_listen) {
 930             char *name;
 931             sioc = qio_channel_socket_new();
 932
 933             name = g_strdup_printf("chardev-tcp-listener-%s", chr->label);
 934             qio_channel_set_name(QIO_CHANNEL(sioc), name);
 935             g_free(name);
 936
 937             if (qio_channel_socket_listen_sync(sioc, s->addr, errp) < 0) {
 938                 goto error;
 939             }
 940             s->listen_ioc = sioc;
 941             if (is_waitconnect &&
 942                 qemu_chr_wait_connected(chr, errp) < 0) {
 943                 return;
 944             }
 945             if (!s->ioc) {
 946                 s->listen_tag = qio_channel_add_watch(
 947                     QIO_CHANNEL(s->listen_ioc), G_IO_IN,
 948                     tcp_chr_accept, chr, NULL);
 949             }
 950         } else if (qemu_chr_wait_connected(chr, errp) < 0) {
 951             goto error;
 952         }
 953     }
 954
 955     return;
 956
 957 error:
 958     if (sioc) {
 959         object_unref(OBJECT(sioc));
 960     }
 961 }
 962
 963 static void qemu_chr_parse_socket(QemuOpts *opts, ChardevBackend *backend,
 964                                   Error **errp)
 965 {
 966     bool is_listen      = qemu_opt_get_bool(opts, "server", false);
 967     bool is_waitconnect = is_listen && qemu_opt_get_bool(opts, "wait", true);
 968     bool is_telnet      = qemu_opt_get_bool(opts, "telnet", false);
 969     bool is_tn3270      = qemu_opt_get_bool(opts, "tn3270", false);
 970     bool do_nodelay     = !qemu_opt_get_bool(opts, "delay", true);
 971     int64_t reconnect   = qemu_opt_get_number(opts, "reconnect", 0);
 972     const char *path = qemu_opt_get(opts, "path");
 973     const char *host = qemu_opt_get(opts, "host");
 974     const char *port = qemu_opt_get(opts, "port");
 975     const char *tls_creds = qemu_opt_get(opts, "tls-creds");
 976     SocketAddress *addr;
 977     ChardevSocket *sock;
 978
 979     backend->type = CHARDEV_BACKEND_KIND_SOCKET;
 980     if (!path) {
 981         if (!host) {
 982             error_setg(errp, "chardev: socket: no host given");
 983             return;
 984         }
 985         if (!port) {
 986             error_setg(errp, "chardev: socket: no port given");
 987             return;
 988         }
 989     } else {
 990         if (tls_creds) {
 991             error_setg(errp, "TLS can only be used over TCP socket");
 992             return;
 993         }
 994     }
 995
 996     sock = backend->u.socket.data = g_new0(ChardevSocket, 1);
 997     qemu_chr_parse_common(opts, qapi_ChardevSocket_base(sock));
 998
 999     sock->has_nodelay = true;
1000     sock->nodelay = do_nodelay;
1001     sock->has_server = true;
1002     sock->server = is_listen;
1003     sock->has_telnet = true;
1004     sock->telnet = is_telnet;
1005     sock->has_tn3270 = true;
1006     sock->tn3270 = is_tn3270;
1007     sock->has_wait = true;
1008     sock->wait = is_waitconnect;
1009     sock->has_reconnect = true;
1010     sock->reconnect = reconnect;
1011     sock->tls_creds = g_strdup(tls_creds);
1012
1013     addr = g_new0(SocketAddress, 1);
1014     if (path) {
1015         UnixSocketAddress *q_unix;
1016         addr->type = SOCKET_ADDRESS_KIND_UNIX;
1017         q_unix = addr->u.q_unix.data = g_new0(UnixSocketAddress, 1);
1018         q_unix->path = g_strdup(path);
1019     } else {
1020         addr->type = SOCKET_ADDRESS_KIND_INET;
1021         addr->u.inet.data = g_new(InetSocketAddress, 1);
1022         *addr->u.inet.data = (InetSocketAddress) {
1023             .host = g_strdup(host),
1024             .port = g_strdup(port),
1025             .has_to = qemu_opt_get(opts, "to"),
1026             .to = qemu_opt_get_number(opts, "to", 0),
1027             .has_ipv4 = qemu_opt_get(opts, "ipv4"),
1028             .ipv4 = qemu_opt_get_bool(opts, "ipv4", 0),
1029             .has_ipv6 = qemu_opt_get(opts, "ipv6"),
1030             .ipv6 = qemu_opt_get_bool(opts, "ipv6", 0),
1031         };
1032     }
1033     sock->addr = addr;
1034 }
1035
1036 static void char_socket_class_init(ObjectClass *oc, void *data)
1037 {
1038     ChardevClass *cc = CHARDEV_CLASS(oc);
1039
1040     cc->parse = qemu_chr_parse_socket;
1041     cc->open = qmp_chardev_open_socket;
1042     cc->chr_wait_connected = tcp_chr_wait_connected;
1043     cc->chr_write = tcp_chr_write;
1044     cc->chr_sync_read = tcp_chr_sync_read;
1045     cc->chr_disconnect = tcp_chr_disconnect;
1046     cc->get_msgfds = tcp_get_msgfds;
1047     cc->set_msgfds = tcp_set_msgfds;
1048     cc->chr_add_client = tcp_chr_add_client;
1049     cc->chr_add_watch = tcp_chr_add_watch;
1050     cc->chr_update_read_handler = tcp_chr_update_read_handler;
1051 }
1052
1053 static const TypeInfo char_socket_type_info = {
1054     .name = TYPE_CHARDEV_SOCKET,
1055     .parent = TYPE_CHARDEV,
1056     .instance_size = sizeof(SocketChardev),
1057     .instance_finalize = char_socket_finalize,
1058     .class_init = char_socket_class_init,
1059 };
1060
1061 static void register_types(void)
1062 {
1063     type_register_static(&char_socket_type_info);
1064 }
1065
1066 type_init(register_types);