2 * inet and unix socket functions for qemu
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; under version 2 of the License.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * Contributions after 2012-01-13 are licensed under the terms of the
16 * GNU GPL, version 2 or (at your option) any later version.
26 #include "qemu_socket.h"
27 #include "qemu-common.h" /* for qemu_isdigit */
28 #include "main-loop.h"
31 # define AI_ADDRCONFIG 0
34 static const int on=1, off=0;
36 /* used temporarely until all users are converted to QemuOpts */
37 static QemuOptsList dummy_opts = {
39 .head = QTAILQ_HEAD_INITIALIZER(dummy_opts.head),
43 .type = QEMU_OPT_STRING,
46 .type = QEMU_OPT_STRING,
49 .type = QEMU_OPT_STRING,
52 .type = QEMU_OPT_NUMBER,
55 .type = QEMU_OPT_BOOL,
58 .type = QEMU_OPT_BOOL,
64 static int inet_getport(struct addrinfo *e)
66 struct sockaddr_in *i4;
67 struct sockaddr_in6 *i6;
69 switch (e->ai_family) {
71 i6 = (void*)e->ai_addr;
72 return ntohs(i6->sin6_port);
74 i4 = (void*)e->ai_addr;
75 return ntohs(i4->sin_port);
81 static void inet_setport(struct addrinfo *e, int port)
83 struct sockaddr_in *i4;
84 struct sockaddr_in6 *i6;
86 switch (e->ai_family) {
88 i6 = (void*)e->ai_addr;
89 i6->sin6_port = htons(port);
92 i4 = (void*)e->ai_addr;
93 i4->sin_port = htons(port);
98 const char *inet_strfamily(int family)
101 case PF_INET6: return "ipv6";
102 case PF_INET: return "ipv4";
103 case PF_UNIX: return "unix";
108 int inet_listen_opts(QemuOpts *opts, int port_offset, Error **errp)
110 struct addrinfo ai,*res,*e;
113 char uaddr[INET6_ADDRSTRLEN+1];
115 int slisten, rc, to, port_min, port_max, p;
117 memset(&ai,0, sizeof(ai));
118 ai.ai_flags = AI_PASSIVE | AI_ADDRCONFIG;
119 ai.ai_family = PF_UNSPEC;
120 ai.ai_socktype = SOCK_STREAM;
122 if ((qemu_opt_get(opts, "host") == NULL) ||
123 (qemu_opt_get(opts, "port") == NULL)) {
124 error_setg(errp, "host and/or port not specified");
127 pstrcpy(port, sizeof(port), qemu_opt_get(opts, "port"));
128 addr = qemu_opt_get(opts, "host");
130 to = qemu_opt_get_number(opts, "to", 0);
131 if (qemu_opt_get_bool(opts, "ipv4", 0))
132 ai.ai_family = PF_INET;
133 if (qemu_opt_get_bool(opts, "ipv6", 0))
134 ai.ai_family = PF_INET6;
138 snprintf(port, sizeof(port), "%d", atoi(port) + port_offset);
139 rc = getaddrinfo(strlen(addr) ? addr : NULL, port, &ai, &res);
141 error_setg(errp, "address resolution failed for %s:%s: %s", addr, port,
146 /* create socket + bind */
147 for (e = res; e != NULL; e = e->ai_next) {
148 getnameinfo((struct sockaddr*)e->ai_addr,e->ai_addrlen,
149 uaddr,INET6_ADDRSTRLEN,uport,32,
150 NI_NUMERICHOST | NI_NUMERICSERV);
151 slisten = qemu_socket(e->ai_family, e->ai_socktype, e->ai_protocol);
154 error_set_errno(errp, errno, QERR_SOCKET_CREATE_FAILED);
159 setsockopt(slisten,SOL_SOCKET,SO_REUSEADDR,(void*)&on,sizeof(on));
161 if (e->ai_family == PF_INET6) {
162 /* listen on both ipv4 and ipv6 */
163 setsockopt(slisten,IPPROTO_IPV6,IPV6_V6ONLY,(void*)&off,
168 port_min = inet_getport(e);
169 port_max = to ? to + port_offset : port_min;
170 for (p = port_min; p <= port_max; p++) {
172 if (bind(slisten, e->ai_addr, e->ai_addrlen) == 0) {
177 error_set_errno(errp, errno, QERR_SOCKET_BIND_FAILED);
181 closesocket(slisten);
187 if (listen(slisten,1) != 0) {
188 error_set_errno(errp, errno, QERR_SOCKET_LISTEN_FAILED);
189 closesocket(slisten);
193 snprintf(uport, sizeof(uport), "%d", inet_getport(e) - port_offset);
194 qemu_opt_set(opts, "host", uaddr);
195 qemu_opt_set(opts, "port", uport);
196 qemu_opt_set(opts, "ipv6", (e->ai_family == PF_INET6) ? "on" : "off");
197 qemu_opt_set(opts, "ipv4", (e->ai_family != PF_INET6) ? "on" : "off");
203 #define QEMU_SOCKET_RC_INPROGRESS(rc) \
204 ((rc) == -EINPROGRESS || (rc) == -EWOULDBLOCK || (rc) == -WSAEALREADY)
206 #define QEMU_SOCKET_RC_INPROGRESS(rc) \
207 ((rc) == -EINPROGRESS)
210 /* Struct to store connect state for non blocking connect */
211 typedef struct ConnectState {
213 struct addrinfo *addr_list;
214 struct addrinfo *current_addr;
215 NonBlockingConnectHandler *callback;
219 static int inet_connect_addr(struct addrinfo *addr, bool *in_progress,
220 ConnectState *connect_state, Error **errp);
222 static void wait_for_connect(void *opaque)
224 ConnectState *s = opaque;
226 socklen_t valsize = sizeof(val);
229 qemu_set_fd_handler2(s->fd, NULL, NULL, NULL, NULL);
232 rc = getsockopt(s->fd, SOL_SOCKET, SO_ERROR, (void *) &val, &valsize);
233 } while (rc == -1 && socket_error() == EINTR);
235 /* update rc to contain error */
246 /* try to connect to the next address on the list */
247 if (s->current_addr) {
248 while (s->current_addr->ai_next != NULL && s->fd < 0) {
249 s->current_addr = s->current_addr->ai_next;
250 s->fd = inet_connect_addr(s->current_addr, &in_progress, s, NULL);
251 /* connect in progress */
257 freeaddrinfo(s->addr_list);
261 s->callback(s->fd, s->opaque);
266 static int inet_connect_addr(struct addrinfo *addr, bool *in_progress,
267 ConnectState *connect_state, Error **errp)
271 *in_progress = false;
273 sock = qemu_socket(addr->ai_family, addr->ai_socktype, addr->ai_protocol);
275 error_set_errno(errp, errno, QERR_SOCKET_CREATE_FAILED);
278 qemu_setsockopt(sock, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on));
279 if (connect_state != NULL) {
280 socket_set_nonblock(sock);
282 /* connect to peer */
285 if (connect(sock, addr->ai_addr, addr->ai_addrlen) < 0) {
286 rc = -socket_error();
288 } while (rc == -EINTR);
290 if (connect_state != NULL && QEMU_SOCKET_RC_INPROGRESS(rc)) {
291 connect_state->fd = sock;
292 qemu_set_fd_handler2(sock, NULL, NULL, wait_for_connect,
296 error_set_errno(errp, errno, QERR_SOCKET_CONNECT_FAILED);
303 static struct addrinfo *inet_parse_connect_opts(QemuOpts *opts, Error **errp)
305 struct addrinfo ai, *res;
310 memset(&ai, 0, sizeof(ai));
312 ai.ai_flags = AI_CANONNAME | AI_ADDRCONFIG;
313 ai.ai_family = PF_UNSPEC;
314 ai.ai_socktype = SOCK_STREAM;
316 addr = qemu_opt_get(opts, "host");
317 port = qemu_opt_get(opts, "port");
318 if (addr == NULL || port == NULL) {
319 error_setg(errp, "host and/or port not specified");
323 if (qemu_opt_get_bool(opts, "ipv4", 0)) {
324 ai.ai_family = PF_INET;
326 if (qemu_opt_get_bool(opts, "ipv6", 0)) {
327 ai.ai_family = PF_INET6;
331 rc = getaddrinfo(addr, port, &ai, &res);
333 error_setg(errp, "address resolution failed for %s:%s: %s", addr, port,
341 * Create a socket and connect it to an address.
343 * @opts: QEMU options, recognized parameters strings "host" and "port",
344 * bools "ipv4" and "ipv6".
345 * @errp: set on error
346 * @callback: callback function for non-blocking connect
347 * @opaque: opaque for callback function
349 * Returns: -1 on error, file descriptor on success.
351 * If @callback is non-null, the connect is non-blocking. If this
352 * function succeeds, callback will be called when the connection
353 * completes, with the file descriptor on success, or -1 on error.
355 int inet_connect_opts(QemuOpts *opts, Error **errp,
356 NonBlockingConnectHandler *callback, void *opaque)
358 struct addrinfo *res, *e;
361 ConnectState *connect_state = NULL;
363 res = inet_parse_connect_opts(opts, errp);
368 if (callback != NULL) {
369 connect_state = g_malloc0(sizeof(*connect_state));
370 connect_state->addr_list = res;
371 connect_state->callback = callback;
372 connect_state->opaque = opaque;
375 for (e = res; e != NULL; e = e->ai_next) {
376 if (connect_state != NULL) {
377 connect_state->current_addr = e;
379 sock = inet_connect_addr(e, &in_progress, connect_state, errp);
382 } else if (sock >= 0) {
383 /* non blocking socket immediate success, call callback */
384 if (callback != NULL) {
385 callback(sock, opaque);
390 g_free(connect_state);
395 int inet_dgram_opts(QemuOpts *opts, Error **errp)
397 struct addrinfo ai, *peer = NULL, *local = NULL;
402 /* lookup peer addr */
403 memset(&ai,0, sizeof(ai));
404 ai.ai_flags = AI_CANONNAME | AI_ADDRCONFIG;
405 ai.ai_family = PF_UNSPEC;
406 ai.ai_socktype = SOCK_DGRAM;
408 addr = qemu_opt_get(opts, "host");
409 port = qemu_opt_get(opts, "port");
410 if (addr == NULL || strlen(addr) == 0) {
413 if (port == NULL || strlen(port) == 0) {
414 error_setg(errp, "remote port not specified");
418 if (qemu_opt_get_bool(opts, "ipv4", 0))
419 ai.ai_family = PF_INET;
420 if (qemu_opt_get_bool(opts, "ipv6", 0))
421 ai.ai_family = PF_INET6;
423 if (0 != (rc = getaddrinfo(addr, port, &ai, &peer))) {
424 error_setg(errp, "address resolution failed for %s:%s: %s", addr, port,
429 /* lookup local addr */
430 memset(&ai,0, sizeof(ai));
431 ai.ai_flags = AI_PASSIVE;
432 ai.ai_family = peer->ai_family;
433 ai.ai_socktype = SOCK_DGRAM;
435 addr = qemu_opt_get(opts, "localaddr");
436 port = qemu_opt_get(opts, "localport");
437 if (addr == NULL || strlen(addr) == 0) {
440 if (!port || strlen(port) == 0)
443 if (0 != (rc = getaddrinfo(addr, port, &ai, &local))) {
444 error_setg(errp, "address resolution failed for %s:%s: %s", addr, port,
450 sock = qemu_socket(peer->ai_family, peer->ai_socktype, peer->ai_protocol);
452 error_set_errno(errp, errno, QERR_SOCKET_CREATE_FAILED);
455 setsockopt(sock,SOL_SOCKET,SO_REUSEADDR,(void*)&on,sizeof(on));
458 if (bind(sock, local->ai_addr, local->ai_addrlen) < 0) {
459 error_set_errno(errp, errno, QERR_SOCKET_BIND_FAILED);
463 /* connect to peer */
464 if (connect(sock,peer->ai_addr,peer->ai_addrlen) < 0) {
465 error_set_errno(errp, errno, QERR_SOCKET_CONNECT_FAILED);
483 /* compatibility wrapper */
484 static InetSocketAddress *inet_parse(const char *str, Error **errp)
486 InetSocketAddress *addr;
487 const char *optstr, *h;
493 addr = g_new0(InetSocketAddress, 1);
499 if (1 != sscanf(str, ":%32[^,]%n", port, &pos)) {
500 error_setg(errp, "error parsing port in address '%s'", str);
503 } else if (str[0] == '[') {
505 if (2 != sscanf(str, "[%64[^]]]:%32[^,]%n", host, port, &pos)) {
506 error_setg(errp, "error parsing IPv6 address '%s'", str);
509 addr->ipv6 = addr->has_ipv6 = true;
510 } else if (qemu_isdigit(str[0])) {
512 if (2 != sscanf(str, "%64[0-9.]:%32[^,]%n", host, port, &pos)) {
513 error_setg(errp, "error parsing IPv4 address '%s'", str);
516 addr->ipv4 = addr->has_ipv4 = true;
519 if (2 != sscanf(str, "%64[^:]:%32[^,]%n", host, port, &pos)) {
520 error_setg(errp, "error parsing address '%s'", str);
525 addr->host = g_strdup(host);
526 addr->port = g_strdup(port);
530 h = strstr(optstr, ",to=");
533 if (sscanf(h, "%d%n", &to, &pos) != 1 ||
534 (h[pos] != '\0' && h[pos] != ',')) {
535 error_setg(errp, "error parsing to= argument");
541 if (strstr(optstr, ",ipv4")) {
542 addr->ipv4 = addr->has_ipv4 = true;
544 if (strstr(optstr, ",ipv6")) {
545 addr->ipv6 = addr->has_ipv6 = true;
550 qapi_free_InetSocketAddress(addr);
554 static void inet_addr_to_opts(QemuOpts *opts, InetSocketAddress *addr)
556 bool ipv4 = addr->ipv4 || !addr->has_ipv4;
557 bool ipv6 = addr->ipv6 || !addr->has_ipv6;
559 if (!ipv4 || !ipv6) {
560 qemu_opt_set_bool(opts, "ipv4", ipv4);
561 qemu_opt_set_bool(opts, "ipv6", ipv6);
565 snprintf(to, sizeof(to), "%d", addr->to);
566 qemu_opt_set(opts, "to", to);
568 qemu_opt_set(opts, "host", addr->host);
569 qemu_opt_set(opts, "port", addr->port);
572 int inet_listen(const char *str, char *ostr, int olen,
573 int socktype, int port_offset, Error **errp)
578 InetSocketAddress *addr;
580 addr = inet_parse(str, errp);
582 opts = qemu_opts_create(&dummy_opts, NULL, 0, NULL);
583 inet_addr_to_opts(opts, addr);
584 qapi_free_InetSocketAddress(addr);
585 sock = inet_listen_opts(opts, port_offset, errp);
586 if (sock != -1 && ostr) {
587 optstr = strchr(str, ',');
588 if (qemu_opt_get_bool(opts, "ipv6", 0)) {
589 snprintf(ostr, olen, "[%s]:%s%s",
590 qemu_opt_get(opts, "host"),
591 qemu_opt_get(opts, "port"),
592 optstr ? optstr : "");
594 snprintf(ostr, olen, "%s:%s%s",
595 qemu_opt_get(opts, "host"),
596 qemu_opt_get(opts, "port"),
597 optstr ? optstr : "");
606 * Create a blocking socket and connect it to an address.
608 * @str: address string
609 * @errp: set in case of an error
611 * Returns -1 in case of error, file descriptor on success
613 int inet_connect(const char *str, Error **errp)
617 InetSocketAddress *addr;
619 addr = inet_parse(str, errp);
621 opts = qemu_opts_create(&dummy_opts, NULL, 0, NULL);
622 inet_addr_to_opts(opts, addr);
623 qapi_free_InetSocketAddress(addr);
624 sock = inet_connect_opts(opts, errp, NULL, NULL);
631 * Create a non-blocking socket and connect it to an address.
632 * Calls the callback function with fd in case of success or -1 in case of
635 * @str: address string
636 * @callback: callback function that is called when connect completes,
638 * @opaque: opaque for callback function
639 * @errp: set in case of an error
641 * Returns: -1 on immediate error, file descriptor on success.
643 int inet_nonblocking_connect(const char *str,
644 NonBlockingConnectHandler *callback,
645 void *opaque, Error **errp)
649 InetSocketAddress *addr;
651 g_assert(callback != NULL);
653 addr = inet_parse(str, errp);
655 opts = qemu_opts_create(&dummy_opts, NULL, 0, NULL);
656 inet_addr_to_opts(opts, addr);
657 qapi_free_InetSocketAddress(addr);
658 sock = inet_connect_opts(opts, errp, callback, opaque);
666 int unix_listen_opts(QemuOpts *opts, Error **errp)
668 struct sockaddr_un un;
669 const char *path = qemu_opt_get(opts, "path");
672 sock = qemu_socket(PF_UNIX, SOCK_STREAM, 0);
674 error_set_errno(errp, errno, QERR_SOCKET_CREATE_FAILED);
678 memset(&un, 0, sizeof(un));
679 un.sun_family = AF_UNIX;
680 if (path && strlen(path)) {
681 snprintf(un.sun_path, sizeof(un.sun_path), "%s", path);
683 char *tmpdir = getenv("TMPDIR");
684 snprintf(un.sun_path, sizeof(un.sun_path), "%s/qemu-socket-XXXXXX",
685 tmpdir ? tmpdir : "/tmp");
687 * This dummy fd usage silences the mktemp() unsecure warning.
688 * Using mkstemp() doesn't make things more secure here
689 * though. bind() complains about existing files, so we have
690 * to unlink first and thus re-open the race window. The
691 * worst case possible is bind() failing, i.e. a DoS attack.
693 fd = mkstemp(un.sun_path); close(fd);
694 qemu_opt_set(opts, "path", un.sun_path);
698 if (bind(sock, (struct sockaddr*) &un, sizeof(un)) < 0) {
699 error_set_errno(errp, errno, QERR_SOCKET_BIND_FAILED);
702 if (listen(sock, 1) < 0) {
703 error_set_errno(errp, errno, QERR_SOCKET_LISTEN_FAILED);
714 int unix_connect_opts(QemuOpts *opts, Error **errp,
715 NonBlockingConnectHandler *callback, void *opaque)
717 struct sockaddr_un un;
718 const char *path = qemu_opt_get(opts, "path");
719 ConnectState *connect_state = NULL;
723 error_setg(errp, "unix connect: no path specified\n");
727 sock = qemu_socket(PF_UNIX, SOCK_STREAM, 0);
729 error_set_errno(errp, errno, QERR_SOCKET_CREATE_FAILED);
732 if (callback != NULL) {
733 connect_state = g_malloc0(sizeof(*connect_state));
734 connect_state->callback = callback;
735 connect_state->opaque = opaque;
736 socket_set_nonblock(sock);
739 memset(&un, 0, sizeof(un));
740 un.sun_family = AF_UNIX;
741 snprintf(un.sun_path, sizeof(un.sun_path), "%s", path);
743 /* connect to peer */
746 if (connect(sock, (struct sockaddr *) &un, sizeof(un)) < 0) {
747 rc = -socket_error();
749 } while (rc == -EINTR);
751 if (connect_state != NULL && QEMU_SOCKET_RC_INPROGRESS(rc)) {
752 connect_state->fd = sock;
753 qemu_set_fd_handler2(sock, NULL, NULL, wait_for_connect,
756 } else if (rc >= 0) {
757 /* non blocking socket immediate success, call callback */
758 if (callback != NULL) {
759 callback(sock, opaque);
764 error_set_errno(errp, -rc, QERR_SOCKET_CONNECT_FAILED);
769 g_free(connect_state);
775 int unix_listen_opts(QemuOpts *opts, Error **errp)
777 error_setg(errp, "unix sockets are not available on windows");
782 int unix_connect_opts(QemuOpts *opts, Error **errp,
783 NonBlockingConnectHandler *callback, void *opaque)
785 error_setg(errp, "unix sockets are not available on windows");
791 /* compatibility wrapper */
792 int unix_listen(const char *str, char *ostr, int olen, Error **errp)
798 opts = qemu_opts_create(&dummy_opts, NULL, 0, NULL);
800 optstr = strchr(str, ',');
804 path = g_malloc(len+1);
805 snprintf(path, len+1, "%.*s", len, str);
806 qemu_opt_set(opts, "path", path);
810 qemu_opt_set(opts, "path", str);
813 sock = unix_listen_opts(opts, errp);
815 if (sock != -1 && ostr)
816 snprintf(ostr, olen, "%s%s", qemu_opt_get(opts, "path"), optstr ? optstr : "");
821 int unix_connect(const char *path, Error **errp)
826 opts = qemu_opts_create(&dummy_opts, NULL, 0, NULL);
827 qemu_opt_set(opts, "path", path);
828 sock = unix_connect_opts(opts, errp, NULL, NULL);
834 int unix_nonblocking_connect(const char *path,
835 NonBlockingConnectHandler *callback,
836 void *opaque, Error **errp)
841 g_assert(callback != NULL);
843 opts = qemu_opts_create(&dummy_opts, NULL, 0, NULL);
844 qemu_opt_set(opts, "path", path);
845 sock = unix_connect_opts(opts, errp, callback, opaque);
850 SocketAddress *socket_parse(const char *str, Error **errp)
852 SocketAddress *addr = NULL;
854 addr = g_new(SocketAddress, 1);
855 if (strstart(str, "unix:", NULL)) {
856 if (str[5] == '\0') {
857 error_setg(errp, "invalid Unix socket address\n");
860 addr->kind = SOCKET_ADDRESS_KIND_UNIX;
861 addr->q_unix = g_new(UnixSocketAddress, 1);
862 addr->q_unix->path = g_strdup(str + 5);
864 } else if (strstart(str, "fd:", NULL)) {
865 if (str[3] == '\0') {
866 error_setg(errp, "invalid file descriptor address\n");
869 addr->kind = SOCKET_ADDRESS_KIND_FD;
870 addr->fd = g_new(String, 1);
871 addr->fd->str = g_strdup(str + 3);
874 addr->kind = SOCKET_ADDRESS_KIND_INET;
875 addr->inet = g_new(InetSocketAddress, 1);
876 addr->inet = inet_parse(str, errp);
877 if (addr->inet == NULL) {
884 qapi_free_SocketAddress(addr);
888 int socket_connect(SocketAddress *addr, Error **errp,
889 NonBlockingConnectHandler *callback, void *opaque)
894 opts = qemu_opts_create(&dummy_opts, NULL, 0, NULL);
895 switch (addr->kind) {
896 case SOCKET_ADDRESS_KIND_INET:
897 inet_addr_to_opts(opts, addr->inet);
898 fd = inet_connect_opts(opts, errp, callback, opaque);
901 case SOCKET_ADDRESS_KIND_UNIX:
902 qemu_opt_set(opts, "path", addr->q_unix->path);
903 fd = unix_connect_opts(opts, errp, callback, opaque);
906 case SOCKET_ADDRESS_KIND_FD:
907 fd = monitor_get_fd(cur_mon, addr->fd->str, errp);
909 callback(fd, opaque);
920 int socket_listen(SocketAddress *addr, Error **errp)
925 opts = qemu_opts_create(&dummy_opts, NULL, 0, NULL);
926 switch (addr->kind) {
927 case SOCKET_ADDRESS_KIND_INET:
928 inet_addr_to_opts(opts, addr->inet);
929 fd = inet_listen_opts(opts, 0, errp);
932 case SOCKET_ADDRESS_KIND_UNIX:
933 qemu_opt_set(opts, "path", addr->q_unix->path);
934 fd = unix_listen_opts(opts, errp);
937 case SOCKET_ADDRESS_KIND_FD:
938 fd = monitor_get_fd(cur_mon, addr->fd->str, errp);
949 static void socket_cleanup(void)
955 int socket_init(void)
961 ret = WSAStartup(MAKEWORD(2,2), &Data);
963 err = WSAGetLastError();
964 fprintf(stderr, "WSAStartup: %d\n", err);
967 atexit(socket_cleanup);