Update documentation for Synchronized
[folly.git] / folly / SocketAddress.cpp
1 /*
2  * Copyright 2016 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 = 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   prepFamilyChange(AF_UNIX);
329   memcpy(storage_.un.addr, address, addrlen);
330   updateUnixAddressLength(addrlen);
331
332   // Fill the rest with 0s, just for safety
333   if (addrlen < sizeof(struct sockaddr_un)) {
334     char *p = reinterpret_cast<char*>(storage_.un.addr);
335     memset(p + addrlen, 0, sizeof(struct sockaddr_un) - addrlen);
336   }
337 }
338
339 const folly::IPAddress& SocketAddress::getIPAddress() const {
340   auto family = getFamily();
341   if (family != AF_INET && family != AF_INET6) {
342     throw InvalidAddressFamilyException(family);
343   }
344   return storage_.addr;
345 }
346
347 socklen_t SocketAddress::getActualSize() const {
348   if (external_) {
349     return storage_.un.len;
350   }
351   switch (getFamily()) {
352     case AF_UNSPEC:
353     case AF_INET:
354       return sizeof(struct sockaddr_in);
355     case AF_INET6:
356       return sizeof(struct sockaddr_in6);
357     default:
358       throw std::invalid_argument(
359         "SocketAddress::getActualSize() called "
360         "with unrecognized address family");
361   }
362 }
363
364 std::string SocketAddress::getFullyQualified() const {
365   auto family = getFamily();
366   if (family != AF_INET && family != AF_INET6) {
367     throw std::invalid_argument("Can't get address str for non ip address");
368   }
369   return storage_.addr.toFullyQualified();
370 }
371
372 std::string SocketAddress::getAddressStr() const {
373   char buf[INET6_ADDRSTRLEN];
374   getAddressStr(buf, sizeof(buf));
375   return buf;
376 }
377
378 void SocketAddress::getAddressStr(char* buf, size_t buflen) const {
379   auto family = getFamily();
380   if (family != AF_INET && family != AF_INET6) {
381     throw std::invalid_argument("Can't get address str for non ip address");
382   }
383   std::string ret = storage_.addr.str();
384   size_t len = std::min(buflen, ret.size());
385   memcpy(buf, ret.data(), len);
386   buf[len] = '\0';
387 }
388
389 uint16_t SocketAddress::getPort() const {
390   switch (getFamily()) {
391     case AF_INET:
392     case AF_INET6:
393       return port_;
394     default:
395       throw std::invalid_argument(
396         "SocketAddress::getPort() called on non-IP "
397         "address");
398   }
399 }
400
401 void SocketAddress::setPort(uint16_t port) {
402   switch (getFamily()) {
403     case AF_INET:
404     case AF_INET6:
405       port_ = port;
406       return;
407     default:
408       throw std::invalid_argument(
409         "SocketAddress::setPort() called on non-IP "
410         "address");
411   }
412 }
413
414 void SocketAddress::convertToIPv4() {
415   if (!tryConvertToIPv4()) {
416     throw std::invalid_argument(
417       "convertToIPv4() called on an addresse that is "
418       "not an IPv4-mapped address");
419   }
420 }
421
422 bool SocketAddress::tryConvertToIPv4() {
423   if (!isIPv4Mapped()) {
424     return false;
425   }
426
427   storage_.addr = folly::IPAddress::createIPv4(storage_.addr);
428   return true;
429 }
430
431 bool SocketAddress::mapToIPv6() {
432   if (getFamily() != AF_INET) {
433     return false;
434   }
435
436   storage_.addr = folly::IPAddress::createIPv6(storage_.addr);
437   return true;
438 }
439
440 std::string SocketAddress::getHostStr() const {
441   return getIpString(0);
442 }
443
444 std::string SocketAddress::getPath() const {
445   if (!external_) {
446     throw std::invalid_argument(
447       "SocketAddress: attempting to get path "
448       "for a non-Unix address");
449   }
450
451   if (storage_.un.pathLength() == 0) {
452     // anonymous address
453     return std::string();
454   }
455   if (storage_.un.addr->sun_path[0] == '\0') {
456     // abstract namespace
457     return std::string(storage_.un.addr->sun_path, storage_.un.pathLength());
458   }
459
460   return std::string(storage_.un.addr->sun_path,
461                      strnlen(storage_.un.addr->sun_path,
462                              storage_.un.pathLength()));
463 }
464
465 std::string SocketAddress::describe() const {
466   if (external_) {
467     if (storage_.un.pathLength() == 0) {
468       return "<anonymous unix address>";
469     }
470
471     if (storage_.un.addr->sun_path[0] == '\0') {
472       // Linux supports an abstract namespace for unix socket addresses
473       return "<abstract unix address>";
474     }
475
476     return std::string(storage_.un.addr->sun_path,
477                        strnlen(storage_.un.addr->sun_path,
478                                storage_.un.pathLength()));
479   }
480   switch (getFamily()) {
481     case AF_UNSPEC:
482       return "<uninitialized address>";
483     case AF_INET:
484     {
485       char buf[NI_MAXHOST + 16];
486       getAddressStr(buf, sizeof(buf));
487       size_t iplen = strlen(buf);
488       snprintf(buf + iplen, sizeof(buf) - iplen, ":%" PRIu16, getPort());
489       return buf;
490     }
491     case AF_INET6:
492     {
493       char buf[NI_MAXHOST + 18];
494       buf[0] = '[';
495       getAddressStr(buf + 1, sizeof(buf) - 1);
496       size_t iplen = strlen(buf);
497       snprintf(buf + iplen, sizeof(buf) - iplen, "]:%" PRIu16, getPort());
498       return buf;
499     }
500     default:
501     {
502       char buf[64];
503       snprintf(buf, sizeof(buf), "<unknown address family %d>",
504                getFamily());
505       return buf;
506     }
507   }
508 }
509
510 bool SocketAddress::operator==(const SocketAddress& other) const {
511   if (external_ != other.external_ || other.getFamily() != getFamily()) {
512     return false;
513   }
514   if (external_) {
515     // anonymous addresses are never equal to any other addresses
516     if (storage_.un.pathLength() == 0 ||
517         other.storage_.un.pathLength() == 0) {
518       return false;
519     }
520
521     if (storage_.un.len != other.storage_.un.len) {
522       return false;
523     }
524     int cmp = memcmp(storage_.un.addr->sun_path,
525                      other.storage_.un.addr->sun_path,
526                      storage_.un.pathLength());
527     return cmp == 0;
528   }
529
530   switch (getFamily()) {
531     case AF_INET:
532     case AF_INET6:
533       return (other.storage_.addr == storage_.addr) &&
534         (other.port_ == port_);
535     default:
536       throw std::invalid_argument(
537         "SocketAddress: unsupported address family "
538         "for comparison");
539   }
540 }
541
542 bool SocketAddress::prefixMatch(const SocketAddress& other,
543     unsigned prefixLength) const {
544   if (other.getFamily() != getFamily()) {
545     return false;
546   }
547   int mask_length = 128;
548   switch (getFamily()) {
549     case AF_INET:
550       mask_length = 32;
551       // fallthrough
552     case AF_INET6:
553     {
554       auto prefix = folly::IPAddress::longestCommonPrefix(
555         {storage_.addr, mask_length},
556         {other.storage_.addr, mask_length});
557       return prefix.second >= prefixLength;
558     }
559     default:
560       return false;
561   }
562 }
563
564
565 size_t SocketAddress::hash() const {
566   size_t seed = folly::hash::twang_mix64(getFamily());
567
568   if (external_) {
569     enum { kUnixPathMax = sizeof(storage_.un.addr->sun_path) };
570     const char *path = storage_.un.addr->sun_path;
571     size_t pathLength = storage_.un.pathLength();
572     // TODO: this probably could be made more efficient
573     for (unsigned int n = 0; n < pathLength; ++n) {
574       boost::hash_combine(seed, folly::hash::twang_mix64(path[n]));
575     }
576   }
577
578   switch (getFamily()) {
579     case AF_INET:
580     case AF_INET6: {
581       boost::hash_combine(seed, port_);
582       boost::hash_combine(seed, storage_.addr.hash());
583       break;
584     }
585     case AF_UNIX:
586       DCHECK(external_);
587       break;
588     case AF_UNSPEC:
589     default:
590       throw std::invalid_argument(
591         "SocketAddress: unsupported address family "
592         "for hashing");
593   }
594
595   return seed;
596 }
597
598 struct addrinfo* SocketAddress::getAddrInfo(const char* host,
599                                              uint16_t port,
600                                              int flags) {
601   // getaddrinfo() requires the port number as a string
602   char portString[sizeof("65535")];
603   snprintf(portString, sizeof(portString), "%" PRIu16, port);
604
605   return getAddrInfo(host, portString, flags);
606 }
607
608 struct addrinfo* SocketAddress::getAddrInfo(const char* host,
609                                              const char* port,
610                                              int flags) {
611   struct addrinfo hints;
612   memset(&hints, 0, sizeof(hints));
613   hints.ai_family = AF_UNSPEC;
614   hints.ai_socktype = SOCK_STREAM;
615   hints.ai_flags = AI_PASSIVE | AI_NUMERICSERV | flags;
616
617   struct addrinfo *results;
618   int error = getaddrinfo(host, port, &hints, &results);
619   if (error != 0) {
620     auto os = folly::to<std::string>(
621       "Failed to resolve address for \"", host,  "\": ",
622       gai_strerror(error), " (error=", error,  ")");
623     throw std::system_error(error, std::generic_category(), os);
624   }
625
626   return results;
627 }
628
629 void SocketAddress::setFromAddrInfo(const struct addrinfo* info) {
630   setFromSockaddr(info->ai_addr, info->ai_addrlen);
631 }
632
633 void SocketAddress::setFromLocalAddr(const struct addrinfo* info) {
634   // If an IPv6 address is present, prefer to use it, since IPv4 addresses
635   // can be mapped into IPv6 space.
636   for (const struct addrinfo* ai = info; ai != nullptr; ai = ai->ai_next) {
637     if (ai->ai_family == AF_INET6) {
638       setFromSockaddr(ai->ai_addr, ai->ai_addrlen);
639       return;
640     }
641   }
642
643   // Otherwise, just use the first address in the list.
644   setFromSockaddr(info->ai_addr, info->ai_addrlen);
645 }
646
647 void SocketAddress::setFromSocket(
648     int socket,
649     int (*fn)(int, struct sockaddr*, socklen_t*)) {
650   // Try to put the address into a local storage buffer.
651   sockaddr_storage tmp_sock;
652   socklen_t addrLen = sizeof(tmp_sock);
653   if (fn(socket, (sockaddr*)&tmp_sock, &addrLen) != 0) {
654     folly::throwSystemError("setFromSocket() failed");
655   }
656
657   setFromSockaddr((sockaddr*)&tmp_sock, addrLen);
658 }
659
660 std::string SocketAddress::getIpString(int flags) const {
661   char addrString[NI_MAXHOST];
662   getIpString(addrString, sizeof(addrString), flags);
663   return std::string(addrString);
664 }
665
666 void SocketAddress::getIpString(char *buf, size_t buflen, int flags) const {
667   auto family = getFamily();
668   if (family != AF_INET &&
669       family != AF_INET6) {
670     throw std::invalid_argument(
671       "SocketAddress: attempting to get IP address "
672       "for a non-IP address");
673   }
674
675   sockaddr_storage tmp_sock;
676   storage_.addr.toSockaddrStorage(&tmp_sock, port_);
677   int rc = getnameinfo((sockaddr*)&tmp_sock, sizeof(sockaddr_storage),
678                        buf, buflen, nullptr, 0, flags);
679   if (rc != 0) {
680     auto os = folly::to<std::string>(
681       "getnameinfo() failed in getIpString() error = ",
682       gai_strerror(rc));
683     throw std::system_error(rc, std::generic_category(), os);
684   }
685 }
686
687 void SocketAddress::updateUnixAddressLength(socklen_t addrlen) {
688   if (addrlen < offsetof(struct sockaddr_un, sun_path)) {
689     throw std::invalid_argument(
690       "SocketAddress: attempted to set a Unix socket "
691       "with a length too short for a sockaddr_un");
692   }
693
694   storage_.un.len = addrlen;
695   if (storage_.un.pathLength() == 0) {
696     // anonymous address
697     return;
698   }
699
700   if (storage_.un.addr->sun_path[0] == '\0') {
701     // abstract namespace.  honor the specified length
702   } else {
703     // Call strnlen(), just in case the length was overspecified.
704     socklen_t maxLength = addrlen - offsetof(struct sockaddr_un, sun_path);
705     size_t pathLength = strnlen(storage_.un.addr->sun_path, maxLength);
706     storage_.un.len = offsetof(struct sockaddr_un, sun_path) + pathLength;
707   }
708 }
709
710 bool SocketAddress::operator<(const SocketAddress& other) const {
711   if (getFamily() != other.getFamily()) {
712     return getFamily() < other.getFamily();
713   }
714
715   if (external_) {
716     // Anonymous addresses can't be compared to anything else.
717     // Return that they are never less than anything.
718     //
719     // Note that this still meets the requirements for a strict weak
720     // ordering, so we can use this operator<() with standard C++ containers.
721     size_t thisPathLength = storage_.un.pathLength();
722     if (thisPathLength == 0) {
723       return false;
724     }
725     size_t otherPathLength = other.storage_.un.pathLength();
726     if (otherPathLength == 0) {
727       return true;
728     }
729
730     // Compare based on path length first, for efficiency
731     if (thisPathLength != otherPathLength) {
732       return thisPathLength < otherPathLength;
733     }
734     int cmp = memcmp(storage_.un.addr->sun_path,
735                      other.storage_.un.addr->sun_path,
736                      thisPathLength);
737     return cmp < 0;
738   }
739   switch (getFamily()) {
740     case AF_INET:
741     case AF_INET6: {
742       if (port_ != other.port_) {
743         return port_ < other.port_;
744       }
745
746       return
747         storage_.addr < other.storage_.addr;
748     }
749     case AF_UNSPEC:
750     default:
751       throw std::invalid_argument(
752         "SocketAddress: unsupported address family for comparing");
753   }
754 }
755
756 size_t hash_value(const SocketAddress& address) {
757   return address.hash();
758 }
759
760 std::ostream& operator<<(std::ostream& os, const SocketAddress& addr) {
761   os << addr.describe();
762   return os;
763 }
764
765 } // folly