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 */
79 int connected; /* irrelevant for listening sockets */
81 int frozen; /* this causes readability notifications to be ignored */
82 int localhost_only; /* for listening sockets */
85 int oobpending; /* is there OOB data available to read? */
87 enum { EOF_NO, EOF_PENDING, EOF_SENT } outgoingeof;
89 int pending_error; /* in case send() returns error */
91 int nodelay, keepalive; /* for connect()-type sockets */
92 int privport, port; /* and again */
96 * We sometimes need pairs of Socket structures to be linked:
97 * if we are listening on the same IPv6 and v4 port, for
98 * example. So here we define `parent' and `child' pointers to
101 Actual_Socket parent, child;
104 struct SockAddr_tag {
107 enum { UNRESOLVED, UNIX, IP } superfamily;
109 struct addrinfo *ais; /* Addresses IPv6 style. */
111 unsigned long *addresses; /* Addresses IPv4 style. */
114 char hostname[512]; /* Store an unresolved host name. */
118 * Which address family this address belongs to. AF_INET for IPv4;
119 * AF_INET6 for IPv6; AF_UNSPEC indicates that name resolution has
120 * not been done and a simple host name is held in this SockAddr
124 #define SOCKADDR_FAMILY(addr, step) \
125 ((addr)->superfamily == UNRESOLVED ? AF_UNSPEC : \
126 (addr)->superfamily == UNIX ? AF_UNIX : \
127 (step).ai ? (step).ai->ai_family : AF_INET)
129 #define SOCKADDR_FAMILY(addr, step) \
130 ((addr)->superfamily == UNRESOLVED ? AF_UNSPEC : \
131 (addr)->superfamily == UNIX ? AF_UNIX : AF_INET)
135 * Start a SockAddrStep structure to step through multiple
139 #define START_STEP(addr, step) \
140 ((step).ai = (addr)->ais, (step).curraddr = 0)
142 #define START_STEP(addr, step) \
143 ((step).curraddr = 0)
146 static tree234 *sktree;
148 static void uxsel_tell(Actual_Socket s);
150 static int cmpfortree(void *av, void *bv)
152 Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
153 int as = a->s, bs = b->s;
165 static int cmpforsearch(void *av, void *bv)
167 Actual_Socket b = (Actual_Socket) bv;
168 int as = *(int *)av, bs = b->s;
178 sktree = newtree234(cmpfortree);
181 void sk_cleanup(void)
187 for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
193 SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family)
195 SockAddr ret = snew(struct SockAddr_tag);
197 struct addrinfo hints;
201 struct hostent *h = NULL;
206 /* Clear the structure and default to IPv4. */
207 memset(ret, 0, sizeof(struct SockAddr_tag));
208 ret->superfamily = UNRESOLVED;
214 hints.ai_flags = AI_CANONNAME;
215 hints.ai_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
216 address_family == ADDRTYPE_IPV6 ? AF_INET6 :
218 hints.ai_socktype = SOCK_STREAM;
219 hints.ai_protocol = 0;
220 hints.ai_addrlen = 0;
221 hints.ai_addr = NULL;
222 hints.ai_canonname = NULL;
223 hints.ai_next = NULL;
225 char *trimmed_host = host_strduptrim(host); /* strip [] on literals */
226 err = getaddrinfo(trimmed_host, NULL, &hints, &ret->ais);
230 ret->error = gai_strerror(err);
233 ret->superfamily = IP;
235 if (ret->ais->ai_canonname != NULL)
236 strncat(realhost, ret->ais->ai_canonname, sizeof(realhost) - 1);
238 strncat(realhost, host, sizeof(realhost) - 1);
240 if ((a = inet_addr(host)) == (unsigned long)(in_addr_t)(-1)) {
242 * Otherwise use the IPv4-only gethostbyname... (NOTE:
243 * we don't use gethostbyname as a fallback!)
245 if (ret->superfamily == UNRESOLVED) {
246 /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
247 if ( (h = gethostbyname(host)) )
248 ret->superfamily = IP;
250 if (ret->superfamily == UNRESOLVED) {
251 ret->error = (h_errno == HOST_NOT_FOUND ||
252 h_errno == NO_DATA ||
253 h_errno == NO_ADDRESS ? "Host does not exist" :
254 h_errno == TRY_AGAIN ?
255 "Temporary name service failure" :
256 "gethostbyname: unknown error");
259 /* This way we are always sure the h->h_name is valid :) */
260 strncpy(realhost, h->h_name, sizeof(realhost));
261 for (n = 0; h->h_addr_list[n]; n++);
262 ret->addresses = snewn(n, unsigned long);
264 for (n = 0; n < ret->naddresses; n++) {
265 memcpy(&a, h->h_addr_list[n], sizeof(a));
266 ret->addresses[n] = ntohl(a);
270 * This must be a numeric IPv4 address because it caused a
271 * success return from inet_addr.
273 ret->superfamily = IP;
274 strncpy(realhost, host, sizeof(realhost));
275 ret->addresses = snew(unsigned long);
277 ret->addresses[0] = ntohl(a);
280 realhost[lenof(realhost)-1] = '\0';
281 *canonicalname = snewn(1+strlen(realhost), char);
282 strcpy(*canonicalname, realhost);
286 SockAddr sk_nonamelookup(const char *host)
288 SockAddr ret = snew(struct SockAddr_tag);
290 ret->superfamily = UNRESOLVED;
291 strncpy(ret->hostname, host, lenof(ret->hostname));
292 ret->hostname[lenof(ret->hostname)-1] = '\0';
296 ret->addresses = NULL;
302 static int sk_nextaddr(SockAddr addr, SockAddrStep *step)
305 if (step->ai && step->ai->ai_next) {
306 step->ai = step->ai->ai_next;
311 if (step->curraddr+1 < addr->naddresses) {
320 void sk_getaddr(SockAddr addr, char *buf, int buflen)
322 if (addr->superfamily == UNRESOLVED || addr->superfamily == UNIX) {
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);
334 assert(SOCKADDR_FAMILY(addr, ignored_macro_parameter) == AF_INET);
335 a.s_addr = htonl(addr->addresses[0]);
336 strncpy(buf, inet_ntoa(a), buflen);
337 buf[buflen-1] = '\0';
342 int sk_addr_needs_port(SockAddr addr)
344 if (addr->superfamily == UNRESOLVED || addr->superfamily == UNIX) {
351 int sk_hostname_is_local(const char *name)
353 return !strcmp(name, "localhost") ||
354 !strcmp(name, "::1") ||
355 !strncmp(name, "127.", 4);
358 #define ipv4_is_loopback(addr) \
359 (((addr).s_addr & htonl(0xff000000)) == htonl(0x7f000000))
361 static int sockaddr_is_loopback(struct sockaddr *sa)
363 union sockaddr_union *u = (union sockaddr_union *)sa;
364 switch (u->sa.sa_family) {
366 return ipv4_is_loopback(u->sin.sin_addr);
369 return IN6_IS_ADDR_LOOPBACK(&u->sin6.sin6_addr);
378 int sk_address_is_local(SockAddr addr)
380 if (addr->superfamily == UNRESOLVED)
381 return 0; /* we don't know; assume not */
382 else if (addr->superfamily == UNIX)
386 return sockaddr_is_loopback(addr->ais->ai_addr);
389 assert(SOCKADDR_FAMILY(addr, ignored_macro_parameter) == AF_INET);
390 a.s_addr = htonl(addr->addresses[0]);
391 return ipv4_is_loopback(a);
396 int sk_address_is_special_local(SockAddr addr)
398 return addr->superfamily == UNIX;
401 int sk_addrtype(SockAddr addr)
404 family = SOCKADDR_FAMILY(addr, ignored_macro_parameter);
406 return (family == AF_INET ? ADDRTYPE_IPV4 :
408 family == AF_INET6 ? ADDRTYPE_IPV6 :
413 void sk_addrcopy(SockAddr addr, char *buf)
417 START_STEP(addr, step);
418 family = SOCKADDR_FAMILY(addr, step);
421 if (family == AF_INET)
422 memcpy(buf, &((struct sockaddr_in *)step.ai->ai_addr)->sin_addr,
423 sizeof(struct in_addr));
424 else if (family == AF_INET6)
425 memcpy(buf, &((struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr,
426 sizeof(struct in6_addr));
432 assert(family == AF_INET);
433 a.s_addr = htonl(addr->addresses[step.curraddr]);
434 memcpy(buf, (char*) &a.s_addr, 4);
438 void sk_addr_free(SockAddr addr)
440 if (--addr->refcount > 0)
443 if (addr->ais != NULL)
444 freeaddrinfo(addr->ais);
446 sfree(addr->addresses);
451 SockAddr sk_addr_dup(SockAddr addr)
457 static Plug sk_tcp_plug(Socket sock, Plug p)
459 Actual_Socket s = (Actual_Socket) sock;
466 static void sk_tcp_flush(Socket s)
469 * We send data to the socket as soon as we can anyway,
470 * so we don't need to do anything here. :-)
474 static void sk_tcp_close(Socket s);
475 static int sk_tcp_write(Socket s, const char *data, int len);
476 static int sk_tcp_write_oob(Socket s, const char *data, int len);
477 static void sk_tcp_write_eof(Socket s);
478 static void sk_tcp_set_frozen(Socket s, int is_frozen);
479 static const char *sk_tcp_socket_error(Socket s);
481 static struct socket_function_table tcp_fn_table = {
492 static Socket sk_tcp_accept(accept_ctx_t ctx, Plug plug)
498 * Create Socket structure.
500 ret = snew(struct Socket_tag);
501 ret->fn = &tcp_fn_table;
504 bufchain_init(&ret->output_data);
505 ret->writable = 1; /* to start with */
506 ret->sending_oob = 0;
508 ret->localhost_only = 0; /* unused, but best init anyway */
509 ret->pending_error = 0;
510 ret->oobpending = FALSE;
511 ret->outgoingeof = EOF_NO;
512 ret->incomingeof = FALSE;
514 ret->parent = ret->child = NULL;
521 ret->error = strerror(errno);
533 static int try_connect(Actual_Socket sock)
536 union sockaddr_union u;
537 const union sockaddr_union *sa;
543 * Remove the socket from the tree before we overwrite its
544 * internal socket id, because that forms part of the tree's
545 * sorting criterion. We'll add it back before exiting this
546 * function, whether we changed anything or not.
548 del234(sktree, sock);
553 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
558 family = SOCKADDR_FAMILY(sock->addr, sock->step);
559 assert(family != AF_UNSPEC);
560 s = socket(family, SOCK_STREAM, 0);
570 if (sock->oobinline) {
572 if (setsockopt(s, SOL_SOCKET, SO_OOBINLINE,
573 (void *) &b, sizeof(b)) < 0) {
582 if (setsockopt(s, IPPROTO_TCP, TCP_NODELAY,
583 (void *) &b, sizeof(b)) < 0) {
590 if (sock->keepalive) {
592 if (setsockopt(s, SOL_SOCKET, SO_KEEPALIVE,
593 (void *) &b, sizeof(b)) < 0) {
601 * Bind to local address.
604 localport = 1023; /* count from 1023 downwards */
606 localport = 0; /* just use port 0 (ie kernel picks) */
608 /* BSD IP stacks need sockaddr_in zeroed before filling in */
609 memset(&u,'\0',sizeof(u));
611 /* We don't try to bind to a local address for UNIX domain sockets. (Why
612 * do we bother doing the bind when localport == 0 anyway?) */
613 if (family != AF_UNIX) {
614 /* Loop round trying to bind */
619 if (family == AF_INET6) {
620 /* XXX use getaddrinfo to get a local address? */
621 u.sin6.sin6_family = AF_INET6;
622 u.sin6.sin6_addr = in6addr_any;
623 u.sin6.sin6_port = htons(localport);
624 retcode = bind(s, &u.sa, sizeof(u.sin6));
628 assert(family == AF_INET);
629 u.sin.sin_family = AF_INET;
630 u.sin.sin_addr.s_addr = htonl(INADDR_ANY);
631 u.sin.sin_port = htons(localport);
632 retcode = bind(s, &u.sa, sizeof(u.sin));
639 if (err != EADDRINUSE) /* failed, for a bad reason */
644 break; /* we're only looping once */
647 break; /* we might have got to the end */
655 * Connect to remote address.
660 /* XXX would be better to have got getaddrinfo() to fill in the port. */
661 ((struct sockaddr_in *)sock->step.ai->ai_addr)->sin_port =
663 sa = (const union sockaddr_union *)sock->step.ai->ai_addr;
664 salen = sock->step.ai->ai_addrlen;
667 ((struct sockaddr_in *)sock->step.ai->ai_addr)->sin_port =
669 sa = (const union sockaddr_union *)sock->step.ai->ai_addr;
670 salen = sock->step.ai->ai_addrlen;
674 u.sin.sin_family = AF_INET;
675 u.sin.sin_addr.s_addr = htonl(sock->addr->addresses[sock->step.curraddr]);
676 u.sin.sin_port = htons((short) sock->port);
678 salen = sizeof u.sin;
682 assert(sock->port == 0); /* to catch confused people */
683 assert(strlen(sock->addr->hostname) < sizeof u.su.sun_path);
684 u.su.sun_family = AF_UNIX;
685 strcpy(u.su.sun_path, sock->addr->hostname);
691 assert(0 && "unknown address family");
692 exit(1); /* XXX: GCC doesn't understand assert() on some systems. */
697 if ((connect(s, &(sa->sa), salen)) < 0) {
698 if ( errno != EINPROGRESS ) {
704 * If we _don't_ get EWOULDBLOCK, the connect has completed
705 * and we should set the socket as connected and writable.
716 * No matter what happened, put the socket back in the tree.
718 add234(sktree, sock);
721 plug_log(sock->plug, 1, sock->addr, sock->port, strerror(err), err);
725 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
726 int nodelay, int keepalive, Plug plug)
732 * Create Socket structure.
734 ret = snew(struct Socket_tag);
735 ret->fn = &tcp_fn_table;
738 bufchain_init(&ret->output_data);
739 ret->connected = 0; /* to start with */
740 ret->writable = 0; /* to start with */
741 ret->sending_oob = 0;
743 ret->localhost_only = 0; /* unused, but best init anyway */
744 ret->pending_error = 0;
745 ret->parent = ret->child = NULL;
746 ret->oobpending = FALSE;
747 ret->outgoingeof = EOF_NO;
748 ret->incomingeof = FALSE;
751 START_STEP(ret->addr, ret->step);
753 ret->oobinline = oobinline;
754 ret->nodelay = nodelay;
755 ret->keepalive = keepalive;
756 ret->privport = privport;
761 err = try_connect(ret);
762 } while (err && sk_nextaddr(ret->addr, &ret->step));
765 ret->error = strerror(err);
770 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int orig_address_family)
774 struct addrinfo hints, *ai;
777 union sockaddr_union u;
778 union sockaddr_union *addr;
786 * Create Socket structure.
788 ret = snew(struct Socket_tag);
789 ret->fn = &tcp_fn_table;
792 bufchain_init(&ret->output_data);
793 ret->writable = 0; /* to start with */
794 ret->sending_oob = 0;
796 ret->localhost_only = local_host_only;
797 ret->pending_error = 0;
798 ret->parent = ret->child = NULL;
799 ret->oobpending = FALSE;
800 ret->outgoingeof = EOF_NO;
801 ret->incomingeof = FALSE;
807 * Translate address_family from platform-independent constants
808 * into local reality.
810 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
812 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
817 /* Let's default to IPv6.
818 * If the stack doesn't support IPv6, we will fall back to IPv4. */
819 if (address_family == AF_UNSPEC) address_family = AF_INET6;
821 /* No other choice, default to IPv4 */
822 if (address_family == AF_UNSPEC) address_family = AF_INET;
828 s = socket(address_family, SOCK_STREAM, 0);
831 /* If the host doesn't support IPv6 try fallback to IPv4. */
832 if (s < 0 && address_family == AF_INET6) {
833 address_family = AF_INET;
834 s = socket(address_family, SOCK_STREAM, 0);
839 ret->error = strerror(errno);
847 if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
848 (const char *)&on, sizeof(on)) < 0) {
849 ret->error = strerror(errno);
855 addr = NULL; addrlen = -1; /* placate optimiser */
857 if (srcaddr != NULL) {
859 hints.ai_flags = AI_NUMERICHOST;
860 hints.ai_family = address_family;
861 hints.ai_socktype = SOCK_STREAM;
862 hints.ai_protocol = 0;
863 hints.ai_addrlen = 0;
864 hints.ai_addr = NULL;
865 hints.ai_canonname = NULL;
866 hints.ai_next = NULL;
867 assert(port >= 0 && port <= 99999);
868 sprintf(portstr, "%d", port);
870 char *trimmed_addr = host_strduptrim(srcaddr);
871 retcode = getaddrinfo(trimmed_addr, portstr, &hints, &ai);
875 addr = (union sockaddr_union *)ai->ai_addr;
876 addrlen = ai->ai_addrlen;
879 memset(&u,'\0',sizeof u);
880 u.sin.sin_family = AF_INET;
881 u.sin.sin_port = htons(port);
882 u.sin.sin_addr.s_addr = inet_addr(srcaddr);
883 if (u.sin.sin_addr.s_addr != (in_addr_t)(-1)) {
884 /* Override localhost_only with specified listen addr. */
885 ret->localhost_only = ipv4_is_loopback(u.sin.sin_addr);
888 addrlen = sizeof(u.sin);
894 memset(&u,'\0',sizeof u);
896 if (address_family == AF_INET6) {
897 u.sin6.sin6_family = AF_INET6;
898 u.sin6.sin6_port = htons(port);
900 u.sin6.sin6_addr = in6addr_loopback;
902 u.sin6.sin6_addr = in6addr_any;
904 addrlen = sizeof(u.sin6);
908 u.sin.sin_family = AF_INET;
909 u.sin.sin_port = htons(port);
911 u.sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
913 u.sin.sin_addr.s_addr = htonl(INADDR_ANY);
915 addrlen = sizeof(u.sin);
919 retcode = bind(s, &addr->sa, addrlen);
922 ret->error = strerror(errno);
926 if (listen(s, SOMAXCONN) < 0) {
928 ret->error = strerror(errno);
934 * If we were given ADDRTYPE_UNSPEC, we must also create an
935 * IPv4 listening socket and link it to this one.
937 if (address_family == AF_INET6 && orig_address_family == ADDRTYPE_UNSPEC) {
940 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
941 local_host_only, ADDRTYPE_IPV4);
948 /* If we couldn't create a listening socket on IPv4 as well
949 * as IPv6, we must return an error overall. */
952 return (Socket) other;
966 static void sk_tcp_close(Socket sock)
968 Actual_Socket s = (Actual_Socket) sock;
971 sk_tcp_close((Socket)s->child);
977 sk_addr_free(s->addr);
981 void *sk_getxdmdata(void *sock, int *lenp)
983 Actual_Socket s = (Actual_Socket) sock;
984 union sockaddr_union u;
987 static unsigned int unix_addr = 0xFFFFFFFF;
990 * We must check that this socket really _is_ an Actual_Socket.
992 if (s->fn != &tcp_fn_table)
993 return NULL; /* failure */
996 if (getsockname(s->s, &u.sa, &addrlen) < 0)
998 switch(u.sa.sa_family) {
1001 buf = snewn(*lenp, char);
1002 PUT_32BIT_MSB_FIRST(buf, ntohl(u.sin.sin_addr.s_addr));
1003 PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin.sin_port));
1008 buf = snewn(*lenp, char);
1009 if (IN6_IS_ADDR_V4MAPPED(&u.sin6.sin6_addr)) {
1010 memcpy(buf, u.sin6.sin6_addr.s6_addr + 12, 4);
1011 PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin6.sin6_port));
1013 /* This is stupid, but it's what XLib does. */
1019 buf = snewn(*lenp, char);
1020 PUT_32BIT_MSB_FIRST(buf, unix_addr--);
1021 PUT_16BIT_MSB_FIRST(buf+4, getpid());
1034 * Deal with socket errors detected in try_send().
1036 static void socket_error_callback(void *vs)
1038 Actual_Socket s = (Actual_Socket)vs;
1041 * Just in case other socket work has caused this socket to vanish
1042 * or become somehow non-erroneous before this callback arrived...
1044 if (!find234(sktree, s, NULL) || !s->pending_error)
1048 * An error has occurred on this socket. Pass it to the plug.
1050 plug_closing(s->plug, strerror(s->pending_error), s->pending_error, 0);
1054 * The function which tries to send on a socket once it's deemed
1057 void try_send(Actual_Socket s)
1059 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1063 int len, urgentflag;
1065 if (s->sending_oob) {
1066 urgentflag = MSG_OOB;
1067 len = s->sending_oob;
1071 bufchain_prefix(&s->output_data, &data, &len);
1073 nsent = send(s->s, data, len, urgentflag);
1074 noise_ultralight(nsent);
1076 err = (nsent < 0 ? errno : 0);
1077 if (err == EWOULDBLOCK) {
1079 * Perfectly normal: we've sent all we can for the moment.
1081 s->writable = FALSE;
1085 * We unfortunately can't just call plug_closing(),
1086 * because it's quite likely that we're currently
1087 * _in_ a call from the code we'd be calling back
1088 * to, so we'd have to make half the SSH code
1089 * reentrant. Instead we flag a pending error on
1090 * the socket, to be dealt with (by calling
1091 * plug_closing()) at some suitable future moment.
1093 s->pending_error = err;
1095 * Immediately cease selecting on this socket, so that
1096 * we don't tight-loop repeatedly trying to do
1097 * whatever it was that went wrong.
1101 * Arrange to be called back from the top level to
1102 * deal with the error condition on this socket.
1104 queue_toplevel_callback(socket_error_callback, s);
1108 if (s->sending_oob) {
1110 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1111 s->sending_oob = len - nsent;
1116 bufchain_consume(&s->output_data, nsent);
1122 * If we reach here, we've finished sending everything we might
1123 * have needed to send. Send EOF, if we need to.
1125 if (s->outgoingeof == EOF_PENDING) {
1126 shutdown(s->s, SHUT_WR);
1127 s->outgoingeof = EOF_SENT;
1131 * Also update the select status, because we don't need to select
1132 * for writing any more.
1137 static int sk_tcp_write(Socket sock, const char *buf, int len)
1139 Actual_Socket s = (Actual_Socket) sock;
1141 assert(s->outgoingeof == EOF_NO);
1144 * Add the data to the buffer list on the socket.
1146 bufchain_add(&s->output_data, buf, len);
1149 * Now try sending from the start of the buffer list.
1155 * Update the select() status to correctly reflect whether or
1156 * not we should be selecting for write.
1160 return bufchain_size(&s->output_data);
1163 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1165 Actual_Socket s = (Actual_Socket) sock;
1167 assert(s->outgoingeof == EOF_NO);
1170 * Replace the buffer list on the socket with the data.
1172 bufchain_clear(&s->output_data);
1173 assert(len <= sizeof(s->oobdata));
1174 memcpy(s->oobdata, buf, len);
1175 s->sending_oob = len;
1178 * Now try sending from the start of the buffer list.
1184 * Update the select() status to correctly reflect whether or
1185 * not we should be selecting for write.
1189 return s->sending_oob;
1192 static void sk_tcp_write_eof(Socket sock)
1194 Actual_Socket s = (Actual_Socket) sock;
1196 assert(s->outgoingeof == EOF_NO);
1199 * Mark the socket as pending outgoing EOF.
1201 s->outgoingeof = EOF_PENDING;
1204 * Now try sending from the start of the buffer list.
1210 * Update the select() status to correctly reflect whether or
1211 * not we should be selecting for write.
1216 static int net_select_result(int fd, int event)
1219 char buf[20480]; /* nice big buffer for plenty of speed */
1223 /* Find the Socket structure */
1224 s = find234(sktree, &fd, cmpforsearch);
1226 return 1; /* boggle */
1228 noise_ultralight(event);
1231 case 4: /* exceptional */
1232 if (!s->oobinline) {
1234 * On a non-oobinline socket, this indicates that we
1235 * can immediately perform an OOB read and get back OOB
1236 * data, which we will send to the back end with
1237 * type==2 (urgent data).
1239 ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
1240 noise_ultralight(ret);
1242 return plug_closing(s->plug,
1243 ret == 0 ? "Internal networking trouble" :
1244 strerror(errno), errno, 0);
1247 * Receiving actual data on a socket means we can
1248 * stop falling back through the candidate
1249 * addresses to connect to.
1252 sk_addr_free(s->addr);
1255 return plug_receive(s->plug, 2, buf, ret);
1261 * If we reach here, this is an oobinline socket, which
1262 * means we should set s->oobpending and then deal with it
1263 * when we get called for the readability event (which
1264 * should also occur).
1266 s->oobpending = TRUE;
1268 case 1: /* readable; also acceptance */
1271 * On a listening socket, the readability event means a
1272 * connection is ready to be accepted.
1274 union sockaddr_union su;
1275 socklen_t addrlen = sizeof(su);
1277 int t; /* socket of connection */
1279 memset(&su, 0, addrlen);
1280 t = accept(s->s, &su.sa, &addrlen);
1288 if ((!s->addr || s->addr->superfamily != UNIX) &&
1289 s->localhost_only && !sockaddr_is_loopback(&su.sa)) {
1290 close(t); /* someone let nonlocal through?! */
1291 } else if (plug_accepting(s->plug, sk_tcp_accept, actx)) {
1292 close(t); /* denied or error */
1298 * If we reach here, this is not a listening socket, so
1299 * readability really means readability.
1302 /* In the case the socket is still frozen, we don't even bother */
1307 * We have received data on the socket. For an oobinline
1308 * socket, this might be data _before_ an urgent pointer,
1309 * in which case we send it to the back end with type==1
1310 * (data prior to urgent).
1312 if (s->oobinline && s->oobpending) {
1314 if (ioctl(s->s, SIOCATMARK, &atmark) == 0 && atmark)
1315 s->oobpending = FALSE; /* clear this indicator */
1319 ret = recv(s->s, buf, s->oobpending ? 1 : sizeof(buf), 0);
1320 noise_ultralight(ret);
1322 if (errno == EWOULDBLOCK) {
1328 * An error at this point _might_ be an error reported
1329 * by a non-blocking connect(). So before we return a
1330 * panic status to the user, let's just see whether
1335 plug_log(s->plug, 1, s->addr, s->port, strerror(err), err);
1336 while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1337 err = try_connect(s);
1341 return plug_closing(s->plug, strerror(err), err, 0);
1342 } else if (0 == ret) {
1343 s->incomingeof = TRUE; /* stop trying to read now */
1345 return plug_closing(s->plug, NULL, 0, 0);
1348 * Receiving actual data on a socket means we can
1349 * stop falling back through the candidate
1350 * addresses to connect to.
1353 sk_addr_free(s->addr);
1356 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1359 case 2: /* writable */
1360 if (!s->connected) {
1362 * select() reports a socket as _writable_ when an
1363 * asynchronous connection is completed.
1365 s->connected = s->writable = 1;
1369 int bufsize_before, bufsize_after;
1371 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1373 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1374 if (bufsize_after < bufsize_before)
1375 plug_sent(s->plug, bufsize_after);
1384 * Special error values are returned from sk_namelookup and sk_new
1385 * if there's a problem. These functions extract an error message,
1386 * or return NULL if there's no problem.
1388 const char *sk_addr_error(SockAddr addr)
1392 static const char *sk_tcp_socket_error(Socket sock)
1394 Actual_Socket s = (Actual_Socket) sock;
1398 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1400 Actual_Socket s = (Actual_Socket) sock;
1401 if (s->frozen == is_frozen)
1403 s->frozen = is_frozen;
1407 static void uxsel_tell(Actual_Socket s)
1410 if (!s->pending_error) {
1412 rwx |= 1; /* read == accept */
1415 rwx |= 2; /* write == connect */
1416 if (s->connected && !s->frozen && !s->incomingeof)
1417 rwx |= 1 | 4; /* read, except */
1418 if (bufchain_size(&s->output_data))
1419 rwx |= 2; /* write */
1422 uxsel_set(s->s, rwx, net_select_result);
1425 int net_service_lookup(char *service)
1428 se = getservbyname(service, NULL);
1430 return ntohs(se->s_port);
1435 char *get_hostname(void)
1438 char *hostname = NULL;
1441 hostname = sresize(hostname, len, char);
1442 if ((gethostname(hostname, len) < 0) &&
1443 (errno != ENAMETOOLONG)) {
1448 } while (strlen(hostname) >= len-1);
1452 SockAddr platform_get_x11_unix_address(const char *sockpath, int displaynum)
1454 SockAddr ret = snew(struct SockAddr_tag);
1457 memset(ret, 0, sizeof *ret);
1458 ret->superfamily = UNIX;
1460 * In special circumstances (notably Mac OS X Leopard), we'll
1461 * have been passed an explicit Unix socket path.
1464 n = snprintf(ret->hostname, sizeof ret->hostname,
1467 n = snprintf(ret->hostname, sizeof ret->hostname,
1468 "%s%d", X11_UNIX_PATH, displaynum);
1472 ret->error = "snprintf failed";
1473 else if (n >= sizeof ret->hostname)
1474 ret->error = "X11 UNIX name too long";
1479 ret->addresses = NULL;
1480 ret->naddresses = 0;
1486 SockAddr unix_sock_addr(const char *path)
1488 SockAddr ret = snew(struct SockAddr_tag);
1491 memset(ret, 0, sizeof *ret);
1492 ret->superfamily = UNIX;
1493 n = snprintf(ret->hostname, sizeof ret->hostname, "%s", path);
1496 ret->error = "snprintf failed";
1497 else if (n >= sizeof ret->hostname)
1498 ret->error = "socket pathname too long";
1503 ret->addresses = NULL;
1504 ret->naddresses = 0;
1510 Socket new_unix_listener(SockAddr listenaddr, Plug plug)
1513 union sockaddr_union u;
1514 union sockaddr_union *addr;
1520 * Create Socket structure.
1522 ret = snew(struct Socket_tag);
1523 ret->fn = &tcp_fn_table;
1526 bufchain_init(&ret->output_data);
1527 ret->writable = 0; /* to start with */
1528 ret->sending_oob = 0;
1530 ret->localhost_only = TRUE;
1531 ret->pending_error = 0;
1532 ret->parent = ret->child = NULL;
1533 ret->oobpending = FALSE;
1534 ret->outgoingeof = EOF_NO;
1535 ret->incomingeof = FALSE;
1537 ret->addr = listenaddr;
1540 assert(listenaddr->superfamily == UNIX);
1545 s = socket(AF_UNIX, SOCK_STREAM, 0);
1547 ret->error = strerror(errno);
1548 return (Socket) ret;
1555 memset(&u, '\0', sizeof(u));
1556 u.su.sun_family = AF_UNIX;
1557 strncpy(u.su.sun_path, listenaddr->hostname, sizeof(u.su.sun_path)-1);
1559 addrlen = sizeof(u.su);
1561 if (unlink(u.su.sun_path) < 0 && errno != ENOENT) {
1563 ret->error = strerror(errno);
1564 return (Socket) ret;
1567 retcode = bind(s, &addr->sa, addrlen);
1570 ret->error = strerror(errno);
1571 return (Socket) ret;
1574 if (listen(s, SOMAXCONN) < 0) {
1576 ret->error = strerror(errno);
1577 return (Socket) ret;
1583 add234(sktree, ret);
1585 return (Socket) ret;