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 /* 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(const 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_address_is_special_local(SockAddr addr)
393 return addr->superfamily == UNIX;
396 int sk_addrtype(SockAddr addr)
400 START_STEP(addr, step);
401 family = SOCKADDR_FAMILY(addr, step);
403 return (family == AF_INET ? ADDRTYPE_IPV4 :
405 family == AF_INET6 ? ADDRTYPE_IPV6 :
410 void sk_addrcopy(SockAddr addr, char *buf)
414 START_STEP(addr, step);
415 family = SOCKADDR_FAMILY(addr, step);
418 if (family == AF_INET)
419 memcpy(buf, &((struct sockaddr_in *)step.ai->ai_addr)->sin_addr,
420 sizeof(struct in_addr));
421 else if (family == AF_INET6)
422 memcpy(buf, &((struct sockaddr_in6 *)step.ai->ai_addr)->sin6_addr,
423 sizeof(struct in6_addr));
429 assert(family == AF_INET);
430 a.s_addr = htonl(addr->addresses[step.curraddr]);
431 memcpy(buf, (char*) &a.s_addr, 4);
435 void sk_addr_free(SockAddr addr)
437 if (--addr->refcount > 0)
440 if (addr->ais != NULL)
441 freeaddrinfo(addr->ais);
443 sfree(addr->addresses);
448 SockAddr sk_addr_dup(SockAddr addr)
454 static Plug sk_tcp_plug(Socket sock, Plug p)
456 Actual_Socket s = (Actual_Socket) sock;
463 static void sk_tcp_flush(Socket s)
466 * We send data to the socket as soon as we can anyway,
467 * so we don't need to do anything here. :-)
471 static void sk_tcp_close(Socket s);
472 static int sk_tcp_write(Socket s, const char *data, int len);
473 static int sk_tcp_write_oob(Socket s, const char *data, int len);
474 static void sk_tcp_write_eof(Socket s);
475 static void sk_tcp_set_private_ptr(Socket s, void *ptr);
476 static void *sk_tcp_get_private_ptr(Socket s);
477 static void sk_tcp_set_frozen(Socket s, int is_frozen);
478 static const char *sk_tcp_socket_error(Socket s);
480 static struct socket_function_table tcp_fn_table = {
487 sk_tcp_set_private_ptr,
488 sk_tcp_get_private_ptr,
493 static Socket sk_tcp_accept(accept_ctx_t ctx, Plug plug)
499 * Create Socket structure.
501 ret = snew(struct Socket_tag);
502 ret->fn = &tcp_fn_table;
505 bufchain_init(&ret->output_data);
506 ret->writable = 1; /* to start with */
507 ret->sending_oob = 0;
509 ret->localhost_only = 0; /* unused, but best init anyway */
510 ret->pending_error = 0;
511 ret->oobpending = FALSE;
512 ret->outgoingeof = EOF_NO;
513 ret->incomingeof = FALSE;
515 ret->parent = ret->child = NULL;
522 ret->error = strerror(errno);
534 static int try_connect(Actual_Socket sock)
537 union sockaddr_union u;
538 const union sockaddr_union *sa;
544 * Remove the socket from the tree before we overwrite its
545 * internal socket id, because that forms part of the tree's
546 * sorting criterion. We'll add it back before exiting this
547 * function, whether we changed anything or not.
549 del234(sktree, sock);
554 plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
559 family = SOCKADDR_FAMILY(sock->addr, sock->step);
560 assert(family != AF_UNSPEC);
561 s = socket(family, SOCK_STREAM, 0);
571 if (sock->oobinline) {
573 if (setsockopt(s, SOL_SOCKET, SO_OOBINLINE,
574 (void *) &b, sizeof(b)) < 0) {
583 if (setsockopt(s, IPPROTO_TCP, TCP_NODELAY,
584 (void *) &b, sizeof(b)) < 0) {
591 if (sock->keepalive) {
593 if (setsockopt(s, SOL_SOCKET, SO_KEEPALIVE,
594 (void *) &b, sizeof(b)) < 0) {
602 * Bind to local address.
605 localport = 1023; /* count from 1023 downwards */
607 localport = 0; /* just use port 0 (ie kernel picks) */
609 /* BSD IP stacks need sockaddr_in zeroed before filling in */
610 memset(&u,'\0',sizeof(u));
612 /* We don't try to bind to a local address for UNIX domain sockets. (Why
613 * do we bother doing the bind when localport == 0 anyway?) */
614 if (family != AF_UNIX) {
615 /* Loop round trying to bind */
620 if (family == AF_INET6) {
621 /* XXX use getaddrinfo to get a local address? */
622 u.sin6.sin6_family = AF_INET6;
623 u.sin6.sin6_addr = in6addr_any;
624 u.sin6.sin6_port = htons(localport);
625 retcode = bind(s, &u.sa, sizeof(u.sin6));
629 assert(family == AF_INET);
630 u.sin.sin_family = AF_INET;
631 u.sin.sin_addr.s_addr = htonl(INADDR_ANY);
632 u.sin.sin_port = htons(localport);
633 retcode = bind(s, &u.sa, sizeof(u.sin));
640 if (err != EADDRINUSE) /* failed, for a bad reason */
645 break; /* we're only looping once */
648 break; /* we might have got to the end */
656 * Connect to remote address.
661 /* XXX would be better to have got getaddrinfo() to fill in the port. */
662 ((struct sockaddr_in *)sock->step.ai->ai_addr)->sin_port =
664 sa = (const union sockaddr_union *)sock->step.ai->ai_addr;
665 salen = sock->step.ai->ai_addrlen;
668 ((struct sockaddr_in *)sock->step.ai->ai_addr)->sin_port =
670 sa = (const union sockaddr_union *)sock->step.ai->ai_addr;
671 salen = sock->step.ai->ai_addrlen;
675 u.sin.sin_family = AF_INET;
676 u.sin.sin_addr.s_addr = htonl(sock->addr->addresses[sock->step.curraddr]);
677 u.sin.sin_port = htons((short) sock->port);
679 salen = sizeof u.sin;
683 assert(sock->port == 0); /* to catch confused people */
684 assert(strlen(sock->addr->hostname) < sizeof u.su.sun_path);
685 u.su.sun_family = AF_UNIX;
686 strcpy(u.su.sun_path, sock->addr->hostname);
692 assert(0 && "unknown address family");
693 exit(1); /* XXX: GCC doesn't understand assert() on some systems. */
698 if ((connect(s, &(sa->sa), salen)) < 0) {
699 if ( errno != EINPROGRESS ) {
705 * If we _don't_ get EWOULDBLOCK, the connect has completed
706 * and we should set the socket as connected and writable.
717 * No matter what happened, put the socket back in the tree.
719 add234(sktree, sock);
722 plug_log(sock->plug, 1, sock->addr, sock->port, strerror(err), err);
726 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
727 int nodelay, int keepalive, Plug plug)
733 * Create Socket structure.
735 ret = snew(struct Socket_tag);
736 ret->fn = &tcp_fn_table;
739 bufchain_init(&ret->output_data);
740 ret->connected = 0; /* to start with */
741 ret->writable = 0; /* to start with */
742 ret->sending_oob = 0;
744 ret->localhost_only = 0; /* unused, but best init anyway */
745 ret->pending_error = 0;
746 ret->parent = ret->child = NULL;
747 ret->oobpending = FALSE;
748 ret->outgoingeof = EOF_NO;
749 ret->incomingeof = FALSE;
752 START_STEP(ret->addr, ret->step);
754 ret->oobinline = oobinline;
755 ret->nodelay = nodelay;
756 ret->keepalive = keepalive;
757 ret->privport = privport;
762 err = try_connect(ret);
763 } while (err && sk_nextaddr(ret->addr, &ret->step));
766 ret->error = strerror(err);
771 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int orig_address_family)
775 struct addrinfo hints, *ai;
778 union sockaddr_union u;
779 union sockaddr_union *addr;
787 * Create Socket structure.
789 ret = snew(struct Socket_tag);
790 ret->fn = &tcp_fn_table;
793 bufchain_init(&ret->output_data);
794 ret->writable = 0; /* to start with */
795 ret->sending_oob = 0;
797 ret->localhost_only = local_host_only;
798 ret->pending_error = 0;
799 ret->parent = ret->child = NULL;
800 ret->oobpending = FALSE;
801 ret->outgoingeof = EOF_NO;
802 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);
869 retcode = getaddrinfo(srcaddr, portstr, &hints, &ai);
871 addr = (union sockaddr_union *)ai->ai_addr;
872 addrlen = ai->ai_addrlen;
875 memset(&u,'\0',sizeof u);
876 u.sin.sin_family = AF_INET;
877 u.sin.sin_port = htons(port);
878 u.sin.sin_addr.s_addr = inet_addr(srcaddr);
879 if (u.sin.sin_addr.s_addr != (in_addr_t)(-1)) {
880 /* Override localhost_only with specified listen addr. */
881 ret->localhost_only = ipv4_is_loopback(u.sin.sin_addr);
884 addrlen = sizeof(u.sin);
890 memset(&u,'\0',sizeof u);
892 if (address_family == AF_INET6) {
893 u.sin6.sin6_family = AF_INET6;
894 u.sin6.sin6_port = htons(port);
896 u.sin6.sin6_addr = in6addr_loopback;
898 u.sin6.sin6_addr = in6addr_any;
900 addrlen = sizeof(u.sin6);
904 u.sin.sin_family = AF_INET;
905 u.sin.sin_port = htons(port);
907 u.sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
909 u.sin.sin_addr.s_addr = htonl(INADDR_ANY);
911 addrlen = sizeof(u.sin);
915 retcode = bind(s, &addr->sa, addrlen);
918 ret->error = strerror(errno);
922 if (listen(s, SOMAXCONN) < 0) {
924 ret->error = strerror(errno);
930 * If we were given ADDRTYPE_UNSPEC, we must also create an
931 * IPv4 listening socket and link it to this one.
933 if (address_family == AF_INET6 && orig_address_family == ADDRTYPE_UNSPEC) {
936 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
937 local_host_only, ADDRTYPE_IPV4);
944 /* If we couldn't create a listening socket on IPv4 as well
945 * as IPv6, we must return an error overall. */
948 return (Socket) other;
962 static void sk_tcp_close(Socket sock)
964 Actual_Socket s = (Actual_Socket) sock;
967 sk_tcp_close((Socket)s->child);
973 sk_addr_free(s->addr);
977 void *sk_getxdmdata(void *sock, int *lenp)
979 Actual_Socket s = (Actual_Socket) sock;
980 union sockaddr_union u;
983 static unsigned int unix_addr = 0xFFFFFFFF;
986 * We must check that this socket really _is_ an Actual_Socket.
988 if (s->fn != &tcp_fn_table)
989 return NULL; /* failure */
992 if (getsockname(s->s, &u.sa, &addrlen) < 0)
994 switch(u.sa.sa_family) {
997 buf = snewn(*lenp, char);
998 PUT_32BIT_MSB_FIRST(buf, ntohl(u.sin.sin_addr.s_addr));
999 PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin.sin_port));
1004 buf = snewn(*lenp, char);
1005 if (IN6_IS_ADDR_V4MAPPED(&u.sin6.sin6_addr)) {
1006 memcpy(buf, u.sin6.sin6_addr.s6_addr + 12, 4);
1007 PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin6.sin6_port));
1009 /* This is stupid, but it's what XLib does. */
1015 buf = snewn(*lenp, char);
1016 PUT_32BIT_MSB_FIRST(buf, unix_addr--);
1017 PUT_16BIT_MSB_FIRST(buf+4, getpid());
1030 * Deal with socket errors detected in try_send().
1032 static void socket_error_callback(void *vs)
1034 Actual_Socket s = (Actual_Socket)vs;
1037 * Just in case other socket work has caused this socket to vanish
1038 * or become somehow non-erroneous before this callback arrived...
1040 if (!find234(sktree, s, NULL) || !s->pending_error)
1044 * An error has occurred on this socket. Pass it to the plug.
1046 plug_closing(s->plug, strerror(s->pending_error), s->pending_error, 0);
1050 * The function which tries to send on a socket once it's deemed
1053 void try_send(Actual_Socket s)
1055 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1059 int len, urgentflag;
1061 if (s->sending_oob) {
1062 urgentflag = MSG_OOB;
1063 len = s->sending_oob;
1067 bufchain_prefix(&s->output_data, &data, &len);
1069 nsent = send(s->s, data, len, urgentflag);
1070 noise_ultralight(nsent);
1072 err = (nsent < 0 ? errno : 0);
1073 if (err == EWOULDBLOCK) {
1075 * Perfectly normal: we've sent all we can for the moment.
1077 s->writable = FALSE;
1081 * We unfortunately can't just call plug_closing(),
1082 * because it's quite likely that we're currently
1083 * _in_ a call from the code we'd be calling back
1084 * to, so we'd have to make half the SSH code
1085 * reentrant. Instead we flag a pending error on
1086 * the socket, to be dealt with (by calling
1087 * plug_closing()) at some suitable future moment.
1089 s->pending_error = err;
1091 * Immediately cease selecting on this socket, so that
1092 * we don't tight-loop repeatedly trying to do
1093 * whatever it was that went wrong.
1097 * Arrange to be called back from the top level to
1098 * deal with the error condition on this socket.
1100 queue_toplevel_callback(socket_error_callback, s);
1104 if (s->sending_oob) {
1106 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1107 s->sending_oob = len - nsent;
1112 bufchain_consume(&s->output_data, nsent);
1118 * If we reach here, we've finished sending everything we might
1119 * have needed to send. Send EOF, if we need to.
1121 if (s->outgoingeof == EOF_PENDING) {
1122 shutdown(s->s, SHUT_WR);
1123 s->outgoingeof = EOF_SENT;
1127 * Also update the select status, because we don't need to select
1128 * for writing any more.
1133 static int sk_tcp_write(Socket sock, const char *buf, int len)
1135 Actual_Socket s = (Actual_Socket) sock;
1137 assert(s->outgoingeof == EOF_NO);
1140 * Add the data to the buffer list on the socket.
1142 bufchain_add(&s->output_data, buf, len);
1145 * Now try sending from the start of the buffer list.
1151 * Update the select() status to correctly reflect whether or
1152 * not we should be selecting for write.
1156 return bufchain_size(&s->output_data);
1159 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1161 Actual_Socket s = (Actual_Socket) sock;
1163 assert(s->outgoingeof == EOF_NO);
1166 * Replace the buffer list on the socket with the data.
1168 bufchain_clear(&s->output_data);
1169 assert(len <= sizeof(s->oobdata));
1170 memcpy(s->oobdata, buf, len);
1171 s->sending_oob = len;
1174 * Now try sending from the start of the buffer list.
1180 * Update the select() status to correctly reflect whether or
1181 * not we should be selecting for write.
1185 return s->sending_oob;
1188 static void sk_tcp_write_eof(Socket sock)
1190 Actual_Socket s = (Actual_Socket) sock;
1192 assert(s->outgoingeof == EOF_NO);
1195 * Mark the socket as pending outgoing EOF.
1197 s->outgoingeof = EOF_PENDING;
1200 * Now try sending from the start of the buffer list.
1206 * Update the select() status to correctly reflect whether or
1207 * not we should be selecting for write.
1212 static int net_select_result(int fd, int event)
1215 char buf[20480]; /* nice big buffer for plenty of speed */
1219 /* Find the Socket structure */
1220 s = find234(sktree, &fd, cmpforsearch);
1222 return 1; /* boggle */
1224 noise_ultralight(event);
1227 case 4: /* exceptional */
1228 if (!s->oobinline) {
1230 * On a non-oobinline socket, this indicates that we
1231 * can immediately perform an OOB read and get back OOB
1232 * data, which we will send to the back end with
1233 * type==2 (urgent data).
1235 ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
1236 noise_ultralight(ret);
1238 return plug_closing(s->plug,
1239 ret == 0 ? "Internal networking trouble" :
1240 strerror(errno), errno, 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, 2, buf, ret);
1257 * If we reach here, this is an oobinline socket, which
1258 * means we should set s->oobpending and then deal with it
1259 * when we get called for the readability event (which
1260 * should also occur).
1262 s->oobpending = TRUE;
1264 case 1: /* readable; also acceptance */
1267 * On a listening socket, the readability event means a
1268 * connection is ready to be accepted.
1270 union sockaddr_union su;
1271 socklen_t addrlen = sizeof(su);
1273 int t; /* socket of connection */
1275 memset(&su, 0, addrlen);
1276 t = accept(s->s, &su.sa, &addrlen);
1284 if (s->localhost_only &&
1285 !sockaddr_is_loopback(&su.sa)) {
1286 close(t); /* someone let nonlocal through?! */
1287 } else if (plug_accepting(s->plug, sk_tcp_accept, actx)) {
1288 close(t); /* denied or error */
1294 * If we reach here, this is not a listening socket, so
1295 * readability really means readability.
1298 /* In the case the socket is still frozen, we don't even bother */
1303 * We have received data on the socket. For an oobinline
1304 * socket, this might be data _before_ an urgent pointer,
1305 * in which case we send it to the back end with type==1
1306 * (data prior to urgent).
1308 if (s->oobinline && s->oobpending) {
1310 if (ioctl(s->s, SIOCATMARK, &atmark) == 0 && atmark)
1311 s->oobpending = FALSE; /* clear this indicator */
1315 ret = recv(s->s, buf, s->oobpending ? 1 : sizeof(buf), 0);
1316 noise_ultralight(ret);
1318 if (errno == EWOULDBLOCK) {
1324 * An error at this point _might_ be an error reported
1325 * by a non-blocking connect(). So before we return a
1326 * panic status to the user, let's just see whether
1331 plug_log(s->plug, 1, s->addr, s->port, strerror(err), err);
1332 while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1333 err = try_connect(s);
1337 return plug_closing(s->plug, strerror(err), err, 0);
1338 } else if (0 == ret) {
1339 s->incomingeof = TRUE; /* stop trying to read now */
1341 return plug_closing(s->plug, NULL, 0, 0);
1344 * Receiving actual data on a socket means we can
1345 * stop falling back through the candidate
1346 * addresses to connect to.
1349 sk_addr_free(s->addr);
1352 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1355 case 2: /* writable */
1356 if (!s->connected) {
1358 * select() reports a socket as _writable_ when an
1359 * asynchronous connection is completed.
1361 s->connected = s->writable = 1;
1365 int bufsize_before, bufsize_after;
1367 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1369 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1370 if (bufsize_after < bufsize_before)
1371 plug_sent(s->plug, bufsize_after);
1380 * Each socket abstraction contains a `void *' private field in
1381 * which the client can keep state.
1383 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1385 Actual_Socket s = (Actual_Socket) sock;
1386 s->private_ptr = ptr;
1389 static void *sk_tcp_get_private_ptr(Socket sock)
1391 Actual_Socket s = (Actual_Socket) sock;
1392 return s->private_ptr;
1396 * Special error values are returned from sk_namelookup and sk_new
1397 * if there's a problem. These functions extract an error message,
1398 * or return NULL if there's no problem.
1400 const char *sk_addr_error(SockAddr addr)
1404 static const char *sk_tcp_socket_error(Socket sock)
1406 Actual_Socket s = (Actual_Socket) sock;
1410 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1412 Actual_Socket s = (Actual_Socket) sock;
1413 if (s->frozen == is_frozen)
1415 s->frozen = is_frozen;
1419 static void uxsel_tell(Actual_Socket s)
1422 if (!s->pending_error) {
1424 rwx |= 1; /* read == accept */
1427 rwx |= 2; /* write == connect */
1428 if (s->connected && !s->frozen && !s->incomingeof)
1429 rwx |= 1 | 4; /* read, except */
1430 if (bufchain_size(&s->output_data))
1431 rwx |= 2; /* write */
1434 uxsel_set(s->s, rwx, net_select_result);
1437 int net_service_lookup(char *service)
1440 se = getservbyname(service, NULL);
1442 return ntohs(se->s_port);
1447 char *get_hostname(void)
1450 char *hostname = NULL;
1453 hostname = sresize(hostname, len, char);
1454 if ((gethostname(hostname, len) < 0) &&
1455 (errno != ENAMETOOLONG)) {
1460 } while (strlen(hostname) >= len-1);
1464 SockAddr platform_get_x11_unix_address(const char *sockpath, int displaynum)
1466 SockAddr ret = snew(struct SockAddr_tag);
1469 memset(ret, 0, sizeof *ret);
1470 ret->superfamily = UNIX;
1472 * In special circumstances (notably Mac OS X Leopard), we'll
1473 * have been passed an explicit Unix socket path.
1476 n = snprintf(ret->hostname, sizeof ret->hostname,
1479 n = snprintf(ret->hostname, sizeof ret->hostname,
1480 "%s%d", X11_UNIX_PATH, displaynum);
1484 ret->error = "snprintf failed";
1485 else if (n >= sizeof ret->hostname)
1486 ret->error = "X11 UNIX name too long";
1491 ret->addresses = NULL;
1492 ret->naddresses = 0;