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