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
24 #include "qemu/osdep.h"
28 #include "monitor/monitor.h"
29 #include "qapi/error.h"
30 #include "qemu-common.h"
31 #include "qemu/error-report.h"
32 #include "qemu/option.h"
33 #include "qemu/sockets.h"
35 #include "qemu/main-loop.h"
37 typedef struct NetSocketState {
42 unsigned int send_index; /* number of bytes sent (only SOCK_STREAM) */
43 struct sockaddr_in dgram_dst; /* contains inet host and port destination iff connectionless (SOCK_DGRAM) */
44 IOHandler *send_fn; /* differs between SOCK_STREAM/SOCK_DGRAM */
45 bool read_poll; /* waiting to receive data? */
46 bool write_poll; /* waiting to transmit data? */
49 static void net_socket_accept(void *opaque);
50 static void net_socket_writable(void *opaque);
52 static void net_socket_update_fd_handler(NetSocketState *s)
54 qemu_set_fd_handler(s->fd,
55 s->read_poll ? s->send_fn : NULL,
56 s->write_poll ? net_socket_writable : NULL,
60 static void net_socket_read_poll(NetSocketState *s, bool enable)
62 s->read_poll = enable;
63 net_socket_update_fd_handler(s);
66 static void net_socket_write_poll(NetSocketState *s, bool enable)
68 s->write_poll = enable;
69 net_socket_update_fd_handler(s);
72 static void net_socket_writable(void *opaque)
74 NetSocketState *s = opaque;
76 net_socket_write_poll(s, false);
78 qemu_flush_queued_packets(&s->nc);
81 static ssize_t net_socket_receive(NetClientState *nc, const uint8_t *buf, size_t size)
83 NetSocketState *s = DO_UPCAST(NetSocketState, nc, nc);
84 uint32_t len = htonl(size);
85 struct iovec iov[] = {
88 .iov_len = sizeof(len),
90 .iov_base = (void *)buf,
97 remaining = iov_size(iov, 2) - s->send_index;
98 ret = iov_send(s->fd, iov, 2, s->send_index, remaining);
100 if (ret == -1 && errno == EAGAIN) {
101 ret = 0; /* handled further down */
107 if (ret < (ssize_t)remaining) {
108 s->send_index += ret;
109 net_socket_write_poll(s, true);
116 static ssize_t net_socket_receive_dgram(NetClientState *nc, const uint8_t *buf, size_t size)
118 NetSocketState *s = DO_UPCAST(NetSocketState, nc, nc);
122 if (s->dgram_dst.sin_family != AF_UNIX) {
123 ret = qemu_sendto(s->fd, buf, size, 0,
124 (struct sockaddr *)&s->dgram_dst,
125 sizeof(s->dgram_dst));
127 ret = send(s->fd, buf, size, 0);
129 } while (ret == -1 && errno == EINTR);
131 if (ret == -1 && errno == EAGAIN) {
132 net_socket_write_poll(s, true);
138 static void net_socket_send_completed(NetClientState *nc, ssize_t len)
140 NetSocketState *s = DO_UPCAST(NetSocketState, nc, nc);
143 net_socket_read_poll(s, true);
147 static void net_socket_rs_finalize(SocketReadState *rs)
149 NetSocketState *s = container_of(rs, NetSocketState, rs);
151 if (qemu_send_packet_async(&s->nc, rs->buf,
153 net_socket_send_completed) == 0) {
154 net_socket_read_poll(s, false);
158 static void net_socket_send(void *opaque)
160 NetSocketState *s = opaque;
163 uint8_t buf1[NET_BUFSIZE];
166 size = qemu_recv(s->fd, buf1, sizeof(buf1), 0);
168 if (errno != EWOULDBLOCK)
170 } else if (size == 0) {
171 /* end of connection */
173 net_socket_read_poll(s, false);
174 net_socket_write_poll(s, false);
175 if (s->listen_fd != -1) {
176 qemu_set_fd_handler(s->listen_fd, net_socket_accept, NULL, s);
181 net_socket_rs_init(&s->rs, net_socket_rs_finalize, false);
182 s->nc.link_down = true;
188 ret = net_fill_rstate(&s->rs, buf, size);
195 static void net_socket_send_dgram(void *opaque)
197 NetSocketState *s = opaque;
200 size = qemu_recv(s->fd, s->rs.buf, sizeof(s->rs.buf), 0);
204 /* end of connection */
205 net_socket_read_poll(s, false);
206 net_socket_write_poll(s, false);
209 if (qemu_send_packet_async(&s->nc, s->rs.buf, size,
210 net_socket_send_completed) == 0) {
211 net_socket_read_poll(s, false);
215 static int net_socket_mcast_create(struct sockaddr_in *mcastaddr,
216 struct in_addr *localaddr,
228 if (!IN_MULTICAST(ntohl(mcastaddr->sin_addr.s_addr))) {
229 error_setg(errp, "specified mcastaddr %s (0x%08x) "
230 "does not contain a multicast address",
231 inet_ntoa(mcastaddr->sin_addr),
232 (int)ntohl(mcastaddr->sin_addr.s_addr));
236 fd = qemu_socket(PF_INET, SOCK_DGRAM, 0);
238 error_setg_errno(errp, errno, "can't create datagram socket");
242 /* Allow multiple sockets to bind the same multicast ip and port by setting
243 * SO_REUSEADDR. This is the only situation where SO_REUSEADDR should be set
244 * on windows. Use socket_set_fast_reuse otherwise as it sets SO_REUSEADDR
245 * only on posix systems.
248 ret = qemu_setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &val, sizeof(val));
250 error_setg_errno(errp, errno,
251 "can't set socket option SO_REUSEADDR");
255 ret = bind(fd, (struct sockaddr *)mcastaddr, sizeof(*mcastaddr));
257 error_setg_errno(errp, errno, "can't bind ip=%s to socket",
258 inet_ntoa(mcastaddr->sin_addr));
262 /* Add host to multicast group */
263 imr.imr_multiaddr = mcastaddr->sin_addr;
265 imr.imr_interface = *localaddr;
267 imr.imr_interface.s_addr = htonl(INADDR_ANY);
270 ret = qemu_setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
271 &imr, sizeof(struct ip_mreq));
273 error_setg_errno(errp, errno,
274 "can't add socket to multicast group %s",
275 inet_ntoa(imr.imr_multiaddr));
279 /* Force mcast msgs to loopback (eg. several QEMUs in same host */
281 ret = qemu_setsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP,
282 &loop, sizeof(loop));
284 error_setg_errno(errp, errno,
285 "can't force multicast message to loopback");
289 /* If a bind address is given, only send packets from that address */
290 if (localaddr != NULL) {
291 ret = qemu_setsockopt(fd, IPPROTO_IP, IP_MULTICAST_IF,
292 localaddr, sizeof(*localaddr));
294 error_setg_errno(errp, errno,
295 "can't set the default network send interface");
300 qemu_set_nonblock(fd);
308 static void net_socket_cleanup(NetClientState *nc)
310 NetSocketState *s = DO_UPCAST(NetSocketState, nc, nc);
312 net_socket_read_poll(s, false);
313 net_socket_write_poll(s, false);
317 if (s->listen_fd != -1) {
318 qemu_set_fd_handler(s->listen_fd, NULL, NULL, NULL);
319 closesocket(s->listen_fd);
324 static NetClientInfo net_dgram_socket_info = {
325 .type = NET_CLIENT_DRIVER_SOCKET,
326 .size = sizeof(NetSocketState),
327 .receive = net_socket_receive_dgram,
328 .cleanup = net_socket_cleanup,
331 static NetSocketState *net_socket_fd_init_dgram(NetClientState *peer,
334 int fd, int is_connected,
338 struct sockaddr_in saddr;
343 SocketAddressType sa_type;
344 NetdevSocketOptions *stored;
346 sa = socket_local_address(fd, errp);
351 qapi_free_SocketAddress(sa);
353 /* fd passed: multicast: "learn" dgram_dst address from bound address and save it
354 * Because this may be "shared" socket from a "master" process, datagrams would be recv()
355 * by ONLY ONE process: we must "clone" this dgram socket --jjo
358 if (is_connected && mcast != NULL) {
359 if (parse_host_port(&saddr, mcast, errp) < 0) {
363 if (saddr.sin_addr.s_addr == 0) {
364 error_setg(errp, "can't setup multicast destination address");
367 /* clone dgram socket */
368 newfd = net_socket_mcast_create(&saddr, NULL, errp);
372 /* clone newfd to fd, close newfd */
378 nc = qemu_new_net_client(&net_dgram_socket_info, peer, model, name);
380 s = DO_UPCAST(NetSocketState, nc, nc);
384 s->send_fn = net_socket_send_dgram;
385 net_socket_rs_init(&s->rs, net_socket_rs_finalize, false);
386 net_socket_read_poll(s, true);
388 /* Store startup parameters */
389 nc->stored_config = g_new0(NetdevInfo, 1);
390 nc->stored_config->type = NET_BACKEND_SOCKET;
391 stored = &nc->stored_config->u.socket;
393 stored->has_fd = true;
394 stored->fd = g_strdup_printf("%d", fd);
396 /* mcast: save bound address as dst */
397 if (is_connected && mcast != NULL) {
398 stored->has_mcast = true;
399 stored->mcast = g_strdup(mcast);
401 s->dgram_dst = saddr;
403 if (sa_type == SOCKET_ADDRESS_TYPE_UNIX) {
404 s->dgram_dst.sin_family = AF_UNIX;
415 static void net_socket_connect(void *opaque)
417 NetSocketState *s = opaque;
418 s->send_fn = net_socket_send;
419 net_socket_read_poll(s, true);
422 static NetClientInfo net_socket_info = {
423 .type = NET_CLIENT_DRIVER_SOCKET,
424 .size = sizeof(NetSocketState),
425 .receive = net_socket_receive,
426 .cleanup = net_socket_cleanup,
429 static NetSocketState *net_socket_fd_init_stream(NetClientState *peer,
432 int fd, int is_connected)
436 NetdevSocketOptions *stored;
438 nc = qemu_new_net_client(&net_socket_info, peer, model, name);
440 s = DO_UPCAST(NetSocketState, nc, nc);
444 net_socket_rs_init(&s->rs, net_socket_rs_finalize, false);
446 /* Disable Nagle algorithm on TCP sockets to reduce latency */
447 socket_set_nodelay(fd);
450 net_socket_connect(s);
452 qemu_set_fd_handler(s->fd, NULL, net_socket_connect, s);
455 /* Store startup parameters */
456 nc->stored_config = g_new0(NetdevInfo, 1);
457 nc->stored_config->type = NET_BACKEND_SOCKET;
458 stored = &nc->stored_config->u.socket;
460 stored->has_fd = true;
461 stored->fd = g_strdup_printf("%d", fd);
466 static NetSocketState *net_socket_fd_init(NetClientState *peer,
467 const char *model, const char *name,
468 int fd, int is_connected,
469 const char *mc, Error **errp)
471 int so_type = -1, optlen=sizeof(so_type);
473 if(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&so_type,
474 (socklen_t *)&optlen)< 0) {
475 error_setg(errp, "can't get socket option SO_TYPE");
481 return net_socket_fd_init_dgram(peer, model, name, fd, is_connected,
484 return net_socket_fd_init_stream(peer, model, name, fd, is_connected);
486 error_setg(errp, "socket type=%d for fd=%d must be either"
487 " SOCK_DGRAM or SOCK_STREAM", so_type, fd);
493 static void net_socket_accept(void *opaque)
495 NetSocketState *s = opaque;
496 struct sockaddr_in saddr;
499 NetdevSocketOptions *stored;
503 fd = qemu_accept(s->listen_fd, (struct sockaddr *)&saddr, &len);
504 if (fd < 0 && errno != EINTR) {
506 } else if (fd >= 0) {
507 qemu_set_fd_handler(s->listen_fd, NULL, NULL, NULL);
513 s->nc.link_down = false;
514 net_socket_connect(s);
516 /* Store additional startup parameters (extend net_socket_listen_init) */
517 stored = &s->nc.stored_config->u.socket;
519 stored->has_fd = true;
520 stored->fd = g_strdup_printf("%d", fd);
523 static int net_socket_listen_init(NetClientState *peer,
526 const char *host_str,
531 struct sockaddr_in saddr;
533 NetdevSocketOptions *stored;
535 if (parse_host_port(&saddr, host_str, errp) < 0) {
539 fd = qemu_socket(PF_INET, SOCK_STREAM, 0);
541 error_setg_errno(errp, errno, "can't create stream socket");
544 qemu_set_nonblock(fd);
546 socket_set_fast_reuse(fd);
548 ret = bind(fd, (struct sockaddr *)&saddr, sizeof(saddr));
550 error_setg_errno(errp, errno, "can't bind ip=%s to socket",
551 inet_ntoa(saddr.sin_addr));
557 error_setg_errno(errp, errno, "can't listen on socket");
562 nc = qemu_new_net_client(&net_socket_info, peer, model, name);
563 s = DO_UPCAST(NetSocketState, nc, nc);
566 s->nc.link_down = true;
567 net_socket_rs_init(&s->rs, net_socket_rs_finalize, false);
569 qemu_set_fd_handler(s->listen_fd, net_socket_accept, NULL, s);
571 /* Store startup parameters */
572 nc->stored_config = g_new0(NetdevInfo, 1);
573 nc->stored_config->type = NET_BACKEND_SOCKET;
574 stored = &nc->stored_config->u.socket;
576 stored->has_listen = true;
577 stored->listen = g_strdup(host_str);
582 static int net_socket_connect_init(NetClientState *peer,
585 const char *host_str,
589 int fd, connected, ret;
590 struct sockaddr_in saddr;
591 NetdevSocketOptions *stored;
593 if (parse_host_port(&saddr, host_str, errp) < 0) {
597 fd = qemu_socket(PF_INET, SOCK_STREAM, 0);
599 error_setg_errno(errp, errno, "can't create stream socket");
602 qemu_set_nonblock(fd);
606 ret = connect(fd, (struct sockaddr *)&saddr, sizeof(saddr));
608 if (errno == EINTR || errno == EWOULDBLOCK) {
610 } else if (errno == EINPROGRESS ||
615 error_setg_errno(errp, errno, "can't connect socket");
624 s = net_socket_fd_init(peer, model, name, fd, connected, NULL, errp);
629 /* Store additional startup parameters (extend net_socket_fd_init) */
630 stored = &s->nc.stored_config->u.socket;
632 stored->has_connect = true;
633 stored->connect = g_strdup(host_str);
638 static int net_socket_mcast_init(NetClientState *peer,
641 const char *host_str,
642 const char *localaddr_str,
647 struct sockaddr_in saddr;
648 struct in_addr localaddr, *param_localaddr;
649 NetdevSocketOptions *stored;
651 if (parse_host_port(&saddr, host_str, errp) < 0) {
655 if (localaddr_str != NULL) {
656 if (inet_aton(localaddr_str, &localaddr) == 0) {
657 error_setg(errp, "localaddr '%s' is not a valid IPv4 address",
661 param_localaddr = &localaddr;
663 param_localaddr = NULL;
666 fd = net_socket_mcast_create(&saddr, param_localaddr, errp);
671 s = net_socket_fd_init(peer, model, name, fd, 0, NULL, errp);
676 s->dgram_dst = saddr;
678 /* Store additional startup parameters (extend net_socket_fd_init) */
679 stored = &s->nc.stored_config->u.socket;
681 if (!stored->has_mcast) {
682 stored->has_mcast = true;
683 stored->mcast = g_strdup(host_str);
687 stored->has_localaddr = true;
688 stored->localaddr = g_strdup(localaddr_str);
694 static int net_socket_udp_init(NetClientState *peer,
703 struct sockaddr_in laddr, raddr;
704 NetdevSocketOptions *stored;
706 if (parse_host_port(&laddr, lhost, errp) < 0) {
710 if (parse_host_port(&raddr, rhost, errp) < 0) {
714 fd = qemu_socket(PF_INET, SOCK_DGRAM, 0);
716 error_setg_errno(errp, errno, "can't create datagram socket");
720 ret = socket_set_fast_reuse(fd);
722 error_setg_errno(errp, errno,
723 "can't set socket option SO_REUSEADDR");
727 ret = bind(fd, (struct sockaddr *)&laddr, sizeof(laddr));
729 error_setg_errno(errp, errno, "can't bind ip=%s to socket",
730 inet_ntoa(laddr.sin_addr));
734 qemu_set_nonblock(fd);
736 s = net_socket_fd_init(peer, model, name, fd, 0, NULL, errp);
741 s->dgram_dst = raddr;
743 /* Store additional startup parameters (extend net_socket_fd_init) */
744 stored = &s->nc.stored_config->u.socket;
746 stored->has_localaddr = true;
747 stored->localaddr = g_strdup(lhost);
749 stored->has_udp = true;
750 stored->udp = g_strdup(rhost);
755 int net_init_socket(const Netdev *netdev, const char *name,
756 NetClientState *peer, Error **errp)
758 const NetdevSocketOptions *sock;
760 assert(netdev->type == NET_CLIENT_DRIVER_SOCKET);
761 sock = &netdev->u.socket;
763 if (sock->has_fd + sock->has_listen + sock->has_connect + sock->has_mcast +
764 sock->has_udp != 1) {
765 error_setg(errp, "exactly one of listen=, connect=, mcast= or udp="
770 if (sock->has_localaddr && !sock->has_mcast && !sock->has_udp) {
771 error_setg(errp, "localaddr= is only valid with mcast= or udp=");
778 fd = monitor_fd_param(monitor_cur(), sock->fd, errp);
782 ret = qemu_try_set_nonblock(fd);
784 error_setg_errno(errp, -ret, "%s: Can't use file descriptor %d",
788 if (!net_socket_fd_init(peer, "socket", name, fd, 1, sock->mcast,
795 if (sock->has_listen) {
796 if (net_socket_listen_init(peer, "socket", name, sock->listen, errp)
803 if (sock->has_connect) {
804 if (net_socket_connect_init(peer, "socket", name, sock->connect, errp)
811 if (sock->has_mcast) {
812 /* if sock->localaddr is missing, it has been initialized to "all bits
814 if (net_socket_mcast_init(peer, "socket", name, sock->mcast,
815 sock->localaddr, errp) < 0) {
821 assert(sock->has_udp);
822 if (!sock->has_localaddr) {
823 error_setg(errp, "localaddr= is mandatory with udp=");
826 if (net_socket_udp_init(peer, "socket", name, sock->udp, sock->localaddr,