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