2 This file is part of GNUnet.
3 Copyright (C) 2009-2013 GNUnet e.V.
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
22 * @file util/network.c
23 * @brief basic, low-level networking interface
25 * @author Christian Grothoff
28 #include "gnunet_util_lib.h"
31 #define LOG(kind,...) GNUNET_log_from (kind, "util", __VA_ARGS__)
32 #define LOG_STRERROR_FILE(kind,syscall,filename) GNUNET_log_from_strerror_file (kind, "util", syscall, filename)
33 #define LOG_STRERROR(kind,syscall) GNUNET_log_from_strerror (kind, "util", syscall)
35 #define DEBUG_NETWORK GNUNET_EXTRA_LOGGING
38 #ifndef INVALID_SOCKET
39 #define INVALID_SOCKET -1
44 * @brief handle to a socket
46 struct GNUNET_NETWORK_Handle
55 * Address family / domain.
65 * Number of bytes in addr.
70 * Address we were bound to, or NULL.
72 struct sockaddr *addr;
78 * Test if the given protocol family is supported by this system.
80 * @param pf protocol family to test (PF_INET, PF_INET6, PF_UNIX)
81 * @return #GNUNET_OK if the PF is supported
84 GNUNET_NETWORK_test_pf (int pf)
88 s = socket (pf, SOCK_STREAM, 0);
91 if (EAFNOSUPPORT == errno)
93 GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
94 "Failed to create test socket: %s\n",
108 * Given a unixpath that is too long (larger than UNIX_PATH_MAX),
109 * shorten it to an acceptable length while keeping it unique
110 * and making sure it remains a valid filename (if possible).
112 * @param unixpath long path, will be freed (or same pointer returned
113 * with moved 0-termination).
114 * @return shortened unixpath, NULL on error
117 GNUNET_NETWORK_shorten_unixpath (char *unixpath)
119 struct sockaddr_un dummy;
122 struct GNUNET_HashCode sh;
123 struct GNUNET_CRYPTO_HashAsciiEncoded ae;
126 upm = sizeof (dummy.sun_path);
127 slen = strlen (unixpath);
129 return unixpath; /* no shortening required */
130 GNUNET_CRYPTO_hash (unixpath, slen, &sh);
132 strlen (unixpath) >= upm)
134 if (NULL == (end = strrchr (unixpath, '/')))
136 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
137 _("Unable to shorten unix path `%s' while keeping name unique\n"),
139 GNUNET_free (unixpath);
144 GNUNET_CRYPTO_hash_to_enc (&sh, &ae);
145 strncat (unixpath, (char*) ae.encoding, 16);
152 * If services crash, they can leave a unix domain socket file on the
153 * disk. This needs to be manually removed, because otherwise both
154 * bind() and connect() for the respective address will fail. In this
155 * function, we test if such a left-over file exists, and if so,
156 * remove it (unless there is a listening service at the address).
158 * @param un unix domain socket address to check
161 GNUNET_NETWORK_unix_precheck (const struct sockaddr_un *un)
168 s = socket (AF_UNIX, SOCK_STREAM, 0);
170 (struct sockaddr *) un,
171 sizeof (struct sockaddr_un));
173 GNUNET_break (0 == close (s));
175 return; /* another process is listening, do not remove! */
176 if (ECONNREFUSED != eno)
177 return; /* some other error, likely "no such file or directory" -- all well */
178 /* should unlink, but sanity checks first */
179 if (0 != stat (un->sun_path,
181 return; /* failed to 'stat', likely does not exist after all */
182 if (S_IFSOCK != (S_IFMT & sbuf.st_mode))
183 return; /* refuse to unlink anything except sockets */
184 /* finally, really unlink */
185 GNUNET_log (GNUNET_ERROR_TYPE_INFO,
186 "Removing left-over `%s' from previous exeuction\n",
188 if (0 != unlink (un->sun_path))
189 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
198 #define FD_COPY(s, d) (memcpy ((d), (s), sizeof (fd_set)))
203 * Set if a socket should use blocking or non-blocking IO.
206 * @param doBlock blocking mode
207 * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
210 GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd,
224 SetErrnoFromWinsockError (WSAGetLastError ());
225 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
227 return GNUNET_SYSERR;
233 int flags = fcntl (fd->fd, F_GETFL);
238 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
240 return GNUNET_SYSERR;
243 flags &= ~O_NONBLOCK;
247 if (0 != fcntl (fd->fd,
252 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
254 return GNUNET_SYSERR;
262 * Make a socket non-inheritable to child processes
264 * @param h the socket to make non-inheritable
265 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
266 * @warning Not implemented on Windows
269 socket_set_inheritable (const struct GNUNET_NETWORK_Handle *h)
273 i = fcntl (h->fd, F_GETFD);
275 return GNUNET_SYSERR;
276 if (i == (i | FD_CLOEXEC))
279 if (fcntl (h->fd, F_SETFD, i) < 0)
280 return GNUNET_SYSERR;
284 b = SetHandleInformation ((HANDLE) h->fd, HANDLE_FLAG_INHERIT, 0);
287 SetErrnoFromWinsockError (WSAGetLastError ());
288 return GNUNET_SYSERR;
297 * The MSG_NOSIGNAL equivalent on Mac OS X
299 * @param h the socket to make non-delaying
302 socket_set_nosigpipe (const struct GNUNET_NETWORK_Handle *h)
307 setsockopt (h->fd, SOL_SOCKET, SO_NOSIGPIPE,
308 (const void *) &abs_value,
310 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "setsockopt");
316 * Disable delays when sending data via the socket.
317 * (GNUnet makes sure that messages are as big as
320 * @param h the socket to make non-delaying
323 socket_set_nodelay (const struct GNUNET_NETWORK_Handle *h)
332 &value, sizeof (value)))
333 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
336 const char *abs_value = "1";
339 setsockopt (h->fd, IPPROTO_TCP, TCP_NODELAY,
340 (const void *) abs_value,
342 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
349 * Perform proper canonical initialization for a network handle.
350 * Set it to non-blocking, make it non-inheritable to child
351 * processes, disable SIGPIPE, enable "nodelay" (if non-UNIX
352 * stream socket) and check that it is smaller than FD_SETSIZE.
354 * @param h socket to initialize
355 * @param af address family of the socket
356 * @param type socket type
357 * @return #GNUNET_OK on success, #GNUNET_SYSERR if initialization
358 * failed and the handle was destroyed
361 initialize_network_handle (struct GNUNET_NETWORK_Handle *h,
369 if (h->fd == INVALID_SOCKET)
372 SetErrnoFromWinsockError (WSAGetLastError ());
377 return GNUNET_SYSERR;
380 if (h->fd >= FD_SETSIZE)
382 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (h));
384 return GNUNET_SYSERR;
387 if (GNUNET_OK != socket_set_inheritable (h))
388 LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
389 "socket_set_inheritable");
391 if (GNUNET_SYSERR == GNUNET_NETWORK_socket_set_blocking (h, GNUNET_NO))
395 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (h));
397 return GNUNET_SYSERR;
400 socket_set_nosigpipe (h);
402 if ( (type == SOCK_STREAM)
407 socket_set_nodelay (h);
413 * accept a new connection on a socket
415 * @param desc bound socket
416 * @param address address of the connecting peer, may be NULL
417 * @param address_len length of @a address
418 * @return client socket
420 struct GNUNET_NETWORK_Handle *
421 GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
422 struct sockaddr *address,
423 socklen_t *address_len)
425 struct GNUNET_NETWORK_Handle *ret;
428 ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
431 struct sockaddr_storage name;
432 socklen_t namelen = sizeof (name);
434 int gsn = getsockname (desc->fd,
435 (struct sockaddr *) &name,
439 LOG (GNUNET_ERROR_TYPE_DEBUG,
440 "Accepting connection on `%s'\n",
441 GNUNET_a2s ((const struct sockaddr *) &name,
445 ret->fd = accept (desc->fd,
456 initialize_network_handle (ret,
457 (NULL != address) ? address->sa_family : desc->af,
468 * Bind a socket to a particular address.
470 * @param desc socket to bind
471 * @param address address to be bound
472 * @param address_len length of @a address
473 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
476 GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
477 const struct sockaddr *address,
478 socklen_t address_len)
487 if (AF_INET6 == desc->af)
488 if (setsockopt (desc->fd, IPPROTO_IPV6, IPV6_V6ONLY,
491 LOG_STRERROR (GNUNET_ERROR_TYPE_DEBUG,
497 if (AF_UNIX == address->sa_family)
498 GNUNET_NETWORK_unix_precheck ((const struct sockaddr_un *) address);
502 /* This is required here for TCP sockets, but only on UNIX */
503 if ( (SOCK_STREAM == desc->type) &&
504 (0 != setsockopt (desc->fd,
508 LOG_STRERROR (GNUNET_ERROR_TYPE_DEBUG,
512 /* set permissions of newly created non-abstract UNIX domain socket to
513 "user-only"; applications can choose to relax this later */
514 mode_t old_mask = 0; /* assigned to make compiler happy */
515 const struct sockaddr_un *un;
516 int not_abstract = 0;
518 if ((AF_UNIX == address->sa_family)
519 && (NULL != (un = (const struct sockaddr_un *) address)->sun_path)
520 && ('\0' != un->sun_path[0]) ) /* Not an abstract socket */
523 old_mask = umask (S_IWGRP | S_IRGRP | S_IXGRP | S_IWOTH | S_IROTH | S_IXOTH);
526 ret = bind (desc->fd,
532 (void) umask (old_mask);
536 if (SOCKET_ERROR == ret)
537 SetErrnoFromWinsockError (WSAGetLastError ());
540 return GNUNET_SYSERR;
542 desc->addr = GNUNET_malloc (address_len);
543 memcpy (desc->addr, address, address_len);
544 desc->addrlen = address_len;
554 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
557 GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc)
565 ret = closesocket (desc->fd);
566 error = WSAGetLastError ();
567 SetErrnoFromWinsockError (error);
568 LOG (GNUNET_ERROR_TYPE_DEBUG,
569 "Closed 0x%x, closesocket() returned %d, GLE is %u\n",
574 ret = close (desc->fd);
577 const struct sockaddr_un *un;
579 /* Cleanup the UNIX domain socket and its parent directories in case of non
581 if ( (AF_UNIX == desc->af) &&
582 (NULL != desc->addr) &&
583 (NULL != (un = (const struct sockaddr_un *) desc->addr)->sun_path) &&
584 ('\0' != un->sun_path[0]) )
586 char *dirname = GNUNET_strndup (un->sun_path,
587 sizeof (un->sun_path));
589 if (0 != unlink (dirname))
591 LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
599 len = strlen (dirname);
600 while ((len > 0) && (dirname[len] != DIR_SEPARATOR))
603 if ((0 != len) && (0 != rmdir (dirname)))
610 /* these are normal and can just be ignored */
613 GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
620 GNUNET_free (dirname);
623 GNUNET_NETWORK_socket_free_memory_only_ (desc);
624 return (ret == 0) ? GNUNET_OK : GNUNET_SYSERR;
629 * Only free memory of a socket, keep the file descriptor untouched.
634 GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc)
636 GNUNET_free_non_null (desc->addr);
642 * Box a native socket (and check that it is a socket).
644 * @param fd socket to box
645 * @return NULL on error (including not supported on target platform)
647 struct GNUNET_NETWORK_Handle *
648 GNUNET_NETWORK_socket_box_native (SOCKTYPE fd)
650 struct GNUNET_NETWORK_Handle *ret;
654 /* FIXME: Find a better call to check that FD is valid */
656 WSAIoctl (fd, FIONBIO,
657 (void *) &i, sizeof (i),
660 return NULL; /* invalid FD */
661 ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
666 if (fcntl (fd, F_GETFD) < 0)
667 return NULL; /* invalid FD */
668 ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
677 * Connect a socket to some remote address.
680 * @param address peer address
681 * @param address_len length of @a address
682 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
685 GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
686 const struct sockaddr *address,
687 socklen_t address_len)
691 ret = connect (desc->fd,
695 if (SOCKET_ERROR == ret)
697 SetErrnoFromWinsockError (WSAGetLastError ());
698 if (errno == EWOULDBLOCK)
702 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
710 * @param level protocol level of the option
711 * @param optname identifier of the option
712 * @param optval options
713 * @param optlen length of @a optval
714 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
717 GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
725 ret = getsockopt (desc->fd,
732 (SOL_SOCKET == level) &&
733 (SO_ERROR == optname) )
734 *((int *) optval) = GetErrnoFromWinsockError (*((int *) optval));
735 else if (SOCKET_ERROR == ret)
736 SetErrnoFromWinsockError (WSAGetLastError ());
738 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
746 * @param backlog length of the listen queue
747 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
750 GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
755 ret = listen (desc->fd,
758 if (SOCKET_ERROR == ret)
759 SetErrnoFromWinsockError (WSAGetLastError ());
761 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
766 * How much data is available to be read on this descriptor?
769 * @returns #GNUNET_NO if no data is available, or on error!
772 GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle *desc)
776 /* How much is there to be read? */
780 error = ioctl (desc->fd,
784 return (ssize_t) pending;
789 error = ioctlsocket (desc->fd,
792 if (error != SOCKET_ERROR)
793 return (ssize_t) pending;
800 * Read data from a socket (always non-blocking).
803 * @param buffer buffer
804 * @param length length of @a buffer
805 * @param src_addr either the source to recv from, or all zeroes
806 * to be filled in by recvfrom
807 * @param addrlen length of the @a src_addr
810 GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
813 struct sockaddr *src_addr,
822 flags |= MSG_DONTWAIT;
825 ret = recvfrom (desc->fd,
832 if (SOCKET_ERROR == ret)
833 SetErrnoFromWinsockError (WSAGetLastError ());
840 * Read data from a connected socket (always non-blocking).
843 * @param buffer buffer
844 * @param length length of @a buffer
845 * @return number of bytes received, -1 on error
848 GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
858 flags |= MSG_DONTWAIT;
860 ret = recv (desc->fd,
865 if (SOCKET_ERROR == ret)
866 SetErrnoFromWinsockError (WSAGetLastError ());
873 * Send data (always non-blocking).
876 * @param buffer data to send
877 * @param length size of the @a buffer
878 * @return number of bytes sent, #GNUNET_SYSERR on error
881 GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
890 flags |= MSG_DONTWAIT;
894 flags |= MSG_NOSIGNAL;
897 ret = send (desc->fd,
902 if (SOCKET_ERROR == ret)
903 SetErrnoFromWinsockError (WSAGetLastError ());
911 * Send data to a particular destination (always non-blocking).
912 * This function only works for UDP sockets.
915 * @param message data to send
916 * @param length size of the @a message
917 * @param dest_addr destination address
918 * @param dest_len length of @a address
919 * @return number of bytes sent, #GNUNET_SYSERR on error
922 GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
925 const struct sockaddr *dest_addr,
934 flags |= MSG_DONTWAIT;
937 flags |= MSG_NOSIGNAL;
939 ret = sendto (desc->fd, message, length, flags, dest_addr, dest_len);
941 if (SOCKET_ERROR == ret)
942 SetErrnoFromWinsockError (WSAGetLastError ());
952 * @param level protocol level of the option
953 * @param option_name option identifier
954 * @param option_value value to set
955 * @param option_len size of @a option_value
956 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
959 GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
962 const void *option_value,
963 socklen_t option_len)
967 ret = setsockopt (fd->fd,
973 if (SOCKET_ERROR == ret)
974 SetErrnoFromWinsockError (WSAGetLastError ());
976 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
981 * Create a new socket. Configure it for non-blocking IO and
982 * mark it as non-inheritable to child processes (set the
983 * close-on-exec flag).
985 * @param domain domain of the socket
986 * @param type socket type
987 * @param protocol network protocol
988 * @return new socket, NULL on error
990 struct GNUNET_NETWORK_Handle *
991 GNUNET_NETWORK_socket_create (int domain,
995 struct GNUNET_NETWORK_Handle *ret;
998 fd = socket (domain, type, protocol);
1001 ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
1004 initialize_network_handle (ret,
1013 * Shut down socket operations
1014 * @param desc socket
1015 * @param how type of shutdown
1016 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
1019 GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,
1024 ret = shutdown (desc->fd, how);
1027 SetErrnoFromWinsockError (WSAGetLastError ());
1029 return (0 == ret) ? GNUNET_OK : GNUNET_SYSERR;
1034 * Disable the "CORK" feature for communication with the given socket,
1035 * forcing the OS to immediately flush the buffer on transmission
1036 * instead of potentially buffering multiple messages. Essentially
1037 * reduces the OS send buffers to zero.
1039 * @param desc socket
1040 * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
1043 GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc)
1052 setsockopt (desc->fd,
1057 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1061 setsockopt (desc->fd,
1066 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1073 setsockopt (desc->fd,
1078 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1082 setsockopt (desc->fd,
1087 LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1090 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
1100 GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds)
1102 FD_ZERO (&fds->sds);
1105 fds->handles_pos = 0;
1111 * Add a socket to the FD set
1114 * @param desc socket to add
1117 GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
1118 const struct GNUNET_NETWORK_Handle *desc)
1122 fds->nsds = GNUNET_MAX (fds->nsds,
1128 * Check whether a socket is part of the fd set
1131 * @param desc socket
1132 * @return 0 if the FD is not set
1135 GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
1136 const struct GNUNET_NETWORK_Handle *desc)
1138 return FD_ISSET (desc->fd,
1144 * Add one fd set to another
1146 * @param dst the fd set to add to
1147 * @param src the fd set to add from
1150 GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
1151 const struct GNUNET_NETWORK_FDSet *src)
1156 for (nfds = src->nsds; nfds >= 0; nfds--)
1157 if (FD_ISSET (nfds, &src->sds))
1158 FD_SET (nfds, &dst->sds);
1159 dst->nsds = GNUNET_MAX (dst->nsds,
1162 /* This is MinGW32-specific implementation that relies on the code that
1163 * winsock2.h defines for FD_SET. Namely, it relies on FD_SET checking
1164 * that fd being added is not already in the set.
1165 * Also relies on us knowing what's inside fd_set (fd_count and fd_array).
1167 * NOTE: I don't understand why the UNIX-logic wouldn't work
1168 * for the first part here as well. -CG
1172 for (i = 0; i < src->sds.fd_count; i++)
1173 FD_SET (src->sds.fd_array[i],
1175 dst->nsds = GNUNET_MAX (src->nsds,
1178 /* also copy over `struct GNUNET_DISK_FileHandle` array */
1179 if (dst->handles_pos + src->handles_pos > dst->handles_size)
1180 GNUNET_array_grow (dst->handles,
1182 ((dst->handles_pos + src->handles_pos) << 1));
1183 for (i = 0; i < src->handles_pos; i++)
1184 dst->handles[dst->handles_pos++] = src->handles[i];
1190 * Copy one fd set to another
1192 * @param to destination
1193 * @param from source
1196 GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
1197 const struct GNUNET_NETWORK_FDSet *from)
1199 FD_COPY (&from->sds,
1201 to->nsds = from->nsds;
1203 if (from->handles_pos > to->handles_size)
1204 GNUNET_array_grow (to->handles,
1206 from->handles_pos * 2);
1207 memcpy (to->handles,
1209 from->handles_pos * sizeof (struct GNUNET_NETWORK_Handle *));
1210 to->handles_pos = from->handles_pos;
1216 * Return file descriptor for this network handle
1218 * @param desc wrapper to process
1219 * @return POSIX file descriptor
1222 GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc)
1229 * Return sockaddr for this network handle
1231 * @param desc wrapper to process
1235 GNUNET_NETWORK_get_addr (struct GNUNET_NETWORK_Handle *desc)
1242 * Return sockaddr length for this network handle
1244 * @param desc wrapper to process
1245 * @return socklen_t for sockaddr
1248 GNUNET_NETWORK_get_addrlen (struct GNUNET_NETWORK_Handle *desc)
1250 return desc->addrlen;
1255 * Copy a native fd set
1257 * @param to destination
1258 * @param from native source set
1259 * @param nfds the biggest socket number in from + 1
1262 GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
1273 * Set a native fd in a set
1275 * @param to destination
1276 * @param nfd native FD to set
1279 GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to,
1282 GNUNET_assert ((nfd >= 0) && (nfd < FD_SETSIZE));
1283 FD_SET (nfd, &to->sds);
1284 to->nsds = GNUNET_MAX (nfd + 1,
1290 * Test native fd in a set
1292 * @param to set to test, NULL for empty set
1293 * @param nfd native FD to test, or -1 for none
1294 * @return #GNUNET_YES if FD is set in the set
1297 GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
1303 return FD_ISSET (nfd, &to->sds) ? GNUNET_YES : GNUNET_NO;
1308 * Add a file handle to the fd set
1310 * @param h the file handle to add
1313 GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
1314 const struct GNUNET_DISK_FileHandle *h)
1317 if (fds->handles_pos == fds->handles_size)
1318 GNUNET_array_grow (fds->handles,
1320 fds->handles_size * 2 + 2);
1321 fds->handles[fds->handles_pos++] = h;
1325 GNUNET_DISK_internal_file_handle_ (h,
1330 fds->nsds = GNUNET_MAX (fd + 1,
1337 * Add a file handle to the fd set
1339 * @param h the file handle to add
1342 GNUNET_NETWORK_fdset_handle_set_first (struct GNUNET_NETWORK_FDSet *fds,
1343 const struct GNUNET_DISK_FileHandle *h)
1346 if (fds->handles_pos == fds->handles_size)
1347 GNUNET_array_grow (fds->handles,
1349 fds->handles_size * 2 + 2);
1350 fds->handles[fds->handles_pos] = h;
1351 if (fds->handles[0] != h)
1353 const struct GNUNET_DISK_FileHandle *bak = fds->handles[0];
1354 fds->handles[0] = h;
1355 fds->handles[fds->handles_pos] = bak;
1359 GNUNET_NETWORK_fdset_handle_set (fds, h);
1365 * Check if a file handle is part of an fd set
1368 * @param h file handle
1369 * @return #GNUNET_YES if the file handle is part of the set
1372 GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
1373 const struct GNUNET_DISK_FileHandle *h)
1378 for (i=0;i<fds->handles_pos;i++)
1379 if (fds->handles[i] == h)
1383 return FD_ISSET (h->fd,
1391 * Numerically compare pointers to sort them.
1392 * Used to test for overlap in the arrays.
1394 * @param p1 a pointer
1395 * @param p2 a pointer
1396 * @return -1, 0 or 1, if the p1 < p2, p1==p2 or p1 > p2.
1399 ptr_cmp (const void *p1,
1404 if ((intptr_t) p1 < (intptr_t) p2)
1412 * Checks if two fd sets overlap
1414 * @param fds1 first fd set
1415 * @param fds2 second fd set
1416 * @return #GNUNET_YES if they do overlap, #GNUNET_NO otherwise
1419 GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
1420 const struct GNUNET_NETWORK_FDSet *fds2)
1425 nfds = GNUNET_MIN (fds1->nsds,
1430 if ( (FD_ISSET (nfds,
1441 /* This code is somewhat hacky, we are not supposed to know what's
1442 * inside of fd_set; also the O(n^2) is really bad... */
1443 for (i = 0; i < fds1->sds.fd_count; i++)
1444 for (j = 0; j < fds2->sds.fd_count; j++)
1445 if (fds1->sds.fd_array[i] == fds2->sds.fd_array[j])
1448 /* take a short cut if possible */
1449 if ( (0 == fds1->handles_pos) ||
1450 (0 == fds2->handles_pos) )
1453 /* Sort file handles array to avoid quadratic complexity when
1454 checking for overlap */
1455 qsort (fds1->handles,
1459 qsort (fds2->handles,
1465 while ( (i < fds1->handles_pos) &&
1466 (j < fds2->handles_pos) )
1468 switch (ptr_cmp (fds1->handles[i],
1488 * @return a new fd set
1490 struct GNUNET_NETWORK_FDSet *
1491 GNUNET_NETWORK_fdset_create ()
1493 struct GNUNET_NETWORK_FDSet *fds;
1495 fds = GNUNET_new (struct GNUNET_NETWORK_FDSet);
1496 GNUNET_NETWORK_fdset_zero (fds);
1502 * Releases the associated memory of an fd set
1507 GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds)
1510 GNUNET_array_grow (fds->handles,
1522 struct _select_params
1540 * Timeout for select().
1557 SOCKET wakeup_socket;
1560 * Set to return value from select.
1570 _selector (LPVOID p)
1572 struct _select_params *sp = p;
1576 WaitForSingleObject (sp->standby,
1578 ResetEvent (sp->standby);
1579 sp->status = select (1,
1584 if (FD_ISSET (sp->wakeup_socket,
1587 FD_CLR (sp->wakeup_socket,
1591 SetEvent (sp->wakeup);
1597 static HANDLE hEventPipeWrite;
1599 static HANDLE hEventReadReady;
1601 static struct _select_params sp;
1603 static HANDLE select_thread;
1605 static HANDLE select_finished_event;
1607 static HANDLE select_standby_event;
1609 static SOCKET select_wakeup_socket = -1;
1611 static SOCKET select_send_socket = -1;
1613 static struct timeval select_timeout;
1617 * On W32, we actually use a thread to help with the
1618 * event loop due to W32-API limitations. This function
1619 * initializes that thread.
1622 initialize_select_thread ()
1624 SOCKET select_listening_socket = -1;
1625 struct sockaddr_in s_in;
1630 select_standby_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1631 select_finished_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1633 select_wakeup_socket = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
1635 select_listening_socket = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
1638 res = ioctlsocket (select_wakeup_socket, FIONBIO, &p);
1639 LOG (GNUNET_ERROR_TYPE_DEBUG,
1640 "Select thread initialization: ioctlsocket() returns %d\n",
1643 alen = sizeof (s_in);
1644 s_in.sin_family = AF_INET;
1646 s_in.sin_addr.S_un.S_un_b.s_b1 = 127;
1647 s_in.sin_addr.S_un.S_un_b.s_b2 = 0;
1648 s_in.sin_addr.S_un.S_un_b.s_b3 = 0;
1649 s_in.sin_addr.S_un.S_un_b.s_b4 = 1;
1650 res = bind (select_listening_socket,
1651 (const struct sockaddr *) &s_in,
1653 LOG (GNUNET_ERROR_TYPE_DEBUG,
1654 "Select thread initialization: bind() returns %d\n",
1657 res = getsockname (select_listening_socket,
1658 (struct sockaddr *) &s_in,
1660 LOG (GNUNET_ERROR_TYPE_DEBUG,
1661 "Select thread initialization: getsockname() returns %d\n",
1664 res = listen (select_listening_socket,
1666 LOG (GNUNET_ERROR_TYPE_DEBUG,
1667 "Select thread initialization: listen() returns %d\n",
1669 res = connect (select_wakeup_socket,
1670 (const struct sockaddr *) &s_in,
1672 LOG (GNUNET_ERROR_TYPE_DEBUG,
1673 "Select thread initialization: connect() returns %d\n",
1676 select_send_socket = accept (select_listening_socket,
1677 (struct sockaddr *) &s_in,
1680 closesocket (select_listening_socket);
1682 sp.wakeup = select_finished_event;
1683 sp.standby = select_standby_event;
1684 sp.wakeup_socket = select_wakeup_socket;
1686 select_thread = CreateThread (NULL,
1699 * Check if sockets or pipes meet certain conditions
1701 * @param rfds set of sockets or pipes to be checked for readability
1702 * @param wfds set of sockets or pipes to be checked for writability
1703 * @param efds set of sockets or pipes to be checked for exceptions
1704 * @param timeout relative value when to return
1705 * @return number of selected sockets or pipes, #GNUNET_SYSERR on error
1708 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
1709 struct GNUNET_NETWORK_FDSet *wfds,
1710 struct GNUNET_NETWORK_FDSet *efds,
1711 const struct GNUNET_TIME_Relative timeout)
1721 nfds = GNUNET_MAX (nfds,
1724 nfds = GNUNET_MAX (nfds,
1727 (timeout.rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us))
1730 LOG (GNUNET_ERROR_TYPE_ERROR,
1731 _("Fatal internal logic error, process hangs in `%s' (abort with CTRL-C)!\n"),
1734 tv.tv_sec = timeout.rel_value_us / GNUNET_TIME_UNIT_SECONDS.rel_value_us;
1736 (timeout.rel_value_us -
1737 (tv.tv_sec * GNUNET_TIME_UNIT_SECONDS.rel_value_us));
1738 return select (nfds,
1739 (NULL != rfds) ? &rfds->sds : NULL,
1740 (NULL != wfds) ? &wfds->sds : NULL,
1741 (NULL != efds) ? &efds->sds : NULL,
1742 (timeout.rel_value_us ==
1743 GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us) ? NULL : &tv);
1752 * Non-blocking test if a pipe is ready for reading.
1754 * @param fh pipe handle
1755 * @return #GNUNET_YES if the pipe is ready for reading
1758 pipe_read_ready (const struct GNUNET_DISK_FileHandle *fh)
1762 DWORD waitstatus = 0;
1765 bret = PeekNamedPipe (fh->h, NULL, 0, NULL, &waitstatus, NULL);
1766 error = GetLastError ();
1769 /* TODO: either add more errors to this condition, or eliminate it
1770 * entirely (failed to peek -> pipe is in serious trouble, should
1771 * be selected as readable).
1773 if ( (error != ERROR_BROKEN_PIPE) &&
1774 (error != ERROR_INVALID_HANDLE) )
1777 else if (waitstatus <= 0)
1784 * Non-blocking test if a pipe is having an IO exception.
1786 * @param fh pipe handle
1787 * @return #GNUNET_YES if the pipe is having an IO exception.
1790 pipe_except_ready (const struct GNUNET_DISK_FileHandle *fh)
1794 if (PeekNamedPipe (fh->h, NULL, 0, NULL, &dwBytes, NULL))
1801 * Iterate over handles in fds, destructively rewrite the
1802 * handles array contents of fds so that it starts with the
1803 * handles that are ready, and update handles_pos accordingly.
1805 * @param fds set of handles (usually pipes) to be checked for readiness
1806 * @param except GNUNET_NO if fds should be checked for readiness to read,
1807 * GNUNET_YES if fds should be checked for exceptions
1808 * (there is no way to check for write-readiness - pipes are always write-ready)
1809 * @param set_for_sure a HANDLE that is known to be set already,
1810 * because WaitForMultipleObjects() returned its index.
1811 * @return number of ready handles
1814 check_handles_status (struct GNUNET_NETWORK_FDSet *fds,
1816 HANDLE set_for_sure)
1818 const struct GNUNET_DISK_FileHandle *fh;
1822 for (woff = 0, roff = 0; roff < fds->handles_pos; roff++)
1824 fh = fds->handles[roff];
1825 if (fh == set_for_sure)
1827 fds->handles[woff++] = fh;
1829 else if (fh->type == GNUNET_DISK_HANLDE_TYPE_PIPE)
1831 if ((except && pipe_except_ready (fh)) ||
1832 (!except && pipe_read_ready (fh)))
1833 fds->handles[woff++] = fh;
1835 else if (fh->type == GNUNET_DISK_HANLDE_TYPE_FILE)
1838 fds->handles[woff++] = fh;
1842 if (WAIT_OBJECT_0 == WaitForSingleObject (fh->h, 0))
1843 fds->handles[woff++] = fh;
1846 fds->handles_pos = woff;
1852 * Check if sockets or pipes meet certain conditions, version for W32.
1854 * @param rfds set of sockets or pipes to be checked for readability
1855 * @param wfds set of sockets or pipes to be checked for writability
1856 * @param efds set of sockets or pipes to be checked for exceptions
1857 * @param timeout relative value when to return
1858 * @return number of selected sockets or pipes, #GNUNET_SYSERR on error
1861 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
1862 struct GNUNET_NETWORK_FDSet *wfds,
1863 struct GNUNET_NETWORK_FDSet *efds,
1864 const struct GNUNET_TIME_Relative timeout)
1866 const struct GNUNET_DISK_FileHandle *fh;
1875 HANDLE handle_array[FD_SETSIZE + 2];
1877 int returnedpos = 0;
1887 nfds = GNUNET_MAX (nfds, rfds->nsds);
1888 handles += rfds->handles_pos;
1892 nfds = GNUNET_MAX (nfds, wfds->nsds);
1893 handles += wfds->handles_pos;
1897 nfds = GNUNET_MAX (nfds, efds->nsds);
1898 handles += efds->handles_pos;
1902 (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == timeout.rel_value_us) &&
1906 LOG (GNUNET_ERROR_TYPE_ERROR,
1907 _("Fatal internal logic error, process hangs in `%s' (abort with CTRL-C)!\n"),
1910 #define SAFE_FD_ISSET(fd, set) (set != NULL && FD_ISSET(fd, set))
1911 /* calculate how long we need to wait in microseconds */
1912 if (timeout.rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
1914 mcs_total = INFINITE;
1915 ms_rounded = INFINITE;
1919 mcs_total = timeout.rel_value_us / GNUNET_TIME_UNIT_MICROSECONDS.rel_value_us;
1920 ms_rounded = (DWORD) (mcs_total / GNUNET_TIME_UNIT_MILLISECONDS.rel_value_us);
1921 if (mcs_total > 0 && ms_rounded == 0)
1924 /* select() may be used as a portable way to sleep */
1925 if (! (rfds || wfds || efds))
1931 if (NULL == select_thread)
1932 initialize_select_thread ();
1938 FD_COPY (&rfds->sds, &aread);
1940 FD_COPY (&wfds->sds, &awrite);
1942 FD_COPY (&efds->sds, &aexcept);
1944 /* Start by doing a fast check on sockets and pipes (without
1945 waiting). It is cheap, and is sufficient most of the time. By
1946 profiling we detected that to be true in 90% of the cases.
1949 /* Do the select now */
1950 select_timeout.tv_sec = 0;
1951 select_timeout.tv_usec = 0;
1953 /* Copy all the writes to the except, so we can detect connect() errors */
1954 for (i = 0; i < awrite.fd_count; i++)
1955 FD_SET (awrite.fd_array[i],
1957 if ( (aread.fd_count > 0) ||
1958 (awrite.fd_count > 0) ||
1959 (aexcept.fd_count > 0) )
1960 selectret = select (1,
1961 (NULL != rfds) ? &aread : NULL,
1962 (NULL != wfds) ? &awrite : NULL,
1967 if (-1 == selectret)
1969 /* Throw an error early on, while we still have the context. */
1970 LOG (GNUNET_ERROR_TYPE_ERROR,
1971 "W32 select(%d, %d, %d) failed: %lu\n",
1972 rfds ? aread.fd_count : 0,
1973 wfds ? awrite.fd_count : 0,
1979 /* Check aexcept, if something is in there and we copied that
1980 FD before to detect connect() errors, add it back to the
1981 write set to report errors. */
1983 for (i = 0; i < aexcept.fd_count; i++)
1984 if (FD_ISSET (aexcept.fd_array[i],
1986 FD_SET (aexcept.fd_array[i],
1990 /* If our select returned something or is a 0-timed request, then
1991 also check the pipes and get out of here! */
1992 /* Sadly, it means code duplication :( */
1993 if ( (selectret > 0) || (0 == mcs_total) )
1998 if (rfds && (rfds->handles_pos > 0))
1999 retcode += check_handles_status (rfds, GNUNET_NO, NULL);
2001 /* wfds handles remain untouched, on W32
2002 we pretend our pipes are "always" write-ready */
2005 if (efds && (efds->handles_pos > 0))
2006 retcode += check_handles_status (efds, GNUNET_YES, NULL);
2010 GNUNET_NETWORK_fdset_zero (rfds);
2011 if (selectret != -1)
2012 GNUNET_NETWORK_fdset_copy_native (rfds, &aread, selectret);
2016 GNUNET_NETWORK_fdset_zero (wfds);
2017 if (selectret != -1)
2018 GNUNET_NETWORK_fdset_copy_native (wfds, &awrite, selectret);
2022 GNUNET_NETWORK_fdset_zero (efds);
2023 if (selectret != -1)
2024 GNUNET_NETWORK_fdset_copy_native (efds, &aexcept, selectret);
2026 if (-1 == selectret)
2028 /* Add our select() FDs to the total return value */
2029 retcode += selectret;
2033 /* If we got this far, use slower implementation that is able to do a waiting select
2034 on both sockets and pipes simultaneously */
2036 /* Events for pipes */
2037 if (! hEventReadReady)
2038 hEventReadReady = CreateEvent (NULL, TRUE, TRUE, NULL);
2039 if (! hEventPipeWrite)
2040 hEventPipeWrite = CreateEvent (NULL, TRUE, TRUE, NULL);
2047 FD_COPY (&rfds->sds, &aread);
2049 FD_COPY (&wfds->sds, &awrite);
2051 FD_COPY (&efds->sds, &aexcept);
2052 /* We will first Add the PIPES to the events */
2053 /* Track how far in `handle_array` the read pipes go,
2054 so we may by-pass them quickly if none of them
2057 if (rfds && (rfds->handles_pos > 0))
2059 for (i = 0; i <rfds->handles_pos; i++)
2061 fh = rfds->handles[i];
2062 if (fh->type == GNUNET_DISK_HANLDE_TYPE_EVENT)
2064 handle_array[nhandles++] = fh->h;
2067 if (fh->type != GNUNET_DISK_HANLDE_TYPE_PIPE)
2069 /* Read zero bytes to check the status of the pipe */
2070 if (! ReadFile (fh->h, NULL, 0, NULL, fh->oOverlapRead))
2072 DWORD error_code = GetLastError ();
2074 if (error_code == ERROR_IO_PENDING)
2076 /* add as unready */
2077 handle_array[nhandles++] = fh->oOverlapRead->hEvent;
2083 handle_array[nhandles++] = hEventReadReady;
2089 /* error also counts as ready */
2090 handle_array[nhandles++] = hEventReadReady;
2096 if (wfds && (wfds->handles_pos > 0))
2098 LOG (GNUNET_ERROR_TYPE_DEBUG,
2099 "Adding the write ready event to the array as %d\n",
2101 handle_array[nhandles++] = hEventPipeWrite;
2107 LOG (GNUNET_ERROR_TYPE_DEBUG,
2108 "Adding the socket event to the array as %d\n",
2110 handle_array[nhandles++] = select_finished_event;
2111 if (timeout.rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
2117 select_timeout.tv_sec = timeout.rel_value_us / GNUNET_TIME_UNIT_SECONDS.rel_value_us;
2118 select_timeout.tv_usec = (timeout.rel_value_us -
2119 (select_timeout.tv_sec *
2120 GNUNET_TIME_UNIT_SECONDS.rel_value_us));
2121 sp.tv = &select_timeout;
2123 FD_SET (select_wakeup_socket, &aread);
2126 i = recv (select_wakeup_socket,
2127 (char *) &returnedpos,
2134 /* Failed connections cause sockets to be set in errorfds on W32,
2135 * but on POSIX it should set them in writefds.
2136 * First copy all awrite sockets to aexcept, later we'll
2137 * check aexcept and set its contents in awrite as well
2138 * Sockets are also set in errorfds when OOB data is available,
2139 * but we don't use OOB data.
2141 for (i = 0; i < awrite.fd_count; i++)
2142 FD_SET (awrite.fd_array[i],
2144 ResetEvent (select_finished_event);
2145 SetEvent (select_standby_event);
2148 /* NULL-terminate array */
2149 handle_array[nhandles] = NULL;
2150 LOG (GNUNET_ERROR_TYPE_DEBUG,
2151 "nfds: %d, handles: %d, will wait: %llu mcs\n",
2158 = WaitForMultipleObjects (nhandles,
2162 LOG (GNUNET_ERROR_TYPE_DEBUG,
2163 "WaitForMultipleObjects Returned: %d\n",
2168 GNUNET_break (0); /* This branch shouldn't actually be executed...*/
2169 i = (int) WaitForSingleObject (select_finished_event,
2171 returncode = WAIT_TIMEOUT;
2175 /* Shouldn't come this far. If it does - investigate. */
2181 /* Don't wake up select-thread when delay is 0, it should return immediately
2182 * and wake up by itself.
2185 i = send (select_send_socket,
2186 (const char *) &returnedpos,
2189 i = (int) WaitForSingleObject (select_finished_event,
2191 LOG (GNUNET_ERROR_TYPE_DEBUG,
2192 "Finished waiting for the select thread: %d %d\n",
2199 i = recv (select_wakeup_socket,
2200 (char *) &returnedpos,
2204 /* Check aexcept, add its contents to awrite */
2205 for (i = 0; i < aexcept.fd_count; i++)
2206 FD_SET (aexcept.fd_array[i], &awrite);
2209 returnedpos = returncode - WAIT_OBJECT_0;
2210 LOG (GNUNET_ERROR_TYPE_DEBUG,
2211 "return pos is: %d\n",
2216 /* We queued a zero-long read on each pipe to check
2217 * its state, now we must cancel these read operations.
2218 * This must be done while rfds->handles_pos is still
2219 * intact and matches the number of read handles that we
2220 * got from the caller.
2222 for (i = 0; i < rfds->handles_pos; i++)
2224 fh = rfds->handles[i];
2225 if (GNUNET_DISK_HANLDE_TYPE_PIPE == fh->type)
2229 /* We may have some pipes ready for reading. */
2230 if (returnedpos < read_pipes_off)
2231 retcode += check_handles_status (rfds, GNUNET_NO, handle_array[returnedpos]);
2233 rfds->handles_pos = 0;
2235 if (-1 != sp.status)
2236 GNUNET_NETWORK_fdset_copy_native (rfds, &aread, retcode);
2240 retcode += wfds->handles_pos;
2241 /* wfds handles remain untouched */
2242 if (-1 != sp.status)
2243 GNUNET_NETWORK_fdset_copy_native (wfds, &awrite, retcode);
2247 retcode += check_handles_status (rfds,
2249 returnedpos < nhandles ? handle_array[returnedpos] : NULL);
2250 if (-1 != sp.status)
2251 GNUNET_NETWORK_fdset_copy_native (efds, &aexcept, retcode);
2255 retcode += sp.status;
2263 /* end of network.c */