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