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 * We used to typedef struct Socket_tag *Socket.
37 * Since we have made the networking abstraction slightly more
38 * abstract, Socket no longer means a tcp socket (it could mean
39 * an ssl socket). So now we must use Actual_Socket when we know
40 * we are talking about a tcp socket.
42 typedef struct Socket_tag
*Actual_Socket
;
45 * Mutable state that goes with a SockAddr: stores information
46 * about where in the list of candidate IP(v*) addresses we've
49 typedef struct SockAddrStep_tag SockAddrStep
;
50 struct SockAddrStep_tag
{
52 struct addrinfo
*ai
; /* steps along addr->ais */
58 struct socket_function_table
*fn
;
59 /* the above variable absolutely *must* be the first in this structure */
65 int connected
; /* irrelevant for listening sockets */
67 int frozen
; /* this causes readability notifications to be ignored */
68 int frozen_readable
; /* this means we missed at least one readability
69 * notification while we were frozen */
70 int localhost_only
; /* for listening sockets */
73 int oobpending
; /* is there OOB data available to read? */
75 int pending_error
; /* in case send() returns error */
77 int nodelay
, keepalive
; /* for connect()-type sockets */
78 int privport
, port
; /* and again */
82 * We sometimes need pairs of Socket structures to be linked:
83 * if we are listening on the same IPv6 and v4 port, for
84 * example. So here we define `parent' and `child' pointers to
87 Actual_Socket parent
, child
;
93 enum { UNRESOLVED
, UNIX
, IP
} superfamily
;
95 struct addrinfo
*ais
; /* Addresses IPv6 style. */
97 unsigned long *addresses
; /* Addresses IPv4 style. */
100 char hostname
[512]; /* Store an unresolved host name. */
104 * Which address family this address belongs to. AF_INET for IPv4;
105 * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
106 * not been done and a simple host name is held in this SockAddr
110 #define SOCKADDR_FAMILY(addr, step) \
111 ((addr)->superfamily == UNRESOLVED ? AF_UNSPEC : \
112 (addr)->superfamily == UNIX ? AF_UNIX : \
113 (step).ai ? (step).ai->ai_family : AF_INET)
115 #define SOCKADDR_FAMILY(addr, step) \
116 ((addr)->superfamily == UNRESOLVED ? AF_UNSPEC : \
117 (addr)->superfamily == UNIX ? AF_UNIX : AF_INET)
121 * Start a SockAddrStep structure to step through multiple
125 #define START_STEP(addr, step) \
126 ((step).ai = (addr)->ais, (step).curraddr = 0)
128 #define START_STEP(addr, step) \
129 ((step).curraddr = 0)
132 static tree234
*sktree
;
134 static void uxsel_tell(Actual_Socket s
);
136 static int cmpfortree(void *av
, void *bv
)
138 Actual_Socket a
= (Actual_Socket
) av
, b
= (Actual_Socket
) bv
;
139 int as
= a
->s
, bs
= b
->s
;
151 static int cmpforsearch(void *av
, void *bv
)
153 Actual_Socket b
= (Actual_Socket
) bv
;
154 int as
= *(int *)av
, bs
= b
->s
;
164 sktree
= newtree234(cmpfortree
);
167 void sk_cleanup(void)
173 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
179 SockAddr
sk_namelookup(const char *host
, char **canonicalname
, int address_family
)
181 SockAddr ret
= snew(struct SockAddr_tag
);
183 struct addrinfo hints
;
187 struct hostent
*h
= NULL
;
192 /* Clear the structure and default to IPv4. */
193 memset(ret
, 0, sizeof(struct SockAddr_tag
));
194 ret
->superfamily
= UNRESOLVED
;
200 hints
.ai_flags
= AI_CANONNAME
;
201 hints
.ai_family
= (address_family
== ADDRTYPE_IPV4 ? AF_INET
:
202 address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
204 hints
.ai_socktype
= SOCK_STREAM
;
205 hints
.ai_protocol
= 0;
206 hints
.ai_addrlen
= 0;
207 hints
.ai_addr
= NULL
;
208 hints
.ai_canonname
= NULL
;
209 hints
.ai_next
= NULL
;
210 err
= getaddrinfo(host
, NULL
, &hints
, &ret
->ais
);
212 ret
->error
= gai_strerror(err
);
215 ret
->superfamily
= IP
;
217 if (ret
->ais
->ai_canonname
!= NULL
)
218 strncat(realhost
, ret
->ais
->ai_canonname
, sizeof(realhost
) - 1);
220 strncat(realhost
, host
, sizeof(realhost
) - 1);
222 if ((a
= inet_addr(host
)) == (unsigned long)(in_addr_t
)(-1)) {
224 * Otherwise use the IPv4-only gethostbyname... (NOTE:
225 * we don't use gethostbyname as a fallback!)
227 if (ret
->superfamily
== UNRESOLVED
) {
228 /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
229 if ( (h
= gethostbyname(host
)) )
230 ret
->superfamily
= IP
;
232 if (ret
->superfamily
== UNRESOLVED
) {
233 ret
->error
= (h_errno
== HOST_NOT_FOUND
||
234 h_errno
== NO_DATA
||
235 h_errno
== NO_ADDRESS ?
"Host does not exist" :
236 h_errno
== TRY_AGAIN ?
237 "Temporary name service failure" :
238 "gethostbyname: unknown error");
241 /* This way we are always sure the h->h_name is valid :) */
242 strncpy(realhost
, h
->h_name
, sizeof(realhost
));
243 for (n
= 0; h
->h_addr_list
[n
]; n
++);
244 ret
->addresses
= snewn(n
, unsigned long);
246 for (n
= 0; n
< ret
->naddresses
; n
++) {
247 memcpy(&a
, h
->h_addr_list
[n
], sizeof(a
));
248 ret
->addresses
[n
] = ntohl(a
);
252 * This must be a numeric IPv4 address because it caused a
253 * success return from inet_addr.
255 ret
->superfamily
= IP
;
256 strncpy(realhost
, host
, sizeof(realhost
));
257 ret
->addresses
= snew(unsigned long);
259 ret
->addresses
[0] = ntohl(a
);
262 realhost
[lenof(realhost
)-1] = '\0';
263 *canonicalname
= snewn(1+strlen(realhost
), char);
264 strcpy(*canonicalname
, realhost
);
268 SockAddr
sk_nonamelookup(const char *host
)
270 SockAddr ret
= snew(struct SockAddr_tag
);
272 ret
->superfamily
= UNRESOLVED
;
273 strncpy(ret
->hostname
, host
, lenof(ret
->hostname
));
274 ret
->hostname
[lenof(ret
->hostname
)-1] = '\0';
278 ret
->addresses
= NULL
;
284 static int sk_nextaddr(SockAddr addr
, SockAddrStep
*step
)
287 if (step
->ai
&& step
->ai
->ai_next
) {
288 step
->ai
= step
->ai
->ai_next
;
293 if (step
->curraddr
+1 < addr
->naddresses
) {
302 void sk_getaddr(SockAddr addr
, char *buf
, int buflen
)
305 if (addr
->superfamily
== UNRESOLVED
) {
306 strncpy(buf
, addr
->hostname
, buflen
);
307 buf
[buflen
-1] = '\0';
310 if (getnameinfo(addr
->ais
->ai_addr
, addr
->ais
->ai_addrlen
, buf
, buflen
,
311 NULL
, 0, NI_NUMERICHOST
) != 0) {
313 strncat(buf
, "<unknown>", buflen
- 1);
318 START_STEP(addr
, step
);
319 assert(SOCKADDR_FAMILY(addr
, step
) == AF_INET
);
320 a
.s_addr
= htonl(addr
->addresses
[0]);
321 strncpy(buf
, inet_ntoa(a
), buflen
);
322 buf
[buflen
-1] = '\0';
327 int sk_hostname_is_local(char *name
)
329 return !strcmp(name
, "localhost");
332 #define ipv4_is_loopback(addr) \
333 (((addr).s_addr & htonl(0xff000000)) == htonl(0x7f000000))
335 static int sockaddr_is_loopback(struct sockaddr
*sa
)
337 struct sockaddr_in
*sin
;
339 struct sockaddr_in6
*sin6
;
342 switch (sa
->sa_family
) {
344 sin
= (struct sockaddr_in
*)sa
;
345 return ipv4_is_loopback(sin
->sin_addr
);
348 sin6
= (struct sockaddr_in6
*)sa
;
349 return IN6_IS_ADDR_LOOPBACK(&sin6
->sin6_addr
);
358 int sk_address_is_local(SockAddr addr
)
361 if (addr
->superfamily
== UNRESOLVED
)
362 return 0; /* we don't know; assume not */
365 return sockaddr_is_loopback(addr
->ais
->ai_addr
);
369 START_STEP(addr
, step
);
370 assert(SOCKADDR_FAMILY(addr
, step
) == AF_INET
);
371 a
.s_addr
= htonl(addr
->addresses
[0]);
372 return ipv4_is_loopback(a
);
377 int sk_addrtype(SockAddr addr
)
381 START_STEP(addr
, step
);
382 family
= SOCKADDR_FAMILY(addr
, step
);
384 return (family
== AF_INET ? ADDRTYPE_IPV4
:
386 family
== AF_INET6 ? ADDRTYPE_IPV6
:
391 void sk_addrcopy(SockAddr addr
, char *buf
)
395 START_STEP(addr
, step
);
396 family
= SOCKADDR_FAMILY(addr
, step
);
399 if (family
== AF_INET
)
400 memcpy(buf
, &((struct sockaddr_in
*)step
.ai
->ai_addr
)->sin_addr
,
401 sizeof(struct in_addr
));
402 else if (family
== AF_INET6
)
403 memcpy(buf
, &((struct sockaddr_in6
*)step
.ai
->ai_addr
)->sin6_addr
,
404 sizeof(struct in6_addr
));
410 assert(family
== AF_INET
);
411 a
.s_addr
= htonl(addr
->addresses
[step
.curraddr
]);
412 memcpy(buf
, (char*) &a
.s_addr
, 4);
416 void sk_addr_free(SockAddr addr
)
418 if (--addr
->refcount
> 0)
421 if (addr
->ais
!= NULL
)
422 freeaddrinfo(addr
->ais
);
424 sfree(addr
->addresses
);
429 SockAddr
sk_addr_dup(SockAddr addr
)
435 static Plug
sk_tcp_plug(Socket sock
, Plug p
)
437 Actual_Socket s
= (Actual_Socket
) sock
;
444 static void sk_tcp_flush(Socket s
)
447 * We send data to the socket as soon as we can anyway,
448 * so we don't need to do anything here. :-)
452 static void sk_tcp_close(Socket s
);
453 static int sk_tcp_write(Socket s
, const char *data
, int len
);
454 static int sk_tcp_write_oob(Socket s
, const char *data
, int len
);
455 static void sk_tcp_set_private_ptr(Socket s
, void *ptr
);
456 static void *sk_tcp_get_private_ptr(Socket s
);
457 static void sk_tcp_set_frozen(Socket s
, int is_frozen
);
458 static const char *sk_tcp_socket_error(Socket s
);
460 static struct socket_function_table tcp_fn_table
= {
466 sk_tcp_set_private_ptr
,
467 sk_tcp_get_private_ptr
,
472 Socket
sk_register(OSSocket sockfd
, Plug plug
)
477 * Create Socket structure.
479 ret
= snew(struct Socket_tag
);
480 ret
->fn
= &tcp_fn_table
;
483 bufchain_init(&ret
->output_data
);
484 ret
->writable
= 1; /* to start with */
485 ret
->sending_oob
= 0;
487 ret
->frozen_readable
= 0;
488 ret
->localhost_only
= 0; /* unused, but best init anyway */
489 ret
->pending_error
= 0;
490 ret
->oobpending
= FALSE
;
492 ret
->parent
= ret
->child
= NULL
;
499 ret
->error
= strerror(errno
);
511 static int try_connect(Actual_Socket sock
)
515 struct sockaddr_in6 a6
;
517 struct sockaddr_in a
;
518 struct sockaddr_un au
;
519 const struct sockaddr
*sa
;
522 int fl
, salen
, family
;
525 * Remove the socket from the tree before we overwrite its
526 * internal socket id, because that forms part of the tree's
527 * sorting criterion. We'll add it back before exiting this
528 * function, whether we changed anything or not.
530 del234(sktree
, sock
);
535 plug_log(sock
->plug
, 0, sock
->addr
, sock
->port
, NULL
, 0);
540 family
= SOCKADDR_FAMILY(sock
->addr
, sock
->step
);
541 assert(family
!= AF_UNSPEC
);
542 s
= socket(family
, SOCK_STREAM
, 0);
552 if (sock
->oobinline
) {
554 setsockopt(s
, SOL_SOCKET
, SO_OOBINLINE
, (void *) &b
, sizeof(b
));
559 setsockopt(s
, IPPROTO_TCP
, TCP_NODELAY
, (void *) &b
, sizeof(b
));
562 if (sock
->keepalive
) {
564 setsockopt(s
, SOL_SOCKET
, SO_KEEPALIVE
, (void *) &b
, sizeof(b
));
568 * Bind to local address.
571 localport
= 1023; /* count from 1023 downwards */
573 localport
= 0; /* just use port 0 (ie kernel picks) */
575 /* BSD IP stacks need sockaddr_in zeroed before filling in */
576 memset(&a
,'\0',sizeof(struct sockaddr_in
));
578 memset(&a6
,'\0',sizeof(struct sockaddr_in6
));
581 /* We don't try to bind to a local address for UNIX domain sockets. (Why
582 * do we bother doing the bind when localport == 0 anyway?) */
583 if (family
!= AF_UNIX
) {
584 /* Loop round trying to bind */
589 if (family
== AF_INET6
) {
590 /* XXX use getaddrinfo to get a local address? */
591 a6
.sin6_family
= AF_INET6
;
592 a6
.sin6_addr
= in6addr_any
;
593 a6
.sin6_port
= htons(localport
);
594 retcode
= bind(s
, (struct sockaddr
*) &a6
, sizeof(a6
));
598 assert(family
== AF_INET
);
599 a
.sin_family
= AF_INET
;
600 a
.sin_addr
.s_addr
= htonl(INADDR_ANY
);
601 a
.sin_port
= htons(localport
);
602 retcode
= bind(s
, (struct sockaddr
*) &a
, sizeof(a
));
609 if (err
!= EADDRINUSE
) /* failed, for a bad reason */
614 break; /* we're only looping once */
617 break; /* we might have got to the end */
625 * Connect to remote address.
630 /* XXX would be better to have got getaddrinfo() to fill in the port. */
631 ((struct sockaddr_in
*)sock
->step
.ai
->ai_addr
)->sin_port
=
633 sa
= (const struct sockaddr
*)sock
->step
.ai
->ai_addr
;
634 salen
= sock
->step
.ai
->ai_addrlen
;
637 ((struct sockaddr_in
*)sock
->step
.ai
->ai_addr
)->sin_port
=
639 sa
= (const struct sockaddr
*)sock
->step
.ai
->ai_addr
;
640 salen
= sock
->step
.ai
->ai_addrlen
;
644 a
.sin_family
= AF_INET
;
645 a
.sin_addr
.s_addr
= htonl(sock
->addr
->addresses
[sock
->step
.curraddr
]);
646 a
.sin_port
= htons((short) sock
->port
);
647 sa
= (const struct sockaddr
*)&a
;
652 assert(sock
->port
== 0); /* to catch confused people */
653 assert(strlen(sock
->addr
->hostname
) < sizeof au
.sun_path
);
654 memset(&au
, 0, sizeof au
);
655 au
.sun_family
= AF_UNIX
;
656 strcpy(au
.sun_path
, sock
->addr
->hostname
);
657 sa
= (const struct sockaddr
*)&au
;
662 assert(0 && "unknown address family");
663 exit(1); /* XXX: GCC doesn't understand assert() on some systems. */
666 fl
= fcntl(s
, F_GETFL
);
668 fcntl(s
, F_SETFL
, fl
| O_NONBLOCK
);
670 if ((connect(s
, sa
, salen
)) < 0) {
671 if ( errno
!= EINPROGRESS
) {
677 * If we _don't_ get EWOULDBLOCK, the connect has completed
678 * and we should set the socket as connected and writable.
689 * No matter what happened, put the socket back in the tree.
691 add234(sktree
, sock
);
694 plug_log(sock
->plug
, 1, sock
->addr
, sock
->port
, strerror(err
), err
);
698 Socket
sk_new(SockAddr addr
, int port
, int privport
, int oobinline
,
699 int nodelay
, int keepalive
, Plug plug
)
705 * Create Socket structure.
707 ret
= snew(struct Socket_tag
);
708 ret
->fn
= &tcp_fn_table
;
711 bufchain_init(&ret
->output_data
);
712 ret
->connected
= 0; /* to start with */
713 ret
->writable
= 0; /* to start with */
714 ret
->sending_oob
= 0;
716 ret
->frozen_readable
= 0;
717 ret
->localhost_only
= 0; /* unused, but best init anyway */
718 ret
->pending_error
= 0;
719 ret
->parent
= ret
->child
= NULL
;
720 ret
->oobpending
= FALSE
;
723 START_STEP(ret
->addr
, ret
->step
);
725 ret
->oobinline
= oobinline
;
726 ret
->nodelay
= nodelay
;
727 ret
->keepalive
= keepalive
;
728 ret
->privport
= privport
;
733 err
= try_connect(ret
);
734 } while (err
&& sk_nextaddr(ret
->addr
, &ret
->step
));
737 ret
->error
= strerror(err
);
742 Socket
sk_newlistener(char *srcaddr
, int port
, Plug plug
, int local_host_only
, int orig_address_family
)
746 struct addrinfo hints
, *ai
;
748 struct sockaddr_in6 a6
;
750 struct sockaddr
*addr
;
752 struct sockaddr_in a
;
759 * Create Socket structure.
761 ret
= snew(struct Socket_tag
);
762 ret
->fn
= &tcp_fn_table
;
765 bufchain_init(&ret
->output_data
);
766 ret
->writable
= 0; /* to start with */
767 ret
->sending_oob
= 0;
769 ret
->frozen_readable
= 0;
770 ret
->localhost_only
= local_host_only
;
771 ret
->pending_error
= 0;
772 ret
->parent
= ret
->child
= NULL
;
773 ret
->oobpending
= FALSE
;
778 * Translate address_family from platform-independent constants
779 * into local reality.
781 address_family
= (orig_address_family
== ADDRTYPE_IPV4 ? AF_INET
:
783 orig_address_family
== ADDRTYPE_IPV6 ? AF_INET6
:
788 /* Let's default to IPv6.
789 * If the stack doesn't support IPv6, we will fall back to IPv4. */
790 if (address_family
== AF_UNSPEC
) address_family
= AF_INET6
;
792 /* No other choice, default to IPv4 */
793 if (address_family
== AF_UNSPEC
) address_family
= AF_INET
;
799 s
= socket(address_family
, SOCK_STREAM
, 0);
802 /* If the host doesn't support IPv6 try fallback to IPv4. */
803 if (s
< 0 && address_family
== AF_INET6
) {
804 address_family
= AF_INET
;
805 s
= socket(address_family
, SOCK_STREAM
, 0);
810 ret
->error
= strerror(errno
);
818 setsockopt(s
, SOL_SOCKET
, SO_REUSEADDR
, (const char *)&on
, sizeof(on
));
821 addr
= NULL
; addrlen
= -1; /* placate optimiser */
823 if (srcaddr
!= NULL
) {
825 hints
.ai_flags
= AI_NUMERICHOST
;
826 hints
.ai_family
= address_family
;
827 hints
.ai_socktype
= SOCK_STREAM
;
828 hints
.ai_protocol
= 0;
829 hints
.ai_addrlen
= 0;
830 hints
.ai_addr
= NULL
;
831 hints
.ai_canonname
= NULL
;
832 hints
.ai_next
= NULL
;
833 assert(port
>= 0 && port
<= 99999);
834 sprintf(portstr
, "%d", port
);
835 retcode
= getaddrinfo(srcaddr
, portstr
, &hints
, &ai
);
838 addrlen
= ai
->ai_addrlen
;
841 memset(&a
,'\0',sizeof(struct sockaddr_in
));
842 a
.sin_family
= AF_INET
;
843 a
.sin_port
= htons(port
);
844 a
.sin_addr
.s_addr
= inet_addr(srcaddr
);
845 if (a
.sin_addr
.s_addr
!= (in_addr_t
)(-1)) {
846 /* Override localhost_only with specified listen addr. */
847 ret
->localhost_only
= ipv4_is_loopback(a
.sin_addr
);
849 addr
= (struct sockaddr
*)&a
;
857 if (address_family
== AF_INET6
) {
858 memset(&a6
,'\0',sizeof(struct sockaddr_in6
));
859 a6
.sin6_family
= AF_INET6
;
860 a6
.sin6_port
= htons(port
);
862 a6
.sin6_addr
= in6addr_loopback
;
864 a6
.sin6_addr
= in6addr_any
;
865 addr
= (struct sockaddr
*)&a6
;
866 addrlen
= sizeof(a6
);
870 memset(&a
,'\0',sizeof(struct sockaddr_in
));
871 a
.sin_family
= AF_INET
;
872 a
.sin_port
= htons(port
);
874 a
.sin_addr
.s_addr
= htonl(INADDR_LOOPBACK
);
876 a
.sin_addr
.s_addr
= htonl(INADDR_ANY
);
877 addr
= (struct sockaddr
*)&a
;
882 retcode
= bind(s
, addr
, addrlen
);
885 ret
->error
= strerror(errno
);
889 if (listen(s
, SOMAXCONN
) < 0) {
891 ret
->error
= strerror(errno
);
897 * If we were given ADDRTYPE_UNSPEC, we must also create an
898 * IPv4 listening socket and link it to this one.
900 if (address_family
== AF_INET6
&& orig_address_family
== ADDRTYPE_UNSPEC
) {
903 other
= (Actual_Socket
) sk_newlistener(srcaddr
, port
, plug
,
904 local_host_only
, ADDRTYPE_IPV4
);
911 /* If we couldn't create a listening socket on IPv4 as well
912 * as IPv6, we must return an error overall. */
915 return (Socket
) other
;
929 static void sk_tcp_close(Socket sock
)
931 Actual_Socket s
= (Actual_Socket
) sock
;
934 sk_tcp_close((Socket
)s
->child
);
940 sk_addr_free(s
->addr
);
944 void *sk_getxdmdata(void *sock
, int *lenp
)
946 Actual_Socket s
= (Actual_Socket
) sock
;
948 struct sockaddr_in addr
;
950 struct sockaddr_storage addr
;
951 struct sockaddr_in6
*sin6
= (struct sockaddr_in6
*)&addr
;
953 struct sockaddr
*sa
= (struct sockaddr
*)&addr
;
954 struct sockaddr_in
*sin
= (struct sockaddr_in
*)&addr
;
957 static unsigned int unix_addr
= 0xFFFFFFFF;
960 * We must check that this socket really _is_ an Actual_Socket.
962 if (s
->fn
!= &tcp_fn_table
)
963 return NULL
; /* failure */
965 addrlen
= sizeof(addr
);
966 if (getsockname(s
->s
, sa
, &addrlen
) < 0)
968 switch(sa
->sa_family
) {
971 buf
= snewn(*lenp
, char);
972 PUT_32BIT_MSB_FIRST(buf
, ntohl(sin
->sin_addr
.s_addr
));
973 PUT_16BIT_MSB_FIRST(buf
+4, ntohs(sin
->sin_port
));
978 buf
= snewn(*lenp
, char);
979 if (IN6_IS_ADDR_V4MAPPED(&sin6
->sin6_addr
)) {
980 memcpy(buf
, sin6
->sin6_addr
.s6_addr
+ 12, 4);
981 PUT_16BIT_MSB_FIRST(buf
+4, ntohs(sin6
->sin6_port
));
983 /* This is stupid, but it's what XLib does. */
989 buf
= snewn(*lenp
, char);
990 PUT_32BIT_MSB_FIRST(buf
, unix_addr
--);
991 PUT_16BIT_MSB_FIRST(buf
+4, getpid());
1004 * The function which tries to send on a socket once it's deemed
1007 void try_send(Actual_Socket s
)
1009 while (s
->sending_oob
|| bufchain_size(&s
->output_data
) > 0) {
1013 int len
, urgentflag
;
1015 if (s
->sending_oob
) {
1016 urgentflag
= MSG_OOB
;
1017 len
= s
->sending_oob
;
1021 bufchain_prefix(&s
->output_data
, &data
, &len
);
1023 nsent
= send(s
->s
, data
, len
, urgentflag
);
1024 noise_ultralight(nsent
);
1026 err
= (nsent
< 0 ? errno
: 0);
1027 if (err
== EWOULDBLOCK
) {
1029 * Perfectly normal: we've sent all we can for the moment.
1031 s
->writable
= FALSE
;
1035 * We unfortunately can't just call plug_closing(),
1036 * because it's quite likely that we're currently
1037 * _in_ a call from the code we'd be calling back
1038 * to, so we'd have to make half the SSH code
1039 * reentrant. Instead we flag a pending error on
1040 * the socket, to be dealt with (by calling
1041 * plug_closing()) at some suitable future moment.
1043 s
->pending_error
= err
;
1047 if (s
->sending_oob
) {
1049 memmove(s
->oobdata
, s
->oobdata
+nsent
, len
-nsent
);
1050 s
->sending_oob
= len
- nsent
;
1055 bufchain_consume(&s
->output_data
, nsent
);
1062 static int sk_tcp_write(Socket sock
, const char *buf
, int len
)
1064 Actual_Socket s
= (Actual_Socket
) sock
;
1067 * Add the data to the buffer list on the socket.
1069 bufchain_add(&s
->output_data
, buf
, len
);
1072 * Now try sending from the start of the buffer list.
1078 * Update the select() status to correctly reflect whether or
1079 * not we should be selecting for write.
1083 return bufchain_size(&s
->output_data
);
1086 static int sk_tcp_write_oob(Socket sock
, const char *buf
, int len
)
1088 Actual_Socket s
= (Actual_Socket
) sock
;
1091 * Replace the buffer list on the socket with the data.
1093 bufchain_clear(&s
->output_data
);
1094 assert(len
<= sizeof(s
->oobdata
));
1095 memcpy(s
->oobdata
, buf
, len
);
1096 s
->sending_oob
= len
;
1099 * Now try sending from the start of the buffer list.
1105 * Update the select() status to correctly reflect whether or
1106 * not we should be selecting for write.
1110 return s
->sending_oob
;
1113 static int net_select_result(int fd
, int event
)
1116 char buf
[20480]; /* nice big buffer for plenty of speed */
1120 /* Find the Socket structure */
1121 s
= find234(sktree
, &fd
, cmpforsearch
);
1123 return 1; /* boggle */
1125 noise_ultralight(event
);
1128 case 4: /* exceptional */
1129 if (!s
->oobinline
) {
1131 * On a non-oobinline socket, this indicates that we
1132 * can immediately perform an OOB read and get back OOB
1133 * data, which we will send to the back end with
1134 * type==2 (urgent data).
1136 ret
= recv(s
->s
, buf
, sizeof(buf
), MSG_OOB
);
1137 noise_ultralight(ret
);
1139 return plug_closing(s
->plug
,
1140 ret
== 0 ?
"Internal networking trouble" :
1141 strerror(errno
), errno
, 0);
1144 * Receiving actual data on a socket means we can
1145 * stop falling back through the candidate
1146 * addresses to connect to.
1149 sk_addr_free(s
->addr
);
1152 return plug_receive(s
->plug
, 2, buf
, ret
);
1158 * If we reach here, this is an oobinline socket, which
1159 * means we should set s->oobpending and then deal with it
1160 * when we get called for the readability event (which
1161 * should also occur).
1163 s
->oobpending
= TRUE
;
1165 case 1: /* readable; also acceptance */
1168 * On a listening socket, the readability event means a
1169 * connection is ready to be accepted.
1172 struct sockaddr_in ss
;
1174 struct sockaddr_storage ss
;
1176 socklen_t addrlen
= sizeof(ss
);
1177 int t
; /* socket of connection */
1180 memset(&ss
, 0, addrlen
);
1181 t
= accept(s
->s
, (struct sockaddr
*)&ss
, &addrlen
);
1186 fl
= fcntl(t
, F_GETFL
);
1188 fcntl(t
, F_SETFL
, fl
| O_NONBLOCK
);
1190 if (s
->localhost_only
&&
1191 !sockaddr_is_loopback((struct sockaddr
*)&ss
)) {
1192 close(t
); /* someone let nonlocal through?! */
1193 } else if (plug_accepting(s
->plug
, t
)) {
1194 close(t
); /* denied or error */
1200 * If we reach here, this is not a listening socket, so
1201 * readability really means readability.
1204 /* In the case the socket is still frozen, we don't even bother */
1206 s
->frozen_readable
= 1;
1211 * We have received data on the socket. For an oobinline
1212 * socket, this might be data _before_ an urgent pointer,
1213 * in which case we send it to the back end with type==1
1214 * (data prior to urgent).
1216 if (s
->oobinline
&& s
->oobpending
) {
1218 if (ioctl(s
->s
, SIOCATMARK
, &atmark
) == 0 && atmark
)
1219 s
->oobpending
= FALSE
; /* clear this indicator */
1223 ret
= recv(s
->s
, buf
, s
->oobpending ?
1 : sizeof(buf
), 0);
1224 noise_ultralight(ret
);
1226 if (errno
== EWOULDBLOCK
) {
1232 * An error at this point _might_ be an error reported
1233 * by a non-blocking connect(). So before we return a
1234 * panic status to the user, let's just see whether
1239 plug_log(s
->plug
, 1, s
->addr
, s
->port
, strerror(err
), err
);
1240 while (s
->addr
&& sk_nextaddr(s
->addr
, &s
->step
)) {
1241 err
= try_connect(s
);
1245 return plug_closing(s
->plug
, strerror(err
), err
, 0);
1246 } else if (0 == ret
) {
1247 return plug_closing(s
->plug
, NULL
, 0, 0);
1250 * Receiving actual data on a socket means we can
1251 * stop falling back through the candidate
1252 * addresses to connect to.
1255 sk_addr_free(s
->addr
);
1258 return plug_receive(s
->plug
, atmark ?
0 : 1, buf
, ret
);
1261 case 2: /* writable */
1262 if (!s
->connected
) {
1264 * select() reports a socket as _writable_ when an
1265 * asynchronous connection is completed.
1267 s
->connected
= s
->writable
= 1;
1271 int bufsize_before
, bufsize_after
;
1273 bufsize_before
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1275 bufsize_after
= s
->sending_oob
+ bufchain_size(&s
->output_data
);
1276 if (bufsize_after
< bufsize_before
)
1277 plug_sent(s
->plug
, bufsize_after
);
1286 * Deal with socket errors detected in try_send().
1288 void net_pending_errors(void)
1294 * This might be a fiddly business, because it's just possible
1295 * that handling a pending error on one socket might cause
1296 * others to be closed. (I can't think of any reason this might
1297 * happen in current SSH implementation, but to maintain
1298 * generality of this network layer I'll assume the worst.)
1300 * So what we'll do is search the socket list for _one_ socket
1301 * with a pending error, and then handle it, and then search
1302 * the list again _from the beginning_. Repeat until we make a
1303 * pass with no socket errors present. That way we are
1304 * protected against the socket list changing under our feet.
1308 for (i
= 0; (s
= index234(sktree
, i
)) != NULL
; i
++) {
1309 if (s
->pending_error
) {
1311 * An error has occurred on this socket. Pass it to the
1314 plug_closing(s
->plug
, strerror(s
->pending_error
),
1315 s
->pending_error
, 0);
1323 * Each socket abstraction contains a `void *' private field in
1324 * which the client can keep state.
1326 static void sk_tcp_set_private_ptr(Socket sock
, void *ptr
)
1328 Actual_Socket s
= (Actual_Socket
) sock
;
1329 s
->private_ptr
= ptr
;
1332 static void *sk_tcp_get_private_ptr(Socket sock
)
1334 Actual_Socket s
= (Actual_Socket
) sock
;
1335 return s
->private_ptr
;
1339 * Special error values are returned from sk_namelookup and sk_new
1340 * if there's a problem. These functions extract an error message,
1341 * or return NULL if there's no problem.
1343 const char *sk_addr_error(SockAddr addr
)
1347 static const char *sk_tcp_socket_error(Socket sock
)
1349 Actual_Socket s
= (Actual_Socket
) sock
;
1353 static void sk_tcp_set_frozen(Socket sock
, int is_frozen
)
1355 Actual_Socket s
= (Actual_Socket
) sock
;
1356 if (s
->frozen
== is_frozen
)
1358 s
->frozen
= is_frozen
;
1359 if (!is_frozen
&& s
->frozen_readable
) {
1361 recv(s
->s
, &c
, 1, MSG_PEEK
);
1363 s
->frozen_readable
= 0;
1367 static void uxsel_tell(Actual_Socket s
)
1371 rwx
|= 1; /* read == accept */
1374 rwx
|= 2; /* write == connect */
1375 if (s
->connected
&& !s
->frozen
)
1376 rwx
|= 1 | 4; /* read, except */
1377 if (bufchain_size(&s
->output_data
))
1378 rwx
|= 2; /* write */
1380 uxsel_set(s
->s
, rwx
, net_select_result
);
1383 int net_service_lookup(char *service
)
1386 se
= getservbyname(service
, NULL
);
1388 return ntohs(se
->s_port
);
1393 SockAddr
platform_get_x11_unix_address(const char *sockpath
, int displaynum
)
1395 SockAddr ret
= snew(struct SockAddr_tag
);
1398 memset(ret
, 0, sizeof *ret
);
1399 ret
->superfamily
= UNIX
;
1401 * In special circumstances (notably Mac OS X Leopard), we'll
1402 * have been passed an explicit Unix socket path.
1405 n
= snprintf(ret
->hostname
, sizeof ret
->hostname
,
1408 n
= snprintf(ret
->hostname
, sizeof ret
->hostname
,
1409 "%s%d", X11_UNIX_PATH
, displaynum
);
1413 ret
->error
= "snprintf failed";
1414 else if (n
>= sizeof ret
->hostname
)
1415 ret
->error
= "X11 UNIX name too long";
1420 ret
->addresses
= NULL
;
1421 ret
->naddresses
= 0;