sjero.net Git - wget/blob - src/connect.c

   1 /* Establishing and handling network connections.
   2    Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
   3    2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
   4
   5 This file is part of GNU Wget.
   6
   7 GNU Wget is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 3 of the License, or
  10  (at your option) any later version.
  11
  12 GNU Wget is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Wget.  If not, see <http://www.gnu.org/licenses/>.
  19
  20 Additional permission under GNU GPL version 3 section 7
  21
  22 If you modify this program, or any covered work, by linking or
  23 combining it with the OpenSSL project's OpenSSL library (or a
  24 modified version of that library), containing parts covered by the
  25 terms of the OpenSSL or SSLeay licenses, the Free Software Foundation
  26 grants you additional permission to convey the resulting work.
  27 Corresponding Source for a non-source form of such a combination
  28 shall include the source code for the parts of OpenSSL used as well
  29 as that of the covered work.  */
  30
  31 #include "wget.h"
  32
  33 #include <stdio.h>
  34 #include <stdlib.h>
  35 #ifdef HAVE_UNISTD_H
  36 # include <unistd.h>
  37 #endif
  38 #include <assert.h>
  39
  40 #include <sys/socket.h>
  41 #include <sys/select.h>
  42
  43 #ifndef WINDOWS
  44 # ifdef __VMS
  45 #  include "vms_ip.h"
  46 # else /* def __VMS */
  47 #  include <netdb.h>
  48 # endif /* def __VMS [else] */
  49 # include <netinet/in.h>
  50 # ifndef __BEOS__
  51 #  include <arpa/inet.h>
  52 # endif
  53 #endif /* not WINDOWS */
  54
  55 #include <errno.h>
  56 #include <string.h>
  57 #ifdef HAVE_SYS_TIME_H
  58 # include <sys/time.h>
  59 #endif
  60 #include "utils.h"
  61 #include "host.h"
  62 #include "connect.h"
  63 #include "hash.h"
  64
  65 /* Apparently needed for Interix: */
  66 #ifdef HAVE_STDINT_H
  67 # include <stdint.h>
  68 #endif
  69
  70 /* Define sockaddr_storage where unavailable (presumably on IPv4-only
  71    hosts).  */
  72
  73 #ifndef ENABLE_IPV6
  74 # ifndef HAVE_STRUCT_SOCKADDR_STORAGE
  75 #  define sockaddr_storage sockaddr_in
  76 # endif
  77 #endif /* ENABLE_IPV6 */
  78
  79 /* Fill SA as per the data in IP and PORT.  SA shoult point to struct
  80    sockaddr_storage if ENABLE_IPV6 is defined, to struct sockaddr_in
  81    otherwise.  */
  82
  83 static void
  84 sockaddr_set_data (struct sockaddr *sa, const ip_address *ip, int port)
  85 {
  86   switch (ip->family)
  87     {
  88     case AF_INET:
  89       {
  90         struct sockaddr_in *sin = (struct sockaddr_in *)sa;
  91         xzero (*sin);
  92         sin->sin_family = AF_INET;
  93         sin->sin_port = htons (port);
  94         sin->sin_addr = ip->data.d4;
  95         break;
  96       }
  97 #ifdef ENABLE_IPV6
  98     case AF_INET6:
  99       {
 100         struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sa;
 101         xzero (*sin6);
 102         sin6->sin6_family = AF_INET6;
 103         sin6->sin6_port = htons (port);
 104         sin6->sin6_addr = ip->data.d6;
 105 #ifdef HAVE_SOCKADDR_IN6_SCOPE_ID
 106         sin6->sin6_scope_id = ip->ipv6_scope;
 107 #endif
 108         break;
 109       }
 110 #endif /* ENABLE_IPV6 */
 111     default:
 112       abort ();
 113     }
 114 }
 115
 116 /* Get the data of SA, specifically the IP address and the port.  If
 117    you're not interested in one or the other information, pass NULL as
 118    the pointer.  */
 119
 120 static void
 121 sockaddr_get_data (const struct sockaddr *sa, ip_address *ip, int *port)
 122 {
 123   switch (sa->sa_family)
 124     {
 125     case AF_INET:
 126       {
 127         struct sockaddr_in *sin = (struct sockaddr_in *)sa;
 128         if (ip)
 129           {
 130             ip->family = AF_INET;
 131             ip->data.d4 = sin->sin_addr;
 132           }
 133         if (port)
 134           *port = ntohs (sin->sin_port);
 135         break;
 136       }
 137 #ifdef ENABLE_IPV6
 138     case AF_INET6:
 139       {
 140         struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sa;
 141         if (ip)
 142           {
 143             ip->family = AF_INET6;
 144             ip->data.d6 = sin6->sin6_addr;
 145 #ifdef HAVE_SOCKADDR_IN6_SCOPE_ID
 146             ip->ipv6_scope = sin6->sin6_scope_id;
 147 #endif
 148           }
 149         if (port)
 150           *port = ntohs (sin6->sin6_port);
 151         break;
 152       }
 153 #endif
 154     default:
 155       abort ();
 156     }
 157 }
 158
 159 /* Return the size of the sockaddr structure depending on its
 160    family.  */
 161
 162 static socklen_t
 163 sockaddr_size (const struct sockaddr *sa)
 164 {
 165   switch (sa->sa_family)
 166     {
 167     case AF_INET:
 168       return sizeof (struct sockaddr_in);
 169 #ifdef ENABLE_IPV6
 170     case AF_INET6:
 171       return sizeof (struct sockaddr_in6);
 172 #endif
 173     default:
 174       abort ();
 175     }
 176 }
 177 \f
 178 /* Resolve the bind address specified via --bind-address and store it
 179    to SA.  The resolved value is stored in a static variable and
 180    reused after the first invocation of this function.
 181
 182    Returns true on success, false on failure.  */
 183
 184 static bool
 185 resolve_bind_address (struct sockaddr *sa)
 186 {
 187   struct address_list *al;
 188
 189   /* Make sure this is called only once.  opt.bind_address doesn't
 190      change during a Wget run.  */
 191   static bool called, should_bind;
 192   static ip_address ip;
 193   if (called)
 194     {
 195       if (should_bind)
 196         sockaddr_set_data (sa, &ip, 0);
 197       return should_bind;
 198     }
 199   called = true;
 200
 201   al = lookup_host (opt.bind_address, LH_BIND | LH_SILENT);
 202   if (!al)
 203     {
 204       /* #### We should be able to print the error message here. */
 205       logprintf (LOG_NOTQUIET,
 206                  _("%s: unable to resolve bind address %s; disabling bind.\n"),
 207                  exec_name, quote (opt.bind_address));
 208       should_bind = false;
 209       return false;
 210     }
 211
 212   /* Pick the first address in the list and use it as bind address.
 213      Perhaps we should try multiple addresses in succession, but I
 214      don't think that's necessary in practice.  */
 215   ip = *address_list_address_at (al, 0);
 216   address_list_release (al);
 217
 218   sockaddr_set_data (sa, &ip, 0);
 219   should_bind = true;
 220   return true;
 221 }
 222 \f
 223 struct cwt_context {
 224   int fd;
 225   const struct sockaddr *addr;
 226   socklen_t addrlen;
 227   int result;
 228 };
 229
 230 static void
 231 connect_with_timeout_callback (void *arg)
 232 {
 233   struct cwt_context *ctx = (struct cwt_context *)arg;
 234   ctx->result = connect (ctx->fd, ctx->addr, ctx->addrlen);
 235 }
 236
 237 /* Like connect, but specifies a timeout.  If connecting takes longer
 238    than TIMEOUT seconds, -1 is returned and errno is set to
 239    ETIMEDOUT.  */
 240
 241 static int
 242 connect_with_timeout (int fd, const struct sockaddr *addr, socklen_t addrlen,
 243                       double timeout)
 244 {
 245   struct cwt_context ctx;
 246   ctx.fd = fd;
 247   ctx.addr = addr;
 248   ctx.addrlen = addrlen;
 249
 250   if (run_with_timeout (timeout, connect_with_timeout_callback, &ctx))
 251     {
 252       errno = ETIMEDOUT;
 253       return -1;
 254     }
 255   if (ctx.result == -1 && errno == EINTR)
 256     errno = ETIMEDOUT;
 257   return ctx.result;
 258 }
 259 \f
 260 /* Connect via TCP to the specified address and port.
 261
 262    If PRINT is non-NULL, it is the host name to print that we're
 263    connecting to.  */
 264
 265 int
 266 connect_to_ip (const ip_address *ip, int port, const char *print)
 267 {
 268   struct sockaddr_storage ss;
 269   struct sockaddr *sa = (struct sockaddr *)&ss;
 270   int sock;
 271
 272   /* If PRINT is non-NULL, print the "Connecting to..." line, with
 273      PRINT being the host name we're connecting to.  */
 274   if (print)
 275     {
 276       const char *txt_addr = print_address (ip);
 277       if (0 != strcmp (print, txt_addr))
 278         {
 279                                   char *str = NULL, *name;
 280
 281           if (opt.enable_iri && (name = idn_decode ((char *) print)) != NULL)
 282             {
 283               int len = strlen (print) + strlen (name) + 4;
 284               str = xmalloc (len);
 285               snprintf (str, len, "%s (%s)", name, print);
 286               str[len-1] = '\0';
 287               xfree (name);
 288             }
 289
 290           logprintf (LOG_VERBOSE, _("Connecting to %s|%s|:%d... "),
 291                      str ? str : escnonprint_uri (print), txt_addr, port);
 292
 293                                         if (str)
 294                                           xfree (str);
 295         }
 296       else
 297         logprintf (LOG_VERBOSE, _("Connecting to %s:%d... "), txt_addr, port);
 298     }
 299
 300   /* Store the sockaddr info to SA.  */
 301   sockaddr_set_data (sa, ip, port);
 302
 303   /* Create the socket of the family appropriate for the address.  */
 304   sock = socket (sa->sa_family, SOCK_STREAM, 0);
 305   if (sock < 0)
 306     goto err;
 307
 308 #if defined(ENABLE_IPV6) && defined(IPV6_V6ONLY)
 309   if (opt.ipv6_only) {
 310     int on = 1;
 311     /* In case of error, we will go on anyway... */
 312     int err = setsockopt (sock, IPPROTO_IPV6, IPV6_V6ONLY, &on, sizeof (on));
 313     IF_DEBUG
 314       if (err < 0)
 315         DEBUGP (("Failed setting IPV6_V6ONLY: %s", strerror (errno)));
 316   }
 317 #endif
 318
 319   /* For very small rate limits, set the buffer size (and hence,
 320      hopefully, the kernel's TCP window size) to the per-second limit.
 321      That way we should never have to sleep for more than 1s between
 322      network reads.  */
 323   if (opt.limit_rate && opt.limit_rate < 8192)
 324     {
 325       int bufsize = opt.limit_rate;
 326       if (bufsize < 512)
 327         bufsize = 512;          /* avoid pathologically small values */
 328 #ifdef SO_RCVBUF
 329       setsockopt (sock, SOL_SOCKET, SO_RCVBUF,
 330                   (void *)&bufsize, (socklen_t)sizeof (bufsize));
 331 #endif
 332       /* When we add limit_rate support for writing, which is useful
 333          for POST, we should also set SO_SNDBUF here.  */
 334     }
 335
 336   if (opt.bind_address)
 337     {
 338       /* Bind the client side of the socket to the requested
 339          address.  */
 340       struct sockaddr_storage bind_ss;
 341       struct sockaddr *bind_sa = (struct sockaddr *)&bind_ss;
 342       if (resolve_bind_address (bind_sa))
 343         {
 344           if (bind (sock, bind_sa, sockaddr_size (bind_sa)) < 0)
 345             goto err;
 346         }
 347     }
 348
 349   /* Connect the socket to the remote endpoint.  */
 350   if (connect_with_timeout (sock, sa, sockaddr_size (sa),
 351                             opt.connect_timeout) < 0)
 352     goto err;
 353
 354   /* Success. */
 355   assert (sock >= 0);
 356   if (print)
 357     logprintf (LOG_VERBOSE, _("connected.\n"));
 358   DEBUGP (("Created socket %d.\n", sock));
 359   return sock;
 360
 361  err:
 362   {
 363     /* Protect errno from possible modifications by close and
 364        logprintf.  */
 365     int save_errno = errno;
 366     if (sock >= 0)
 367       fd_close (sock);
 368     if (print)
 369       logprintf (LOG_VERBOSE, _("failed: %s.\n"), strerror (errno));
 370     errno = save_errno;
 371     return -1;
 372   }
 373 }
 374
 375 /* Connect via TCP to a remote host on the specified port.
 376
 377    HOST is resolved as an Internet host name.  If HOST resolves to
 378    more than one IP address, they are tried in the order returned by
 379    DNS until connecting to one of them succeeds.  */
 380
 381 int
 382 connect_to_host (const char *host, int port)
 383 {
 384   int i, start, end;
 385   int sock;
 386
 387   struct address_list *al = lookup_host (host, 0);
 388
 389  retry:
 390   if (!al)
 391     {
 392       logprintf (LOG_NOTQUIET,
 393                  _("%s: unable to resolve host address %s\n"),
 394                  exec_name, quote (host));
 395       return E_HOST;
 396     }
 397
 398   address_list_get_bounds (al, &start, &end);
 399   for (i = start; i < end; i++)
 400     {
 401       const ip_address *ip = address_list_address_at (al, i);
 402       sock = connect_to_ip (ip, port, host);
 403       if (sock >= 0)
 404         {
 405           /* Success. */
 406           address_list_set_connected (al);
 407           address_list_release (al);
 408           return sock;
 409         }
 410
 411       /* The attempt to connect has failed.  Continue with the loop
 412          and try next address. */
 413
 414       address_list_set_faulty (al, i);
 415     }
 416
 417   /* Failed to connect to any of the addresses in AL. */
 418
 419   if (address_list_connected_p (al))
 420     {
 421       /* We connected to AL before, but cannot do so now.  That might
 422          indicate that our DNS cache entry for HOST has expired.  */
 423       address_list_release (al);
 424       al = lookup_host (host, LH_REFRESH);
 425       goto retry;
 426     }
 427   address_list_release (al);
 428
 429   return -1;
 430 }
 431 \f
 432 /* Create a socket, bind it to local interface BIND_ADDRESS on port
 433    *PORT, set up a listen backlog, and return the resulting socket, or
 434    -1 in case of error.
 435
 436    BIND_ADDRESS is the address of the interface to bind to.  If it is
 437    NULL, the socket is bound to the default address.  PORT should
 438    point to the port number that will be used for the binding.  If
 439    that number is 0, the system will choose a suitable port, and the
 440    chosen value will be written to *PORT.
 441
 442    Calling accept() on such a socket waits for and accepts incoming
 443    TCP connections.  */
 444
 445 int
 446 bind_local (const ip_address *bind_address, int *port)
 447 {
 448   int sock;
 449   struct sockaddr_storage ss;
 450   struct sockaddr *sa = (struct sockaddr *)&ss;
 451
 452   /* For setting options with setsockopt. */
 453   int setopt_val = 1;
 454   void *setopt_ptr = (void *)&setopt_val;
 455   socklen_t setopt_size = sizeof (setopt_val);
 456
 457   sock = socket (bind_address->family, SOCK_STREAM, 0);
 458   if (sock < 0)
 459     return -1;
 460
 461 #ifdef SO_REUSEADDR
 462   setsockopt (sock, SOL_SOCKET, SO_REUSEADDR, setopt_ptr, setopt_size);
 463 #endif
 464
 465   xzero (ss);
 466   sockaddr_set_data (sa, bind_address, *port);
 467   if (bind (sock, sa, sockaddr_size (sa)) < 0)
 468     {
 469       fd_close (sock);
 470       return -1;
 471     }
 472   DEBUGP (("Local socket fd %d bound.\n", sock));
 473
 474   /* If *PORT is 0, find out which port we've bound to.  */
 475   if (*port == 0)
 476     {
 477       socklen_t addrlen = sockaddr_size (sa);
 478       if (getsockname (sock, sa, &addrlen) < 0)
 479         {
 480           /* If we can't find out the socket's local address ("name"),
 481              something is seriously wrong with the socket, and it's
 482              unusable for us anyway because we must know the chosen
 483              port.  */
 484           fd_close (sock);
 485           return -1;
 486         }
 487       sockaddr_get_data (sa, NULL, port);
 488       DEBUGP (("binding to address %s using port %i.\n",
 489                print_address (bind_address), *port));
 490     }
 491   if (listen (sock, 1) < 0)
 492     {
 493       fd_close (sock);
 494       return -1;
 495     }
 496   return sock;
 497 }
 498
 499 /* Like a call to accept(), but with the added check for timeout.
 500
 501    In other words, accept a client connection on LOCAL_SOCK, and
 502    return the new socket used for communication with the client.
 503    LOCAL_SOCK should have been bound, e.g. using bind_local().
 504
 505    The caller is blocked until a connection is established.  If no
 506    connection is established for opt.connect_timeout seconds, the
 507    function exits with an error status.  */
 508
 509 int
 510 accept_connection (int local_sock)
 511 {
 512   int sock;
 513
 514   /* We don't need the values provided by accept, but accept
 515      apparently requires them to be present.  */
 516   struct sockaddr_storage ss;
 517   struct sockaddr *sa = (struct sockaddr *)&ss;
 518   socklen_t addrlen = sizeof (ss);
 519
 520   if (opt.connect_timeout)
 521     {
 522       int test = select_fd (local_sock, opt.connect_timeout, WAIT_FOR_READ);
 523       if (test == 0)
 524         errno = ETIMEDOUT;
 525       if (test <= 0)
 526         return -1;
 527     }
 528   sock = accept (local_sock, sa, &addrlen);
 529   DEBUGP (("Accepted client at socket %d.\n", sock));
 530   return sock;
 531 }
 532
 533 /* Get the IP address associated with the connection on FD and store
 534    it to IP.  Return true on success, false otherwise.
 535
 536    If ENDPOINT is ENDPOINT_LOCAL, it returns the address of the local
 537    (client) side of the socket.  Else if ENDPOINT is ENDPOINT_PEER, it
 538    returns the address of the remote (peer's) side of the socket.  */
 539
 540 bool
 541 socket_ip_address (int sock, ip_address *ip, int endpoint)
 542 {
 543   struct sockaddr_storage storage;
 544   struct sockaddr *sockaddr = (struct sockaddr *) &storage;
 545   socklen_t addrlen = sizeof (storage);
 546   int ret;
 547
 548   memset (sockaddr, 0, addrlen);
 549   if (endpoint == ENDPOINT_LOCAL)
 550     ret = getsockname (sock, sockaddr, &addrlen);
 551   else if (endpoint == ENDPOINT_PEER)
 552     ret = getpeername (sock, sockaddr, &addrlen);
 553   else
 554     abort ();
 555   if (ret < 0)
 556     return false;
 557
 558   ip->family = sockaddr->sa_family;
 559   switch (sockaddr->sa_family)
 560     {
 561 #ifdef ENABLE_IPV6
 562     case AF_INET6:
 563       {
 564         struct sockaddr_in6 *sa6 = (struct sockaddr_in6 *)&storage;
 565         ip->data.d6 = sa6->sin6_addr;
 566 #ifdef HAVE_SOCKADDR_IN6_SCOPE_ID
 567         ip->ipv6_scope = sa6->sin6_scope_id;
 568 #endif
 569         DEBUGP (("conaddr is: %s\n", print_address (ip)));
 570         return true;
 571       }
 572 #endif
 573     case AF_INET:
 574       {
 575         struct sockaddr_in *sa = (struct sockaddr_in *)&storage;
 576         ip->data.d4 = sa->sin_addr;
 577         DEBUGP (("conaddr is: %s\n", print_address (ip)));
 578         return true;
 579       }
 580     default:
 581       abort ();
 582     }
 583 }
 584
 585 /* Return true if the error from the connect code can be considered
 586    retryable.  Wget normally retries after errors, but the exception
 587    are the "unsupported protocol" type errors (possible on IPv4/IPv6
 588    dual family systems) and "connection refused".  */
 589
 590 bool
 591 retryable_socket_connect_error (int err)
 592 {
 593   /* Have to guard against some of these values not being defined.
 594      Cannot use a switch statement because some of the values might be
 595      equal.  */
 596   if (false
 597 #ifdef EAFNOSUPPORT
 598       || err == EAFNOSUPPORT
 599 #endif
 600 #ifdef EPFNOSUPPORT
 601       || err == EPFNOSUPPORT
 602 #endif
 603 #ifdef ESOCKTNOSUPPORT          /* no, "sockt" is not a typo! */
 604       || err == ESOCKTNOSUPPORT
 605 #endif
 606 #ifdef EPROTONOSUPPORT
 607       || err == EPROTONOSUPPORT
 608 #endif
 609 #ifdef ENOPROTOOPT
 610       || err == ENOPROTOOPT
 611 #endif
 612       /* Apparently, older versions of Linux and BSD used EINVAL
 613          instead of EAFNOSUPPORT and such.  */
 614       || err == EINVAL
 615       )
 616     return false;
 617
 618   if (!opt.retry_connrefused)
 619     if (err == ECONNREFUSED
 620 #ifdef ENETUNREACH
 621         || err == ENETUNREACH   /* network is unreachable */
 622 #endif
 623 #ifdef EHOSTUNREACH
 624         || err == EHOSTUNREACH  /* host is unreachable */
 625 #endif
 626         )
 627       return false;
 628
 629   return true;
 630 }
 631
 632 /* Wait for a single descriptor to become available, timing out after
 633    MAXTIME seconds.  Returns 1 if FD is available, 0 for timeout and
 634    -1 for error.  The argument WAIT_FOR can be a combination of
 635    WAIT_FOR_READ and WAIT_FOR_WRITE.
 636
 637    This is a mere convenience wrapper around the select call, and
 638    should be taken as such (for example, it doesn't implement Wget's
 639    0-timeout-means-no-timeout semantics.)  */
 640
 641 int
 642 select_fd (int fd, double maxtime, int wait_for)
 643 {
 644   fd_set fdset;
 645   fd_set *rd = NULL, *wr = NULL;
 646   struct timeval tmout;
 647   int result;
 648
 649   FD_ZERO (&fdset);
 650   FD_SET (fd, &fdset);
 651   if (wait_for & WAIT_FOR_READ)
 652     rd = &fdset;
 653   if (wait_for & WAIT_FOR_WRITE)
 654     wr = &fdset;
 655
 656   tmout.tv_sec = (long) maxtime;
 657   tmout.tv_usec = 1000000 * (maxtime - (long) maxtime);
 658
 659   do
 660     result = select (fd + 1, rd, wr, NULL, &tmout);
 661   while (result < 0 && errno == EINTR);
 662
 663   return result;
 664 }
 665
 666 /* Return true iff the connection to the remote site established
 667    through SOCK is still open.
 668
 669    Specifically, this function returns true if SOCK is not ready for
 670    reading.  This is because, when the connection closes, the socket
 671    is ready for reading because EOF is about to be delivered.  A side
 672    effect of this method is that sockets that have pending data are
 673    considered non-open.  This is actually a good thing for callers of
 674    this function, where such pending data can only be unwanted
 675    leftover from a previous request.  */
 676
 677 bool
 678 test_socket_open (int sock)
 679 {
 680   fd_set check_set;
 681   struct timeval to;
 682
 683   /* Check if we still have a valid (non-EOF) connection.  From Andrew
 684    * Maholski's code in the Unix Socket FAQ.  */
 685
 686   FD_ZERO (&check_set);
 687   FD_SET (sock, &check_set);
 688
 689   /* Wait one microsecond */
 690   to.tv_sec = 0;
 691   to.tv_usec = 1;
 692
 693   if (select (sock + 1, &check_set, NULL, NULL, &to) == 0)
 694     /* We got a timeout, it means we're still connected. */
 695     return true;
 696   else
 697     /* Read now would not wait, it means we have either pending data
 698        or EOF/error. */
 699     return false;
 700 }
 701 \f
 702 /* Basic socket operations, mostly EINTR wrappers.  */
 703
 704 static int
 705 sock_read (int fd, char *buf, int bufsize)
 706 {
 707   int res;
 708   do
 709     res = read (fd, buf, bufsize);
 710   while (res == -1 && errno == EINTR);
 711   return res;
 712 }
 713
 714 static int
 715 sock_write (int fd, char *buf, int bufsize)
 716 {
 717   int res;
 718   do
 719     res = write (fd, buf, bufsize);
 720   while (res == -1 && errno == EINTR);
 721   return res;
 722 }
 723
 724 static int
 725 sock_poll (int fd, double timeout, int wait_for)
 726 {
 727   return select_fd (fd, timeout, wait_for);
 728 }
 729
 730 static int
 731 sock_peek (int fd, char *buf, int bufsize)
 732 {
 733   int res;
 734   do
 735     res = recv (fd, buf, bufsize, MSG_PEEK);
 736   while (res == -1 && errno == EINTR);
 737   return res;
 738 }
 739
 740 static void
 741 sock_close (int fd)
 742 {
 743   close (fd);
 744   DEBUGP (("Closed fd %d\n", fd));
 745 }
 746 #undef read
 747 #undef write
 748 #undef close
 749 \f
 750 /* Reading and writing from the network.  We build around the socket
 751    (file descriptor) API, but support "extended" operations for things
 752    that are not mere file descriptors under the hood, such as SSL
 753    sockets.
 754
 755    That way the user code can call fd_read(fd, ...) and we'll run read
 756    or SSL_read or whatever is necessary.  */
 757
 758 static struct hash_table *transport_map;
 759 static unsigned int transport_map_modified_tick;
 760
 761 struct transport_info {
 762   struct transport_implementation *imp;
 763   void *ctx;
 764 };
 765
 766 /* Register the transport layer operations that will be used when
 767    reading, writing, and polling FD.
 768
 769    This should be used for transport layers like SSL that piggyback on
 770    sockets.  FD should otherwise be a real socket, on which you can
 771    call getpeername, etc.  */
 772
 773 void
 774 fd_register_transport (int fd, struct transport_implementation *imp, void *ctx)
 775 {
 776   struct transport_info *info;
 777
 778   /* The file descriptor must be non-negative to be registered.
 779      Negative values are ignored by fd_close(), and -1 cannot be used as
 780      hash key.  */
 781   assert (fd >= 0);
 782
 783   info = xnew (struct transport_info);
 784   info->imp = imp;
 785   info->ctx = ctx;
 786   if (!transport_map)
 787     transport_map = hash_table_new (0, NULL, NULL);
 788   hash_table_put (transport_map, (void *)(intptr_t) fd, info);
 789   ++transport_map_modified_tick;
 790 }
 791
 792 /* Return context of the transport registered with
 793    fd_register_transport.  This assumes fd_register_transport was
 794    previously called on FD.  */
 795
 796 void *
 797 fd_transport_context (int fd)
 798 {
 799   struct transport_info *info = hash_table_get (transport_map, (void *)(intptr_t) fd);
 800   return info->ctx;
 801 }
 802
 803 /* When fd_read/fd_write are called multiple times in a loop, they should
 804    remember the INFO pointer instead of fetching it every time.  It is
 805    not enough to compare FD to LAST_FD because FD might have been
 806    closed and reopened.  modified_tick ensures that changes to
 807    transport_map will not be unnoticed.
 808
 809    This is a macro because we want the static storage variables to be
 810    per-function.  */
 811
 812 #define LAZY_RETRIEVE_INFO(info) do {                                   \
 813   static struct transport_info *last_info;                              \
 814   static int last_fd = -1;                                              \
 815   static unsigned int last_tick;                                        \
 816   if (!transport_map)                                                   \
 817     info = NULL;                                                        \
 818   else if (last_fd == fd && last_tick == transport_map_modified_tick)   \
 819     info = last_info;                                                   \
 820   else                                                                  \
 821     {                                                                   \
 822       info = hash_table_get (transport_map, (void *)(intptr_t) fd);     \
 823       last_fd = fd;                                                     \
 824       last_info = info;                                                 \
 825       last_tick = transport_map_modified_tick;                          \
 826     }                                                                   \
 827 } while (0)
 828
 829 static bool
 830 poll_internal (int fd, struct transport_info *info, int wf, double timeout)
 831 {
 832   if (timeout == -1)
 833     timeout = opt.read_timeout;
 834   if (timeout)
 835     {
 836       int test;
 837       if (info && info->imp->poller)
 838         test = info->imp->poller (fd, timeout, wf, info->ctx);
 839       else
 840         test = sock_poll (fd, timeout, wf);
 841       if (test == 0)
 842         errno = ETIMEDOUT;
 843       if (test <= 0)
 844         return false;
 845     }
 846   return true;
 847 }
 848
 849 /* Read no more than BUFSIZE bytes of data from FD, storing them to
 850    BUF.  If TIMEOUT is non-zero, the operation aborts if no data is
 851    received after that many seconds.  If TIMEOUT is -1, the value of
 852    opt.timeout is used for TIMEOUT.  */
 853
 854 int
 855 fd_read (int fd, char *buf, int bufsize, double timeout)
 856 {
 857   struct transport_info *info;
 858   LAZY_RETRIEVE_INFO (info);
 859   if (!poll_internal (fd, info, WAIT_FOR_READ, timeout))
 860     return -1;
 861   if (info && info->imp->reader)
 862     return info->imp->reader (fd, buf, bufsize, info->ctx);
 863   else
 864     return sock_read (fd, buf, bufsize);
 865 }
 866
 867 /* Like fd_read, except it provides a "preview" of the data that will
 868    be read by subsequent calls to fd_read.  Specifically, it copies no
 869    more than BUFSIZE bytes of the currently available data to BUF and
 870    returns the number of bytes copied.  Return values and timeout
 871    semantics are the same as those of fd_read.
 872
 873    CAVEAT: Do not assume that the first subsequent call to fd_read
 874    will retrieve the same amount of data.  Reading can return more or
 875    less data, depending on the TCP implementation and other
 876    circumstances.  However, barring an error, it can be expected that
 877    all the peeked data will eventually be read by fd_read.  */
 878
 879 int
 880 fd_peek (int fd, char *buf, int bufsize, double timeout)
 881 {
 882   struct transport_info *info;
 883   LAZY_RETRIEVE_INFO (info);
 884   if (!poll_internal (fd, info, WAIT_FOR_READ, timeout))
 885     return -1;
 886   if (info && info->imp->peeker)
 887     return info->imp->peeker (fd, buf, bufsize, info->ctx);
 888   else
 889     return sock_peek (fd, buf, bufsize);
 890 }
 891
 892 /* Write the entire contents of BUF to FD.  If TIMEOUT is non-zero,
 893    the operation aborts if no data is received after that many
 894    seconds.  If TIMEOUT is -1, the value of opt.timeout is used for
 895    TIMEOUT.  */
 896
 897 int
 898 fd_write (int fd, char *buf, int bufsize, double timeout)
 899 {
 900   int res;
 901   struct transport_info *info;
 902   LAZY_RETRIEVE_INFO (info);
 903
 904   /* `write' may write less than LEN bytes, thus the loop keeps trying
 905      it until all was written, or an error occurred.  */
 906   res = 0;
 907   while (bufsize > 0)
 908     {
 909       if (!poll_internal (fd, info, WAIT_FOR_WRITE, timeout))
 910         return -1;
 911       if (info && info->imp->writer)
 912         res = info->imp->writer (fd, buf, bufsize, info->ctx);
 913       else
 914         res = sock_write (fd, buf, bufsize);
 915       if (res <= 0)
 916         break;
 917       buf += res;
 918       bufsize -= res;
 919     }
 920   return res;
 921 }
 922
 923 /* Report the most recent error(s) on FD.  This should only be called
 924    after fd_* functions, such as fd_read and fd_write, and only if
 925    they return a negative result.  For errors coming from other calls
 926    such as setsockopt or fopen, strerror should continue to be
 927    used.
 928
 929    If the transport doesn't support error messages or doesn't supply
 930    one, strerror(errno) is returned.  The returned error message
 931    should not be used after fd_close has been called.  */
 932
 933 const char *
 934 fd_errstr (int fd)
 935 {
 936   /* Don't bother with LAZY_RETRIEVE_INFO, as this will only be called
 937      in case of error, never in a tight loop.  */
 938   struct transport_info *info = NULL;
 939   if (transport_map)
 940     info = hash_table_get (transport_map, (void *)(intptr_t) fd);
 941
 942   if (info && info->imp->errstr)
 943     {
 944       const char *err = info->imp->errstr (fd, info->ctx);
 945       if (err)
 946         return err;
 947       /* else, fall through and print the system error. */
 948     }
 949   return strerror (errno);
 950 }
 951
 952 /* Close the file descriptor FD.  */
 953
 954 void
 955 fd_close (int fd)
 956 {
 957   struct transport_info *info;
 958   if (fd < 0)
 959     return;
 960
 961   /* Don't use LAZY_RETRIEVE_INFO because fd_close() is only called once
 962      per socket, so that particular optimization wouldn't work.  */
 963   info = NULL;
 964   if (transport_map)
 965     info = hash_table_get (transport_map, (void *)(intptr_t) fd);
 966
 967   if (info && info->imp->closer)
 968     info->imp->closer (fd, info->ctx);
 969   else
 970     sock_close (fd);
 971
 972   if (info)
 973     {
 974       hash_table_remove (transport_map, (void *)(intptr_t) fd);
 975       xfree (info);
 976       ++transport_map_modified_tick;
 977     }
 978 }