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;
805 * Translate address_family from platform-independent constants
806 * into local reality.
808 address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
810 orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
815 /* Let's default to IPv6.
816 * If the stack doesn't support IPv6, we will fall back to IPv4. */
817 if (address_family == AF_UNSPEC) address_family = AF_INET6;
819 /* No other choice, default to IPv4 */
820 if (address_family == AF_UNSPEC) address_family = AF_INET;
826 s = socket(address_family, SOCK_STREAM, 0);
829 /* If the host doesn't support IPv6 try fallback to IPv4. */
830 if (s < 0 && address_family == AF_INET6) {
831 address_family = AF_INET;
832 s = socket(address_family, SOCK_STREAM, 0);
837 ret->error = strerror(errno);
845 if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
846 (const char *)&on, sizeof(on)) < 0) {
847 ret->error = strerror(errno);
853 addr = NULL; addrlen = -1; /* placate optimiser */
855 if (srcaddr != NULL) {
857 hints.ai_flags = AI_NUMERICHOST;
858 hints.ai_family = address_family;
859 hints.ai_socktype = SOCK_STREAM;
860 hints.ai_protocol = 0;
861 hints.ai_addrlen = 0;
862 hints.ai_addr = NULL;
863 hints.ai_canonname = NULL;
864 hints.ai_next = NULL;
865 assert(port >= 0 && port <= 99999);
866 sprintf(portstr, "%d", port);
867 retcode = getaddrinfo(srcaddr, portstr, &hints, &ai);
869 addr = (union sockaddr_union *)ai->ai_addr;
870 addrlen = ai->ai_addrlen;
873 memset(&u,'\0',sizeof u);
874 u.sin.sin_family = AF_INET;
875 u.sin.sin_port = htons(port);
876 u.sin.sin_addr.s_addr = inet_addr(srcaddr);
877 if (u.sin.sin_addr.s_addr != (in_addr_t)(-1)) {
878 /* Override localhost_only with specified listen addr. */
879 ret->localhost_only = ipv4_is_loopback(u.sin.sin_addr);
882 addrlen = sizeof(u.sin);
888 memset(&u,'\0',sizeof u);
890 if (address_family == AF_INET6) {
891 u.sin6.sin6_family = AF_INET6;
892 u.sin6.sin6_port = htons(port);
894 u.sin6.sin6_addr = in6addr_loopback;
896 u.sin6.sin6_addr = in6addr_any;
898 addrlen = sizeof(u.sin6);
902 u.sin.sin_family = AF_INET;
903 u.sin.sin_port = htons(port);
905 u.sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
907 u.sin.sin_addr.s_addr = htonl(INADDR_ANY);
909 addrlen = sizeof(u.sin);
913 retcode = bind(s, &addr->sa, addrlen);
916 ret->error = strerror(errno);
920 if (listen(s, SOMAXCONN) < 0) {
922 ret->error = strerror(errno);
928 * If we were given ADDRTYPE_UNSPEC, we must also create an
929 * IPv4 listening socket and link it to this one.
931 if (address_family == AF_INET6 && orig_address_family == ADDRTYPE_UNSPEC) {
934 other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
935 local_host_only, ADDRTYPE_IPV4);
942 /* If we couldn't create a listening socket on IPv4 as well
943 * as IPv6, we must return an error overall. */
946 return (Socket) other;
960 static void sk_tcp_close(Socket sock)
962 Actual_Socket s = (Actual_Socket) sock;
965 sk_tcp_close((Socket)s->child);
971 sk_addr_free(s->addr);
975 void *sk_getxdmdata(void *sock, int *lenp)
977 Actual_Socket s = (Actual_Socket) sock;
978 union sockaddr_union u;
981 static unsigned int unix_addr = 0xFFFFFFFF;
984 * We must check that this socket really _is_ an Actual_Socket.
986 if (s->fn != &tcp_fn_table)
987 return NULL; /* failure */
990 if (getsockname(s->s, &u.sa, &addrlen) < 0)
992 switch(u.sa.sa_family) {
995 buf = snewn(*lenp, char);
996 PUT_32BIT_MSB_FIRST(buf, ntohl(u.sin.sin_addr.s_addr));
997 PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin.sin_port));
1002 buf = snewn(*lenp, char);
1003 if (IN6_IS_ADDR_V4MAPPED(&u.sin6.sin6_addr)) {
1004 memcpy(buf, u.sin6.sin6_addr.s6_addr + 12, 4);
1005 PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin6.sin6_port));
1007 /* This is stupid, but it's what XLib does. */
1013 buf = snewn(*lenp, char);
1014 PUT_32BIT_MSB_FIRST(buf, unix_addr--);
1015 PUT_16BIT_MSB_FIRST(buf+4, getpid());
1028 * Deal with socket errors detected in try_send().
1030 static void socket_error_callback(void *vs)
1032 Actual_Socket s = (Actual_Socket)vs;
1035 * Just in case other socket work has caused this socket to vanish
1036 * or become somehow non-erroneous before this callback arrived...
1038 if (!find234(sktree, s, NULL) || !s->pending_error)
1042 * An error has occurred on this socket. Pass it to the plug.
1044 plug_closing(s->plug, strerror(s->pending_error), s->pending_error, 0);
1048 * The function which tries to send on a socket once it's deemed
1051 void try_send(Actual_Socket s)
1053 while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1057 int len, urgentflag;
1059 if (s->sending_oob) {
1060 urgentflag = MSG_OOB;
1061 len = s->sending_oob;
1065 bufchain_prefix(&s->output_data, &data, &len);
1067 nsent = send(s->s, data, len, urgentflag);
1068 noise_ultralight(nsent);
1070 err = (nsent < 0 ? errno : 0);
1071 if (err == EWOULDBLOCK) {
1073 * Perfectly normal: we've sent all we can for the moment.
1075 s->writable = FALSE;
1079 * We unfortunately can't just call plug_closing(),
1080 * because it's quite likely that we're currently
1081 * _in_ a call from the code we'd be calling back
1082 * to, so we'd have to make half the SSH code
1083 * reentrant. Instead we flag a pending error on
1084 * the socket, to be dealt with (by calling
1085 * plug_closing()) at some suitable future moment.
1087 s->pending_error = err;
1089 * Immediately cease selecting on this socket, so that
1090 * we don't tight-loop repeatedly trying to do
1091 * whatever it was that went wrong.
1095 * Arrange to be called back from the top level to
1096 * deal with the error condition on this socket.
1098 queue_toplevel_callback(socket_error_callback, s);
1102 if (s->sending_oob) {
1104 memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1105 s->sending_oob = len - nsent;
1110 bufchain_consume(&s->output_data, nsent);
1116 * If we reach here, we've finished sending everything we might
1117 * have needed to send. Send EOF, if we need to.
1119 if (s->outgoingeof == EOF_PENDING) {
1120 shutdown(s->s, SHUT_WR);
1121 s->outgoingeof = EOF_SENT;
1125 * Also update the select status, because we don't need to select
1126 * for writing any more.
1131 static int sk_tcp_write(Socket sock, const char *buf, int len)
1133 Actual_Socket s = (Actual_Socket) sock;
1135 assert(s->outgoingeof == EOF_NO);
1138 * Add the data to the buffer list on the socket.
1140 bufchain_add(&s->output_data, buf, len);
1143 * Now try sending from the start of the buffer list.
1149 * Update the select() status to correctly reflect whether or
1150 * not we should be selecting for write.
1154 return bufchain_size(&s->output_data);
1157 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1159 Actual_Socket s = (Actual_Socket) sock;
1161 assert(s->outgoingeof == EOF_NO);
1164 * Replace the buffer list on the socket with the data.
1166 bufchain_clear(&s->output_data);
1167 assert(len <= sizeof(s->oobdata));
1168 memcpy(s->oobdata, buf, len);
1169 s->sending_oob = len;
1172 * Now try sending from the start of the buffer list.
1178 * Update the select() status to correctly reflect whether or
1179 * not we should be selecting for write.
1183 return s->sending_oob;
1186 static void sk_tcp_write_eof(Socket sock)
1188 Actual_Socket s = (Actual_Socket) sock;
1190 assert(s->outgoingeof == EOF_NO);
1193 * Mark the socket as pending outgoing EOF.
1195 s->outgoingeof = EOF_PENDING;
1198 * Now try sending from the start of the buffer list.
1204 * Update the select() status to correctly reflect whether or
1205 * not we should be selecting for write.
1210 static int net_select_result(int fd, int event)
1213 char buf[20480]; /* nice big buffer for plenty of speed */
1217 /* Find the Socket structure */
1218 s = find234(sktree, &fd, cmpforsearch);
1220 return 1; /* boggle */
1222 noise_ultralight(event);
1225 case 4: /* exceptional */
1226 if (!s->oobinline) {
1228 * On a non-oobinline socket, this indicates that we
1229 * can immediately perform an OOB read and get back OOB
1230 * data, which we will send to the back end with
1231 * type==2 (urgent data).
1233 ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
1234 noise_ultralight(ret);
1236 return plug_closing(s->plug,
1237 ret == 0 ? "Internal networking trouble" :
1238 strerror(errno), errno, 0);
1241 * Receiving actual data on a socket means we can
1242 * stop falling back through the candidate
1243 * addresses to connect to.
1246 sk_addr_free(s->addr);
1249 return plug_receive(s->plug, 2, buf, ret);
1255 * If we reach here, this is an oobinline socket, which
1256 * means we should set s->oobpending and then deal with it
1257 * when we get called for the readability event (which
1258 * should also occur).
1260 s->oobpending = TRUE;
1262 case 1: /* readable; also acceptance */
1265 * On a listening socket, the readability event means a
1266 * connection is ready to be accepted.
1268 union sockaddr_union su;
1269 socklen_t addrlen = sizeof(su);
1271 int t; /* socket of connection */
1273 memset(&su, 0, addrlen);
1274 t = accept(s->s, &su.sa, &addrlen);
1282 if ((!s->addr || s->addr->superfamily != UNIX) &&
1283 s->localhost_only && !sockaddr_is_loopback(&su.sa)) {
1284 close(t); /* someone let nonlocal through?! */
1285 } else if (plug_accepting(s->plug, sk_tcp_accept, actx)) {
1286 close(t); /* denied or error */
1292 * If we reach here, this is not a listening socket, so
1293 * readability really means readability.
1296 /* In the case the socket is still frozen, we don't even bother */
1301 * We have received data on the socket. For an oobinline
1302 * socket, this might be data _before_ an urgent pointer,
1303 * in which case we send it to the back end with type==1
1304 * (data prior to urgent).
1306 if (s->oobinline && s->oobpending) {
1308 if (ioctl(s->s, SIOCATMARK, &atmark) == 0 && atmark)
1309 s->oobpending = FALSE; /* clear this indicator */
1313 ret = recv(s->s, buf, s->oobpending ? 1 : sizeof(buf), 0);
1314 noise_ultralight(ret);
1316 if (errno == EWOULDBLOCK) {
1322 * An error at this point _might_ be an error reported
1323 * by a non-blocking connect(). So before we return a
1324 * panic status to the user, let's just see whether
1329 plug_log(s->plug, 1, s->addr, s->port, strerror(err), err);
1330 while (s->addr && sk_nextaddr(s->addr, &s->step)) {
1331 err = try_connect(s);
1335 return plug_closing(s->plug, strerror(err), err, 0);
1336 } else if (0 == ret) {
1337 s->incomingeof = TRUE; /* stop trying to read now */
1339 return plug_closing(s->plug, NULL, 0, 0);
1342 * Receiving actual data on a socket means we can
1343 * stop falling back through the candidate
1344 * addresses to connect to.
1347 sk_addr_free(s->addr);
1350 return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1353 case 2: /* writable */
1354 if (!s->connected) {
1356 * select() reports a socket as _writable_ when an
1357 * asynchronous connection is completed.
1359 s->connected = s->writable = 1;
1363 int bufsize_before, bufsize_after;
1365 bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1367 bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1368 if (bufsize_after < bufsize_before)
1369 plug_sent(s->plug, bufsize_after);
1378 * Each socket abstraction contains a `void *' private field in
1379 * which the client can keep state.
1381 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1383 Actual_Socket s = (Actual_Socket) sock;
1384 s->private_ptr = ptr;
1387 static void *sk_tcp_get_private_ptr(Socket sock)
1389 Actual_Socket s = (Actual_Socket) sock;
1390 return s->private_ptr;
1394 * Special error values are returned from sk_namelookup and sk_new
1395 * if there's a problem. These functions extract an error message,
1396 * or return NULL if there's no problem.
1398 const char *sk_addr_error(SockAddr addr)
1402 static const char *sk_tcp_socket_error(Socket sock)
1404 Actual_Socket s = (Actual_Socket) sock;
1408 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1410 Actual_Socket s = (Actual_Socket) sock;
1411 if (s->frozen == is_frozen)
1413 s->frozen = is_frozen;
1417 static void uxsel_tell(Actual_Socket s)
1420 if (!s->pending_error) {
1422 rwx |= 1; /* read == accept */
1425 rwx |= 2; /* write == connect */
1426 if (s->connected && !s->frozen && !s->incomingeof)
1427 rwx |= 1 | 4; /* read, except */
1428 if (bufchain_size(&s->output_data))
1429 rwx |= 2; /* write */
1432 uxsel_set(s->s, rwx, net_select_result);
1435 int net_service_lookup(char *service)
1438 se = getservbyname(service, NULL);
1440 return ntohs(se->s_port);
1445 char *get_hostname(void)
1448 char *hostname = NULL;
1451 hostname = sresize(hostname, len, char);
1452 if ((gethostname(hostname, len) < 0) &&
1453 (errno != ENAMETOOLONG)) {
1458 } while (strlen(hostname) >= len-1);
1462 SockAddr platform_get_x11_unix_address(const char *sockpath, int displaynum)
1464 SockAddr ret = snew(struct SockAddr_tag);
1467 memset(ret, 0, sizeof *ret);
1468 ret->superfamily = UNIX;
1470 * In special circumstances (notably Mac OS X Leopard), we'll
1471 * have been passed an explicit Unix socket path.
1474 n = snprintf(ret->hostname, sizeof ret->hostname,
1477 n = snprintf(ret->hostname, sizeof ret->hostname,
1478 "%s%d", X11_UNIX_PATH, displaynum);
1482 ret->error = "snprintf failed";
1483 else if (n >= sizeof ret->hostname)
1484 ret->error = "X11 UNIX name too long";
1489 ret->addresses = NULL;
1490 ret->naddresses = 0;
1496 SockAddr unix_sock_addr(const char *path)
1498 SockAddr ret = snew(struct SockAddr_tag);
1501 memset(ret, 0, sizeof *ret);
1502 ret->superfamily = UNIX;
1503 n = snprintf(ret->hostname, sizeof ret->hostname, "%s", path);
1506 ret->error = "snprintf failed";
1507 else if (n >= sizeof ret->hostname)
1508 ret->error = "socket pathname too long";
1513 ret->addresses = NULL;
1514 ret->naddresses = 0;
1520 Socket new_unix_listener(SockAddr listenaddr, Plug plug)
1523 union sockaddr_union u;
1524 union sockaddr_union *addr;
1530 * Create Socket structure.
1532 ret = snew(struct Socket_tag);
1533 ret->fn = &tcp_fn_table;
1536 bufchain_init(&ret->output_data);
1537 ret->writable = 0; /* to start with */
1538 ret->sending_oob = 0;
1540 ret->localhost_only = TRUE;
1541 ret->pending_error = 0;
1542 ret->parent = ret->child = NULL;
1543 ret->oobpending = FALSE;
1544 ret->outgoingeof = EOF_NO;
1545 ret->incomingeof = FALSE;
1547 ret->addr = listenaddr;
1550 assert(listenaddr->superfamily == UNIX);
1555 s = socket(AF_UNIX, SOCK_STREAM, 0);
1557 ret->error = strerror(errno);
1558 return (Socket) ret;
1565 memset(&u, '\0', sizeof(u));
1566 u.su.sun_family = AF_UNIX;
1567 strncpy(u.su.sun_path, listenaddr->hostname, sizeof(u.su.sun_path)-1);
1569 addrlen = sizeof(u.su);
1571 if (unlink(u.su.sun_path) < 0 && errno != ENOENT) {
1573 ret->error = strerror(errno);
1574 return (Socket) ret;
1577 retcode = bind(s, &addr->sa, addrlen);
1580 ret->error = strerror(errno);
1581 return (Socket) ret;
1584 if (listen(s, SOMAXCONN) < 0) {
1586 ret->error = strerror(errno);
1587 return (Socket) ret;
1593 add234(sktree, ret);
1595 return (Socket) ret;