add GNUNET_STRINGS_data_to_string_alloc from TALER
[oweals/gnunet.git] / src / util / network.c
1 /*
2      This file is part of GNUnet.
3      (C) 2009-2013 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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.
19 */
20
21 /**
22  * @file util/network.c
23  * @brief basic, low-level networking interface
24  * @author Nils Durner
25  * @author Christian Grothoff
26  */
27 #include "platform.h"
28 #include "gnunet_util_lib.h"
29 #include "disk.h"
30
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)
34
35 #define DEBUG_NETWORK GNUNET_EXTRA_LOGGING
36
37
38 #ifndef INVALID_SOCKET
39 #define INVALID_SOCKET -1
40 #endif
41
42
43 /**
44  * @brief handle to a socket
45  */
46 struct GNUNET_NETWORK_Handle
47 {
48 #ifndef MINGW
49   int fd;
50 #else
51   SOCKET fd;
52 #endif
53
54   /**
55    * Address family / domain.
56    */
57   int af;
58
59   /**
60    * Type of the socket
61    */
62   int type;
63
64   /**
65    * Number of bytes in addr.
66    */
67   socklen_t addrlen;
68
69   /**
70    * Address we were bound to, or NULL.
71    */
72   struct sockaddr *addr;
73
74 };
75
76
77 /**
78  * Test if the given protocol family is supported by this system.
79  *
80  * @param pf protocol family to test (PF_INET, PF_INET6, PF_UNIX)
81  * @return #GNUNET_OK if the PF is supported
82  */
83 int
84 GNUNET_NETWORK_test_pf (int pf)
85 {
86   int s;
87
88   s = socket (pf, SOCK_STREAM, 0);
89   if (-1 == s)
90   {
91     if (EAFNOSUPPORT == errno)
92       return GNUNET_NO;
93     GNUNET_log (GNUNET_ERROR_TYPE_WARNING,
94                 "Failed to create test socket: %s\n",
95                 STRERROR (errno));
96     return GNUNET_SYSERR;
97   }
98 #if WINDOWS
99   closesocket (s);
100 #else
101   close (s);
102 #endif
103   return GNUNET_OK;
104 }
105
106
107 /**
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).
111  *
112  * @param unixpath long path, will be freed (or same pointer returned
113  *        with moved 0-termination).
114  * @return shortened unixpath, NULL on error
115  */
116 char *
117 GNUNET_NETWORK_shorten_unixpath (char *unixpath)
118 {
119   struct sockaddr_un dummy;
120   size_t slen;
121   char *end;
122   struct GNUNET_HashCode sh;
123   struct GNUNET_CRYPTO_HashAsciiEncoded ae;
124   size_t upm;
125
126   upm = sizeof (dummy.sun_path);
127   slen = strlen (unixpath);
128   if (slen < upm)
129     return unixpath; /* no shortening required */
130   GNUNET_CRYPTO_hash (unixpath, slen, &sh);
131   while (16 +
132          strlen (unixpath) >= upm)
133   {
134     if (NULL == (end = strrchr (unixpath, '/')))
135     {
136       GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
137                   _("Unable to shorten unix path `%s' while keeping name unique\n"),
138                   unixpath);
139       GNUNET_free (unixpath);
140       return NULL;
141     }
142     *end = '\0';
143   }
144   GNUNET_CRYPTO_hash_to_enc (&sh, &ae);
145   strncat (unixpath, (char*) ae.encoding, 16);
146   return unixpath;
147 }
148
149
150 #ifndef FD_COPY
151 #define FD_COPY(s, d) (memcpy ((d), (s), sizeof (fd_set)))
152 #endif
153
154
155 /**
156  * Set if a socket should use blocking or non-blocking IO.
157  *
158  * @param fd socket
159  * @param doBlock blocking mode
160  * @return #GNUNET_OK on success, #GNUNET_SYSERR on error
161  */
162 int
163 GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd,
164                                     int doBlock)
165 {
166
167 #if MINGW
168   u_long mode;
169
170   mode = !doBlock;
171   if (SOCKET_ERROR ==
172       ioctlsocket (fd->fd,
173                    FIONBIO,
174                    &mode))
175
176   {
177     SetErrnoFromWinsockError (WSAGetLastError ());
178     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
179                   "ioctlsocket");
180     return GNUNET_SYSERR;
181   }
182   return GNUNET_OK;
183
184 #else
185   /* not MINGW */
186   int flags = fcntl (fd->fd, F_GETFL);
187
188   if (flags == -1)
189
190   {
191     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
192                   "fcntl");
193     return GNUNET_SYSERR;
194   }
195   if (doBlock)
196     flags &= ~O_NONBLOCK;
197
198   else
199     flags |= O_NONBLOCK;
200   if (0 != fcntl (fd->fd,
201                   F_SETFL,
202                   flags))
203
204   {
205     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
206                   "fcntl");
207     return GNUNET_SYSERR;
208   }
209   return GNUNET_OK;
210 #endif
211 }
212
213
214 /**
215  * Make a socket non-inheritable to child processes
216  *
217  * @param h the socket to make non-inheritable
218  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
219  * @warning Not implemented on Windows
220  */
221 static int
222 socket_set_inheritable (const struct GNUNET_NETWORK_Handle *h)
223 {
224 #ifndef MINGW
225   int i;
226   i = fcntl (h->fd, F_GETFD);
227   if (i < 0)
228     return GNUNET_SYSERR;
229   if (i == (i | FD_CLOEXEC))
230     return GNUNET_OK;
231   i |= FD_CLOEXEC;
232   if (fcntl (h->fd, F_SETFD, i) < 0)
233     return GNUNET_SYSERR;
234 #else
235   BOOL b;
236   SetLastError (0);
237   b = SetHandleInformation ((HANDLE) h->fd, HANDLE_FLAG_INHERIT, 0);
238   if (!b)
239   {
240     SetErrnoFromWinsockError (WSAGetLastError ());
241     return GNUNET_SYSERR;
242   }
243 #endif
244   return GNUNET_OK;
245 }
246
247
248 #ifdef DARWIN
249 /**
250  * The MSG_NOSIGNAL equivalent on Mac OS X
251  *
252  * @param h the socket to make non-delaying
253  */
254 static void
255 socket_set_nosigpipe (const struct GNUNET_NETWORK_Handle *h)
256 {
257   int abs_value = 1;
258
259   if (0 !=
260       setsockopt (h->fd, SOL_SOCKET, SO_NOSIGPIPE,
261                   (const void *) &abs_value,
262                   sizeof (abs_value)))
263     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING, "setsockopt");
264 }
265 #endif
266
267
268 /**
269  * Disable delays when sending data via the socket.
270  * (GNUnet makes sure that messages are as big as
271  * possible already).
272  *
273  * @param h the socket to make non-delaying
274  */
275 static void
276 socket_set_nodelay (const struct GNUNET_NETWORK_Handle *h)
277 {
278 #ifndef WINDOWS
279   int value = 1;
280
281   if (0 !=
282       setsockopt (h->fd,
283                   IPPROTO_TCP,
284                   TCP_NODELAY,
285                   &value, sizeof (value)))
286     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
287                   "setsockopt");
288 #else
289   const char *abs_value = "1";
290
291   if (0 !=
292       setsockopt (h->fd, IPPROTO_TCP, TCP_NODELAY,
293                   (const void *) abs_value,
294                   sizeof (abs_value)))
295     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
296                   "setsockopt");
297 #endif
298 }
299
300
301 /**
302  * Perform proper canonical initialization for a network handle.
303  * Set it to non-blocking, make it non-inheritable to child
304  * processes, disable SIGPIPE, enable "nodelay" (if non-UNIX
305  * stream socket) and check that it is smaller than FD_SETSIZE.
306  *
307  * @param h socket to initialize
308  * @param af address family of the socket
309  * @param type socket type
310  * @return #GNUNET_OK on success, #GNUNET_SYSERR if initialization
311  *         failed and the handle was destroyed
312  */
313 static int
314 initialize_network_handle (struct GNUNET_NETWORK_Handle *h,
315                            int af,
316                            int type)
317 {
318   h->af = af;
319   h->type = type;
320   if (h->fd == INVALID_SOCKET)
321   {
322 #ifdef MINGW
323     SetErrnoFromWinsockError (WSAGetLastError ());
324 #endif
325     GNUNET_free (h);
326     return GNUNET_SYSERR;
327   }
328 #ifndef MINGW
329   if (h->fd >= FD_SETSIZE)
330   {
331     GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (h));
332     errno = EMFILE;
333     return GNUNET_SYSERR;
334   }
335 #endif
336   if (GNUNET_OK != socket_set_inheritable (h))
337     LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
338                   "socket_set_inheritable");
339
340   if (GNUNET_SYSERR == GNUNET_NETWORK_socket_set_blocking (h, GNUNET_NO))
341   {
342     GNUNET_break (0);
343     GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (h));
344     return GNUNET_SYSERR;
345   }
346 #ifdef DARWIN
347   socket_set_nosigpipe (h);
348 #endif
349   if ( (type == SOCK_STREAM)
350 #ifdef AF_UNIX
351        && (af != AF_UNIX)
352 #endif
353        )
354     socket_set_nodelay (h);
355   return GNUNET_OK;
356 }
357
358
359 /**
360  * accept a new connection on a socket
361  *
362  * @param desc bound socket
363  * @param address address of the connecting peer, may be NULL
364  * @param address_len length of @a address
365  * @return client socket
366  */
367 struct GNUNET_NETWORK_Handle *
368 GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
369                               struct sockaddr *address,
370                               socklen_t *address_len)
371 {
372   struct GNUNET_NETWORK_Handle *ret;
373
374   ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
375 #if DEBUG_NETWORK
376   {
377     struct sockaddr_storage name;
378     socklen_t namelen = sizeof (name);
379
380     int gsn = getsockname (desc->fd,
381                            (struct sockaddr *) &name,
382                            &namelen);
383
384     if (gsn == 0)
385       LOG (GNUNET_ERROR_TYPE_DEBUG,
386            "Accepting connection on `%s'\n",
387            GNUNET_a2s ((const struct sockaddr *) &name,
388                        namelen));
389   }
390 #endif
391   ret->fd = accept (desc->fd,
392                     address,
393                     address_len);
394   if (-1 == ret->fd)
395   {
396     GNUNET_free (ret);
397     return NULL;
398   }
399   if (GNUNET_OK !=
400       initialize_network_handle (ret,
401                                  (NULL != address) ? address->sa_family : desc->af,
402                                  SOCK_STREAM))
403     return NULL;
404   return ret;
405 }
406
407
408 /**
409  * Bind a socket to a particular address.
410  *
411  * @param desc socket to bind
412  * @param address address to be bound
413  * @param address_len length of @a address
414  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
415  */
416 int
417 GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
418                             const struct sockaddr *address,
419                             socklen_t address_len)
420 {
421   int ret;
422
423 #ifdef IPV6_V6ONLY
424 #ifdef IPPROTO_IPV6
425   {
426     const int on = 1;
427
428     if (AF_INET6 == desc->af)
429       if (setsockopt (desc->fd, IPPROTO_IPV6, IPV6_V6ONLY,
430                       (const void *) &on,
431                       sizeof (on)))
432         LOG_STRERROR (GNUNET_ERROR_TYPE_DEBUG,
433                       "setsockopt");
434   }
435 #endif
436 #endif
437 #ifndef WINDOWS
438   {
439     const int on = 1;
440
441     /* This is required here for TCP sockets, but only on UNIX */
442     if ( (SOCK_STREAM == desc->type) &&
443          (0 != setsockopt (desc->fd,
444                            SOL_SOCKET,
445                            SO_REUSEADDR,
446                            &on, sizeof (on))))
447       LOG_STRERROR (GNUNET_ERROR_TYPE_DEBUG,
448                     "setsockopt");
449   }
450 #endif
451 #ifndef WINDOWS
452   {
453     /* set permissions of newly created non-abstract UNIX domain socket to
454        "user-only"; applications can choose to relax this later */
455     mode_t old_mask = 0; /* assigned to make compiler happy */
456     const struct sockaddr_un *un;
457     int not_abstract = 0;
458
459     if ((AF_UNIX == address->sa_family)
460         && (NULL != (un = (const struct sockaddr_un *) address)->sun_path)
461         && ('\0' != un->sun_path[0]) ) /* Not an abstract socket */
462       not_abstract = 1;
463     if (not_abstract)
464       old_mask = umask (S_IWGRP | S_IRGRP | S_IXGRP | S_IWOTH | S_IROTH | S_IXOTH);
465 #endif
466
467     ret = bind (desc->fd, address, address_len);
468 #ifndef WINDOWS
469     if (not_abstract)
470       (void) umask (old_mask);
471   }
472 #endif
473 #ifdef MINGW
474   if (SOCKET_ERROR == ret)
475     SetErrnoFromWinsockError (WSAGetLastError ());
476 #endif
477   if (ret != 0)
478     return GNUNET_SYSERR;
479 #ifndef MINGW
480   desc->addr = GNUNET_malloc (address_len);
481   memcpy (desc->addr, address, address_len);
482   desc->addrlen = address_len;
483 #endif
484   return GNUNET_OK;
485 }
486
487
488 /**
489  * Close a socket
490  *
491  * @param desc socket
492  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
493  */
494 int
495 GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc)
496 {
497   int ret;
498
499 #ifdef WINDOWS
500   DWORD error = 0;
501
502   SetLastError (0);
503   ret = closesocket (desc->fd);
504   error = WSAGetLastError ();
505   SetErrnoFromWinsockError (error);
506   LOG (GNUNET_ERROR_TYPE_DEBUG,
507        "Closed 0x%x, closesocket() returned %d, GLE is %u\n",
508        desc->fd,
509        ret,
510        error);
511 #else
512   ret = close (desc->fd);
513 #endif
514 #ifndef WINDOWS
515   const struct sockaddr_un *un;
516
517   /* Cleanup the UNIX domain socket and its parent directories in case of non
518      abstract sockets */
519   if ( (AF_UNIX == desc->af) &&
520        (NULL != desc->addr) &&
521        (NULL != (un = (const struct sockaddr_un *) desc->addr)->sun_path) &&
522        ('\0' != un->sun_path[0]) )
523   {
524     char *dirname = GNUNET_strndup (un->sun_path,
525                                     sizeof (un->sun_path));
526
527     if (0 != unlink (dirname))
528     {
529       LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
530                          "unlink",
531                          dirname);
532     }
533     else
534     {
535       size_t len;
536
537       len = strlen (dirname);
538       while ((len > 0) && (dirname[len] != DIR_SEPARATOR))
539         len--;
540       dirname[len] = '\0';
541       if ((0 != len) && (0 != rmdir (dirname)))
542       {
543         switch (errno)
544         {
545         case EACCES:
546         case ENOTEMPTY:
547         case EPERM:
548           /* these are normal and can just be ignored */
549           break;
550         default:
551           GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
552                                     "rmdir",
553                                     dirname);
554           break;
555         }
556       }
557     }
558     GNUNET_free (dirname);
559   }
560 #endif
561   GNUNET_NETWORK_socket_free_memory_only_ (desc);
562   return (ret == 0) ? GNUNET_OK : GNUNET_SYSERR;
563 }
564
565
566 /**
567  * Only free memory of a socket, keep the file descriptor untouched.
568  *
569  * @param desc socket
570  */
571 void
572 GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc)
573 {
574   GNUNET_free_non_null (desc->addr);
575   GNUNET_free (desc);
576 }
577
578
579 /**
580  * Box a native socket (and check that it is a socket).
581  *
582  * @param fd socket to box
583  * @return NULL on error (including not supported on target platform)
584  */
585 struct GNUNET_NETWORK_Handle *
586 GNUNET_NETWORK_socket_box_native (SOCKTYPE fd)
587 {
588   struct GNUNET_NETWORK_Handle *ret;
589 #if MINGW
590   unsigned long i;
591   DWORD d;
592   /* FIXME: Find a better call to check that FD is valid */
593   if (0 !=
594       WSAIoctl (fd, FIONBIO,
595                 (void *) &i, sizeof (i),
596                 NULL, 0, &d,
597                 NULL, NULL))
598     return NULL;                /* invalid FD */
599   ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
600   ret->fd = fd;
601   ret->af = AF_UNSPEC;
602   return ret;
603 #else
604   if (fcntl (fd, F_GETFD) < 0)
605     return NULL;                /* invalid FD */
606   ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
607   ret->fd = fd;
608   ret->af = AF_UNSPEC;
609   return ret;
610 #endif
611 }
612
613
614 /**
615  * Connect a socket to some remote address.
616  *
617  * @param desc socket
618  * @param address peer address
619  * @param address_len length of @a address
620  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
621  */
622 int
623 GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
624                                const struct sockaddr *address,
625                                socklen_t address_len)
626 {
627   int ret;
628
629   ret = connect (desc->fd,
630                  address,
631                  address_len);
632 #ifdef MINGW
633   if (SOCKET_ERROR == ret)
634   {
635     SetErrnoFromWinsockError (WSAGetLastError ());
636     if (errno == EWOULDBLOCK)
637       errno = EINPROGRESS;
638   }
639 #endif
640   return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
641 }
642
643
644 /**
645  * Get socket options
646  *
647  * @param desc socket
648  * @param level protocol level of the option
649  * @param optname identifier of the option
650  * @param optval options
651  * @param optlen length of @a optval
652  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
653  */
654 int
655 GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
656                                   int level,
657                                   int optname,
658                                   void *optval,
659                                   socklen_t *optlen)
660 {
661   int ret;
662
663   ret = getsockopt (desc->fd,
664                     level,
665                     optname,
666                     optval, optlen);
667
668 #ifdef MINGW
669   if ( (0 == ret) &&
670        (SOL_SOCKET == level) &&
671        (SO_ERROR == optname) )
672     *((int *) optval) = GetErrnoFromWinsockError (*((int *) optval));
673   else if (SOCKET_ERROR == ret)
674     SetErrnoFromWinsockError (WSAGetLastError ());
675 #endif
676   return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
677 }
678
679
680 /**
681  * Listen on a socket
682  *
683  * @param desc socket
684  * @param backlog length of the listen queue
685  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
686  */
687 int
688 GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
689                               int backlog)
690 {
691   int ret;
692
693   ret = listen (desc->fd,
694                 backlog);
695 #ifdef MINGW
696   if (SOCKET_ERROR == ret)
697     SetErrnoFromWinsockError (WSAGetLastError ());
698 #endif
699   return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
700 }
701
702
703 /**
704  * How much data is available to be read on this descriptor?
705  *
706  * @param desc socket
707  * @returns #GNUNET_NO if no data is available, or on error!
708  */
709 ssize_t
710 GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle *desc)
711 {
712   int error;
713
714   /* How much is there to be read? */
715 #ifndef WINDOWS
716   int pending;
717
718   error = ioctl (desc->fd,
719                  FIONREAD,
720                  &pending);
721   if (error == 0)
722     return (ssize_t) pending;
723   return GNUNET_NO;
724 #else
725   u_long pending;
726
727   error = ioctlsocket (desc->fd,
728                        FIONREAD,
729                        &pending);
730   if (error != SOCKET_ERROR)
731     return (ssize_t) pending;
732   return GNUNET_NO;
733 #endif
734 }
735
736
737 /**
738  * Read data from a socket (always non-blocking).
739  *
740  * @param desc socket
741  * @param buffer buffer
742  * @param length length of @a buffer
743  * @param src_addr either the source to recv from, or all zeroes
744  *        to be filled in by recvfrom
745  * @param addrlen length of the @a src_addr
746  */
747 ssize_t
748 GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
749                                 void *buffer,
750                                 size_t length,
751                                 struct sockaddr *src_addr,
752                                 socklen_t *addrlen)
753 {
754   int ret;
755   int flags;
756
757   flags = 0;
758
759 #ifdef MSG_DONTWAIT
760   flags |= MSG_DONTWAIT;
761
762 #endif
763   ret = recvfrom (desc->fd,
764                   buffer,
765                   length,
766                   flags,
767                   src_addr,
768                   addrlen);
769 #ifdef MINGW
770   if (SOCKET_ERROR == ret)
771     SetErrnoFromWinsockError (WSAGetLastError ());
772 #endif
773   return ret;
774 }
775
776
777 /**
778  * Read data from a connected socket (always non-blocking).
779  *
780  * @param desc socket
781  * @param buffer buffer
782  * @param length length of @a buffer
783  * @return number of bytes received, -1 on error
784  */
785 ssize_t
786 GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
787                             void *buffer,
788                             size_t length)
789 {
790   int ret;
791   int flags;
792
793   flags = 0;
794
795 #ifdef MSG_DONTWAIT
796   flags |= MSG_DONTWAIT;
797 #endif
798   ret = recv (desc->fd,
799               buffer,
800               length,
801               flags);
802 #ifdef MINGW
803   if (SOCKET_ERROR == ret)
804     SetErrnoFromWinsockError (WSAGetLastError ());
805 #endif
806   return ret;
807 }
808
809
810 /**
811  * Send data (always non-blocking).
812  *
813  * @param desc socket
814  * @param buffer data to send
815  * @param length size of the @a buffer
816  * @return number of bytes sent, #GNUNET_SYSERR on error
817  */
818 ssize_t
819 GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
820                             const void *buffer,
821                             size_t length)
822 {
823   int ret;
824   int flags;
825
826   flags = 0;
827 #ifdef MSG_DONTWAIT
828   flags |= MSG_DONTWAIT;
829
830 #endif
831 #ifdef MSG_NOSIGNAL
832   flags |= MSG_NOSIGNAL;
833
834 #endif
835   ret = send (desc->fd,
836               buffer,
837               length,
838               flags);
839 #ifdef MINGW
840   if (SOCKET_ERROR == ret)
841     SetErrnoFromWinsockError (WSAGetLastError ());
842
843 #endif
844   return ret;
845 }
846
847
848 /**
849  * Send data to a particular destination (always non-blocking).
850  * This function only works for UDP sockets.
851  *
852  * @param desc socket
853  * @param message data to send
854  * @param length size of the @a message
855  * @param dest_addr destination address
856  * @param dest_len length of @a address
857  * @return number of bytes sent, #GNUNET_SYSERR on error
858  */
859 ssize_t
860 GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
861                               const void *message,
862                               size_t length,
863                               const struct sockaddr *dest_addr,
864                               socklen_t dest_len)
865 {
866   int ret;
867   int flags;
868
869   flags = 0;
870
871 #ifdef MSG_DONTWAIT
872   flags |= MSG_DONTWAIT;
873 #endif
874 #ifdef MSG_NOSIGNAL
875   flags |= MSG_NOSIGNAL;
876 #endif
877   ret = sendto (desc->fd, message, length, flags, dest_addr, dest_len);
878 #ifdef MINGW
879   if (SOCKET_ERROR == ret)
880     SetErrnoFromWinsockError (WSAGetLastError ());
881 #endif
882   return ret;
883 }
884
885
886 /**
887  * Set socket option
888  *
889  * @param fd socket
890  * @param level protocol level of the option
891  * @param option_name option identifier
892  * @param option_value value to set
893  * @param option_len size of @a option_value
894  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
895  */
896 int
897 GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
898                                   int level,
899                                   int option_name,
900                                   const void *option_value,
901                                   socklen_t option_len)
902 {
903   int ret;
904
905   ret = setsockopt (fd->fd,
906                     level,
907                     option_name,
908                     option_value,
909                     option_len);
910 #ifdef MINGW
911   if (SOCKET_ERROR == ret)
912     SetErrnoFromWinsockError (WSAGetLastError ());
913 #endif
914   return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
915 }
916
917
918 /**
919  * Create a new socket.  Configure it for non-blocking IO and
920  * mark it as non-inheritable to child processes (set the
921  * close-on-exec flag).
922  *
923  * @param domain domain of the socket
924  * @param type socket type
925  * @param protocol network protocol
926  * @return new socket, NULL on error
927  */
928 struct GNUNET_NETWORK_Handle *
929 GNUNET_NETWORK_socket_create (int domain,
930                               int type,
931                               int protocol)
932 {
933   struct GNUNET_NETWORK_Handle *ret;
934   int fd;
935
936   fd = socket (domain, type, protocol);
937   if (-1 == fd)
938     return NULL;
939   ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
940   ret->fd = fd;
941   if (GNUNET_OK !=
942       initialize_network_handle (ret,
943                                  domain,
944                                  type))
945     return NULL;
946   return ret;
947 }
948
949
950 /**
951  * Shut down socket operations
952  * @param desc socket
953  * @param how type of shutdown
954  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
955  */
956 int
957 GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,
958                                 int how)
959 {
960   int ret;
961
962   ret = shutdown (desc->fd, how);
963 #ifdef MINGW
964   if (ret != 0)
965     SetErrnoFromWinsockError (WSAGetLastError ());
966 #endif
967   return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
968 }
969
970
971 /**
972  * Disable the "CORK" feature for communication with the given socket,
973  * forcing the OS to immediately flush the buffer on transmission
974  * instead of potentially buffering multiple messages.  Essentially
975  * reduces the OS send buffers to zero.
976  *
977  * @param desc socket
978  * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise
979  */
980 int
981 GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc)
982 {
983   int ret = 0;
984
985 #if WINDOWS
986   int value = 0;
987
988   if (0 !=
989       (ret =
990        setsockopt (desc->fd,
991                    SOL_SOCKET,
992                    SO_SNDBUF,
993                    (char *) &value,
994                    sizeof (value))))
995     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
996                   "setsockopt");
997   if (0 !=
998       (ret =
999        setsockopt (desc->fd,
1000                    SOL_SOCKET,
1001                    SO_RCVBUF,
1002                    (char *) &value,
1003                    sizeof (value))))
1004     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1005                   "setsockopt");
1006 #elif LINUX
1007   int value = 0;
1008
1009   if (0 !=
1010       (ret =
1011        setsockopt (desc->fd,
1012                    SOL_SOCKET,
1013                    SO_SNDBUF,
1014                    &value,
1015                    sizeof (value))))
1016     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1017                   "setsockopt");
1018   if (0 !=
1019       (ret =
1020        setsockopt (desc->fd,
1021                    SOL_SOCKET,
1022                    SO_RCVBUF,
1023                    &value,
1024                    sizeof (value))))
1025     LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
1026                   "setsockopt");
1027 #endif
1028   return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
1029 }
1030
1031
1032 /**
1033  * Reset FD set
1034  *
1035  * @param fds fd set
1036  */
1037 void
1038 GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds)
1039 {
1040   FD_ZERO (&fds->sds);
1041   fds->nsds = 0;
1042 #ifdef MINGW
1043   fds->handles_pos = 0;
1044 #endif
1045 }
1046
1047
1048 /**
1049  * Add a socket to the FD set
1050  *
1051  * @param fds fd set
1052  * @param desc socket to add
1053  */
1054 void
1055 GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
1056                           const struct GNUNET_NETWORK_Handle *desc)
1057 {
1058   FD_SET (desc->fd,
1059           &fds->sds);
1060   fds->nsds = GNUNET_MAX (fds->nsds,
1061                           desc->fd + 1);
1062 }
1063
1064
1065 /**
1066  * Check whether a socket is part of the fd set
1067  *
1068  * @param fds fd set
1069  * @param desc socket
1070  * @return 0 if the FD is not set
1071  */
1072 int
1073 GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
1074                             const struct GNUNET_NETWORK_Handle *desc)
1075 {
1076   return FD_ISSET (desc->fd,
1077                    &fds->sds);
1078 }
1079
1080
1081 /**
1082  * Add one fd set to another
1083  *
1084  * @param dst the fd set to add to
1085  * @param src the fd set to add from
1086  */
1087 void
1088 GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
1089                           const struct GNUNET_NETWORK_FDSet *src)
1090 {
1091 #ifndef MINGW
1092   int nfds;
1093
1094   for (nfds = src->nsds; nfds >= 0; nfds--)
1095     if (FD_ISSET (nfds, &src->sds))
1096       FD_SET (nfds, &dst->sds);
1097   dst->nsds = GNUNET_MAX (dst->nsds,
1098                           src->nsds);
1099 #else
1100   /* This is MinGW32-specific implementation that relies on the code that
1101    * winsock2.h defines for FD_SET. Namely, it relies on FD_SET checking
1102    * that fd being added is not already in the set.
1103    * Also relies on us knowing what's inside fd_set (fd_count and fd_array).
1104    *
1105    * NOTE: I don't understand why the UNIX-logic wouldn't work
1106    * for the first part here as well. -CG
1107    */
1108   unsigned int i;
1109
1110   for (i = 0; i < src->sds.fd_count; i++)
1111     FD_SET (src->sds.fd_array[i],
1112             &dst->sds);
1113   dst->nsds = GNUNET_MAX (src->nsds,
1114                           dst->nsds);
1115
1116   /* also copy over `struct GNUNET_DISK_FileHandle` array */
1117   if (dst->handles_pos + src->handles_pos > dst->handles_size)
1118     GNUNET_array_grow (dst->handles,
1119                        dst->handles_size,
1120                        ((dst->handles_pos + src->handles_pos) << 1));
1121   for (i = 0; i < src->handles_pos; i++)
1122     dst->handles[dst->handles_pos++] = src->handles[i];
1123 #endif
1124 }
1125
1126
1127 /**
1128  * Copy one fd set to another
1129  *
1130  * @param to destination
1131  * @param from source
1132  */
1133 void
1134 GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
1135                            const struct GNUNET_NETWORK_FDSet *from)
1136 {
1137   FD_COPY (&from->sds,
1138            &to->sds);
1139   to->nsds = from->nsds;
1140 #ifdef MINGW
1141   if (from->handles_pos > to->handles_size)
1142     GNUNET_array_grow (to->handles,
1143                        to->handles_size,
1144                        from->handles_pos * 2);
1145   memcpy (to->handles,
1146           from->handles,
1147           from->handles_pos * sizeof (struct GNUNET_NETWORK_Handle *));
1148   to->handles_pos = from->handles_pos;
1149 #endif
1150 }
1151
1152
1153 /**
1154  * Return file descriptor for this network handle
1155  *
1156  * @param desc wrapper to process
1157  * @return POSIX file descriptor
1158  */
1159 int
1160 GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc)
1161 {
1162   return desc->fd;
1163 }
1164
1165
1166 /**
1167  * Return sockaddr for this network handle
1168  *
1169  * @param desc wrapper to process
1170  * @return sockaddr
1171  */
1172 struct sockaddr*
1173 GNUNET_NETWORK_get_addr (struct GNUNET_NETWORK_Handle *desc)
1174 {
1175   return desc->addr;
1176 }
1177
1178
1179 /**
1180  * Return sockaddr length for this network handle
1181  *
1182  * @param desc wrapper to process
1183  * @return socklen_t for sockaddr
1184  */
1185 socklen_t
1186 GNUNET_NETWORK_get_addrlen (struct GNUNET_NETWORK_Handle *desc)
1187 {
1188   return desc->addrlen;
1189 }
1190
1191
1192 /**
1193  * Copy a native fd set
1194  *
1195  * @param to destination
1196  * @param from native source set
1197  * @param nfds the biggest socket number in from + 1
1198  */
1199 void
1200 GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
1201                                   const fd_set *from,
1202                                   int nfds)
1203 {
1204   FD_COPY (from,
1205            &to->sds);
1206   to->nsds = nfds;
1207 }
1208
1209
1210 /**
1211  * Set a native fd in a set
1212  *
1213  * @param to destination
1214  * @param nfd native FD to set
1215  */
1216 void
1217 GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to,
1218                                  int nfd)
1219 {
1220   GNUNET_assert ((nfd >= 0) && (nfd < FD_SETSIZE));
1221   FD_SET (nfd, &to->sds);
1222   to->nsds = GNUNET_MAX (nfd + 1,
1223                          to->nsds);
1224 }
1225
1226
1227 /**
1228  * Test native fd in a set
1229  *
1230  * @param to set to test, NULL for empty set
1231  * @param nfd native FD to test, or -1 for none
1232  * @return #GNUNET_YES if FD is set in the set
1233  */
1234 int
1235 GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
1236                                   int nfd)
1237 {
1238   if ( (-1 == nfd) ||
1239        (NULL == to) )
1240     return GNUNET_NO;
1241   return FD_ISSET (nfd, &to->sds) ? GNUNET_YES : GNUNET_NO;
1242 }
1243
1244
1245 /**
1246  * Add a file handle to the fd set
1247  * @param fds fd set
1248  * @param h the file handle to add
1249  */
1250 void
1251 GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
1252                                  const struct GNUNET_DISK_FileHandle *h)
1253 {
1254 #ifdef MINGW
1255   if (fds->handles_pos == fds->handles_size)
1256     GNUNET_array_grow (fds->handles,
1257                        fds->handles_size,
1258                        fds->handles_size * 2 + 2);
1259   fds->handles[fds->handles_pos++] = h;
1260 #else
1261   int fd;
1262
1263   GNUNET_DISK_internal_file_handle_ (h,
1264                                      &fd,
1265                                      sizeof (int));
1266   FD_SET (fd,
1267           &fds->sds);
1268   fds->nsds = GNUNET_MAX (fd + 1,
1269                           fds->nsds);
1270 #endif
1271 }
1272
1273
1274 /**
1275  * Add a file handle to the fd set
1276  * @param fds fd set
1277  * @param h the file handle to add
1278  */
1279 void
1280 GNUNET_NETWORK_fdset_handle_set_first (struct GNUNET_NETWORK_FDSet *fds,
1281                                        const struct GNUNET_DISK_FileHandle *h)
1282 {
1283 #ifdef MINGW
1284   if (fds->handles_pos == fds->handles_size)
1285     GNUNET_array_grow (fds->handles,
1286                        fds->handles_size,
1287                        fds->handles_size * 2 + 2);
1288   fds->handles[fds->handles_pos] = h;
1289   if (fds->handles[0] != h)
1290   {
1291     const struct GNUNET_DISK_FileHandle *bak = fds->handles[0];
1292     fds->handles[0] = h;
1293     fds->handles[fds->handles_pos] = bak;
1294   }
1295   fds->handles_pos++;
1296 #else
1297   GNUNET_NETWORK_fdset_handle_set (fds, h);
1298 #endif
1299 }
1300
1301
1302 /**
1303  * Check if a file handle is part of an fd set
1304  *
1305  * @param fds fd set
1306  * @param h file handle
1307  * @return #GNUNET_YES if the file handle is part of the set
1308  */
1309 int
1310 GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
1311                                    const struct GNUNET_DISK_FileHandle *h)
1312 {
1313 #ifdef MINGW
1314   unsigned int i;
1315
1316   for (i=0;i<fds->handles_pos;i++)
1317     if (fds->handles[i] == h)
1318       return GNUNET_YES;
1319   return GNUNET_NO;
1320 #else
1321   return FD_ISSET (h->fd,
1322                    &fds->sds);
1323 #endif
1324 }
1325
1326
1327 #ifdef MINGW
1328 /**
1329  * Numerically compare pointers to sort them.
1330  * Used to test for overlap in the arrays.
1331  *
1332  * @param p1 a pointer
1333  * @param p2 a pointer
1334  * @return -1, 0 or 1, if the p1 < p2, p1==p2 or p1 > p2.
1335  */
1336 static int
1337 ptr_cmp (const void *p1,
1338          const void *p2)
1339 {
1340   if (p1 == p2)
1341     return 0;
1342   if ((intptr_t) p1 < (intptr_t) p2)
1343     return -1;
1344   return 1;
1345 }
1346 #endif
1347
1348
1349 /**
1350  * Checks if two fd sets overlap
1351  *
1352  * @param fds1 first fd set
1353  * @param fds2 second fd set
1354  * @return #GNUNET_YES if they do overlap, #GNUNET_NO otherwise
1355  */
1356 int
1357 GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
1358                               const struct GNUNET_NETWORK_FDSet *fds2)
1359 {
1360 #ifndef MINGW
1361   int nfds;
1362
1363   nfds = GNUNET_MIN (fds1->nsds,
1364                      fds2->nsds);
1365   while (nfds > 0)
1366   {
1367     nfds--;
1368     if ( (FD_ISSET (nfds,
1369                     &fds1->sds)) &&
1370          (FD_ISSET (nfds,
1371                     &fds2->sds)) )
1372       return GNUNET_YES;
1373   }
1374   return GNUNET_NO;
1375 #else
1376   unsigned int i;
1377   unsigned int j;
1378
1379   /* This code is somewhat hacky, we are not supposed to know what's
1380    * inside of fd_set; also the O(n^2) is really bad... */
1381   for (i = 0; i < fds1->sds.fd_count; i++)
1382     for (j = 0; j < fds2->sds.fd_count; j++)
1383       if (fds1->sds.fd_array[i] == fds2->sds.fd_array[j])
1384         return GNUNET_YES;
1385
1386   /* take a short cut if possible */
1387   if ( (0 == fds1->handles_pos) ||
1388        (0 == fds2->handles_pos) )
1389     return GNUNET_NO;
1390
1391   /* Sort file handles array to avoid quadratic complexity when
1392      checking for overlap */
1393   qsort (fds1->handles,
1394          fds1->handles_pos,
1395          sizeof (void *),
1396          &ptr_cmp);
1397   qsort (fds2->handles,
1398          fds2->handles_pos,
1399          sizeof (void *),
1400          &ptr_cmp);
1401   i = 0;
1402   j = 0;
1403   while ( (i < fds1->handles_pos) &&
1404           (j < fds2->handles_pos) )
1405   {
1406     switch (ptr_cmp (fds1->handles[i],
1407                      fds2->handles[j]))
1408     {
1409     case -1:
1410       i++;
1411       break;
1412     case 0:
1413       return GNUNET_YES;
1414     case 1:
1415       j++;
1416     }
1417   }
1418   return GNUNET_NO;
1419 #endif
1420 }
1421
1422
1423 /**
1424  * Creates an fd set
1425  *
1426  * @return a new fd set
1427  */
1428 struct GNUNET_NETWORK_FDSet *
1429 GNUNET_NETWORK_fdset_create ()
1430 {
1431   struct GNUNET_NETWORK_FDSet *fds;
1432
1433   fds = GNUNET_new (struct GNUNET_NETWORK_FDSet);
1434   GNUNET_NETWORK_fdset_zero (fds);
1435   return fds;
1436 }
1437
1438
1439 /**
1440  * Releases the associated memory of an fd set
1441  *
1442  * @param fds fd set
1443  */
1444 void
1445 GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds)
1446 {
1447 #ifdef MINGW
1448   GNUNET_array_grow (fds->handles,
1449                      fds->handles_size,
1450                      0);
1451 #endif
1452   GNUNET_free (fds);
1453 }
1454
1455
1456 #if MINGW
1457 /**
1458  * FIXME.
1459  */
1460 struct _select_params
1461 {
1462   /**
1463    * Read set.
1464    */
1465   fd_set *r;
1466
1467   /**
1468    * Write set.
1469    */
1470   fd_set *w;
1471
1472   /**
1473    * Except set.
1474    */
1475   fd_set *e;
1476
1477   /**
1478    * Timeout for select().
1479    */
1480   struct timeval *tv;
1481
1482   /**
1483    * FIXME.
1484    */
1485   HANDLE wakeup;
1486
1487   /**
1488    * FIXME.
1489    */
1490   HANDLE standby;
1491
1492   /**
1493    * FIXME.
1494    */
1495   SOCKET wakeup_socket;
1496
1497   /**
1498    * Set to return value from select.
1499    */
1500   int status;
1501 };
1502
1503
1504 /**
1505  * FIXME.
1506  */
1507 static DWORD WINAPI
1508 _selector (LPVOID p)
1509 {
1510   struct _select_params *sp = p;
1511
1512   while (1)
1513   {
1514     WaitForSingleObject (sp->standby,
1515                          INFINITE);
1516     ResetEvent (sp->standby);
1517     sp->status = select (1,
1518                          sp->r,
1519                          sp->w,
1520                          sp->e,
1521                          sp->tv);
1522     if (FD_ISSET (sp->wakeup_socket,
1523                   sp->r))
1524     {
1525       FD_CLR (sp->wakeup_socket,
1526               sp->r);
1527       sp->status -= 1;
1528     }
1529     SetEvent (sp->wakeup);
1530   }
1531   return 0;
1532 }
1533
1534
1535 static HANDLE hEventPipeWrite;
1536
1537 static HANDLE hEventReadReady;
1538
1539 static struct _select_params sp;
1540
1541 static HANDLE select_thread;
1542
1543 static HANDLE select_finished_event;
1544
1545 static HANDLE select_standby_event;
1546
1547 static SOCKET select_wakeup_socket = -1;
1548
1549 static SOCKET select_send_socket = -1;
1550
1551 static struct timeval select_timeout;
1552
1553
1554 /**
1555  * On W32, we actually use a thread to help with the
1556  * event loop due to W32-API limitations.  This function
1557  * initializes that thread.
1558  */
1559 static void
1560 initialize_select_thread ()
1561 {
1562   SOCKET select_listening_socket = -1;
1563   struct sockaddr_in s_in;
1564   int alen;
1565   int res;
1566   unsigned long p;
1567
1568   select_standby_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1569   select_finished_event = CreateEvent (NULL, TRUE, FALSE, NULL);
1570
1571   select_wakeup_socket = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
1572
1573   select_listening_socket = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
1574
1575   p = 1;
1576   res = ioctlsocket (select_wakeup_socket, FIONBIO, &p);
1577   LOG (GNUNET_ERROR_TYPE_DEBUG,
1578        "Select thread initialization: ioctlsocket() returns %d\n",
1579        res);
1580
1581   alen = sizeof (s_in);
1582   s_in.sin_family = AF_INET;
1583   s_in.sin_port = 0;
1584   s_in.sin_addr.S_un.S_un_b.s_b1 = 127;
1585   s_in.sin_addr.S_un.S_un_b.s_b2 = 0;
1586   s_in.sin_addr.S_un.S_un_b.s_b3 = 0;
1587   s_in.sin_addr.S_un.S_un_b.s_b4 = 1;
1588   res = bind (select_listening_socket,
1589               (const struct sockaddr *) &s_in,
1590               sizeof (s_in));
1591   LOG (GNUNET_ERROR_TYPE_DEBUG,
1592        "Select thread initialization: bind() returns %d\n",
1593        res);
1594
1595   res = getsockname (select_listening_socket,
1596                      (struct sockaddr *) &s_in,
1597                      &alen);
1598   LOG (GNUNET_ERROR_TYPE_DEBUG,
1599        "Select thread initialization: getsockname() returns %d\n",
1600        res);
1601
1602   res = listen (select_listening_socket,
1603                 SOMAXCONN);
1604   LOG (GNUNET_ERROR_TYPE_DEBUG,
1605        "Select thread initialization: listen() returns %d\n",
1606        res);
1607   res = connect (select_wakeup_socket,
1608                  (const struct sockaddr *) &s_in,
1609                  sizeof (s_in));
1610   LOG (GNUNET_ERROR_TYPE_DEBUG,
1611        "Select thread initialization: connect() returns %d\n",
1612        res);
1613
1614   select_send_socket = accept (select_listening_socket,
1615                                (struct sockaddr *) &s_in,
1616                                &alen);
1617
1618   closesocket (select_listening_socket);
1619
1620   sp.wakeup = select_finished_event;
1621   sp.standby = select_standby_event;
1622   sp.wakeup_socket = select_wakeup_socket;
1623
1624   select_thread = CreateThread (NULL,
1625                                 0,
1626                                 _selector,
1627                                 &sp,
1628                                 0, NULL);
1629 }
1630
1631
1632 #endif
1633
1634
1635 #ifndef MINGW
1636 /**
1637  * Check if sockets or pipes meet certain conditions
1638  *
1639  * @param rfds set of sockets or pipes to be checked for readability
1640  * @param wfds set of sockets or pipes to be checked for writability
1641  * @param efds set of sockets or pipes to be checked for exceptions
1642  * @param timeout relative value when to return
1643  * @return number of selected sockets or pipes, #GNUNET_SYSERR on error
1644  */
1645 int
1646 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
1647                               struct GNUNET_NETWORK_FDSet *wfds,
1648                               struct GNUNET_NETWORK_FDSet *efds,
1649                               const struct GNUNET_TIME_Relative timeout)
1650 {
1651   int nfds;
1652   struct timeval tv;
1653
1654   if (NULL != rfds)
1655     nfds = rfds->nsds;
1656   else
1657     nfds = 0;
1658   if (NULL != wfds)
1659     nfds = GNUNET_MAX (nfds,
1660                        wfds->nsds);
1661   if (NULL != efds)
1662     nfds = GNUNET_MAX (nfds,
1663                        efds->nsds);
1664   if ((0 == nfds) &&
1665       (timeout.rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us))
1666   {
1667     GNUNET_break (0);
1668     LOG (GNUNET_ERROR_TYPE_ERROR,
1669          _("Fatal internal logic error, process hangs in `%s' (abort with CTRL-C)!\n"),
1670          "select");
1671   }
1672   tv.tv_sec = timeout.rel_value_us / GNUNET_TIME_UNIT_SECONDS.rel_value_us;
1673   tv.tv_usec =
1674     (timeout.rel_value_us -
1675      (tv.tv_sec * GNUNET_TIME_UNIT_SECONDS.rel_value_us));
1676   return select (nfds,
1677                  (NULL != rfds) ? &rfds->sds : NULL,
1678                  (NULL != wfds) ? &wfds->sds : NULL,
1679                  (NULL != efds) ? &efds->sds : NULL,
1680                  (timeout.rel_value_us ==
1681                   GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us) ? NULL : &tv);
1682 }
1683
1684
1685 #else
1686 /* MINGW */
1687
1688
1689 /**
1690  * Non-blocking test if a pipe is ready for reading.
1691  *
1692  * @param fh pipe handle
1693  * @return #GNUNET_YES if the pipe is ready for reading
1694  */
1695 static int
1696 pipe_read_ready (struct GNUNET_DISK_FileHandle *fh)
1697 {
1698   DWORD error;
1699   BOOL bret;
1700   DWORD waitstatus = 0;
1701
1702   SetLastError (0);
1703   bret = PeekNamedPipe (fh->h, NULL, 0, NULL, &waitstatus, NULL);
1704   error = GetLastError ();
1705   if (0 == bret)
1706   {
1707     /* TODO: either add more errors to this condition, or eliminate it
1708      * entirely (failed to peek -> pipe is in serious trouble, should
1709      * be selected as readable).
1710      */
1711     if ( (error != ERROR_BROKEN_PIPE) &&
1712          (error != ERROR_INVALID_HANDLE) )
1713       return GNUNET_NO;
1714   }
1715   else if (waitstatus <= 0)
1716     return GNUNET_NO;
1717   return GNUNET_YES;
1718 }
1719
1720
1721 /**
1722  * Non-blocking test if a pipe is having an IO exception.
1723  *
1724  * @param fh pipe handle
1725  * @return #GNUNET_YES if the pipe is having an IO exception.
1726  */
1727 static int
1728 pipe_except_ready (struct GNUNET_DISK_FileHandle *fh)
1729 {
1730   DWORD dwBytes;
1731
1732   if (PeekNamedPipe (fh->h, NULL, 0, NULL, &dwBytes, NULL))
1733     return GNUNET_NO;
1734   return GNUNET_YES;
1735 }
1736
1737
1738 /**
1739  * Iterate over handles in fds, destructively rewrite the
1740  * handles array contents of fds so that it starts with the
1741  * handles that are ready, and update handles_pos accordingly.
1742  *
1743  * @param fds set of handles (usually pipes) to be checked for readiness
1744  * @param except GNUNET_NO if fds should be checked for readiness to read,
1745  * GNUNET_YES if fds should be checked for exceptions
1746  * (there is no way to check for write-readiness - pipes are always write-ready)
1747  * @param set_for_sure a HANDLE that is known to be set already,
1748  * because WaitForMultipleObjects() returned its index.
1749  * @return number of ready handles
1750  */
1751 static int
1752 check_handles_status (struct GNUNET_NETWORK_FDSet *fds,
1753                       int except,
1754                       HANDLE set_for_sure)
1755 {
1756   struct GNUNET_DISK_FileHandle *fh;
1757   unsigned int roff;
1758   unsigned int woff;
1759
1760   for (woff = 0, roff = 0; roff < fds->handles_pos; roff++)
1761   {
1762     fh = fds->handles[roff];
1763     if (fh == set_for_sure)
1764     {
1765       fds->handles[woff++] = fh;
1766     }
1767     else if (fh->type == GNUNET_DISK_HANLDE_TYPE_PIPE)
1768     {
1769       if ((except && pipe_except_ready (fh)) ||
1770           (!except && pipe_read_ready (fh)))
1771         fds->handles[woff++] = fh;
1772     }
1773     else if (fh->type == GNUNET_DISK_HANLDE_TYPE_FILE)
1774     {
1775       if (!except)
1776         fds->handles[woff++] = fh;
1777     }
1778     else
1779     {
1780       if (WAIT_OBJECT_0 == WaitForSingleObject (fh, 0))
1781         fds->handles[woff++] = fh;
1782     }
1783   }
1784   fds->handles_pos = woff;
1785   return woff;
1786 }
1787
1788
1789 /**
1790  * Check if sockets or pipes meet certain conditions, version for W32.
1791  *
1792  * @param rfds set of sockets or pipes to be checked for readability
1793  * @param wfds set of sockets or pipes to be checked for writability
1794  * @param efds set of sockets or pipes to be checked for exceptions
1795  * @param timeout relative value when to return
1796  * @return number of selected sockets or pipes, #GNUNET_SYSERR on error
1797  */
1798 int
1799 GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
1800                               struct GNUNET_NETWORK_FDSet *wfds,
1801                               struct GNUNET_NETWORK_FDSet *efds,
1802                               const struct GNUNET_TIME_Relative timeout)
1803 {
1804   struct GNUNET_DISK_FileHandle *fh;
1805   int nfds;
1806   int handles;
1807   unsigned int i;
1808   int retcode;
1809   uint64_t mcs_total;
1810   DWORD ms_rounded;
1811   int nhandles = 0;
1812   int read_pipes_off;
1813   HANDLE handle_array[FD_SETSIZE + 2];
1814   int returncode;
1815   int returnedpos = 0;
1816   int selectret;
1817   fd_set aread;
1818   fd_set awrite;
1819   fd_set aexcept;
1820
1821   nfds = 0;
1822   handles = 0;
1823   if (NULL != rfds)
1824   {
1825     nfds = GNUNET_MAX (nfds, rfds->nsds);
1826     handles += rfds->handles_pos;
1827   }
1828   if (NULL != wfds)
1829   {
1830     nfds = GNUNET_MAX (nfds, wfds->nsds);
1831     handles += wfds->handles_pos;
1832   }
1833   if (NULL != efds)
1834   {
1835     nfds = GNUNET_MAX (nfds, efds->nsds);
1836     handles += efds->handles_pos;
1837   }
1838
1839   if ((0 == nfds) &&
1840       (GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us == timeout.rel_value_us) &&
1841       (0 == handles) )
1842   {
1843     GNUNET_break (0);
1844     LOG (GNUNET_ERROR_TYPE_ERROR,
1845          _("Fatal internal logic error, process hangs in `%s' (abort with CTRL-C)!\n"),
1846          "select");
1847   }
1848 #define SAFE_FD_ISSET(fd, set)  (set != NULL && FD_ISSET(fd, set))
1849   /* calculate how long we need to wait in microseconds */
1850   if (timeout.rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
1851   {
1852     mcs_total = INFINITE;
1853     ms_rounded = INFINITE;
1854   }
1855   else
1856   {
1857     mcs_total = timeout.rel_value_us / GNUNET_TIME_UNIT_MICROSECONDS.rel_value_us;
1858     ms_rounded = (DWORD) (mcs_total / GNUNET_TIME_UNIT_MILLISECONDS.rel_value_us);
1859     if (mcs_total > 0 && ms_rounded == 0)
1860       ms_rounded = 1;
1861   }
1862   /* select() may be used as a portable way to sleep */
1863   if (! (rfds || wfds || efds))
1864   {
1865     Sleep (ms_rounded);
1866     return 0;
1867   }
1868
1869   if (NULL == select_thread)
1870     initialize_select_thread ();
1871
1872   FD_ZERO (&aread);
1873   FD_ZERO (&awrite);
1874   FD_ZERO (&aexcept);
1875   if (rfds)
1876     FD_COPY (&rfds->sds, &aread);
1877   if (wfds)
1878     FD_COPY (&wfds->sds, &awrite);
1879   if (efds)
1880     FD_COPY (&efds->sds, &aexcept);
1881
1882   /* Start by doing a fast check on sockets and pipes (without
1883      waiting). It is cheap, and is sufficient most of the time.  By
1884      profiling we detected that to be true in 90% of the cases.
1885   */
1886
1887   /* Do the select now */
1888   select_timeout.tv_sec = 0;
1889   select_timeout.tv_usec = 0;
1890
1891   /* Copy all the writes to the except, so we can detect connect() errors */
1892   for (i = 0; i < awrite.fd_count; i++)
1893     FD_SET (awrite.fd_array[i],
1894             &aexcept);
1895   if ( (aread.fd_count > 0) ||
1896        (awrite.fd_count > 0) ||
1897        (aexcept.fd_count > 0) )
1898     selectret = select (1,
1899                         (NULL != rfds) ? &aread : NULL,
1900                         (NULL != wfds) ? &awrite : NULL,
1901                         &aexcept,
1902                         &select_timeout);
1903   else
1904     selectret = 0;
1905   if (-1 == selectret)
1906   {
1907     /* Throw an error early on, while we still have the context. */
1908     LOG (GNUNET_ERROR_TYPE_ERROR,
1909          "W32 select(%d, %d, %d) failed: %lu\n",
1910          rfds ? aread.fd_count : 0,
1911          wfds ? awrite.fd_count : 0,
1912          aexcept.fd_count,
1913          GetLastError ());
1914     GNUNET_abort ();
1915   }
1916
1917   /* Check aexcept, if something is in there and we copied that
1918      FD before to detect connect() errors, add it back to the
1919      write set to report errors. */
1920   if (NULL != wfds)
1921     for (i = 0; i < aexcept.fd_count; i++)
1922       if (FD_ISSET (aexcept.fd_array[i],
1923                     &wfds->sds))
1924         FD_SET (aexcept.fd_array[i],
1925                 &awrite);
1926
1927
1928   /* If our select returned something or is a 0-timed request, then
1929      also check the pipes and get out of here! */
1930   /* Sadly, it means code duplication :( */
1931   if ( (selectret > 0) || (0 == mcs_total) )
1932   {
1933     retcode = 0;
1934
1935     /* Read Pipes */
1936     if (rfds && (rfds->handles_pos > 0))
1937       retcode += check_handles_status (rfds, GNUNET_NO, NULL);
1938
1939     /* wfds handles remain untouched, on W32
1940        we pretend our pipes are "always" write-ready */
1941
1942     /* except pipes */
1943     if (efds && (efds->handles_pos > 0))
1944       retcode += check_handles_status (efds, GNUNET_YES, NULL);
1945
1946     if (rfds)
1947     {
1948       GNUNET_NETWORK_fdset_zero (rfds);
1949       if (selectret != -1)
1950         GNUNET_NETWORK_fdset_copy_native (rfds, &aread, selectret);
1951     }
1952     if (wfds)
1953     {
1954       GNUNET_NETWORK_fdset_zero (wfds);
1955       if (selectret != -1)
1956         GNUNET_NETWORK_fdset_copy_native (wfds, &awrite, selectret);
1957     }
1958     if (efds)
1959     {
1960       GNUNET_NETWORK_fdset_zero (efds);
1961       if (selectret != -1)
1962         GNUNET_NETWORK_fdset_copy_native (efds, &aexcept, selectret);
1963     }
1964     if (-1 == selectret)
1965       return -1;
1966     /* Add our select() FDs to the total return value */
1967     retcode += selectret;
1968     return retcode;
1969   }
1970
1971   /* If we got this far, use slower implementation that is able to do a waiting select
1972      on both sockets and pipes simultaneously */
1973
1974   /* Events for pipes */
1975   if (! hEventReadReady)
1976     hEventReadReady = CreateEvent (NULL, TRUE, TRUE, NULL);
1977   if (! hEventPipeWrite)
1978     hEventPipeWrite = CreateEvent (NULL, TRUE, TRUE, NULL);
1979   retcode = 0;
1980
1981   FD_ZERO (&aread);
1982   FD_ZERO (&awrite);
1983   FD_ZERO (&aexcept);
1984   if (rfds)
1985     FD_COPY (&rfds->sds, &aread);
1986   if (wfds)
1987     FD_COPY (&wfds->sds, &awrite);
1988   if (efds)
1989     FD_COPY (&efds->sds, &aexcept);
1990   /* We will first Add the PIPES to the events */
1991   /* Track how far in `handle_array` the read pipes go,
1992      so we may by-pass them quickly if none of them
1993      are selected. */
1994   read_pipes_off = 0;
1995   if (rfds && (rfds->handles_pos > 0))
1996   {
1997     for (i = 0; i <rfds->handles_pos; i++)
1998     {
1999       fh = rfds->handles[i];
2000       if (fh->type == GNUNET_DISK_HANLDE_TYPE_EVENT)
2001       {
2002         handle_array[nhandles++] = fh->h;
2003         continue;
2004       }
2005       if (fh->type != GNUNET_DISK_HANLDE_TYPE_PIPE)
2006         continue;
2007       /* Read zero bytes to check the status of the pipe */
2008       if (! ReadFile (fh->h, NULL, 0, NULL, fh->oOverlapRead))
2009       {
2010         DWORD error_code = GetLastError ();
2011
2012         if (error_code == ERROR_IO_PENDING)
2013         {
2014           /* add as unready */
2015           handle_array[nhandles++] = fh->oOverlapRead->hEvent;
2016           read_pipes_off++;
2017         }
2018         else
2019         {
2020           /* add as ready */
2021           handle_array[nhandles++] = hEventReadReady;
2022           read_pipes_off++;
2023         }
2024       }
2025       else
2026       {
2027         /* error also counts as ready */
2028         handle_array[nhandles++] = hEventReadReady;
2029         read_pipes_off++;
2030       }
2031     }
2032   }
2033
2034   if (wfds && (wfds->handles_pos > 0))
2035   {
2036     LOG (GNUNET_ERROR_TYPE_DEBUG,
2037          "Adding the write ready event to the array as %d\n",
2038          nhandles);
2039     handle_array[nhandles++] = hEventPipeWrite;
2040   }
2041
2042   sp.status = 0;
2043   if (nfds > 0)
2044   {
2045     LOG (GNUNET_ERROR_TYPE_DEBUG,
2046          "Adding the socket event to the array as %d\n",
2047          nhandles);
2048     handle_array[nhandles++] = select_finished_event;
2049     if (timeout.rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us)
2050     {
2051       sp.tv = NULL;
2052     }
2053     else
2054     {
2055       select_timeout.tv_sec = timeout.rel_value_us / GNUNET_TIME_UNIT_SECONDS.rel_value_us;
2056       select_timeout.tv_usec = (timeout.rel_value_us -
2057                                 (select_timeout.tv_sec *
2058                                  GNUNET_TIME_UNIT_SECONDS.rel_value_us));
2059       sp.tv = &select_timeout;
2060     }
2061     FD_SET (select_wakeup_socket, &aread);
2062     do
2063     {
2064       i = recv (select_wakeup_socket,
2065                 (char *) &returnedpos,
2066                 1,
2067                 0);
2068     } while (i == 1);
2069     sp.r = &aread;
2070     sp.w = &awrite;
2071     sp.e = &aexcept;
2072     /* Failed connections cause sockets to be set in errorfds on W32,
2073      * but on POSIX it should set them in writefds.
2074      * First copy all awrite sockets to aexcept, later we'll
2075      * check aexcept and set its contents in awrite as well
2076      * Sockets are also set in errorfds when OOB data is available,
2077      * but we don't use OOB data.
2078      */
2079     for (i = 0; i < awrite.fd_count; i++)
2080       FD_SET (awrite.fd_array[i],
2081               &aexcept);
2082     ResetEvent (select_finished_event);
2083     SetEvent (select_standby_event);
2084   }
2085
2086   /* NULL-terminate array */
2087   handle_array[nhandles] = NULL;
2088   LOG (GNUNET_ERROR_TYPE_DEBUG,
2089        "nfds: %d, handles: %d, will wait: %llu mcs\n",
2090        nfds,
2091        nhandles,
2092        mcs_total);
2093   if (nhandles)
2094   {
2095     returncode
2096       = WaitForMultipleObjects (nhandles,
2097                                 handle_array,
2098                                 FALSE,
2099                                 ms_rounded);
2100     LOG (GNUNET_ERROR_TYPE_DEBUG,
2101          "WaitForMultipleObjects Returned: %d\n",
2102          returncode);
2103   }
2104   else if (nfds > 0)
2105   {
2106     GNUNET_break (0); /* This branch shouldn't actually be executed...*/
2107     i = (int) WaitForSingleObject (select_finished_event,
2108                                    INFINITE);
2109     returncode = WAIT_TIMEOUT;
2110   }
2111   else
2112   {
2113     /* Shouldn't come this far. If it does - investigate. */
2114     GNUNET_assert (0);
2115   }
2116
2117   if (nfds > 0)
2118   {
2119     /* Don't wake up select-thread when delay is 0, it should return immediately
2120      * and wake up by itself.
2121      */
2122     if (0 != mcs_total)
2123       i = send (select_send_socket,
2124                 (const char *) &returnedpos,
2125                 1,
2126                 0);
2127     i = (int) WaitForSingleObject (select_finished_event,
2128                                    INFINITE);
2129     LOG (GNUNET_ERROR_TYPE_DEBUG,
2130          "Finished waiting for the select thread: %d %d\n",
2131          i,
2132          sp.status);
2133     if (0 != mcs_total)
2134     {
2135       do
2136       {
2137         i = recv (select_wakeup_socket,
2138                   (char *) &returnedpos,
2139                   1, 0);
2140       } while (1 == i);
2141     }
2142     /* Check aexcept, add its contents to awrite */
2143     for (i = 0; i < aexcept.fd_count; i++)
2144       FD_SET (aexcept.fd_array[i], &awrite);
2145   }
2146
2147   returnedpos = returncode - WAIT_OBJECT_0;
2148   LOG (GNUNET_ERROR_TYPE_DEBUG,
2149        "return pos is: %d\n",
2150        returnedpos);
2151
2152   if (rfds)
2153   {
2154     /* We queued a zero-long read on each pipe to check
2155      * its state, now we must cancel these read operations.
2156      * This must be done while rfds->handles_pos is still
2157      * intact and matches the number of read handles that we
2158      * got from the caller.
2159      */
2160     for (i = 0; i < rfds->handles_pos; i++)
2161     {
2162       fh = rfds->handles[i];
2163       if (GNUNET_DISK_HANLDE_TYPE_PIPE == fh->type)
2164         CancelIo (fh->h);
2165     }
2166
2167     /* We may have some pipes ready for reading. */
2168     if (returnedpos < read_pipes_off)
2169       retcode += check_handles_status (rfds, GNUNET_NO, handle_array[returnedpos]);
2170     else
2171       rfds->handles_pos = 0;
2172
2173     if (-1 != sp.status)
2174       GNUNET_NETWORK_fdset_copy_native (rfds, &aread, retcode);
2175   }
2176   if (wfds)
2177   {
2178     retcode += wfds->handles_pos;
2179     /* wfds handles remain untouched */
2180     if (-1 != sp.status)
2181       GNUNET_NETWORK_fdset_copy_native (wfds, &awrite, retcode);
2182   }
2183   if (efds)
2184   {
2185     retcode += check_handles_status (rfds,
2186                                      GNUNET_YES,
2187                                      returnedpos < nhandles ? handle_array[returnedpos] : NULL);
2188     if (-1 != sp.status)
2189       GNUNET_NETWORK_fdset_copy_native (efds, &aexcept, retcode);
2190   }
2191
2192   if (sp.status > 0)
2193     retcode += sp.status;
2194
2195   return retcode;
2196 }
2197
2198 /* MINGW */
2199 #endif
2200
2201 /* end of network.c */