2 This file is part of GNUnet.
3 (C) 2009 Christian Grothoff (and other contributing authors)
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 2, 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., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA.
22 * @file util/network.c
23 * @brief basic, low-level networking interface
28 #include "gnunet_disk_lib.h"
30 #include "gnunet_container_lib.h"
32 #define DEBUG_NETWORK GNUNET_NO
34 #ifndef INVALID_SOCKET
35 #define INVALID_SOCKET -1
39 struct GNUNET_NETWORK_Handle
45 struct GNUNET_NETWORK_FDSet
49 * Maximum number of any socket socket descriptor in the set
54 * Bitset with the descriptors.
60 * Linked list of handles
62 struct GNUNET_CONTAINER_SList *handles;
68 #define FD_COPY(s, d) (memcpy ((d), (s), sizeof (fd_set)))
73 * Set if a socket should use blocking or non-blocking IO.
75 * @param doBlock blocking mode
76 * @return GNUNET_OK on success, GNUNET_SYSERR on error
79 socket_set_blocking (struct GNUNET_NETWORK_Handle *fd, int doBlock)
85 if (ioctlsocket (fd->fd, FIONBIO, &mode) == SOCKET_ERROR)
88 SetErrnoFromWinsockError (WSAGetLastError ());
89 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "ioctlsocket");
96 int flags = fcntl (fd->fd, F_GETFL);
100 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "fcntl");
101 return GNUNET_SYSERR;
104 flags &= ~O_NONBLOCK;
108 if (0 != fcntl (fd->fd, F_SETFL, flags))
111 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "fcntl");
112 return GNUNET_SYSERR;
121 * Make a socket non-inheritable to child processes
123 * @param h the socket to make non-inheritable
124 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
125 * @warning Not implemented on Windows
128 socket_set_inheritable (const struct GNUNET_NETWORK_Handle *h)
131 i = fcntl (h->fd, F_GETFD);
132 if (i == (i | FD_CLOEXEC))
134 return (fcntl (h->fd, F_SETFD, i | FD_CLOEXEC) == 0)
135 ? GNUNET_OK : GNUNET_SYSERR;
142 * The MSG_NOSIGNAL equivalent on Mac OS X
144 * @param h the socket to make non-delaying
147 socket_set_nosigpipe (const struct GNUNET_NETWORK_Handle *h)
151 setsockopt (h->fd, SOL_SOCKET, SO_NOSIGPIPE, &value, sizeof (value)))
152 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "setsockopt");
158 * Disable delays when sending data via the socket.
159 * (GNUnet makes sure that messages are as big as
162 * @param h the socket to make non-delaying
165 socket_set_nodelay (const struct GNUNET_NETWORK_Handle *h)
169 setsockopt (h->fd, IPPROTO_TCP, TCP_NODELAY, &value, sizeof (value)))
170 GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING, "setsockopt");
175 * accept a new connection on a socket
177 * @param desc bound socket
178 * @param address address of the connecting peer, may be NULL
179 * @param address_len length of address
180 * @return client socket
182 struct GNUNET_NETWORK_Handle *
183 GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
184 struct sockaddr *address,
185 socklen_t * address_len)
187 struct GNUNET_NETWORK_Handle *ret;
188 ret = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle));
189 ret->fd = accept (desc->fd, address, address_len);
190 if (ret->fd == INVALID_SOCKET)
193 SetErrnoFromWinsockError (WSAGetLastError ());
199 if (ret->fd >= FD_SETSIZE)
201 GNUNET_break (0 == close (ret->fd));
207 if (GNUNET_SYSERR == socket_set_blocking (ret, GNUNET_NO))
211 /* we might want to treat this one as fatal... */
213 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (ret));
218 if (GNUNET_OK != socket_set_inheritable (ret))
219 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
220 "socket_set_inheritable");
223 socket_set_nosigpipe (ret);
225 socket_set_nodelay (ret);
231 * Bind to a connected socket
233 * @param address address to be bound
234 * @param address_len length of address
235 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
238 GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
239 const struct sockaddr *address,
240 socklen_t address_len)
244 ret = bind (desc->fd, address, address_len);
246 if (SOCKET_ERROR == ret)
247 SetErrnoFromWinsockError (WSAGetLastError ());
249 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
256 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
259 GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc)
265 ret = closesocket (desc->fd);
266 SetErrnoFromWinsockError (WSAGetLastError ());
268 ret = close (desc->fd);
273 return (ret == 0) ? GNUNET_OK : GNUNET_SYSERR;
280 * @param address peer address
281 * @param address_len length of address
282 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
285 GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
286 const struct sockaddr *address,
287 socklen_t address_len)
290 ret = connect (desc->fd, address, address_len);
293 if (SOCKET_ERROR == ret)
296 SetErrnoFromWinsockError (WSAGetLastError ());
297 if (errno == EWOULDBLOCK)
301 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
309 * @param level protocol level of the option
310 * @param optname identifier of the option
311 * @param optval options
312 * @param optlen length of optval
313 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
316 GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
317 int level, int optname, void *optval,
321 ret = getsockopt (desc->fd, level, optname, optval, optlen);
324 if (ret == 0 && level == SOL_SOCKET && optname == SO_ERROR)
325 *((int *) optval) = GetErrnoFromWinsockError (*((int *) optval));
327 else if (SOCKET_ERROR == ret)
328 SetErrnoFromWinsockError (WSAGetLastError ());
331 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
338 * @param backlog length of the listen queue
339 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
342 GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
346 ret = listen (desc->fd, backlog);
349 if (SOCKET_ERROR == ret)
350 SetErrnoFromWinsockError (WSAGetLastError ());
353 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
358 * Read data from a connected socket (always non-blocking).
360 * @param buffer buffer
361 * @param length length of buffer
364 GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle * desc,
365 void *buffer, size_t length)
372 flags |= MSG_DONTWAIT;
375 ret = recv (desc->fd, buffer, length, flags);
378 if (SOCKET_ERROR == ret)
379 SetErrnoFromWinsockError (WSAGetLastError ());
387 * Send data (always non-blocking).
390 * @param buffer data to send
391 * @param length size of the buffer
392 * @return number of bytes sent, GNUNET_SYSERR on error
395 GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle * desc,
396 const void *buffer, size_t length)
403 flags |= MSG_DONTWAIT;
407 flags |= MSG_NOSIGNAL;
410 ret = send (desc->fd, buffer, length, flags);
413 if (SOCKET_ERROR == ret)
414 SetErrnoFromWinsockError (WSAGetLastError ());
422 * Send data to a particular destination (always non-blocking).
423 * This function only works for UDP sockets.
426 * @param message data to send
427 * @param length size of the data
428 * @param dest_addr destination address
429 * @param dest_len length of address
430 * @return number of bytes sent, GNUNET_SYSERR on error
433 GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle * desc,
434 const void *message, size_t length,
435 const struct sockaddr * dest_addr,
443 flags |= MSG_DONTWAIT;
446 flags |= MSG_NOSIGNAL;
448 ret = sendto (desc->fd, message, length, flags, dest_addr, dest_len);
450 if (SOCKET_ERROR == ret)
451 SetErrnoFromWinsockError (WSAGetLastError ());
460 * @param level protocol level of the option
461 * @param option_name option identifier
462 * @param option_value value to set
463 * @param option_len size of option_value
464 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
467 GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
468 int level, int option_name,
469 const void *option_value,
470 socklen_t option_len)
474 ret = setsockopt (fd->fd, level, option_name, option_value, option_len);
476 if (SOCKET_ERROR == ret)
477 SetErrnoFromWinsockError (WSAGetLastError ());
479 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
484 * Create a new socket. Configure it for non-blocking IO and
485 * mark it as non-inheritable to child processes (set the
486 * close-on-exec flag).
488 * @param domain domain of the socket
489 * @param type socket type
490 * @param protocol network protocol
491 * @return new socket, NULL on error
493 struct GNUNET_NETWORK_Handle *
494 GNUNET_NETWORK_socket_create (int domain, int type, int protocol)
496 struct GNUNET_NETWORK_Handle *ret;
497 ret = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_Handle));
498 ret->fd = socket (domain, type, protocol);
499 if (INVALID_SOCKET == ret->fd)
502 SetErrnoFromWinsockError (WSAGetLastError ());
509 if (ret->fd >= FD_SETSIZE)
511 GNUNET_break (0 == close (ret->fd));
518 if (GNUNET_SYSERR == socket_set_blocking (ret, GNUNET_NO))
520 /* we might want to treat this one as fatal... */
522 GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (ret));
527 if (GNUNET_OK != socket_set_inheritable (ret))
528 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
529 "socket_set_inheritable");
532 socket_set_nosigpipe (ret);
534 if (type == SOCK_STREAM)
535 socket_set_nodelay (ret);
541 * Shut down socket operations
543 * @param how type of shutdown
544 * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
547 GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how)
551 ret = shutdown (desc->fd, how);
554 SetErrnoFromWinsockError (WSAGetLastError ());
556 return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
565 GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds)
570 GNUNET_CONTAINER_slist_clear (fds->handles);
575 * Add a socket to the FD set
577 * @param desc socket to add
580 GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
581 const struct GNUNET_NETWORK_Handle *desc)
583 FD_SET (desc->fd, &fds->sds);
584 if (desc->fd + 1 > fds->nsds)
585 fds->nsds = desc->fd + 1;
590 * Check whether a socket is part of the fd set
593 * @return 0 if the FD is not set
596 GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
597 const struct GNUNET_NETWORK_Handle *desc)
599 return FD_ISSET (desc->fd, &fds->sds);
604 * Add one fd set to another
605 * @param dst the fd set to add to
606 * @param src the fd set to add from
609 GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
610 const struct GNUNET_NETWORK_FDSet *src)
613 for (nfds = src->nsds; nfds > 0; nfds--)
614 if (FD_ISSET (nfds, &src->sds))
617 FD_SET (nfds, &dst->sds);
618 if (nfds + 1 > dst->nsds)
619 dst->nsds = nfds + 1;
622 GNUNET_CONTAINER_slist_append (dst->handles, src->handles);
628 * Copy one fd set to another
630 * @param to destination
634 GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
635 const struct GNUNET_NETWORK_FDSet *from)
637 FD_COPY (&from->sds, &to->sds);
638 to->nsds = from->nsds;
641 GNUNET_CONTAINER_slist_clear (to->handles);
642 GNUNET_CONTAINER_slist_append (to->handles, from->handles);
647 * Copy a native fd set
649 * @param to destination
650 * @param from native source set
651 * @param nfds the biggest socket number in from + 1
654 GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
655 const fd_set * from, int nfds)
657 FD_COPY (from, &to->sds);
662 * Add a file handle to the fd set
664 * @param h the file handle to add
667 GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
668 const struct GNUNET_DISK_FileHandle *h)
673 GNUNET_DISK_internal_file_handle_ (h, &hw, sizeof (HANDLE));
674 GNUNET_CONTAINER_slist_add (fds->handles, GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT, &hw, sizeof (HANDLE));
678 GNUNET_DISK_internal_file_handle_ (h, &fd, sizeof (int));
679 FD_SET (fd, &fds->sds);
680 if (fd + 1 > fds->nsds)
688 * Check if a file handle is part of an fd set
690 * @param h file handle
691 * @return GNUNET_YES if the file handle is part of the set
694 GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
695 const struct GNUNET_DISK_FileHandle *h)
699 return GNUNET_CONTAINER_slist_contains (fds->handles, &h->h,
702 return FD_ISSET (h->fd, &fds->sds);
708 * Checks if two fd sets overlap
709 * @param fds1 first fd set
710 * @param fds2 second fd set
711 * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise
714 GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
715 const struct GNUNET_NETWORK_FDSet *fds2)
719 if (nfds < fds2->nsds)
721 for (; nfds >= 0; nfds--)
722 if (FD_ISSET (nfds, &fds1->sds) && FD_ISSET (nfds, &fds2->sds))
726 struct GNUNET_CONTAINER_SList_Iterator *it;
728 for(it = GNUNET_CONTAINER_slist_begin (fds1->handles); GNUNET_CONTAINER_slist_end (it) != GNUNET_YES; GNUNET_CONTAINER_slist_next (it))
732 h = GNUNET_CONTAINER_slist_get (it, NULL);
733 if (GNUNET_CONTAINER_slist_contains (fds2->handles, h, sizeof (HANDLE)))
735 GNUNET_CONTAINER_slist_iter_destroy (it);
739 GNUNET_CONTAINER_slist_iter_destroy (it);
748 * @return a new fd set
750 struct GNUNET_NETWORK_FDSet *
751 GNUNET_NETWORK_fdset_create ()
753 struct GNUNET_NETWORK_FDSet *fds;
754 fds = GNUNET_malloc (sizeof (struct GNUNET_NETWORK_FDSet));
756 fds->handles = GNUNET_CONTAINER_slist_create ();
758 GNUNET_NETWORK_fdset_zero (fds);
764 * Releases the associated memory of an fd set
768 GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds)
771 GNUNET_CONTAINER_slist_destroy (fds->handles);
777 * Check if sockets meet certain conditions
778 * @param rfds set of sockets to be checked for readability
779 * @param wfds set of sockets to be checked for writability
780 * @param efds set of sockets to be checked for exceptions
781 * @param timeout relative value when to return
782 * @return number of selected sockets, GNUNET_SYSERR on error
785 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
786 struct GNUNET_NETWORK_FDSet *wfds,
787 struct GNUNET_NETWORK_FDSet *efds,
788 const struct GNUNET_TIME_Relative timeout)
802 handles = GNUNET_CONTAINER_slist_count (rfds->handles);
807 nfds = GNUNET_MAX (nfds, wfds->nsds);
809 handles += GNUNET_CONTAINER_slist_count (wfds->handles);
814 nfds = GNUNET_MAX (nfds, efds->nsds);
816 handles += GNUNET_CONTAINER_slist_count (efds->handles);
821 tv.tv_sec = timeout.value / GNUNET_TIME_UNIT_SECONDS.value;
823 1000 * (timeout.value - (tv.tv_sec * GNUNET_TIME_UNIT_SECONDS.value));
824 if ((nfds == 0) && (timeout.value == GNUNET_TIME_UNIT_FOREVER_REL.value)
830 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
832 ("Fatal internal logic error, process hangs in `%s' (abort with CTRL-C)!\n"),
837 return select (nfds + 1,
838 (rfds != NULL) ? &rfds->sds : NULL,
839 (wfds != NULL) ? &wfds->sds : NULL,
840 (efds != NULL) ? &efds->sds : NULL,
841 (timeout.value == GNUNET_TIME_UNIT_FOREVER_REL.value)
846 fd_set sock_read, sock_write, sock_except;
847 fd_set aread, awrite, aexcept;
848 struct GNUNET_CONTAINER_SList *handles_read, *handles_write, *handles_except;
851 struct timeval tvslice;
855 #define SAFE_FD_ISSET(fd, set) (set != NULL && FD_ISSET(fd, set))
857 /* calculate how long we need to wait in milliseconds */
858 if (timeout.value == GNUNET_TIME_UNIT_FOREVER_REL.value)
862 ms_total = timeout.value / GNUNET_TIME_UNIT_MILLISECONDS.value;
864 /* select() may be used as a portable way to sleep */
865 if (!(rfds || wfds || efds))
872 handles_read = GNUNET_CONTAINER_slist_create ();
873 handles_write = GNUNET_CONTAINER_slist_create ();
874 handles_except = GNUNET_CONTAINER_slist_create ();
877 sock_read = rfds->sds;
879 FD_ZERO (&sock_read);
881 sock_write = wfds->sds;
883 FD_ZERO (&sock_write);
885 sock_except = efds->sds;
887 FD_ZERO (&sock_except);
889 /* multiplex between winsock select() and waiting on the handles */
893 limit = GetTickCount () + ms_total;
902 /* overwrite the zero'd sets here; the select call
903 * will clear those that are not active */
904 FD_COPY (&sock_read, &aread);
905 FD_COPY (&sock_write, &awrite);
906 FD_COPY (&sock_except, &aexcept);
908 tvslice.tv_usec = 100000;
910 select (nfds + 1, &aread, &awrite, &aexcept,
911 &tvslice)) == SOCKET_ERROR)
914 SetErrnoFromWinsockError (WSAGetLastError ());
915 if (errno == ENOTSOCK)
919 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR, "select");
922 goto select_loop_end;
926 /* Poll read pipes */
930 struct GNUNET_CONTAINER_SList_Iterator *i;
931 for (i = GNUNET_CONTAINER_slist_begin (rfds->handles);
932 GNUNET_CONTAINER_slist_end (i) != GNUNET_YES;
933 GNUNET_CONTAINER_slist_next (i))
938 h = *(HANDLE *) GNUNET_CONTAINER_slist_get (i, NULL);
939 if (!PeekNamedPipe (h, NULL, 0, NULL, &dwBytes, NULL))
942 SetErrnoFromWinError (GetLastError ());
945 GNUNET_log_strerror (GNUNET_ERROR_TYPE_ERROR,
949 goto select_loop_end;
954 GNUNET_CONTAINER_slist_add (handles_read,
955 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT, &h,
960 GNUNET_CONTAINER_slist_iter_destroy (i);
963 /* Poll for faulty pipes */
967 struct GNUNET_CONTAINER_SList_Iterator *i;
968 for (i = GNUNET_CONTAINER_slist_begin (efds->handles);
969 GNUNET_CONTAINER_slist_end (i) != GNUNET_YES;
970 GNUNET_CONTAINER_slist_next (i))
975 h = *(HANDLE *) GNUNET_CONTAINER_slist_get (i, NULL);
976 if (!PeekNamedPipe (h, NULL, 0, NULL, &dwBytes, NULL))
979 GNUNET_CONTAINER_slist_add (handles_except,
980 GNUNET_CONTAINER_SLIST_DISPOSITION_TRANSIENT, &h,
985 GNUNET_CONTAINER_slist_iter_destroy (i);
990 GNUNET_CONTAINER_slist_append (handles_write, wfds->handles);
991 retcode += GNUNET_CONTAINER_slist_count (wfds->handles);
994 /* Check for closed sockets */
995 for (i = 0; i < nfds; i++)
998 if (SAFE_FD_ISSET (i, &sock_read))
1001 struct sockaddr addr;
1003 if (getpeername (i, &addr, &len) == SOCKET_ERROR)
1009 (i, SOL_SOCKET, SO_ERROR, (char *) &err, &len) == 0
1010 && err == WSAENOTCONN)
1013 if (!SAFE_FD_ISSET (i, &aread))
1024 if (retcode == 0 && nfds == 0)
1025 Sleep (GNUNET_MIN (100, limit - GetTickCount ()));
1027 while (retcode == 0 && (ms_total == INFINITE || GetTickCount () < limit));
1035 GNUNET_NETWORK_fdset_zero (rfds);
1036 GNUNET_NETWORK_fdset_copy_native (rfds, &aread, retcode);
1037 GNUNET_CONTAINER_slist_clear (rfds->handles);
1038 GNUNET_CONTAINER_slist_append (rfds->handles, handles_read);
1044 GNUNET_NETWORK_fdset_zero (wfds);
1045 GNUNET_NETWORK_fdset_copy_native (wfds, &awrite, retcode);
1046 GNUNET_CONTAINER_slist_clear (wfds->handles);
1047 GNUNET_CONTAINER_slist_append (wfds->handles, handles_write);
1052 GNUNET_NETWORK_fdset_zero (efds);
1053 GNUNET_NETWORK_fdset_copy_native (efds, &aexcept, retcode);
1054 GNUNET_CONTAINER_slist_clear (efds->handles);
1055 GNUNET_CONTAINER_slist_append (efds->handles, handles_except);
1059 GNUNET_CONTAINER_slist_destroy (handles_read);
1060 GNUNET_CONTAINER_slist_destroy (handles_write);
1061 GNUNET_CONTAINER_slist_destroy (handles_except);
1068 /* end of network.c */