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