4 * Copyright (c) 2003-2008 Fabrice Bellard
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
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/channel-websock.h"
30 #include "io/net-listener.h"
31 #include "qemu/error-report.h"
32 #include "qemu/module.h"
33 #include "qemu/option.h"
34 #include "qapi/error.h"
35 #include "qapi/clone-visitor.h"
36 #include "qapi/qapi-visit-sockets.h"
38 #include "chardev/char-io.h"
39 #include "qom/object.h"
41 /***********************************************************/
44 #define TCP_MAX_FDS 16
49 } TCPChardevTelnetInit
;
52 TCP_CHARDEV_STATE_DISCONNECTED
,
53 TCP_CHARDEV_STATE_CONNECTING
,
54 TCP_CHARDEV_STATE_CONNECTED
,
57 struct SocketChardev
{
59 QIOChannel
*ioc
; /* Client I/O channel */
60 QIOChannelSocket
*sioc
; /* Client master channel */
61 QIONetListener
*listener
;
63 QCryptoTLSCreds
*tls_creds
;
65 TCPChardevState state
;
70 size_t read_msgfds_num
;
72 size_t write_msgfds_num
;
78 GSource
*telnet_source
;
79 TCPChardevTelnetInit
*telnet_init
;
83 GSource
*reconnect_timer
;
84 int64_t reconnect_time
;
85 bool connect_err_reported
;
87 QIOTask
*connect_task
;
89 typedef struct SocketChardev SocketChardev
;
91 DECLARE_INSTANCE_CHECKER(SocketChardev
, SOCKET_CHARDEV
,
94 static gboolean
socket_reconnect_timeout(gpointer opaque
);
95 static void tcp_chr_telnet_init(Chardev
*chr
);
97 static void tcp_chr_change_state(SocketChardev
*s
, TCPChardevState state
)
100 case TCP_CHARDEV_STATE_DISCONNECTED
:
102 case TCP_CHARDEV_STATE_CONNECTING
:
103 assert(s
->state
== TCP_CHARDEV_STATE_DISCONNECTED
);
105 case TCP_CHARDEV_STATE_CONNECTED
:
106 assert(s
->state
== TCP_CHARDEV_STATE_CONNECTING
);
112 static void tcp_chr_reconn_timer_cancel(SocketChardev
*s
)
114 if (s
->reconnect_timer
) {
115 g_source_destroy(s
->reconnect_timer
);
116 g_source_unref(s
->reconnect_timer
);
117 s
->reconnect_timer
= NULL
;
121 static void qemu_chr_socket_restart_timer(Chardev
*chr
)
123 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
126 assert(s
->state
== TCP_CHARDEV_STATE_DISCONNECTED
);
127 assert(!s
->reconnect_timer
);
128 name
= g_strdup_printf("chardev-socket-reconnect-%s", chr
->label
);
129 s
->reconnect_timer
= qemu_chr_timeout_add_ms(chr
,
130 s
->reconnect_time
* 1000,
131 socket_reconnect_timeout
,
133 g_source_set_name(s
->reconnect_timer
, name
);
137 static void check_report_connect_error(Chardev
*chr
,
140 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
142 if (!s
->connect_err_reported
) {
143 error_reportf_err(err
,
144 "Unable to connect character device %s: ",
146 s
->connect_err_reported
= true;
150 qemu_chr_socket_restart_timer(chr
);
153 static void tcp_chr_accept(QIONetListener
*listener
,
154 QIOChannelSocket
*cioc
,
157 static int tcp_chr_read_poll(void *opaque
);
158 static void tcp_chr_disconnect_locked(Chardev
*chr
);
160 /* Called with chr_write_lock held. */
161 static int tcp_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
163 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
165 if (s
->state
== TCP_CHARDEV_STATE_CONNECTED
) {
166 int ret
= io_channel_send_full(s
->ioc
, buf
, len
,
168 s
->write_msgfds_num
);
170 /* free the written msgfds in any cases
171 * other than ret < 0 && errno == EAGAIN
173 if (!(ret
< 0 && EAGAIN
== errno
)
174 && s
->write_msgfds_num
) {
175 g_free(s
->write_msgfds
);
177 s
->write_msgfds_num
= 0;
180 if (ret
< 0 && errno
!= EAGAIN
) {
181 if (tcp_chr_read_poll(chr
) <= 0) {
182 /* Perform disconnect and return error. */
183 tcp_chr_disconnect_locked(chr
);
184 } /* else let the read handler finish it properly */
189 /* Indicate an error. */
195 static int tcp_chr_read_poll(void *opaque
)
197 Chardev
*chr
= CHARDEV(opaque
);
198 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
199 if (s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) {
202 s
->max_size
= qemu_chr_be_can_write(chr
);
206 static void tcp_chr_process_IAC_bytes(Chardev
*chr
,
208 uint8_t *buf
, int *size
)
210 /* Handle any telnet or tn3270 client's basic IAC options.
211 * For telnet options, it satisfies char by char mode with no echo.
212 * For tn3270 options, it satisfies binary mode with EOR.
213 * All IAC options will be removed from the buf and the do_opt
214 * pointer will be used to track the state of the width of the
217 * RFC854: "All TELNET commands consist of at least a two byte sequence.
218 * The commands dealing with option negotiation are three byte sequences,
219 * the third byte being the code for the option referenced."
220 * "IAC BREAK", "IAC IP", "IAC NOP" and the double IAC are two bytes.
221 * "IAC SB", "IAC SE" and "IAC EOR" are saved to split up data boundary
223 * NOP, Break and Interrupt Process(IP) might be encountered during a TN3270
224 * session, and NOP and IP need to be done later.
230 for (i
= 0; i
< *size
; i
++) {
231 if (s
->do_telnetopt
> 1) {
232 if ((unsigned char)buf
[i
] == IAC
&& s
->do_telnetopt
== 2) {
233 /* Double IAC means send an IAC */
240 if ((unsigned char)buf
[i
] == IAC_BREAK
241 && s
->do_telnetopt
== 2) {
242 /* Handle IAC break commands by sending a serial break */
243 qemu_chr_be_event(chr
, CHR_EVENT_BREAK
);
245 } else if (s
->is_tn3270
&& ((unsigned char)buf
[i
] == IAC_EOR
246 || (unsigned char)buf
[i
] == IAC_SB
247 || (unsigned char)buf
[i
] == IAC_SE
)
248 && s
->do_telnetopt
== 2) {
252 } else if (s
->is_tn3270
&& ((unsigned char)buf
[i
] == IAC_IP
253 || (unsigned char)buf
[i
] == IAC_NOP
)
254 && s
->do_telnetopt
== 2) {
255 /* TODO: IP and NOP need to be implemented later. */
260 if (s
->do_telnetopt
>= 4) {
264 if ((unsigned char)buf
[i
] == IAC
) {
277 static int tcp_get_msgfds(Chardev
*chr
, int *fds
, int num
)
279 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
281 int to_copy
= (s
->read_msgfds_num
< num
) ? s
->read_msgfds_num
: num
;
283 assert(num
<= TCP_MAX_FDS
);
288 memcpy(fds
, s
->read_msgfds
, to_copy
* sizeof(int));
290 /* Close unused fds */
291 for (i
= to_copy
; i
< s
->read_msgfds_num
; i
++) {
292 close(s
->read_msgfds
[i
]);
295 g_free(s
->read_msgfds
);
297 s
->read_msgfds_num
= 0;
303 static int tcp_set_msgfds(Chardev
*chr
, int *fds
, int num
)
305 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
307 /* clear old pending fd array */
308 g_free(s
->write_msgfds
);
309 s
->write_msgfds
= NULL
;
310 s
->write_msgfds_num
= 0;
312 if ((s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) ||
313 !qio_channel_has_feature(s
->ioc
,
314 QIO_CHANNEL_FEATURE_FD_PASS
)) {
319 s
->write_msgfds
= g_new(int, num
);
320 memcpy(s
->write_msgfds
, fds
, num
* sizeof(int));
323 s
->write_msgfds_num
= num
;
328 static ssize_t
tcp_chr_recv(Chardev
*chr
, char *buf
, size_t len
)
330 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
331 struct iovec iov
= { .iov_base
= buf
, .iov_len
= len
};
335 size_t msgfds_num
= 0;
337 if (qio_channel_has_feature(s
->ioc
, QIO_CHANNEL_FEATURE_FD_PASS
)) {
338 ret
= qio_channel_readv_full(s
->ioc
, &iov
, 1,
339 &msgfds
, &msgfds_num
,
342 ret
= qio_channel_readv_full(s
->ioc
, &iov
, 1,
347 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
350 } else if (ret
== -1) {
355 /* close and clean read_msgfds */
356 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
357 close(s
->read_msgfds
[i
]);
360 if (s
->read_msgfds_num
) {
361 g_free(s
->read_msgfds
);
364 s
->read_msgfds
= msgfds
;
365 s
->read_msgfds_num
= msgfds_num
;
368 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
369 int fd
= s
->read_msgfds
[i
];
374 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
377 #ifndef MSG_CMSG_CLOEXEC
378 qemu_set_cloexec(fd
);
385 static GSource
*tcp_chr_add_watch(Chardev
*chr
, GIOCondition cond
)
387 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
388 return qio_channel_create_watch(s
->ioc
, cond
);
391 static void remove_hup_source(SocketChardev
*s
)
393 if (s
->hup_source
!= NULL
) {
394 g_source_destroy(s
->hup_source
);
395 g_source_unref(s
->hup_source
);
396 s
->hup_source
= NULL
;
400 static void tcp_chr_free_connection(Chardev
*chr
)
402 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
405 if (s
->read_msgfds_num
) {
406 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
407 close(s
->read_msgfds
[i
]);
409 g_free(s
->read_msgfds
);
410 s
->read_msgfds
= NULL
;
411 s
->read_msgfds_num
= 0;
414 remove_hup_source(s
);
416 tcp_set_msgfds(chr
, NULL
, 0);
417 remove_fd_in_watch(chr
);
418 object_unref(OBJECT(s
->sioc
));
420 object_unref(OBJECT(s
->ioc
));
422 g_free(chr
->filename
);
423 chr
->filename
= NULL
;
424 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_DISCONNECTED
);
427 static const char *qemu_chr_socket_protocol(SocketChardev
*s
)
432 return s
->is_websock
? "websocket" : "tcp";
435 static char *qemu_chr_socket_address(SocketChardev
*s
, const char *prefix
)
437 switch (s
->addr
->type
) {
438 case SOCKET_ADDRESS_TYPE_INET
:
439 return g_strdup_printf("%s%s:%s:%s%s", prefix
,
440 qemu_chr_socket_protocol(s
),
441 s
->addr
->u
.inet
.host
,
442 s
->addr
->u
.inet
.port
,
443 s
->is_listen
? ",server" : "");
445 case SOCKET_ADDRESS_TYPE_UNIX
:
446 return g_strdup_printf("%sunix:%s%s", prefix
,
447 s
->addr
->u
.q_unix
.path
,
448 s
->is_listen
? ",server" : "");
450 case SOCKET_ADDRESS_TYPE_FD
:
451 return g_strdup_printf("%sfd:%s%s", prefix
, s
->addr
->u
.fd
.str
,
452 s
->is_listen
? ",server" : "");
454 case SOCKET_ADDRESS_TYPE_VSOCK
:
455 return g_strdup_printf("%svsock:%s:%s", prefix
,
456 s
->addr
->u
.vsock
.cid
,
457 s
->addr
->u
.vsock
.port
);
463 static void update_disconnected_filename(SocketChardev
*s
)
465 Chardev
*chr
= CHARDEV(s
);
467 g_free(chr
->filename
);
469 chr
->filename
= qemu_chr_socket_address(s
, "disconnected:");
471 chr
->filename
= g_strdup("disconnected:socket");
475 /* NB may be called even if tcp_chr_connect has not been
476 * reached, due to TLS or telnet initialization failure,
477 * so can *not* assume s->state == TCP_CHARDEV_STATE_CONNECTED
478 * This must be called with chr->chr_write_lock held.
480 static void tcp_chr_disconnect_locked(Chardev
*chr
)
482 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
483 bool emit_close
= s
->state
== TCP_CHARDEV_STATE_CONNECTED
;
485 tcp_chr_free_connection(chr
);
488 qio_net_listener_set_client_func_full(s
->listener
, tcp_chr_accept
,
489 chr
, NULL
, chr
->gcontext
);
491 update_disconnected_filename(s
);
493 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
495 if (s
->reconnect_time
&& !s
->reconnect_timer
) {
496 qemu_chr_socket_restart_timer(chr
);
500 static void tcp_chr_disconnect(Chardev
*chr
)
502 qemu_mutex_lock(&chr
->chr_write_lock
);
503 tcp_chr_disconnect_locked(chr
);
504 qemu_mutex_unlock(&chr
->chr_write_lock
);
507 static gboolean
tcp_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
509 Chardev
*chr
= CHARDEV(opaque
);
510 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
511 uint8_t buf
[CHR_READ_BUF_LEN
];
514 if ((s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) ||
519 if (len
> s
->max_size
) {
522 size
= tcp_chr_recv(chr
, (void *)buf
, len
);
523 if (size
== 0 || (size
== -1 && errno
!= EAGAIN
)) {
524 /* connection closed */
525 tcp_chr_disconnect(chr
);
526 } else if (size
> 0) {
527 if (s
->do_telnetopt
) {
528 tcp_chr_process_IAC_bytes(chr
, s
, buf
, &size
);
531 qemu_chr_be_write(chr
, buf
, size
);
538 static gboolean
tcp_chr_hup(QIOChannel
*channel
,
542 Chardev
*chr
= CHARDEV(opaque
);
543 tcp_chr_disconnect(chr
);
544 return G_SOURCE_REMOVE
;
547 static int tcp_chr_sync_read(Chardev
*chr
, const uint8_t *buf
, int len
)
549 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
552 if (s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) {
556 qio_channel_set_blocking(s
->ioc
, true, NULL
);
557 size
= tcp_chr_recv(chr
, (void *) buf
, len
);
558 if (s
->state
!= TCP_CHARDEV_STATE_DISCONNECTED
) {
559 qio_channel_set_blocking(s
->ioc
, false, NULL
);
562 /* connection closed */
563 tcp_chr_disconnect(chr
);
569 static char *qemu_chr_compute_filename(SocketChardev
*s
)
571 struct sockaddr_storage
*ss
= &s
->sioc
->localAddr
;
572 struct sockaddr_storage
*ps
= &s
->sioc
->remoteAddr
;
573 socklen_t ss_len
= s
->sioc
->localAddrLen
;
574 socklen_t ps_len
= s
->sioc
->remoteAddrLen
;
575 char shost
[NI_MAXHOST
], sserv
[NI_MAXSERV
];
576 char phost
[NI_MAXHOST
], pserv
[NI_MAXSERV
];
577 const char *left
= "", *right
= "";
579 switch (ss
->ss_family
) {
582 return g_strdup_printf("unix:%s%s",
583 ((struct sockaddr_un
*)(ss
))->sun_path
,
584 s
->is_listen
? ",server" : "");
591 getnameinfo((struct sockaddr
*) ss
, ss_len
, shost
, sizeof(shost
),
592 sserv
, sizeof(sserv
), NI_NUMERICHOST
| NI_NUMERICSERV
);
593 getnameinfo((struct sockaddr
*) ps
, ps_len
, phost
, sizeof(phost
),
594 pserv
, sizeof(pserv
), NI_NUMERICHOST
| NI_NUMERICSERV
);
595 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
596 qemu_chr_socket_protocol(s
),
597 left
, shost
, right
, sserv
,
598 s
->is_listen
? ",server" : "",
599 left
, phost
, right
, pserv
);
602 return g_strdup_printf("unknown");
606 static void update_ioc_handlers(SocketChardev
*s
)
608 Chardev
*chr
= CHARDEV(s
);
610 if (s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) {
614 remove_fd_in_watch(chr
);
615 chr
->gsource
= io_add_watch_poll(chr
, s
->ioc
,
620 remove_hup_source(s
);
621 s
->hup_source
= qio_channel_create_watch(s
->ioc
, G_IO_HUP
);
622 g_source_set_callback(s
->hup_source
, (GSourceFunc
)tcp_chr_hup
,
624 g_source_attach(s
->hup_source
, chr
->gcontext
);
627 static void tcp_chr_connect(void *opaque
)
629 Chardev
*chr
= CHARDEV(opaque
);
630 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
632 g_free(chr
->filename
);
633 chr
->filename
= qemu_chr_compute_filename(s
);
635 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTED
);
636 update_ioc_handlers(s
);
637 qemu_chr_be_event(chr
, CHR_EVENT_OPENED
);
640 static void tcp_chr_telnet_destroy(SocketChardev
*s
)
642 if (s
->telnet_source
) {
643 g_source_destroy(s
->telnet_source
);
644 g_source_unref(s
->telnet_source
);
645 s
->telnet_source
= NULL
;
649 static void tcp_chr_update_read_handler(Chardev
*chr
)
651 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
653 if (s
->listener
&& s
->state
== TCP_CHARDEV_STATE_DISCONNECTED
) {
655 * It's possible that chardev context is changed in
656 * qemu_chr_be_update_read_handlers(). Reset it for QIO net
657 * listener if there is.
659 qio_net_listener_set_client_func_full(s
->listener
, tcp_chr_accept
,
660 chr
, NULL
, chr
->gcontext
);
663 if (s
->telnet_source
) {
664 tcp_chr_telnet_init(CHARDEV(s
));
667 update_ioc_handlers(s
);
670 static gboolean
tcp_chr_telnet_init_io(QIOChannel
*ioc
,
671 GIOCondition cond G_GNUC_UNUSED
,
674 SocketChardev
*s
= user_data
;
675 Chardev
*chr
= CHARDEV(s
);
676 TCPChardevTelnetInit
*init
= s
->telnet_init
;
681 ret
= qio_channel_write(ioc
, init
->buf
, init
->buflen
, NULL
);
683 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
686 tcp_chr_disconnect(chr
);
692 if (init
->buflen
== 0) {
693 tcp_chr_connect(chr
);
697 memmove(init
->buf
, init
->buf
+ ret
, init
->buflen
);
699 return G_SOURCE_CONTINUE
;
702 g_free(s
->telnet_init
);
703 s
->telnet_init
= NULL
;
704 g_source_unref(s
->telnet_source
);
705 s
->telnet_source
= NULL
;
706 return G_SOURCE_REMOVE
;
709 static void tcp_chr_telnet_init(Chardev
*chr
)
711 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
712 TCPChardevTelnetInit
*init
;
715 /* Destroy existing task */
716 tcp_chr_telnet_destroy(s
);
718 if (s
->telnet_init
) {
719 /* We are possibly during a handshake already */
723 s
->telnet_init
= g_new0(TCPChardevTelnetInit
, 1);
724 init
= s
->telnet_init
;
726 #define IACSET(x, a, b, c) \
735 /* Prep the telnet negotion to put telnet in binary,
736 * no echo, single char mode */
737 IACSET(init
->buf
, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
738 IACSET(init
->buf
, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
739 IACSET(init
->buf
, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
740 IACSET(init
->buf
, 0xff, 0xfd, 0x00); /* IAC DO Binary */
743 /* Prep the TN3270 negotion based on RFC1576 */
744 IACSET(init
->buf
, 0xff, 0xfd, 0x19); /* IAC DO EOR */
745 IACSET(init
->buf
, 0xff, 0xfb, 0x19); /* IAC WILL EOR */
746 IACSET(init
->buf
, 0xff, 0xfd, 0x00); /* IAC DO BINARY */
747 IACSET(init
->buf
, 0xff, 0xfb, 0x00); /* IAC WILL BINARY */
748 IACSET(init
->buf
, 0xff, 0xfd, 0x18); /* IAC DO TERMINAL TYPE */
749 IACSET(init
->buf
, 0xff, 0xfa, 0x18); /* IAC SB TERMINAL TYPE */
750 IACSET(init
->buf
, 0x01, 0xff, 0xf0); /* SEND IAC SE */
756 s
->telnet_source
= qio_channel_add_watch_source(s
->ioc
, G_IO_OUT
,
757 tcp_chr_telnet_init_io
,
763 static void tcp_chr_websock_handshake(QIOTask
*task
, gpointer user_data
)
765 Chardev
*chr
= user_data
;
766 SocketChardev
*s
= user_data
;
768 if (qio_task_propagate_error(task
, NULL
)) {
769 tcp_chr_disconnect(chr
);
771 if (s
->do_telnetopt
) {
772 tcp_chr_telnet_init(chr
);
774 tcp_chr_connect(chr
);
780 static void tcp_chr_websock_init(Chardev
*chr
)
782 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
783 QIOChannelWebsock
*wioc
= NULL
;
786 wioc
= qio_channel_websock_new_server(s
->ioc
);
788 name
= g_strdup_printf("chardev-websocket-server-%s", chr
->label
);
789 qio_channel_set_name(QIO_CHANNEL(wioc
), name
);
791 object_unref(OBJECT(s
->ioc
));
792 s
->ioc
= QIO_CHANNEL(wioc
);
794 qio_channel_websock_handshake(wioc
, tcp_chr_websock_handshake
, chr
, NULL
);
798 static void tcp_chr_tls_handshake(QIOTask
*task
,
801 Chardev
*chr
= user_data
;
802 SocketChardev
*s
= user_data
;
804 if (qio_task_propagate_error(task
, NULL
)) {
805 tcp_chr_disconnect(chr
);
808 tcp_chr_websock_init(chr
);
809 } else if (s
->do_telnetopt
) {
810 tcp_chr_telnet_init(chr
);
812 tcp_chr_connect(chr
);
818 static void tcp_chr_tls_init(Chardev
*chr
)
820 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
825 tioc
= qio_channel_tls_new_server(
826 s
->ioc
, s
->tls_creds
,
830 tioc
= qio_channel_tls_new_client(
831 s
->ioc
, s
->tls_creds
,
832 s
->addr
->u
.inet
.host
,
836 tcp_chr_disconnect(chr
);
839 name
= g_strdup_printf("chardev-tls-%s-%s",
840 s
->is_listen
? "server" : "client",
842 qio_channel_set_name(QIO_CHANNEL(tioc
), name
);
844 object_unref(OBJECT(s
->ioc
));
845 s
->ioc
= QIO_CHANNEL(tioc
);
847 qio_channel_tls_handshake(tioc
,
848 tcp_chr_tls_handshake
,
855 static void tcp_chr_set_client_ioc_name(Chardev
*chr
,
856 QIOChannelSocket
*sioc
)
858 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
860 name
= g_strdup_printf("chardev-tcp-%s-%s",
861 s
->is_listen
? "server" : "client",
863 qio_channel_set_name(QIO_CHANNEL(sioc
), name
);
868 static int tcp_chr_new_client(Chardev
*chr
, QIOChannelSocket
*sioc
)
870 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
872 if (s
->state
!= TCP_CHARDEV_STATE_CONNECTING
) {
876 s
->ioc
= QIO_CHANNEL(sioc
);
877 object_ref(OBJECT(sioc
));
879 object_ref(OBJECT(sioc
));
881 qio_channel_set_blocking(s
->ioc
, false, NULL
);
884 qio_channel_set_delay(s
->ioc
, false);
887 qio_net_listener_set_client_func_full(s
->listener
, NULL
, NULL
,
888 NULL
, chr
->gcontext
);
892 tcp_chr_tls_init(chr
);
893 } else if (s
->is_websock
) {
894 tcp_chr_websock_init(chr
);
895 } else if (s
->do_telnetopt
) {
896 tcp_chr_telnet_init(chr
);
898 tcp_chr_connect(chr
);
905 static int tcp_chr_add_client(Chardev
*chr
, int fd
)
908 QIOChannelSocket
*sioc
;
909 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
911 if (s
->state
!= TCP_CHARDEV_STATE_DISCONNECTED
) {
915 sioc
= qio_channel_socket_new_fd(fd
, NULL
);
919 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
920 tcp_chr_set_client_ioc_name(chr
, sioc
);
921 ret
= tcp_chr_new_client(chr
, sioc
);
922 object_unref(OBJECT(sioc
));
926 static void tcp_chr_accept(QIONetListener
*listener
,
927 QIOChannelSocket
*cioc
,
930 Chardev
*chr
= CHARDEV(opaque
);
931 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
933 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
934 tcp_chr_set_client_ioc_name(chr
, cioc
);
935 tcp_chr_new_client(chr
, cioc
);
939 static int tcp_chr_connect_client_sync(Chardev
*chr
, Error
**errp
)
941 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
942 QIOChannelSocket
*sioc
= qio_channel_socket_new();
943 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
944 tcp_chr_set_client_ioc_name(chr
, sioc
);
945 if (qio_channel_socket_connect_sync(sioc
, s
->addr
, errp
) < 0) {
946 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_DISCONNECTED
);
947 object_unref(OBJECT(sioc
));
950 tcp_chr_new_client(chr
, sioc
);
951 object_unref(OBJECT(sioc
));
956 static void tcp_chr_accept_server_sync(Chardev
*chr
)
958 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
959 QIOChannelSocket
*sioc
;
960 info_report("QEMU waiting for connection on: %s",
962 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
963 sioc
= qio_net_listener_wait_client(s
->listener
);
964 tcp_chr_set_client_ioc_name(chr
, sioc
);
965 tcp_chr_new_client(chr
, sioc
);
966 object_unref(OBJECT(sioc
));
970 static int tcp_chr_wait_connected(Chardev
*chr
, Error
**errp
)
972 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
973 const char *opts
[] = { "telnet", "tn3270", "websock", "tls-creds" };
974 bool optset
[] = { s
->is_telnet
, s
->is_tn3270
, s
->is_websock
, s
->tls_creds
};
977 QEMU_BUILD_BUG_ON(G_N_ELEMENTS(opts
) != G_N_ELEMENTS(optset
));
978 for (i
= 0; i
< G_N_ELEMENTS(opts
); i
++) {
981 "'%s' option is incompatible with waiting for "
982 "connection completion", opts
[i
]);
987 tcp_chr_reconn_timer_cancel(s
);
990 * We expect states to be as follows:
993 * - wait -> CONNECTED
994 * - nowait -> DISCONNECTED
996 * - reconnect == 0 -> CONNECTED
997 * - reconnect != 0 -> CONNECTING
1000 if (s
->state
== TCP_CHARDEV_STATE_CONNECTING
) {
1001 if (!s
->connect_task
) {
1003 "Unexpected 'connecting' state without connect task "
1004 "while waiting for connection completion");
1008 * tcp_chr_wait_connected should only ever be run from the
1009 * main loop thread associated with chr->gcontext, otherwise
1010 * qio_task_wait_thread has a dangerous race condition with
1011 * free'ing of the s->connect_task object.
1013 * Acquiring the main context doesn't 100% prove we're in
1014 * the main loop thread, but it does at least guarantee
1015 * that the main loop won't be executed by another thread
1016 * avoiding the race condition with the task idle callback.
1018 g_main_context_acquire(chr
->gcontext
);
1019 qio_task_wait_thread(s
->connect_task
);
1020 g_main_context_release(chr
->gcontext
);
1023 * The completion callback (qemu_chr_socket_connected) for
1024 * s->connect_task should have set this to NULL by the time
1025 * qio_task_wait_thread has returned.
1027 assert(!s
->connect_task
);
1030 * NB we are *not* guaranteed to have "s->state == ..CONNECTED"
1031 * at this point as this first connect may be failed, so
1032 * allow the next loop to run regardless.
1036 while (s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) {
1038 tcp_chr_accept_server_sync(chr
);
1041 if (tcp_chr_connect_client_sync(chr
, &err
) < 0) {
1042 if (s
->reconnect_time
) {
1044 g_usleep(s
->reconnect_time
* 1000ULL * 1000ULL);
1046 error_propagate(errp
, err
);
1056 static void char_socket_finalize(Object
*obj
)
1058 Chardev
*chr
= CHARDEV(obj
);
1059 SocketChardev
*s
= SOCKET_CHARDEV(obj
);
1061 tcp_chr_free_connection(chr
);
1062 tcp_chr_reconn_timer_cancel(s
);
1063 qapi_free_SocketAddress(s
->addr
);
1064 tcp_chr_telnet_destroy(s
);
1065 g_free(s
->telnet_init
);
1067 qio_net_listener_set_client_func_full(s
->listener
, NULL
, NULL
,
1068 NULL
, chr
->gcontext
);
1069 object_unref(OBJECT(s
->listener
));
1072 object_unref(OBJECT(s
->tls_creds
));
1074 g_free(s
->tls_authz
);
1076 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1079 static void qemu_chr_socket_connected(QIOTask
*task
, void *opaque
)
1081 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
1082 Chardev
*chr
= CHARDEV(opaque
);
1083 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1086 s
->connect_task
= NULL
;
1088 if (qio_task_propagate_error(task
, &err
)) {
1089 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_DISCONNECTED
);
1090 check_report_connect_error(chr
, err
);
1094 s
->connect_err_reported
= false;
1095 tcp_chr_new_client(chr
, sioc
);
1098 object_unref(OBJECT(sioc
));
1102 static void tcp_chr_connect_client_task(QIOTask
*task
,
1105 QIOChannelSocket
*ioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
1106 SocketAddress
*addr
= opaque
;
1109 qio_channel_socket_connect_sync(ioc
, addr
, &err
);
1111 qio_task_set_error(task
, err
);
1115 static void tcp_chr_connect_client_async(Chardev
*chr
)
1117 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1118 QIOChannelSocket
*sioc
;
1120 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
1121 sioc
= qio_channel_socket_new();
1122 tcp_chr_set_client_ioc_name(chr
, sioc
);
1124 * Normally code would use the qio_channel_socket_connect_async
1125 * method which uses a QIOTask + qio_task_set_error internally
1126 * to avoid blocking. The tcp_chr_wait_connected method, however,
1127 * needs a way to synchronize with completion of the background
1128 * connect task which can't be done with the QIOChannelSocket
1129 * async APIs. Thus we must use QIOTask directly to implement
1130 * the non-blocking concept locally.
1132 s
->connect_task
= qio_task_new(OBJECT(sioc
),
1133 qemu_chr_socket_connected
,
1134 object_ref(OBJECT(chr
)),
1135 (GDestroyNotify
)object_unref
);
1136 qio_task_run_in_thread(s
->connect_task
,
1137 tcp_chr_connect_client_task
,
1143 static gboolean
socket_reconnect_timeout(gpointer opaque
)
1145 Chardev
*chr
= CHARDEV(opaque
);
1146 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
1148 qemu_mutex_lock(&chr
->chr_write_lock
);
1149 g_source_unref(s
->reconnect_timer
);
1150 s
->reconnect_timer
= NULL
;
1151 qemu_mutex_unlock(&chr
->chr_write_lock
);
1157 tcp_chr_connect_client_async(chr
);
1163 static int qmp_chardev_open_socket_server(Chardev
*chr
,
1165 bool is_waitconnect
,
1168 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1171 s
->do_telnetopt
= 1;
1173 s
->listener
= qio_net_listener_new();
1175 name
= g_strdup_printf("chardev-tcp-listener-%s", chr
->label
);
1176 qio_net_listener_set_name(s
->listener
, name
);
1179 if (qio_net_listener_open_sync(s
->listener
, s
->addr
, 1, errp
) < 0) {
1180 object_unref(OBJECT(s
->listener
));
1185 qapi_free_SocketAddress(s
->addr
);
1186 s
->addr
= socket_local_address(s
->listener
->sioc
[0]->fd
, errp
);
1187 update_disconnected_filename(s
);
1189 if (is_waitconnect
) {
1190 tcp_chr_accept_server_sync(chr
);
1192 qio_net_listener_set_client_func_full(s
->listener
,
1202 static int qmp_chardev_open_socket_client(Chardev
*chr
,
1206 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1208 if (reconnect
> 0) {
1209 s
->reconnect_time
= reconnect
;
1210 tcp_chr_connect_client_async(chr
);
1213 return tcp_chr_connect_client_sync(chr
, errp
);
1218 static bool qmp_chardev_validate_socket(ChardevSocket
*sock
,
1219 SocketAddress
*addr
,
1222 /* Validate any options which have a dependency on address type */
1223 switch (addr
->type
) {
1224 case SOCKET_ADDRESS_TYPE_FD
:
1225 if (sock
->has_reconnect
) {
1227 "'reconnect' option is incompatible with "
1228 "'fd' address type");
1231 if (sock
->has_tls_creds
&&
1232 !(sock
->has_server
&& sock
->server
)) {
1234 "'tls_creds' option is incompatible with "
1235 "'fd' address type as client");
1240 case SOCKET_ADDRESS_TYPE_UNIX
:
1241 if (sock
->has_tls_creds
) {
1243 "'tls_creds' option is incompatible with "
1244 "'unix' address type");
1249 case SOCKET_ADDRESS_TYPE_INET
:
1252 case SOCKET_ADDRESS_TYPE_VSOCK
:
1253 if (sock
->has_tls_creds
) {
1255 "'tls_creds' option is incompatible with "
1256 "'vsock' address type");
1264 if (sock
->has_tls_authz
&& !sock
->has_tls_creds
) {
1265 error_setg(errp
, "'tls_authz' option requires 'tls_creds' option");
1269 /* Validate any options which have a dependancy on client vs server */
1270 if (!sock
->has_server
|| sock
->server
) {
1271 if (sock
->has_reconnect
) {
1273 "'reconnect' option is incompatible with "
1274 "socket in server listen mode");
1278 if (sock
->has_websocket
&& sock
->websocket
) {
1279 error_setg(errp
, "%s", "Websocket client is not implemented");
1282 if (sock
->has_wait
) {
1283 warn_report("'wait' option is deprecated with "
1284 "socket in client connect mode");
1286 error_setg(errp
, "%s",
1287 "'wait' option is incompatible with "
1288 "socket in client connect mode");
1298 static void qmp_chardev_open_socket(Chardev
*chr
,
1299 ChardevBackend
*backend
,
1303 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1304 ChardevSocket
*sock
= backend
->u
.socket
.data
;
1305 bool do_nodelay
= sock
->has_nodelay
? sock
->nodelay
: false;
1306 bool is_listen
= sock
->has_server
? sock
->server
: true;
1307 bool is_telnet
= sock
->has_telnet
? sock
->telnet
: false;
1308 bool is_tn3270
= sock
->has_tn3270
? sock
->tn3270
: false;
1309 bool is_waitconnect
= sock
->has_wait
? sock
->wait
: false;
1310 bool is_websock
= sock
->has_websocket
? sock
->websocket
: false;
1311 int64_t reconnect
= sock
->has_reconnect
? sock
->reconnect
: 0;
1312 SocketAddress
*addr
;
1314 s
->is_listen
= is_listen
;
1315 s
->is_telnet
= is_telnet
;
1316 s
->is_tn3270
= is_tn3270
;
1317 s
->is_websock
= is_websock
;
1318 s
->do_nodelay
= do_nodelay
;
1319 if (sock
->tls_creds
) {
1321 creds
= object_resolve_path_component(
1322 object_get_objects_root(), sock
->tls_creds
);
1324 error_setg(errp
, "No TLS credentials with id '%s'",
1328 s
->tls_creds
= (QCryptoTLSCreds
*)
1329 object_dynamic_cast(creds
,
1330 TYPE_QCRYPTO_TLS_CREDS
);
1331 if (!s
->tls_creds
) {
1332 error_setg(errp
, "Object with id '%s' is not TLS credentials",
1336 object_ref(OBJECT(s
->tls_creds
));
1338 if (s
->tls_creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
) {
1339 error_setg(errp
, "%s",
1340 "Expected TLS credentials for server endpoint");
1344 if (s
->tls_creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT
) {
1345 error_setg(errp
, "%s",
1346 "Expected TLS credentials for client endpoint");
1351 s
->tls_authz
= g_strdup(sock
->tls_authz
);
1353 s
->addr
= addr
= socket_address_flatten(sock
->addr
);
1355 if (!qmp_chardev_validate_socket(sock
, addr
, errp
)) {
1359 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_RECONNECTABLE
);
1360 /* TODO SOCKET_ADDRESS_FD where fd has AF_UNIX */
1361 if (addr
->type
== SOCKET_ADDRESS_TYPE_UNIX
) {
1362 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_FD_PASS
);
1365 /* be isn't opened until we get a connection */
1368 update_disconnected_filename(s
);
1371 if (qmp_chardev_open_socket_server(chr
, is_telnet
|| is_tn3270
,
1372 is_waitconnect
, errp
) < 0) {
1376 if (qmp_chardev_open_socket_client(chr
, reconnect
, errp
) < 0) {
1382 static void qemu_chr_parse_socket(QemuOpts
*opts
, ChardevBackend
*backend
,
1385 const char *path
= qemu_opt_get(opts
, "path");
1386 const char *host
= qemu_opt_get(opts
, "host");
1387 const char *port
= qemu_opt_get(opts
, "port");
1388 const char *fd
= qemu_opt_get(opts
, "fd");
1389 bool tight
= qemu_opt_get_bool(opts
, "tight", true);
1390 bool abstract
= qemu_opt_get_bool(opts
, "abstract", false);
1391 SocketAddressLegacy
*addr
;
1392 ChardevSocket
*sock
;
1394 if ((!!path
+ !!fd
+ !!host
) != 1) {
1396 "Exactly one of 'path', 'fd' or 'host' required");
1400 if (host
&& !port
) {
1401 error_setg(errp
, "chardev: socket: no port given");
1405 backend
->type
= CHARDEV_BACKEND_KIND_SOCKET
;
1406 sock
= backend
->u
.socket
.data
= g_new0(ChardevSocket
, 1);
1407 qemu_chr_parse_common(opts
, qapi_ChardevSocket_base(sock
));
1409 sock
->has_nodelay
= qemu_opt_get(opts
, "delay");
1410 sock
->nodelay
= !qemu_opt_get_bool(opts
, "delay", true);
1412 * We have different default to QMP for 'server', hence
1413 * we can't just check for existence of 'server'
1415 sock
->has_server
= true;
1416 sock
->server
= qemu_opt_get_bool(opts
, "server", false);
1417 sock
->has_telnet
= qemu_opt_get(opts
, "telnet");
1418 sock
->telnet
= qemu_opt_get_bool(opts
, "telnet", false);
1419 sock
->has_tn3270
= qemu_opt_get(opts
, "tn3270");
1420 sock
->tn3270
= qemu_opt_get_bool(opts
, "tn3270", false);
1421 sock
->has_websocket
= qemu_opt_get(opts
, "websocket");
1422 sock
->websocket
= qemu_opt_get_bool(opts
, "websocket", false);
1424 * We have different default to QMP for 'wait' when 'server'
1425 * is set, hence we can't just check for existence of 'wait'
1427 sock
->has_wait
= qemu_opt_find(opts
, "wait") || sock
->server
;
1428 sock
->wait
= qemu_opt_get_bool(opts
, "wait", true);
1429 sock
->has_reconnect
= qemu_opt_find(opts
, "reconnect");
1430 sock
->reconnect
= qemu_opt_get_number(opts
, "reconnect", 0);
1431 sock
->has_tls_creds
= qemu_opt_get(opts
, "tls-creds");
1432 sock
->tls_creds
= g_strdup(qemu_opt_get(opts
, "tls-creds"));
1433 sock
->has_tls_authz
= qemu_opt_get(opts
, "tls-authz");
1434 sock
->tls_authz
= g_strdup(qemu_opt_get(opts
, "tls-authz"));
1436 addr
= g_new0(SocketAddressLegacy
, 1);
1438 UnixSocketAddress
*q_unix
;
1439 addr
->type
= SOCKET_ADDRESS_LEGACY_KIND_UNIX
;
1440 q_unix
= addr
->u
.q_unix
.data
= g_new0(UnixSocketAddress
, 1);
1441 q_unix
->path
= g_strdup(path
);
1442 q_unix
->tight
= tight
;
1443 q_unix
->abstract
= abstract
;
1445 addr
->type
= SOCKET_ADDRESS_LEGACY_KIND_INET
;
1446 addr
->u
.inet
.data
= g_new(InetSocketAddress
, 1);
1447 *addr
->u
.inet
.data
= (InetSocketAddress
) {
1448 .host
= g_strdup(host
),
1449 .port
= g_strdup(port
),
1450 .has_to
= qemu_opt_get(opts
, "to"),
1451 .to
= qemu_opt_get_number(opts
, "to", 0),
1452 .has_ipv4
= qemu_opt_get(opts
, "ipv4"),
1453 .ipv4
= qemu_opt_get_bool(opts
, "ipv4", 0),
1454 .has_ipv6
= qemu_opt_get(opts
, "ipv6"),
1455 .ipv6
= qemu_opt_get_bool(opts
, "ipv6", 0),
1458 addr
->type
= SOCKET_ADDRESS_LEGACY_KIND_FD
;
1459 addr
->u
.fd
.data
= g_new(String
, 1);
1460 addr
->u
.fd
.data
->str
= g_strdup(fd
);
1462 g_assert_not_reached();
1468 char_socket_get_addr(Object
*obj
, Visitor
*v
, const char *name
,
1469 void *opaque
, Error
**errp
)
1471 SocketChardev
*s
= SOCKET_CHARDEV(obj
);
1473 visit_type_SocketAddress(v
, name
, &s
->addr
, errp
);
1477 char_socket_get_connected(Object
*obj
, Error
**errp
)
1479 SocketChardev
*s
= SOCKET_CHARDEV(obj
);
1481 return s
->state
== TCP_CHARDEV_STATE_CONNECTED
;
1484 static void char_socket_class_init(ObjectClass
*oc
, void *data
)
1486 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
1488 cc
->parse
= qemu_chr_parse_socket
;
1489 cc
->open
= qmp_chardev_open_socket
;
1490 cc
->chr_wait_connected
= tcp_chr_wait_connected
;
1491 cc
->chr_write
= tcp_chr_write
;
1492 cc
->chr_sync_read
= tcp_chr_sync_read
;
1493 cc
->chr_disconnect
= tcp_chr_disconnect
;
1494 cc
->get_msgfds
= tcp_get_msgfds
;
1495 cc
->set_msgfds
= tcp_set_msgfds
;
1496 cc
->chr_add_client
= tcp_chr_add_client
;
1497 cc
->chr_add_watch
= tcp_chr_add_watch
;
1498 cc
->chr_update_read_handler
= tcp_chr_update_read_handler
;
1500 object_class_property_add(oc
, "addr", "SocketAddress",
1501 char_socket_get_addr
, NULL
,
1504 object_class_property_add_bool(oc
, "connected", char_socket_get_connected
,
1508 static const TypeInfo char_socket_type_info
= {
1509 .name
= TYPE_CHARDEV_SOCKET
,
1510 .parent
= TYPE_CHARDEV
,
1511 .instance_size
= sizeof(SocketChardev
),
1512 .instance_finalize
= char_socket_finalize
,
1513 .class_init
= char_socket_class_init
,
1516 static void register_types(void)
1518 type_register_static(&char_socket_type_info
);
1521 type_init(register_types
);