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/option.h"
33 #include "qapi/error.h"
34 #include "qapi/clone-visitor.h"
35 #include "qapi/qapi-visit-sockets.h"
37 #include "chardev/char-io.h"
39 /***********************************************************/
42 #define TCP_MAX_FDS 16
47 } TCPChardevTelnetInit
;
50 TCP_CHARDEV_STATE_DISCONNECTED
,
51 TCP_CHARDEV_STATE_CONNECTING
,
52 TCP_CHARDEV_STATE_CONNECTED
,
57 QIOChannel
*ioc
; /* Client I/O channel */
58 QIOChannelSocket
*sioc
; /* Client master channel */
59 QIONetListener
*listener
;
61 QCryptoTLSCreds
*tls_creds
;
62 TCPChardevState state
;
67 size_t read_msgfds_num
;
69 size_t write_msgfds_num
;
75 GSource
*telnet_source
;
76 TCPChardevTelnetInit
*telnet_init
;
80 GSource
*reconnect_timer
;
81 int64_t reconnect_time
;
82 bool connect_err_reported
;
84 QIOTask
*connect_task
;
87 #define SOCKET_CHARDEV(obj) \
88 OBJECT_CHECK(SocketChardev, (obj), TYPE_CHARDEV_SOCKET)
90 static gboolean
socket_reconnect_timeout(gpointer opaque
);
91 static void tcp_chr_telnet_init(Chardev
*chr
);
93 static void tcp_chr_change_state(SocketChardev
*s
, TCPChardevState state
)
96 case TCP_CHARDEV_STATE_DISCONNECTED
:
98 case TCP_CHARDEV_STATE_CONNECTING
:
99 assert(s
->state
== TCP_CHARDEV_STATE_DISCONNECTED
);
101 case TCP_CHARDEV_STATE_CONNECTED
:
102 assert(s
->state
== TCP_CHARDEV_STATE_CONNECTING
);
108 static void tcp_chr_reconn_timer_cancel(SocketChardev
*s
)
110 if (s
->reconnect_timer
) {
111 g_source_destroy(s
->reconnect_timer
);
112 g_source_unref(s
->reconnect_timer
);
113 s
->reconnect_timer
= NULL
;
117 static void qemu_chr_socket_restart_timer(Chardev
*chr
)
119 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
122 assert(s
->state
== TCP_CHARDEV_STATE_DISCONNECTED
);
123 assert(!s
->reconnect_timer
);
124 name
= g_strdup_printf("chardev-socket-reconnect-%s", chr
->label
);
125 s
->reconnect_timer
= qemu_chr_timeout_add_ms(chr
,
126 s
->reconnect_time
* 1000,
127 socket_reconnect_timeout
,
129 g_source_set_name(s
->reconnect_timer
, name
);
133 static void check_report_connect_error(Chardev
*chr
,
136 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
138 if (!s
->connect_err_reported
) {
139 error_report("Unable to connect character device %s: %s",
140 chr
->label
, error_get_pretty(err
));
141 s
->connect_err_reported
= true;
143 qemu_chr_socket_restart_timer(chr
);
146 static void tcp_chr_accept(QIONetListener
*listener
,
147 QIOChannelSocket
*cioc
,
150 static int tcp_chr_read_poll(void *opaque
);
151 static void tcp_chr_disconnect(Chardev
*chr
);
153 /* Called with chr_write_lock held. */
154 static int tcp_chr_write(Chardev
*chr
, const uint8_t *buf
, int len
)
156 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
158 if (s
->state
== TCP_CHARDEV_STATE_CONNECTED
) {
159 int ret
= io_channel_send_full(s
->ioc
, buf
, len
,
161 s
->write_msgfds_num
);
163 /* free the written msgfds in any cases
164 * other than ret < 0 && errno == EAGAIN
166 if (!(ret
< 0 && EAGAIN
== errno
)
167 && s
->write_msgfds_num
) {
168 g_free(s
->write_msgfds
);
170 s
->write_msgfds_num
= 0;
173 if (ret
< 0 && errno
!= EAGAIN
) {
174 if (tcp_chr_read_poll(chr
) <= 0) {
175 tcp_chr_disconnect(chr
);
177 } /* else let the read handler finish it properly */
182 /* XXX: indicate an error ? */
187 static int tcp_chr_read_poll(void *opaque
)
189 Chardev
*chr
= CHARDEV(opaque
);
190 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
191 if (s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) {
194 s
->max_size
= qemu_chr_be_can_write(chr
);
198 static void tcp_chr_process_IAC_bytes(Chardev
*chr
,
200 uint8_t *buf
, int *size
)
202 /* Handle any telnet or tn3270 client's basic IAC options.
203 * For telnet options, it satisfies char by char mode with no echo.
204 * For tn3270 options, it satisfies binary mode with EOR.
205 * All IAC options will be removed from the buf and the do_opt
206 * pointer will be used to track the state of the width of the
209 * RFC854: "All TELNET commands consist of at least a two byte sequence.
210 * The commands dealing with option negotiation are three byte sequences,
211 * the third byte being the code for the option referenced."
212 * "IAC BREAK", "IAC IP", "IAC NOP" and the double IAC are two bytes.
213 * "IAC SB", "IAC SE" and "IAC EOR" are saved to split up data boundary
215 * NOP, Break and Interrupt Process(IP) might be encountered during a TN3270
216 * session, and NOP and IP need to be done later.
222 for (i
= 0; i
< *size
; i
++) {
223 if (s
->do_telnetopt
> 1) {
224 if ((unsigned char)buf
[i
] == IAC
&& s
->do_telnetopt
== 2) {
225 /* Double IAC means send an IAC */
232 if ((unsigned char)buf
[i
] == IAC_BREAK
233 && s
->do_telnetopt
== 2) {
234 /* Handle IAC break commands by sending a serial break */
235 qemu_chr_be_event(chr
, CHR_EVENT_BREAK
);
237 } else if (s
->is_tn3270
&& ((unsigned char)buf
[i
] == IAC_EOR
238 || (unsigned char)buf
[i
] == IAC_SB
239 || (unsigned char)buf
[i
] == IAC_SE
)
240 && s
->do_telnetopt
== 2) {
244 } else if (s
->is_tn3270
&& ((unsigned char)buf
[i
] == IAC_IP
245 || (unsigned char)buf
[i
] == IAC_NOP
)
246 && s
->do_telnetopt
== 2) {
247 /* TODO: IP and NOP need to be implemented later. */
252 if (s
->do_telnetopt
>= 4) {
256 if ((unsigned char)buf
[i
] == IAC
) {
269 static int tcp_get_msgfds(Chardev
*chr
, int *fds
, int num
)
271 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
273 int to_copy
= (s
->read_msgfds_num
< num
) ? s
->read_msgfds_num
: num
;
275 assert(num
<= TCP_MAX_FDS
);
280 memcpy(fds
, s
->read_msgfds
, to_copy
* sizeof(int));
282 /* Close unused fds */
283 for (i
= to_copy
; i
< s
->read_msgfds_num
; i
++) {
284 close(s
->read_msgfds
[i
]);
287 g_free(s
->read_msgfds
);
289 s
->read_msgfds_num
= 0;
295 static int tcp_set_msgfds(Chardev
*chr
, int *fds
, int num
)
297 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
299 /* clear old pending fd array */
300 g_free(s
->write_msgfds
);
301 s
->write_msgfds
= NULL
;
302 s
->write_msgfds_num
= 0;
304 if ((s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) ||
305 !qio_channel_has_feature(s
->ioc
,
306 QIO_CHANNEL_FEATURE_FD_PASS
)) {
311 s
->write_msgfds
= g_new(int, num
);
312 memcpy(s
->write_msgfds
, fds
, num
* sizeof(int));
315 s
->write_msgfds_num
= num
;
320 static ssize_t
tcp_chr_recv(Chardev
*chr
, char *buf
, size_t len
)
322 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
323 struct iovec iov
= { .iov_base
= buf
, .iov_len
= len
};
327 size_t msgfds_num
= 0;
329 if (qio_channel_has_feature(s
->ioc
, QIO_CHANNEL_FEATURE_FD_PASS
)) {
330 ret
= qio_channel_readv_full(s
->ioc
, &iov
, 1,
331 &msgfds
, &msgfds_num
,
334 ret
= qio_channel_readv_full(s
->ioc
, &iov
, 1,
339 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
342 } else if (ret
== -1) {
347 /* close and clean read_msgfds */
348 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
349 close(s
->read_msgfds
[i
]);
352 if (s
->read_msgfds_num
) {
353 g_free(s
->read_msgfds
);
356 s
->read_msgfds
= msgfds
;
357 s
->read_msgfds_num
= msgfds_num
;
360 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
361 int fd
= s
->read_msgfds
[i
];
366 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
369 #ifndef MSG_CMSG_CLOEXEC
370 qemu_set_cloexec(fd
);
377 static GSource
*tcp_chr_add_watch(Chardev
*chr
, GIOCondition cond
)
379 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
380 return qio_channel_create_watch(s
->ioc
, cond
);
383 static void remove_hup_source(SocketChardev
*s
)
385 if (s
->hup_source
!= NULL
) {
386 g_source_destroy(s
->hup_source
);
387 g_source_unref(s
->hup_source
);
388 s
->hup_source
= NULL
;
392 static void tcp_chr_free_connection(Chardev
*chr
)
394 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
397 if (s
->read_msgfds_num
) {
398 for (i
= 0; i
< s
->read_msgfds_num
; i
++) {
399 close(s
->read_msgfds
[i
]);
401 g_free(s
->read_msgfds
);
402 s
->read_msgfds
= NULL
;
403 s
->read_msgfds_num
= 0;
406 remove_hup_source(s
);
408 tcp_set_msgfds(chr
, NULL
, 0);
409 remove_fd_in_watch(chr
);
410 object_unref(OBJECT(s
->sioc
));
412 object_unref(OBJECT(s
->ioc
));
414 g_free(chr
->filename
);
415 chr
->filename
= NULL
;
416 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_DISCONNECTED
);
419 static const char *qemu_chr_socket_protocol(SocketChardev
*s
)
424 return s
->is_websock
? "websocket" : "tcp";
427 static char *qemu_chr_socket_address(SocketChardev
*s
, const char *prefix
)
429 switch (s
->addr
->type
) {
430 case SOCKET_ADDRESS_TYPE_INET
:
431 return g_strdup_printf("%s%s:%s:%s%s", prefix
,
432 qemu_chr_socket_protocol(s
),
433 s
->addr
->u
.inet
.host
,
434 s
->addr
->u
.inet
.port
,
435 s
->is_listen
? ",server" : "");
437 case SOCKET_ADDRESS_TYPE_UNIX
:
438 return g_strdup_printf("%sunix:%s%s", prefix
,
439 s
->addr
->u
.q_unix
.path
,
440 s
->is_listen
? ",server" : "");
442 case SOCKET_ADDRESS_TYPE_FD
:
443 return g_strdup_printf("%sfd:%s%s", prefix
, s
->addr
->u
.fd
.str
,
444 s
->is_listen
? ",server" : "");
446 case SOCKET_ADDRESS_TYPE_VSOCK
:
447 return g_strdup_printf("%svsock:%s:%s", prefix
,
448 s
->addr
->u
.vsock
.cid
,
449 s
->addr
->u
.vsock
.port
);
455 static void update_disconnected_filename(SocketChardev
*s
)
457 Chardev
*chr
= CHARDEV(s
);
459 g_free(chr
->filename
);
461 chr
->filename
= qemu_chr_socket_address(s
, "disconnected:");
463 chr
->filename
= g_strdup("disconnected:socket");
467 /* NB may be called even if tcp_chr_connect has not been
468 * reached, due to TLS or telnet initialization failure,
469 * so can *not* assume s->state == TCP_CHARDEV_STATE_CONNECTED
471 static void tcp_chr_disconnect(Chardev
*chr
)
473 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
474 bool emit_close
= s
->state
== TCP_CHARDEV_STATE_CONNECTED
;
476 tcp_chr_free_connection(chr
);
479 qio_net_listener_set_client_func_full(s
->listener
, tcp_chr_accept
,
480 chr
, NULL
, chr
->gcontext
);
482 update_disconnected_filename(s
);
484 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
486 if (s
->reconnect_time
) {
487 qemu_chr_socket_restart_timer(chr
);
491 static gboolean
tcp_chr_read(QIOChannel
*chan
, GIOCondition cond
, void *opaque
)
493 Chardev
*chr
= CHARDEV(opaque
);
494 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
495 uint8_t buf
[CHR_READ_BUF_LEN
];
498 if ((s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) ||
503 if (len
> s
->max_size
) {
506 size
= tcp_chr_recv(chr
, (void *)buf
, len
);
507 if (size
== 0 || (size
== -1 && errno
!= EAGAIN
)) {
508 /* connection closed */
509 tcp_chr_disconnect(chr
);
510 } else if (size
> 0) {
511 if (s
->do_telnetopt
) {
512 tcp_chr_process_IAC_bytes(chr
, s
, buf
, &size
);
515 qemu_chr_be_write(chr
, buf
, size
);
522 static gboolean
tcp_chr_hup(QIOChannel
*channel
,
526 Chardev
*chr
= CHARDEV(opaque
);
527 tcp_chr_disconnect(chr
);
528 return G_SOURCE_REMOVE
;
531 static int tcp_chr_sync_read(Chardev
*chr
, const uint8_t *buf
, int len
)
533 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
536 if (s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) {
540 qio_channel_set_blocking(s
->ioc
, true, NULL
);
541 size
= tcp_chr_recv(chr
, (void *) buf
, len
);
542 qio_channel_set_blocking(s
->ioc
, false, NULL
);
544 /* connection closed */
545 tcp_chr_disconnect(chr
);
551 static char *qemu_chr_compute_filename(SocketChardev
*s
)
553 struct sockaddr_storage
*ss
= &s
->sioc
->localAddr
;
554 struct sockaddr_storage
*ps
= &s
->sioc
->remoteAddr
;
555 socklen_t ss_len
= s
->sioc
->localAddrLen
;
556 socklen_t ps_len
= s
->sioc
->remoteAddrLen
;
557 char shost
[NI_MAXHOST
], sserv
[NI_MAXSERV
];
558 char phost
[NI_MAXHOST
], pserv
[NI_MAXSERV
];
559 const char *left
= "", *right
= "";
561 switch (ss
->ss_family
) {
564 return g_strdup_printf("unix:%s%s",
565 ((struct sockaddr_un
*)(ss
))->sun_path
,
566 s
->is_listen
? ",server" : "");
573 getnameinfo((struct sockaddr
*) ss
, ss_len
, shost
, sizeof(shost
),
574 sserv
, sizeof(sserv
), NI_NUMERICHOST
| NI_NUMERICSERV
);
575 getnameinfo((struct sockaddr
*) ps
, ps_len
, phost
, sizeof(phost
),
576 pserv
, sizeof(pserv
), NI_NUMERICHOST
| NI_NUMERICSERV
);
577 return g_strdup_printf("%s:%s%s%s:%s%s <-> %s%s%s:%s",
578 qemu_chr_socket_protocol(s
),
579 left
, shost
, right
, sserv
,
580 s
->is_listen
? ",server" : "",
581 left
, phost
, right
, pserv
);
584 return g_strdup_printf("unknown");
588 static void update_ioc_handlers(SocketChardev
*s
)
590 Chardev
*chr
= CHARDEV(s
);
592 if (s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) {
596 remove_fd_in_watch(chr
);
597 chr
->gsource
= io_add_watch_poll(chr
, s
->ioc
,
602 remove_hup_source(s
);
603 s
->hup_source
= qio_channel_create_watch(s
->ioc
, G_IO_HUP
);
604 g_source_set_callback(s
->hup_source
, (GSourceFunc
)tcp_chr_hup
,
606 g_source_attach(s
->hup_source
, chr
->gcontext
);
609 static void tcp_chr_connect(void *opaque
)
611 Chardev
*chr
= CHARDEV(opaque
);
612 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
614 g_free(chr
->filename
);
615 chr
->filename
= qemu_chr_compute_filename(s
);
617 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTED
);
618 update_ioc_handlers(s
);
619 qemu_chr_be_event(chr
, CHR_EVENT_OPENED
);
622 static void tcp_chr_telnet_destroy(SocketChardev
*s
)
624 if (s
->telnet_source
) {
625 g_source_destroy(s
->telnet_source
);
626 g_source_unref(s
->telnet_source
);
627 s
->telnet_source
= NULL
;
631 static void tcp_chr_update_read_handler(Chardev
*chr
)
633 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
637 * It's possible that chardev context is changed in
638 * qemu_chr_be_update_read_handlers(). Reset it for QIO net
639 * listener if there is.
641 qio_net_listener_set_client_func_full(s
->listener
, tcp_chr_accept
,
642 chr
, NULL
, chr
->gcontext
);
645 if (s
->telnet_source
) {
646 tcp_chr_telnet_init(CHARDEV(s
));
649 update_ioc_handlers(s
);
652 static gboolean
tcp_chr_telnet_init_io(QIOChannel
*ioc
,
653 GIOCondition cond G_GNUC_UNUSED
,
656 SocketChardev
*s
= user_data
;
657 Chardev
*chr
= CHARDEV(s
);
658 TCPChardevTelnetInit
*init
= s
->telnet_init
;
663 ret
= qio_channel_write(ioc
, init
->buf
, init
->buflen
, NULL
);
665 if (ret
== QIO_CHANNEL_ERR_BLOCK
) {
668 tcp_chr_disconnect(chr
);
674 if (init
->buflen
== 0) {
675 tcp_chr_connect(chr
);
679 memmove(init
->buf
, init
->buf
+ ret
, init
->buflen
);
681 return G_SOURCE_CONTINUE
;
684 g_free(s
->telnet_init
);
685 s
->telnet_init
= NULL
;
686 g_source_unref(s
->telnet_source
);
687 s
->telnet_source
= NULL
;
688 return G_SOURCE_REMOVE
;
691 static void tcp_chr_telnet_init(Chardev
*chr
)
693 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
694 TCPChardevTelnetInit
*init
;
697 /* Destroy existing task */
698 tcp_chr_telnet_destroy(s
);
700 if (s
->telnet_init
) {
701 /* We are possibly during a handshake already */
705 s
->telnet_init
= g_new0(TCPChardevTelnetInit
, 1);
706 init
= s
->telnet_init
;
708 #define IACSET(x, a, b, c) \
717 /* Prep the telnet negotion to put telnet in binary,
718 * no echo, single char mode */
719 IACSET(init
->buf
, 0xff, 0xfb, 0x01); /* IAC WILL ECHO */
720 IACSET(init
->buf
, 0xff, 0xfb, 0x03); /* IAC WILL Suppress go ahead */
721 IACSET(init
->buf
, 0xff, 0xfb, 0x00); /* IAC WILL Binary */
722 IACSET(init
->buf
, 0xff, 0xfd, 0x00); /* IAC DO Binary */
725 /* Prep the TN3270 negotion based on RFC1576 */
726 IACSET(init
->buf
, 0xff, 0xfd, 0x19); /* IAC DO EOR */
727 IACSET(init
->buf
, 0xff, 0xfb, 0x19); /* IAC WILL EOR */
728 IACSET(init
->buf
, 0xff, 0xfd, 0x00); /* IAC DO BINARY */
729 IACSET(init
->buf
, 0xff, 0xfb, 0x00); /* IAC WILL BINARY */
730 IACSET(init
->buf
, 0xff, 0xfd, 0x18); /* IAC DO TERMINAL TYPE */
731 IACSET(init
->buf
, 0xff, 0xfa, 0x18); /* IAC SB TERMINAL TYPE */
732 IACSET(init
->buf
, 0x01, 0xff, 0xf0); /* SEND IAC SE */
738 s
->telnet_source
= qio_channel_add_watch_source(s
->ioc
, G_IO_OUT
,
739 tcp_chr_telnet_init_io
,
745 static void tcp_chr_websock_handshake(QIOTask
*task
, gpointer user_data
)
747 Chardev
*chr
= user_data
;
748 SocketChardev
*s
= user_data
;
750 if (qio_task_propagate_error(task
, NULL
)) {
751 tcp_chr_disconnect(chr
);
753 if (s
->do_telnetopt
) {
754 tcp_chr_telnet_init(chr
);
756 tcp_chr_connect(chr
);
762 static void tcp_chr_websock_init(Chardev
*chr
)
764 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
765 QIOChannelWebsock
*wioc
= NULL
;
768 wioc
= qio_channel_websock_new_server(s
->ioc
);
770 name
= g_strdup_printf("chardev-websocket-server-%s", chr
->label
);
771 qio_channel_set_name(QIO_CHANNEL(wioc
), name
);
773 object_unref(OBJECT(s
->ioc
));
774 s
->ioc
= QIO_CHANNEL(wioc
);
776 qio_channel_websock_handshake(wioc
, tcp_chr_websock_handshake
, chr
, NULL
);
780 static void tcp_chr_tls_handshake(QIOTask
*task
,
783 Chardev
*chr
= user_data
;
784 SocketChardev
*s
= user_data
;
786 if (qio_task_propagate_error(task
, NULL
)) {
787 tcp_chr_disconnect(chr
);
790 tcp_chr_websock_init(chr
);
791 } else if (s
->do_telnetopt
) {
792 tcp_chr_telnet_init(chr
);
794 tcp_chr_connect(chr
);
800 static void tcp_chr_tls_init(Chardev
*chr
)
802 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
808 tioc
= qio_channel_tls_new_server(
809 s
->ioc
, s
->tls_creds
,
810 NULL
, /* XXX Use an ACL */
813 tioc
= qio_channel_tls_new_client(
814 s
->ioc
, s
->tls_creds
,
815 s
->addr
->u
.inet
.host
,
820 tcp_chr_disconnect(chr
);
823 name
= g_strdup_printf("chardev-tls-%s-%s",
824 s
->is_listen
? "server" : "client",
826 qio_channel_set_name(QIO_CHANNEL(tioc
), name
);
828 object_unref(OBJECT(s
->ioc
));
829 s
->ioc
= QIO_CHANNEL(tioc
);
831 qio_channel_tls_handshake(tioc
,
832 tcp_chr_tls_handshake
,
839 static void tcp_chr_set_client_ioc_name(Chardev
*chr
,
840 QIOChannelSocket
*sioc
)
842 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
844 name
= g_strdup_printf("chardev-tcp-%s-%s",
845 s
->is_listen
? "server" : "client",
847 qio_channel_set_name(QIO_CHANNEL(sioc
), name
);
852 static int tcp_chr_new_client(Chardev
*chr
, QIOChannelSocket
*sioc
)
854 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
856 if (s
->state
!= TCP_CHARDEV_STATE_CONNECTING
) {
860 s
->ioc
= QIO_CHANNEL(sioc
);
861 object_ref(OBJECT(sioc
));
863 object_ref(OBJECT(sioc
));
865 qio_channel_set_blocking(s
->ioc
, false, NULL
);
868 qio_channel_set_delay(s
->ioc
, false);
871 qio_net_listener_set_client_func_full(s
->listener
, NULL
, NULL
,
872 NULL
, chr
->gcontext
);
876 tcp_chr_tls_init(chr
);
877 } else if (s
->is_websock
) {
878 tcp_chr_websock_init(chr
);
879 } else if (s
->do_telnetopt
) {
880 tcp_chr_telnet_init(chr
);
882 tcp_chr_connect(chr
);
889 static int tcp_chr_add_client(Chardev
*chr
, int fd
)
892 QIOChannelSocket
*sioc
;
893 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
895 if (s
->state
!= TCP_CHARDEV_STATE_DISCONNECTED
) {
899 sioc
= qio_channel_socket_new_fd(fd
, NULL
);
903 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
904 tcp_chr_set_client_ioc_name(chr
, sioc
);
905 ret
= tcp_chr_new_client(chr
, sioc
);
906 object_unref(OBJECT(sioc
));
910 static void tcp_chr_accept(QIONetListener
*listener
,
911 QIOChannelSocket
*cioc
,
914 Chardev
*chr
= CHARDEV(opaque
);
915 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
917 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
918 tcp_chr_set_client_ioc_name(chr
, cioc
);
919 tcp_chr_new_client(chr
, cioc
);
923 static int tcp_chr_connect_client_sync(Chardev
*chr
, Error
**errp
)
925 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
926 QIOChannelSocket
*sioc
= qio_channel_socket_new();
927 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
928 tcp_chr_set_client_ioc_name(chr
, sioc
);
929 if (qio_channel_socket_connect_sync(sioc
, s
->addr
, errp
) < 0) {
930 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_DISCONNECTED
);
931 object_unref(OBJECT(sioc
));
934 tcp_chr_new_client(chr
, sioc
);
935 object_unref(OBJECT(sioc
));
940 static void tcp_chr_accept_server_sync(Chardev
*chr
)
942 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
943 QIOChannelSocket
*sioc
;
944 info_report("QEMU waiting for connection on: %s",
946 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
947 sioc
= qio_net_listener_wait_client(s
->listener
);
948 tcp_chr_set_client_ioc_name(chr
, sioc
);
949 tcp_chr_new_client(chr
, sioc
);
950 object_unref(OBJECT(sioc
));
954 static int tcp_chr_wait_connected(Chardev
*chr
, Error
**errp
)
956 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
957 const char *opts
[] = { "telnet", "tn3270", "websock", "tls-creds" };
958 bool optset
[] = { s
->is_telnet
, s
->is_tn3270
, s
->is_websock
, s
->tls_creds
};
961 QEMU_BUILD_BUG_ON(G_N_ELEMENTS(opts
) != G_N_ELEMENTS(optset
));
962 for (i
= 0; i
< G_N_ELEMENTS(opts
); i
++) {
965 "'%s' option is incompatible with waiting for "
966 "connection completion", opts
[i
]);
971 tcp_chr_reconn_timer_cancel(s
);
974 * We expect states to be as follows:
977 * - wait -> CONNECTED
978 * - nowait -> DISCONNECTED
980 * - reconnect == 0 -> CONNECTED
981 * - reconnect != 0 -> CONNECTING
984 if (s
->state
== TCP_CHARDEV_STATE_CONNECTING
) {
985 if (!s
->connect_task
) {
987 "Unexpected 'connecting' state without connect task "
988 "while waiting for connection completion");
992 * tcp_chr_wait_connected should only ever be run from the
993 * main loop thread associated with chr->gcontext, otherwise
994 * qio_task_wait_thread has a dangerous race condition with
995 * free'ing of the s->connect_task object.
997 * Acquiring the main context doesn't 100% prove we're in
998 * the main loop thread, but it does at least guarantee
999 * that the main loop won't be executed by another thread
1000 * avoiding the race condition with the task idle callback.
1002 g_main_context_acquire(chr
->gcontext
);
1003 qio_task_wait_thread(s
->connect_task
);
1004 g_main_context_release(chr
->gcontext
);
1007 * The completion callback (qemu_chr_socket_connected) for
1008 * s->connect_task should have set this to NULL by the time
1009 * qio_task_wait_thread has returned.
1011 assert(!s
->connect_task
);
1014 * NB we are *not* guaranteed to have "s->state == ..CONNECTED"
1015 * at this point as this first connect may be failed, so
1016 * allow the next loop to run regardless.
1020 while (s
->state
!= TCP_CHARDEV_STATE_CONNECTED
) {
1022 tcp_chr_accept_server_sync(chr
);
1025 if (tcp_chr_connect_client_sync(chr
, &err
) < 0) {
1026 if (s
->reconnect_time
) {
1028 g_usleep(s
->reconnect_time
* 1000ULL * 1000ULL);
1030 error_propagate(errp
, err
);
1040 static void char_socket_finalize(Object
*obj
)
1042 Chardev
*chr
= CHARDEV(obj
);
1043 SocketChardev
*s
= SOCKET_CHARDEV(obj
);
1045 tcp_chr_free_connection(chr
);
1046 tcp_chr_reconn_timer_cancel(s
);
1047 qapi_free_SocketAddress(s
->addr
);
1048 tcp_chr_telnet_destroy(s
);
1049 g_free(s
->telnet_init
);
1051 qio_net_listener_set_client_func_full(s
->listener
, NULL
, NULL
,
1052 NULL
, chr
->gcontext
);
1053 object_unref(OBJECT(s
->listener
));
1056 object_unref(OBJECT(s
->tls_creds
));
1059 qemu_chr_be_event(chr
, CHR_EVENT_CLOSED
);
1062 static void qemu_chr_socket_connected(QIOTask
*task
, void *opaque
)
1064 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
1065 Chardev
*chr
= CHARDEV(opaque
);
1066 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1069 s
->connect_task
= NULL
;
1071 if (qio_task_propagate_error(task
, &err
)) {
1072 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_DISCONNECTED
);
1073 check_report_connect_error(chr
, err
);
1078 s
->connect_err_reported
= false;
1079 tcp_chr_new_client(chr
, sioc
);
1082 object_unref(OBJECT(sioc
));
1086 static void tcp_chr_connect_client_task(QIOTask
*task
,
1089 QIOChannelSocket
*ioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
1090 SocketAddress
*addr
= opaque
;
1093 qio_channel_socket_connect_sync(ioc
, addr
, &err
);
1095 qio_task_set_error(task
, err
);
1099 static void tcp_chr_connect_client_async(Chardev
*chr
)
1101 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1102 QIOChannelSocket
*sioc
;
1104 tcp_chr_change_state(s
, TCP_CHARDEV_STATE_CONNECTING
);
1105 sioc
= qio_channel_socket_new();
1106 tcp_chr_set_client_ioc_name(chr
, sioc
);
1108 * Normally code would use the qio_channel_socket_connect_async
1109 * method which uses a QIOTask + qio_task_set_error internally
1110 * to avoid blocking. The tcp_chr_wait_connected method, however,
1111 * needs a way to synchronize with completion of the background
1112 * connect task which can't be done with the QIOChannelSocket
1113 * async APIs. Thus we must use QIOTask directly to implement
1114 * the non-blocking concept locally.
1116 s
->connect_task
= qio_task_new(OBJECT(sioc
),
1117 qemu_chr_socket_connected
,
1119 qio_task_run_in_thread(s
->connect_task
,
1120 tcp_chr_connect_client_task
,
1126 static gboolean
socket_reconnect_timeout(gpointer opaque
)
1128 Chardev
*chr
= CHARDEV(opaque
);
1129 SocketChardev
*s
= SOCKET_CHARDEV(opaque
);
1131 g_source_unref(s
->reconnect_timer
);
1132 s
->reconnect_timer
= NULL
;
1138 tcp_chr_connect_client_async(chr
);
1144 static int qmp_chardev_open_socket_server(Chardev
*chr
,
1146 bool is_waitconnect
,
1149 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1152 s
->do_telnetopt
= 1;
1154 s
->listener
= qio_net_listener_new();
1156 name
= g_strdup_printf("chardev-tcp-listener-%s", chr
->label
);
1157 qio_net_listener_set_name(s
->listener
, name
);
1160 if (qio_net_listener_open_sync(s
->listener
, s
->addr
, errp
) < 0) {
1161 object_unref(OBJECT(s
->listener
));
1166 qapi_free_SocketAddress(s
->addr
);
1167 s
->addr
= socket_local_address(s
->listener
->sioc
[0]->fd
, errp
);
1168 update_disconnected_filename(s
);
1170 if (is_waitconnect
) {
1171 tcp_chr_accept_server_sync(chr
);
1173 qio_net_listener_set_client_func_full(s
->listener
,
1183 static int qmp_chardev_open_socket_client(Chardev
*chr
,
1187 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1189 if (reconnect
> 0) {
1190 s
->reconnect_time
= reconnect
;
1191 tcp_chr_connect_client_async(chr
);
1194 return tcp_chr_connect_client_sync(chr
, errp
);
1199 static bool qmp_chardev_validate_socket(ChardevSocket
*sock
,
1200 SocketAddress
*addr
,
1203 /* Validate any options which have a dependency on address type */
1204 switch (addr
->type
) {
1205 case SOCKET_ADDRESS_TYPE_FD
:
1206 if (sock
->has_reconnect
) {
1208 "'reconnect' option is incompatible with "
1209 "'fd' address type");
1212 if (sock
->has_tls_creds
&&
1213 !(sock
->has_server
&& sock
->server
)) {
1215 "'tls_creds' option is incompatible with "
1216 "'fd' address type as client");
1221 case SOCKET_ADDRESS_TYPE_UNIX
:
1222 if (sock
->has_tls_creds
) {
1224 "'tls_creds' option is incompatible with "
1225 "'unix' address type");
1230 case SOCKET_ADDRESS_TYPE_INET
:
1233 case SOCKET_ADDRESS_TYPE_VSOCK
:
1234 if (sock
->has_tls_creds
) {
1236 "'tls_creds' option is incompatible with "
1237 "'vsock' address type");
1245 /* Validate any options which have a dependancy on client vs server */
1246 if (!sock
->has_server
|| sock
->server
) {
1247 if (sock
->has_reconnect
) {
1249 "'reconnect' option is incompatible with "
1250 "socket in server listen mode");
1254 if (sock
->has_websocket
&& sock
->websocket
) {
1255 error_setg(errp
, "%s", "Websocket client is not implemented");
1258 if (sock
->has_wait
) {
1259 error_setg(errp
, "%s",
1260 "'wait' option is incompatible with "
1261 "socket in client connect mode");
1270 static void qmp_chardev_open_socket(Chardev
*chr
,
1271 ChardevBackend
*backend
,
1275 SocketChardev
*s
= SOCKET_CHARDEV(chr
);
1276 ChardevSocket
*sock
= backend
->u
.socket
.data
;
1277 bool do_nodelay
= sock
->has_nodelay
? sock
->nodelay
: false;
1278 bool is_listen
= sock
->has_server
? sock
->server
: true;
1279 bool is_telnet
= sock
->has_telnet
? sock
->telnet
: false;
1280 bool is_tn3270
= sock
->has_tn3270
? sock
->tn3270
: false;
1281 bool is_waitconnect
= sock
->has_wait
? sock
->wait
: false;
1282 bool is_websock
= sock
->has_websocket
? sock
->websocket
: false;
1283 int64_t reconnect
= sock
->has_reconnect
? sock
->reconnect
: 0;
1284 SocketAddress
*addr
;
1286 s
->is_listen
= is_listen
;
1287 s
->is_telnet
= is_telnet
;
1288 s
->is_tn3270
= is_tn3270
;
1289 s
->is_websock
= is_websock
;
1290 s
->do_nodelay
= do_nodelay
;
1291 if (sock
->tls_creds
) {
1293 creds
= object_resolve_path_component(
1294 object_get_objects_root(), sock
->tls_creds
);
1296 error_setg(errp
, "No TLS credentials with id '%s'",
1300 s
->tls_creds
= (QCryptoTLSCreds
*)
1301 object_dynamic_cast(creds
,
1302 TYPE_QCRYPTO_TLS_CREDS
);
1303 if (!s
->tls_creds
) {
1304 error_setg(errp
, "Object with id '%s' is not TLS credentials",
1308 object_ref(OBJECT(s
->tls_creds
));
1310 if (s
->tls_creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_SERVER
) {
1311 error_setg(errp
, "%s",
1312 "Expected TLS credentials for server endpoint");
1316 if (s
->tls_creds
->endpoint
!= QCRYPTO_TLS_CREDS_ENDPOINT_CLIENT
) {
1317 error_setg(errp
, "%s",
1318 "Expected TLS credentials for client endpoint");
1324 s
->addr
= addr
= socket_address_flatten(sock
->addr
);
1326 if (!qmp_chardev_validate_socket(sock
, addr
, errp
)) {
1330 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_RECONNECTABLE
);
1331 /* TODO SOCKET_ADDRESS_FD where fd has AF_UNIX */
1332 if (addr
->type
== SOCKET_ADDRESS_TYPE_UNIX
) {
1333 qemu_chr_set_feature(chr
, QEMU_CHAR_FEATURE_FD_PASS
);
1336 /* be isn't opened until we get a connection */
1339 update_disconnected_filename(s
);
1342 if (qmp_chardev_open_socket_server(chr
, is_telnet
|| is_tn3270
,
1343 is_waitconnect
, errp
) < 0) {
1347 if (qmp_chardev_open_socket_client(chr
, reconnect
, errp
) < 0) {
1353 static void qemu_chr_parse_socket(QemuOpts
*opts
, ChardevBackend
*backend
,
1356 const char *path
= qemu_opt_get(opts
, "path");
1357 const char *host
= qemu_opt_get(opts
, "host");
1358 const char *port
= qemu_opt_get(opts
, "port");
1359 const char *fd
= qemu_opt_get(opts
, "fd");
1360 SocketAddressLegacy
*addr
;
1361 ChardevSocket
*sock
;
1363 if ((!!path
+ !!fd
+ !!host
) != 1) {
1365 "Exactly one of 'path', 'fd' or 'host' required");
1369 if (host
&& !port
) {
1370 error_setg(errp
, "chardev: socket: no port given");
1374 backend
->type
= CHARDEV_BACKEND_KIND_SOCKET
;
1375 sock
= backend
->u
.socket
.data
= g_new0(ChardevSocket
, 1);
1376 qemu_chr_parse_common(opts
, qapi_ChardevSocket_base(sock
));
1378 sock
->has_nodelay
= qemu_opt_get(opts
, "delay");
1379 sock
->nodelay
= !qemu_opt_get_bool(opts
, "delay", true);
1381 * We have different default to QMP for 'server', hence
1382 * we can't just check for existence of 'server'
1384 sock
->has_server
= true;
1385 sock
->server
= qemu_opt_get_bool(opts
, "server", false);
1386 sock
->has_telnet
= qemu_opt_get(opts
, "telnet");
1387 sock
->telnet
= qemu_opt_get_bool(opts
, "telnet", false);
1388 sock
->has_tn3270
= qemu_opt_get(opts
, "tn3270");
1389 sock
->tn3270
= qemu_opt_get_bool(opts
, "tn3270", false);
1390 sock
->has_websocket
= qemu_opt_get(opts
, "websocket");
1391 sock
->websocket
= qemu_opt_get_bool(opts
, "websocket", false);
1393 * We have different default to QMP for 'wait' when 'server'
1394 * is set, hence we can't just check for existence of 'wait'
1396 sock
->has_wait
= qemu_opt_find(opts
, "wait") || sock
->server
;
1397 sock
->wait
= qemu_opt_get_bool(opts
, "wait", true);
1398 sock
->has_reconnect
= qemu_opt_find(opts
, "reconnect");
1399 sock
->reconnect
= qemu_opt_get_number(opts
, "reconnect", 0);
1400 sock
->has_tls_creds
= qemu_opt_get(opts
, "tls-creds");
1401 sock
->tls_creds
= g_strdup(qemu_opt_get(opts
, "tls-creds"));
1403 addr
= g_new0(SocketAddressLegacy
, 1);
1405 UnixSocketAddress
*q_unix
;
1406 addr
->type
= SOCKET_ADDRESS_LEGACY_KIND_UNIX
;
1407 q_unix
= addr
->u
.q_unix
.data
= g_new0(UnixSocketAddress
, 1);
1408 q_unix
->path
= g_strdup(path
);
1410 addr
->type
= SOCKET_ADDRESS_LEGACY_KIND_INET
;
1411 addr
->u
.inet
.data
= g_new(InetSocketAddress
, 1);
1412 *addr
->u
.inet
.data
= (InetSocketAddress
) {
1413 .host
= g_strdup(host
),
1414 .port
= g_strdup(port
),
1415 .has_to
= qemu_opt_get(opts
, "to"),
1416 .to
= qemu_opt_get_number(opts
, "to", 0),
1417 .has_ipv4
= qemu_opt_get(opts
, "ipv4"),
1418 .ipv4
= qemu_opt_get_bool(opts
, "ipv4", 0),
1419 .has_ipv6
= qemu_opt_get(opts
, "ipv6"),
1420 .ipv6
= qemu_opt_get_bool(opts
, "ipv6", 0),
1423 addr
->type
= SOCKET_ADDRESS_LEGACY_KIND_FD
;
1424 addr
->u
.fd
.data
= g_new(String
, 1);
1425 addr
->u
.fd
.data
->str
= g_strdup(fd
);
1427 g_assert_not_reached();
1433 char_socket_get_addr(Object
*obj
, Visitor
*v
, const char *name
,
1434 void *opaque
, Error
**errp
)
1436 SocketChardev
*s
= SOCKET_CHARDEV(obj
);
1438 visit_type_SocketAddress(v
, name
, &s
->addr
, errp
);
1442 char_socket_get_connected(Object
*obj
, Error
**errp
)
1444 SocketChardev
*s
= SOCKET_CHARDEV(obj
);
1446 return s
->state
== TCP_CHARDEV_STATE_CONNECTED
;
1449 static void char_socket_class_init(ObjectClass
*oc
, void *data
)
1451 ChardevClass
*cc
= CHARDEV_CLASS(oc
);
1453 cc
->parse
= qemu_chr_parse_socket
;
1454 cc
->open
= qmp_chardev_open_socket
;
1455 cc
->chr_wait_connected
= tcp_chr_wait_connected
;
1456 cc
->chr_write
= tcp_chr_write
;
1457 cc
->chr_sync_read
= tcp_chr_sync_read
;
1458 cc
->chr_disconnect
= tcp_chr_disconnect
;
1459 cc
->get_msgfds
= tcp_get_msgfds
;
1460 cc
->set_msgfds
= tcp_set_msgfds
;
1461 cc
->chr_add_client
= tcp_chr_add_client
;
1462 cc
->chr_add_watch
= tcp_chr_add_watch
;
1463 cc
->chr_update_read_handler
= tcp_chr_update_read_handler
;
1465 object_class_property_add(oc
, "addr", "SocketAddress",
1466 char_socket_get_addr
, NULL
,
1467 NULL
, NULL
, &error_abort
);
1469 object_class_property_add_bool(oc
, "connected", char_socket_get_connected
,
1470 NULL
, &error_abort
);
1473 static const TypeInfo char_socket_type_info
= {
1474 .name
= TYPE_CHARDEV_SOCKET
,
1475 .parent
= TYPE_CHARDEV
,
1476 .instance_size
= sizeof(SocketChardev
),
1477 .instance_finalize
= char_socket_finalize
,
1478 .class_init
= char_socket_class_init
,
1481 static void register_types(void)
1483 type_register_static(&char_socket_type_info
);
1486 type_init(register_types
);