compiler: use weak aliases to provide default definitions
[qemu/opensuse.git] / net / socket.c
blobb75d567695c50fe1c8226131ffe651d4f11116bb
1 /*
2 * QEMU System Emulator
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
22 * THE SOFTWARE.
24 #include "config-host.h"
26 #include "net.h"
27 #include "clients.h"
28 #include "monitor.h"
29 #include "qemu-char.h"
30 #include "qemu-common.h"
31 #include "qemu-error.h"
32 #include "qemu-option.h"
33 #include "qemu_socket.h"
34 #include "iov.h"
36 typedef struct NetSocketState {
37 NetClientState nc;
38 int listen_fd;
39 int fd;
40 int state; /* 0 = getting length, 1 = getting data */
41 unsigned int index;
42 unsigned int packet_len;
43 unsigned int send_index; /* number of bytes sent (only SOCK_STREAM) */
44 uint8_t buf[4096];
45 struct sockaddr_in dgram_dst; /* contains inet host and port destination iff connectionless (SOCK_DGRAM) */
46 IOHandler *send_fn; /* differs between SOCK_STREAM/SOCK_DGRAM */
47 bool read_poll; /* waiting to receive data? */
48 bool write_poll; /* waiting to transmit data? */
49 } NetSocketState;
51 static void net_socket_accept(void *opaque);
52 static void net_socket_writable(void *opaque);
54 /* Only read packets from socket when peer can receive them */
55 static int net_socket_can_send(void *opaque)
57 NetSocketState *s = opaque;
59 return qemu_can_send_packet(&s->nc);
62 static void net_socket_update_fd_handler(NetSocketState *s)
64 qemu_set_fd_handler2(s->fd,
65 s->read_poll ? net_socket_can_send : NULL,
66 s->read_poll ? s->send_fn : NULL,
67 s->write_poll ? net_socket_writable : NULL,
68 s);
71 static void net_socket_read_poll(NetSocketState *s, bool enable)
73 s->read_poll = enable;
74 net_socket_update_fd_handler(s);
77 static void net_socket_write_poll(NetSocketState *s, bool enable)
79 s->write_poll = enable;
80 net_socket_update_fd_handler(s);
83 static void net_socket_writable(void *opaque)
85 NetSocketState *s = opaque;
87 net_socket_write_poll(s, false);
89 qemu_flush_queued_packets(&s->nc);
92 static ssize_t net_socket_receive(NetClientState *nc, const uint8_t *buf, size_t size)
94 NetSocketState *s = DO_UPCAST(NetSocketState, nc, nc);
95 uint32_t len = htonl(size);
96 struct iovec iov[] = {
98 .iov_base = &len,
99 .iov_len = sizeof(len),
100 }, {
101 .iov_base = (void *)buf,
102 .iov_len = size,
105 size_t remaining;
106 ssize_t ret;
108 remaining = iov_size(iov, 2) - s->send_index;
109 ret = iov_send(s->fd, iov, 2, s->send_index, remaining);
111 if (ret == -1 && errno == EAGAIN) {
112 ret = 0; /* handled further down */
114 if (ret == -1) {
115 s->send_index = 0;
116 return -errno;
118 if (ret < (ssize_t)remaining) {
119 s->send_index += ret;
120 net_socket_write_poll(s, true);
121 return 0;
123 s->send_index = 0;
124 return size;
127 static ssize_t net_socket_receive_dgram(NetClientState *nc, const uint8_t *buf, size_t size)
129 NetSocketState *s = DO_UPCAST(NetSocketState, nc, nc);
130 ssize_t ret;
132 do {
133 ret = qemu_sendto(s->fd, buf, size, 0,
134 (struct sockaddr *)&s->dgram_dst,
135 sizeof(s->dgram_dst));
136 } while (ret == -1 && errno == EINTR);
138 if (ret == -1 && errno == EAGAIN) {
139 net_socket_write_poll(s, true);
140 return 0;
142 return ret;
145 static void net_socket_send(void *opaque)
147 NetSocketState *s = opaque;
148 int size, err;
149 unsigned l;
150 uint8_t buf1[4096];
151 const uint8_t *buf;
153 size = qemu_recv(s->fd, buf1, sizeof(buf1), 0);
154 if (size < 0) {
155 err = socket_error();
156 if (err != EWOULDBLOCK)
157 goto eoc;
158 } else if (size == 0) {
159 /* end of connection */
160 eoc:
161 net_socket_read_poll(s, false);
162 net_socket_write_poll(s, false);
163 if (s->listen_fd != -1) {
164 qemu_set_fd_handler(s->listen_fd, net_socket_accept, NULL, s);
166 closesocket(s->fd);
168 s->fd = -1;
169 s->state = 0;
170 s->index = 0;
171 s->packet_len = 0;
172 s->nc.link_down = true;
173 memset(s->buf, 0, sizeof(s->buf));
174 memset(s->nc.info_str, 0, sizeof(s->nc.info_str));
176 return;
178 buf = buf1;
179 while (size > 0) {
180 /* reassemble a packet from the network */
181 switch(s->state) {
182 case 0:
183 l = 4 - s->index;
184 if (l > size)
185 l = size;
186 memcpy(s->buf + s->index, buf, l);
187 buf += l;
188 size -= l;
189 s->index += l;
190 if (s->index == 4) {
191 /* got length */
192 s->packet_len = ntohl(*(uint32_t *)s->buf);
193 s->index = 0;
194 s->state = 1;
196 break;
197 case 1:
198 l = s->packet_len - s->index;
199 if (l > size)
200 l = size;
201 if (s->index + l <= sizeof(s->buf)) {
202 memcpy(s->buf + s->index, buf, l);
203 } else {
204 fprintf(stderr, "serious error: oversized packet received,"
205 "connection terminated.\n");
206 s->state = 0;
207 goto eoc;
210 s->index += l;
211 buf += l;
212 size -= l;
213 if (s->index >= s->packet_len) {
214 qemu_send_packet(&s->nc, s->buf, s->packet_len);
215 s->index = 0;
216 s->state = 0;
218 break;
223 static void net_socket_send_dgram(void *opaque)
225 NetSocketState *s = opaque;
226 int size;
228 size = qemu_recv(s->fd, s->buf, sizeof(s->buf), 0);
229 if (size < 0)
230 return;
231 if (size == 0) {
232 /* end of connection */
233 net_socket_read_poll(s, false);
234 net_socket_write_poll(s, false);
235 return;
237 qemu_send_packet(&s->nc, s->buf, size);
240 static int net_socket_mcast_create(struct sockaddr_in *mcastaddr, struct in_addr *localaddr)
242 struct ip_mreq imr;
243 int fd;
244 int val, ret;
245 #ifdef __OpenBSD__
246 unsigned char loop;
247 #else
248 int loop;
249 #endif
251 if (!IN_MULTICAST(ntohl(mcastaddr->sin_addr.s_addr))) {
252 fprintf(stderr, "qemu: error: specified mcastaddr \"%s\" (0x%08x) "
253 "does not contain a multicast address\n",
254 inet_ntoa(mcastaddr->sin_addr),
255 (int)ntohl(mcastaddr->sin_addr.s_addr));
256 return -1;
259 fd = qemu_socket(PF_INET, SOCK_DGRAM, 0);
260 if (fd < 0) {
261 perror("socket(PF_INET, SOCK_DGRAM)");
262 return -1;
265 val = 1;
266 ret=setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,
267 (const char *)&val, sizeof(val));
268 if (ret < 0) {
269 perror("setsockopt(SOL_SOCKET, SO_REUSEADDR)");
270 goto fail;
273 ret = bind(fd, (struct sockaddr *)mcastaddr, sizeof(*mcastaddr));
274 if (ret < 0) {
275 perror("bind");
276 goto fail;
279 /* Add host to multicast group */
280 imr.imr_multiaddr = mcastaddr->sin_addr;
281 if (localaddr) {
282 imr.imr_interface = *localaddr;
283 } else {
284 imr.imr_interface.s_addr = htonl(INADDR_ANY);
287 ret = setsockopt(fd, IPPROTO_IP, IP_ADD_MEMBERSHIP,
288 (const char *)&imr, sizeof(struct ip_mreq));
289 if (ret < 0) {
290 perror("setsockopt(IP_ADD_MEMBERSHIP)");
291 goto fail;
294 /* Force mcast msgs to loopback (eg. several QEMUs in same host */
295 loop = 1;
296 ret=setsockopt(fd, IPPROTO_IP, IP_MULTICAST_LOOP,
297 (const char *)&loop, sizeof(loop));
298 if (ret < 0) {
299 perror("setsockopt(SOL_IP, IP_MULTICAST_LOOP)");
300 goto fail;
303 /* If a bind address is given, only send packets from that address */
304 if (localaddr != NULL) {
305 ret = setsockopt(fd, IPPROTO_IP, IP_MULTICAST_IF,
306 (const char *)localaddr, sizeof(*localaddr));
307 if (ret < 0) {
308 perror("setsockopt(IP_MULTICAST_IF)");
309 goto fail;
313 socket_set_nonblock(fd);
314 return fd;
315 fail:
316 if (fd >= 0)
317 closesocket(fd);
318 return -1;
321 static void net_socket_cleanup(NetClientState *nc)
323 NetSocketState *s = DO_UPCAST(NetSocketState, nc, nc);
324 if (s->fd != -1) {
325 net_socket_read_poll(s, false);
326 net_socket_write_poll(s, false);
327 close(s->fd);
328 s->fd = -1;
330 if (s->listen_fd != -1) {
331 qemu_set_fd_handler(s->listen_fd, NULL, NULL, NULL);
332 closesocket(s->listen_fd);
333 s->listen_fd = -1;
337 static NetClientInfo net_dgram_socket_info = {
338 .type = NET_CLIENT_OPTIONS_KIND_SOCKET,
339 .size = sizeof(NetSocketState),
340 .receive = net_socket_receive_dgram,
341 .cleanup = net_socket_cleanup,
344 static NetSocketState *net_socket_fd_init_dgram(NetClientState *peer,
345 const char *model,
346 const char *name,
347 int fd, int is_connected)
349 struct sockaddr_in saddr;
350 int newfd;
351 socklen_t saddr_len;
352 NetClientState *nc;
353 NetSocketState *s;
355 /* fd passed: multicast: "learn" dgram_dst address from bound address and save it
356 * Because this may be "shared" socket from a "master" process, datagrams would be recv()
357 * by ONLY ONE process: we must "clone" this dgram socket --jjo
360 if (is_connected) {
361 if (getsockname(fd, (struct sockaddr *) &saddr, &saddr_len) == 0) {
362 /* must be bound */
363 if (saddr.sin_addr.s_addr == 0) {
364 fprintf(stderr, "qemu: error: init_dgram: fd=%d unbound, "
365 "cannot setup multicast dst addr\n", fd);
366 goto err;
368 /* clone dgram socket */
369 newfd = net_socket_mcast_create(&saddr, NULL);
370 if (newfd < 0) {
371 /* error already reported by net_socket_mcast_create() */
372 goto err;
374 /* clone newfd to fd, close newfd */
375 dup2(newfd, fd);
376 close(newfd);
378 } else {
379 fprintf(stderr,
380 "qemu: error: init_dgram: fd=%d failed getsockname(): %s\n",
381 fd, strerror(errno));
382 goto err;
386 nc = qemu_new_net_client(&net_dgram_socket_info, peer, model, name);
388 snprintf(nc->info_str, sizeof(nc->info_str),
389 "socket: fd=%d (%s mcast=%s:%d)",
390 fd, is_connected ? "cloned" : "",
391 inet_ntoa(saddr.sin_addr), ntohs(saddr.sin_port));
393 s = DO_UPCAST(NetSocketState, nc, nc);
395 s->fd = fd;
396 s->listen_fd = -1;
397 s->send_fn = net_socket_send_dgram;
398 net_socket_read_poll(s, true);
400 /* mcast: save bound address as dst */
401 if (is_connected) {
402 s->dgram_dst = saddr;
405 return s;
407 err:
408 closesocket(fd);
409 return NULL;
412 static void net_socket_connect(void *opaque)
414 NetSocketState *s = opaque;
415 s->send_fn = net_socket_send;
416 net_socket_read_poll(s, true);
419 static NetClientInfo net_socket_info = {
420 .type = NET_CLIENT_OPTIONS_KIND_SOCKET,
421 .size = sizeof(NetSocketState),
422 .receive = net_socket_receive,
423 .cleanup = net_socket_cleanup,
426 static NetSocketState *net_socket_fd_init_stream(NetClientState *peer,
427 const char *model,
428 const char *name,
429 int fd, int is_connected)
431 NetClientState *nc;
432 NetSocketState *s;
434 nc = qemu_new_net_client(&net_socket_info, peer, model, name);
436 snprintf(nc->info_str, sizeof(nc->info_str), "socket: fd=%d", fd);
438 s = DO_UPCAST(NetSocketState, nc, nc);
440 s->fd = fd;
441 s->listen_fd = -1;
443 if (is_connected) {
444 net_socket_connect(s);
445 } else {
446 qemu_set_fd_handler(s->fd, NULL, net_socket_connect, s);
448 return s;
451 static NetSocketState *net_socket_fd_init(NetClientState *peer,
452 const char *model, const char *name,
453 int fd, int is_connected)
455 int so_type = -1, optlen=sizeof(so_type);
457 if(getsockopt(fd, SOL_SOCKET, SO_TYPE, (char *)&so_type,
458 (socklen_t *)&optlen)< 0) {
459 fprintf(stderr, "qemu: error: getsockopt(SO_TYPE) for fd=%d failed\n",
460 fd);
461 closesocket(fd);
462 return NULL;
464 switch(so_type) {
465 case SOCK_DGRAM:
466 return net_socket_fd_init_dgram(peer, model, name, fd, is_connected);
467 case SOCK_STREAM:
468 return net_socket_fd_init_stream(peer, model, name, fd, is_connected);
469 default:
470 /* who knows ... this could be a eg. a pty, do warn and continue as stream */
471 fprintf(stderr, "qemu: warning: socket type=%d for fd=%d is not SOCK_DGRAM or SOCK_STREAM\n", so_type, fd);
472 return net_socket_fd_init_stream(peer, model, name, fd, is_connected);
474 return NULL;
477 static void net_socket_accept(void *opaque)
479 NetSocketState *s = opaque;
480 struct sockaddr_in saddr;
481 socklen_t len;
482 int fd;
484 for(;;) {
485 len = sizeof(saddr);
486 fd = qemu_accept(s->listen_fd, (struct sockaddr *)&saddr, &len);
487 if (fd < 0 && errno != EINTR) {
488 return;
489 } else if (fd >= 0) {
490 qemu_set_fd_handler(s->listen_fd, NULL, NULL, NULL);
491 break;
495 s->fd = fd;
496 s->nc.link_down = false;
497 net_socket_connect(s);
498 snprintf(s->nc.info_str, sizeof(s->nc.info_str),
499 "socket: connection from %s:%d",
500 inet_ntoa(saddr.sin_addr), ntohs(saddr.sin_port));
503 static int net_socket_listen_init(NetClientState *peer,
504 const char *model,
505 const char *name,
506 const char *host_str)
508 NetClientState *nc;
509 NetSocketState *s;
510 struct sockaddr_in saddr;
511 int fd, val, ret;
513 if (parse_host_port(&saddr, host_str) < 0)
514 return -1;
516 fd = qemu_socket(PF_INET, SOCK_STREAM, 0);
517 if (fd < 0) {
518 perror("socket");
519 return -1;
521 socket_set_nonblock(fd);
523 /* allow fast reuse */
524 val = 1;
525 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (const char *)&val, sizeof(val));
527 ret = bind(fd, (struct sockaddr *)&saddr, sizeof(saddr));
528 if (ret < 0) {
529 perror("bind");
530 closesocket(fd);
531 return -1;
533 ret = listen(fd, 0);
534 if (ret < 0) {
535 perror("listen");
536 closesocket(fd);
537 return -1;
540 nc = qemu_new_net_client(&net_socket_info, peer, model, name);
541 s = DO_UPCAST(NetSocketState, nc, nc);
542 s->fd = -1;
543 s->listen_fd = fd;
544 s->nc.link_down = true;
546 qemu_set_fd_handler(s->listen_fd, net_socket_accept, NULL, s);
547 return 0;
550 static int net_socket_connect_init(NetClientState *peer,
551 const char *model,
552 const char *name,
553 const char *host_str)
555 NetSocketState *s;
556 int fd, connected, ret, err;
557 struct sockaddr_in saddr;
559 if (parse_host_port(&saddr, host_str) < 0)
560 return -1;
562 fd = qemu_socket(PF_INET, SOCK_STREAM, 0);
563 if (fd < 0) {
564 perror("socket");
565 return -1;
567 socket_set_nonblock(fd);
569 connected = 0;
570 for(;;) {
571 ret = connect(fd, (struct sockaddr *)&saddr, sizeof(saddr));
572 if (ret < 0) {
573 err = socket_error();
574 if (err == EINTR || err == EWOULDBLOCK) {
575 } else if (err == EINPROGRESS) {
576 break;
577 #ifdef _WIN32
578 } else if (err == WSAEALREADY || err == WSAEINVAL) {
579 break;
580 #endif
581 } else {
582 perror("connect");
583 closesocket(fd);
584 return -1;
586 } else {
587 connected = 1;
588 break;
591 s = net_socket_fd_init(peer, model, name, fd, connected);
592 if (!s)
593 return -1;
594 snprintf(s->nc.info_str, sizeof(s->nc.info_str),
595 "socket: connect to %s:%d",
596 inet_ntoa(saddr.sin_addr), ntohs(saddr.sin_port));
597 return 0;
600 static int net_socket_mcast_init(NetClientState *peer,
601 const char *model,
602 const char *name,
603 const char *host_str,
604 const char *localaddr_str)
606 NetSocketState *s;
607 int fd;
608 struct sockaddr_in saddr;
609 struct in_addr localaddr, *param_localaddr;
611 if (parse_host_port(&saddr, host_str) < 0)
612 return -1;
614 if (localaddr_str != NULL) {
615 if (inet_aton(localaddr_str, &localaddr) == 0)
616 return -1;
617 param_localaddr = &localaddr;
618 } else {
619 param_localaddr = NULL;
622 fd = net_socket_mcast_create(&saddr, param_localaddr);
623 if (fd < 0)
624 return -1;
626 s = net_socket_fd_init(peer, model, name, fd, 0);
627 if (!s)
628 return -1;
630 s->dgram_dst = saddr;
632 snprintf(s->nc.info_str, sizeof(s->nc.info_str),
633 "socket: mcast=%s:%d",
634 inet_ntoa(saddr.sin_addr), ntohs(saddr.sin_port));
635 return 0;
639 static int net_socket_udp_init(NetClientState *peer,
640 const char *model,
641 const char *name,
642 const char *rhost,
643 const char *lhost)
645 NetSocketState *s;
646 int fd, val, ret;
647 struct sockaddr_in laddr, raddr;
649 if (parse_host_port(&laddr, lhost) < 0) {
650 return -1;
653 if (parse_host_port(&raddr, rhost) < 0) {
654 return -1;
657 fd = qemu_socket(PF_INET, SOCK_DGRAM, 0);
658 if (fd < 0) {
659 perror("socket(PF_INET, SOCK_DGRAM)");
660 return -1;
662 val = 1;
663 ret = setsockopt(fd, SOL_SOCKET, SO_REUSEADDR,
664 (const char *)&val, sizeof(val));
665 if (ret < 0) {
666 perror("setsockopt(SOL_SOCKET, SO_REUSEADDR)");
667 closesocket(fd);
668 return -1;
670 ret = bind(fd, (struct sockaddr *)&laddr, sizeof(laddr));
671 if (ret < 0) {
672 perror("bind");
673 closesocket(fd);
674 return -1;
677 s = net_socket_fd_init(peer, model, name, fd, 0);
678 if (!s) {
679 return -1;
682 s->dgram_dst = raddr;
684 snprintf(s->nc.info_str, sizeof(s->nc.info_str),
685 "socket: udp=%s:%d",
686 inet_ntoa(raddr.sin_addr), ntohs(raddr.sin_port));
687 return 0;
690 int net_init_socket(const NetClientOptions *opts, const char *name,
691 NetClientState *peer)
693 const NetdevSocketOptions *sock;
695 assert(opts->kind == NET_CLIENT_OPTIONS_KIND_SOCKET);
696 sock = opts->socket;
698 if (sock->has_fd + sock->has_listen + sock->has_connect + sock->has_mcast +
699 sock->has_udp != 1) {
700 error_report("exactly one of fd=, listen=, connect=, mcast= or udp="
701 " is required");
702 return -1;
705 if (sock->has_localaddr && !sock->has_mcast && !sock->has_udp) {
706 error_report("localaddr= is only valid with mcast= or udp=");
707 return -1;
710 if (sock->has_fd) {
711 int fd;
713 fd = monitor_handle_fd_param(cur_mon, sock->fd);
714 if (fd == -1 || !net_socket_fd_init(peer, "socket", name, fd, 1)) {
715 return -1;
717 return 0;
720 if (sock->has_listen) {
721 if (net_socket_listen_init(peer, "socket", name, sock->listen) == -1) {
722 return -1;
724 return 0;
727 if (sock->has_connect) {
728 if (net_socket_connect_init(peer, "socket", name, sock->connect) ==
729 -1) {
730 return -1;
732 return 0;
735 if (sock->has_mcast) {
736 /* if sock->localaddr is missing, it has been initialized to "all bits
737 * zero" */
738 if (net_socket_mcast_init(peer, "socket", name, sock->mcast,
739 sock->localaddr) == -1) {
740 return -1;
742 return 0;
745 assert(sock->has_udp);
746 if (!sock->has_localaddr) {
747 error_report("localaddr= is mandatory with udp=");
748 return -1;
750 if (net_socket_udp_init(peer, "udp", name, sock->udp, sock->localaddr) ==
751 -1) {
752 return -1;
754 return 0;