2 * Unix networking abstraction.
11 #include <sys/types.h>
12 #include <sys/socket.h>
13 #include <sys/ioctl.h>
14 #include <arpa/inet.h>
15 #include <netinet/in.h>
16 #include <netinet/tcp.h>
20 #define DEFINE_PLUG_METHOD_MACROS
25 /* Solaris needs <sys/sockio.h> for SIOCATMARK. */
27 #include <sys/sockio.h>
31 # define X11_UNIX_PATH "/tmp/.X11-unix/X"
35 * Access to sockaddr types without breaking C strict aliasing rules.
37 union sockaddr_union
{
39 struct sockaddr_in storage
;
41 struct sockaddr_storage storage
;
42 struct sockaddr_in6 sin6
;
45 struct sockaddr_in sin
;
46 struct sockaddr_un su
;
50 * We used to typedef struct Socket_tag *Socket.
52 * Since we have made the networking abstraction slightly more
53 * abstract, Socket no longer means a tcp socket (it could mean
54 * an ssl socket). So now we must use Actual_Socket when we know
55 * we are talking about a tcp socket.
57 typedef struct Socket_tag
*Actual_Socket
;
60 * Mutable state that goes with a SockAddr: stores information
61 * about where in the list of candidate IP(v*) addresses we've
64 typedef struct SockAddrStep_tag SockAddrStep
;
65 struct SockAddrStep_tag
{
67 struct addrinfo
*ai
; /* steps along addr->ais */
73 struct socket_function_table
*fn
;
74 /* the above variable absolutely *must* be the first in this structure */
80 int connected
; /* irrelevant for listening sockets */
82 int frozen
; /* this causes readability notifications to be ignored */
83 int frozen_readable
; /* this means we missed at least one readability
84 * notification while we were frozen */
85 int localhost_only
; /* for listening sockets */
88 int oobpending
; /* is there OOB data available to read? */
90 int pending_error
; /* in case send() returns error */
92 int nodelay
, keepalive
; /* for connect()-type sockets */
93 int privport
, port
; /* and again */
97 * We sometimes need pairs of Socket structures to be linked:
98 * if we are listening on the same IPv6 and v4 port, for
99 * example. So here we define `parent' and `child' pointers to
102 Actual_Socket parent
, child
;
105 struct SockAddr_tag
{
108 enum { UNRESOLVED
, UNIX
, IP
} superfamily
;
110 struct addrinfo
*ais
; /* Addresses IPv6 style. */
112 unsigned long *addresses
; /* Addresses IPv4 style. */
115 char hostname
[512]; /* Store an unresolved host name. */
119 * Which address family this address belongs to. AF_INET for IPv4;
120 * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
121 * not been done and a simple host name is held in this SockAddr
125 #define SOCKADDR_FAMILY(addr, step) \
126 ((addr)->superfamily == UNRESOLVED ? AF_UNSPEC : \
127 (addr)->superfamily == UNIX ? AF_UNIX : \
128 (step).ai ? (step).ai->ai_family : AF_INET)
130 #define SOCKADDR_FAMILY(addr, step) \
131 ((addr)->superfamily == UNRESOLVED ? AF_UNSPEC : \
132 (addr)->superfamily == UNIX ? AF_UNIX : AF_INET)
136 * Start a SockAddrStep structure to step through multiple
140 #define START_STEP(addr, step) \
141 ((step).ai = (addr)->ais, (step).curraddr = 0)
143 #define START_STEP(addr, step) \
144 ((step).curraddr = 0)
147 static tree234
*sktree
;
149 static void uxsel_tell(Actual_Socket s
);
151 static int cmpfortree(void *av
, void *bv
)
153 Actual_Socket a
= (Actual_Socket
) av
, b
= (Actual_Socket
) bv
;
154 int as
= a
->s
, bs
= b
->s
;
166 static int cmpforsearch(void *av
, void *bv
)
168 Actual_Socket b
= (Actual_Socket
) bv
;
169 int as
= *(int *)av
, bs
= b
->s
;
179 sktree
= newtree234(cmpfortree
);
182 void sk_cleanup(void)
188 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
194 SockAddr
sk_namelookup(const char *host
, char **canonicalname
, int address_family
)
196 SockAddr ret
= snew(struct SockAddr_tag
);
198 struct addrinfo hints
;
202 struct hostent
*h
= NULL
;
207 /* Clear the structure and default to IPv4. */
208 memset(ret
, 0, sizeof(struct SockAddr_tag
));
209 ret
->superfamily
= UNRESOLVED
;
215 hints
.ai_flags
= AI_CANONNAME
;
216 hints
.ai_family
= (address_family
== ADDRTYPE_IPV4 ? AF_INET
:
217 address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
219 hints
.ai_socktype
= SOCK_STREAM
;
220 hints
.ai_protocol
= 0;
221 hints
.ai_addrlen
= 0;
222 hints
.ai_addr
= NULL
;
223 hints
.ai_canonname
= NULL
;
224 hints
.ai_next
= NULL
;
225 err
= getaddrinfo(host
, NULL
, &hints
, &ret
->ais
);
227 ret
->error
= gai_strerror(err
);
230 ret
->superfamily
= IP
;
232 if (ret
->ais
->ai_canonname
!= NULL
)
233 strncat(realhost
, ret
->ais
->ai_canonname
, sizeof(realhost
) - 1);
235 strncat(realhost
, host
, sizeof(realhost
) - 1);
237 if ((a
= inet_addr(host
)) == (unsigned long)(in_addr_t
)(-1)) {
239 * Otherwise use the IPv4-only gethostbyname... (NOTE:
240 * we don't use gethostbyname as a fallback!)
242 if (ret
->superfamily
== UNRESOLVED
) {
243 /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
244 if ( (h
= gethostbyname(host
)) )
245 ret
->superfamily
= IP
;
247 if (ret
->superfamily
== UNRESOLVED
) {
248 ret
->error
= (h_errno
== HOST_NOT_FOUND
||
249 h_errno
== NO_DATA
||
250 h_errno
== NO_ADDRESS ?
"Host does not exist" :
251 h_errno
== TRY_AGAIN ?
252 "Temporary name service failure" :
253 "gethostbyname: unknown error");
256 /* This way we are always sure the h->h_name is valid :) */
257 strncpy(realhost
, h
->h_name
, sizeof(realhost
));
258 for (n
= 0; h
->h_addr_list
[n
]; n
++);
259 ret
->addresses
= snewn(n
, unsigned long);
261 for (n
= 0; n
< ret
->naddresses
; n
++) {
262 memcpy(&a
, h
->h_addr_list
[n
], sizeof(a
));
263 ret
->addresses
[n
] = ntohl(a
);
267 * This must be a numeric IPv4 address because it caused a
268 * success return from inet_addr.
270 ret
->superfamily
= IP
;
271 strncpy(realhost
, host
, sizeof(realhost
));
272 ret
->addresses
= snew(unsigned long);
274 ret
->addresses
[0] = ntohl(a
);
277 realhost
[lenof(realhost
)-1] = '\0';
278 *canonicalname
= snewn(1+strlen(realhost
), char);
279 strcpy(*canonicalname
, realhost
);
283 SockAddr
sk_nonamelookup(const char *host
)
285 SockAddr ret
= snew(struct SockAddr_tag
);
287 ret
->superfamily
= UNRESOLVED
;
288 strncpy(ret
->hostname
, host
, lenof(ret
->hostname
));
289 ret
->hostname
[lenof(ret
->hostname
)-1] = '\0';
293 ret
->addresses
= NULL
;
299 static int sk_nextaddr(SockAddr addr
, SockAddrStep
*step
)
302 if (step
->ai
&& step
->ai
->ai_next
) {
303 step
->ai
= step
->ai
->ai_next
;
308 if (step
->curraddr
+1 < addr
->naddresses
) {
317 void sk_getaddr(SockAddr addr
, char *buf
, int buflen
)
319 /* XXX not clear what we should return for Unix-domain sockets; let's
320 * hope the question never arises */
321 assert(addr
->superfamily
!= UNIX
);
322 if (addr
->superfamily
== UNRESOLVED
) {
323 strncpy(buf
, addr
->hostname
, buflen
);
324 buf
[buflen
-1] = '\0';
327 if (getnameinfo(addr
->ais
->ai_addr
, addr
->ais
->ai_addrlen
, buf
, buflen
,
328 NULL
, 0, NI_NUMERICHOST
) != 0) {
330 strncat(buf
, "<unknown>", buflen
- 1);
335 START_STEP(addr
, step
);
336 assert(SOCKADDR_FAMILY(addr
, step
) == AF_INET
);
337 a
.s_addr
= htonl(addr
->addresses
[0]);
338 strncpy(buf
, inet_ntoa(a
), buflen
);
339 buf
[buflen
-1] = '\0';
344 int sk_hostname_is_local(char *name
)
346 return !strcmp(name
, "localhost") ||
347 !strcmp(name
, "::1") ||
348 !strncmp(name
, "127.", 4);
351 #define ipv4_is_loopback(addr) \
352 (((addr).s_addr & htonl(0xff000000)) == htonl(0x7f000000))
354 static int sockaddr_is_loopback(struct sockaddr
*sa
)
356 union sockaddr_union
*u
= (union sockaddr_union
*)sa
;
357 switch (u
->sa
.sa_family
) {
359 return ipv4_is_loopback(u
->sin
.sin_addr
);
362 return IN6_IS_ADDR_LOOPBACK(&u
->sin6
.sin6_addr
);
371 int sk_address_is_local(SockAddr addr
)
373 if (addr
->superfamily
== UNRESOLVED
)
374 return 0; /* we don't know; assume not */
375 else if (addr
->superfamily
== UNIX
)
379 return sockaddr_is_loopback(addr
->ais
->ai_addr
);
383 START_STEP(addr
, step
);
384 assert(SOCKADDR_FAMILY(addr
, step
) == AF_INET
);
385 a
.s_addr
= htonl(addr
->addresses
[0]);
386 return ipv4_is_loopback(a
);
391 int sk_addrtype(SockAddr addr
)
395 START_STEP(addr
, step
);
396 family
= SOCKADDR_FAMILY(addr
, step
);
398 return (family
== AF_INET ? ADDRTYPE_IPV4
:
400 family
== AF_INET6 ? ADDRTYPE_IPV6
:
405 void sk_addrcopy(SockAddr addr
, char *buf
)
409 START_STEP(addr
, step
);
410 family
= SOCKADDR_FAMILY(addr
, step
);
413 if (family
== AF_INET
)
414 memcpy(buf
, &((struct sockaddr_in
*)step
.ai
->ai_addr
)->sin_addr
,
415 sizeof(struct in_addr
));
416 else if (family
== AF_INET6
)
417 memcpy(buf
, &((struct sockaddr_in6
*)step
.ai
->ai_addr
)->sin6_addr
,
418 sizeof(struct in6_addr
));
424 assert(family
== AF_INET
);
425 a
.s_addr
= htonl(addr
->addresses
[step
.curraddr
]);
426 memcpy(buf
, (char*) &a
.s_addr
, 4);
430 void sk_addr_free(SockAddr addr
)
432 if (--addr
->refcount
> 0)
435 if (addr
->ais
!= NULL
)
436 freeaddrinfo(addr
->ais
);
438 sfree(addr
->addresses
);
443 SockAddr
sk_addr_dup(SockAddr addr
)
449 static Plug
sk_tcp_plug(Socket sock
, Plug p
)
451 Actual_Socket s
= (Actual_Socket
) sock
;
458 static void sk_tcp_flush(Socket s
)
461 * We send data to the socket as soon as we can anyway,
462 * so we don't need to do anything here. :-)
466 static void sk_tcp_close(Socket s
);
467 static int sk_tcp_write(Socket s
, const char *data
, int len
);
468 static int sk_tcp_write_oob(Socket s
, const char *data
, int len
);
469 static void sk_tcp_set_private_ptr(Socket s
, void *ptr
);
470 static void *sk_tcp_get_private_ptr(Socket s
);
471 static void sk_tcp_set_frozen(Socket s
, int is_frozen
);
472 static const char *sk_tcp_socket_error(Socket s
);
474 static struct socket_function_table tcp_fn_table
= {
480 sk_tcp_set_private_ptr
,
481 sk_tcp_get_private_ptr
,
486 Socket
sk_register(OSSocket sockfd
, Plug plug
)
491 * Create Socket structure.
493 ret
= snew(struct Socket_tag
);
494 ret
->fn
= &tcp_fn_table
;
497 bufchain_init(&ret
->output_data
);
498 ret
->writable
= 1; /* to start with */
499 ret
->sending_oob
= 0;
501 ret
->frozen_readable
= 0;
502 ret
->localhost_only
= 0; /* unused, but best init anyway */
503 ret
->pending_error
= 0;
504 ret
->oobpending
= FALSE
;
506 ret
->parent
= ret
->child
= NULL
;
513 ret
->error
= strerror(errno
);
525 static int try_connect(Actual_Socket sock
)
528 union sockaddr_union u
;
529 const union sockaddr_union
*sa
;
532 int fl
, salen
, family
;
535 * Remove the socket from the tree before we overwrite its
536 * internal socket id, because that forms part of the tree's
537 * sorting criterion. We'll add it back before exiting this
538 * function, whether we changed anything or not.
540 del234(sktree
, sock
);
545 plug_log(sock
->plug
, 0, sock
->addr
, sock
->port
, NULL
, 0);
550 family
= SOCKADDR_FAMILY(sock
->addr
, sock
->step
);
551 assert(family
!= AF_UNSPEC
);
552 s
= socket(family
, SOCK_STREAM
, 0);
562 if (sock
->oobinline
) {
564 setsockopt(s
, SOL_SOCKET
, SO_OOBINLINE
, (void *) &b
, sizeof(b
));
569 setsockopt(s
, IPPROTO_TCP
, TCP_NODELAY
, (void *) &b
, sizeof(b
));
572 if (sock
->keepalive
) {
574 setsockopt(s
, SOL_SOCKET
, SO_KEEPALIVE
, (void *) &b
, sizeof(b
));
578 * Bind to local address.
581 localport
= 1023; /* count from 1023 downwards */
583 localport
= 0; /* just use port 0 (ie kernel picks) */
585 /* BSD IP stacks need sockaddr_in zeroed before filling in */
586 memset(&u
,'\0',sizeof(u
));
588 /* We don't try to bind to a local address for UNIX domain sockets. (Why
589 * do we bother doing the bind when localport == 0 anyway?) */
590 if (family
!= AF_UNIX
) {
591 /* Loop round trying to bind */
596 if (family
== AF_INET6
) {
597 /* XXX use getaddrinfo to get a local address? */
598 u
.sin6
.sin6_family
= AF_INET6
;
599 u
.sin6
.sin6_addr
= in6addr_any
;
600 u
.sin6
.sin6_port
= htons(localport
);
601 retcode
= bind(s
, &u
.sa
, sizeof(u
.sin6
));
605 assert(family
== AF_INET
);
606 u
.sin
.sin_family
= AF_INET
;
607 u
.sin
.sin_addr
.s_addr
= htonl(INADDR_ANY
);
608 u
.sin
.sin_port
= htons(localport
);
609 retcode
= bind(s
, &u
.sa
, sizeof(u
.sin
));
616 if (err
!= EADDRINUSE
) /* failed, for a bad reason */
621 break; /* we're only looping once */
624 break; /* we might have got to the end */
632 * Connect to remote address.
637 /* XXX would be better to have got getaddrinfo() to fill in the port. */
638 ((struct sockaddr_in
*)sock
->step
.ai
->ai_addr
)->sin_port
=
640 sa
= (const union sockaddr_union
*)sock
->step
.ai
->ai_addr
;
641 salen
= sock
->step
.ai
->ai_addrlen
;
644 ((struct sockaddr_in
*)sock
->step
.ai
->ai_addr
)->sin_port
=
646 sa
= (const union sockaddr_union
*)sock
->step
.ai
->ai_addr
;
647 salen
= sock
->step
.ai
->ai_addrlen
;
651 u
.sin
.sin_family
= AF_INET
;
652 u
.sin
.sin_addr
.s_addr
= htonl(sock
->addr
->addresses
[sock
->step
.curraddr
]);
653 u
.sin
.sin_port
= htons((short) sock
->port
);
655 salen
= sizeof u
.sin
;
659 assert(sock
->port
== 0); /* to catch confused people */
660 assert(strlen(sock
->addr
->hostname
) < sizeof u
.su
.sun_path
);
661 u
.su
.sun_family
= AF_UNIX
;
662 strcpy(u
.su
.sun_path
, sock
->addr
->hostname
);
668 assert(0 && "unknown address family");
669 exit(1); /* XXX: GCC doesn't understand assert() on some systems. */
672 fl
= fcntl(s
, F_GETFL
);
674 fcntl(s
, F_SETFL
, fl
| O_NONBLOCK
);
676 if ((connect(s
, &(sa
->sa
), salen
)) < 0) {
677 if ( errno
!= EINPROGRESS
) {
683 * If we _don't_ get EWOULDBLOCK, the connect has completed
684 * and we should set the socket as connected and writable.
695 * No matter what happened, put the socket back in the tree.
697 add234(sktree
, sock
);
700 plug_log(sock
->plug
, 1, sock
->addr
, sock
->port
, strerror(err
), err
);
704 Socket
sk_new(SockAddr addr
, int port
, int privport
, int oobinline
,
705 int nodelay
, int keepalive
, Plug plug
)
711 * Create Socket structure.
713 ret
= snew(struct Socket_tag
);
714 ret
->fn
= &tcp_fn_table
;
717 bufchain_init(&ret
->output_data
);
718 ret
->connected
= 0; /* to start with */
719 ret
->writable
= 0; /* to start with */
720 ret
->sending_oob
= 0;
722 ret
->frozen_readable
= 0;
723 ret
->localhost_only
= 0; /* unused, but best init anyway */
724 ret
->pending_error
= 0;
725 ret
->parent
= ret
->child
= NULL
;
726 ret
->oobpending
= FALSE
;
729 START_STEP(ret
->addr
, ret
->step
);
731 ret
->oobinline
= oobinline
;
732 ret
->nodelay
= nodelay
;
733 ret
->keepalive
= keepalive
;
734 ret
->privport
= privport
;
739 err
= try_connect(ret
);
740 } while (err
&& sk_nextaddr(ret
->addr
, &ret
->step
));
743 ret
->error
= strerror(err
);
748 Socket
sk_newlistener(char *srcaddr
, int port
, Plug plug
, int local_host_only
, int orig_address_family
)
752 struct addrinfo hints
, *ai
;
755 union sockaddr_union u
;
756 union sockaddr_union
*addr
;
764 * Create Socket structure.
766 ret
= snew(struct Socket_tag
);
767 ret
->fn
= &tcp_fn_table
;
770 bufchain_init(&ret
->output_data
);
771 ret
->writable
= 0; /* to start with */
772 ret
->sending_oob
= 0;
774 ret
->frozen_readable
= 0;
775 ret
->localhost_only
= local_host_only
;
776 ret
->pending_error
= 0;
777 ret
->parent
= ret
->child
= NULL
;
778 ret
->oobpending
= FALSE
;
783 * Translate address_family from platform-independent constants
784 * into local reality.
786 address_family
= (orig_address_family
== ADDRTYPE_IPV4 ? AF_INET
:
788 orig_address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
793 /* Let's default to IPv6.
794 * If the stack doesn't support IPv6, we will fall back to IPv4. */
795 if (address_family
== AF_UNSPEC
) address_family
= AF_INET6
;
797 /* No other choice, default to IPv4 */
798 if (address_family
== AF_UNSPEC
) address_family
= AF_INET
;
804 s
= socket(address_family
, SOCK_STREAM
, 0);
807 /* If the host doesn't support IPv6 try fallback to IPv4. */
808 if (s
< 0 && address_family
== AF_INET6
) {
809 address_family
= AF_INET
;
810 s
= socket(address_family
, SOCK_STREAM
, 0);
815 ret
->error
= strerror(errno
);
823 setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
, (const char *)&on
, sizeof(on
));
826 addr
= NULL
; addrlen
= -1; /* placate optimiser */
828 if (srcaddr
!= NULL
) {
830 hints
.ai_flags
= AI_NUMERICHOST
;
831 hints
.ai_family
= address_family
;
832 hints
.ai_socktype
= SOCK_STREAM
;
833 hints
.ai_protocol
= 0;
834 hints
.ai_addrlen
= 0;
835 hints
.ai_addr
= NULL
;
836 hints
.ai_canonname
= NULL
;
837 hints
.ai_next
= NULL
;
838 assert(port
>= 0 && port
<= 99999);
839 sprintf(portstr
, "%d", port
);
840 retcode
= getaddrinfo(srcaddr
, portstr
, &hints
, &ai
);
842 addr
= (union sockaddr_union
*)ai
->ai_addr
;
843 addrlen
= ai
->ai_addrlen
;
846 memset(&u
,'\0',sizeof u
);
847 u
.sin
.sin_family
= AF_INET
;
848 u
.sin
.sin_port
= htons(port
);
849 u
.sin
.sin_addr
.s_addr
= inet_addr(srcaddr
);
850 if (u
.sin
.sin_addr
.s_addr
!= (in_addr_t
)(-1)) {
851 /* Override localhost_only with specified listen addr. */
852 ret
->localhost_only
= ipv4_is_loopback(u
.sin
.sin_addr
);
855 addrlen
= sizeof(u
.sin
);
861 memset(&u
,'\0',sizeof u
);
863 if (address_family
== AF_INET6
) {
864 u
.sin6
.sin6_family
= AF_INET6
;
865 u
.sin6
.sin6_port
= htons(port
);
867 u
.sin6
.sin6_addr
= in6addr_loopback
;
869 u
.sin6
.sin6_addr
= in6addr_any
;
871 addrlen
= sizeof(u
.sin6
);
875 u
.sin
.sin_family
= AF_INET
;
876 u
.sin
.sin_port
= htons(port
);
878 u
.sin
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
880 u
.sin
.sin_addr
.s_addr
= htonl(INADDR_ANY
);
882 addrlen
= sizeof(u
.sin
);
886 retcode
= bind(s
, &addr
->sa
, addrlen
);
889 ret
->error
= strerror(errno
);
893 if (listen(s
, SOMAXCONN
) < 0) {
895 ret
->error
= strerror(errno
);
901 * If we were given ADDRTYPE_UNSPEC, we must also create an
902 * IPv4 listening socket and link it to this one.
904 if (address_family
== AF_INET6
&& orig_address_family
== ADDRTYPE_UNSPEC
) {
907 other
= (Actual_Socket
) sk_newlistener(srcaddr
, port
, plug
,
908 local_host_only
, ADDRTYPE_IPV4
);
915 /* If we couldn't create a listening socket on IPv4 as well
916 * as IPv6, we must return an error overall. */
919 return (Socket
) other
;
933 static void sk_tcp_close(Socket sock
)
935 Actual_Socket s
= (Actual_Socket
) sock
;
938 sk_tcp_close((Socket
)s
->child
);
944 sk_addr_free(s
->addr
);
948 void *sk_getxdmdata(void *sock
, int *lenp
)
950 Actual_Socket s
= (Actual_Socket
) sock
;
951 union sockaddr_union u
;
954 static unsigned int unix_addr
= 0xFFFFFFFF;
957 * We must check that this socket really _is_ an Actual_Socket.
959 if (s
->fn
!= &tcp_fn_table
)
960 return NULL
; /* failure */
963 if (getsockname(s
->s
, &u
.sa
, &addrlen
) < 0)
965 switch(u
.sa
.sa_family
) {
968 buf
= snewn(*lenp
, char);
969 PUT_32BIT_MSB_FIRST(buf
, ntohl(u
.sin
.sin_addr
.s_addr
));
970 PUT_16BIT_MSB_FIRST(buf
+4, ntohs(u
.sin
.sin_port
));
975 buf
= snewn(*lenp
, char);
976 if (IN6_IS_ADDR_V4MAPPED(&u
.sin6
.sin6_addr
)) {
977 memcpy(buf
, u
.sin6
.sin6_addr
.s6_addr
+ 12, 4);
978 PUT_16BIT_MSB_FIRST(buf
+4, ntohs(u
.sin6
.sin6_port
));
980 /* This is stupid, but it's what XLib does. */
986 buf
= snewn(*lenp
, char);
987 PUT_32BIT_MSB_FIRST(buf
, unix_addr
--);
988 PUT_16BIT_MSB_FIRST(buf
+4, getpid());
1001 * The function which tries to send on a socket once it's deemed
1004 void try_send(Actual_Socket s
)
1006 while (s
->sending_oob
|| bufchain_size(&s
->output_data
) > 0) {
1010 int len
, urgentflag
;
1012 if (s
->sending_oob
) {
1013 urgentflag
= MSG_OOB
;
1014 len
= s
->sending_oob
;
1018 bufchain_prefix(&s
->output_data
, &data
, &len
);
1020 nsent
= send(s
->s
, data
, len
, urgentflag
);
1021 noise_ultralight(nsent
);
1023 err
= (nsent
< 0 ? errno
: 0);
1024 if (err
== EWOULDBLOCK
) {
1026 * Perfectly normal: we've sent all we can for the moment.
1028 s
->writable
= FALSE
;
1032 * We unfortunately can't just call plug_closing(),
1033 * because it's quite likely that we're currently
1034 * _in_ a call from the code we'd be calling back
1035 * to, so we'd have to make half the SSH code
1036 * reentrant. Instead we flag a pending error on
1037 * the socket, to be dealt with (by calling
1038 * plug_closing()) at some suitable future moment.
1040 s
->pending_error
= err
;
1044 if (s
->sending_oob
) {
1046 memmove(s
->oobdata
, s
->oobdata
+nsent
, len
-nsent
);
1047 s
->sending_oob
= len
- nsent
;
1052 bufchain_consume(&s
->output_data
, nsent
);
1059 static int sk_tcp_write(Socket sock
, const char *buf
, int len
)
1061 Actual_Socket s
= (Actual_Socket
) sock
;
1064 * Add the data to the buffer list on the socket.
1066 bufchain_add(&s
->output_data
, buf
, len
);
1069 * Now try sending from the start of the buffer list.
1075 * Update the select() status to correctly reflect whether or
1076 * not we should be selecting for write.
1080 return bufchain_size(&s
->output_data
);
1083 static int sk_tcp_write_oob(Socket sock
, const char *buf
, int len
)
1085 Actual_Socket s
= (Actual_Socket
) sock
;
1088 * Replace the buffer list on the socket with the data.
1090 bufchain_clear(&s
->output_data
);
1091 assert(len
<= sizeof(s
->oobdata
));
1092 memcpy(s
->oobdata
, buf
, len
);
1093 s
->sending_oob
= len
;
1096 * Now try sending from the start of the buffer list.
1102 * Update the select() status to correctly reflect whether or
1103 * not we should be selecting for write.
1107 return s
->sending_oob
;
1110 static int net_select_result(int fd
, int event
)
1113 char buf
[20480]; /* nice big buffer for plenty of speed */
1117 /* Find the Socket structure */
1118 s
= find234(sktree
, &fd
, cmpforsearch
);
1120 return 1; /* boggle */
1122 noise_ultralight(event
);
1125 case 4: /* exceptional */
1126 if (!s
->oobinline
) {
1128 * On a non-oobinline socket, this indicates that we
1129 * can immediately perform an OOB read and get back OOB
1130 * data, which we will send to the back end with
1131 * type==2 (urgent data).
1133 ret
= recv(s
->s
, buf
, sizeof(buf
), MSG_OOB
);
1134 noise_ultralight(ret
);
1136 return plug_closing(s
->plug
,
1137 ret
== 0 ?
"Internal networking trouble" :
1138 strerror(errno
), errno
, 0);
1141 * Receiving actual data on a socket means we can
1142 * stop falling back through the candidate
1143 * addresses to connect to.
1146 sk_addr_free(s
->addr
);
1149 return plug_receive(s
->plug
, 2, buf
, ret
);
1155 * If we reach here, this is an oobinline socket, which
1156 * means we should set s->oobpending and then deal with it
1157 * when we get called for the readability event (which
1158 * should also occur).
1160 s
->oobpending
= TRUE
;
1162 case 1: /* readable; also acceptance */
1165 * On a listening socket, the readability event means a
1166 * connection is ready to be accepted.
1168 union sockaddr_union su
;
1169 socklen_t addrlen
= sizeof(su
);
1170 int t
; /* socket of connection */
1173 memset(&su
, 0, addrlen
);
1174 t
= accept(s
->s
, &su
.sa
, &addrlen
);
1179 fl
= fcntl(t
, F_GETFL
);
1181 fcntl(t
, F_SETFL
, fl
| O_NONBLOCK
);
1183 if (s
->localhost_only
&&
1184 !sockaddr_is_loopback(&su
.sa
)) {
1185 close(t
); /* someone let nonlocal through?! */
1186 } else if (plug_accepting(s
->plug
, t
)) {
1187 close(t
); /* denied or error */
1193 * If we reach here, this is not a listening socket, so
1194 * readability really means readability.
1197 /* In the case the socket is still frozen, we don't even bother */
1199 s
->frozen_readable
= 1;
1204 * We have received data on the socket. For an oobinline
1205 * socket, this might be data _before_ an urgent pointer,
1206 * in which case we send it to the back end with type==1
1207 * (data prior to urgent).
1209 if (s
->oobinline
&& s
->oobpending
) {
1211 if (ioctl(s
->s
, SIOCATMARK
, &atmark
) == 0 && atmark
)
1212 s
->oobpending
= FALSE
; /* clear this indicator */
1216 ret
= recv(s
->s
, buf
, s
->oobpending ?
1 : sizeof(buf
), 0);
1217 noise_ultralight(ret
);
1219 if (errno
== EWOULDBLOCK
) {
1225 * An error at this point _might_ be an error reported
1226 * by a non-blocking connect(). So before we return a
1227 * panic status to the user, let's just see whether
1232 plug_log(s
->plug
, 1, s
->addr
, s
->port
, strerror(err
), err
);
1233 while (s
->addr
&& sk_nextaddr(s
->addr
, &s
->step
)) {
1234 err
= try_connect(s
);
1238 return plug_closing(s
->plug
, strerror(err
), err
, 0);
1239 } else if (0 == ret
) {
1240 return plug_closing(s
->plug
, NULL
, 0, 0);
1243 * Receiving actual data on a socket means we can
1244 * stop falling back through the candidate
1245 * addresses to connect to.
1248 sk_addr_free(s
->addr
);
1251 return plug_receive(s
->plug
, atmark ?
0 : 1, buf
, ret
);
1254 case 2: /* writable */
1255 if (!s
->connected
) {
1257 * select() reports a socket as _writable_ when an
1258 * asynchronous connection is completed.
1260 s
->connected
= s
->writable
= 1;
1264 int bufsize_before
, bufsize_after
;
1266 bufsize_before
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1268 bufsize_after
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1269 if (bufsize_after
< bufsize_before
)
1270 plug_sent(s
->plug
, bufsize_after
);
1279 * Deal with socket errors detected in try_send().
1281 void net_pending_errors(void)
1287 * This might be a fiddly business, because it's just possible
1288 * that handling a pending error on one socket might cause
1289 * others to be closed. (I can't think of any reason this might
1290 * happen in current SSH implementation, but to maintain
1291 * generality of this network layer I'll assume the worst.)
1293 * So what we'll do is search the socket list for _one_ socket
1294 * with a pending error, and then handle it, and then search
1295 * the list again _from the beginning_. Repeat until we make a
1296 * pass with no socket errors present. That way we are
1297 * protected against the socket list changing under our feet.
1301 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1302 if (s
->pending_error
) {
1304 * An error has occurred on this socket. Pass it to the
1307 plug_closing(s
->plug
, strerror(s
->pending_error
),
1308 s
->pending_error
, 0);
1316 * Each socket abstraction contains a `void *' private field in
1317 * which the client can keep state.
1319 static void sk_tcp_set_private_ptr(Socket sock
, void *ptr
)
1321 Actual_Socket s
= (Actual_Socket
) sock
;
1322 s
->private_ptr
= ptr
;
1325 static void *sk_tcp_get_private_ptr(Socket sock
)
1327 Actual_Socket s
= (Actual_Socket
) sock
;
1328 return s
->private_ptr
;
1332 * Special error values are returned from sk_namelookup and sk_new
1333 * if there's a problem. These functions extract an error message,
1334 * or return NULL if there's no problem.
1336 const char *sk_addr_error(SockAddr addr
)
1340 static const char *sk_tcp_socket_error(Socket sock
)
1342 Actual_Socket s
= (Actual_Socket
) sock
;
1346 static void sk_tcp_set_frozen(Socket sock
, int is_frozen
)
1348 Actual_Socket s
= (Actual_Socket
) sock
;
1349 if (s
->frozen
== is_frozen
)
1351 s
->frozen
= is_frozen
;
1352 if (!is_frozen
&& s
->frozen_readable
) {
1354 recv(s
->s
, &c
, 1, MSG_PEEK
);
1356 s
->frozen_readable
= 0;
1360 static void uxsel_tell(Actual_Socket s
)
1364 rwx
|= 1; /* read == accept */
1367 rwx
|= 2; /* write == connect */
1368 if (s
->connected
&& !s
->frozen
)
1369 rwx
|= 1 | 4; /* read, except */
1370 if (bufchain_size(&s
->output_data
))
1371 rwx
|= 2; /* write */
1373 uxsel_set(s
->s
, rwx
, net_select_result
);
1376 int net_service_lookup(char *service
)
1379 se
= getservbyname(service
, NULL
);
1381 return ntohs(se
->s_port
);
1386 char *get_hostname(void)
1389 char *hostname
= NULL
;
1392 hostname
= sresize(hostname
, len
, char);
1393 if ((gethostname(hostname
, len
) < 0) &&
1394 (errno
!= ENAMETOOLONG
)) {
1399 } while (strlen(hostname
) >= len
-1);
1403 SockAddr
platform_get_x11_unix_address(const char *sockpath
, int displaynum
)
1405 SockAddr ret
= snew(struct SockAddr_tag
);
1408 memset(ret
, 0, sizeof *ret
);
1409 ret
->superfamily
= UNIX
;
1411 * In special circumstances (notably Mac OS X Leopard), we'll
1412 * have been passed an explicit Unix socket path.
1415 n
= snprintf(ret
->hostname
, sizeof ret
->hostname
,
1418 n
= snprintf(ret
->hostname
, sizeof ret
->hostname
,
1419 "%s%d", X11_UNIX_PATH
, displaynum
);
1423 ret
->error
= "snprintf failed";
1424 else if (n
>= sizeof ret
->hostname
)
1425 ret
->error
= "X11 UNIX name too long";
1430 ret
->addresses
= NULL
;
1431 ret
->naddresses
= 0;