folly/SocketAddress.cpp

   1 /*
   2  * Copyright 2017 Facebook, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *   http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __STDC_FORMAT_MACROS
  18   #define __STDC_FORMAT_MACROS
  19 #endif
  20
  21 #include <folly/SocketAddress.h>
  22
  23 #include <folly/Exception.h>
  24 #include <folly/Hash.h>
  25
  26 #include <boost/functional/hash.hpp>
  27 #include <string.h>
  28 #include <stdio.h>
  29 #include <errno.h>
  30 #include <sstream>
  31 #include <string>
  32 #include <system_error>
  33
  34 namespace {
  35
  36 /**
  37  * A structure to free a struct addrinfo when it goes out of scope.
  38  */
  39 struct ScopedAddrInfo {
  40   explicit ScopedAddrInfo(struct addrinfo* addrinfo) : info(addrinfo) {}
  41   ~ScopedAddrInfo() {
  42     freeaddrinfo(info);
  43   }
  44
  45   struct addrinfo* info;
  46 };
  47
  48 /**
  49  * A simple data structure for parsing a host-and-port string.
  50  *
  51  * Accepts a string of the form "<host>:<port>" or just "<port>",
  52  * and contains two string pointers to the host and the port portion of the
  53  * string.
  54  *
  55  * The HostAndPort may contain pointers into the original string.  It is
  56  * responsible for the user to ensure that the input string is valid for the
  57  * lifetime of the HostAndPort structure.
  58  */
  59 struct HostAndPort {
  60   HostAndPort(const char* str, bool hostRequired)
  61     : host(nullptr),
  62       port(nullptr),
  63       allocated(nullptr) {
  64
  65     // Look for the last colon
  66     const char* colon = strrchr(str, ':');
  67     if (colon == nullptr) {
  68       // No colon, just a port number.
  69       if (hostRequired) {
  70         throw std::invalid_argument(
  71           "expected a host and port string of the "
  72           "form \"<host>:<port>\"");
  73       }
  74       port = str;
  75       return;
  76     }
  77
  78     // We have to make a copy of the string so we can modify it
  79     // and change the colon to a NUL terminator.
  80     allocated = strdup(str);
  81     if (!allocated) {
  82       throw std::bad_alloc();
  83     }
  84
  85     char *allocatedColon = allocated + (colon - str);
  86     *allocatedColon = '\0';
  87     host = allocated;
  88     port = allocatedColon + 1;
  89     // bracketed IPv6 address, remove the brackets
  90     // allocatedColon[-1] is fine, as allocatedColon >= host and
  91     // *allocatedColon != *host therefore allocatedColon > host
  92     if (*host == '[' && allocatedColon[-1] == ']') {
  93       allocatedColon[-1] = '\0';
  94       ++host;
  95     }
  96   }
  97
  98   ~HostAndPort() {
  99     free(allocated);
 100   }
 101
 102   const char* host;
 103   const char* port;
 104   char* allocated;
 105 };
 106
 107 } // unnamed namespace
 108
 109 namespace folly {
 110
 111 bool SocketAddress::isPrivateAddress() const {
 112   auto family = getFamily();
 113   if (family == AF_INET || family == AF_INET6) {
 114     return storage_.addr.isPrivate() ||
 115       (storage_.addr.isV6() && storage_.addr.asV6().isLinkLocal());
 116   } else if (external_) {
 117     // Unix addresses are always local to a host.  Return true,
 118     // since this conforms to the semantics of returning true for IP loopback
 119     // addresses.
 120     return true;
 121   }
 122   return false;
 123 }
 124
 125 bool SocketAddress::isLoopbackAddress() const {
 126   auto family = getFamily();
 127   if (family == AF_INET || family == AF_INET6) {
 128     return storage_.addr.isLoopback();
 129   } else if (external_) {
 130     // Return true for UNIX addresses, since they are always local to a host.
 131     return true;
 132   }
 133   return false;
 134 }
 135
 136 void SocketAddress::setFromHostPort(const char* host, uint16_t port) {
 137   ScopedAddrInfo results(getAddrInfo(host, port, 0));
 138   setFromAddrInfo(results.info);
 139 }
 140
 141 void SocketAddress::setFromIpPort(const char* ip, uint16_t port) {
 142   ScopedAddrInfo results(getAddrInfo(ip, port, AI_NUMERICHOST));
 143   setFromAddrInfo(results.info);
 144 }
 145
 146 void SocketAddress::setFromIpAddrPort(const IPAddress& ipAddr, uint16_t port) {
 147   if (external_) {
 148     storage_.un.free();
 149     external_ = false;
 150   }
 151   storage_.addr = ipAddr;
 152   port_ = port;
 153 }
 154
 155 void SocketAddress::setFromLocalPort(uint16_t port) {
 156   ScopedAddrInfo results(getAddrInfo(nullptr, port, AI_ADDRCONFIG));
 157   setFromLocalAddr(results.info);
 158 }
 159
 160 void SocketAddress::setFromLocalPort(const char* port) {
 161   ScopedAddrInfo results(getAddrInfo(nullptr, port, AI_ADDRCONFIG));
 162   setFromLocalAddr(results.info);
 163 }
 164
 165 void SocketAddress::setFromLocalIpPort(const char* addressAndPort) {
 166   HostAndPort hp(addressAndPort, false);
 167   ScopedAddrInfo results(getAddrInfo(hp.host, hp.port,
 168                                      AI_NUMERICHOST | AI_ADDRCONFIG));
 169   setFromLocalAddr(results.info);
 170 }
 171
 172 void SocketAddress::setFromIpPort(const char* addressAndPort) {
 173   HostAndPort hp(addressAndPort, true);
 174   ScopedAddrInfo results(getAddrInfo(hp.host, hp.port, AI_NUMERICHOST));
 175   setFromAddrInfo(results.info);
 176 }
 177
 178 void SocketAddress::setFromHostPort(const char* hostAndPort) {
 179   HostAndPort hp(hostAndPort, true);
 180   ScopedAddrInfo results(getAddrInfo(hp.host, hp.port, 0));
 181   setFromAddrInfo(results.info);
 182 }
 183
 184 int SocketAddress::getPortFrom(const struct sockaddr* address) {
 185   switch (address->sa_family) {
 186     case AF_INET:
 187       return ntohs(((sockaddr_in*)address)->sin_port);
 188
 189     case AF_INET6:
 190       return ntohs(((sockaddr_in6*)address)->sin6_port);
 191
 192     default:
 193       return -1;
 194   }
 195 }
 196
 197 const char* SocketAddress::getFamilyNameFrom(
 198     const struct sockaddr* address,
 199     const char* defaultResult) {
 200 #define GETFAMILYNAMEFROM_IMPL(Family) \
 201   case Family:                         \
 202     return #Family
 203
 204   switch (address->sa_family) {
 205     GETFAMILYNAMEFROM_IMPL(AF_INET);
 206     GETFAMILYNAMEFROM_IMPL(AF_INET6);
 207     GETFAMILYNAMEFROM_IMPL(AF_UNIX);
 208     GETFAMILYNAMEFROM_IMPL(AF_UNSPEC);
 209
 210     default:
 211       return defaultResult;
 212   }
 213
 214 #undef GETFAMILYNAMEFROM_IMPL
 215 }
 216
 217 void SocketAddress::setFromPath(StringPiece path) {
 218   // Before we touch storage_, check to see if the length is too big.
 219   // Note that "storage_.un.addr->sun_path" may not be safe to evaluate here,
 220   // but sizeof() just uses its type, and does't evaluate it.
 221   if (path.size() > sizeof(storage_.un.addr->sun_path)) {
 222     throw std::invalid_argument(
 223         "socket path too large to fit into sockaddr_un");
 224   }
 225
 226   if (!external_) {
 227     storage_.un.init();
 228     external_ = true;
 229   }
 230
 231   size_t len = path.size();
 232   storage_.un.len = socklen_t(offsetof(struct sockaddr_un, sun_path) + len);
 233   memcpy(storage_.un.addr->sun_path, path.data(), len);
 234   // If there is room, put a terminating NUL byte in sun_path.  In general the
 235   // path should be NUL terminated, although getsockname() and getpeername()
 236   // may return Unix socket addresses with paths that fit exactly in sun_path
 237   // with no terminating NUL.
 238   if (len < sizeof(storage_.un.addr->sun_path)) {
 239     storage_.un.addr->sun_path[len] = '\0';
 240   }
 241 }
 242
 243 void SocketAddress::setFromPeerAddress(int socket) {
 244   setFromSocket(socket, getpeername);
 245 }
 246
 247 void SocketAddress::setFromLocalAddress(int socket) {
 248   setFromSocket(socket, getsockname);
 249 }
 250
 251 void SocketAddress::setFromSockaddr(const struct sockaddr* address) {
 252   uint16_t port;
 253
 254   if (address->sa_family == AF_INET) {
 255     port = ntohs(((sockaddr_in*)address)->sin_port);
 256   } else if (address->sa_family == AF_INET6) {
 257     port = ntohs(((sockaddr_in6*)address)->sin6_port);
 258   } else if (address->sa_family == AF_UNIX) {
 259     // We need an explicitly specified length for AF_UNIX addresses,
 260     // to be able to distinguish anonymous addresses from addresses
 261     // in Linux's abstract namespace.
 262     throw std::invalid_argument(
 263       "SocketAddress::setFromSockaddr(): the address "
 264       "length must be explicitly specified when "
 265       "setting AF_UNIX addresses");
 266   } else {
 267     throw std::invalid_argument(
 268       "SocketAddress::setFromSockaddr() called "
 269       "with unsupported address type");
 270   }
 271
 272   setFromIpAddrPort(folly::IPAddress(address), port);
 273 }
 274
 275 void SocketAddress::setFromSockaddr(const struct sockaddr* address,
 276                                      socklen_t addrlen) {
 277   // Check the length to make sure we can access address->sa_family
 278   if (addrlen < (offsetof(struct sockaddr, sa_family) +
 279                  sizeof(address->sa_family))) {
 280     throw std::invalid_argument(
 281       "SocketAddress::setFromSockaddr() called "
 282       "with length too short for a sockaddr");
 283   }
 284
 285   if (address->sa_family == AF_INET) {
 286     if (addrlen < sizeof(struct sockaddr_in)) {
 287       throw std::invalid_argument(
 288         "SocketAddress::setFromSockaddr() called "
 289         "with length too short for a sockaddr_in");
 290     }
 291     setFromSockaddr(reinterpret_cast<const struct sockaddr_in*>(address));
 292   } else if (address->sa_family == AF_INET6) {
 293     if (addrlen < sizeof(struct sockaddr_in6)) {
 294       throw std::invalid_argument(
 295         "SocketAddress::setFromSockaddr() called "
 296         "with length too short for a sockaddr_in6");
 297     }
 298     setFromSockaddr(reinterpret_cast<const struct sockaddr_in6*>(address));
 299   } else if (address->sa_family == AF_UNIX) {
 300     setFromSockaddr(reinterpret_cast<const struct sockaddr_un*>(address),
 301                     addrlen);
 302   } else {
 303     throw std::invalid_argument(
 304       "SocketAddress::setFromSockaddr() called "
 305       "with unsupported address type");
 306   }
 307 }
 308
 309 void SocketAddress::setFromSockaddr(const struct sockaddr_in* address) {
 310   assert(address->sin_family == AF_INET);
 311   setFromSockaddr((sockaddr*)address);
 312 }
 313
 314 void SocketAddress::setFromSockaddr(const struct sockaddr_in6* address) {
 315   assert(address->sin6_family == AF_INET6);
 316   setFromSockaddr((sockaddr*)address);
 317 }
 318
 319 void SocketAddress::setFromSockaddr(const struct sockaddr_un* address,
 320                                      socklen_t addrlen) {
 321   assert(address->sun_family == AF_UNIX);
 322   if (addrlen > sizeof(struct sockaddr_un)) {
 323     throw std::invalid_argument(
 324       "SocketAddress::setFromSockaddr() called "
 325       "with length too long for a sockaddr_un");
 326   }
 327
 328   if (!external_) {
 329     storage_.un.init();
 330   }
 331   external_ = true;
 332   memcpy(storage_.un.addr, address, addrlen);
 333   updateUnixAddressLength(addrlen);
 334
 335   // Fill the rest with 0s, just for safety
 336   if (addrlen < sizeof(struct sockaddr_un)) {
 337     char *p = reinterpret_cast<char*>(storage_.un.addr);
 338     memset(p + addrlen, 0, sizeof(struct sockaddr_un) - addrlen);
 339   }
 340 }
 341
 342 const folly::IPAddress& SocketAddress::getIPAddress() const {
 343   auto family = getFamily();
 344   if (family != AF_INET && family != AF_INET6) {
 345     throw InvalidAddressFamilyException(family);
 346   }
 347   return storage_.addr;
 348 }
 349
 350 socklen_t SocketAddress::getActualSize() const {
 351   if (external_) {
 352     return storage_.un.len;
 353   }
 354   switch (getFamily()) {
 355     case AF_UNSPEC:
 356     case AF_INET:
 357       return sizeof(struct sockaddr_in);
 358     case AF_INET6:
 359       return sizeof(struct sockaddr_in6);
 360     default:
 361       throw std::invalid_argument(
 362         "SocketAddress::getActualSize() called "
 363         "with unrecognized address family");
 364   }
 365 }
 366
 367 std::string SocketAddress::getFullyQualified() const {
 368   if (!isFamilyInet()) {
 369     throw std::invalid_argument("Can't get address str for non ip address");
 370   }
 371   return storage_.addr.toFullyQualified();
 372 }
 373
 374 std::string SocketAddress::getAddressStr() const {
 375   if (!isFamilyInet()) {
 376     throw std::invalid_argument("Can't get address str for non ip address");
 377   }
 378   return storage_.addr.str();
 379 }
 380
 381 bool SocketAddress::isFamilyInet() const {
 382   auto family = getFamily();
 383   return family == AF_INET || family == AF_INET6;
 384 }
 385
 386 void SocketAddress::getAddressStr(char* buf, size_t buflen) const {
 387   auto ret = getAddressStr();
 388   size_t len = std::min(buflen - 1, ret.size());
 389   memcpy(buf, ret.data(), len);
 390   buf[len] = '\0';
 391 }
 392
 393 uint16_t SocketAddress::getPort() const {
 394   switch (getFamily()) {
 395     case AF_INET:
 396     case AF_INET6:
 397       return port_;
 398     default:
 399       throw std::invalid_argument(
 400         "SocketAddress::getPort() called on non-IP "
 401         "address");
 402   }
 403 }
 404
 405 void SocketAddress::setPort(uint16_t port) {
 406   switch (getFamily()) {
 407     case AF_INET:
 408     case AF_INET6:
 409       port_ = port;
 410       return;
 411     default:
 412       throw std::invalid_argument(
 413         "SocketAddress::setPort() called on non-IP "
 414         "address");
 415   }
 416 }
 417
 418 void SocketAddress::convertToIPv4() {
 419   if (!tryConvertToIPv4()) {
 420     throw std::invalid_argument(
 421       "convertToIPv4() called on an addresse that is "
 422       "not an IPv4-mapped address");
 423   }
 424 }
 425
 426 bool SocketAddress::tryConvertToIPv4() {
 427   if (!isIPv4Mapped()) {
 428     return false;
 429   }
 430
 431   storage_.addr = folly::IPAddress::createIPv4(storage_.addr);
 432   return true;
 433 }
 434
 435 bool SocketAddress::mapToIPv6() {
 436   if (getFamily() != AF_INET) {
 437     return false;
 438   }
 439
 440   storage_.addr = folly::IPAddress::createIPv6(storage_.addr);
 441   return true;
 442 }
 443
 444 std::string SocketAddress::getHostStr() const {
 445   return getIpString(0);
 446 }
 447
 448 std::string SocketAddress::getPath() const {
 449   if (!external_) {
 450     throw std::invalid_argument(
 451       "SocketAddress: attempting to get path "
 452       "for a non-Unix address");
 453   }
 454
 455   if (storage_.un.pathLength() == 0) {
 456     // anonymous address
 457     return std::string();
 458   }
 459   if (storage_.un.addr->sun_path[0] == '\0') {
 460     // abstract namespace
 461     return std::string(storage_.un.addr->sun_path, storage_.un.pathLength());
 462   }
 463
 464   return std::string(storage_.un.addr->sun_path,
 465                      strnlen(storage_.un.addr->sun_path,
 466                              storage_.un.pathLength()));
 467 }
 468
 469 std::string SocketAddress::describe() const {
 470   if (external_) {
 471     if (storage_.un.pathLength() == 0) {
 472       return "<anonymous unix address>";
 473     }
 474
 475     if (storage_.un.addr->sun_path[0] == '\0') {
 476       // Linux supports an abstract namespace for unix socket addresses
 477       return "<abstract unix address>";
 478     }
 479
 480     return std::string(storage_.un.addr->sun_path,
 481                        strnlen(storage_.un.addr->sun_path,
 482                                storage_.un.pathLength()));
 483   }
 484   switch (getFamily()) {
 485     case AF_UNSPEC:
 486       return "<uninitialized address>";
 487     case AF_INET:
 488     {
 489       char buf[NI_MAXHOST + 16];
 490       getAddressStr(buf, sizeof(buf));
 491       size_t iplen = strlen(buf);
 492       snprintf(buf + iplen, sizeof(buf) - iplen, ":%" PRIu16, getPort());
 493       return buf;
 494     }
 495     case AF_INET6:
 496     {
 497       char buf[NI_MAXHOST + 18];
 498       buf[0] = '[';
 499       getAddressStr(buf + 1, sizeof(buf) - 1);
 500       size_t iplen = strlen(buf);
 501       snprintf(buf + iplen, sizeof(buf) - iplen, "]:%" PRIu16, getPort());
 502       return buf;
 503     }
 504     default:
 505     {
 506       char buf[64];
 507       snprintf(buf, sizeof(buf), "<unknown address family %d>",
 508                getFamily());
 509       return buf;
 510     }
 511   }
 512 }
 513
 514 bool SocketAddress::operator==(const SocketAddress& other) const {
 515   if (external_ != other.external_ || other.getFamily() != getFamily()) {
 516     return false;
 517   }
 518   if (external_) {
 519     // anonymous addresses are never equal to any other addresses
 520     if (storage_.un.pathLength() == 0 ||
 521         other.storage_.un.pathLength() == 0) {
 522       return false;
 523     }
 524
 525     if (storage_.un.len != other.storage_.un.len) {
 526       return false;
 527     }
 528     int cmp = memcmp(storage_.un.addr->sun_path,
 529                      other.storage_.un.addr->sun_path,
 530                      storage_.un.pathLength());
 531     return cmp == 0;
 532   }
 533
 534   switch (getFamily()) {
 535     case AF_INET:
 536     case AF_INET6:
 537       return (other.storage_.addr == storage_.addr) &&
 538         (other.port_ == port_);
 539     default:
 540       throw std::invalid_argument(
 541         "SocketAddress: unsupported address family "
 542         "for comparison");
 543   }
 544 }
 545
 546 bool SocketAddress::prefixMatch(const SocketAddress& other,
 547     unsigned prefixLength) const {
 548   if (other.getFamily() != getFamily()) {
 549     return false;
 550   }
 551   uint8_t mask_length = 128;
 552   switch (getFamily()) {
 553     case AF_INET:
 554       mask_length = 32;
 555       // fallthrough
 556     case AF_INET6:
 557     {
 558       auto prefix = folly::IPAddress::longestCommonPrefix(
 559         {storage_.addr, mask_length},
 560         {other.storage_.addr, mask_length});
 561       return prefix.second >= prefixLength;
 562     }
 563     default:
 564       return false;
 565   }
 566 }
 567
 568
 569 size_t SocketAddress::hash() const {
 570   size_t seed = folly::hash::twang_mix64(getFamily());
 571
 572   if (external_) {
 573     enum { kUnixPathMax = sizeof(storage_.un.addr->sun_path) };
 574     const char *path = storage_.un.addr->sun_path;
 575     size_t pathLength = storage_.un.pathLength();
 576     // TODO: this probably could be made more efficient
 577     for (unsigned int n = 0; n < pathLength; ++n) {
 578       boost::hash_combine(seed, folly::hash::twang_mix64(path[n]));
 579     }
 580   }
 581
 582   switch (getFamily()) {
 583     case AF_INET:
 584     case AF_INET6: {
 585       boost::hash_combine(seed, port_);
 586       boost::hash_combine(seed, storage_.addr.hash());
 587       break;
 588     }
 589     case AF_UNIX:
 590       DCHECK(external_);
 591       break;
 592     case AF_UNSPEC:
 593     default:
 594       throw std::invalid_argument(
 595         "SocketAddress: unsupported address family "
 596         "for hashing");
 597   }
 598
 599   return seed;
 600 }
 601
 602 struct addrinfo* SocketAddress::getAddrInfo(const char* host,
 603                                              uint16_t port,
 604                                              int flags) {
 605   // getaddrinfo() requires the port number as a string
 606   char portString[sizeof("65535")];
 607   snprintf(portString, sizeof(portString), "%" PRIu16, port);
 608
 609   return getAddrInfo(host, portString, flags);
 610 }
 611
 612 struct addrinfo* SocketAddress::getAddrInfo(const char* host,
 613                                              const char* port,
 614                                              int flags) {
 615   struct addrinfo hints;
 616   memset(&hints, 0, sizeof(hints));
 617   hints.ai_family = AF_UNSPEC;
 618   hints.ai_socktype = SOCK_STREAM;
 619   hints.ai_flags = AI_PASSIVE | AI_NUMERICSERV | flags;
 620
 621   struct addrinfo *results;
 622   int error = getaddrinfo(host, port, &hints, &results);
 623   if (error != 0) {
 624     auto os = folly::to<std::string>(
 625       "Failed to resolve address for \"", host,  "\": ",
 626       gai_strerror(error), " (error=", error,  ")");
 627     throw std::system_error(error, std::generic_category(), os);
 628   }
 629
 630   return results;
 631 }
 632
 633 void SocketAddress::setFromAddrInfo(const struct addrinfo* info) {
 634   setFromSockaddr(info->ai_addr, socklen_t(info->ai_addrlen));
 635 }
 636
 637 void SocketAddress::setFromLocalAddr(const struct addrinfo* info) {
 638   // If an IPv6 address is present, prefer to use it, since IPv4 addresses
 639   // can be mapped into IPv6 space.
 640   for (const struct addrinfo* ai = info; ai != nullptr; ai = ai->ai_next) {
 641     if (ai->ai_family == AF_INET6) {
 642       setFromSockaddr(ai->ai_addr, socklen_t(ai->ai_addrlen));
 643       return;
 644     }
 645   }
 646
 647   // Otherwise, just use the first address in the list.
 648   setFromSockaddr(info->ai_addr, socklen_t(info->ai_addrlen));
 649 }
 650
 651 void SocketAddress::setFromSocket(
 652     int socket,
 653     int (*fn)(int, struct sockaddr*, socklen_t*)) {
 654   // Try to put the address into a local storage buffer.
 655   sockaddr_storage tmp_sock;
 656   socklen_t addrLen = sizeof(tmp_sock);
 657   if (fn(socket, (sockaddr*)&tmp_sock, &addrLen) != 0) {
 658     folly::throwSystemError("setFromSocket() failed");
 659   }
 660
 661   setFromSockaddr((sockaddr*)&tmp_sock, addrLen);
 662 }
 663
 664 std::string SocketAddress::getIpString(int flags) const {
 665   char addrString[NI_MAXHOST];
 666   getIpString(addrString, sizeof(addrString), flags);
 667   return std::string(addrString);
 668 }
 669
 670 void SocketAddress::getIpString(char *buf, size_t buflen, int flags) const {
 671   auto family = getFamily();
 672   if (family != AF_INET &&
 673       family != AF_INET6) {
 674     throw std::invalid_argument(
 675       "SocketAddress: attempting to get IP address "
 676       "for a non-IP address");
 677   }
 678
 679   sockaddr_storage tmp_sock;
 680   storage_.addr.toSockaddrStorage(&tmp_sock, port_);
 681   int rc = getnameinfo((sockaddr*)&tmp_sock, sizeof(sockaddr_storage),
 682                        buf, buflen, nullptr, 0, flags);
 683   if (rc != 0) {
 684     auto os = folly::to<std::string>(
 685       "getnameinfo() failed in getIpString() error = ",
 686       gai_strerror(rc));
 687     throw std::system_error(rc, std::generic_category(), os);
 688   }
 689 }
 690
 691 void SocketAddress::updateUnixAddressLength(socklen_t addrlen) {
 692   if (addrlen < offsetof(struct sockaddr_un, sun_path)) {
 693     throw std::invalid_argument(
 694       "SocketAddress: attempted to set a Unix socket "
 695       "with a length too short for a sockaddr_un");
 696   }
 697
 698   storage_.un.len = addrlen;
 699   if (storage_.un.pathLength() == 0) {
 700     // anonymous address
 701     return;
 702   }
 703
 704   if (storage_.un.addr->sun_path[0] == '\0') {
 705     // abstract namespace.  honor the specified length
 706   } else {
 707     // Call strnlen(), just in case the length was overspecified.
 708     socklen_t maxLength = addrlen - offsetof(struct sockaddr_un, sun_path);
 709     size_t pathLength = strnlen(storage_.un.addr->sun_path, maxLength);
 710     storage_.un.len =
 711         socklen_t(offsetof(struct sockaddr_un, sun_path) + pathLength);
 712   }
 713 }
 714
 715 bool SocketAddress::operator<(const SocketAddress& other) const {
 716   if (getFamily() != other.getFamily()) {
 717     return getFamily() < other.getFamily();
 718   }
 719
 720   if (external_) {
 721     // Anonymous addresses can't be compared to anything else.
 722     // Return that they are never less than anything.
 723     //
 724     // Note that this still meets the requirements for a strict weak
 725     // ordering, so we can use this operator<() with standard C++ containers.
 726     size_t thisPathLength = storage_.un.pathLength();
 727     if (thisPathLength == 0) {
 728       return false;
 729     }
 730     size_t otherPathLength = other.storage_.un.pathLength();
 731     if (otherPathLength == 0) {
 732       return true;
 733     }
 734
 735     // Compare based on path length first, for efficiency
 736     if (thisPathLength != otherPathLength) {
 737       return thisPathLength < otherPathLength;
 738     }
 739     int cmp = memcmp(storage_.un.addr->sun_path,
 740                      other.storage_.un.addr->sun_path,
 741                      thisPathLength);
 742     return cmp < 0;
 743   }
 744   switch (getFamily()) {
 745     case AF_INET:
 746     case AF_INET6: {
 747       if (port_ != other.port_) {
 748         return port_ < other.port_;
 749       }
 750
 751       return
 752         storage_.addr < other.storage_.addr;
 753     }
 754     case AF_UNSPEC:
 755     default:
 756       throw std::invalid_argument(
 757         "SocketAddress: unsupported address family for comparing");
 758   }
 759 }
 760
 761 size_t hash_value(const SocketAddress& address) {
 762   return address.hash();
 763 }
 764
 765 std::ostream& operator<<(std::ostream& os, const SocketAddress& addr) {
 766   os << addr.describe();
 767   return os;
 768 }
 769
 770 } // folly