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