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