2 * QEMU I/O channels sockets driver
4 * Copyright (c) 2015 Red Hat, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 #include "qemu/osdep.h"
22 #include "qapi/error.h"
23 #include "io/channel-socket.h"
24 #include "io/channel-watch.h"
26 #include "qapi/clone-visitor.h"
28 #define SOCKET_MAX_FDS 16
31 qio_channel_socket_get_local_address(QIOChannelSocket
*ioc
,
34 return socket_sockaddr_to_address(&ioc
->localAddr
,
40 qio_channel_socket_get_remote_address(QIOChannelSocket
*ioc
,
43 return socket_sockaddr_to_address(&ioc
->remoteAddr
,
49 qio_channel_socket_new(void)
51 QIOChannelSocket
*sioc
;
54 sioc
= QIO_CHANNEL_SOCKET(object_new(TYPE_QIO_CHANNEL_SOCKET
));
57 ioc
= QIO_CHANNEL(sioc
);
58 qio_channel_set_feature(ioc
, QIO_CHANNEL_FEATURE_SHUTDOWN
);
61 ioc
->event
= CreateEvent(NULL
, FALSE
, FALSE
, NULL
);
64 trace_qio_channel_socket_new(sioc
);
71 qio_channel_socket_set_fd(QIOChannelSocket
*sioc
,
76 error_setg(errp
, "Socket is already open");
81 sioc
->remoteAddrLen
= sizeof(sioc
->remoteAddr
);
82 sioc
->localAddrLen
= sizeof(sioc
->localAddr
);
85 if (getpeername(fd
, (struct sockaddr
*)&sioc
->remoteAddr
,
86 &sioc
->remoteAddrLen
) < 0) {
87 if (errno
== ENOTCONN
) {
88 memset(&sioc
->remoteAddr
, 0, sizeof(sioc
->remoteAddr
));
89 sioc
->remoteAddrLen
= sizeof(sioc
->remoteAddr
);
91 error_setg_errno(errp
, errno
,
92 "Unable to query remote socket address");
97 if (getsockname(fd
, (struct sockaddr
*)&sioc
->localAddr
,
98 &sioc
->localAddrLen
) < 0) {
99 error_setg_errno(errp
, errno
,
100 "Unable to query local socket address");
105 if (sioc
->localAddr
.ss_family
== AF_UNIX
) {
106 QIOChannel
*ioc
= QIO_CHANNEL(sioc
);
107 qio_channel_set_feature(ioc
, QIO_CHANNEL_FEATURE_FD_PASS
);
114 sioc
->fd
= -1; /* Let the caller close FD on failure */
119 qio_channel_socket_new_fd(int fd
,
122 QIOChannelSocket
*ioc
;
124 ioc
= qio_channel_socket_new();
125 if (qio_channel_socket_set_fd(ioc
, fd
, errp
) < 0) {
126 object_unref(OBJECT(ioc
));
130 trace_qio_channel_socket_new_fd(ioc
, fd
);
136 int qio_channel_socket_connect_sync(QIOChannelSocket
*ioc
,
142 trace_qio_channel_socket_connect_sync(ioc
, addr
);
143 fd
= socket_connect(addr
, NULL
, NULL
, errp
);
145 trace_qio_channel_socket_connect_fail(ioc
);
149 trace_qio_channel_socket_connect_complete(ioc
, fd
);
150 if (qio_channel_socket_set_fd(ioc
, fd
, errp
) < 0) {
159 static void qio_channel_socket_connect_worker(QIOTask
*task
,
162 QIOChannelSocket
*ioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
163 SocketAddress
*addr
= opaque
;
166 qio_channel_socket_connect_sync(ioc
, addr
, &err
);
168 qio_task_set_error(task
, err
);
172 void qio_channel_socket_connect_async(QIOChannelSocket
*ioc
,
174 QIOTaskFunc callback
,
176 GDestroyNotify destroy
)
178 QIOTask
*task
= qio_task_new(
179 OBJECT(ioc
), callback
, opaque
, destroy
);
180 SocketAddress
*addrCopy
;
182 addrCopy
= QAPI_CLONE(SocketAddress
, addr
);
184 /* socket_connect() does a non-blocking connect(), but it
185 * still blocks in DNS lookups, so we must use a thread */
186 trace_qio_channel_socket_connect_async(ioc
, addr
);
187 qio_task_run_in_thread(task
,
188 qio_channel_socket_connect_worker
,
190 (GDestroyNotify
)qapi_free_SocketAddress
);
194 int qio_channel_socket_listen_sync(QIOChannelSocket
*ioc
,
200 trace_qio_channel_socket_listen_sync(ioc
, addr
);
201 fd
= socket_listen(addr
, errp
);
203 trace_qio_channel_socket_listen_fail(ioc
);
207 trace_qio_channel_socket_listen_complete(ioc
, fd
);
208 if (qio_channel_socket_set_fd(ioc
, fd
, errp
) < 0) {
212 qio_channel_set_feature(QIO_CHANNEL(ioc
), QIO_CHANNEL_FEATURE_LISTEN
);
218 static void qio_channel_socket_listen_worker(QIOTask
*task
,
221 QIOChannelSocket
*ioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
222 SocketAddress
*addr
= opaque
;
225 qio_channel_socket_listen_sync(ioc
, addr
, &err
);
227 qio_task_set_error(task
, err
);
231 void qio_channel_socket_listen_async(QIOChannelSocket
*ioc
,
233 QIOTaskFunc callback
,
235 GDestroyNotify destroy
)
237 QIOTask
*task
= qio_task_new(
238 OBJECT(ioc
), callback
, opaque
, destroy
);
239 SocketAddress
*addrCopy
;
241 addrCopy
= QAPI_CLONE(SocketAddress
, addr
);
243 /* socket_listen() blocks in DNS lookups, so we must use a thread */
244 trace_qio_channel_socket_listen_async(ioc
, addr
);
245 qio_task_run_in_thread(task
,
246 qio_channel_socket_listen_worker
,
248 (GDestroyNotify
)qapi_free_SocketAddress
);
252 int qio_channel_socket_dgram_sync(QIOChannelSocket
*ioc
,
253 SocketAddress
*localAddr
,
254 SocketAddress
*remoteAddr
,
259 trace_qio_channel_socket_dgram_sync(ioc
, localAddr
, remoteAddr
);
260 fd
= socket_dgram(remoteAddr
, localAddr
, errp
);
262 trace_qio_channel_socket_dgram_fail(ioc
);
266 trace_qio_channel_socket_dgram_complete(ioc
, fd
);
267 if (qio_channel_socket_set_fd(ioc
, fd
, errp
) < 0) {
276 struct QIOChannelSocketDGramWorkerData
{
277 SocketAddress
*localAddr
;
278 SocketAddress
*remoteAddr
;
282 static void qio_channel_socket_dgram_worker_free(gpointer opaque
)
284 struct QIOChannelSocketDGramWorkerData
*data
= opaque
;
285 qapi_free_SocketAddress(data
->localAddr
);
286 qapi_free_SocketAddress(data
->remoteAddr
);
290 static void qio_channel_socket_dgram_worker(QIOTask
*task
,
293 QIOChannelSocket
*ioc
= QIO_CHANNEL_SOCKET(qio_task_get_source(task
));
294 struct QIOChannelSocketDGramWorkerData
*data
= opaque
;
297 /* socket_dgram() blocks in DNS lookups, so we must use a thread */
298 qio_channel_socket_dgram_sync(ioc
, data
->localAddr
,
299 data
->remoteAddr
, &err
);
301 qio_task_set_error(task
, err
);
305 void qio_channel_socket_dgram_async(QIOChannelSocket
*ioc
,
306 SocketAddress
*localAddr
,
307 SocketAddress
*remoteAddr
,
308 QIOTaskFunc callback
,
310 GDestroyNotify destroy
)
312 QIOTask
*task
= qio_task_new(
313 OBJECT(ioc
), callback
, opaque
, destroy
);
314 struct QIOChannelSocketDGramWorkerData
*data
= g_new0(
315 struct QIOChannelSocketDGramWorkerData
, 1);
317 data
->localAddr
= QAPI_CLONE(SocketAddress
, localAddr
);
318 data
->remoteAddr
= QAPI_CLONE(SocketAddress
, remoteAddr
);
320 trace_qio_channel_socket_dgram_async(ioc
, localAddr
, remoteAddr
);
321 qio_task_run_in_thread(task
,
322 qio_channel_socket_dgram_worker
,
324 qio_channel_socket_dgram_worker_free
);
329 qio_channel_socket_accept(QIOChannelSocket
*ioc
,
332 QIOChannelSocket
*cioc
;
334 cioc
= qio_channel_socket_new();
335 cioc
->remoteAddrLen
= sizeof(ioc
->remoteAddr
);
336 cioc
->localAddrLen
= sizeof(ioc
->localAddr
);
339 trace_qio_channel_socket_accept(ioc
);
340 cioc
->fd
= qemu_accept(ioc
->fd
, (struct sockaddr
*)&cioc
->remoteAddr
,
341 &cioc
->remoteAddrLen
);
343 trace_qio_channel_socket_accept_fail(ioc
);
344 if (errno
== EINTR
) {
350 if (getsockname(cioc
->fd
, (struct sockaddr
*)&cioc
->localAddr
,
351 &cioc
->localAddrLen
) < 0) {
352 error_setg_errno(errp
, errno
,
353 "Unable to query local socket address");
358 if (cioc
->localAddr
.ss_family
== AF_UNIX
) {
359 QIOChannel
*ioc_local
= QIO_CHANNEL(cioc
);
360 qio_channel_set_feature(ioc_local
, QIO_CHANNEL_FEATURE_FD_PASS
);
364 trace_qio_channel_socket_accept_complete(ioc
, cioc
, cioc
->fd
);
368 object_unref(OBJECT(cioc
));
372 static void qio_channel_socket_init(Object
*obj
)
374 QIOChannelSocket
*ioc
= QIO_CHANNEL_SOCKET(obj
);
378 static void qio_channel_socket_finalize(Object
*obj
)
380 QIOChannelSocket
*ioc
= QIO_CHANNEL_SOCKET(obj
);
383 QIOChannel
*ioc_local
= QIO_CHANNEL(ioc
);
384 if (qio_channel_has_feature(ioc_local
, QIO_CHANNEL_FEATURE_LISTEN
)) {
387 socket_listen_cleanup(ioc
->fd
, &err
);
389 error_report_err(err
);
394 WSAEventSelect(ioc
->fd
, NULL
, 0);
396 closesocket(ioc
->fd
);
403 static void qio_channel_socket_copy_fds(struct msghdr
*msg
,
404 int **fds
, size_t *nfds
)
406 struct cmsghdr
*cmsg
;
411 for (cmsg
= CMSG_FIRSTHDR(msg
); cmsg
; cmsg
= CMSG_NXTHDR(msg
, cmsg
)) {
415 if (cmsg
->cmsg_len
< CMSG_LEN(sizeof(int)) ||
416 cmsg
->cmsg_level
!= SOL_SOCKET
||
417 cmsg
->cmsg_type
!= SCM_RIGHTS
) {
421 fd_size
= cmsg
->cmsg_len
- CMSG_LEN(0);
427 gotfds
= fd_size
/ sizeof(int);
428 *fds
= g_renew(int, *fds
, *nfds
+ gotfds
);
429 memcpy(*fds
+ *nfds
, CMSG_DATA(cmsg
), fd_size
);
431 for (i
= 0; i
< gotfds
; i
++) {
432 int fd
= (*fds
)[*nfds
+ i
];
437 /* O_NONBLOCK is preserved across SCM_RIGHTS so reset it */
440 #ifndef MSG_CMSG_CLOEXEC
441 qemu_set_cloexec(fd
);
449 static ssize_t
qio_channel_socket_readv(QIOChannel
*ioc
,
450 const struct iovec
*iov
,
456 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
458 struct msghdr msg
= { NULL
, };
459 char control
[CMSG_SPACE(sizeof(int) * SOCKET_MAX_FDS
)];
462 memset(control
, 0, CMSG_SPACE(sizeof(int) * SOCKET_MAX_FDS
));
464 #ifdef MSG_CMSG_CLOEXEC
465 sflags
|= MSG_CMSG_CLOEXEC
;
468 msg
.msg_iov
= (struct iovec
*)iov
;
469 msg
.msg_iovlen
= niov
;
471 msg
.msg_control
= control
;
472 msg
.msg_controllen
= sizeof(control
);
476 ret
= recvmsg(sioc
->fd
, &msg
, sflags
);
478 if (errno
== EAGAIN
) {
479 return QIO_CHANNEL_ERR_BLOCK
;
481 if (errno
== EINTR
) {
485 error_setg_errno(errp
, errno
,
486 "Unable to read from socket");
491 qio_channel_socket_copy_fds(&msg
, fds
, nfds
);
497 static ssize_t
qio_channel_socket_writev(QIOChannel
*ioc
,
498 const struct iovec
*iov
,
504 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
506 struct msghdr msg
= { NULL
, };
507 char control
[CMSG_SPACE(sizeof(int) * SOCKET_MAX_FDS
)];
508 size_t fdsize
= sizeof(int) * nfds
;
509 struct cmsghdr
*cmsg
;
511 memset(control
, 0, CMSG_SPACE(sizeof(int) * SOCKET_MAX_FDS
));
513 msg
.msg_iov
= (struct iovec
*)iov
;
514 msg
.msg_iovlen
= niov
;
517 if (nfds
> SOCKET_MAX_FDS
) {
518 error_setg_errno(errp
, EINVAL
,
519 "Only %d FDs can be sent, got %zu",
520 SOCKET_MAX_FDS
, nfds
);
524 msg
.msg_control
= control
;
525 msg
.msg_controllen
= CMSG_SPACE(sizeof(int) * nfds
);
527 cmsg
= CMSG_FIRSTHDR(&msg
);
528 cmsg
->cmsg_len
= CMSG_LEN(fdsize
);
529 cmsg
->cmsg_level
= SOL_SOCKET
;
530 cmsg
->cmsg_type
= SCM_RIGHTS
;
531 memcpy(CMSG_DATA(cmsg
), fds
, fdsize
);
535 ret
= sendmsg(sioc
->fd
, &msg
, 0);
537 if (errno
== EAGAIN
) {
538 return QIO_CHANNEL_ERR_BLOCK
;
540 if (errno
== EINTR
) {
543 error_setg_errno(errp
, errno
,
544 "Unable to write to socket");
550 static ssize_t
qio_channel_socket_readv(QIOChannel
*ioc
,
551 const struct iovec
*iov
,
557 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
561 for (i
= 0; i
< niov
; i
++) {
569 if (errno
== EAGAIN
) {
573 return QIO_CHANNEL_ERR_BLOCK
;
575 } else if (errno
== EINTR
) {
578 error_setg_errno(errp
, errno
,
579 "Unable to read from socket");
584 if (ret
< iov
[i
].iov_len
) {
592 static ssize_t
qio_channel_socket_writev(QIOChannel
*ioc
,
593 const struct iovec
*iov
,
599 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
603 for (i
= 0; i
< niov
; i
++) {
611 if (errno
== EAGAIN
) {
615 return QIO_CHANNEL_ERR_BLOCK
;
617 } else if (errno
== EINTR
) {
620 error_setg_errno(errp
, errno
,
621 "Unable to write to socket");
626 if (ret
< iov
[i
].iov_len
) {
636 qio_channel_socket_set_blocking(QIOChannel
*ioc
,
640 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
643 qemu_set_block(sioc
->fd
);
645 qemu_set_nonblock(sioc
->fd
);
652 qio_channel_socket_set_delay(QIOChannel
*ioc
,
655 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
656 int v
= enabled
? 0 : 1;
658 qemu_setsockopt(sioc
->fd
,
659 IPPROTO_TCP
, TCP_NODELAY
,
665 qio_channel_socket_set_cork(QIOChannel
*ioc
,
668 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
669 int v
= enabled
? 1 : 0;
671 socket_set_cork(sioc
->fd
, v
);
676 qio_channel_socket_close(QIOChannel
*ioc
,
679 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
681 if (sioc
->fd
!= -1) {
683 WSAEventSelect(sioc
->fd
, NULL
, 0);
685 if (closesocket(sioc
->fd
) < 0) {
687 error_setg_errno(errp
, errno
,
688 "Unable to close socket");
697 qio_channel_socket_shutdown(QIOChannel
*ioc
,
698 QIOChannelShutdown how
,
701 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
705 case QIO_CHANNEL_SHUTDOWN_READ
:
708 case QIO_CHANNEL_SHUTDOWN_WRITE
:
711 case QIO_CHANNEL_SHUTDOWN_BOTH
:
717 if (shutdown(sioc
->fd
, sockhow
) < 0) {
718 error_setg_errno(errp
, errno
,
719 "Unable to shutdown socket");
725 static void qio_channel_socket_set_aio_fd_handler(QIOChannel
*ioc
,
731 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
732 aio_set_fd_handler(ctx
, sioc
->fd
, false, io_read
, io_write
, NULL
, opaque
);
735 static GSource
*qio_channel_socket_create_watch(QIOChannel
*ioc
,
736 GIOCondition condition
)
738 QIOChannelSocket
*sioc
= QIO_CHANNEL_SOCKET(ioc
);
739 return qio_channel_create_socket_watch(ioc
,
744 static void qio_channel_socket_class_init(ObjectClass
*klass
,
745 void *class_data G_GNUC_UNUSED
)
747 QIOChannelClass
*ioc_klass
= QIO_CHANNEL_CLASS(klass
);
749 ioc_klass
->io_writev
= qio_channel_socket_writev
;
750 ioc_klass
->io_readv
= qio_channel_socket_readv
;
751 ioc_klass
->io_set_blocking
= qio_channel_socket_set_blocking
;
752 ioc_klass
->io_close
= qio_channel_socket_close
;
753 ioc_klass
->io_shutdown
= qio_channel_socket_shutdown
;
754 ioc_klass
->io_set_cork
= qio_channel_socket_set_cork
;
755 ioc_klass
->io_set_delay
= qio_channel_socket_set_delay
;
756 ioc_klass
->io_create_watch
= qio_channel_socket_create_watch
;
757 ioc_klass
->io_set_aio_fd_handler
= qio_channel_socket_set_aio_fd_handler
;
760 static const TypeInfo qio_channel_socket_info
= {
761 .parent
= TYPE_QIO_CHANNEL
,
762 .name
= TYPE_QIO_CHANNEL_SOCKET
,
763 .instance_size
= sizeof(QIOChannelSocket
),
764 .instance_init
= qio_channel_socket_init
,
765 .instance_finalize
= qio_channel_socket_finalize
,
766 .class_init
= qio_channel_socket_class_init
,
769 static void qio_channel_socket_register_types(void)
771 type_register_static(&qio_channel_socket_info
);
774 type_init(qio_channel_socket_register_types
);