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