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