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 localhost_only; /* for listening sockets */
86 int oobpending; /* is there OOB data available to read? */
88 enum { EOF_NO, EOF_PENDING, EOF_SENT } outgoingeof;
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 if (addr->superfamily == UNRESOLVED || addr->superfamily == UNIX) {
320 strncpy(buf, addr->hostname, buflen);
321 buf[buflen-1] = '\0';
324 if (getnameinfo(addr->ais->ai_addr, addr->ais->ai_addrlen, buf, buflen,
325 NULL, 0, NI_NUMERICHOST) != 0) {
327 strncat(buf, "<unknown>", buflen - 1);
332 START_STEP(addr, step);
333 assert(SOCKADDR_FAMILY(addr, step) == AF_INET);
334 a.s_addr = htonl(addr->addresses[0]);
335 strncpy(buf, inet_ntoa(a), buflen);
336 buf[buflen-1] = '\0';
341 int sk_hostname_is_local(const char *name)
343 return !strcmp(name, "localhost") ||
344 !strcmp(name, "::1") ||
345 !strncmp(name, "127.", 4);
348 #define ipv4_is_loopback(addr) \
349 (((addr).s_addr & htonl(0xff000000)) == htonl(0x7f000000))
351 static int sockaddr_is_loopback(struct sockaddr *sa)
353 union sockaddr_union *u = (union sockaddr_union *)sa;
354 switch (u->sa.sa_family) {
356 return ipv4_is_loopback(u->sin.sin_addr);
359 return IN6_IS_ADDR_LOOPBACK(&u->sin6.sin6_addr);
368 int sk_address_is_local(SockAddr addr)
370 if (addr->superfamily == UNRESOLVED)
371 return 0; /* we don't know; assume not */
372 else if (addr->superfamily == UNIX)
376 return sockaddr_is_loopback(addr->ais->ai_addr);
380 START_STEP(addr, step);
381 assert(SOCKADDR_FAMILY(addr, step) == AF_INET);
382 a.s_addr = htonl(addr->addresses[0]);
383 return ipv4_is_loopback(a);
388 int sk_address_is_special_local(SockAddr addr)
390 return addr->superfamily == UNIX;
393 int sk_addrtype(SockAddr addr)
397 START_STEP(addr, step);
398 family = SOCKADDR_FAMILY(addr, step);
400 return (family == AF_INET ? ADDRTYPE_IPV4 :
402 family == AF_INET6 ? ADDRTYPE_IPV6 :
407 void sk_addrcopy(SockAddr addr, char *buf)
411 START_STEP(addr, step);
412 family = SOCKADDR_FAMILY(addr, step);
415 if (family == AF_INET)
416 memcpy(buf, &((struct sockaddr_in *)step.ai->ai_addr)->sin_addr,
417 sizeof(struct in_addr));
418 else if (family == AF_INET6)
419 memcpy(buf, &((struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr,
420 sizeof(struct in6_addr));
426 assert(family == AF_INET);
427 a.s_addr = htonl(addr->addresses[step.curraddr]);
428 memcpy(buf, (char*) &a.s_addr, 4);
432 void sk_addr_free(SockAddr addr)
434 if (--addr->refcount > 0)
437 if (addr->ais != NULL)
438 freeaddrinfo(addr->ais);
440 sfree(addr->addresses);
445 SockAddr sk_addr_dup(SockAddr addr)
451 static Plug sk_tcp_plug(Socket sock, Plug p)
453 Actual_Socket s = (Actual_Socket) sock;
460 static void sk_tcp_flush(Socket s)
463 * We send data to the socket as soon as we can anyway,
464 * so we don't need to do anything here. :-)
468 static void sk_tcp_close(Socket s);
469 static int sk_tcp_write(Socket s, const char *data, int len);
470 static int sk_tcp_write_oob(Socket s, const char *data, int len);
471 static void sk_tcp_write_eof(Socket s);
472 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
473 static void *sk_tcp_get_private_ptr(Socket s);
474 static void sk_tcp_set_frozen(Socket s, int is_frozen);
475 static const char *sk_tcp_socket_error(Socket s);
477 static struct socket_function_table tcp_fn_table = {
484 sk_tcp_set_private_ptr,
485 sk_tcp_get_private_ptr,
490 static Socket sk_tcp_accept(accept_ctx_t ctx, Plug plug)
496 * Create Socket structure.
498 ret = snew(struct Socket_tag);
499 ret->fn = &tcp_fn_table;
502 bufchain_init(&ret->output_data);
503 ret->writable = 1; /* to start with */
504 ret->sending_oob = 0;
506 ret->localhost_only = 0; /* unused, but best init anyway */
507 ret->pending_error = 0;
508 ret->oobpending = FALSE;
509 ret->outgoingeof = EOF_NO;
510 ret->incomingeof = FALSE;
512 ret->parent = ret->child = NULL;
519 ret->error = strerror(errno);
531 static int try_connect(Actual_Socket sock)
534 union sockaddr_union u;
535 const union sockaddr_union *sa;
541 * Remove the socket from the tree before we overwrite its
542 * internal socket id, because that forms part of the tree's
543 * sorting criterion. We'll add it back before exiting this
544 * function, whether we changed anything or not.
546 del234(sktree, sock);
551 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
556 family = SOCKADDR_FAMILY(sock->addr, sock->step);
557 assert(family != AF_UNSPEC);
558 s = socket(family, SOCK_STREAM, 0);
568 if (sock->oobinline) {
570 if (setsockopt(s, SOL_SOCKET, SO_OOBINLINE,
571 (void *) &b, sizeof(b)) < 0) {
580 if (setsockopt(s, IPPROTO_TCP, TCP_NODELAY,
581 (void *) &b, sizeof(b)) < 0) {
588 if (sock->keepalive) {
590 if (setsockopt(s, SOL_SOCKET, SO_KEEPALIVE,
591 (void *) &b, sizeof(b)) < 0) {
599 * Bind to local address.
602 localport = 1023; /* count from 1023 downwards */
604 localport = 0; /* just use port 0 (ie kernel picks) */
606 /* BSD IP stacks need sockaddr_in zeroed before filling in */
607 memset(&u,'\0',sizeof(u));
609 /* We don't try to bind to a local address for UNIX domain sockets. (Why
610 * do we bother doing the bind when localport == 0 anyway?) */
611 if (family != AF_UNIX) {
612 /* Loop round trying to bind */
617 if (family == AF_INET6) {
618 /* XXX use getaddrinfo to get a local address? */
619 u.sin6.sin6_family = AF_INET6;
620 u.sin6.sin6_addr = in6addr_any;
621 u.sin6.sin6_port = htons(localport);
622 retcode = bind(s, &u.sa, sizeof(u.sin6));
626 assert(family == AF_INET);
627 u.sin.sin_family = AF_INET;
628 u.sin.sin_addr.s_addr = htonl(INADDR_ANY);
629 u.sin.sin_port = htons(localport);
630 retcode = bind(s, &u.sa, sizeof(u.sin));
637 if (err != EADDRINUSE) /* failed, for a bad reason */
642 break; /* we're only looping once */
645 break; /* we might have got to the end */
653 * Connect to remote address.
658 /* XXX would be better to have got getaddrinfo() to fill in the port. */
659 ((struct sockaddr_in *)sock->step.ai->ai_addr)->sin_port =
661 sa = (const union sockaddr_union *)sock->step.ai->ai_addr;
662 salen = sock->step.ai->ai_addrlen;
665 ((struct sockaddr_in *)sock->step.ai->ai_addr)->sin_port =
667 sa = (const union sockaddr_union *)sock->step.ai->ai_addr;
668 salen = sock->step.ai->ai_addrlen;
672 u.sin.sin_family = AF_INET;
673 u.sin.sin_addr.s_addr = htonl(sock->addr->addresses[sock->step.curraddr]);
674 u.sin.sin_port = htons((short) sock->port);
676 salen = sizeof u.sin;
680 assert(sock->port == 0); /* to catch confused people */
681 assert(strlen(sock->addr->hostname) < sizeof u.su.sun_path);
682 u.su.sun_family = AF_UNIX;
683 strcpy(u.su.sun_path, sock->addr->hostname);
689 assert(0 && "unknown address family");
690 exit(1); /* XXX: GCC doesn't understand assert() on some systems. */
695 if ((connect(s, &(sa->sa), salen)) < 0) {
696 if ( errno != EINPROGRESS ) {
702 * If we _don't_ get EWOULDBLOCK, the connect has completed
703 * and we should set the socket as connected and writable.
714 * No matter what happened, put the socket back in the tree.
716 add234(sktree, sock);
719 plug_log(sock->plug, 1, sock->addr, sock->port, strerror(err), err);
723 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
724 int nodelay, int keepalive, Plug plug)
730 * Create Socket structure.
732 ret = snew(struct Socket_tag);
733 ret->fn = &tcp_fn_table;
736 bufchain_init(&ret->output_data);
737 ret->connected = 0; /* to start with */
738 ret->writable = 0; /* to start with */
739 ret->sending_oob = 0;
741 ret->localhost_only = 0; /* unused, but best init anyway */
742 ret->pending_error = 0;
743 ret->parent = ret->child = NULL;
744 ret->oobpending = FALSE;
745 ret->outgoingeof = EOF_NO;
746 ret->incomingeof = FALSE;
749 START_STEP(ret->addr, ret->step);
751 ret->oobinline = oobinline;
752 ret->nodelay = nodelay;
753 ret->keepalive = keepalive;
754 ret->privport = privport;
759 err = try_connect(ret);
760 } while (err && sk_nextaddr(ret->addr, &ret->step));
763 ret->error = strerror(err);
768 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int orig_address_family)
772 struct addrinfo hints, *ai;
775 union sockaddr_union u;
776 union sockaddr_union *addr;
784 * Create Socket structure.
786 ret = snew(struct Socket_tag);
787 ret->fn = &tcp_fn_table;
790 bufchain_init(&ret->output_data);
791 ret->writable = 0; /* to start with */
792 ret->sending_oob = 0;
794 ret->localhost_only = local_host_only;
795 ret->pending_error = 0;
796 ret->parent = ret->child = NULL;
797 ret->oobpending = FALSE;
798 ret->outgoingeof = EOF_NO;
799 ret->incomingeof = FALSE;
804 * Translate address_family from platform-independent constants
805 * into local reality.
807 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
809 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
814 /* Let's default to IPv6.
815 * If the stack doesn't support IPv6, we will fall back to IPv4. */
816 if (address_family == AF_UNSPEC) address_family = AF_INET6;
818 /* No other choice, default to IPv4 */
819 if (address_family == AF_UNSPEC) address_family = AF_INET;
825 s = socket(address_family, SOCK_STREAM, 0);
828 /* If the host doesn't support IPv6 try fallback to IPv4. */
829 if (s < 0 && address_family == AF_INET6) {
830 address_family = AF_INET;
831 s = socket(address_family, SOCK_STREAM, 0);
836 ret->error = strerror(errno);
844 if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
845 (const char *)&on, sizeof(on)) < 0) {
846 ret->error = strerror(errno);
852 addr = NULL; addrlen = -1; /* placate optimiser */
854 if (srcaddr != NULL) {
856 hints.ai_flags = AI_NUMERICHOST;
857 hints.ai_family = address_family;
858 hints.ai_socktype = SOCK_STREAM;
859 hints.ai_protocol = 0;
860 hints.ai_addrlen = 0;
861 hints.ai_addr = NULL;
862 hints.ai_canonname = NULL;
863 hints.ai_next = NULL;
864 assert(port >= 0 && port <= 99999);
865 sprintf(portstr, "%d", port);
866 retcode = getaddrinfo(srcaddr, portstr, &hints, &ai);
868 addr = (union sockaddr_union *)ai->ai_addr;
869 addrlen = ai->ai_addrlen;
872 memset(&u,'\0',sizeof u);
873 u.sin.sin_family = AF_INET;
874 u.sin.sin_port = htons(port);
875 u.sin.sin_addr.s_addr = inet_addr(srcaddr);
876 if (u.sin.sin_addr.s_addr != (in_addr_t)(-1)) {
877 /* Override localhost_only with specified listen addr. */
878 ret->localhost_only = ipv4_is_loopback(u.sin.sin_addr);
881 addrlen = sizeof(u.sin);
887 memset(&u,'\0',sizeof u);
889 if (address_family == AF_INET6) {
890 u.sin6.sin6_family = AF_INET6;
891 u.sin6.sin6_port = htons(port);
893 u.sin6.sin6_addr = in6addr_loopback;
895 u.sin6.sin6_addr = in6addr_any;
897 addrlen = sizeof(u.sin6);
901 u.sin.sin_family = AF_INET;
902 u.sin.sin_port = htons(port);
904 u.sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
906 u.sin.sin_addr.s_addr = htonl(INADDR_ANY);
908 addrlen = sizeof(u.sin);
912 retcode = bind(s, &addr->sa, addrlen);
915 ret->error = strerror(errno);
919 if (listen(s, SOMAXCONN) < 0) {
921 ret->error = strerror(errno);
927 * If we were given ADDRTYPE_UNSPEC, we must also create an
928 * IPv4 listening socket and link it to this one.
930 if (address_family == AF_INET6 && orig_address_family == ADDRTYPE_UNSPEC) {
933 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
934 local_host_only, ADDRTYPE_IPV4);
941 /* If we couldn't create a listening socket on IPv4 as well
942 * as IPv6, we must return an error overall. */
945 return (Socket) other;
959 static void sk_tcp_close(Socket sock)
961 Actual_Socket s = (Actual_Socket) sock;
964 sk_tcp_close((Socket)s->child);
970 sk_addr_free(s->addr);
974 void *sk_getxdmdata(void *sock, int *lenp)
976 Actual_Socket s = (Actual_Socket) sock;
977 union sockaddr_union u;
980 static unsigned int unix_addr = 0xFFFFFFFF;
983 * We must check that this socket really _is_ an Actual_Socket.
985 if (s->fn != &tcp_fn_table)
986 return NULL; /* failure */
989 if (getsockname(s->s, &u.sa, &addrlen) < 0)
991 switch(u.sa.sa_family) {
994 buf = snewn(*lenp, char);
995 PUT_32BIT_MSB_FIRST(buf, ntohl(u.sin.sin_addr.s_addr));
996 PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin.sin_port));
1001 buf = snewn(*lenp, char);
1002 if (IN6_IS_ADDR_V4MAPPED(&u.sin6.sin6_addr)) {
1003 memcpy(buf, u.sin6.sin6_addr.s6_addr + 12, 4);
1004 PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin6.sin6_port));
1006 /* This is stupid, but it's what XLib does. */
1012 buf = snewn(*lenp, char);
1013 PUT_32BIT_MSB_FIRST(buf, unix_addr--);
1014 PUT_16BIT_MSB_FIRST(buf+4, getpid());
1027 * Deal with socket errors detected in try_send().
1029 static void socket_error_callback(void *vs)
1031 Actual_Socket s = (Actual_Socket)vs;
1034 * Just in case other socket work has caused this socket to vanish
1035 * or become somehow non-erroneous before this callback arrived...
1037 if (!find234(sktree, s, NULL) || !s->pending_error)
1041 * An error has occurred on this socket. Pass it to the plug.
1043 plug_closing(s->plug, strerror(s->pending_error), s->pending_error, 0);
1047 * The function which tries to send on a socket once it's deemed
1050 void try_send(Actual_Socket s)
1052 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1056 int len, urgentflag;
1058 if (s->sending_oob) {
1059 urgentflag = MSG_OOB;
1060 len = s->sending_oob;
1064 bufchain_prefix(&s->output_data, &data, &len);
1066 nsent = send(s->s, data, len, urgentflag);
1067 noise_ultralight(nsent);
1069 err = (nsent < 0 ? errno : 0);
1070 if (err == EWOULDBLOCK) {
1072 * Perfectly normal: we've sent all we can for the moment.
1074 s->writable = FALSE;
1078 * We unfortunately can't just call plug_closing(),
1079 * because it's quite likely that we're currently
1080 * _in_ a call from the code we'd be calling back
1081 * to, so we'd have to make half the SSH code
1082 * reentrant. Instead we flag a pending error on
1083 * the socket, to be dealt with (by calling
1084 * plug_closing()) at some suitable future moment.
1086 s->pending_error = err;
1088 * Immediately cease selecting on this socket, so that
1089 * we don't tight-loop repeatedly trying to do
1090 * whatever it was that went wrong.
1094 * Arrange to be called back from the top level to
1095 * deal with the error condition on this socket.
1097 queue_toplevel_callback(socket_error_callback, s);
1101 if (s->sending_oob) {
1103 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1104 s->sending_oob = len - nsent;
1109 bufchain_consume(&s->output_data, nsent);
1115 * If we reach here, we've finished sending everything we might
1116 * have needed to send. Send EOF, if we need to.
1118 if (s->outgoingeof == EOF_PENDING) {
1119 shutdown(s->s, SHUT_WR);
1120 s->outgoingeof = EOF_SENT;
1124 * Also update the select status, because we don't need to select
1125 * for writing any more.
1130 static int sk_tcp_write(Socket sock, const char *buf, int len)
1132 Actual_Socket s = (Actual_Socket) sock;
1134 assert(s->outgoingeof == EOF_NO);
1137 * Add the data to the buffer list on the socket.
1139 bufchain_add(&s->output_data, buf, len);
1142 * Now try sending from the start of the buffer list.
1148 * Update the select() status to correctly reflect whether or
1149 * not we should be selecting for write.
1153 return bufchain_size(&s->output_data);
1156 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1158 Actual_Socket s = (Actual_Socket) sock;
1160 assert(s->outgoingeof == EOF_NO);
1163 * Replace the buffer list on the socket with the data.
1165 bufchain_clear(&s->output_data);
1166 assert(len <= sizeof(s->oobdata));
1167 memcpy(s->oobdata, buf, len);
1168 s->sending_oob = len;
1171 * Now try sending from the start of the buffer list.
1177 * Update the select() status to correctly reflect whether or
1178 * not we should be selecting for write.
1182 return s->sending_oob;
1185 static void sk_tcp_write_eof(Socket sock)
1187 Actual_Socket s = (Actual_Socket) sock;
1189 assert(s->outgoingeof == EOF_NO);
1192 * Mark the socket as pending outgoing EOF.
1194 s->outgoingeof = EOF_PENDING;
1197 * Now try sending from the start of the buffer list.
1203 * Update the select() status to correctly reflect whether or
1204 * not we should be selecting for write.
1209 static int net_select_result(int fd, int event)
1212 char buf[20480]; /* nice big buffer for plenty of speed */
1216 /* Find the Socket structure */
1217 s = find234(sktree, &fd, cmpforsearch);
1219 return 1; /* boggle */
1221 noise_ultralight(event);
1224 case 4: /* exceptional */
1225 if (!s->oobinline) {
1227 * On a non-oobinline socket, this indicates that we
1228 * can immediately perform an OOB read and get back OOB
1229 * data, which we will send to the back end with
1230 * type==2 (urgent data).
1232 ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
1233 noise_ultralight(ret);
1235 return plug_closing(s->plug,
1236 ret == 0 ? "Internal networking trouble" :
1237 strerror(errno), errno, 0);
1240 * Receiving actual data on a socket means we can
1241 * stop falling back through the candidate
1242 * addresses to connect to.
1245 sk_addr_free(s->addr);
1248 return plug_receive(s->plug, 2, buf, ret);
1254 * If we reach here, this is an oobinline socket, which
1255 * means we should set s->oobpending and then deal with it
1256 * when we get called for the readability event (which
1257 * should also occur).
1259 s->oobpending = TRUE;
1261 case 1: /* readable; also acceptance */
1264 * On a listening socket, the readability event means a
1265 * connection is ready to be accepted.
1267 union sockaddr_union su;
1268 socklen_t addrlen = sizeof(su);
1270 int t; /* socket of connection */
1272 memset(&su, 0, addrlen);
1273 t = accept(s->s, &su.sa, &addrlen);
1281 if ((!s->addr || s->addr->superfamily != UNIX) &&
1282 s->localhost_only && !sockaddr_is_loopback(&su.sa)) {
1283 close(t); /* someone let nonlocal through?! */
1284 } else if (plug_accepting(s->plug, sk_tcp_accept, actx)) {
1285 close(t); /* denied or error */
1291 * If we reach here, this is not a listening socket, so
1292 * readability really means readability.
1295 /* In the case the socket is still frozen, we don't even bother */
1300 * We have received data on the socket. For an oobinline
1301 * socket, this might be data _before_ an urgent pointer,
1302 * in which case we send it to the back end with type==1
1303 * (data prior to urgent).
1305 if (s->oobinline && s->oobpending) {
1307 if (ioctl(s->s, SIOCATMARK, &atmark) == 0 && atmark)
1308 s->oobpending = FALSE; /* clear this indicator */
1312 ret = recv(s->s, buf, s->oobpending ? 1 : sizeof(buf), 0);
1313 noise_ultralight(ret);
1315 if (errno == EWOULDBLOCK) {
1321 * An error at this point _might_ be an error reported
1322 * by a non-blocking connect(). So before we return a
1323 * panic status to the user, let's just see whether
1328 plug_log(s->plug, 1, s->addr, s->port, strerror(err), err);
1329 while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1330 err = try_connect(s);
1334 return plug_closing(s->plug, strerror(err), err, 0);
1335 } else if (0 == ret) {
1336 s->incomingeof = TRUE; /* stop trying to read now */
1338 return plug_closing(s->plug, NULL, 0, 0);
1341 * Receiving actual data on a socket means we can
1342 * stop falling back through the candidate
1343 * addresses to connect to.
1346 sk_addr_free(s->addr);
1349 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1352 case 2: /* writable */
1353 if (!s->connected) {
1355 * select() reports a socket as _writable_ when an
1356 * asynchronous connection is completed.
1358 s->connected = s->writable = 1;
1362 int bufsize_before, bufsize_after;
1364 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1366 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1367 if (bufsize_after < bufsize_before)
1368 plug_sent(s->plug, bufsize_after);
1377 * Each socket abstraction contains a `void *' private field in
1378 * which the client can keep state.
1380 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1382 Actual_Socket s = (Actual_Socket) sock;
1383 s->private_ptr = ptr;
1386 static void *sk_tcp_get_private_ptr(Socket sock)
1388 Actual_Socket s = (Actual_Socket) sock;
1389 return s->private_ptr;
1393 * Special error values are returned from sk_namelookup and sk_new
1394 * if there's a problem. These functions extract an error message,
1395 * or return NULL if there's no problem.
1397 const char *sk_addr_error(SockAddr addr)
1401 static const char *sk_tcp_socket_error(Socket sock)
1403 Actual_Socket s = (Actual_Socket) sock;
1407 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1409 Actual_Socket s = (Actual_Socket) sock;
1410 if (s->frozen == is_frozen)
1412 s->frozen = is_frozen;
1416 static void uxsel_tell(Actual_Socket s)
1419 if (!s->pending_error) {
1421 rwx |= 1; /* read == accept */
1424 rwx |= 2; /* write == connect */
1425 if (s->connected && !s->frozen && !s->incomingeof)
1426 rwx |= 1 | 4; /* read, except */
1427 if (bufchain_size(&s->output_data))
1428 rwx |= 2; /* write */
1431 uxsel_set(s->s, rwx, net_select_result);
1434 int net_service_lookup(char *service)
1437 se = getservbyname(service, NULL);
1439 return ntohs(se->s_port);
1444 char *get_hostname(void)
1447 char *hostname = NULL;
1450 hostname = sresize(hostname, len, char);
1451 if ((gethostname(hostname, len) < 0) &&
1452 (errno != ENAMETOOLONG)) {
1457 } while (strlen(hostname) >= len-1);
1461 SockAddr platform_get_x11_unix_address(const char *sockpath, int displaynum)
1463 SockAddr ret = snew(struct SockAddr_tag);
1466 memset(ret, 0, sizeof *ret);
1467 ret->superfamily = UNIX;
1469 * In special circumstances (notably Mac OS X Leopard), we'll
1470 * have been passed an explicit Unix socket path.
1473 n = snprintf(ret->hostname, sizeof ret->hostname,
1476 n = snprintf(ret->hostname, sizeof ret->hostname,
1477 "%s%d", X11_UNIX_PATH, displaynum);
1481 ret->error = "snprintf failed";
1482 else if (n >= sizeof ret->hostname)
1483 ret->error = "X11 UNIX name too long";
1488 ret->addresses = NULL;
1489 ret->naddresses = 0;
1495 SockAddr unix_sock_addr(const char *path)
1497 SockAddr ret = snew(struct SockAddr_tag);
1500 memset(ret, 0, sizeof *ret);
1501 ret->superfamily = UNIX;
1502 n = snprintf(ret->hostname, sizeof ret->hostname, "%s", path);
1505 ret->error = "snprintf failed";
1506 else if (n >= sizeof ret->hostname)
1507 ret->error = "socket pathname too long";
1512 ret->addresses = NULL;
1513 ret->naddresses = 0;
1519 Socket new_unix_listener(SockAddr listenaddr, Plug plug)
1522 union sockaddr_union u;
1523 union sockaddr_union *addr;
1529 * Create Socket structure.
1531 ret = snew(struct Socket_tag);
1532 ret->fn = &tcp_fn_table;
1535 bufchain_init(&ret->output_data);
1536 ret->writable = 0; /* to start with */
1537 ret->sending_oob = 0;
1539 ret->localhost_only = TRUE;
1540 ret->pending_error = 0;
1541 ret->parent = ret->child = NULL;
1542 ret->oobpending = FALSE;
1543 ret->outgoingeof = EOF_NO;
1544 ret->incomingeof = FALSE;
1546 ret->addr = listenaddr;
1548 assert(listenaddr->superfamily == UNIX);
1553 s = socket(AF_UNIX, SOCK_STREAM, 0);
1555 ret->error = strerror(errno);
1556 return (Socket) ret;
1563 memset(&u, '\0', sizeof(u));
1564 u.su.sun_family = AF_UNIX;
1565 strncpy(u.su.sun_path, listenaddr->hostname, sizeof(u.su.sun_path)-1);
1567 addrlen = sizeof(u.su);
1569 if (unlink(u.su.sun_path) < 0 && errno != ENOENT) {
1571 ret->error = strerror(errno);
1572 return (Socket) ret;
1575 retcode = bind(s, &addr->sa, addrlen);
1578 ret->error = strerror(errno);
1579 return (Socket) ret;
1582 if (listen(s, SOMAXCONN) < 0) {
1584 ret->error = strerror(errno);
1585 return (Socket) ret;
1591 add234(sktree, ret);
1593 return (Socket) ret;