gcc/ada/socket.c

   1 /****************************************************************************
   2  *                                                                          *
   3  *                         GNAT COMPILER COMPONENTS                         *
   4  *                                                                          *
   5  *                               S O C K E T                                *
   6  *                                                                          *
   7  *                          C Implementation File                           *
   8  *                                                                          *
   9  *          Copyright (C) 2003-2007, Free Software Foundation, Inc.         *
  10  *                                                                          *
  11  * GNAT is free software;  you can  redistribute it  and/or modify it under *
  12  * terms of the  GNU General Public License as published  by the Free Soft- *
  13  * ware  Foundation;  either version 2,  or (at your option) any later ver- *
  14  * sion.  GNAT is distributed in the hope that it will be useful, but WITH- *
  15  * OUT ANY WARRANTY;  without even the  implied warranty of MERCHANTABILITY *
  16  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License *
  17  * for  more details.  You should have  received  a copy of the GNU General *
  18  * Public License  distributed with GNAT;  see file COPYING.  If not, write *
  19  * to  the  Free Software Foundation,  51  Franklin  Street,  Fifth  Floor, *
  20  * Boston, MA 02110-1301, USA.                                              *
  21  *                                                                          *
  22  * As a  special  exception,  if you  link  this file  with other  files to *
  23  * produce an executable,  this file does not by itself cause the resulting *
  24  * executable to be covered by the GNU General Public License. This except- *
  25  * ion does not  however invalidate  any other reasons  why the  executable *
  26  * file might be covered by the  GNU Public License.                        *
  27  *                                                                          *
  28  * GNAT was originally developed  by the GNAT team at  New York University. *
  29  * Extensive contributions were provided by Ada Core Technologies Inc.      *
  30  *                                                                          *
  31  ****************************************************************************/
  32
  33 /*  This file provides a portable binding to the sockets API                */
  34 #if defined (__nucleus__)
  35 /* ??? Need proper implementation */
  36 #warning Sockets not yet supported on Nucleus
  37 #else
  38 #include "gsocket.h"
  39 /* Include all the necessary system-specific headers and define the
  40    necessary macros (shared with gen-soccon). */
  41
  42 #if !defined(SO_NOSIGPIPE) && !defined (MSG_NOSIGNAL)
  43 #include <signal.h>
  44 #endif
  45 /* Required if we will be calling signal() in __gnat_disable_all_sigpipes() */
  46
  47 #include "raise.h"
  48 /* Required for __gnat_malloc() */
  49
  50 #include <string.h>
  51 /* Required for memcpy() */
  52
  53 extern void __gnat_disable_sigpipe (int fd);
  54 extern void __gnat_disable_all_sigpipes (void);
  55 extern int  __gnat_create_signalling_fds (int *fds);
  56 extern int  __gnat_read_signalling_fd (int rsig);
  57 extern int  __gnat_write_signalling_fd (int wsig);
  58 extern void  __gnat_close_signalling_fd (int sig);
  59 extern void __gnat_free_socket_set (fd_set *);
  60 extern void __gnat_last_socket_in_set (fd_set *, int *);
  61 extern void __gnat_get_socket_from_set (fd_set *, int *, int *);
  62 extern void __gnat_insert_socket_in_set (fd_set *, int);
  63 extern int __gnat_is_socket_in_set (fd_set *, int);
  64 extern fd_set *__gnat_new_socket_set (fd_set *);
  65 extern void __gnat_remove_socket_from_set (fd_set *, int);
  66 extern int  __gnat_get_h_errno (void);
  67 \f
  68 /* Disable the sending of SIGPIPE for writes on a broken stream */
  69
  70 void
  71 __gnat_disable_sigpipe (int fd)
  72 {
  73 #ifdef SO_NOSIGPIPE
  74   int val = 1;
  75   (void) setsockopt (fd, SOL_SOCKET, SO_NOSIGPIPE, &val, sizeof val);
  76 #endif
  77 }
  78
  79 void
  80 __gnat_disable_all_sigpipes (void)
  81 {
  82 #if !defined(SO_NOSIGPIPE) && !defined(MSG_NOSIGNAL) && defined(SIGPIPE)
  83   (void) signal (SIGPIPE, SIG_IGN);
  84 #endif
  85 }
  86 \f
  87 #if defined (_WIN32) || defined (__vxworks) || defined (VMS)
  88 /*
  89  * Signalling FDs operations are implemented in Ada for these platforms
  90  * (see subunit GNAT.Sockets.Thin.Signalling_Fds).
  91  */
  92 #else
  93 /*
  94  * Create a pair of connected file descriptors fds[0] and fds[1] used for
  95  * signalling by a Selector object. fds[0] is the read end, and fds[1] the
  96  * write end.
  97  */
  98 int
  99 __gnat_create_signalling_fds (int *fds) {
 100   return pipe (fds);
 101 }
 102 \f
 103 /*
 104  * Read one byte of data from rsig, the read end of a pair of signalling fds
 105  * created by __gnat_create_signalling_fds.
 106  */
 107 int
 108 __gnat_read_signalling_fd (int rsig) {
 109   char c;
 110   return read (rsig, &c, 1);
 111 }
 112 \f
 113 /*
 114  * Write one byte of data to wsig, the write end of a pair of signalling fds
 115  * created by __gnat_create_signalling_fds.
 116  */
 117 int
 118 __gnat_write_signalling_fd (int wsig) {
 119   char c = 0;
 120   return write (wsig, &c, 1);
 121 }
 122 \f
 123 /*
 124  * Close one end of a pair of signalling fds
 125  */
 126 void
 127 __gnat_close_signalling_fd (int sig) {
 128   (void) close (sig);
 129 }
 130 #endif
 131 \f
 132 /*
 133  * GetXXXbyYYY wrappers
 134  * These functions are used by the default implementation of g-socthi,
 135  * and also by the Windows version.
 136  *
 137  * They can be used for any platform that either provides an intrinsically
 138  * task safe implementation of getXXXbyYYY, or a reentrant variant
 139  * getXXXbyYYY_r. Otherwise, a task safe wrapper, including proper mutual
 140  * exclusion if appropriate, must be implemented in the target specific
 141  * version of g-socthi.
 142  */
 143
 144 #ifdef HAVE_THREAD_SAFE_GETxxxBYyyy
 145 int
 146 __gnat_safe_gethostbyname (const char *name,
 147   struct hostent *ret, char *buf, size_t buflen,
 148   int *h_errnop)
 149 {
 150   struct hostent *rh;
 151   rh = gethostbyname (name);
 152   if (rh == NULL) {
 153     *h_errnop = h_errno;
 154     return -1;
 155   }
 156   *ret = *rh;
 157   *h_errnop = 0;
 158   return 0;
 159 }
 160
 161 int
 162 __gnat_safe_gethostbyaddr (const char *addr, int len, int type,
 163   struct hostent *ret, char *buf, size_t buflen,
 164   int *h_errnop)
 165 {
 166   struct hostent *rh;
 167   rh = gethostbyaddr (addr, len, type);
 168   if (rh == NULL) {
 169     *h_errnop = h_errno;
 170     return -1;
 171   }
 172   *ret = *rh;
 173   *h_errnop = 0;
 174   return 0;
 175 }
 176
 177 int
 178 __gnat_safe_getservbyname (const char *name, const char *proto,
 179   struct servent *ret, char *buf, size_t buflen)
 180 {
 181   struct servent *rh;
 182   rh = getservbyname (name, proto);
 183   if (rh == NULL)
 184     return -1;
 185   *ret = *rh;
 186   return 0;
 187 }
 188
 189 int
 190 __gnat_safe_getservbyport (int port, const char *proto,
 191   struct servent *ret, char *buf, size_t buflen)
 192 {
 193   struct servent *rh;
 194   rh = getservbyport (port, proto);
 195   if (rh == NULL)
 196     return -1;
 197   *ret = *rh;
 198   return 0;
 199 }
 200 #elif HAVE_GETxxxBYyyy_R
 201 int
 202 __gnat_safe_gethostbyname (const char *name,
 203   struct hostent *ret, char *buf, size_t buflen,
 204   int *h_errnop)
 205 {
 206   struct hostent *rh;
 207   int ri;
 208
 209 #ifdef __linux__
 210   (void) gethostbyname_r (name, ret, buf, buflen, &rh, h_errnop);
 211 #else
 212   rh = gethostbyname_r (name, ret, buf, buflen, h_errnop);
 213 #endif
 214   ri = (rh == NULL) ? -1 : 0;
 215   return ri;
 216 }
 217
 218 int
 219 __gnat_safe_gethostbyaddr (const char *addr, int len, int type,
 220   struct hostent *ret, char *buf, size_t buflen,
 221   int *h_errnop)
 222 {
 223   struct hostent *rh;
 224   int ri;
 225
 226 #ifdef __linux__
 227   (void) gethostbyaddr_r (addr, len, type, ret, buf, buflen, &rh, h_errnop);
 228 #else
 229   rh = gethostbyaddr_r (addr, len, type, ret, buf, buflen, h_errnop);
 230 #endif
 231   ri = (rh == NULL) ? -1 : 0;
 232   return ri;
 233 }
 234
 235 int
 236 __gnat_safe_getservbyname (const char *name, const char *proto,
 237   struct servent *ret, char *buf, size_t buflen)
 238 {
 239   struct servent *rh;
 240   int ri;
 241
 242 #ifdef __linux__
 243   (void) getservbyname_r (name, proto, ret, buf, buflen, &rh);
 244 #else
 245   rh = getservbyname_r (name, proto, ret, buf, buflen);
 246 #endif
 247   ri = (rh == NULL) ? -1 : 0;
 248   return ri;
 249 }
 250
 251 int
 252 __gnat_safe_getservbyport (int port, const char *proto,
 253   struct servent *ret, char *buf, size_t buflen)
 254 {
 255   struct servent *rh;
 256   int ri;
 257
 258 #ifdef __linux__
 259   (void) getservbyport_r (port, proto, ret, buf, buflen, &rh);
 260 #else
 261   rh = getservbyport_r (port, proto, ret, buf, buflen);
 262 #endif
 263   ri = (rh == NULL) ? -1 : 0;
 264   return ri;
 265 }
 266 #endif
 267 \f
 268 /* Free socket set. */
 269
 270 void
 271 __gnat_free_socket_set (fd_set *set)
 272 {
 273   __gnat_free (set);
 274 }
 275
 276 /* Find the largest socket in the socket set SET. This is needed for
 277    `select'.  LAST is the maximum value for the largest socket. This hint is
 278    used to avoid scanning very large socket sets.  On return, LAST is the
 279    actual largest socket in the socket set. */
 280
 281 void
 282 __gnat_last_socket_in_set (fd_set *set, int *last)
 283 {
 284   int s;
 285   int l;
 286   l = -1;
 287
 288 #ifdef _WIN32
 289   /* More efficient method for NT. */
 290   for (s = 0; s < set->fd_count; s++)
 291     if ((int) set->fd_array[s] > l)
 292       l = set->fd_array[s];
 293
 294 #else
 295
 296   for (s = *last; s != -1; s--)
 297     if (FD_ISSET (s, set))
 298       {
 299         l = s;
 300         break;
 301       }
 302 #endif
 303
 304   *last = l;
 305 }
 306
 307 /* Get last socket and remove it from the socket set SET.  LAST is the
 308    maximum value of the largest socket.  This hint is used to avoid scanning
 309    very large socket sets.  On return, LAST is set to the actual largest
 310    socket in the socket set. */
 311
 312 void
 313 __gnat_get_socket_from_set (fd_set *set, int *last, int *socket)
 314 {
 315   *socket = *last;
 316   FD_CLR (*socket, set);
 317   __gnat_last_socket_in_set (set, last);
 318 }
 319
 320 /* Insert SOCKET in the socket set SET. */
 321
 322 void
 323 __gnat_insert_socket_in_set (fd_set *set, int socket)
 324 {
 325   FD_SET (socket, set);
 326 }
 327
 328 /* Check whether a given SOCKET is in the socket set SET. */
 329
 330 int
 331 __gnat_is_socket_in_set (fd_set *set, int socket)
 332 {
 333   return FD_ISSET (socket, set);
 334 }
 335
 336 /* Allocate a new socket set and set it as empty.  */
 337
 338 fd_set *
 339 __gnat_new_socket_set (fd_set *set)
 340 {
 341   fd_set *new;
 342
 343   new = (fd_set *) __gnat_malloc (sizeof (fd_set));
 344
 345   if (set)
 346     memcpy (new, set, sizeof (fd_set));
 347   else
 348     FD_ZERO (new);
 349
 350   return new;
 351 }
 352
 353 /* Remove SOCKET from the socket set SET. */
 354
 355 void
 356 __gnat_remove_socket_from_set (fd_set *set, int socket)
 357 {
 358   FD_CLR (socket, set);
 359 }
 360
 361 /* Get the value of the last host error */
 362
 363 int
 364 __gnat_get_h_errno (void) {
 365 #ifdef __vxworks
 366   int vxw_errno = errno;
 367
 368   switch (vxw_errno) {
 369     case 0:
 370       return 0;
 371
 372     case S_resolvLib_HOST_NOT_FOUND:
 373     case S_hostLib_UNKNOWN_HOST:
 374       return HOST_NOT_FOUND;
 375
 376     case S_resolvLib_TRY_AGAIN:
 377       return TRY_AGAIN;
 378
 379     case S_resolvLib_NO_RECOVERY:
 380     case S_resolvLib_BUFFER_2_SMALL:
 381     case S_resolvLib_INVALID_PARAMETER:
 382     case S_resolvLib_INVALID_ADDRESS:
 383     case S_hostLib_INVALID_PARAMETER:
 384       return NO_RECOVERY;
 385
 386     case S_resolvLib_NO_DATA:
 387       return NO_DATA;
 388
 389     default:
 390       return -1;
 391   }
 392
 393 #elif defined (VMS)
 394   /* h_errno is defined as follows in OpenVMS' version of <netdb.h>.
 395    * However this header file is not available when building the GNAT
 396    * runtime library using GCC, so we are hardcoding the definition
 397    * directly. Note that the returned address is thread-specific.
 398    */
 399   extern int *decc$h_errno_get_addr ();
 400   return *decc$h_errno_get_addr ();
 401
 402 #elif defined (__rtems__)
 403   /* At this stage in the tool build, no networking .h files are available.
 404    * Newlib does not provide networking .h files and RTEMS is not built yet.
 405    * So we need to explicitly extern h_errno to access it.
 406    */
 407   extern int h_errno;
 408   return h_errno;
 409
 410 #else
 411   return h_errno;
 412 #endif
 413 }
 414 #endif /* __nucleus__ */