unix/uxnet.c

   1 /*
   2  * Unix networking abstraction.
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <assert.h>
   8 #include <errno.h>
   9 #include <fcntl.h>
  10 #include <unistd.h>
  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>
  17 #include <netdb.h>
  18 #include <sys/un.h>
  19
  20 #define DEFINE_PLUG_METHOD_MACROS
  21 #include "putty.h"
  22 #include "network.h"
  23 #include "tree234.h"
  24
  25 /* Solaris needs <sys/sockio.h> for SIOCATMARK. */
  26 #ifndef SIOCATMARK
  27 #include <sys/sockio.h>
  28 #endif
  29
  30 #ifndef X11_UNIX_PATH
  31 # define X11_UNIX_PATH "/tmp/.X11-unix/X"
  32 #endif
  33
  34 /*
  35  * Access to sockaddr types without breaking C strict aliasing rules.
  36  */
  37 union sockaddr_union {
  38 #ifdef NO_IPV6
  39     struct sockaddr_in storage;
  40 #else
  41     struct sockaddr_storage storage;
  42     struct sockaddr_in6 sin6;
  43 #endif
  44     struct sockaddr sa;
  45     struct sockaddr_in sin;
  46     struct sockaddr_un su;
  47 };
  48
  49 /*
  50  * We used to typedef struct Socket_tag *Socket.
  51  *
  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.
  56  */
  57 typedef struct Socket_tag *Actual_Socket;
  58
  59 /*
  60  * Mutable state that goes with a SockAddr: stores information
  61  * about where in the list of candidate IP(v*) addresses we've
  62  * currently got to.
  63  */
  64 typedef struct SockAddrStep_tag SockAddrStep;
  65 struct SockAddrStep_tag {
  66 #ifndef NO_IPV6
  67     struct addrinfo *ai;               /* steps along addr->ais */
  68 #endif
  69     int curraddr;
  70 };
  71
  72 struct Socket_tag {
  73     struct socket_function_table *fn;
  74     /* the above variable absolutely *must* be the first in this structure */
  75     const char *error;
  76     int s;
  77     Plug plug;
  78     void *private_ptr;
  79     bufchain output_data;
  80     int connected;                     /* irrelevant for listening sockets */
  81     int writable;
  82     int frozen; /* this causes readability notifications to be ignored */
  83     int localhost_only;                /* for listening sockets */
  84     char oobdata[1];
  85     int sending_oob;
  86     int oobpending;                    /* is there OOB data available to read? */
  87     int oobinline;
  88     enum { EOF_NO, EOF_PENDING, EOF_SENT } outgoingeof;
  89     int incomingeof;
  90     int pending_error;                 /* in case send() returns error */
  91     int listener;
  92     int nodelay, keepalive;            /* for connect()-type sockets */
  93     int privport, port;                /* and again */
  94     SockAddr addr;
  95     SockAddrStep step;
  96     /*
  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
 100      * track this link.
 101      */
 102     Actual_Socket parent, child;
 103 };
 104
 105 struct SockAddr_tag {
 106     int refcount;
 107     const char *error;
 108     enum { UNRESOLVED, UNIX, IP } superfamily;
 109 #ifndef NO_IPV6
 110     struct addrinfo *ais;              /* Addresses IPv6 style. */
 111 #else
 112     unsigned long *addresses;          /* Addresses IPv4 style. */
 113     int naddresses;
 114 #endif
 115     char hostname[512];                /* Store an unresolved host name. */
 116 };
 117
 118 /*
 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
 122  * structure.
 123  */
 124 #ifndef NO_IPV6
 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)
 129 #else
 130 #define SOCKADDR_FAMILY(addr, step) \
 131     ((addr)->superfamily == UNRESOLVED ? AF_UNSPEC : \
 132      (addr)->superfamily == UNIX ? AF_UNIX : AF_INET)
 133 #endif
 134
 135 /*
 136  * Start a SockAddrStep structure to step through multiple
 137  * addresses.
 138  */
 139 #ifndef NO_IPV6
 140 #define START_STEP(addr, step) \
 141     ((step).ai = (addr)->ais, (step).curraddr = 0)
 142 #else
 143 #define START_STEP(addr, step) \
 144     ((step).curraddr = 0)
 145 #endif
 146
 147 static tree234 *sktree;
 148
 149 static void uxsel_tell(Actual_Socket s);
 150
 151 static int cmpfortree(void *av, void *bv)
 152 {
 153     Actual_Socket a = (Actual_Socket) av, b = (Actual_Socket) bv;
 154     int as = a->s, bs = b->s;
 155     if (as < bs)
 156         return -1;
 157     if (as > bs)
 158         return +1;
 159     if (a < b)
 160        return -1;
 161     if (a > b)
 162        return +1;
 163     return 0;
 164 }
 165
 166 static int cmpforsearch(void *av, void *bv)
 167 {
 168     Actual_Socket b = (Actual_Socket) bv;
 169     int as = *(int *)av, bs = b->s;
 170     if (as < bs)
 171         return -1;
 172     if (as > bs)
 173         return +1;
 174     return 0;
 175 }
 176
 177 void sk_init(void)
 178 {
 179     sktree = newtree234(cmpfortree);
 180 }
 181
 182 void sk_cleanup(void)
 183 {
 184     Actual_Socket s;
 185     int i;
 186
 187     if (sktree) {
 188         for (i = 0; (s = index234(sktree, i)) != NULL; i++) {
 189             close(s->s);
 190         }
 191     }
 192 }
 193
 194 SockAddr sk_namelookup(const char *host, char **canonicalname, int address_family)
 195 {
 196     SockAddr ret = snew(struct SockAddr_tag);
 197 #ifndef NO_IPV6
 198     struct addrinfo hints;
 199     int err;
 200 #else
 201     unsigned long a;
 202     struct hostent *h = NULL;
 203     int n;
 204 #endif
 205     char realhost[8192];
 206
 207     /* Clear the structure and default to IPv4. */
 208     memset(ret, 0, sizeof(struct SockAddr_tag));
 209     ret->superfamily = UNRESOLVED;
 210     *realhost = '\0';
 211     ret->error = NULL;
 212     ret->refcount = 1;
 213
 214 #ifndef NO_IPV6
 215     hints.ai_flags = AI_CANONNAME;
 216     hints.ai_family = (address_family == ADDRTYPE_IPV4 ? AF_INET :
 217                        address_family == ADDRTYPE_IPV6 ? AF_INET6 :
 218                        AF_UNSPEC);
 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);
 226     if (err != 0) {
 227         ret->error = gai_strerror(err);
 228         return ret;
 229     }
 230     ret->superfamily = IP;
 231     *realhost = '\0';
 232     if (ret->ais->ai_canonname != NULL)
 233         strncat(realhost, ret->ais->ai_canonname, sizeof(realhost) - 1);
 234     else
 235         strncat(realhost, host, sizeof(realhost) - 1);
 236 #else
 237     if ((a = inet_addr(host)) == (unsigned long)(in_addr_t)(-1)) {
 238         /*
 239          * Otherwise use the IPv4-only gethostbyname... (NOTE:
 240          * we don't use gethostbyname as a fallback!)
 241          */
 242         if (ret->superfamily == UNRESOLVED) {
 243             /*debug(("Resolving \"%s\" with gethostbyname() (IPv4 only)...\n", host)); */
 244             if ( (h = gethostbyname(host)) )
 245                 ret->superfamily = IP;
 246         }
 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");
 254             return ret;
 255         }
 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);
 260         ret->naddresses = n;
 261         for (n = 0; n < ret->naddresses; n++) {
 262             memcpy(&a, h->h_addr_list[n], sizeof(a));
 263             ret->addresses[n] = ntohl(a);
 264         }
 265     } else {
 266         /*
 267          * This must be a numeric IPv4 address because it caused a
 268          * success return from inet_addr.
 269          */
 270         ret->superfamily = IP;
 271         strncpy(realhost, host, sizeof(realhost));
 272         ret->addresses = snew(unsigned long);
 273         ret->naddresses = 1;
 274         ret->addresses[0] = ntohl(a);
 275     }
 276 #endif
 277     realhost[lenof(realhost)-1] = '\0';
 278     *canonicalname = snewn(1+strlen(realhost), char);
 279     strcpy(*canonicalname, realhost);
 280     return ret;
 281 }
 282
 283 SockAddr sk_nonamelookup(const char *host)
 284 {
 285     SockAddr ret = snew(struct SockAddr_tag);
 286     ret->error = NULL;
 287     ret->superfamily = UNRESOLVED;
 288     strncpy(ret->hostname, host, lenof(ret->hostname));
 289     ret->hostname[lenof(ret->hostname)-1] = '\0';
 290 #ifndef NO_IPV6
 291     ret->ais = NULL;
 292 #else
 293     ret->addresses = NULL;
 294 #endif
 295     ret->refcount = 1;
 296     return ret;
 297 }
 298
 299 static int sk_nextaddr(SockAddr addr, SockAddrStep *step)
 300 {
 301 #ifndef NO_IPV6
 302     if (step->ai && step->ai->ai_next) {
 303         step->ai = step->ai->ai_next;
 304         return TRUE;
 305     } else
 306         return FALSE;
 307 #else
 308     if (step->curraddr+1 < addr->naddresses) {
 309         step->curraddr++;
 310         return TRUE;
 311     } else {
 312         return FALSE;
 313     }
 314 #endif
 315 }
 316
 317 void sk_getaddr(SockAddr addr, char *buf, int buflen)
 318 {
 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';
 325     } else {
 326 #ifndef NO_IPV6
 327         if (getnameinfo(addr->ais->ai_addr, addr->ais->ai_addrlen, buf, buflen,
 328                         NULL, 0, NI_NUMERICHOST) != 0) {
 329             buf[0] = '\0';
 330             strncat(buf, "<unknown>", buflen - 1);
 331         }
 332 #else
 333         struct in_addr a;
 334         SockAddrStep step;
 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';
 340 #endif
 341     }
 342 }
 343
 344 int sk_hostname_is_local(const char *name)
 345 {
 346     return !strcmp(name, "localhost") ||
 347            !strcmp(name, "::1") ||
 348            !strncmp(name, "127.", 4);
 349 }
 350
 351 #define ipv4_is_loopback(addr) \
 352     (((addr).s_addr & htonl(0xff000000)) == htonl(0x7f000000))
 353
 354 static int sockaddr_is_loopback(struct sockaddr *sa)
 355 {
 356     union sockaddr_union *u = (union sockaddr_union *)sa;
 357     switch (u->sa.sa_family) {
 358       case AF_INET:
 359         return ipv4_is_loopback(u->sin.sin_addr);
 360 #ifndef NO_IPV6
 361       case AF_INET6:
 362         return IN6_IS_ADDR_LOOPBACK(&u->sin6.sin6_addr);
 363 #endif
 364       case AF_UNIX:
 365         return TRUE;
 366       default:
 367         return FALSE;
 368     }
 369 }
 370
 371 int sk_address_is_local(SockAddr addr)
 372 {
 373     if (addr->superfamily == UNRESOLVED)
 374         return 0;                      /* we don't know; assume not */
 375     else if (addr->superfamily == UNIX)
 376         return 1;
 377     else {
 378 #ifndef NO_IPV6
 379         return sockaddr_is_loopback(addr->ais->ai_addr);
 380 #else
 381         struct in_addr a;
 382         SockAddrStep step;
 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);
 387 #endif
 388     }
 389 }
 390
 391 int sk_address_is_special_local(SockAddr addr)
 392 {
 393     return addr->superfamily == UNIX;
 394 }
 395
 396 int sk_addrtype(SockAddr addr)
 397 {
 398     SockAddrStep step;
 399     int family;
 400     START_STEP(addr, step);
 401     family = SOCKADDR_FAMILY(addr, step);
 402
 403     return (family == AF_INET ? ADDRTYPE_IPV4 :
 404 #ifndef NO_IPV6
 405             family == AF_INET6 ? ADDRTYPE_IPV6 :
 406 #endif
 407             ADDRTYPE_NAME);
 408 }
 409
 410 void sk_addrcopy(SockAddr addr, char *buf)
 411 {
 412     SockAddrStep step;
 413     int family;
 414     START_STEP(addr, step);
 415     family = SOCKADDR_FAMILY(addr, step);
 416
 417 #ifndef NO_IPV6
 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));
 424     else
 425         assert(FALSE);
 426 #else
 427     struct in_addr a;
 428
 429     assert(family == AF_INET);
 430     a.s_addr = htonl(addr->addresses[step.curraddr]);
 431     memcpy(buf, (char*) &a.s_addr, 4);
 432 #endif
 433 }
 434
 435 void sk_addr_free(SockAddr addr)
 436 {
 437     if (--addr->refcount > 0)
 438         return;
 439 #ifndef NO_IPV6
 440     if (addr->ais != NULL)
 441         freeaddrinfo(addr->ais);
 442 #else
 443     sfree(addr->addresses);
 444 #endif
 445     sfree(addr);
 446 }
 447
 448 SockAddr sk_addr_dup(SockAddr addr)
 449 {
 450     addr->refcount++;
 451     return addr;
 452 }
 453
 454 static Plug sk_tcp_plug(Socket sock, Plug p)
 455 {
 456     Actual_Socket s = (Actual_Socket) sock;
 457     Plug ret = s->plug;
 458     if (p)
 459         s->plug = p;
 460     return ret;
 461 }
 462
 463 static void sk_tcp_flush(Socket s)
 464 {
 465     /*
 466      * We send data to the socket as soon as we can anyway,
 467      * so we don't need to do anything here.  :-)
 468      */
 469 }
 470
 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);
 479
 480 static struct socket_function_table tcp_fn_table = {
 481     sk_tcp_plug,
 482     sk_tcp_close,
 483     sk_tcp_write,
 484     sk_tcp_write_oob,
 485     sk_tcp_write_eof,
 486     sk_tcp_flush,
 487     sk_tcp_set_private_ptr,
 488     sk_tcp_get_private_ptr,
 489     sk_tcp_set_frozen,
 490     sk_tcp_socket_error
 491 };
 492
 493 Socket sk_register(OSSocket sockfd, Plug plug)
 494 {
 495     Actual_Socket ret;
 496
 497     /*
 498      * Create Socket structure.
 499      */
 500     ret = snew(struct Socket_tag);
 501     ret->fn = &tcp_fn_table;
 502     ret->error = NULL;
 503     ret->plug = plug;
 504     bufchain_init(&ret->output_data);
 505     ret->writable = 1;                 /* to start with */
 506     ret->sending_oob = 0;
 507     ret->frozen = 1;
 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;
 513     ret->listener = 0;
 514     ret->parent = ret->child = NULL;
 515     ret->addr = NULL;
 516     ret->connected = 1;
 517
 518     ret->s = sockfd;
 519
 520     if (ret->s < 0) {
 521         ret->error = strerror(errno);
 522         return (Socket) ret;
 523     }
 524
 525     ret->oobinline = 0;
 526
 527     uxsel_tell(ret);
 528     add234(sktree, ret);
 529
 530     return (Socket) ret;
 531 }
 532
 533 static int try_connect(Actual_Socket sock)
 534 {
 535     int s;
 536     union sockaddr_union u;
 537     const union sockaddr_union *sa;
 538     int err = 0;
 539     short localport;
 540     int salen, family;
 541
 542     /*
 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.
 547      */
 548     del234(sktree, sock);
 549
 550     if (sock->s >= 0)
 551         close(sock->s);
 552
 553     plug_log(sock->plug, 0, sock->addr, sock->port, NULL, 0);
 554
 555     /*
 556      * Open socket.
 557      */
 558     family = SOCKADDR_FAMILY(sock->addr, sock->step);
 559     assert(family != AF_UNSPEC);
 560     s = socket(family, SOCK_STREAM, 0);
 561     sock->s = s;
 562
 563     if (s < 0) {
 564         err = errno;
 565         goto ret;
 566     }
 567
 568     cloexec(s);
 569
 570     if (sock->oobinline) {
 571         int b = TRUE;
 572         if (setsockopt(s, SOL_SOCKET, SO_OOBINLINE,
 573                        (void *) &b, sizeof(b)) < 0) {
 574             err = errno;
 575             close(s);
 576             goto ret;
 577         }
 578     }
 579
 580     if (sock->nodelay) {
 581         int b = TRUE;
 582         if (setsockopt(s, IPPROTO_TCP, TCP_NODELAY,
 583                        (void *) &b, sizeof(b)) < 0) {
 584             err = errno;
 585             close(s);
 586             goto ret;
 587         }
 588     }
 589
 590     if (sock->keepalive) {
 591         int b = TRUE;
 592         if (setsockopt(s, SOL_SOCKET, SO_KEEPALIVE,
 593                        (void *) &b, sizeof(b)) < 0) {
 594             err = errno;
 595             close(s);
 596             goto ret;
 597         }
 598     }
 599
 600     /*
 601      * Bind to local address.
 602      */
 603     if (sock->privport)
 604         localport = 1023;              /* count from 1023 downwards */
 605     else
 606         localport = 0;                 /* just use port 0 (ie kernel picks) */
 607
 608     /* BSD IP stacks need sockaddr_in zeroed before filling in */
 609     memset(&u,'\0',sizeof(u));
 610
 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 */
 615         while (1) {
 616             int retcode;
 617
 618 #ifndef NO_IPV6
 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));
 625             } else
 626 #endif
 627             {
 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));
 633             }
 634             if (retcode >= 0) {
 635                 err = 0;
 636                 break;                 /* done */
 637             } else {
 638                 err = errno;
 639                 if (err != EADDRINUSE) /* failed, for a bad reason */
 640                   break;
 641             }
 642
 643             if (localport == 0)
 644               break;                   /* we're only looping once */
 645             localport--;
 646             if (localport == 0)
 647               break;                   /* we might have got to the end */
 648         }
 649
 650         if (err)
 651             goto ret;
 652     }
 653
 654     /*
 655      * Connect to remote address.
 656      */
 657     switch(family) {
 658 #ifndef NO_IPV6
 659       case AF_INET:
 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 =
 662             htons(sock->port);
 663         sa = (const union sockaddr_union *)sock->step.ai->ai_addr;
 664         salen = sock->step.ai->ai_addrlen;
 665         break;
 666       case AF_INET6:
 667         ((struct sockaddr_in *)sock->step.ai->ai_addr)->sin_port =
 668             htons(sock->port);
 669         sa = (const union sockaddr_union *)sock->step.ai->ai_addr;
 670         salen = sock->step.ai->ai_addrlen;
 671         break;
 672 #else
 673       case AF_INET:
 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);
 677         sa = &u;
 678         salen = sizeof u.sin;
 679         break;
 680 #endif
 681       case AF_UNIX:
 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);
 686         sa = &u;
 687         salen = sizeof u.su;
 688         break;
 689
 690       default:
 691         assert(0 && "unknown address family");
 692         exit(1); /* XXX: GCC doesn't understand assert() on some systems. */
 693     }
 694
 695     nonblock(s);
 696
 697     if ((connect(s, &(sa->sa), salen)) < 0) {
 698         if ( errno != EINPROGRESS ) {
 699             err = errno;
 700             goto ret;
 701         }
 702     } else {
 703         /*
 704          * If we _don't_ get EWOULDBLOCK, the connect has completed
 705          * and we should set the socket as connected and writable.
 706          */
 707         sock->connected = 1;
 708         sock->writable = 1;
 709     }
 710
 711     uxsel_tell(sock);
 712
 713     ret:
 714
 715     /*
 716      * No matter what happened, put the socket back in the tree.
 717      */
 718     add234(sktree, sock);
 719
 720     if (err)
 721         plug_log(sock->plug, 1, sock->addr, sock->port, strerror(err), err);
 722     return err;
 723 }
 724
 725 Socket sk_new(SockAddr addr, int port, int privport, int oobinline,
 726               int nodelay, int keepalive, Plug plug)
 727 {
 728     Actual_Socket ret;
 729     int err;
 730
 731     /*
 732      * Create Socket structure.
 733      */
 734     ret = snew(struct Socket_tag);
 735     ret->fn = &tcp_fn_table;
 736     ret->error = NULL;
 737     ret->plug = plug;
 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;
 742     ret->frozen = 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;
 749     ret->listener = 0;
 750     ret->addr = addr;
 751     START_STEP(ret->addr, ret->step);
 752     ret->s = -1;
 753     ret->oobinline = oobinline;
 754     ret->nodelay = nodelay;
 755     ret->keepalive = keepalive;
 756     ret->privport = privport;
 757     ret->port = port;
 758
 759     err = 0;
 760     do {
 761         err = try_connect(ret);
 762     } while (err && sk_nextaddr(ret->addr, &ret->step));
 763
 764     if (err)
 765         ret->error = strerror(err);
 766
 767     return (Socket) ret;
 768 }
 769
 770 Socket sk_newlistener(char *srcaddr, int port, Plug plug, int local_host_only, int orig_address_family)
 771 {
 772     int s;
 773 #ifndef NO_IPV6
 774     struct addrinfo hints, *ai;
 775     char portstr[6];
 776 #endif
 777     union sockaddr_union u;
 778     union sockaddr_union *addr;
 779     int addrlen;
 780     Actual_Socket ret;
 781     int retcode;
 782     int address_family;
 783     int on = 1;
 784
 785     /*
 786      * Create Socket structure.
 787      */
 788     ret = snew(struct Socket_tag);
 789     ret->fn = &tcp_fn_table;
 790     ret->error = NULL;
 791     ret->plug = plug;
 792     bufchain_init(&ret->output_data);
 793     ret->writable = 0;                 /* to start with */
 794     ret->sending_oob = 0;
 795     ret->frozen = 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;
 802     ret->listener = 1;
 803     ret->addr = NULL;
 804
 805     /*
 806      * Translate address_family from platform-independent constants
 807      * into local reality.
 808      */
 809     address_family = (orig_address_family == ADDRTYPE_IPV4 ? AF_INET :
 810 #ifndef NO_IPV6
 811                       orig_address_family == ADDRTYPE_IPV6 ? AF_INET6 :
 812 #endif
 813                       AF_UNSPEC);
 814
 815 #ifndef NO_IPV6
 816     /* Let's default to IPv6.
 817      * If the stack doesn't support IPv6, we will fall back to IPv4. */
 818     if (address_family == AF_UNSPEC) address_family = AF_INET6;
 819 #else
 820     /* No other choice, default to IPv4 */
 821     if (address_family == AF_UNSPEC)  address_family = AF_INET;
 822 #endif
 823
 824     /*
 825      * Open socket.
 826      */
 827     s = socket(address_family, SOCK_STREAM, 0);
 828
 829 #ifndef NO_IPV6
 830     /* If the host doesn't support IPv6 try fallback to IPv4. */
 831     if (s < 0 && address_family == AF_INET6) {
 832         address_family = AF_INET;
 833         s = socket(address_family, SOCK_STREAM, 0);
 834     }
 835 #endif
 836
 837     if (s < 0) {
 838         ret->error = strerror(errno);
 839         return (Socket) ret;
 840     }
 841
 842     cloexec(s);
 843
 844     ret->oobinline = 0;
 845
 846     if (setsockopt(s, SOL_SOCKET, SO_REUSEADDR,
 847                    (const char *)&on, sizeof(on)) < 0) {
 848         ret->error = strerror(errno);
 849         close(s);
 850         return (Socket) ret;
 851     }
 852
 853     retcode = -1;
 854     addr = NULL; addrlen = -1;         /* placate optimiser */
 855
 856     if (srcaddr != NULL) {
 857 #ifndef NO_IPV6
 858         hints.ai_flags = AI_NUMERICHOST;
 859         hints.ai_family = address_family;
 860         hints.ai_socktype = SOCK_STREAM;
 861         hints.ai_protocol = 0;
 862         hints.ai_addrlen = 0;
 863         hints.ai_addr = NULL;
 864         hints.ai_canonname = NULL;
 865         hints.ai_next = NULL;
 866         assert(port >= 0 && port <= 99999);
 867         sprintf(portstr, "%d", port);
 868         retcode = getaddrinfo(srcaddr, portstr, &hints, &ai);
 869         if (retcode == 0) {
 870             addr = (union sockaddr_union *)ai->ai_addr;
 871             addrlen = ai->ai_addrlen;
 872         }
 873 #else
 874         memset(&u,'\0',sizeof u);
 875         u.sin.sin_family = AF_INET;
 876         u.sin.sin_port = htons(port);
 877         u.sin.sin_addr.s_addr = inet_addr(srcaddr);
 878         if (u.sin.sin_addr.s_addr != (in_addr_t)(-1)) {
 879             /* Override localhost_only with specified listen addr. */
 880             ret->localhost_only = ipv4_is_loopback(u.sin.sin_addr);
 881         }
 882         addr = &u;
 883         addrlen = sizeof(u.sin);
 884         retcode = 0;
 885 #endif
 886     }
 887
 888     if (retcode != 0) {
 889         memset(&u,'\0',sizeof u);
 890 #ifndef NO_IPV6
 891         if (address_family == AF_INET6) {
 892             u.sin6.sin6_family = AF_INET6;
 893             u.sin6.sin6_port = htons(port);
 894             if (local_host_only)
 895                 u.sin6.sin6_addr = in6addr_loopback;
 896             else
 897                 u.sin6.sin6_addr = in6addr_any;
 898             addr = &u;
 899             addrlen = sizeof(u.sin6);
 900         } else
 901 #endif
 902         {
 903             u.sin.sin_family = AF_INET;
 904             u.sin.sin_port = htons(port);
 905             if (local_host_only)
 906                 u.sin.sin_addr.s_addr = htonl(INADDR_LOOPBACK);
 907             else
 908                 u.sin.sin_addr.s_addr = htonl(INADDR_ANY);
 909             addr = &u;
 910             addrlen = sizeof(u.sin);
 911         }
 912     }
 913
 914     retcode = bind(s, &addr->sa, addrlen);
 915     if (retcode < 0) {
 916         close(s);
 917         ret->error = strerror(errno);
 918         return (Socket) ret;
 919     }
 920
 921     if (listen(s, SOMAXCONN) < 0) {
 922         close(s);
 923         ret->error = strerror(errno);
 924         return (Socket) ret;
 925     }
 926
 927 #ifndef NO_IPV6
 928     /*
 929      * If we were given ADDRTYPE_UNSPEC, we must also create an
 930      * IPv4 listening socket and link it to this one.
 931      */
 932     if (address_family == AF_INET6 && orig_address_family == ADDRTYPE_UNSPEC) {
 933         Actual_Socket other;
 934
 935         other = (Actual_Socket) sk_newlistener(srcaddr, port, plug,
 936                                                local_host_only, ADDRTYPE_IPV4);
 937
 938         if (other) {
 939             if (!other->error) {
 940                 other->parent = ret;
 941                 ret->child = other;
 942             } else {
 943                 /* If we couldn't create a listening socket on IPv4 as well
 944                  * as IPv6, we must return an error overall. */
 945                 close(s);
 946                 sfree(ret);
 947                 return (Socket) other;
 948             }
 949         }
 950     }
 951 #endif
 952
 953     ret->s = s;
 954
 955     uxsel_tell(ret);
 956     add234(sktree, ret);
 957
 958     return (Socket) ret;
 959 }
 960
 961 static void sk_tcp_close(Socket sock)
 962 {
 963     Actual_Socket s = (Actual_Socket) sock;
 964
 965     if (s->child)
 966         sk_tcp_close((Socket)s->child);
 967
 968     uxsel_del(s->s);
 969     del234(sktree, s);
 970     close(s->s);
 971     if (s->addr)
 972         sk_addr_free(s->addr);
 973     sfree(s);
 974 }
 975
 976 void *sk_getxdmdata(void *sock, int *lenp)
 977 {
 978     Actual_Socket s = (Actual_Socket) sock;
 979     union sockaddr_union u;
 980     socklen_t addrlen;
 981     char *buf;
 982     static unsigned int unix_addr = 0xFFFFFFFF;
 983
 984     /*
 985      * We must check that this socket really _is_ an Actual_Socket.
 986      */
 987     if (s->fn != &tcp_fn_table)
 988         return NULL;                   /* failure */
 989
 990     addrlen = sizeof(u);
 991     if (getsockname(s->s, &u.sa, &addrlen) < 0)
 992         return NULL;
 993     switch(u.sa.sa_family) {
 994       case AF_INET:
 995         *lenp = 6;
 996         buf = snewn(*lenp, char);
 997         PUT_32BIT_MSB_FIRST(buf, ntohl(u.sin.sin_addr.s_addr));
 998         PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin.sin_port));
 999         break;
1000 #ifndef NO_IPV6
1001     case AF_INET6:
1002         *lenp = 6;
1003         buf = snewn(*lenp, char);
1004         if (IN6_IS_ADDR_V4MAPPED(&u.sin6.sin6_addr)) {
1005             memcpy(buf, u.sin6.sin6_addr.s6_addr + 12, 4);
1006             PUT_16BIT_MSB_FIRST(buf+4, ntohs(u.sin6.sin6_port));
1007         } else
1008             /* This is stupid, but it's what XLib does. */
1009             memset(buf, 0, 6);
1010         break;
1011 #endif
1012       case AF_UNIX:
1013         *lenp = 6;
1014         buf = snewn(*lenp, char);
1015         PUT_32BIT_MSB_FIRST(buf, unix_addr--);
1016         PUT_16BIT_MSB_FIRST(buf+4, getpid());
1017         break;
1018
1019         /* XXX IPV6 */
1020
1021       default:
1022         return NULL;
1023     }
1024
1025     return buf;
1026 }
1027
1028 /*
1029  * Deal with socket errors detected in try_send().
1030  */
1031 static void socket_error_callback(void *vs)
1032 {
1033     Actual_Socket s = (Actual_Socket)vs;
1034
1035     /*
1036      * Just in case other socket work has caused this socket to vanish
1037      * or become somehow non-erroneous before this callback arrived...
1038      */
1039     if (!find234(sktree, s, NULL) || !s->pending_error)
1040         return;
1041
1042     /*
1043      * An error has occurred on this socket. Pass it to the plug.
1044      */
1045     plug_closing(s->plug, strerror(s->pending_error), s->pending_error, 0);
1046 }
1047
1048 /*
1049  * The function which tries to send on a socket once it's deemed
1050  * writable.
1051  */
1052 void try_send(Actual_Socket s)
1053 {
1054     while (s->sending_oob || bufchain_size(&s->output_data) > 0) {
1055         int nsent;
1056         int err;
1057         void *data;
1058         int len, urgentflag;
1059
1060         if (s->sending_oob) {
1061             urgentflag = MSG_OOB;
1062             len = s->sending_oob;
1063             data = &s->oobdata;
1064         } else {
1065             urgentflag = 0;
1066             bufchain_prefix(&s->output_data, &data, &len);
1067         }
1068         nsent = send(s->s, data, len, urgentflag);
1069         noise_ultralight(nsent);
1070         if (nsent <= 0) {
1071             err = (nsent < 0 ? errno : 0);
1072             if (err == EWOULDBLOCK) {
1073                 /*
1074                  * Perfectly normal: we've sent all we can for the moment.
1075                  */
1076                 s->writable = FALSE;
1077                 return;
1078             } else {
1079                 /*
1080                  * We unfortunately can't just call plug_closing(),
1081                  * because it's quite likely that we're currently
1082                  * _in_ a call from the code we'd be calling back
1083                  * to, so we'd have to make half the SSH code
1084                  * reentrant. Instead we flag a pending error on
1085                  * the socket, to be dealt with (by calling
1086                  * plug_closing()) at some suitable future moment.
1087                  */
1088                 s->pending_error = err;
1089                 /*
1090                  * Immediately cease selecting on this socket, so that
1091                  * we don't tight-loop repeatedly trying to do
1092                  * whatever it was that went wrong.
1093                  */
1094                 uxsel_tell(s);
1095                 /*
1096                  * Arrange to be called back from the top level to
1097                  * deal with the error condition on this socket.
1098                  */
1099                 queue_toplevel_callback(socket_error_callback, s);
1100                 return;
1101             }
1102         } else {
1103             if (s->sending_oob) {
1104                 if (nsent < len) {
1105                     memmove(s->oobdata, s->oobdata+nsent, len-nsent);
1106                     s->sending_oob = len - nsent;
1107                 } else {
1108                     s->sending_oob = 0;
1109                 }
1110             } else {
1111                 bufchain_consume(&s->output_data, nsent);
1112             }
1113         }
1114     }
1115
1116     /*
1117      * If we reach here, we've finished sending everything we might
1118      * have needed to send. Send EOF, if we need to.
1119      */
1120     if (s->outgoingeof == EOF_PENDING) {
1121         shutdown(s->s, SHUT_WR);
1122         s->outgoingeof = EOF_SENT;
1123     }
1124
1125     /*
1126      * Also update the select status, because we don't need to select
1127      * for writing any more.
1128      */
1129     uxsel_tell(s);
1130 }
1131
1132 static int sk_tcp_write(Socket sock, const char *buf, int len)
1133 {
1134     Actual_Socket s = (Actual_Socket) sock;
1135
1136     assert(s->outgoingeof == EOF_NO);
1137
1138     /*
1139      * Add the data to the buffer list on the socket.
1140      */
1141     bufchain_add(&s->output_data, buf, len);
1142
1143     /*
1144      * Now try sending from the start of the buffer list.
1145      */
1146     if (s->writable)
1147         try_send(s);
1148
1149     /*
1150      * Update the select() status to correctly reflect whether or
1151      * not we should be selecting for write.
1152      */
1153     uxsel_tell(s);
1154
1155     return bufchain_size(&s->output_data);
1156 }
1157
1158 static int sk_tcp_write_oob(Socket sock, const char *buf, int len)
1159 {
1160     Actual_Socket s = (Actual_Socket) sock;
1161
1162     assert(s->outgoingeof == EOF_NO);
1163
1164     /*
1165      * Replace the buffer list on the socket with the data.
1166      */
1167     bufchain_clear(&s->output_data);
1168     assert(len <= sizeof(s->oobdata));
1169     memcpy(s->oobdata, buf, len);
1170     s->sending_oob = len;
1171
1172     /*
1173      * Now try sending from the start of the buffer list.
1174      */
1175     if (s->writable)
1176         try_send(s);
1177
1178     /*
1179      * Update the select() status to correctly reflect whether or
1180      * not we should be selecting for write.
1181      */
1182     uxsel_tell(s);
1183
1184     return s->sending_oob;
1185 }
1186
1187 static void sk_tcp_write_eof(Socket sock)
1188 {
1189     Actual_Socket s = (Actual_Socket) sock;
1190
1191     assert(s->outgoingeof == EOF_NO);
1192
1193     /*
1194      * Mark the socket as pending outgoing EOF.
1195      */
1196     s->outgoingeof = EOF_PENDING;
1197
1198     /*
1199      * Now try sending from the start of the buffer list.
1200      */
1201     if (s->writable)
1202         try_send(s);
1203
1204     /*
1205      * Update the select() status to correctly reflect whether or
1206      * not we should be selecting for write.
1207      */
1208     uxsel_tell(s);
1209 }
1210
1211 static int net_select_result(int fd, int event)
1212 {
1213     int ret;
1214     char buf[20480];                   /* nice big buffer for plenty of speed */
1215     Actual_Socket s;
1216     u_long atmark;
1217
1218     /* Find the Socket structure */
1219     s = find234(sktree, &fd, cmpforsearch);
1220     if (!s)
1221         return 1;                      /* boggle */
1222
1223     noise_ultralight(event);
1224
1225     switch (event) {
1226       case 4:                          /* exceptional */
1227         if (!s->oobinline) {
1228             /*
1229              * On a non-oobinline socket, this indicates that we
1230              * can immediately perform an OOB read and get back OOB
1231              * data, which we will send to the back end with
1232              * type==2 (urgent data).
1233              */
1234             ret = recv(s->s, buf, sizeof(buf), MSG_OOB);
1235             noise_ultralight(ret);
1236             if (ret <= 0) {
1237                 return plug_closing(s->plug,
1238                                     ret == 0 ? "Internal networking trouble" :
1239                                     strerror(errno), errno, 0);
1240             } else {
1241                 /*
1242                  * Receiving actual data on a socket means we can
1243                  * stop falling back through the candidate
1244                  * addresses to connect to.
1245                  */
1246                 if (s->addr) {
1247                     sk_addr_free(s->addr);
1248                     s->addr = NULL;
1249                 }
1250                 return plug_receive(s->plug, 2, buf, ret);
1251             }
1252             break;
1253         }
1254
1255         /*
1256          * If we reach here, this is an oobinline socket, which
1257          * means we should set s->oobpending and then deal with it
1258          * when we get called for the readability event (which
1259          * should also occur).
1260          */
1261         s->oobpending = TRUE;
1262         break;
1263       case 1:                          /* readable; also acceptance */
1264         if (s->listener) {
1265             /*
1266              * On a listening socket, the readability event means a
1267              * connection is ready to be accepted.
1268              */
1269             union sockaddr_union su;
1270             socklen_t addrlen = sizeof(su);
1271             int t;  /* socket of connection */
1272
1273             memset(&su, 0, addrlen);
1274             t = accept(s->s, &su.sa, &addrlen);
1275             if (t < 0) {
1276                 break;
1277             }
1278
1279             nonblock(t);
1280
1281             if (s->localhost_only &&
1282                 !sockaddr_is_loopback(&su.sa)) {
1283                 close(t);              /* someone let nonlocal through?! */
1284             } else if (plug_accepting(s->plug, t)) {
1285                 close(t);              /* denied or error */
1286             }
1287             break;
1288         }
1289
1290         /*
1291          * If we reach here, this is not a listening socket, so
1292          * readability really means readability.
1293          */
1294
1295         /* In the case the socket is still frozen, we don't even bother */
1296         if (s->frozen)
1297             break;
1298
1299         /*
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).
1304          */
1305         if (s->oobinline && s->oobpending) {
1306             atmark = 1;
1307             if (ioctl(s->s, SIOCATMARK, &atmark) == 0 && atmark)
1308                 s->oobpending = FALSE; /* clear this indicator */
1309         } else
1310             atmark = 1;
1311
1312         ret = recv(s->s, buf, s->oobpending ? 1 : sizeof(buf), 0);
1313         noise_ultralight(ret);
1314         if (ret < 0) {
1315             if (errno == EWOULDBLOCK) {
1316                 break;
1317             }
1318         }
1319         if (ret < 0) {
1320             /*
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
1324              * that's the case.
1325              */
1326             int err = errno;
1327             if (s->addr) {
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);
1331                 }
1332             }
1333             if (err != 0)
1334                 return plug_closing(s->plug, strerror(err), err, 0);
1335         } else if (0 == ret) {
1336             s->incomingeof = TRUE;     /* stop trying to read now */
1337             uxsel_tell(s);
1338             return plug_closing(s->plug, NULL, 0, 0);
1339         } else {
1340             /*
1341              * Receiving actual data on a socket means we can
1342              * stop falling back through the candidate
1343              * addresses to connect to.
1344              */
1345             if (s->addr) {
1346                 sk_addr_free(s->addr);
1347                 s->addr = NULL;
1348             }
1349             return plug_receive(s->plug, atmark ? 0 : 1, buf, ret);
1350         }
1351         break;
1352       case 2:                          /* writable */
1353         if (!s->connected) {
1354             /*
1355              * select() reports a socket as _writable_ when an
1356              * asynchronous connection is completed.
1357              */
1358             s->connected = s->writable = 1;
1359             uxsel_tell(s);
1360             break;
1361         } else {
1362             int bufsize_before, bufsize_after;
1363             s->writable = 1;
1364             bufsize_before = s->sending_oob + bufchain_size(&s->output_data);
1365             try_send(s);
1366             bufsize_after = s->sending_oob + bufchain_size(&s->output_data);
1367             if (bufsize_after < bufsize_before)
1368                 plug_sent(s->plug, bufsize_after);
1369         }
1370         break;
1371     }
1372
1373     return 1;
1374 }
1375
1376 /*
1377  * Each socket abstraction contains a `void *' private field in
1378  * which the client can keep state.
1379  */
1380 static void sk_tcp_set_private_ptr(Socket sock, void *ptr)
1381 {
1382     Actual_Socket s = (Actual_Socket) sock;
1383     s->private_ptr = ptr;
1384 }
1385
1386 static void *sk_tcp_get_private_ptr(Socket sock)
1387 {
1388     Actual_Socket s = (Actual_Socket) sock;
1389     return s->private_ptr;
1390 }
1391
1392 /*
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.
1396  */
1397 const char *sk_addr_error(SockAddr addr)
1398 {
1399     return addr->error;
1400 }
1401 static const char *sk_tcp_socket_error(Socket sock)
1402 {
1403     Actual_Socket s = (Actual_Socket) sock;
1404     return s->error;
1405 }
1406
1407 static void sk_tcp_set_frozen(Socket sock, int is_frozen)
1408 {
1409     Actual_Socket s = (Actual_Socket) sock;
1410     if (s->frozen == is_frozen)
1411         return;
1412     s->frozen = is_frozen;
1413     uxsel_tell(s);
1414 }
1415
1416 static void uxsel_tell(Actual_Socket s)
1417 {
1418     int rwx = 0;
1419     if (!s->pending_error) {
1420         if (s->listener) {
1421             rwx |= 1;                  /* read == accept */
1422         } else {
1423             if (!s->connected)
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 */
1429         }
1430     }
1431     uxsel_set(s->s, rwx, net_select_result);
1432 }
1433
1434 int net_service_lookup(char *service)
1435 {
1436     struct servent *se;
1437     se = getservbyname(service, NULL);
1438     if (se != NULL)
1439         return ntohs(se->s_port);
1440     else
1441         return 0;
1442 }
1443
1444 char *get_hostname(void)
1445 {
1446     int len = 128;
1447     char *hostname = NULL;
1448     do {
1449         len *= 2;
1450         hostname = sresize(hostname, len, char);
1451         if ((gethostname(hostname, len) < 0) &&
1452             (errno != ENAMETOOLONG)) {
1453             sfree(hostname);
1454             hostname = NULL;
1455             break;
1456         }
1457     } while (strlen(hostname) >= len-1);
1458     return hostname;
1459 }
1460
1461 SockAddr platform_get_x11_unix_address(const char *sockpath, int displaynum)
1462 {
1463     SockAddr ret = snew(struct SockAddr_tag);
1464     int n;
1465
1466     memset(ret, 0, sizeof *ret);
1467     ret->superfamily = UNIX;
1468     /*
1469      * In special circumstances (notably Mac OS X Leopard), we'll
1470      * have been passed an explicit Unix socket path.
1471      */
1472     if (sockpath) {
1473         n = snprintf(ret->hostname, sizeof ret->hostname,
1474                      "%s", sockpath);
1475     } else {
1476         n = snprintf(ret->hostname, sizeof ret->hostname,
1477                      "%s%d", X11_UNIX_PATH, displaynum);
1478     }
1479
1480     if (n < 0)
1481         ret->error = "snprintf failed";
1482     else if (n >= sizeof ret->hostname)
1483         ret->error = "X11 UNIX name too long";
1484
1485 #ifndef NO_IPV6
1486     ret->ais = NULL;
1487 #else
1488     ret->addresses = NULL;
1489     ret->naddresses = 0;
1490 #endif
1491     ret->refcount = 1;
1492     return ret;
1493 }